/[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 1416 by schoenebeck, Sun Oct 14 12:06:32 2007 UTC revision 2923 by schoenebeck, Sat May 21 08:54:32 2016 UTC
# Line 2  Line 2 
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file access library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003-2007 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2016 by Christian Schoenebeck                      *
6   *                              <cuse@users.sourceforge.net>               *   *                              <cuse@users.sourceforge.net>               *
7   *                                                                         *   *                                                                         *
8   *   This library is free software; you can redistribute it and/or modify  *   *   This library is free software; you can redistribute it and/or modify  *
# Line 25  Line 25 
25    
26  #include "helper.h"  #include "helper.h"
27    
28    #include <algorithm>
29  #include <math.h>  #include <math.h>
30  #include <iostream>  #include <iostream>
31    #include <assert.h>
32    
33    /// libgig's current file format version (for extending the original Giga file
34    /// format with libgig's own custom data / custom features).
35    #define GIG_FILE_EXT_VERSION    2
36    
37  /// Initial size of the sample buffer which is used for decompression of  /// Initial size of the sample buffer which is used for decompression of
38  /// compressed sample wave streams - this value should always be bigger than  /// compressed sample wave streams - this value should always be bigger than
# Line 51  Line 57 
57    
58  namespace gig {  namespace gig {
59    
 // *************** progress_t ***************  
 // *  
   
     progress_t::progress_t() {  
         callback    = NULL;  
         custom      = NULL;  
         __range_min = 0.0f;  
         __range_max = 1.0f;  
     }  
   
     // private helper function to convert progress of a subprocess into the global progress  
     static void __notify_progress(progress_t* pProgress, float subprogress) {  
         if (pProgress && pProgress->callback) {  
             const float totalrange    = pProgress->__range_max - pProgress->__range_min;  
             const float totalprogress = pProgress->__range_min + subprogress * totalrange;  
             pProgress->factor         = totalprogress;  
             pProgress->callback(pProgress); // now actually notify about the progress  
         }  
     }  
   
     // private helper function to divide a progress into subprogresses  
     static void __divide_progress(progress_t* pParentProgress, progress_t* pSubProgress, float totalTasks, float currentTask) {  
         if (pParentProgress && pParentProgress->callback) {  
             const float totalrange    = pParentProgress->__range_max - pParentProgress->__range_min;  
             pSubProgress->callback    = pParentProgress->callback;  
             pSubProgress->custom      = pParentProgress->custom;  
             pSubProgress->__range_min = pParentProgress->__range_min + totalrange * currentTask / totalTasks;  
             pSubProgress->__range_max = pSubProgress->__range_min + totalrange / totalTasks;  
         }  
     }  
   
   
60  // *************** Internal functions for sample decompression ***************  // *************** Internal functions for sample decompression ***************
61  // *  // *
62    
# Line 121  namespace { Line 95  namespace {
95      void Decompress16(int compressionmode, const unsigned char* params,      void Decompress16(int compressionmode, const unsigned char* params,
96                        int srcStep, int dstStep,                        int srcStep, int dstStep,
97                        const unsigned char* pSrc, int16_t* pDst,                        const unsigned char* pSrc, int16_t* pDst,
98                        unsigned long currentframeoffset,                        file_offset_t currentframeoffset,
99                        unsigned long copysamples)                        file_offset_t copysamples)
100      {      {
101          switch (compressionmode) {          switch (compressionmode) {
102              case 0: // 16 bit uncompressed              case 0: // 16 bit uncompressed
# Line 158  namespace { Line 132  namespace {
132    
133      void Decompress24(int compressionmode, const unsigned char* params,      void Decompress24(int compressionmode, const unsigned char* params,
134                        int dstStep, const unsigned char* pSrc, uint8_t* pDst,                        int dstStep, const unsigned char* pSrc, uint8_t* pDst,
135                        unsigned long currentframeoffset,                        file_offset_t currentframeoffset,
136                        unsigned long copysamples, int truncatedBits)                        file_offset_t copysamples, int truncatedBits)
137      {      {
138          int y, dy, ddy, dddy;          int y, dy, ddy, dddy;
139    
# Line 344  namespace { Line 318  namespace {
318  // *************** Sample ***************  // *************** Sample ***************
319  // *  // *
320    
321      unsigned int Sample::Instances = 0;      size_t       Sample::Instances = 0;
322      buffer_t     Sample::InternalDecompressionBuffer;      buffer_t     Sample::InternalDecompressionBuffer;
323    
324      /** @brief Constructor.      /** @brief Constructor.
# Line 365  namespace { Line 339  namespace {
339       * @param fileNo         - number of an extension file where this sample       * @param fileNo         - number of an extension file where this sample
340       *                         is located, 0 otherwise       *                         is located, 0 otherwise
341       */       */
342      Sample::Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {      Sample::Sample(File* pFile, RIFF::List* waveList, file_offset_t WavePoolOffset, unsigned long fileNo) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {
343          static const DLS::Info::string_length_t fixedStringLengths[] = {          static const DLS::Info::string_length_t fixedStringLengths[] = {
344              { CHUNK_ID_INAM, 64 },              { CHUNK_ID_INAM, 64 },
345              { 0, 0 }              { 0, 0 }
# Line 453  namespace { Line 427  namespace {
427      }      }
428    
429      /**      /**
430         * Make a (semi) deep copy of the Sample object given by @a orig (without
431         * the actual waveform data) and assign it to this object.
432         *
433         * Discussion: copying .gig samples is a bit tricky. It requires three
434         * steps:
435         * 1. Copy sample's meta informations (done by CopyAssignMeta()) including
436         *    its new sample waveform data size.
437         * 2. Saving the file (done by File::Save()) so that it gains correct size
438         *    and layout for writing the actual wave form data directly to disc
439         *    in next step.
440         * 3. Copy the waveform data with disk streaming (done by CopyAssignWave()).
441         *
442         * @param orig - original Sample object to be copied from
443         */
444        void Sample::CopyAssignMeta(const Sample* orig) {
445            // handle base classes
446            DLS::Sample::CopyAssignCore(orig);
447            
448            // handle actual own attributes of this class
449            Manufacturer = orig->Manufacturer;
450            Product = orig->Product;
451            SamplePeriod = orig->SamplePeriod;
452            MIDIUnityNote = orig->MIDIUnityNote;
453            FineTune = orig->FineTune;
454            SMPTEFormat = orig->SMPTEFormat;
455            SMPTEOffset = orig->SMPTEOffset;
456            Loops = orig->Loops;
457            LoopID = orig->LoopID;
458            LoopType = orig->LoopType;
459            LoopStart = orig->LoopStart;
460            LoopEnd = orig->LoopEnd;
461            LoopSize = orig->LoopSize;
462            LoopFraction = orig->LoopFraction;
463            LoopPlayCount = orig->LoopPlayCount;
464            
465            // schedule resizing this sample to the given sample's size
466            Resize(orig->GetSize());
467        }
468    
469        /**
470         * Should be called after CopyAssignMeta() and File::Save() sequence.
471         * Read more about it in the discussion of CopyAssignMeta(). This method
472         * copies the actual waveform data by disk streaming.
473         *
474         * @e CAUTION: this method is currently not thread safe! During this
475         * operation the sample must not be used for other purposes by other
476         * threads!
477         *
478         * @param orig - original Sample object to be copied from
479         */
480        void Sample::CopyAssignWave(const Sample* orig) {
481            const int iReadAtOnce = 32*1024;
482            char* buf = new char[iReadAtOnce * orig->FrameSize];
483            Sample* pOrig = (Sample*) orig; //HACK: remove constness for now
484            file_offset_t restorePos = pOrig->GetPos();
485            pOrig->SetPos(0);
486            SetPos(0);
487            for (file_offset_t n = pOrig->Read(buf, iReadAtOnce); n;
488                               n = pOrig->Read(buf, iReadAtOnce))
489            {
490                Write(buf, n);
491            }
492            pOrig->SetPos(restorePos);
493            delete [] buf;
494        }
495    
496        /**
497       * Apply sample and its settings to the respective RIFF chunks. You have       * Apply sample and its settings to the respective RIFF chunks. You have
498       * to call File::Save() to make changes persistent.       * to call File::Save() to make changes persistent.
499       *       *
500       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
501       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
502       *       *
503         * @param pProgress - callback function for progress notification
504       * @throws DLS::Exception if FormatTag != DLS_WAVE_FORMAT_PCM or no sample data       * @throws DLS::Exception if FormatTag != DLS_WAVE_FORMAT_PCM or no sample data
505       *                        was provided yet       *                        was provided yet
506       * @throws gig::Exception if there is any invalid sample setting       * @throws gig::Exception if there is any invalid sample setting
507       */       */
508      void Sample::UpdateChunks() {      void Sample::UpdateChunks(progress_t* pProgress) {
509          // first update base class's chunks          // first update base class's chunks
510          DLS::Sample::UpdateChunks();          DLS::Sample::UpdateChunks(pProgress);
511    
512          // make sure 'smpl' chunk exists          // make sure 'smpl' chunk exists
513          pCkSmpl = pWaveList->GetSubChunk(CHUNK_ID_SMPL);          pCkSmpl = pWaveList->GetSubChunk(CHUNK_ID_SMPL);
# Line 513  namespace { Line 555  namespace {
555          // update '3gix' chunk          // update '3gix' chunk
556          pData = (uint8_t*) pCk3gix->LoadChunkData();          pData = (uint8_t*) pCk3gix->LoadChunkData();
557          store16(&pData[0], iSampleGroup);          store16(&pData[0], iSampleGroup);
558    
559            // if the library user toggled the "Compressed" attribute from true to
560            // false, then the EWAV chunk associated with compressed samples needs
561            // to be deleted
562            RIFF::Chunk* ewav = pWaveList->GetSubChunk(CHUNK_ID_EWAV);
563            if (ewav && !Compressed) {
564                pWaveList->DeleteSubChunk(ewav);
565            }
566      }      }
567    
568      /// 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).
569      void Sample::ScanCompressedSample() {      void Sample::ScanCompressedSample() {
570          //TODO: we have to add some more scans here (e.g. determine compression rate)          //TODO: we have to add some more scans here (e.g. determine compression rate)
571          this->SamplesTotal = 0;          this->SamplesTotal = 0;
572          std::list<unsigned long> frameOffsets;          std::list<file_offset_t> frameOffsets;
573    
574          SamplesPerFrame = BitDepth == 24 ? 256 : 2048;          SamplesPerFrame = BitDepth == 24 ? 256 : 2048;
575          WorstCaseFrameSize = SamplesPerFrame * FrameSize + Channels; // +Channels for compression flag          WorstCaseFrameSize = SamplesPerFrame * FrameSize + Channels; // +Channels for compression flag
# Line 535  namespace { Line 585  namespace {
585                  const int mode_l = pCkData->ReadUint8();                  const int mode_l = pCkData->ReadUint8();
586                  const int mode_r = pCkData->ReadUint8();                  const int mode_r = pCkData->ReadUint8();
587                  if (mode_l > 5 || mode_r > 5) throw gig::Exception("Unknown compression mode");                  if (mode_l > 5 || mode_r > 5) throw gig::Exception("Unknown compression mode");
588                  const unsigned long frameSize = bytesPerFrame[mode_l] + bytesPerFrame[mode_r];                  const file_offset_t frameSize = bytesPerFrame[mode_l] + bytesPerFrame[mode_r];
589    
590                  if (pCkData->RemainingBytes() <= frameSize) {                  if (pCkData->RemainingBytes() <= frameSize) {
591                      SamplesInLastFrame =                      SamplesInLastFrame =
# Line 554  namespace { Line 604  namespace {
604    
605                  const int mode = pCkData->ReadUint8();                  const int mode = pCkData->ReadUint8();
606                  if (mode > 5) throw gig::Exception("Unknown compression mode");                  if (mode > 5) throw gig::Exception("Unknown compression mode");
607                  const unsigned long frameSize = bytesPerFrame[mode];                  const file_offset_t frameSize = bytesPerFrame[mode];
608    
609                  if (pCkData->RemainingBytes() <= frameSize) {                  if (pCkData->RemainingBytes() <= frameSize) {
610                      SamplesInLastFrame =                      SamplesInLastFrame =
# Line 570  namespace { Line 620  namespace {
620    
621          // Build the frames table (which is used for fast resolving of a frame's chunk offset)          // Build the frames table (which is used for fast resolving of a frame's chunk offset)
622          if (FrameTable) delete[] FrameTable;          if (FrameTable) delete[] FrameTable;
623          FrameTable = new unsigned long[frameOffsets.size()];          FrameTable = new file_offset_t[frameOffsets.size()];
624          std::list<unsigned long>::iterator end  = frameOffsets.end();          std::list<file_offset_t>::iterator end  = frameOffsets.end();
625          std::list<unsigned long>::iterator iter = frameOffsets.begin();          std::list<file_offset_t>::iterator iter = frameOffsets.begin();
626          for (int i = 0; iter != end; i++, iter++) {          for (int i = 0; iter != end; i++, iter++) {
627              FrameTable[i] = *iter;              FrameTable[i] = *iter;
628          }          }
# Line 613  namespace { Line 663  namespace {
663       *                      the cached sample data in bytes       *                      the cached sample data in bytes
664       * @see                 ReleaseSampleData(), Read(), SetPos()       * @see                 ReleaseSampleData(), Read(), SetPos()
665       */       */
666      buffer_t Sample::LoadSampleData(unsigned long SampleCount) {      buffer_t Sample::LoadSampleData(file_offset_t SampleCount) {
667          return LoadSampleDataWithNullSamplesExtension(SampleCount, 0); // 0 amount of NullSamples          return LoadSampleDataWithNullSamplesExtension(SampleCount, 0); // 0 amount of NullSamples
668      }      }
669    
# Line 672  namespace { Line 722  namespace {
722       *                           size of the cached sample data in bytes       *                           size of the cached sample data in bytes
723       * @see                      ReleaseSampleData(), Read(), SetPos()       * @see                      ReleaseSampleData(), Read(), SetPos()
724       */       */
725      buffer_t Sample::LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount) {      buffer_t Sample::LoadSampleDataWithNullSamplesExtension(file_offset_t SampleCount, uint NullSamplesCount) {
726          if (SampleCount > this->SamplesTotal) SampleCount = this->SamplesTotal;          if (SampleCount > this->SamplesTotal) SampleCount = this->SamplesTotal;
727          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
728          unsigned long allocationsize = (SampleCount + NullSamplesCount) * this->FrameSize;          file_offset_t allocationsize = (SampleCount + NullSamplesCount) * this->FrameSize;
729            SetPos(0); // reset read position to begin of sample
730          RAMCache.pStart            = new int8_t[allocationsize];          RAMCache.pStart            = new int8_t[allocationsize];
731          RAMCache.Size              = Read(RAMCache.pStart, SampleCount) * this->FrameSize;          RAMCache.Size              = Read(RAMCache.pStart, SampleCount) * this->FrameSize;
732          RAMCache.NullExtensionSize = allocationsize - RAMCache.Size;          RAMCache.NullExtensionSize = allocationsize - RAMCache.Size;
# Line 713  namespace { Line 764  namespace {
764          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
765          RAMCache.pStart = NULL;          RAMCache.pStart = NULL;
766          RAMCache.Size   = 0;          RAMCache.Size   = 0;
767            RAMCache.NullExtensionSize = 0;
768      }      }
769    
770      /** @brief Resize sample.      /** @brief Resize sample.
# Line 737  namespace { Line 789  namespace {
789       * FormatTag must be DLS_WAVE_FORMAT_PCM. Trying to resize samples with       * FormatTag must be DLS_WAVE_FORMAT_PCM. Trying to resize samples with
790       * other formats will fail!       * other formats will fail!
791       *       *
792       * @param iNewSize - new sample wave data size in sample points (must be       * @param NewSize - new sample wave data size in sample points (must be
793       *                   greater than zero)       *                  greater than zero)
794       * @throws DLS::Excecption if FormatTag != DLS_WAVE_FORMAT_PCM       * @throws DLS::Excecption if FormatTag != DLS_WAVE_FORMAT_PCM
795       *                         or if \a iNewSize is less than 1       * @throws DLS::Exception if \a NewSize is less than 1 or unrealistic large
796       * @throws gig::Exception if existing sample is compressed       * @throws gig::Exception if existing sample is compressed
797       * @see DLS::Sample::GetSize(), DLS::Sample::FrameSize,       * @see DLS::Sample::GetSize(), DLS::Sample::FrameSize,
798       *      DLS::Sample::FormatTag, File::Save()       *      DLS::Sample::FormatTag, File::Save()
799       */       */
800      void Sample::Resize(int iNewSize) {      void Sample::Resize(file_offset_t NewSize) {
801          if (Compressed) throw gig::Exception("There is no support for modifying compressed samples (yet)");          if (Compressed) throw gig::Exception("There is no support for modifying compressed samples (yet)");
802          DLS::Sample::Resize(iNewSize);          DLS::Sample::Resize(NewSize);
803      }      }
804    
805      /**      /**
# Line 771  namespace { Line 823  namespace {
823       * @returns            the new sample position       * @returns            the new sample position
824       * @see                Read()       * @see                Read()
825       */       */
826      unsigned long Sample::SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence) {      file_offset_t Sample::SetPos(file_offset_t SampleCount, RIFF::stream_whence_t Whence) {
827          if (Compressed) {          if (Compressed) {
828              switch (Whence) {              switch (Whence) {
829                  case RIFF::stream_curpos:                  case RIFF::stream_curpos:
# Line 789  namespace { Line 841  namespace {
841              }              }
842              if (this->SamplePos > this->SamplesTotal) this->SamplePos = this->SamplesTotal;              if (this->SamplePos > this->SamplesTotal) this->SamplePos = this->SamplesTotal;
843    
844              unsigned long frame = this->SamplePos / 2048; // to which frame to jump              file_offset_t frame = this->SamplePos / 2048; // to which frame to jump
845              this->FrameOffset   = this->SamplePos % 2048; // offset (in sample points) within that frame              this->FrameOffset   = this->SamplePos % 2048; // offset (in sample points) within that frame
846              pCkData->SetPos(FrameTable[frame]);           // set chunk pointer to the start of sought frame              pCkData->SetPos(FrameTable[frame]);           // set chunk pointer to the start of sought frame
847              return this->SamplePos;              return this->SamplePos;
848          }          }
849          else { // not compressed          else { // not compressed
850              unsigned long orderedBytes = SampleCount * this->FrameSize;              file_offset_t orderedBytes = SampleCount * this->FrameSize;
851              unsigned long result = pCkData->SetPos(orderedBytes, Whence);              file_offset_t result = pCkData->SetPos(orderedBytes, Whence);
852              return (result == orderedBytes) ? SampleCount              return (result == orderedBytes) ? SampleCount
853                                              : result / this->FrameSize;                                              : result / this->FrameSize;
854          }          }
# Line 805  namespace { Line 857  namespace {
857      /**      /**
858       * Returns the current position in the sample (in sample points).       * Returns the current position in the sample (in sample points).
859       */       */
860      unsigned long Sample::GetPos() {      file_offset_t Sample::GetPos() const {
861          if (Compressed) return SamplePos;          if (Compressed) return SamplePos;
862          else            return pCkData->GetPos() / FrameSize;          else            return pCkData->GetPos() / FrameSize;
863      }      }
# Line 844  namespace { Line 896  namespace {
896       * @returns                number of successfully read sample points       * @returns                number of successfully read sample points
897       * @see                    CreateDecompressionBuffer()       * @see                    CreateDecompressionBuffer()
898       */       */
899      unsigned long Sample::ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState,      file_offset_t Sample::ReadAndLoop(void* pBuffer, file_offset_t SampleCount, playback_state_t* pPlaybackState,
900                                        DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer) {                                        DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer) {
901          unsigned long samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;          file_offset_t samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;
902          uint8_t* pDst = (uint8_t*) pBuffer;          uint8_t* pDst = (uint8_t*) pBuffer;
903    
904          SetPos(pPlaybackState->position); // recover position from the last time          SetPos(pPlaybackState->position); // recover position from the last time
# Line 884  namespace { Line 936  namespace {
936                                  // reading, swap all sample frames so it reflects                                  // reading, swap all sample frames so it reflects
937                                  // backward playback                                  // backward playback
938    
939                                  unsigned long swapareastart       = totalreadsamples;                                  file_offset_t swapareastart       = totalreadsamples;
940                                  unsigned long loopoffset          = GetPos() - loop.LoopStart;                                  file_offset_t loopoffset          = GetPos() - loop.LoopStart;
941                                  unsigned long samplestoreadinloop = Min(samplestoread, loopoffset);                                  file_offset_t samplestoreadinloop = Min(samplestoread, loopoffset);
942                                  unsigned long reverseplaybackend  = GetPos() - samplestoreadinloop;                                  file_offset_t reverseplaybackend  = GetPos() - samplestoreadinloop;
943    
944                                  SetPos(reverseplaybackend);                                  SetPos(reverseplaybackend);
945    
# Line 907  namespace { Line 959  namespace {
959                                  }                                  }
960    
961                                  // reverse the sample frames for backward playback                                  // reverse the sample frames for backward playback
962                                  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!
963                                        SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
964                              }                              }
965                          } while (samplestoread && readsamples);                          } while (samplestoread && readsamples);
966                          break;                          break;
# Line 934  namespace { Line 987  namespace {
987                          // reading, swap all sample frames so it reflects                          // reading, swap all sample frames so it reflects
988                          // backward playback                          // backward playback
989    
990                          unsigned long swapareastart       = totalreadsamples;                          file_offset_t swapareastart       = totalreadsamples;
991                          unsigned long loopoffset          = GetPos() - loop.LoopStart;                          file_offset_t loopoffset          = GetPos() - loop.LoopStart;
992                          unsigned long samplestoreadinloop = (this->LoopPlayCount) ? Min(samplestoread, pPlaybackState->loop_cycles_left * loop.LoopLength - loopoffset)                          file_offset_t samplestoreadinloop = (this->LoopPlayCount) ? Min(samplestoread, pPlaybackState->loop_cycles_left * loop.LoopLength - loopoffset)
993                                                                                    : samplestoread;                                                                                    : samplestoread;
994                          unsigned long reverseplaybackend  = loop.LoopStart + Abs((loopoffset - samplestoreadinloop) % loop.LoopLength);                          file_offset_t reverseplaybackend  = loop.LoopStart + Abs((loopoffset - samplestoreadinloop) % loop.LoopLength);
995    
996                          SetPos(reverseplaybackend);                          SetPos(reverseplaybackend);
997    
# Line 1018  namespace { Line 1071  namespace {
1071       * @returns            number of successfully read sample points       * @returns            number of successfully read sample points
1072       * @see                SetPos(), CreateDecompressionBuffer()       * @see                SetPos(), CreateDecompressionBuffer()
1073       */       */
1074      unsigned long Sample::Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer) {      file_offset_t Sample::Read(void* pBuffer, file_offset_t SampleCount, buffer_t* pExternalDecompressionBuffer) {
1075          if (SampleCount == 0) return 0;          if (SampleCount == 0) return 0;
1076          if (!Compressed) {          if (!Compressed) {
1077              if (BitDepth == 24) {              if (BitDepth == 24) {
# Line 1033  namespace { Line 1086  namespace {
1086          else {          else {
1087              if (this->SamplePos >= this->SamplesTotal) return 0;              if (this->SamplePos >= this->SamplesTotal) return 0;
1088              //TODO: efficiency: maybe we should test for an average compression rate              //TODO: efficiency: maybe we should test for an average compression rate
1089              unsigned long assumedsize      = GuessSize(SampleCount),              file_offset_t assumedsize      = GuessSize(SampleCount),
1090                            remainingbytes   = 0,           // remaining bytes in the local buffer                            remainingbytes   = 0,           // remaining bytes in the local buffer
1091                            remainingsamples = SampleCount,                            remainingsamples = SampleCount,
1092                            copysamples, skipsamples,                            copysamples, skipsamples,
# Line 1056  namespace { Line 1109  namespace {
1109              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);
1110    
1111              while (remainingsamples && remainingbytes) {              while (remainingsamples && remainingbytes) {
1112                  unsigned long framesamples = SamplesPerFrame;                  file_offset_t framesamples = SamplesPerFrame;
1113                  unsigned long framebytes, rightChannelOffset = 0, nextFrameOffset;                  file_offset_t framebytes, rightChannelOffset = 0, nextFrameOffset;
1114    
1115                  int mode_l = *pSrc++, mode_r = 0;                  int mode_l = *pSrc++, mode_r = 0;
1116    
# Line 1207  namespace { Line 1260  namespace {
1260       * @throws gig::Exception if sample is compressed       * @throws gig::Exception if sample is compressed
1261       * @see DLS::LoadSampleData()       * @see DLS::LoadSampleData()
1262       */       */
1263      unsigned long Sample::Write(void* pBuffer, unsigned long SampleCount) {      file_offset_t Sample::Write(void* pBuffer, file_offset_t SampleCount) {
1264          if (Compressed) throw gig::Exception("There is no support for writing compressed gig samples (yet)");          if (Compressed) throw gig::Exception("There is no support for writing compressed gig samples (yet)");
1265    
1266          // if this is the first write in this sample, reset the          // if this is the first write in this sample, reset the
# Line 1216  namespace { Line 1269  namespace {
1269              __resetCRC(crc);              __resetCRC(crc);
1270          }          }
1271          if (GetSize() < SampleCount) throw Exception("Could not write sample data, current sample size to small");          if (GetSize() < SampleCount) throw Exception("Could not write sample data, current sample size to small");
1272          unsigned long res;          file_offset_t res;
1273          if (BitDepth == 24) {          if (BitDepth == 24) {
1274              res = pCkData->Write(pBuffer, SampleCount * FrameSize, 1) / FrameSize;              res = pCkData->Write(pBuffer, SampleCount * FrameSize, 1) / FrameSize;
1275          } else { // 16 bit          } else { // 16 bit
# Line 1250  namespace { Line 1303  namespace {
1303       * @returns allocated decompression buffer       * @returns allocated decompression buffer
1304       * @see DestroyDecompressionBuffer()       * @see DestroyDecompressionBuffer()
1305       */       */
1306      buffer_t Sample::CreateDecompressionBuffer(unsigned long MaxReadSize) {      buffer_t Sample::CreateDecompressionBuffer(file_offset_t MaxReadSize) {
1307          buffer_t result;          buffer_t result;
1308          const double worstCaseHeaderOverhead =          const double worstCaseHeaderOverhead =
1309                  (256.0 /*frame size*/ + 12.0 /*header*/ + 2.0 /*compression type flag (stereo)*/) / 256.0;                  (256.0 /*frame size*/ + 12.0 /*header*/ + 2.0 /*compression type flag (stereo)*/) / 256.0;
1310          result.Size              = (unsigned long) (double(MaxReadSize) * 3.0 /*(24 Bit)*/ * 2.0 /*stereo*/ * worstCaseHeaderOverhead);          result.Size              = (file_offset_t) (double(MaxReadSize) * 3.0 /*(24 Bit)*/ * 2.0 /*stereo*/ * worstCaseHeaderOverhead);
1311          result.pStart            = new int8_t[result.Size];          result.pStart            = new int8_t[result.Size];
1312          result.NullExtensionSize = 0;          result.NullExtensionSize = 0;
1313          return result;          return result;
# Line 1304  namespace { Line 1357  namespace {
1357  // *************** DimensionRegion ***************  // *************** DimensionRegion ***************
1358  // *  // *
1359    
1360      uint                               DimensionRegion::Instances       = 0;      size_t                             DimensionRegion::Instances       = 0;
1361      DimensionRegion::VelocityTableMap* DimensionRegion::pVelocityTables = NULL;      DimensionRegion::VelocityTableMap* DimensionRegion::pVelocityTables = NULL;
1362    
1363      DimensionRegion::DimensionRegion(Region* pParent, RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {      DimensionRegion::DimensionRegion(Region* pParent, RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {
# Line 1429  namespace { Line 1482  namespace {
1482                                                          : vcf_res_ctrl_none;                                                          : vcf_res_ctrl_none;
1483              uint16_t eg3depth = _3ewa->ReadUint16();              uint16_t eg3depth = _3ewa->ReadUint16();
1484              EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */              EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */
1485                                          : (-1) * (int16_t) ((eg3depth ^ 0xffff) + 1); /* binary complementary for negatives */                                          : (-1) * (int16_t) ((eg3depth ^ 0xfff) + 1); /* binary complementary for negatives */
1486              _3ewa->ReadInt16(); // unknown              _3ewa->ReadInt16(); // unknown
1487              ChannelOffset = _3ewa->ReadUint8() / 4;              ChannelOffset = _3ewa->ReadUint8() / 4;
1488              uint8_t regoptions = _3ewa->ReadUint8();              uint8_t regoptions = _3ewa->ReadUint8();
# Line 1577  namespace { Line 1630  namespace {
1630       */       */
1631      DimensionRegion::DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src) : DLS::Sampler(_3ewl) {      DimensionRegion::DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src) : DLS::Sampler(_3ewl) {
1632          Instances++;          Instances++;
1633            //NOTE: I think we cannot call CopyAssign() here (in a constructor) as long as its a virtual method
1634          *this = src; // default memberwise shallow copy of all parameters          *this = src; // default memberwise shallow copy of all parameters
1635          pParentList = _3ewl; // restore the chunk pointer          pParentList = _3ewl; // restore the chunk pointer
1636    
# Line 1592  namespace { Line 1646  namespace {
1646                  pSampleLoops[k] = src.pSampleLoops[k];                  pSampleLoops[k] = src.pSampleLoops[k];
1647          }          }
1648      }      }
1649        
1650        /**
1651         * Make a (semi) deep copy of the DimensionRegion object given by @a orig
1652         * and assign it to this object.
1653         *
1654         * Note that all sample pointers referenced by @a orig are simply copied as
1655         * memory address. Thus the respective samples are shared, not duplicated!
1656         *
1657         * @param orig - original DimensionRegion object to be copied from
1658         */
1659        void DimensionRegion::CopyAssign(const DimensionRegion* orig) {
1660            CopyAssign(orig, NULL);
1661        }
1662    
1663        /**
1664         * Make a (semi) deep copy of the DimensionRegion object given by @a orig
1665         * and assign it to this object.
1666         *
1667         * @param orig - original DimensionRegion object to be copied from
1668         * @param mSamples - crosslink map between the foreign file's samples and
1669         *                   this file's samples
1670         */
1671        void DimensionRegion::CopyAssign(const DimensionRegion* orig, const std::map<Sample*,Sample*>* mSamples) {
1672            // delete all allocated data first
1673            if (VelocityTable) delete [] VelocityTable;
1674            if (pSampleLoops) delete [] pSampleLoops;
1675            
1676            // backup parent list pointer
1677            RIFF::List* p = pParentList;
1678            
1679            gig::Sample* pOriginalSample = pSample;
1680            gig::Region* pOriginalRegion = pRegion;
1681            
1682            //NOTE: copy code copied from assignment constructor above, see comment there as well
1683            
1684            *this = *orig; // default memberwise shallow copy of all parameters
1685            
1686            // restore members that shall not be altered
1687            pParentList = p; // restore the chunk pointer
1688            pRegion = pOriginalRegion;
1689            
1690            // only take the raw sample reference reference if the
1691            // two DimensionRegion objects are part of the same file
1692            if (pOriginalRegion->GetParent()->GetParent() != orig->pRegion->GetParent()->GetParent()) {
1693                pSample = pOriginalSample;
1694            }
1695            
1696            if (mSamples && mSamples->count(orig->pSample)) {
1697                pSample = mSamples->find(orig->pSample)->second;
1698            }
1699    
1700            // deep copy of owned structures
1701            if (orig->VelocityTable) {
1702                VelocityTable = new uint8_t[128];
1703                for (int k = 0 ; k < 128 ; k++)
1704                    VelocityTable[k] = orig->VelocityTable[k];
1705            }
1706            if (orig->pSampleLoops) {
1707                pSampleLoops = new DLS::sample_loop_t[orig->SampleLoops];
1708                for (int k = 0 ; k < orig->SampleLoops ; k++)
1709                    pSampleLoops[k] = orig->pSampleLoops[k];
1710            }
1711        }
1712    
1713      /**      /**
1714       * Updates the respective member variable and updates @c SampleAttenuation       * Updates the respective member variable and updates @c SampleAttenuation
# Line 1608  namespace { Line 1725  namespace {
1725       *       *
1726       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
1727       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
1728         *
1729         * @param pProgress - callback function for progress notification
1730       */       */
1731      void DimensionRegion::UpdateChunks() {      void DimensionRegion::UpdateChunks(progress_t* pProgress) {
1732          // first update base class's chunk          // first update base class's chunk
1733          DLS::Sampler::UpdateChunks();          DLS::Sampler::UpdateChunks(pProgress);
1734    
1735          RIFF::Chunk* wsmp = pParentList->GetSubChunk(CHUNK_ID_WSMP);          RIFF::Chunk* wsmp = pParentList->GetSubChunk(CHUNK_ID_WSMP);
1736          uint8_t* pData = (uint8_t*) wsmp->LoadChunkData();          uint8_t* pData = (uint8_t*) wsmp->LoadChunkData();
# Line 1833  namespace { Line 1952  namespace {
1952          }          }
1953    
1954          const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth          const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth
1955                                                    : uint16_t(((-EG3Depth) - 1) ^ 0xffff); /* binary complementary for negatives */                                                    : uint16_t(((-EG3Depth) - 1) ^ 0xfff); /* binary complementary for negatives */
1956          pData[116] = eg3depth;          store16(&pData[116], eg3depth);
1957    
1958          // next 2 bytes unknown          // next 2 bytes unknown
1959    
# Line 1881  namespace { Line 2000  namespace {
2000                                        (VCFKeyboardTrackingBreakpoint & 0x7f); /* lower 7 bits */                                        (VCFKeyboardTrackingBreakpoint & 0x7f); /* lower 7 bits */
2001          pData[137] = vcfbreakpoint;          pData[137] = vcfbreakpoint;
2002    
2003          const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 |          const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 +
2004                                      VCFVelocityCurve * 5;                                      VCFVelocityCurve * 5;
2005          pData[138] = vcfvelocity;          pData[138] = vcfvelocity;
2006    
# Line 1946  namespace { Line 2065  namespace {
2065          return pRegion;          return pRegion;
2066      }      }
2067    
2068    // show error if some _lev_ctrl_* enum entry is not listed in the following function
2069    // (commented out for now, because "diagnostic push" not supported prior GCC 4.6)
2070    // TODO: uncomment and add a GCC version check (see also commented "#pragma GCC diagnostic pop" below)
2071    //#pragma GCC diagnostic push
2072    //#pragma GCC diagnostic error "-Wswitch"
2073    
2074      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {
2075          leverage_ctrl_t decodedcontroller;          leverage_ctrl_t decodedcontroller;
2076          switch (EncodedController) {          switch (EncodedController) {
# Line 2057  namespace { Line 2182  namespace {
2182                  decodedcontroller.controller_number = 95;                  decodedcontroller.controller_number = 95;
2183                  break;                  break;
2184    
2185                // format extension (these controllers are so far only supported by
2186                // LinuxSampler & gigedit) they will *NOT* work with
2187                // Gigasampler/GigaStudio !
2188                case _lev_ctrl_CC3_EXT:
2189                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2190                    decodedcontroller.controller_number = 3;
2191                    break;
2192                case _lev_ctrl_CC6_EXT:
2193                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2194                    decodedcontroller.controller_number = 6;
2195                    break;
2196                case _lev_ctrl_CC7_EXT:
2197                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2198                    decodedcontroller.controller_number = 7;
2199                    break;
2200                case _lev_ctrl_CC8_EXT:
2201                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2202                    decodedcontroller.controller_number = 8;
2203                    break;
2204                case _lev_ctrl_CC9_EXT:
2205                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2206                    decodedcontroller.controller_number = 9;
2207                    break;
2208                case _lev_ctrl_CC10_EXT:
2209                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2210                    decodedcontroller.controller_number = 10;
2211                    break;
2212                case _lev_ctrl_CC11_EXT:
2213                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2214                    decodedcontroller.controller_number = 11;
2215                    break;
2216                case _lev_ctrl_CC14_EXT:
2217                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2218                    decodedcontroller.controller_number = 14;
2219                    break;
2220                case _lev_ctrl_CC15_EXT:
2221                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2222                    decodedcontroller.controller_number = 15;
2223                    break;
2224                case _lev_ctrl_CC20_EXT:
2225                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2226                    decodedcontroller.controller_number = 20;
2227                    break;
2228                case _lev_ctrl_CC21_EXT:
2229                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2230                    decodedcontroller.controller_number = 21;
2231                    break;
2232                case _lev_ctrl_CC22_EXT:
2233                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2234                    decodedcontroller.controller_number = 22;
2235                    break;
2236                case _lev_ctrl_CC23_EXT:
2237                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2238                    decodedcontroller.controller_number = 23;
2239                    break;
2240                case _lev_ctrl_CC24_EXT:
2241                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2242                    decodedcontroller.controller_number = 24;
2243                    break;
2244                case _lev_ctrl_CC25_EXT:
2245                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2246                    decodedcontroller.controller_number = 25;
2247                    break;
2248                case _lev_ctrl_CC26_EXT:
2249                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2250                    decodedcontroller.controller_number = 26;
2251                    break;
2252                case _lev_ctrl_CC27_EXT:
2253                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2254                    decodedcontroller.controller_number = 27;
2255                    break;
2256                case _lev_ctrl_CC28_EXT:
2257                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2258                    decodedcontroller.controller_number = 28;
2259                    break;
2260                case _lev_ctrl_CC29_EXT:
2261                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2262                    decodedcontroller.controller_number = 29;
2263                    break;
2264                case _lev_ctrl_CC30_EXT:
2265                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2266                    decodedcontroller.controller_number = 30;
2267                    break;
2268                case _lev_ctrl_CC31_EXT:
2269                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2270                    decodedcontroller.controller_number = 31;
2271                    break;
2272                case _lev_ctrl_CC68_EXT:
2273                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2274                    decodedcontroller.controller_number = 68;
2275                    break;
2276                case _lev_ctrl_CC69_EXT:
2277                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2278                    decodedcontroller.controller_number = 69;
2279                    break;
2280                case _lev_ctrl_CC70_EXT:
2281                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2282                    decodedcontroller.controller_number = 70;
2283                    break;
2284                case _lev_ctrl_CC71_EXT:
2285                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2286                    decodedcontroller.controller_number = 71;
2287                    break;
2288                case _lev_ctrl_CC72_EXT:
2289                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2290                    decodedcontroller.controller_number = 72;
2291                    break;
2292                case _lev_ctrl_CC73_EXT:
2293                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2294                    decodedcontroller.controller_number = 73;
2295                    break;
2296                case _lev_ctrl_CC74_EXT:
2297                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2298                    decodedcontroller.controller_number = 74;
2299                    break;
2300                case _lev_ctrl_CC75_EXT:
2301                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2302                    decodedcontroller.controller_number = 75;
2303                    break;
2304                case _lev_ctrl_CC76_EXT:
2305                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2306                    decodedcontroller.controller_number = 76;
2307                    break;
2308                case _lev_ctrl_CC77_EXT:
2309                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2310                    decodedcontroller.controller_number = 77;
2311                    break;
2312                case _lev_ctrl_CC78_EXT:
2313                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2314                    decodedcontroller.controller_number = 78;
2315                    break;
2316                case _lev_ctrl_CC79_EXT:
2317                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2318                    decodedcontroller.controller_number = 79;
2319                    break;
2320                case _lev_ctrl_CC84_EXT:
2321                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2322                    decodedcontroller.controller_number = 84;
2323                    break;
2324                case _lev_ctrl_CC85_EXT:
2325                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2326                    decodedcontroller.controller_number = 85;
2327                    break;
2328                case _lev_ctrl_CC86_EXT:
2329                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2330                    decodedcontroller.controller_number = 86;
2331                    break;
2332                case _lev_ctrl_CC87_EXT:
2333                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2334                    decodedcontroller.controller_number = 87;
2335                    break;
2336                case _lev_ctrl_CC89_EXT:
2337                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2338                    decodedcontroller.controller_number = 89;
2339                    break;
2340                case _lev_ctrl_CC90_EXT:
2341                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2342                    decodedcontroller.controller_number = 90;
2343                    break;
2344                case _lev_ctrl_CC96_EXT:
2345                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2346                    decodedcontroller.controller_number = 96;
2347                    break;
2348                case _lev_ctrl_CC97_EXT:
2349                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2350                    decodedcontroller.controller_number = 97;
2351                    break;
2352                case _lev_ctrl_CC102_EXT:
2353                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2354                    decodedcontroller.controller_number = 102;
2355                    break;
2356                case _lev_ctrl_CC103_EXT:
2357                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2358                    decodedcontroller.controller_number = 103;
2359                    break;
2360                case _lev_ctrl_CC104_EXT:
2361                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2362                    decodedcontroller.controller_number = 104;
2363                    break;
2364                case _lev_ctrl_CC105_EXT:
2365                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2366                    decodedcontroller.controller_number = 105;
2367                    break;
2368                case _lev_ctrl_CC106_EXT:
2369                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2370                    decodedcontroller.controller_number = 106;
2371                    break;
2372                case _lev_ctrl_CC107_EXT:
2373                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2374                    decodedcontroller.controller_number = 107;
2375                    break;
2376                case _lev_ctrl_CC108_EXT:
2377                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2378                    decodedcontroller.controller_number = 108;
2379                    break;
2380                case _lev_ctrl_CC109_EXT:
2381                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2382                    decodedcontroller.controller_number = 109;
2383                    break;
2384                case _lev_ctrl_CC110_EXT:
2385                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2386                    decodedcontroller.controller_number = 110;
2387                    break;
2388                case _lev_ctrl_CC111_EXT:
2389                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2390                    decodedcontroller.controller_number = 111;
2391                    break;
2392                case _lev_ctrl_CC112_EXT:
2393                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2394                    decodedcontroller.controller_number = 112;
2395                    break;
2396                case _lev_ctrl_CC113_EXT:
2397                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2398                    decodedcontroller.controller_number = 113;
2399                    break;
2400                case _lev_ctrl_CC114_EXT:
2401                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2402                    decodedcontroller.controller_number = 114;
2403                    break;
2404                case _lev_ctrl_CC115_EXT:
2405                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2406                    decodedcontroller.controller_number = 115;
2407                    break;
2408                case _lev_ctrl_CC116_EXT:
2409                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2410                    decodedcontroller.controller_number = 116;
2411                    break;
2412                case _lev_ctrl_CC117_EXT:
2413                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2414                    decodedcontroller.controller_number = 117;
2415                    break;
2416                case _lev_ctrl_CC118_EXT:
2417                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2418                    decodedcontroller.controller_number = 118;
2419                    break;
2420                case _lev_ctrl_CC119_EXT:
2421                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
2422                    decodedcontroller.controller_number = 119;
2423                    break;
2424    
2425              // unknown controller type              // unknown controller type
2426              default:              default:
2427                  throw gig::Exception("Unknown leverage controller type.");                  throw gig::Exception("Unknown leverage controller type.");
2428          }          }
2429          return decodedcontroller;          return decodedcontroller;
2430      }      }
2431        
2432    // see above (diagnostic push not supported prior GCC 4.6)
2433    //#pragma GCC diagnostic pop
2434    
2435      DimensionRegion::_lev_ctrl_t DimensionRegion::EncodeLeverageController(leverage_ctrl_t DecodedController) {      DimensionRegion::_lev_ctrl_t DimensionRegion::EncodeLeverageController(leverage_ctrl_t DecodedController) {
2436          _lev_ctrl_t encodedcontroller;          _lev_ctrl_t encodedcontroller;
# Line 2150  namespace { Line 2518  namespace {
2518                      case 95:                      case 95:
2519                          encodedcontroller = _lev_ctrl_effect5depth;                          encodedcontroller = _lev_ctrl_effect5depth;
2520                          break;                          break;
2521    
2522                        // format extension (these controllers are so far only
2523                        // supported by LinuxSampler & gigedit) they will *NOT*
2524                        // work with Gigasampler/GigaStudio !
2525                        case 3:
2526                            encodedcontroller = _lev_ctrl_CC3_EXT;
2527                            break;
2528                        case 6:
2529                            encodedcontroller = _lev_ctrl_CC6_EXT;
2530                            break;
2531                        case 7:
2532                            encodedcontroller = _lev_ctrl_CC7_EXT;
2533                            break;
2534                        case 8:
2535                            encodedcontroller = _lev_ctrl_CC8_EXT;
2536                            break;
2537                        case 9:
2538                            encodedcontroller = _lev_ctrl_CC9_EXT;
2539                            break;
2540                        case 10:
2541                            encodedcontroller = _lev_ctrl_CC10_EXT;
2542                            break;
2543                        case 11:
2544                            encodedcontroller = _lev_ctrl_CC11_EXT;
2545                            break;
2546                        case 14:
2547                            encodedcontroller = _lev_ctrl_CC14_EXT;
2548                            break;
2549                        case 15:
2550                            encodedcontroller = _lev_ctrl_CC15_EXT;
2551                            break;
2552                        case 20:
2553                            encodedcontroller = _lev_ctrl_CC20_EXT;
2554                            break;
2555                        case 21:
2556                            encodedcontroller = _lev_ctrl_CC21_EXT;
2557                            break;
2558                        case 22:
2559                            encodedcontroller = _lev_ctrl_CC22_EXT;
2560                            break;
2561                        case 23:
2562                            encodedcontroller = _lev_ctrl_CC23_EXT;
2563                            break;
2564                        case 24:
2565                            encodedcontroller = _lev_ctrl_CC24_EXT;
2566                            break;
2567                        case 25:
2568                            encodedcontroller = _lev_ctrl_CC25_EXT;
2569                            break;
2570                        case 26:
2571                            encodedcontroller = _lev_ctrl_CC26_EXT;
2572                            break;
2573                        case 27:
2574                            encodedcontroller = _lev_ctrl_CC27_EXT;
2575                            break;
2576                        case 28:
2577                            encodedcontroller = _lev_ctrl_CC28_EXT;
2578                            break;
2579                        case 29:
2580                            encodedcontroller = _lev_ctrl_CC29_EXT;
2581                            break;
2582                        case 30:
2583                            encodedcontroller = _lev_ctrl_CC30_EXT;
2584                            break;
2585                        case 31:
2586                            encodedcontroller = _lev_ctrl_CC31_EXT;
2587                            break;
2588                        case 68:
2589                            encodedcontroller = _lev_ctrl_CC68_EXT;
2590                            break;
2591                        case 69:
2592                            encodedcontroller = _lev_ctrl_CC69_EXT;
2593                            break;
2594                        case 70:
2595                            encodedcontroller = _lev_ctrl_CC70_EXT;
2596                            break;
2597                        case 71:
2598                            encodedcontroller = _lev_ctrl_CC71_EXT;
2599                            break;
2600                        case 72:
2601                            encodedcontroller = _lev_ctrl_CC72_EXT;
2602                            break;
2603                        case 73:
2604                            encodedcontroller = _lev_ctrl_CC73_EXT;
2605                            break;
2606                        case 74:
2607                            encodedcontroller = _lev_ctrl_CC74_EXT;
2608                            break;
2609                        case 75:
2610                            encodedcontroller = _lev_ctrl_CC75_EXT;
2611                            break;
2612                        case 76:
2613                            encodedcontroller = _lev_ctrl_CC76_EXT;
2614                            break;
2615                        case 77:
2616                            encodedcontroller = _lev_ctrl_CC77_EXT;
2617                            break;
2618                        case 78:
2619                            encodedcontroller = _lev_ctrl_CC78_EXT;
2620                            break;
2621                        case 79:
2622                            encodedcontroller = _lev_ctrl_CC79_EXT;
2623                            break;
2624                        case 84:
2625                            encodedcontroller = _lev_ctrl_CC84_EXT;
2626                            break;
2627                        case 85:
2628                            encodedcontroller = _lev_ctrl_CC85_EXT;
2629                            break;
2630                        case 86:
2631                            encodedcontroller = _lev_ctrl_CC86_EXT;
2632                            break;
2633                        case 87:
2634                            encodedcontroller = _lev_ctrl_CC87_EXT;
2635                            break;
2636                        case 89:
2637                            encodedcontroller = _lev_ctrl_CC89_EXT;
2638                            break;
2639                        case 90:
2640                            encodedcontroller = _lev_ctrl_CC90_EXT;
2641                            break;
2642                        case 96:
2643                            encodedcontroller = _lev_ctrl_CC96_EXT;
2644                            break;
2645                        case 97:
2646                            encodedcontroller = _lev_ctrl_CC97_EXT;
2647                            break;
2648                        case 102:
2649                            encodedcontroller = _lev_ctrl_CC102_EXT;
2650                            break;
2651                        case 103:
2652                            encodedcontroller = _lev_ctrl_CC103_EXT;
2653                            break;
2654                        case 104:
2655                            encodedcontroller = _lev_ctrl_CC104_EXT;
2656                            break;
2657                        case 105:
2658                            encodedcontroller = _lev_ctrl_CC105_EXT;
2659                            break;
2660                        case 106:
2661                            encodedcontroller = _lev_ctrl_CC106_EXT;
2662                            break;
2663                        case 107:
2664                            encodedcontroller = _lev_ctrl_CC107_EXT;
2665                            break;
2666                        case 108:
2667                            encodedcontroller = _lev_ctrl_CC108_EXT;
2668                            break;
2669                        case 109:
2670                            encodedcontroller = _lev_ctrl_CC109_EXT;
2671                            break;
2672                        case 110:
2673                            encodedcontroller = _lev_ctrl_CC110_EXT;
2674                            break;
2675                        case 111:
2676                            encodedcontroller = _lev_ctrl_CC111_EXT;
2677                            break;
2678                        case 112:
2679                            encodedcontroller = _lev_ctrl_CC112_EXT;
2680                            break;
2681                        case 113:
2682                            encodedcontroller = _lev_ctrl_CC113_EXT;
2683                            break;
2684                        case 114:
2685                            encodedcontroller = _lev_ctrl_CC114_EXT;
2686                            break;
2687                        case 115:
2688                            encodedcontroller = _lev_ctrl_CC115_EXT;
2689                            break;
2690                        case 116:
2691                            encodedcontroller = _lev_ctrl_CC116_EXT;
2692                            break;
2693                        case 117:
2694                            encodedcontroller = _lev_ctrl_CC117_EXT;
2695                            break;
2696                        case 118:
2697                            encodedcontroller = _lev_ctrl_CC118_EXT;
2698                            break;
2699                        case 119:
2700                            encodedcontroller = _lev_ctrl_CC119_EXT;
2701                            break;
2702    
2703                      default:                      default:
2704                          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");
2705                  }                  }
# Line 2372  namespace { Line 2922  namespace {
2922    
2923          // Actual Loading          // Actual Loading
2924    
2925            if (!file->GetAutoLoad()) return;
2926    
2927          LoadDimensionRegions(rgnList);          LoadDimensionRegions(rgnList);
2928    
2929          RIFF::Chunk* _3lnk = rgnList->GetSubChunk(CHUNK_ID_3LNK);          RIFF::Chunk* _3lnk = rgnList->GetSubChunk(CHUNK_ID_3LNK);
# Line 2415  namespace { Line 2967  namespace {
2967              else              else
2968                  _3lnk->SetPos(44);                  _3lnk->SetPos(44);
2969    
2970              // load sample references              // load sample references (if auto loading is enabled)
2971              for (uint i = 0; i < DimensionRegions; i++) {              if (file->GetAutoLoad()) {
2972                  uint32_t wavepoolindex = _3lnk->ReadUint32();                  for (uint i = 0; i < DimensionRegions; i++) {
2973                  if (file->pWavePoolTable) pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);                      uint32_t wavepoolindex = _3lnk->ReadUint32();
2974                        if (file->pWavePoolTable) pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);
2975                    }
2976                    GetSample(); // load global region sample reference
2977              }              }
             GetSample(); // load global region sample reference  
2978          } else {          } else {
2979              DimensionRegions = 0;              DimensionRegions = 0;
2980              for (int i = 0 ; i < 8 ; i++) {              for (int i = 0 ; i < 8 ; i++) {
# Line 2447  namespace { Line 3001  namespace {
3001       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
3002       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
3003       *       *
3004         * @param pProgress - callback function for progress notification
3005       * @throws gig::Exception if samples cannot be dereferenced       * @throws gig::Exception if samples cannot be dereferenced
3006       */       */
3007      void Region::UpdateChunks() {      void Region::UpdateChunks(progress_t* pProgress) {
3008          // in the gig format we don't care about the Region's sample reference          // in the gig format we don't care about the Region's sample reference
3009          // but we still have to provide some existing one to not corrupt the          // but we still have to provide some existing one to not corrupt the
3010          // file, so to avoid the latter we simply always assign the sample of          // file, so to avoid the latter we simply always assign the sample of
# Line 2457  namespace { Line 3012  namespace {
3012          pSample = pDimensionRegions[0]->pSample;          pSample = pDimensionRegions[0]->pSample;
3013    
3014          // first update base class's chunks          // first update base class's chunks
3015          DLS::Region::UpdateChunks();          DLS::Region::UpdateChunks(pProgress);
3016    
3017          // update dimension region's chunks          // update dimension region's chunks
3018          for (int i = 0; i < DimensionRegions; i++) {          for (int i = 0; i < DimensionRegions; i++) {
3019              pDimensionRegions[i]->UpdateChunks();              pDimensionRegions[i]->UpdateChunks(pProgress);
3020          }          }
3021    
3022          File* pFile = (File*) GetParent()->GetParent();          File* pFile = (File*) GetParent()->GetParent();
# Line 2477  namespace { Line 3032  namespace {
3032              memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);              memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);
3033    
3034              // move 3prg to last position              // move 3prg to last position
3035              pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3PRG), 0);              pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3PRG), (RIFF::Chunk*)NULL);
3036          }          }
3037    
3038          // update dimension definitions in '3lnk' chunk          // update dimension definitions in '3lnk' chunk
# Line 2551  namespace { Line 3106  namespace {
3106          int step = 1;          int step = 1;
3107          for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;          for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;
3108          int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;          int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;
         int end = step * pDimensionDefinitions[veldim].zones;  
3109    
3110          // loop through all dimension regions for all dimensions except the velocity dimension          // loop through all dimension regions for all dimensions except the velocity dimension
3111          int dim[8] = { 0 };          int dim[8] = { 0 };
3112          for (int i = 0 ; i < DimensionRegions ; i++) {          for (int i = 0 ; i < DimensionRegions ; i++) {
3113                const int end = i + step * pDimensionDefinitions[veldim].zones;
3114    
3115                // create a velocity table for all cases where the velocity zone is zero
3116              if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||              if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||
3117                  pDimensionRegions[i]->VelocityUpperLimit) {                  pDimensionRegions[i]->VelocityUpperLimit) {
3118                  // create the velocity table                  // create the velocity table
# Line 2587  namespace { Line 3143  namespace {
3143                  }                  }
3144              }              }
3145    
3146                // jump to the next case where the velocity zone is zero
3147              int j;              int j;
3148              int shift = 0;              int shift = 0;
3149              for (j = 0 ; j < Dimensions ; j++) {              for (j = 0 ; j < Dimensions ; j++) {
# Line 2623  namespace { Line 3180  namespace {
3180       *                        dimension bits limit is violated       *                        dimension bits limit is violated
3181       */       */
3182      void Region::AddDimension(dimension_def_t* pDimDef) {      void Region::AddDimension(dimension_def_t* pDimDef) {
3183            // some initial sanity checks of the given dimension definition
3184            if (pDimDef->zones < 2)
3185                throw gig::Exception("Could not add new dimension, amount of requested zones must always be at least two");
3186            if (pDimDef->bits < 1)
3187                throw gig::Exception("Could not add new dimension, amount of requested requested zone bits must always be at least one");
3188            if (pDimDef->dimension == dimension_samplechannel) {
3189                if (pDimDef->zones != 2)
3190                    throw gig::Exception("Could not add new 'sample channel' dimensions, the requested amount of zones must always be 2 for this dimension type");
3191                if (pDimDef->bits != 1)
3192                    throw gig::Exception("Could not add new 'sample channel' dimensions, the requested amount of zone bits must always be 1 for this dimension type");
3193            }
3194    
3195          // check if max. amount of dimensions reached          // check if max. amount of dimensions reached
3196          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
3197          const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;          const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;
# Line 2798  namespace { Line 3367  namespace {
3367          if (pDimDef->dimension == dimension_layer) Layers = 1;          if (pDimDef->dimension == dimension_layer) Layers = 1;
3368      }      }
3369    
3370        /** @brief Delete one split zone of a dimension (decrement zone amount).
3371         *
3372         * Instead of deleting an entire dimensions, this method will only delete
3373         * one particular split zone given by @a zone of the Region's dimension
3374         * given by @a type. So this method will simply decrement the amount of
3375         * zones by one of the dimension in question. To be able to do that, the
3376         * respective dimension must exist on this Region and it must have at least
3377         * 3 zones. All DimensionRegion objects associated with the zone will be
3378         * deleted.
3379         *
3380         * @param type - identifies the dimension where a zone shall be deleted
3381         * @param zone - index of the dimension split zone that shall be deleted
3382         * @throws gig::Exception if requested zone could not be deleted
3383         */
3384        void Region::DeleteDimensionZone(dimension_t type, int zone) {
3385            dimension_def_t* oldDef = GetDimensionDefinition(type);
3386            if (!oldDef)
3387                throw gig::Exception("Could not delete dimension zone, no such dimension of given type");
3388            if (oldDef->zones <= 2)
3389                throw gig::Exception("Could not delete dimension zone, because it would end up with only one zone.");
3390            if (zone < 0 || zone >= oldDef->zones)
3391                throw gig::Exception("Could not delete dimension zone, requested zone index out of bounds.");
3392    
3393            const int newZoneSize = oldDef->zones - 1;
3394    
3395            // create a temporary Region which just acts as a temporary copy
3396            // container and will be deleted at the end of this function and will
3397            // also not be visible through the API during this process
3398            gig::Region* tempRgn = NULL;
3399            {
3400                // adding these temporary chunks is probably not even necessary
3401                Instrument* instr = static_cast<Instrument*>(GetParent());
3402                RIFF::List* pCkInstrument = instr->pCkInstrument;
3403                RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
3404                if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
3405                RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
3406                tempRgn = new Region(instr, rgn);
3407            }
3408    
3409            // copy this region's dimensions (with already the dimension split size
3410            // requested by the arguments of this method call) to the temporary
3411            // region, and don't use Region::CopyAssign() here for this task, since
3412            // it would also alter fast lookup helper variables here and there
3413            dimension_def_t newDef;
3414            for (int i = 0; i < Dimensions; ++i) {
3415                dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference
3416                // is this the dimension requested by the method arguments? ...
3417                if (def.dimension == type) { // ... if yes, decrement zone amount by one
3418                    def.zones = newZoneSize;
3419                    if ((1 << (def.bits - 1)) == def.zones) def.bits--;
3420                    newDef = def;
3421                }
3422                tempRgn->AddDimension(&def);
3423            }
3424    
3425            // find the dimension index in the tempRegion which is the dimension
3426            // type passed to this method (paranoidly expecting different order)
3427            int tempReducedDimensionIndex = -1;
3428            for (int d = 0; d < tempRgn->Dimensions; ++d) {
3429                if (tempRgn->pDimensionDefinitions[d].dimension == type) {
3430                    tempReducedDimensionIndex = d;
3431                    break;
3432                }
3433            }
3434    
3435            // copy dimension regions from this region to the temporary region
3436            for (int iDst = 0; iDst < 256; ++iDst) {
3437                DimensionRegion* dstDimRgn = tempRgn->pDimensionRegions[iDst];
3438                if (!dstDimRgn) continue;
3439                std::map<dimension_t,int> dimCase;
3440                bool isValidZone = true;
3441                for (int d = 0, baseBits = 0; d < tempRgn->Dimensions; ++d) {
3442                    const int dstBits = tempRgn->pDimensionDefinitions[d].bits;
3443                    dimCase[tempRgn->pDimensionDefinitions[d].dimension] =
3444                        (iDst >> baseBits) & ((1 << dstBits) - 1);
3445                    baseBits += dstBits;
3446                    // there are also DimensionRegion objects of unused zones, skip them
3447                    if (dimCase[tempRgn->pDimensionDefinitions[d].dimension] >= tempRgn->pDimensionDefinitions[d].zones) {
3448                        isValidZone = false;
3449                        break;
3450                    }
3451                }
3452                if (!isValidZone) continue;
3453                // a bit paranoid: cope with the chance that the dimensions would
3454                // have different order in source and destination regions
3455                const bool isLastZone = (dimCase[type] == newZoneSize - 1);
3456                if (dimCase[type] >= zone) dimCase[type]++;
3457                DimensionRegion* srcDimRgn = GetDimensionRegionByBit(dimCase);
3458                dstDimRgn->CopyAssign(srcDimRgn);
3459                // if this is the upper most zone of the dimension passed to this
3460                // method, then correct (raise) its upper limit to 127
3461                if (newDef.split_type == split_type_normal && isLastZone)
3462                    dstDimRgn->DimensionUpperLimits[tempReducedDimensionIndex] = 127;
3463            }
3464    
3465            // now tempRegion's dimensions and DimensionRegions basically reflect
3466            // what we wanted to get for this actual Region here, so we now just
3467            // delete and recreate the dimension in question with the new amount
3468            // zones and then copy back from tempRegion      
3469            DeleteDimension(oldDef);
3470            AddDimension(&newDef);
3471            for (int iSrc = 0; iSrc < 256; ++iSrc) {
3472                DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
3473                if (!srcDimRgn) continue;
3474                std::map<dimension_t,int> dimCase;
3475                for (int d = 0, baseBits = 0; d < tempRgn->Dimensions; ++d) {
3476                    const int srcBits = tempRgn->pDimensionDefinitions[d].bits;
3477                    dimCase[tempRgn->pDimensionDefinitions[d].dimension] =
3478                        (iSrc >> baseBits) & ((1 << srcBits) - 1);
3479                    baseBits += srcBits;
3480                }
3481                // a bit paranoid: cope with the chance that the dimensions would
3482                // have different order in source and destination regions
3483                DimensionRegion* dstDimRgn = GetDimensionRegionByBit(dimCase);
3484                if (!dstDimRgn) continue;
3485                dstDimRgn->CopyAssign(srcDimRgn);
3486            }
3487    
3488            // delete temporary region
3489            delete tempRgn;
3490    
3491            UpdateVelocityTable();
3492        }
3493    
3494        /** @brief Divide split zone of a dimension in two (increment zone amount).
3495         *
3496         * This will increment the amount of zones for the dimension (given by
3497         * @a type) by one. It will do so by dividing the zone (given by @a zone)
3498         * in the middle of its zone range in two. So the two zones resulting from
3499         * the zone being splitted, will be an equivalent copy regarding all their
3500         * articulation informations and sample reference. The two zones will only
3501         * differ in their zone's upper limit
3502         * (DimensionRegion::DimensionUpperLimits).
3503         *
3504         * @param type - identifies the dimension where a zone shall be splitted
3505         * @param zone - index of the dimension split zone that shall be splitted
3506         * @throws gig::Exception if requested zone could not be splitted
3507         */
3508        void Region::SplitDimensionZone(dimension_t type, int zone) {
3509            dimension_def_t* oldDef = GetDimensionDefinition(type);
3510            if (!oldDef)
3511                throw gig::Exception("Could not split dimension zone, no such dimension of given type");
3512            if (zone < 0 || zone >= oldDef->zones)
3513                throw gig::Exception("Could not split dimension zone, requested zone index out of bounds.");
3514    
3515            const int newZoneSize = oldDef->zones + 1;
3516    
3517            // create a temporary Region which just acts as a temporary copy
3518            // container and will be deleted at the end of this function and will
3519            // also not be visible through the API during this process
3520            gig::Region* tempRgn = NULL;
3521            {
3522                // adding these temporary chunks is probably not even necessary
3523                Instrument* instr = static_cast<Instrument*>(GetParent());
3524                RIFF::List* pCkInstrument = instr->pCkInstrument;
3525                RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
3526                if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
3527                RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
3528                tempRgn = new Region(instr, rgn);
3529            }
3530    
3531            // copy this region's dimensions (with already the dimension split size
3532            // requested by the arguments of this method call) to the temporary
3533            // region, and don't use Region::CopyAssign() here for this task, since
3534            // it would also alter fast lookup helper variables here and there
3535            dimension_def_t newDef;
3536            for (int i = 0; i < Dimensions; ++i) {
3537                dimension_def_t def = pDimensionDefinitions[i]; // copy, don't reference
3538                // is this the dimension requested by the method arguments? ...
3539                if (def.dimension == type) { // ... if yes, increment zone amount by one
3540                    def.zones = newZoneSize;
3541                    if ((1 << oldDef->bits) < newZoneSize) def.bits++;
3542                    newDef = def;
3543                }
3544                tempRgn->AddDimension(&def);
3545            }
3546    
3547            // find the dimension index in the tempRegion which is the dimension
3548            // type passed to this method (paranoidly expecting different order)
3549            int tempIncreasedDimensionIndex = -1;
3550            for (int d = 0; d < tempRgn->Dimensions; ++d) {
3551                if (tempRgn->pDimensionDefinitions[d].dimension == type) {
3552                    tempIncreasedDimensionIndex = d;
3553                    break;
3554                }
3555            }
3556    
3557            // copy dimension regions from this region to the temporary region
3558            for (int iSrc = 0; iSrc < 256; ++iSrc) {
3559                DimensionRegion* srcDimRgn = pDimensionRegions[iSrc];
3560                if (!srcDimRgn) continue;
3561                std::map<dimension_t,int> dimCase;
3562                bool isValidZone = true;
3563                for (int d = 0, baseBits = 0; d < Dimensions; ++d) {
3564                    const int srcBits = pDimensionDefinitions[d].bits;
3565                    dimCase[pDimensionDefinitions[d].dimension] =
3566                        (iSrc >> baseBits) & ((1 << srcBits) - 1);
3567                    // there are also DimensionRegion objects for unused zones, skip them
3568                    if (dimCase[pDimensionDefinitions[d].dimension] >= pDimensionDefinitions[d].zones) {
3569                        isValidZone = false;
3570                        break;
3571                    }
3572                    baseBits += srcBits;
3573                }
3574                if (!isValidZone) continue;
3575                // a bit paranoid: cope with the chance that the dimensions would
3576                // have different order in source and destination regions            
3577                if (dimCase[type] > zone) dimCase[type]++;
3578                DimensionRegion* dstDimRgn = tempRgn->GetDimensionRegionByBit(dimCase);
3579                dstDimRgn->CopyAssign(srcDimRgn);
3580                // if this is the requested zone to be splitted, then also copy
3581                // the source DimensionRegion to the newly created target zone
3582                // and set the old zones upper limit lower
3583                if (dimCase[type] == zone) {
3584                    // lower old zones upper limit
3585                    if (newDef.split_type == split_type_normal) {
3586                        const int high =
3587                            dstDimRgn->DimensionUpperLimits[tempIncreasedDimensionIndex];
3588                        int low = 0;
3589                        if (zone > 0) {
3590                            std::map<dimension_t,int> lowerCase = dimCase;
3591                            lowerCase[type]--;
3592                            DimensionRegion* dstDimRgnLow = tempRgn->GetDimensionRegionByBit(lowerCase);
3593                            low = dstDimRgnLow->DimensionUpperLimits[tempIncreasedDimensionIndex];
3594                        }
3595                        dstDimRgn->DimensionUpperLimits[tempIncreasedDimensionIndex] = low + (high - low) / 2;
3596                    }
3597                    // fill the newly created zone of the divided zone as well
3598                    dimCase[type]++;
3599                    dstDimRgn = tempRgn->GetDimensionRegionByBit(dimCase);
3600                    dstDimRgn->CopyAssign(srcDimRgn);
3601                }
3602            }
3603    
3604            // now tempRegion's dimensions and DimensionRegions basically reflect
3605            // what we wanted to get for this actual Region here, so we now just
3606            // delete and recreate the dimension in question with the new amount
3607            // zones and then copy back from tempRegion      
3608            DeleteDimension(oldDef);
3609            AddDimension(&newDef);
3610            for (int iSrc = 0; iSrc < 256; ++iSrc) {
3611                DimensionRegion* srcDimRgn = tempRgn->pDimensionRegions[iSrc];
3612                if (!srcDimRgn) continue;
3613                std::map<dimension_t,int> dimCase;
3614                for (int d = 0, baseBits = 0; d < tempRgn->Dimensions; ++d) {
3615                    const int srcBits = tempRgn->pDimensionDefinitions[d].bits;
3616                    dimCase[tempRgn->pDimensionDefinitions[d].dimension] =
3617                        (iSrc >> baseBits) & ((1 << srcBits) - 1);
3618                    baseBits += srcBits;
3619                }
3620                // a bit paranoid: cope with the chance that the dimensions would
3621                // have different order in source and destination regions
3622                DimensionRegion* dstDimRgn = GetDimensionRegionByBit(dimCase);
3623                if (!dstDimRgn) continue;
3624                dstDimRgn->CopyAssign(srcDimRgn);
3625            }
3626    
3627            // delete temporary region
3628            delete tempRgn;
3629    
3630            UpdateVelocityTable();
3631        }
3632    
3633        /** @brief Change type of an existing dimension.
3634         *
3635         * Alters the dimension type of a dimension already existing on this
3636         * region. If there is currently no dimension on this Region with type
3637         * @a oldType, then this call with throw an Exception. Likewise there are
3638         * cases where the requested dimension type cannot be performed. For example
3639         * if the new dimension type shall be gig::dimension_samplechannel, and the
3640         * current dimension has more than 2 zones. In such cases an Exception is
3641         * thrown as well.
3642         *
3643         * @param oldType - identifies the existing dimension to be changed
3644         * @param newType - to which dimension type it should be changed to
3645         * @throws gig::Exception if requested change cannot be performed
3646         */
3647        void Region::SetDimensionType(dimension_t oldType, dimension_t newType) {
3648            if (oldType == newType) return;
3649            dimension_def_t* def = GetDimensionDefinition(oldType);
3650            if (!def)
3651                throw gig::Exception("No dimension with provided old dimension type exists on this region");
3652            if (newType == dimension_samplechannel && def->zones != 2)
3653                throw gig::Exception("Cannot change to dimension type 'sample channel', because existing dimension does not have 2 zones");
3654            if (GetDimensionDefinition(newType))
3655                throw gig::Exception("There is already a dimension with requested new dimension type on this region");
3656            def->dimension  = newType;
3657            def->split_type = __resolveSplitType(newType);
3658        }
3659    
3660        DimensionRegion* Region::GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase) {
3661            uint8_t bits[8] = {};
3662            for (std::map<dimension_t,int>::const_iterator it = DimCase.begin();
3663                 it != DimCase.end(); ++it)
3664            {
3665                for (int d = 0; d < Dimensions; ++d) {
3666                    if (pDimensionDefinitions[d].dimension == it->first) {
3667                        bits[d] = it->second;
3668                        goto nextDimCaseSlice;
3669                    }
3670                }
3671                assert(false); // do crash ... too harsh maybe ? ignore it instead ?
3672                nextDimCaseSlice:
3673                ; // noop
3674            }
3675            return GetDimensionRegionByBit(bits);
3676        }
3677    
3678        /**
3679         * Searches in the current Region for a dimension of the given dimension
3680         * type and returns the precise configuration of that dimension in this
3681         * Region.
3682         *
3683         * @param type - dimension type of the sought dimension
3684         * @returns dimension definition or NULL if there is no dimension with
3685         *          sought type in this Region.
3686         */
3687        dimension_def_t* Region::GetDimensionDefinition(dimension_t type) {
3688            for (int i = 0; i < Dimensions; ++i)
3689                if (pDimensionDefinitions[i].dimension == type)
3690                    return &pDimensionDefinitions[i];
3691            return NULL;
3692        }
3693    
3694      Region::~Region() {      Region::~Region() {
3695          for (int i = 0; i < 256; i++) {          for (int i = 0; i < 256; i++) {
3696              if (pDimensionRegions[i]) delete pDimensionRegions[i];              if (pDimensionRegions[i]) delete pDimensionRegions[i];
# Line 2855  namespace { Line 3748  namespace {
3748              }              }
3749              bitpos += pDimensionDefinitions[i].bits;              bitpos += pDimensionDefinitions[i].bits;
3750          }          }
3751          DimensionRegion* dimreg = pDimensionRegions[dimregidx];          DimensionRegion* dimreg = pDimensionRegions[dimregidx & 255];
3752            if (!dimreg) return NULL;
3753          if (veldim != -1) {          if (veldim != -1) {
3754              // (dimreg is now the dimension region for the lowest velocity)              // (dimreg is now the dimension region for the lowest velocity)
3755              if (dimreg->VelocityTable) // custom defined zone ranges              if (dimreg->VelocityTable) // custom defined zone ranges
3756                  bits = dimreg->VelocityTable[DimValues[veldim]];                  bits = dimreg->VelocityTable[DimValues[veldim] & 127];
3757              else // normal split type              else // normal split type
3758                  bits = uint8_t(DimValues[veldim] / pDimensionDefinitions[veldim].zone_size);                  bits = uint8_t((DimValues[veldim] & 127) / pDimensionDefinitions[veldim].zone_size);
3759    
3760              dimregidx |= bits << velbitpos;              const uint8_t limiter_mask = (1 << pDimensionDefinitions[veldim].bits) - 1;
3761              dimreg = pDimensionRegions[dimregidx];              dimregidx |= (bits & limiter_mask) << velbitpos;
3762                dimreg = pDimensionRegions[dimregidx & 255];
3763          }          }
3764          return dimreg;          return dimreg;
3765      }      }
3766    
3767        int Region::GetDimensionRegionIndexByValue(const uint DimValues[8]) {
3768            uint8_t bits;
3769            int veldim = -1;
3770            int velbitpos;
3771            int bitpos = 0;
3772            int dimregidx = 0;
3773            for (uint i = 0; i < Dimensions; i++) {
3774                if (pDimensionDefinitions[i].dimension == dimension_velocity) {
3775                    // the velocity dimension must be handled after the other dimensions
3776                    veldim = i;
3777                    velbitpos = bitpos;
3778                } else {
3779                    switch (pDimensionDefinitions[i].split_type) {
3780                        case split_type_normal:
3781                            if (pDimensionRegions[0]->DimensionUpperLimits[i]) {
3782                                // gig3: all normal dimensions (not just the velocity dimension) have custom zone ranges
3783                                for (bits = 0 ; bits < pDimensionDefinitions[i].zones ; bits++) {
3784                                    if (DimValues[i] <= pDimensionRegions[bits << bitpos]->DimensionUpperLimits[i]) break;
3785                                }
3786                            } else {
3787                                // gig2: evenly sized zones
3788                                bits = uint8_t(DimValues[i] / pDimensionDefinitions[i].zone_size);
3789                            }
3790                            break;
3791                        case split_type_bit: // the value is already the sought dimension bit number
3792                            const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;
3793                            bits = DimValues[i] & limiter_mask; // just make sure the value doesn't use more bits than allowed
3794                            break;
3795                    }
3796                    dimregidx |= bits << bitpos;
3797                }
3798                bitpos += pDimensionDefinitions[i].bits;
3799            }
3800            dimregidx &= 255;
3801            DimensionRegion* dimreg = pDimensionRegions[dimregidx];
3802            if (!dimreg) return -1;
3803            if (veldim != -1) {
3804                // (dimreg is now the dimension region for the lowest velocity)
3805                if (dimreg->VelocityTable) // custom defined zone ranges
3806                    bits = dimreg->VelocityTable[DimValues[veldim] & 127];
3807                else // normal split type
3808                    bits = uint8_t((DimValues[veldim] & 127) / pDimensionDefinitions[veldim].zone_size);
3809    
3810                const uint8_t limiter_mask = (1 << pDimensionDefinitions[veldim].bits) - 1;
3811                dimregidx |= (bits & limiter_mask) << velbitpos;
3812                dimregidx &= 255;
3813            }
3814            return dimregidx;
3815        }
3816    
3817      /**      /**
3818       * Returns the appropriate DimensionRegion for the given dimension bit       * Returns the appropriate DimensionRegion for the given dimension bit
3819       * numbers (zone index). You usually use <i>GetDimensionRegionByValue</i>       * numbers (zone index). You usually use <i>GetDimensionRegionByValue</i>
# Line 2907  namespace { Line 3852  namespace {
3852          if ((int32_t)WavePoolTableIndex == -1) return NULL;          if ((int32_t)WavePoolTableIndex == -1) return NULL;
3853          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
3854          if (!file->pWavePoolTable) return NULL;          if (!file->pWavePoolTable) return NULL;
3855          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];          // for new files or files >= 2 GB use 64 bit wave pool offsets
3856          unsigned long soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];          if (file->pRIFF->IsNew() || (file->pRIFF->GetCurrentFileSize() >> 31)) {
3857          Sample* sample = file->GetFirstSample(pProgress);              // use 64 bit wave pool offsets (treating this as large file)
3858          while (sample) {              uint64_t soughtoffset =
3859              if (sample->ulWavePoolOffset == soughtoffset &&                  uint64_t(file->pWavePoolTable[WavePoolTableIndex]) |
3860                  sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);                  uint64_t(file->pWavePoolTableHi[WavePoolTableIndex]) << 32;
3861              sample = file->GetNextSample();              Sample* sample = file->GetFirstSample(pProgress);
3862                while (sample) {
3863                    if (sample->ullWavePoolOffset == soughtoffset)
3864                        return static_cast<gig::Sample*>(sample);
3865                    sample = file->GetNextSample();
3866                }
3867            } else {
3868                // use extension files and 32 bit wave pool offsets
3869                file_offset_t soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
3870                file_offset_t soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];
3871                Sample* sample = file->GetFirstSample(pProgress);
3872                while (sample) {
3873                    if (sample->ullWavePoolOffset == soughtoffset &&
3874                        sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);
3875                    sample = file->GetNextSample();
3876                }
3877            }
3878            return NULL;
3879        }
3880        
3881        /**
3882         * Make a (semi) deep copy of the Region object given by @a orig
3883         * and assign it to this object.
3884         *
3885         * Note that all sample pointers referenced by @a orig are simply copied as
3886         * memory address. Thus the respective samples are shared, not duplicated!
3887         *
3888         * @param orig - original Region object to be copied from
3889         */
3890        void Region::CopyAssign(const Region* orig) {
3891            CopyAssign(orig, NULL);
3892        }
3893        
3894        /**
3895         * Make a (semi) deep copy of the Region object given by @a orig and
3896         * assign it to this object
3897         *
3898         * @param mSamples - crosslink map between the foreign file's samples and
3899         *                   this file's samples
3900         */
3901        void Region::CopyAssign(const Region* orig, const std::map<Sample*,Sample*>* mSamples) {
3902            // handle base classes
3903            DLS::Region::CopyAssign(orig);
3904            
3905            if (mSamples && mSamples->count((gig::Sample*)orig->pSample)) {
3906                pSample = mSamples->find((gig::Sample*)orig->pSample)->second;
3907            }
3908            
3909            // handle own member variables
3910            for (int i = Dimensions - 1; i >= 0; --i) {
3911                DeleteDimension(&pDimensionDefinitions[i]);
3912            }
3913            Layers = 0; // just to be sure
3914            for (int i = 0; i < orig->Dimensions; i++) {
3915                // we need to copy the dim definition here, to avoid the compiler
3916                // complaining about const-ness issue
3917                dimension_def_t def = orig->pDimensionDefinitions[i];
3918                AddDimension(&def);
3919            }
3920            for (int i = 0; i < 256; i++) {
3921                if (pDimensionRegions[i] && orig->pDimensionRegions[i]) {
3922                    pDimensionRegions[i]->CopyAssign(
3923                        orig->pDimensionRegions[i],
3924                        mSamples
3925                    );
3926                }
3927            }
3928            Layers = orig->Layers;
3929        }
3930    
3931    
3932    // *************** MidiRule ***************
3933    // *
3934    
3935        MidiRuleCtrlTrigger::MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg) {
3936            _3ewg->SetPos(36);
3937            Triggers = _3ewg->ReadUint8();
3938            _3ewg->SetPos(40);
3939            ControllerNumber = _3ewg->ReadUint8();
3940            _3ewg->SetPos(46);
3941            for (int i = 0 ; i < Triggers ; i++) {
3942                pTriggers[i].TriggerPoint = _3ewg->ReadUint8();
3943                pTriggers[i].Descending = _3ewg->ReadUint8();
3944                pTriggers[i].VelSensitivity = _3ewg->ReadUint8();
3945                pTriggers[i].Key = _3ewg->ReadUint8();
3946                pTriggers[i].NoteOff = _3ewg->ReadUint8();
3947                pTriggers[i].Velocity = _3ewg->ReadUint8();
3948                pTriggers[i].OverridePedal = _3ewg->ReadUint8();
3949                _3ewg->ReadUint8();
3950            }
3951        }
3952    
3953        MidiRuleCtrlTrigger::MidiRuleCtrlTrigger() :
3954            ControllerNumber(0),
3955            Triggers(0) {
3956        }
3957    
3958        void MidiRuleCtrlTrigger::UpdateChunks(uint8_t* pData) const {
3959            pData[32] = 4;
3960            pData[33] = 16;
3961            pData[36] = Triggers;
3962            pData[40] = ControllerNumber;
3963            for (int i = 0 ; i < Triggers ; i++) {
3964                pData[46 + i * 8] = pTriggers[i].TriggerPoint;
3965                pData[47 + i * 8] = pTriggers[i].Descending;
3966                pData[48 + i * 8] = pTriggers[i].VelSensitivity;
3967                pData[49 + i * 8] = pTriggers[i].Key;
3968                pData[50 + i * 8] = pTriggers[i].NoteOff;
3969                pData[51 + i * 8] = pTriggers[i].Velocity;
3970                pData[52 + i * 8] = pTriggers[i].OverridePedal;
3971            }
3972        }
3973    
3974        MidiRuleLegato::MidiRuleLegato(RIFF::Chunk* _3ewg) {
3975            _3ewg->SetPos(36);
3976            LegatoSamples = _3ewg->ReadUint8(); // always 12
3977            _3ewg->SetPos(40);
3978            BypassUseController = _3ewg->ReadUint8();
3979            BypassKey = _3ewg->ReadUint8();
3980            BypassController = _3ewg->ReadUint8();
3981            ThresholdTime = _3ewg->ReadUint16();
3982            _3ewg->ReadInt16();
3983            ReleaseTime = _3ewg->ReadUint16();
3984            _3ewg->ReadInt16();
3985            KeyRange.low = _3ewg->ReadUint8();
3986            KeyRange.high = _3ewg->ReadUint8();
3987            _3ewg->SetPos(64);
3988            ReleaseTriggerKey = _3ewg->ReadUint8();
3989            AltSustain1Key = _3ewg->ReadUint8();
3990            AltSustain2Key = _3ewg->ReadUint8();
3991        }
3992    
3993        MidiRuleLegato::MidiRuleLegato() :
3994            LegatoSamples(12),
3995            BypassUseController(false),
3996            BypassKey(0),
3997            BypassController(1),
3998            ThresholdTime(20),
3999            ReleaseTime(20),
4000            ReleaseTriggerKey(0),
4001            AltSustain1Key(0),
4002            AltSustain2Key(0)
4003        {
4004            KeyRange.low = KeyRange.high = 0;
4005        }
4006    
4007        void MidiRuleLegato::UpdateChunks(uint8_t* pData) const {
4008            pData[32] = 0;
4009            pData[33] = 16;
4010            pData[36] = LegatoSamples;
4011            pData[40] = BypassUseController;
4012            pData[41] = BypassKey;
4013            pData[42] = BypassController;
4014            store16(&pData[43], ThresholdTime);
4015            store16(&pData[47], ReleaseTime);
4016            pData[51] = KeyRange.low;
4017            pData[52] = KeyRange.high;
4018            pData[64] = ReleaseTriggerKey;
4019            pData[65] = AltSustain1Key;
4020            pData[66] = AltSustain2Key;
4021        }
4022    
4023        MidiRuleAlternator::MidiRuleAlternator(RIFF::Chunk* _3ewg) {
4024            _3ewg->SetPos(36);
4025            Articulations = _3ewg->ReadUint8();
4026            int flags = _3ewg->ReadUint8();
4027            Polyphonic = flags & 8;
4028            Chained = flags & 4;
4029            Selector = (flags & 2) ? selector_controller :
4030                (flags & 1) ? selector_key_switch : selector_none;
4031            Patterns = _3ewg->ReadUint8();
4032            _3ewg->ReadUint8(); // chosen row
4033            _3ewg->ReadUint8(); // unknown
4034            _3ewg->ReadUint8(); // unknown
4035            _3ewg->ReadUint8(); // unknown
4036            KeySwitchRange.low = _3ewg->ReadUint8();
4037            KeySwitchRange.high = _3ewg->ReadUint8();
4038            Controller = _3ewg->ReadUint8();
4039            PlayRange.low = _3ewg->ReadUint8();
4040            PlayRange.high = _3ewg->ReadUint8();
4041    
4042            int n = std::min(int(Articulations), 32);
4043            for (int i = 0 ; i < n ; i++) {
4044                _3ewg->ReadString(pArticulations[i], 32);
4045            }
4046            _3ewg->SetPos(1072);
4047            n = std::min(int(Patterns), 32);
4048            for (int i = 0 ; i < n ; i++) {
4049                _3ewg->ReadString(pPatterns[i].Name, 16);
4050                pPatterns[i].Size = _3ewg->ReadUint8();
4051                _3ewg->Read(&pPatterns[i][0], 1, 32);
4052            }
4053        }
4054    
4055        MidiRuleAlternator::MidiRuleAlternator() :
4056            Articulations(0),
4057            Patterns(0),
4058            Selector(selector_none),
4059            Controller(0),
4060            Polyphonic(false),
4061            Chained(false)
4062        {
4063            PlayRange.low = PlayRange.high = 0;
4064            KeySwitchRange.low = KeySwitchRange.high = 0;
4065        }
4066    
4067        void MidiRuleAlternator::UpdateChunks(uint8_t* pData) const {
4068            pData[32] = 3;
4069            pData[33] = 16;
4070            pData[36] = Articulations;
4071            pData[37] = (Polyphonic ? 8 : 0) | (Chained ? 4 : 0) |
4072                (Selector == selector_controller ? 2 :
4073                 (Selector == selector_key_switch ? 1 : 0));
4074            pData[38] = Patterns;
4075    
4076            pData[43] = KeySwitchRange.low;
4077            pData[44] = KeySwitchRange.high;
4078            pData[45] = Controller;
4079            pData[46] = PlayRange.low;
4080            pData[47] = PlayRange.high;
4081    
4082            char* str = reinterpret_cast<char*>(pData);
4083            int pos = 48;
4084            int n = std::min(int(Articulations), 32);
4085            for (int i = 0 ; i < n ; i++, pos += 32) {
4086                strncpy(&str[pos], pArticulations[i].c_str(), 32);
4087            }
4088    
4089            pos = 1072;
4090            n = std::min(int(Patterns), 32);
4091            for (int i = 0 ; i < n ; i++, pos += 49) {
4092                strncpy(&str[pos], pPatterns[i].Name.c_str(), 16);
4093                pData[pos + 16] = pPatterns[i].Size;
4094                memcpy(&pData[pos + 16], &(pPatterns[i][0]), 32);
4095            }
4096        }
4097    
4098    // *************** Script ***************
4099    // *
4100    
4101        Script::Script(ScriptGroup* group, RIFF::Chunk* ckScri) {
4102            pGroup = group;
4103            pChunk = ckScri;
4104            if (ckScri) { // object is loaded from file ...
4105                // read header
4106                uint32_t headerSize = ckScri->ReadUint32();
4107                Compression = (Compression_t) ckScri->ReadUint32();
4108                Encoding    = (Encoding_t) ckScri->ReadUint32();
4109                Language    = (Language_t) ckScri->ReadUint32();
4110                Bypass      = (Language_t) ckScri->ReadUint32() & 1;
4111                crc         = ckScri->ReadUint32();
4112                uint32_t nameSize = ckScri->ReadUint32();
4113                Name.resize(nameSize, ' ');
4114                for (int i = 0; i < nameSize; ++i)
4115                    Name[i] = ckScri->ReadUint8();
4116                // to handle potential future extensions of the header
4117                ckScri->SetPos(sizeof(int32_t) + headerSize);
4118                // read actual script data
4119                uint32_t scriptSize = ckScri->GetSize() - ckScri->GetPos();
4120                data.resize(scriptSize);
4121                for (int i = 0; i < scriptSize; ++i)
4122                    data[i] = ckScri->ReadUint8();
4123            } else { // this is a new script object, so just initialize it as such ...
4124                Compression = COMPRESSION_NONE;
4125                Encoding = ENCODING_ASCII;
4126                Language = LANGUAGE_NKSP;
4127                Bypass   = false;
4128                crc      = 0;
4129                Name     = "Unnamed Script";
4130            }
4131        }
4132    
4133        Script::~Script() {
4134        }
4135    
4136        /**
4137         * Returns the current script (i.e. as source code) in text format.
4138         */
4139        String Script::GetScriptAsText() {
4140            String s;
4141            s.resize(data.size(), ' ');
4142            memcpy(&s[0], &data[0], data.size());
4143            return s;
4144        }
4145    
4146        /**
4147         * Replaces the current script with the new script source code text given
4148         * by @a text.
4149         *
4150         * @param text - new script source code
4151         */
4152        void Script::SetScriptAsText(const String& text) {
4153            data.resize(text.size());
4154            memcpy(&data[0], &text[0], text.size());
4155        }
4156    
4157        /**
4158         * Apply this script to the respective RIFF chunks. You have to call
4159         * File::Save() to make changes persistent.
4160         *
4161         * Usually there is absolutely no need to call this method explicitly.
4162         * It will be called automatically when File::Save() was called.
4163         *
4164         * @param pProgress - callback function for progress notification
4165         */
4166        void Script::UpdateChunks(progress_t* pProgress) {
4167            // recalculate CRC32 check sum
4168            __resetCRC(crc);
4169            __calculateCRC(&data[0], data.size(), crc);
4170            __encodeCRC(crc);
4171            // make sure chunk exists and has the required size
4172            const int chunkSize = 7*sizeof(int32_t) + Name.size() + data.size();
4173            if (!pChunk) pChunk = pGroup->pList->AddSubChunk(CHUNK_ID_SCRI, chunkSize);
4174            else pChunk->Resize(chunkSize);
4175            // fill the chunk data to be written to disk
4176            uint8_t* pData = (uint8_t*) pChunk->LoadChunkData();
4177            int pos = 0;
4178            store32(&pData[pos], 6*sizeof(int32_t) + Name.size()); // total header size
4179            pos += sizeof(int32_t);
4180            store32(&pData[pos], Compression);
4181            pos += sizeof(int32_t);
4182            store32(&pData[pos], Encoding);
4183            pos += sizeof(int32_t);
4184            store32(&pData[pos], Language);
4185            pos += sizeof(int32_t);
4186            store32(&pData[pos], Bypass ? 1 : 0);
4187            pos += sizeof(int32_t);
4188            store32(&pData[pos], crc);
4189            pos += sizeof(int32_t);
4190            store32(&pData[pos], Name.size());
4191            pos += sizeof(int32_t);
4192            for (int i = 0; i < Name.size(); ++i, ++pos)
4193                pData[pos] = Name[i];
4194            for (int i = 0; i < data.size(); ++i, ++pos)
4195                pData[pos] = data[i];
4196        }
4197    
4198        /**
4199         * Move this script from its current ScriptGroup to another ScriptGroup
4200         * given by @a pGroup.
4201         *
4202         * @param pGroup - script's new group
4203         */
4204        void Script::SetGroup(ScriptGroup* pGroup) {
4205            if (this->pGroup == pGroup) return;
4206            if (pChunk)
4207                pChunk->GetParent()->MoveSubChunk(pChunk, pGroup->pList);
4208            this->pGroup = pGroup;
4209        }
4210    
4211        /**
4212         * Returns the script group this script currently belongs to. Each script
4213         * is a member of exactly one ScriptGroup.
4214         *
4215         * @returns current script group
4216         */
4217        ScriptGroup* Script::GetGroup() const {
4218            return pGroup;
4219        }
4220    
4221        void Script::RemoveAllScriptReferences() {
4222            File* pFile = pGroup->pFile;
4223            for (int i = 0; pFile->GetInstrument(i); ++i) {
4224                Instrument* instr = pFile->GetInstrument(i);
4225                instr->RemoveScript(this);
4226            }
4227        }
4228    
4229    // *************** ScriptGroup ***************
4230    // *
4231    
4232        ScriptGroup::ScriptGroup(File* file, RIFF::List* lstRTIS) {
4233            pFile = file;
4234            pList = lstRTIS;
4235            pScripts = NULL;
4236            if (lstRTIS) {
4237                RIFF::Chunk* ckName = lstRTIS->GetSubChunk(CHUNK_ID_LSNM);
4238                ::LoadString(ckName, Name);
4239            } else {
4240                Name = "Default Group";
4241            }
4242        }
4243    
4244        ScriptGroup::~ScriptGroup() {
4245            if (pScripts) {
4246                std::list<Script*>::iterator iter = pScripts->begin();
4247                std::list<Script*>::iterator end  = pScripts->end();
4248                while (iter != end) {
4249                    delete *iter;
4250                    ++iter;
4251                }
4252                delete pScripts;
4253          }          }
4254        }
4255    
4256        /**
4257         * Apply this script group to the respective RIFF chunks. You have to call
4258         * File::Save() to make changes persistent.
4259         *
4260         * Usually there is absolutely no need to call this method explicitly.
4261         * It will be called automatically when File::Save() was called.
4262         *
4263         * @param pProgress - callback function for progress notification
4264         */
4265        void ScriptGroup::UpdateChunks(progress_t* pProgress) {
4266            if (pScripts) {
4267                if (!pList)
4268                    pList = pFile->pRIFF->GetSubList(LIST_TYPE_3LS)->AddSubList(LIST_TYPE_RTIS);
4269    
4270                // now store the name of this group as <LSNM> chunk as subchunk of the <RTIS> list chunk
4271                ::SaveString(CHUNK_ID_LSNM, NULL, pList, Name, String("Unnamed Group"), true, 64);
4272    
4273                for (std::list<Script*>::iterator it = pScripts->begin();
4274                     it != pScripts->end(); ++it)
4275                {
4276                    (*it)->UpdateChunks(pProgress);
4277                }
4278            }
4279        }
4280    
4281        /** @brief Get instrument script.
4282         *
4283         * Returns the real-time instrument script with the given index.
4284         *
4285         * @param index - number of the sought script (0..n)
4286         * @returns sought script or NULL if there's no such script
4287         */
4288        Script* ScriptGroup::GetScript(uint index) {
4289            if (!pScripts) LoadScripts();
4290            std::list<Script*>::iterator it = pScripts->begin();
4291            for (uint i = 0; it != pScripts->end(); ++i, ++it)
4292                if (i == index) return *it;
4293          return NULL;          return NULL;
4294      }      }
4295    
4296        /** @brief Add new instrument script.
4297         *
4298         * Adds a new real-time instrument script to the file. The script is not
4299         * actually used / executed unless it is referenced by an instrument to be
4300         * used. This is similar to samples, which you can add to a file, without
4301         * an instrument necessarily actually using it.
4302         *
4303         * You have to call Save() to make this persistent to the file.
4304         *
4305         * @return new empty script object
4306         */
4307        Script* ScriptGroup::AddScript() {
4308            if (!pScripts) LoadScripts();
4309            Script* pScript = new Script(this, NULL);
4310            pScripts->push_back(pScript);
4311            return pScript;
4312        }
4313    
4314        /** @brief Delete an instrument script.
4315         *
4316         * This will delete the given real-time instrument script. References of
4317         * instruments that are using that script will be removed accordingly.
4318         *
4319         * You have to call Save() to make this persistent to the file.
4320         *
4321         * @param pScript - script to delete
4322         * @throws gig::Exception if given script could not be found
4323         */
4324        void ScriptGroup::DeleteScript(Script* pScript) {
4325            if (!pScripts) LoadScripts();
4326            std::list<Script*>::iterator iter =
4327                find(pScripts->begin(), pScripts->end(), pScript);
4328            if (iter == pScripts->end())
4329                throw gig::Exception("Could not delete script, could not find given script");
4330            pScripts->erase(iter);
4331            pScript->RemoveAllScriptReferences();
4332            if (pScript->pChunk)
4333                pScript->pChunk->GetParent()->DeleteSubChunk(pScript->pChunk);
4334            delete pScript;
4335        }
4336    
4337        void ScriptGroup::LoadScripts() {
4338            if (pScripts) return;
4339            pScripts = new std::list<Script*>;
4340            if (!pList) return;
4341    
4342            for (RIFF::Chunk* ck = pList->GetFirstSubChunk(); ck;
4343                 ck = pList->GetNextSubChunk())
4344            {
4345                if (ck->GetChunkID() == CHUNK_ID_SCRI) {
4346                    pScripts->push_back(new Script(this, ck));
4347                }
4348            }
4349        }
4350    
4351  // *************** Instrument ***************  // *************** Instrument ***************
4352  // *  // *
# Line 2940  namespace { Line 4368  namespace {
4368          PianoReleaseMode = false;          PianoReleaseMode = false;
4369          DimensionKeyRange.low = 0;          DimensionKeyRange.low = 0;
4370          DimensionKeyRange.high = 0;          DimensionKeyRange.high = 0;
4371            pMidiRules = new MidiRule*[3];
4372            pMidiRules[0] = NULL;
4373            pScriptRefs = NULL;
4374    
4375          // Loading          // Loading
4376          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);
# Line 2954  namespace { Line 4385  namespace {
4385                  PianoReleaseMode       = dimkeystart & 0x01;                  PianoReleaseMode       = dimkeystart & 0x01;
4386                  DimensionKeyRange.low  = dimkeystart >> 1;                  DimensionKeyRange.low  = dimkeystart >> 1;
4387                  DimensionKeyRange.high = _3ewg->ReadUint8();                  DimensionKeyRange.high = _3ewg->ReadUint8();
4388    
4389                    if (_3ewg->GetSize() > 32) {
4390                        // read MIDI rules
4391                        int i = 0;
4392                        _3ewg->SetPos(32);
4393                        uint8_t id1 = _3ewg->ReadUint8();
4394                        uint8_t id2 = _3ewg->ReadUint8();
4395    
4396                        if (id2 == 16) {
4397                            if (id1 == 4) {
4398                                pMidiRules[i++] = new MidiRuleCtrlTrigger(_3ewg);
4399                            } else if (id1 == 0) {
4400                                pMidiRules[i++] = new MidiRuleLegato(_3ewg);
4401                            } else if (id1 == 3) {
4402                                pMidiRules[i++] = new MidiRuleAlternator(_3ewg);
4403                            } else {
4404                                pMidiRules[i++] = new MidiRuleUnknown;
4405                            }
4406                        }
4407                        else if (id1 != 0 || id2 != 0) {
4408                            pMidiRules[i++] = new MidiRuleUnknown;
4409                        }
4410                        //TODO: all the other types of rules
4411    
4412                        pMidiRules[i] = NULL;
4413                    }
4414              }              }
4415          }          }
4416    
4417          if (!pRegions) pRegions = new RegionList;          if (pFile->GetAutoLoad()) {
4418          RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);              if (!pRegions) pRegions = new RegionList;
4419          if (lrgn) {              RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);
4420              RIFF::List* rgn = lrgn->GetFirstSubList();              if (lrgn) {
4421              while (rgn) {                  RIFF::List* rgn = lrgn->GetFirstSubList();
4422                  if (rgn->GetListType() == LIST_TYPE_RGN) {                  while (rgn) {
4423                      __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);                      if (rgn->GetListType() == LIST_TYPE_RGN) {
4424                      pRegions->push_back(new Region(this, rgn));                          __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
4425                            pRegions->push_back(new Region(this, rgn));
4426                        }
4427                        rgn = lrgn->GetNextSubList();
4428                    }
4429                    // Creating Region Key Table for fast lookup
4430                    UpdateRegionKeyTable();
4431                }
4432            }
4433    
4434            // own gig format extensions
4435            RIFF::List* lst3LS = insList->GetSubList(LIST_TYPE_3LS);
4436            if (lst3LS) {
4437                RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4438                if (ckSCSL) {
4439                    int headerSize = ckSCSL->ReadUint32();
4440                    int slotCount  = ckSCSL->ReadUint32();
4441                    if (slotCount) {
4442                        int slotSize  = ckSCSL->ReadUint32();
4443                        ckSCSL->SetPos(headerSize); // in case of future header extensions
4444                        int unknownSpace = slotSize - 2*sizeof(uint32_t); // in case of future slot extensions
4445                        for (int i = 0; i < slotCount; ++i) {
4446                            _ScriptPooolEntry e;
4447                            e.fileOffset = ckSCSL->ReadUint32();
4448                            e.bypass     = ckSCSL->ReadUint32() & 1;
4449                            if (unknownSpace) ckSCSL->SetPos(unknownSpace, RIFF::stream_curpos); // in case of future extensions
4450                            scriptPoolFileOffsets.push_back(e);
4451                        }
4452                  }                  }
                 rgn = lrgn->GetNextSubList();  
4453              }              }
             // Creating Region Key Table for fast lookup  
             UpdateRegionKeyTable();  
4454          }          }
4455    
4456          __notify_progress(pProgress, 1.0f); // notify done          __notify_progress(pProgress, 1.0f); // notify done
# Line 2988  namespace { Line 4469  namespace {
4469      }      }
4470    
4471      Instrument::~Instrument() {      Instrument::~Instrument() {
4472            for (int i = 0 ; pMidiRules[i] ; i++) {
4473                delete pMidiRules[i];
4474            }
4475            delete[] pMidiRules;
4476            if (pScriptRefs) delete pScriptRefs;
4477      }      }
4478    
4479      /**      /**
# Line 2997  namespace { Line 4483  namespace {
4483       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
4484       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
4485       *       *
4486         * @param pProgress - callback function for progress notification
4487       * @throws gig::Exception if samples cannot be dereferenced       * @throws gig::Exception if samples cannot be dereferenced
4488       */       */
4489      void Instrument::UpdateChunks() {      void Instrument::UpdateChunks(progress_t* pProgress) {
4490          // first update base classes' chunks          // first update base classes' chunks
4491          DLS::Instrument::UpdateChunks();          DLS::Instrument::UpdateChunks(pProgress);
4492    
4493          // update Regions' chunks          // update Regions' chunks
4494          {          {
4495              RegionList::iterator iter = pRegions->begin();              RegionList::iterator iter = pRegions->begin();
4496              RegionList::iterator end  = pRegions->end();              RegionList::iterator end  = pRegions->end();
4497              for (; iter != end; ++iter)              for (; iter != end; ++iter)
4498                  (*iter)->UpdateChunks();                  (*iter)->UpdateChunks(pProgress);
4499          }          }
4500    
4501          // make sure 'lart' RIFF list chunk exists          // make sure 'lart' RIFF list chunk exists
# Line 3034  namespace { Line 4521  namespace {
4521                                      DimensionKeyRange.low << 1;                                      DimensionKeyRange.low << 1;
4522          pData[10] = dimkeystart;          pData[10] = dimkeystart;
4523          pData[11] = DimensionKeyRange.high;          pData[11] = DimensionKeyRange.high;
4524    
4525            if (pMidiRules[0] == 0 && _3ewg->GetSize() >= 34) {
4526                pData[32] = 0;
4527                pData[33] = 0;
4528            } else {
4529                for (int i = 0 ; pMidiRules[i] ; i++) {
4530                    pMidiRules[i]->UpdateChunks(pData);
4531                }
4532            }
4533    
4534            // own gig format extensions
4535           if (ScriptSlotCount()) {
4536               // make sure we have converted the original loaded script file
4537               // offsets into valid Script object pointers
4538               LoadScripts();
4539    
4540               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
4541               if (!lst3LS) lst3LS = pCkInstrument->AddSubList(LIST_TYPE_3LS);
4542               const int slotCount = pScriptRefs->size();
4543               const int headerSize = 3 * sizeof(uint32_t);
4544               const int slotSize  = 2 * sizeof(uint32_t);
4545               const int totalChunkSize = headerSize + slotCount * slotSize;
4546               RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4547               if (!ckSCSL) ckSCSL = lst3LS->AddSubChunk(CHUNK_ID_SCSL, totalChunkSize);
4548               else ckSCSL->Resize(totalChunkSize);
4549               uint8_t* pData = (uint8_t*) ckSCSL->LoadChunkData();
4550               int pos = 0;
4551               store32(&pData[pos], headerSize);
4552               pos += sizeof(uint32_t);
4553               store32(&pData[pos], slotCount);
4554               pos += sizeof(uint32_t);
4555               store32(&pData[pos], slotSize);
4556               pos += sizeof(uint32_t);
4557               for (int i = 0; i < slotCount; ++i) {
4558                   // arbitrary value, the actual file offset will be updated in
4559                   // UpdateScriptFileOffsets() after the file has been resized
4560                   int bogusFileOffset = 0;
4561                   store32(&pData[pos], bogusFileOffset);
4562                   pos += sizeof(uint32_t);
4563                   store32(&pData[pos], (*pScriptRefs)[i].bypass ? 1 : 0);
4564                   pos += sizeof(uint32_t);
4565               }
4566           } else {
4567               // no script slots, so get rid of any LS custom RIFF chunks (if any)
4568               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
4569               if (lst3LS) pCkInstrument->DeleteSubChunk(lst3LS);
4570           }
4571        }
4572    
4573        void Instrument::UpdateScriptFileOffsets() {
4574           // own gig format extensions
4575           if (pScriptRefs && pScriptRefs->size() > 0) {
4576               RIFF::List* lst3LS = pCkInstrument->GetSubList(LIST_TYPE_3LS);
4577               RIFF::Chunk* ckSCSL = lst3LS->GetSubChunk(CHUNK_ID_SCSL);
4578               const int slotCount = pScriptRefs->size();
4579               const int headerSize = 3 * sizeof(uint32_t);
4580               ckSCSL->SetPos(headerSize);
4581               for (int i = 0; i < slotCount; ++i) {
4582                   uint32_t fileOffset =
4583                        (*pScriptRefs)[i].script->pChunk->GetFilePos() -
4584                        (*pScriptRefs)[i].script->pChunk->GetPos() -
4585                        CHUNK_HEADER_SIZE(ckSCSL->GetFile()->GetFileOffsetSize());
4586                   ckSCSL->WriteUint32(&fileOffset);
4587                   // jump over flags entry (containing the bypass flag)
4588                   ckSCSL->SetPos(sizeof(uint32_t), RIFF::stream_curpos);
4589               }
4590           }        
4591      }      }
4592    
4593      /**      /**
# Line 3102  namespace { Line 4656  namespace {
4656          UpdateRegionKeyTable();          UpdateRegionKeyTable();
4657      }      }
4658    
4659        /**
4660         * Move this instrument at the position before @arg dst.
4661         *
4662         * This method can be used to reorder the sequence of instruments in a
4663         * .gig file. This might be helpful especially on large .gig files which
4664         * contain a large number of instruments within the same .gig file. So
4665         * grouping such instruments to similar ones, can help to keep track of them
4666         * when working with such complex .gig files.
4667         *
4668         * When calling this method, this instrument will be removed from in its
4669         * current position in the instruments list and moved to the requested
4670         * target position provided by @param dst. You may also pass NULL as
4671         * argument to this method, in that case this intrument will be moved to the
4672         * very end of the .gig file's instrument list.
4673         *
4674         * You have to call Save() to make the order change persistent to the .gig
4675         * file.
4676         *
4677         * Currently this method is limited to moving the instrument within the same
4678         * .gig file. Trying to move it to another .gig file by calling this method
4679         * will throw an exception.
4680         *
4681         * @param dst - destination instrument at which this instrument will be
4682         *              moved to, or pass NULL for moving to end of list
4683         * @throw gig::Exception if this instrument and target instrument are not
4684         *                       part of the same file
4685         */
4686        void Instrument::MoveTo(Instrument* dst) {
4687            if (dst && GetParent() != dst->GetParent())
4688                throw Exception(
4689                    "gig::Instrument::MoveTo() can only be used for moving within "
4690                    "the same gig file."
4691                );
4692    
4693            File* pFile = (File*) GetParent();
4694    
4695            // move this instrument within the instrument list
4696            {
4697                File::InstrumentList& list = *pFile->pInstruments;
4698    
4699                File::InstrumentList::iterator itFrom =
4700                    std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(this));
4701    
4702                File::InstrumentList::iterator itTo =
4703                    std::find(list.begin(), list.end(), static_cast<DLS::Instrument*>(dst));
4704    
4705                list.splice(itTo, list, itFrom);
4706            }
4707    
4708            // move the instrument's actual list RIFF chunk appropriately
4709            RIFF::List* lstCkInstruments = pFile->pRIFF->GetSubList(LIST_TYPE_LINS);
4710            lstCkInstruments->MoveSubChunk(
4711                this->pCkInstrument,
4712                (RIFF::Chunk*) ((dst) ? dst->pCkInstrument : NULL)
4713            );
4714        }
4715    
4716        /**
4717         * Returns a MIDI rule of the instrument.
4718         *
4719         * The list of MIDI rules, at least in gig v3, always contains at
4720         * most two rules. The second rule can only be the DEF filter
4721         * (which currently isn't supported by libgig).
4722         *
4723         * @param i - MIDI rule number
4724         * @returns   pointer address to MIDI rule number i or NULL if there is none
4725         */
4726        MidiRule* Instrument::GetMidiRule(int i) {
4727            return pMidiRules[i];
4728        }
4729    
4730        /**
4731         * Adds the "controller trigger" MIDI rule to the instrument.
4732         *
4733         * @returns the new MIDI rule
4734         */
4735        MidiRuleCtrlTrigger* Instrument::AddMidiRuleCtrlTrigger() {
4736            delete pMidiRules[0];
4737            MidiRuleCtrlTrigger* r = new MidiRuleCtrlTrigger;
4738            pMidiRules[0] = r;
4739            pMidiRules[1] = 0;
4740            return r;
4741        }
4742    
4743        /**
4744         * Adds the legato MIDI rule to the instrument.
4745         *
4746         * @returns the new MIDI rule
4747         */
4748        MidiRuleLegato* Instrument::AddMidiRuleLegato() {
4749            delete pMidiRules[0];
4750            MidiRuleLegato* r = new MidiRuleLegato;
4751            pMidiRules[0] = r;
4752            pMidiRules[1] = 0;
4753            return r;
4754        }
4755    
4756        /**
4757         * Adds the alternator MIDI rule to the instrument.
4758         *
4759         * @returns the new MIDI rule
4760         */
4761        MidiRuleAlternator* Instrument::AddMidiRuleAlternator() {
4762            delete pMidiRules[0];
4763            MidiRuleAlternator* r = new MidiRuleAlternator;
4764            pMidiRules[0] = r;
4765            pMidiRules[1] = 0;
4766            return r;
4767        }
4768    
4769        /**
4770         * Deletes a MIDI rule from the instrument.
4771         *
4772         * @param i - MIDI rule number
4773         */
4774        void Instrument::DeleteMidiRule(int i) {
4775            delete pMidiRules[i];
4776            pMidiRules[i] = 0;
4777        }
4778    
4779        void Instrument::LoadScripts() {
4780            if (pScriptRefs) return;
4781            pScriptRefs = new std::vector<_ScriptPooolRef>;
4782            if (scriptPoolFileOffsets.empty()) return;
4783            File* pFile = (File*) GetParent();
4784            for (uint k = 0; k < scriptPoolFileOffsets.size(); ++k) {
4785                uint32_t soughtOffset = scriptPoolFileOffsets[k].fileOffset;
4786                for (uint i = 0; pFile->GetScriptGroup(i); ++i) {
4787                    ScriptGroup* group = pFile->GetScriptGroup(i);
4788                    for (uint s = 0; group->GetScript(s); ++s) {
4789                        Script* script = group->GetScript(s);
4790                        if (script->pChunk) {
4791                            uint32_t offset = script->pChunk->GetFilePos() -
4792                                              script->pChunk->GetPos() -
4793                                              CHUNK_HEADER_SIZE(script->pChunk->GetFile()->GetFileOffsetSize());
4794                            if (offset == soughtOffset)
4795                            {
4796                                _ScriptPooolRef ref;
4797                                ref.script = script;
4798                                ref.bypass = scriptPoolFileOffsets[k].bypass;
4799                                pScriptRefs->push_back(ref);
4800                                break;
4801                            }
4802                        }
4803                    }
4804                }
4805            }
4806            // we don't need that anymore
4807            scriptPoolFileOffsets.clear();
4808        }
4809    
4810        /** @brief Get instrument script (gig format extension).
4811         *
4812         * Returns the real-time instrument script of instrument script slot
4813         * @a index.
4814         *
4815         * @note This is an own format extension which did not exist i.e. in the
4816         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4817         * gigedit.
4818         *
4819         * @param index - instrument script slot index
4820         * @returns script or NULL if index is out of bounds
4821         */
4822        Script* Instrument::GetScriptOfSlot(uint index) {
4823            LoadScripts();
4824            if (index >= pScriptRefs->size()) return NULL;
4825            return pScriptRefs->at(index).script;
4826        }
4827    
4828        /** @brief Add new instrument script slot (gig format extension).
4829         *
4830         * Add the given real-time instrument script reference to this instrument,
4831         * which shall be executed by the sampler for for this instrument. The
4832         * script will be added to the end of the script list of this instrument.
4833         * The positions of the scripts in the Instrument's Script list are
4834         * relevant, because they define in which order they shall be executed by
4835         * the sampler. For this reason it is also legal to add the same script
4836         * twice to an instrument, for example you might have a script called
4837         * "MyFilter" which performs an event filter task, and you might have
4838         * another script called "MyNoteTrigger" which triggers new notes, then you
4839         * might for example have the following list of scripts on the instrument:
4840         *
4841         * 1. Script "MyFilter"
4842         * 2. Script "MyNoteTrigger"
4843         * 3. Script "MyFilter"
4844         *
4845         * Which would make sense, because the 2nd script launched new events, which
4846         * you might need to filter as well.
4847         *
4848         * There are two ways to disable / "bypass" scripts. You can either disable
4849         * a script locally for the respective script slot on an instrument (i.e. by
4850         * passing @c false to the 2nd argument of this method, or by calling
4851         * SetScriptBypassed()). Or you can disable a script globally for all slots
4852         * and all instruments by setting Script::Bypass.
4853         *
4854         * @note This is an own format extension which did not exist i.e. in the
4855         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4856         * gigedit.
4857         *
4858         * @param pScript - script that shall be executed for this instrument
4859         * @param bypass  - if enabled, the sampler shall skip executing this
4860         *                  script (in the respective list position)
4861         * @see SetScriptBypassed()
4862         */
4863        void Instrument::AddScriptSlot(Script* pScript, bool bypass) {
4864            LoadScripts();
4865            _ScriptPooolRef ref = { pScript, bypass };
4866            pScriptRefs->push_back(ref);
4867        }
4868    
4869        /** @brief Flip two script slots with each other (gig format extension).
4870         *
4871         * Swaps the position of the two given scripts in the Instrument's Script
4872         * list. The positions of the scripts in the Instrument's Script list are
4873         * relevant, because they define in which order they shall be executed by
4874         * the sampler.
4875         *
4876         * @note This is an own format extension which did not exist i.e. in the
4877         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4878         * gigedit.
4879         *
4880         * @param index1 - index of the first script slot to swap
4881         * @param index2 - index of the second script slot to swap
4882         */
4883        void Instrument::SwapScriptSlots(uint index1, uint index2) {
4884            LoadScripts();
4885            if (index1 >= pScriptRefs->size() || index2 >= pScriptRefs->size())
4886                return;
4887            _ScriptPooolRef tmp = (*pScriptRefs)[index1];
4888            (*pScriptRefs)[index1] = (*pScriptRefs)[index2];
4889            (*pScriptRefs)[index2] = tmp;
4890        }
4891    
4892        /** @brief Remove script slot.
4893         *
4894         * Removes the script slot with the given slot index.
4895         *
4896         * @param index - index of script slot to remove
4897         */
4898        void Instrument::RemoveScriptSlot(uint index) {
4899            LoadScripts();
4900            if (index >= pScriptRefs->size()) return;
4901            pScriptRefs->erase( pScriptRefs->begin() + index );
4902        }
4903    
4904        /** @brief Remove reference to given Script (gig format extension).
4905         *
4906         * This will remove all script slots on the instrument which are referencing
4907         * the given script.
4908         *
4909         * @note This is an own format extension which did not exist i.e. in the
4910         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4911         * gigedit.
4912         *
4913         * @param pScript - script reference to remove from this instrument
4914         * @see RemoveScriptSlot()
4915         */
4916        void Instrument::RemoveScript(Script* pScript) {
4917            LoadScripts();
4918            for (int i = pScriptRefs->size() - 1; i >= 0; --i) {
4919                if ((*pScriptRefs)[i].script == pScript) {
4920                    pScriptRefs->erase( pScriptRefs->begin() + i );
4921                }
4922            }
4923        }
4924    
4925        /** @brief Instrument's amount of script slots.
4926         *
4927         * This method returns the amount of script slots this instrument currently
4928         * uses.
4929         *
4930         * A script slot is a reference of a real-time instrument script to be
4931         * executed by the sampler. The scripts will be executed by the sampler in
4932         * sequence of the slots. One (same) script may be referenced multiple
4933         * times in different slots.
4934         *
4935         * @note This is an own format extension which did not exist i.e. in the
4936         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4937         * gigedit.
4938         */
4939        uint Instrument::ScriptSlotCount() const {
4940            return pScriptRefs ? pScriptRefs->size() : scriptPoolFileOffsets.size();
4941        }
4942    
4943        /** @brief Whether script execution shall be skipped.
4944         *
4945         * Defines locally for the Script reference slot in the Instrument's Script
4946         * list, whether the script shall be skipped by the sampler regarding
4947         * execution.
4948         *
4949         * It is also possible to ignore exeuction of the script globally, for all
4950         * slots and for all instruments by setting Script::Bypass.
4951         *
4952         * @note This is an own format extension which did not exist i.e. in the
4953         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4954         * gigedit.
4955         *
4956         * @param index - index of the script slot on this instrument
4957         * @see Script::Bypass
4958         */
4959        bool Instrument::IsScriptSlotBypassed(uint index) {
4960            if (index >= ScriptSlotCount()) return false;
4961            return pScriptRefs ? pScriptRefs->at(index).bypass
4962                               : scriptPoolFileOffsets.at(index).bypass;
4963            
4964        }
4965    
4966        /** @brief Defines whether execution shall be skipped.
4967         *
4968         * You can call this method to define locally whether or whether not the
4969         * given script slot shall be executed by the sampler.
4970         *
4971         * @note This is an own format extension which did not exist i.e. in the
4972         * GigaStudio 4 software. It will currently only work with LinuxSampler and
4973         * gigedit.
4974         *
4975         * @param index - script slot index on this instrument
4976         * @param bBypass - if true, the script slot will be skipped by the sampler
4977         * @see Script::Bypass
4978         */
4979        void Instrument::SetScriptSlotBypassed(uint index, bool bBypass) {
4980            if (index >= ScriptSlotCount()) return;
4981            if (pScriptRefs)
4982                pScriptRefs->at(index).bypass = bBypass;
4983            else
4984                scriptPoolFileOffsets.at(index).bypass = bBypass;
4985        }
4986    
4987        /**
4988         * Make a (semi) deep copy of the Instrument object given by @a orig
4989         * and assign it to this object.
4990         *
4991         * Note that all sample pointers referenced by @a orig are simply copied as
4992         * memory address. Thus the respective samples are shared, not duplicated!
4993         *
4994         * @param orig - original Instrument object to be copied from
4995         */
4996        void Instrument::CopyAssign(const Instrument* orig) {
4997            CopyAssign(orig, NULL);
4998        }
4999            
5000        /**
5001         * Make a (semi) deep copy of the Instrument object given by @a orig
5002         * and assign it to this object.
5003         *
5004         * @param orig - original Instrument object to be copied from
5005         * @param mSamples - crosslink map between the foreign file's samples and
5006         *                   this file's samples
5007         */
5008        void Instrument::CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples) {
5009            // handle base class
5010            // (without copying DLS region stuff)
5011            DLS::Instrument::CopyAssignCore(orig);
5012            
5013            // handle own member variables
5014            Attenuation = orig->Attenuation;
5015            EffectSend = orig->EffectSend;
5016            FineTune = orig->FineTune;
5017            PitchbendRange = orig->PitchbendRange;
5018            PianoReleaseMode = orig->PianoReleaseMode;
5019            DimensionKeyRange = orig->DimensionKeyRange;
5020            scriptPoolFileOffsets = orig->scriptPoolFileOffsets;
5021            pScriptRefs = orig->pScriptRefs;
5022            
5023            // free old midi rules
5024            for (int i = 0 ; pMidiRules[i] ; i++) {
5025                delete pMidiRules[i];
5026            }
5027            //TODO: MIDI rule copying
5028            pMidiRules[0] = NULL;
5029            
5030            // delete all old regions
5031            while (Regions) DeleteRegion(GetFirstRegion());
5032            // create new regions and copy them from original
5033            {
5034                RegionList::const_iterator it = orig->pRegions->begin();
5035                for (int i = 0; i < orig->Regions; ++i, ++it) {
5036                    Region* dstRgn = AddRegion();
5037                    //NOTE: Region does semi-deep copy !
5038                    dstRgn->CopyAssign(
5039                        static_cast<gig::Region*>(*it),
5040                        mSamples
5041                    );
5042                }
5043            }
5044    
5045            UpdateRegionKeyTable();
5046        }
5047    
5048    
5049  // *************** Group ***************  // *************** Group ***************
# Line 3131  namespace { Line 5073  namespace {
5073       *       *
5074       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
5075       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
5076         *
5077         * @param pProgress - callback function for progress notification
5078       */       */
5079      void Group::UpdateChunks() {      void Group::UpdateChunks(progress_t* pProgress) {
5080          // make sure <3gri> and <3gnl> list chunks exist          // make sure <3gri> and <3gnl> list chunks exist
5081          RIFF::List* _3gri = pFile->pRIFF->GetSubList(LIST_TYPE_3GRI);          RIFF::List* _3gri = pFile->pRIFF->GetSubList(LIST_TYPE_3GRI);
5082          if (!_3gri) {          if (!_3gri) {
# Line 3259  namespace { Line 5203  namespace {
5203      };      };
5204    
5205      File::File() : DLS::File() {      File::File() : DLS::File() {
5206            bAutoLoad = true;
5207          *pVersion = VERSION_3;          *pVersion = VERSION_3;
5208          pGroups = NULL;          pGroups = NULL;
5209            pScriptGroups = NULL;
5210          pInfo->SetFixedStringLengths(_FileFixedStringLengths);          pInfo->SetFixedStringLengths(_FileFixedStringLengths);
5211          pInfo->ArchivalLocation = String(256, ' ');          pInfo->ArchivalLocation = String(256, ' ');
5212    
# Line 3274  namespace { Line 5220  namespace {
5220      }      }
5221    
5222      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {
5223            bAutoLoad = true;
5224          pGroups = NULL;          pGroups = NULL;
5225            pScriptGroups = NULL;
5226          pInfo->SetFixedStringLengths(_FileFixedStringLengths);          pInfo->SetFixedStringLengths(_FileFixedStringLengths);
5227      }      }
5228    
# Line 3288  namespace { Line 5236  namespace {
5236              }              }
5237              delete pGroups;              delete pGroups;
5238          }          }
5239            if (pScriptGroups) {
5240                std::list<ScriptGroup*>::iterator iter = pScriptGroups->begin();
5241                std::list<ScriptGroup*>::iterator end  = pScriptGroups->end();
5242                while (iter != end) {
5243                    delete *iter;
5244                    ++iter;
5245                }
5246                delete pScriptGroups;
5247            }
5248      }      }
5249    
5250      Sample* File::GetFirstSample(progress_t* pProgress) {      Sample* File::GetFirstSample(progress_t* pProgress) {
# Line 3302  namespace { Line 5259  namespace {
5259          SamplesIterator++;          SamplesIterator++;
5260          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
5261      }      }
5262        
5263        /**
5264         * Returns Sample object of @a index.
5265         *
5266         * @returns sample object or NULL if index is out of bounds
5267         */
5268        Sample* File::GetSample(uint index) {
5269            if (!pSamples) LoadSamples();
5270            if (!pSamples) return NULL;
5271            DLS::File::SampleList::iterator it = pSamples->begin();
5272            for (int i = 0; i < index; ++i) {
5273                ++it;
5274                if (it == pSamples->end()) return NULL;
5275            }
5276            if (it == pSamples->end()) return NULL;
5277            return static_cast<gig::Sample*>( *it );
5278        }
5279    
5280      /** @brief Add a new sample.      /** @brief Add a new sample.
5281       *       *
# Line 3343  namespace { Line 5317  namespace {
5317          pSamples->erase(iter);          pSamples->erase(iter);
5318          delete pSample;          delete pSample;
5319    
5320            SampleList::iterator tmp = SamplesIterator;
5321          // remove all references to the sample          // remove all references to the sample
5322          for (Instrument* instrument = GetFirstInstrument() ; instrument ;          for (Instrument* instrument = GetFirstInstrument() ; instrument ;
5323               instrument = GetNextInstrument()) {               instrument = GetNextInstrument()) {
# Line 3357  namespace { Line 5332  namespace {
5332                  }                  }
5333              }              }
5334          }          }
5335            SamplesIterator = tmp; // restore iterator
5336      }      }
5337    
5338      void File::LoadSamples() {      void File::LoadSamples() {
# Line 3377  namespace { Line 5353  namespace {
5353          int iTotalSamples = WavePoolCount;          int iTotalSamples = WavePoolCount;
5354    
5355          // check if samples should be loaded from extension files          // check if samples should be loaded from extension files
5356            // (only for old gig files < 2 GB)
5357          int lastFileNo = 0;          int lastFileNo = 0;
5358          for (int i = 0 ; i < WavePoolCount ; i++) {          if (!file->IsNew() && !(file->GetCurrentFileSize() >> 31)) {
5359              if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];              for (int i = 0 ; i < WavePoolCount ; i++) {
5360                    if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];
5361                }
5362          }          }
5363          String name(pRIFF->GetFileName());          String name(pRIFF->GetFileName());
5364          int nameLen = name.length();          int nameLen = name.length();
# Line 3389  namespace { Line 5368  namespace {
5368          for (int fileNo = 0 ; ; ) {          for (int fileNo = 0 ; ; ) {
5369              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);
5370              if (wvpl) {              if (wvpl) {
5371                  unsigned long wvplFileOffset = wvpl->GetFilePos();                  file_offset_t wvplFileOffset = wvpl->GetFilePos();
5372                  RIFF::List* wave = wvpl->GetFirstSubList();                  RIFF::List* wave = wvpl->GetFirstSubList();
5373                  while (wave) {                  while (wave) {
5374                      if (wave->GetListType() == LIST_TYPE_WAVE) {                      if (wave->GetListType() == LIST_TYPE_WAVE) {
# Line 3397  namespace { Line 5376  namespace {
5376                          const float subprogress = (float) iSampleIndex / (float) iTotalSamples;                          const float subprogress = (float) iSampleIndex / (float) iTotalSamples;
5377                          __notify_progress(pProgress, subprogress);                          __notify_progress(pProgress, subprogress);
5378    
5379                          unsigned long waveFileOffset = wave->GetFilePos();                          file_offset_t waveFileOffset = wave->GetFilePos();
5380                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));
5381    
5382                          iSampleIndex++;                          iSampleIndex++;
# Line 3447  namespace { Line 5426  namespace {
5426              progress_t subprogress;              progress_t subprogress;
5427              __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask              __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask
5428              __notify_progress(&subprogress, 0.0f);              __notify_progress(&subprogress, 0.0f);
5429              GetFirstSample(&subprogress); // now force all samples to be loaded              if (GetAutoLoad())
5430                    GetFirstSample(&subprogress); // now force all samples to be loaded
5431              __notify_progress(&subprogress, 1.0f);              __notify_progress(&subprogress, 1.0f);
5432    
5433              // instrument loading subtask              // instrument loading subtask
# Line 3496  namespace { Line 5476  namespace {
5476         pInstruments->push_back(pInstrument);         pInstruments->push_back(pInstrument);
5477         return pInstrument;         return pInstrument;
5478      }      }
5479        
5480        /** @brief Add a duplicate of an existing instrument.
5481         *
5482         * Duplicates the instrument definition given by @a orig and adds it
5483         * to this file. This allows in an instrument editor application to
5484         * easily create variations of an instrument, which will be stored in
5485         * the same .gig file, sharing i.e. the same samples.
5486         *
5487         * Note that all sample pointers referenced by @a orig are simply copied as
5488         * memory address. Thus the respective samples are shared, not duplicated!
5489         *
5490         * You have to call Save() to make this persistent to the file.
5491         *
5492         * @param orig - original instrument to be copied
5493         * @returns duplicated copy of the given instrument
5494         */
5495        Instrument* File::AddDuplicateInstrument(const Instrument* orig) {
5496            Instrument* instr = AddInstrument();
5497            instr->CopyAssign(orig);
5498            return instr;
5499        }
5500        
5501        /** @brief Add content of another existing file.
5502         *
5503         * Duplicates the samples, groups and instruments of the original file
5504         * given by @a pFile and adds them to @c this File. In case @c this File is
5505         * a new one that you haven't saved before, then you have to call
5506         * SetFileName() before calling AddContentOf(), because this method will
5507         * automatically save this file during operation, which is required for
5508         * writing the sample waveform data by disk streaming.
5509         *
5510         * @param pFile - original file whose's content shall be copied from
5511         */
5512        void File::AddContentOf(File* pFile) {
5513            static int iCallCount = -1;
5514            iCallCount++;
5515            std::map<Group*,Group*> mGroups;
5516            std::map<Sample*,Sample*> mSamples;
5517            
5518            // clone sample groups
5519            for (int i = 0; pFile->GetGroup(i); ++i) {
5520                Group* g = AddGroup();
5521                g->Name =
5522                    "COPY" + ToString(iCallCount) + "_" + pFile->GetGroup(i)->Name;
5523                mGroups[pFile->GetGroup(i)] = g;
5524            }
5525            
5526            // clone samples (not waveform data here yet)
5527            for (int i = 0; pFile->GetSample(i); ++i) {
5528                Sample* s = AddSample();
5529                s->CopyAssignMeta(pFile->GetSample(i));
5530                mGroups[pFile->GetSample(i)->GetGroup()]->AddSample(s);
5531                mSamples[pFile->GetSample(i)] = s;
5532            }
5533            
5534            //BUG: For some reason this method only works with this additional
5535            //     Save() call in between here.
5536            //
5537            // Important: The correct one of the 2 Save() methods has to be called
5538            // here, depending on whether the file is completely new or has been
5539            // saved to disk already, otherwise it will result in data corruption.
5540            if (pRIFF->IsNew())
5541                Save(GetFileName());
5542            else
5543                Save();
5544            
5545            // clone instruments
5546            // (passing the crosslink table here for the cloned samples)
5547            for (int i = 0; pFile->GetInstrument(i); ++i) {
5548                Instrument* instr = AddInstrument();
5549                instr->CopyAssign(pFile->GetInstrument(i), &mSamples);
5550            }
5551            
5552            // Mandatory: file needs to be saved to disk at this point, so this
5553            // file has the correct size and data layout for writing the samples'
5554            // waveform data to disk.
5555            Save();
5556            
5557            // clone samples' waveform data
5558            // (using direct read & write disk streaming)
5559            for (int i = 0; pFile->GetSample(i); ++i) {
5560                mSamples[pFile->GetSample(i)]->CopyAssignWave(pFile->GetSample(i));
5561            }
5562        }
5563    
5564      /** @brief Delete an instrument.      /** @brief Delete an instrument.
5565       *       *
# Line 3598  namespace { Line 5662  namespace {
5662          return NULL;          return NULL;
5663      }      }
5664    
5665        /**
5666         * Returns the group with the given group name.
5667         *
5668         * Note: group names don't have to be unique in the gig format! So there
5669         * can be multiple groups with the same name. This method will simply
5670         * return the first group found with the given name.
5671         *
5672         * @param name - name of the sought group
5673         * @returns sought group or NULL if there's no group with that name
5674         */
5675        Group* File::GetGroup(String name) {
5676            if (!pGroups) LoadGroups();
5677            GroupsIterator = pGroups->begin();
5678            for (uint i = 0; GroupsIterator != pGroups->end(); ++GroupsIterator, ++i)
5679                if ((*GroupsIterator)->Name == name) return *GroupsIterator;
5680            return NULL;
5681        }
5682    
5683      Group* File::AddGroup() {      Group* File::AddGroup() {
5684          if (!pGroups) LoadGroups();          if (!pGroups) LoadGroups();
5685          // there must always be at least one group          // there must always be at least one group
# Line 3678  namespace { Line 5760  namespace {
5760          }          }
5761      }      }
5762    
5763        /** @brief Get instrument script group (by index).
5764         *
5765         * Returns the real-time instrument script group with the given index.
5766         *
5767         * @param index - number of the sought group (0..n)
5768         * @returns sought script group or NULL if there's no such group
5769         */
5770        ScriptGroup* File::GetScriptGroup(uint index) {
5771            if (!pScriptGroups) LoadScriptGroups();
5772            std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
5773            for (uint i = 0; it != pScriptGroups->end(); ++i, ++it)
5774                if (i == index) return *it;
5775            return NULL;
5776        }
5777    
5778        /** @brief Get instrument script group (by name).
5779         *
5780         * Returns the first real-time instrument script group found with the given
5781         * group name. Note that group names may not necessarily be unique.
5782         *
5783         * @param name - name of the sought script group
5784         * @returns sought script group or NULL if there's no such group
5785         */
5786        ScriptGroup* File::GetScriptGroup(const String& name) {
5787            if (!pScriptGroups) LoadScriptGroups();
5788            std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
5789            for (uint i = 0; it != pScriptGroups->end(); ++i, ++it)
5790                if ((*it)->Name == name) return *it;
5791            return NULL;
5792        }
5793    
5794        /** @brief Add new instrument script group.
5795         *
5796         * Adds a new, empty real-time instrument script group to the file.
5797         *
5798         * You have to call Save() to make this persistent to the file.
5799         *
5800         * @return new empty script group
5801         */
5802        ScriptGroup* File::AddScriptGroup() {
5803            if (!pScriptGroups) LoadScriptGroups();
5804            ScriptGroup* pScriptGroup = new ScriptGroup(this, NULL);
5805            pScriptGroups->push_back(pScriptGroup);
5806            return pScriptGroup;
5807        }
5808    
5809        /** @brief Delete an instrument script group.
5810         *
5811         * This will delete the given real-time instrument script group and all its
5812         * instrument scripts it contains. References inside instruments that are
5813         * using the deleted scripts will be removed from the respective instruments
5814         * accordingly.
5815         *
5816         * You have to call Save() to make this persistent to the file.
5817         *
5818         * @param pScriptGroup - script group to delete
5819         * @throws gig::Exception if given script group could not be found
5820         */
5821        void File::DeleteScriptGroup(ScriptGroup* pScriptGroup) {
5822            if (!pScriptGroups) LoadScriptGroups();
5823            std::list<ScriptGroup*>::iterator iter =
5824                find(pScriptGroups->begin(), pScriptGroups->end(), pScriptGroup);
5825            if (iter == pScriptGroups->end())
5826                throw gig::Exception("Could not delete script group, could not find given script group");
5827            pScriptGroups->erase(iter);
5828            for (int i = 0; pScriptGroup->GetScript(i); ++i)
5829                pScriptGroup->DeleteScript(pScriptGroup->GetScript(i));
5830            if (pScriptGroup->pList)
5831                pScriptGroup->pList->GetParent()->DeleteSubChunk(pScriptGroup->pList);
5832            delete pScriptGroup;
5833        }
5834    
5835        void File::LoadScriptGroups() {
5836            if (pScriptGroups) return;
5837            pScriptGroups = new std::list<ScriptGroup*>;
5838            RIFF::List* lstLS = pRIFF->GetSubList(LIST_TYPE_3LS);
5839            if (lstLS) {
5840                for (RIFF::List* lst = lstLS->GetFirstSubList(); lst;
5841                     lst = lstLS->GetNextSubList())
5842                {
5843                    if (lst->GetListType() == LIST_TYPE_RTIS) {
5844                        pScriptGroups->push_back(new ScriptGroup(this, lst));
5845                    }
5846                }
5847            }
5848        }
5849    
5850      /**      /**
5851       * Apply all the gig file's current instruments, samples, groups and settings       * Apply all the gig file's current instruments, samples, groups and settings
5852       * 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 3686  namespace { Line 5855  namespace {
5855       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
5856       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
5857       *       *
5858         * @param pProgress - callback function for progress notification
5859       * @throws Exception - on errors       * @throws Exception - on errors
5860       */       */
5861      void File::UpdateChunks() {      void File::UpdateChunks(progress_t* pProgress) {
5862          bool newFile = pRIFF->GetSubList(LIST_TYPE_INFO) == NULL;          bool newFile = pRIFF->GetSubList(LIST_TYPE_INFO) == NULL;
5863    
5864          b64BitWavePoolOffsets = pVersion && pVersion->major == 3;          // update own gig format extension chunks
5865            // (not part of the GigaStudio 4 format)
5866            RIFF::List* lst3LS = pRIFF->GetSubList(LIST_TYPE_3LS);
5867            if (!lst3LS) {
5868                lst3LS = pRIFF->AddSubList(LIST_TYPE_3LS);
5869            }
5870            // Make sure <3LS > chunk is placed before <ptbl> chunk. The precise
5871            // location of <3LS > is irrelevant, however it should be located
5872            // before  the actual wave data
5873            RIFF::Chunk* ckPTBL = pRIFF->GetSubChunk(CHUNK_ID_PTBL);
5874            pRIFF->MoveSubChunk(lst3LS, ckPTBL);
5875    
5876            // This must be performed before writing the chunks for instruments,
5877            // because the instruments' script slots will write the file offsets
5878            // of the respective instrument script chunk as reference.
5879            if (pScriptGroups) {
5880                // Update instrument script (group) chunks.
5881                for (std::list<ScriptGroup*>::iterator it = pScriptGroups->begin();
5882                     it != pScriptGroups->end(); ++it)
5883                {
5884                    (*it)->UpdateChunks(pProgress);
5885                }
5886            }
5887    
5888            // in case no libgig custom format data was added, then remove the
5889            // custom "3LS " chunk again
5890            if (!lst3LS->CountSubChunks()) {
5891                pRIFF->DeleteSubChunk(lst3LS);
5892                lst3LS = NULL;
5893            }
5894    
5895          // first update base class's chunks          // first update base class's chunks
5896          DLS::File::UpdateChunks();          DLS::File::UpdateChunks(pProgress);
5897    
5898          if (newFile) {          if (newFile) {
5899              // INFO was added by Resource::UpdateChunks - make sure it              // INFO was added by Resource::UpdateChunks - make sure it
# Line 3708  namespace { Line 5907  namespace {
5907    
5908          // update group's chunks          // update group's chunks
5909          if (pGroups) {          if (pGroups) {
5910              std::list<Group*>::iterator iter = pGroups->begin();              // make sure '3gri' and '3gnl' list chunks exist
5911              std::list<Group*>::iterator end  = pGroups->end();              // (before updating the Group chunks)
5912              for (; iter != end; ++iter) {              RIFF::List* _3gri = pRIFF->GetSubList(LIST_TYPE_3GRI);
5913                  (*iter)->UpdateChunks();              if (!_3gri) {
5914                    _3gri = pRIFF->AddSubList(LIST_TYPE_3GRI);
5915                    pRIFF->MoveSubChunk(_3gri, pRIFF->GetSubChunk(CHUNK_ID_PTBL));
5916              }              }
5917                RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
5918                if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
5919    
5920              // v3: make sure the file has 128 3gnm chunks              // v3: make sure the file has 128 3gnm chunks
5921                // (before updating the Group chunks)
5922              if (pVersion && pVersion->major == 3) {              if (pVersion && pVersion->major == 3) {
                 RIFF::List* _3gnl = pRIFF->GetSubList(LIST_TYPE_3GRI)->GetSubList(LIST_TYPE_3GNL);  
5923                  RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();                  RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();
5924                  for (int i = 0 ; i < 128 ; i++) {                  for (int i = 0 ; i < 128 ; i++) {
5925                      if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);                      if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);
5926                      if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();                      if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();
5927                  }                  }
5928              }              }
5929    
5930                std::list<Group*>::iterator iter = pGroups->begin();
5931                std::list<Group*>::iterator end  = pGroups->end();
5932                for (; iter != end; ++iter) {
5933                    (*iter)->UpdateChunks(pProgress);
5934                }
5935          }          }
5936    
5937          // update einf chunk          // update einf chunk
# Line 3853  namespace { Line 6062  namespace {
6062              if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);              if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);
6063          }          }
6064      }      }
6065        
6066        void File::UpdateFileOffsets() {
6067            DLS::File::UpdateFileOffsets();
6068    
6069            for (Instrument* instrument = GetFirstInstrument(); instrument;
6070                 instrument = GetNextInstrument())
6071            {
6072                instrument->UpdateScriptFileOffsets();
6073            }
6074        }
6075    
6076        /**
6077         * Enable / disable automatic loading. By default this properyt is
6078         * enabled and all informations are loaded automatically. However
6079         * loading all Regions, DimensionRegions and especially samples might
6080         * take a long time for large .gig files, and sometimes one might only
6081         * be interested in retrieving very superficial informations like the
6082         * amount of instruments and their names. In this case one might disable
6083         * automatic loading to avoid very slow response times.
6084         *
6085         * @e CAUTION: by disabling this property many pointers (i.e. sample
6086         * references) and informations will have invalid or even undefined
6087         * data! This feature is currently only intended for retrieving very
6088         * superficial informations in a very fast way. Don't use it to retrieve
6089         * details like synthesis informations or even to modify .gig files!
6090         */
6091        void File::SetAutoLoad(bool b) {
6092            bAutoLoad = b;
6093        }
6094    
6095        /**
6096         * Returns whether automatic loading is enabled.
6097         * @see SetAutoLoad()
6098         */
6099        bool File::GetAutoLoad() {
6100            return bAutoLoad;
6101        }
6102    
6103    
6104    

Legend:
Removed from v.1416  
changed lines
  Added in v.2923

  ViewVC Help
Powered by ViewVC