/[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 384 by schoenebeck, Thu Feb 17 02:22:26 2005 UTC revision 929 by schoenebeck, Tue Oct 24 22:24:45 2006 UTC
# Line 2  Line 2 
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file loader library    *   *   libgig - C++ cross-platform Gigasampler format file loader library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003-2005 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2006 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 23  Line 23 
23    
24  #include "gig.h"  #include "gig.h"
25    
26    #include "helper.h"
27    
28    #include <math.h>
29  #include <iostream>  #include <iostream>
30    
31  namespace gig { namespace {  /// Initial size of the sample buffer which is used for decompression of
32    /// compressed sample wave streams - this value should always be bigger than
33    /// the biggest sample piece expected to be read by the sampler engine,
34    /// otherwise the buffer size will be raised at runtime and thus the buffer
35    /// reallocated which is time consuming and unefficient.
36    #define INITIAL_SAMPLE_BUFFER_SIZE              512000 // 512 kB
37    
38    /** (so far) every exponential paramater in the gig format has a basis of 1.000000008813822 */
39    #define GIG_EXP_DECODE(x)                       (pow(1.000000008813822, x))
40    #define GIG_EXP_ENCODE(x)                       (log(x) / log(1.000000008813822))
41    #define GIG_PITCH_TRACK_EXTRACT(x)              (!(x & 0x01))
42    #define GIG_PITCH_TRACK_ENCODE(x)               ((x) ? 0x00 : 0x01)
43    #define GIG_VCF_RESONANCE_CTRL_EXTRACT(x)       ((x >> 4) & 0x03)
44    #define GIG_VCF_RESONANCE_CTRL_ENCODE(x)        ((x & 0x03) << 4)
45    #define GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(x)  ((x >> 1) & 0x03)
46    #define GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(x)   ((x >> 3) & 0x03)
47    #define GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(x) ((x >> 5) & 0x03)
48    #define GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(x)   ((x & 0x03) << 1)
49    #define GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(x)    ((x & 0x03) << 3)
50    #define GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(x)  ((x & 0x03) << 5)
51    
52    namespace gig {
53    
54  // *************** Internal functions for sample decopmression ***************  // *************** progress_t ***************
55  // *  // *
56    
57        progress_t::progress_t() {
58            callback    = NULL;
59            custom      = NULL;
60            __range_min = 0.0f;
61            __range_max = 1.0f;
62        }
63    
64        // private helper function to convert progress of a subprocess into the global progress
65        static void __notify_progress(progress_t* pProgress, float subprogress) {
66            if (pProgress && pProgress->callback) {
67                const float totalrange    = pProgress->__range_max - pProgress->__range_min;
68                const float totalprogress = pProgress->__range_min + subprogress * totalrange;
69                pProgress->factor         = totalprogress;
70                pProgress->callback(pProgress); // now actually notify about the progress
71            }
72        }
73    
74        // private helper function to divide a progress into subprogresses
75        static void __divide_progress(progress_t* pParentProgress, progress_t* pSubProgress, float totalTasks, float currentTask) {
76            if (pParentProgress && pParentProgress->callback) {
77                const float totalrange    = pParentProgress->__range_max - pParentProgress->__range_min;
78                pSubProgress->callback    = pParentProgress->callback;
79                pSubProgress->custom      = pParentProgress->custom;
80                pSubProgress->__range_min = pParentProgress->__range_min + totalrange * currentTask / totalTasks;
81                pSubProgress->__range_max = pSubProgress->__range_min + totalrange / totalTasks;
82            }
83        }
84    
85    
86    // *************** Internal functions for sample decompression ***************
87    // *
88    
89    namespace {
90    
91      inline int get12lo(const unsigned char* pSrc)      inline int get12lo(const unsigned char* pSrc)
92      {      {
93          const int x = pSrc[0] | (pSrc[1] & 0x0f) << 8;          const int x = pSrc[0] | (pSrc[1] & 0x0f) << 8;
# Line 53  namespace gig { namespace { Line 111  namespace gig { namespace {
111          return x & 0x800000 ? x - 0x1000000 : x;          return x & 0x800000 ? x - 0x1000000 : x;
112      }      }
113    
114        inline void store24(unsigned char* pDst, int x)
115        {
116            pDst[0] = x;
117            pDst[1] = x >> 8;
118            pDst[2] = x >> 16;
119        }
120    
121      void Decompress16(int compressionmode, const unsigned char* params,      void Decompress16(int compressionmode, const unsigned char* params,
122                        int srcStep, int dstStep,                        int srcStep, int dstStep,
123                        const unsigned char* pSrc, int16_t* pDst,                        const unsigned char* pSrc, int16_t* pDst,
# Line 92  namespace gig { namespace { Line 157  namespace gig { namespace {
157      }      }
158    
159      void Decompress24(int compressionmode, const unsigned char* params,      void Decompress24(int compressionmode, const unsigned char* params,
160                        int dstStep, const unsigned char* pSrc, int16_t* pDst,                        int dstStep, const unsigned char* pSrc, uint8_t* pDst,
161                        unsigned long currentframeoffset,                        unsigned long currentframeoffset,
162                        unsigned long copysamples)                        unsigned long copysamples, int truncatedBits)
163      {      {
164          // Note: The 24 bits are truncated to 16 bits for now.          int y, dy, ddy, dddy;
165    
166          // Note: The calculation of the initial value of y is strange  #define GET_PARAMS(params)                      \
167          // and not 100% correct. What should the first two parameters          y    = get24(params);                   \
168          // really be used for? Why are they two? The correct value for          dy   = y - get24((params) + 3);         \
169          // y seems to lie somewhere between the values of the first          ddy  = get24((params) + 6);             \
170          // two parameters.          dddy = get24((params) + 9)
         //  
         // Strange thing #2: The formula in SKIP_ONE gives values for  
         // y that are twice as high as they should be. That's why  
         // COPY_ONE shifts 9 steps instead of 8, and also why y is  
         // initialized with a sum instead of a mean value.  
   
         int y, dy, ddy;  
   
 #define GET_PARAMS(params)                              \  
         y = (get24(params) + get24((params) + 3));      \  
         dy  = get24((params) + 6);                      \  
         ddy = get24((params) + 9)  
171    
172  #define SKIP_ONE(x)                             \  #define SKIP_ONE(x)                             \
173          ddy -= (x);                             \          dddy -= (x);                            \
174          dy -= ddy;                              \          ddy  -= dddy;                           \
175          y -= dy          dy   =  -dy - ddy;                      \
176            y    += dy
177    
178  #define COPY_ONE(x)                             \  #define COPY_ONE(x)                             \
179          SKIP_ONE(x);                            \          SKIP_ONE(x);                            \
180          *pDst = y >> 9;                         \          store24(pDst, y << truncatedBits);      \
181          pDst += dstStep          pDst += dstStep
182    
183          switch (compressionmode) {          switch (compressionmode) {
184              case 2: // 24 bit uncompressed              case 2: // 24 bit uncompressed
185                  pSrc += currentframeoffset * 3;                  pSrc += currentframeoffset * 3;
186                  while (copysamples) {                  while (copysamples) {
187                      *pDst = get24(pSrc) >> 8;                      store24(pDst, get24(pSrc) << truncatedBits);
188                      pDst += dstStep;                      pDst += dstStep;
189                      pSrc += 3;                      pSrc += 3;
190                      copysamples--;                      copysamples--;
# Line 206  namespace gig { namespace { Line 260  namespace gig { namespace {
260      unsigned int Sample::Instances = 0;      unsigned int Sample::Instances = 0;
261      buffer_t     Sample::InternalDecompressionBuffer;      buffer_t     Sample::InternalDecompressionBuffer;
262    
263      Sample::Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {      /** @brief Constructor.
264         *
265         * Load an existing sample or create a new one. A 'wave' list chunk must
266         * be given to this constructor. In case the given 'wave' list chunk
267         * contains a 'fmt', 'data' (and optionally a '3gix', 'smpl') chunk, the
268         * format and sample data will be loaded from there, otherwise default
269         * values will be used and those chunks will be created when
270         * File::Save() will be called later on.
271         *
272         * @param pFile          - pointer to gig::File where this sample is
273         *                         located (or will be located)
274         * @param waveList       - pointer to 'wave' list chunk which is (or
275         *                         will be) associated with this sample
276         * @param WavePoolOffset - offset of this sample data from wave pool
277         *                         ('wvpl') list chunk
278         * @param fileNo         - number of an extension file where this sample
279         *                         is located, 0 otherwise
280         */
281        Sample::Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {
282            pInfo->UseFixedLengthStrings = true;
283          Instances++;          Instances++;
284            FileNo = fileNo;
285    
286          RIFF::Chunk* _3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);          pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);
287          if (!_3gix) throw gig::Exception("Mandatory chunks in <wave> list chunk not found.");          if (pCk3gix) {
288          SampleGroup = _3gix->ReadInt16();              uint16_t iSampleGroup = pCk3gix->ReadInt16();
289                // caution: sample groups in .gig files are indexed (1..n) whereas Groups in libgig (0..n-1)
290          RIFF::Chunk* smpl = waveList->GetSubChunk(CHUNK_ID_SMPL);              pGroup = pFile->GetGroup(iSampleGroup - 1);
291          if (!smpl) throw gig::Exception("Mandatory chunks in <wave> list chunk not found.");          } else { // '3gix' chunk missing
292          Manufacturer      = smpl->ReadInt32();              // not assigned to a group by default
293          Product           = smpl->ReadInt32();              pGroup = NULL;
294          SamplePeriod      = smpl->ReadInt32();          }
295          MIDIUnityNote     = smpl->ReadInt32();  
296          FineTune          = smpl->ReadInt32();          pCkSmpl = waveList->GetSubChunk(CHUNK_ID_SMPL);
297          smpl->Read(&SMPTEFormat, 1, 4);          if (pCkSmpl) {
298          SMPTEOffset       = smpl->ReadInt32();              Manufacturer  = pCkSmpl->ReadInt32();
299          Loops             = smpl->ReadInt32();              Product       = pCkSmpl->ReadInt32();
300          smpl->ReadInt32(); // manufByt              SamplePeriod  = pCkSmpl->ReadInt32();
301          LoopID            = smpl->ReadInt32();              MIDIUnityNote = pCkSmpl->ReadInt32();
302          smpl->Read(&LoopType, 1, 4);              FineTune      = pCkSmpl->ReadInt32();
303          LoopStart         = smpl->ReadInt32();              pCkSmpl->Read(&SMPTEFormat, 1, 4);
304          LoopEnd           = smpl->ReadInt32();              SMPTEOffset   = pCkSmpl->ReadInt32();
305          LoopFraction      = smpl->ReadInt32();              Loops         = pCkSmpl->ReadInt32();
306          LoopPlayCount     = smpl->ReadInt32();              pCkSmpl->ReadInt32(); // manufByt
307                LoopID        = pCkSmpl->ReadInt32();
308                pCkSmpl->Read(&LoopType, 1, 4);
309                LoopStart     = pCkSmpl->ReadInt32();
310                LoopEnd       = pCkSmpl->ReadInt32();
311                LoopFraction  = pCkSmpl->ReadInt32();
312                LoopPlayCount = pCkSmpl->ReadInt32();
313            } else { // 'smpl' chunk missing
314                // use default values
315                Manufacturer  = 0;
316                Product       = 0;
317                SamplePeriod  = uint32_t(1000000000.0 / SamplesPerSecond + 0.5);
318                MIDIUnityNote = 64;
319                FineTune      = 0;
320                SMPTEOffset   = 0;
321                Loops         = 0;
322                LoopID        = 0;
323                LoopStart     = 0;
324                LoopEnd       = 0;
325                LoopFraction  = 0;
326                LoopPlayCount = 0;
327            }
328    
329          FrameTable                 = NULL;          FrameTable                 = NULL;
330          SamplePos                  = 0;          SamplePos                  = 0;
# Line 239  namespace gig { namespace { Line 334  namespace gig { namespace {
334    
335          if (BitDepth > 24) throw gig::Exception("Only samples up to 24 bit supported");          if (BitDepth > 24) throw gig::Exception("Only samples up to 24 bit supported");
336    
337          Compressed = (waveList->GetSubChunk(CHUNK_ID_EWAV));          RIFF::Chunk* ewav = waveList->GetSubChunk(CHUNK_ID_EWAV);
338            Compressed        = ewav;
339            Dithered          = false;
340            TruncatedBits     = 0;
341          if (Compressed) {          if (Compressed) {
342                uint32_t version = ewav->ReadInt32();
343                if (version == 3 && BitDepth == 24) {
344                    Dithered = ewav->ReadInt32();
345                    ewav->SetPos(Channels == 2 ? 84 : 64);
346                    TruncatedBits = ewav->ReadInt32();
347                }
348              ScanCompressedSample();              ScanCompressedSample();
349          }          }
350    
# Line 249  namespace gig { namespace { Line 353  namespace gig { namespace {
353              InternalDecompressionBuffer.pStart = new unsigned char[INITIAL_SAMPLE_BUFFER_SIZE];              InternalDecompressionBuffer.pStart = new unsigned char[INITIAL_SAMPLE_BUFFER_SIZE];
354              InternalDecompressionBuffer.Size   = INITIAL_SAMPLE_BUFFER_SIZE;              InternalDecompressionBuffer.Size   = INITIAL_SAMPLE_BUFFER_SIZE;
355          }          }
356          FrameOffset = 0; // just for streaming compressed samples          FrameOffset = 0; // just for streaming compressed samples
357    
358          LoopSize = LoopEnd - LoopStart;          LoopSize = LoopEnd - LoopStart + 1;
359        }
360    
361        /**
362         * Apply sample and its settings to the respective RIFF chunks. You have
363         * to call File::Save() to make changes persistent.
364         *
365         * Usually there is absolutely no need to call this method explicitly.
366         * It will be called automatically when File::Save() was called.
367         *
368         * @throws DLS::Exception if FormatTag != WAVE_FORMAT_PCM or no sample data
369         *                        was provided yet
370         * @throws gig::Exception if there is any invalid sample setting
371         */
372        void Sample::UpdateChunks() {
373            // first update base class's chunks
374            DLS::Sample::UpdateChunks();
375    
376            // make sure 'smpl' chunk exists
377            pCkSmpl = pWaveList->GetSubChunk(CHUNK_ID_SMPL);
378            if (!pCkSmpl) pCkSmpl = pWaveList->AddSubChunk(CHUNK_ID_SMPL, 60);
379            // update 'smpl' chunk
380            uint8_t* pData = (uint8_t*) pCkSmpl->LoadChunkData();
381            SamplePeriod = uint32_t(1000000000.0 / SamplesPerSecond + 0.5);
382            memcpy(&pData[0], &Manufacturer, 4);
383            memcpy(&pData[4], &Product, 4);
384            memcpy(&pData[8], &SamplePeriod, 4);
385            memcpy(&pData[12], &MIDIUnityNote, 4);
386            memcpy(&pData[16], &FineTune, 4);
387            memcpy(&pData[20], &SMPTEFormat, 4);
388            memcpy(&pData[24], &SMPTEOffset, 4);
389            memcpy(&pData[28], &Loops, 4);
390    
391            // we skip 'manufByt' for now (4 bytes)
392    
393            memcpy(&pData[36], &LoopID, 4);
394            memcpy(&pData[40], &LoopType, 4);
395            memcpy(&pData[44], &LoopStart, 4);
396            memcpy(&pData[48], &LoopEnd, 4);
397            memcpy(&pData[52], &LoopFraction, 4);
398            memcpy(&pData[56], &LoopPlayCount, 4);
399    
400            // make sure '3gix' chunk exists
401            pCk3gix = pWaveList->GetSubChunk(CHUNK_ID_3GIX);
402            if (!pCk3gix) pCk3gix = pWaveList->AddSubChunk(CHUNK_ID_3GIX, 4);
403            // determine appropriate sample group index (to be stored in chunk)
404            uint16_t iSampleGroup = 0; // no sample group by default
405            File* pFile = static_cast<File*>(pParent);
406            if (pFile->pGroups) {
407                std::list<Group*>::iterator iter = pFile->pGroups->begin();
408                std::list<Group*>::iterator end  = pFile->pGroups->end();
409                // caution: sample groups in .gig files are indexed (1..n) whereas Groups in libgig (0..n-1)
410                for (int i = 1; iter != end; i++, iter++) {
411                    if (*iter == pGroup) {
412                        iSampleGroup = i;
413                        break; // found
414                    }
415                }
416            }
417            // update '3gix' chunk
418            pData = (uint8_t*) pCk3gix->LoadChunkData();
419            memcpy(&pData[0], &iSampleGroup, 2);
420      }      }
421    
422      /// Scans compressed samples for mandatory informations (e.g. actual number of total sample points).      /// Scans compressed samples for mandatory informations (e.g. actual number of total sample points).
# Line 454  namespace gig { namespace { Line 619  namespace gig { namespace {
619          RAMCache.Size   = 0;          RAMCache.Size   = 0;
620      }      }
621    
622        /** @brief Resize sample.
623         *
624         * Resizes the sample's wave form data, that is the actual size of
625         * sample wave data possible to be written for this sample. This call
626         * will return immediately and just schedule the resize operation. You
627         * should call File::Save() to actually perform the resize operation(s)
628         * "physically" to the file. As this can take a while on large files, it
629         * is recommended to call Resize() first on all samples which have to be
630         * resized and finally to call File::Save() to perform all those resize
631         * operations in one rush.
632         *
633         * The actual size (in bytes) is dependant to the current FrameSize
634         * value. You may want to set FrameSize before calling Resize().
635         *
636         * <b>Caution:</b> You cannot directly write (i.e. with Write()) to
637         * enlarged samples before calling File::Save() as this might exceed the
638         * current sample's boundary!
639         *
640         * Also note: only WAVE_FORMAT_PCM is currently supported, that is
641         * FormatTag must be WAVE_FORMAT_PCM. Trying to resize samples with
642         * other formats will fail!
643         *
644         * @param iNewSize - new sample wave data size in sample points (must be
645         *                   greater than zero)
646         * @throws DLS::Excecption if FormatTag != WAVE_FORMAT_PCM
647         *                         or if \a iNewSize is less than 1
648         * @throws gig::Exception if existing sample is compressed
649         * @see DLS::Sample::GetSize(), DLS::Sample::FrameSize,
650         *      DLS::Sample::FormatTag, File::Save()
651         */
652        void Sample::Resize(int iNewSize) {
653            if (Compressed) throw gig::Exception("There is no support for modifying compressed samples (yet)");
654            DLS::Sample::Resize(iNewSize);
655        }
656    
657      /**      /**
658       * Sets the position within the sample (in sample points, not in       * Sets the position within the sample (in sample points, not in
659       * bytes). Use this method and <i>Read()</i> if you don't want to load       * bytes). Use this method and <i>Read()</i> if you don't want to load
# Line 543  namespace gig { namespace { Line 743  namespace gig { namespace {
743       * @param SampleCount      number of sample points to read       * @param SampleCount      number of sample points to read
744       * @param pPlaybackState   will be used to store and reload the playback       * @param pPlaybackState   will be used to store and reload the playback
745       *                         state for the next ReadAndLoop() call       *                         state for the next ReadAndLoop() call
746         * @param pDimRgn          dimension region with looping information
747       * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression       * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression
748       * @returns                number of successfully read sample points       * @returns                number of successfully read sample points
749       * @see                    CreateDecompressionBuffer()       * @see                    CreateDecompressionBuffer()
750       */       */
751      unsigned long Sample::ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState, buffer_t* pExternalDecompressionBuffer) {      unsigned long Sample::ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState,
752                                          DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer) {
753          unsigned long samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;          unsigned long samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;
754          uint8_t* pDst = (uint8_t*) pBuffer;          uint8_t* pDst = (uint8_t*) pBuffer;
755    
756          SetPos(pPlaybackState->position); // recover position from the last time          SetPos(pPlaybackState->position); // recover position from the last time
757    
758          if (this->Loops && GetPos() <= this->LoopEnd) { // honor looping if there are loop points defined          if (pDimRgn->SampleLoops) { // honor looping if there are loop points defined
759    
760              switch (this->LoopType) {              const DLS::sample_loop_t& loop = pDimRgn->pSampleLoops[0];
761                const uint32_t loopEnd = loop.LoopStart + loop.LoopLength;
762    
763                  case loop_type_bidirectional: { //TODO: not tested yet!              if (GetPos() <= loopEnd) {
764                      do {                  switch (loop.LoopType) {
                         // if not endless loop check if max. number of loop cycles have been passed  
                         if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;  
   
                         if (!pPlaybackState->reverse) { // forward playback  
                             do {  
                                 samplestoloopend  = this->LoopEnd - GetPos();  
                                 readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);  
                                 samplestoread    -= readsamples;  
                                 totalreadsamples += readsamples;  
                                 if (readsamples == samplestoloopend) {  
                                     pPlaybackState->reverse = true;  
                                     break;  
                                 }  
                             } while (samplestoread && readsamples);  
                         }  
                         else { // backward playback  
765    
766                              // as we can only read forward from disk, we have to                      case loop_type_bidirectional: { //TODO: not tested yet!
767                              // determine the end position within the loop first,                          do {
768                              // read forward from that 'end' and finally after                              // if not endless loop check if max. number of loop cycles have been passed
769                              // reading, swap all sample frames so it reflects                              if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
770                              // backward playback  
771                                if (!pPlaybackState->reverse) { // forward playback
772                              unsigned long swapareastart       = totalreadsamples;                                  do {
773                              unsigned long loopoffset          = GetPos() - this->LoopStart;                                      samplestoloopend  = loopEnd - GetPos();
774                              unsigned long samplestoreadinloop = Min(samplestoread, loopoffset);                                      readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
775                              unsigned long reverseplaybackend  = GetPos() - samplestoreadinloop;                                      samplestoread    -= readsamples;
776                                        totalreadsamples += readsamples;
777                              SetPos(reverseplaybackend);                                      if (readsamples == samplestoloopend) {
778                                            pPlaybackState->reverse = true;
779                              // read samples for backward playback                                          break;
780                              do {                                      }
781                                  readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], samplestoreadinloop, pExternalDecompressionBuffer);                                  } while (samplestoread && readsamples);
782                                  samplestoreadinloop -= readsamples;                              }
783                                  samplestoread       -= readsamples;                              else { // backward playback
                                 totalreadsamples    += readsamples;  
                             } while (samplestoreadinloop && readsamples);  
784    
785                              SetPos(reverseplaybackend); // pretend we really read backwards                                  // as we can only read forward from disk, we have to
786                                    // determine the end position within the loop first,
787                                    // read forward from that 'end' and finally after
788                                    // reading, swap all sample frames so it reflects
789                                    // backward playback
790    
791                                    unsigned long swapareastart       = totalreadsamples;
792                                    unsigned long loopoffset          = GetPos() - loop.LoopStart;
793                                    unsigned long samplestoreadinloop = Min(samplestoread, loopoffset);
794                                    unsigned long reverseplaybackend  = GetPos() - samplestoreadinloop;
795    
796                                    SetPos(reverseplaybackend);
797    
798                                    // read samples for backward playback
799                                    do {
800                                        readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], samplestoreadinloop, pExternalDecompressionBuffer);
801                                        samplestoreadinloop -= readsamples;
802                                        samplestoread       -= readsamples;
803                                        totalreadsamples    += readsamples;
804                                    } while (samplestoreadinloop && readsamples);
805    
806                                    SetPos(reverseplaybackend); // pretend we really read backwards
807    
808                                    if (reverseplaybackend == loop.LoopStart) {
809                                        pPlaybackState->loop_cycles_left--;
810                                        pPlaybackState->reverse = false;
811                                    }
812    
813                              if (reverseplaybackend == this->LoopStart) {                                  // reverse the sample frames for backward playback
814                                  pPlaybackState->loop_cycles_left--;                                  SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
                                 pPlaybackState->reverse = false;  
815                              }                              }
816                            } while (samplestoread && readsamples);
817                            break;
818                        }
819    
820                              // reverse the sample frames for backward playback                      case loop_type_backward: { // TODO: not tested yet!
821                              SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);                          // forward playback (not entered the loop yet)
822                          }                          if (!pPlaybackState->reverse) do {
823                      } while (samplestoread && readsamples);                              samplestoloopend  = loopEnd - GetPos();
824                      break;                              readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
825                  }                              samplestoread    -= readsamples;
826                                totalreadsamples += readsamples;
827                  case loop_type_backward: { // TODO: not tested yet!                              if (readsamples == samplestoloopend) {
828                      // forward playback (not entered the loop yet)                                  pPlaybackState->reverse = true;
829                      if (!pPlaybackState->reverse) do {                                  break;
830                          samplestoloopend  = this->LoopEnd - GetPos();                              }
831                          readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);                          } while (samplestoread && readsamples);
                         samplestoread    -= readsamples;  
                         totalreadsamples += readsamples;  
                         if (readsamples == samplestoloopend) {  
                             pPlaybackState->reverse = true;  
                             break;  
                         }  
                     } while (samplestoread && readsamples);  
832    
833                      if (!samplestoread) break;                          if (!samplestoread) break;
834    
835                      // as we can only read forward from disk, we have to                          // as we can only read forward from disk, we have to
836                      // determine the end position within the loop first,                          // determine the end position within the loop first,
837                      // read forward from that 'end' and finally after                          // read forward from that 'end' and finally after
838                      // reading, swap all sample frames so it reflects                          // reading, swap all sample frames so it reflects
839                      // backward playback                          // backward playback
840    
841                      unsigned long swapareastart       = totalreadsamples;                          unsigned long swapareastart       = totalreadsamples;
842                      unsigned long loopoffset          = GetPos() - this->LoopStart;                          unsigned long loopoffset          = GetPos() - loop.LoopStart;
843                      unsigned long samplestoreadinloop = (this->LoopPlayCount) ? Min(samplestoread, pPlaybackState->loop_cycles_left * LoopSize - loopoffset)                          unsigned long samplestoreadinloop = (this->LoopPlayCount) ? Min(samplestoread, pPlaybackState->loop_cycles_left * loop.LoopLength - loopoffset)
844                                                                                : samplestoread;                                                                                    : samplestoread;
845                      unsigned long reverseplaybackend  = this->LoopStart + Abs((loopoffset - samplestoreadinloop) % this->LoopSize);                          unsigned long reverseplaybackend  = loop.LoopStart + Abs((loopoffset - samplestoreadinloop) % loop.LoopLength);
846    
847                      SetPos(reverseplaybackend);                          SetPos(reverseplaybackend);
848    
849                      // read samples for backward playback                          // read samples for backward playback
850                      do {                          do {
851                          // if not endless loop check if max. number of loop cycles have been passed                              // if not endless loop check if max. number of loop cycles have been passed
852                          if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;                              if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
853                          samplestoloopend     = this->LoopEnd - GetPos();                              samplestoloopend     = loopEnd - GetPos();
854                          readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoreadinloop, samplestoloopend), pExternalDecompressionBuffer);                              readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoreadinloop, samplestoloopend), pExternalDecompressionBuffer);
855                          samplestoreadinloop -= readsamples;                              samplestoreadinloop -= readsamples;
856                          samplestoread       -= readsamples;                              samplestoread       -= readsamples;
857                          totalreadsamples    += readsamples;                              totalreadsamples    += readsamples;
858                          if (readsamples == samplestoloopend) {                              if (readsamples == samplestoloopend) {
859                              pPlaybackState->loop_cycles_left--;                                  pPlaybackState->loop_cycles_left--;
860                              SetPos(this->LoopStart);                                  SetPos(loop.LoopStart);
861                          }                              }
862                      } while (samplestoreadinloop && readsamples);                          } while (samplestoreadinloop && readsamples);
863    
864                      SetPos(reverseplaybackend); // pretend we really read backwards                          SetPos(reverseplaybackend); // pretend we really read backwards
865    
866                      // reverse the sample frames for backward playback                          // reverse the sample frames for backward playback
867                      SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);                          SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
868                      break;                          break;
869                  }                      }
870    
871                  default: case loop_type_normal: {                      default: case loop_type_normal: {
872                      do {                          do {
873                          // if not endless loop check if max. number of loop cycles have been passed                              // if not endless loop check if max. number of loop cycles have been passed
874                          if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;                              if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
875                          samplestoloopend  = this->LoopEnd - GetPos();                              samplestoloopend  = loopEnd - GetPos();
876                          readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);                              readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
877                          samplestoread    -= readsamples;                              samplestoread    -= readsamples;
878                          totalreadsamples += readsamples;                              totalreadsamples += readsamples;
879                          if (readsamples == samplestoloopend) {                              if (readsamples == samplestoloopend) {
880                              pPlaybackState->loop_cycles_left--;                                  pPlaybackState->loop_cycles_left--;
881                              SetPos(this->LoopStart);                                  SetPos(loop.LoopStart);
882                          }                              }
883                      } while (samplestoread && readsamples);                          } while (samplestoread && readsamples);
884                      break;                          break;
885                        }
886                  }                  }
887              }              }
888          }          }
# Line 705  namespace gig { namespace { Line 912  namespace gig { namespace {
912       * have to use an external decompression buffer for <b>EACH</b>       * have to use an external decompression buffer for <b>EACH</b>
913       * streaming thread to avoid race conditions and crashes!       * streaming thread to avoid race conditions and crashes!
914       *       *
915         * For 16 bit samples, the data in the buffer will be int16_t
916         * (using native endianness). For 24 bit, the buffer will
917         * contain three bytes per sample, little-endian.
918         *
919       * @param pBuffer      destination buffer       * @param pBuffer      destination buffer
920       * @param SampleCount  number of sample points to read       * @param SampleCount  number of sample points to read
921       * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression       * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression
# Line 715  namespace gig { namespace { Line 926  namespace gig { namespace {
926          if (SampleCount == 0) return 0;          if (SampleCount == 0) return 0;
927          if (!Compressed) {          if (!Compressed) {
928              if (BitDepth == 24) {              if (BitDepth == 24) {
929                  // 24 bit sample. For now just truncate to 16 bit.                  return pCkData->Read(pBuffer, SampleCount * FrameSize, 1) / FrameSize;
                 unsigned char* pSrc = (unsigned char*) ((pExternalDecompressionBuffer) ? pExternalDecompressionBuffer->pStart : this->InternalDecompressionBuffer.pStart);  
                 int16_t* pDst = static_cast<int16_t*>(pBuffer);  
                 if (Channels == 2) { // Stereo  
                     unsigned long readBytes = pCkData->Read(pSrc, SampleCount * 6, 1);  
                     pSrc++;  
                     for (unsigned long i = readBytes ; i > 0 ; i -= 3) {  
                         *pDst++ = get16(pSrc);  
                         pSrc += 3;  
                     }  
                     return (pDst - static_cast<int16_t*>(pBuffer)) >> 1;  
                 }  
                 else { // Mono  
                     unsigned long readBytes = pCkData->Read(pSrc, SampleCount * 3, 1);  
                     pSrc++;  
                     for (unsigned long i = readBytes ; i > 0 ; i -= 3) {  
                         *pDst++ = get16(pSrc);  
                         pSrc += 3;  
                     }  
                     return pDst - static_cast<int16_t*>(pBuffer);  
                 }  
930              }              }
931              else { // 16 bit              else { // 16 bit
932                  // (pCkData->Read does endian correction)                  // (pCkData->Read does endian correction)
# Line 765  namespace gig { namespace { Line 956  namespace gig { namespace {
956    
957              unsigned char* pSrc = (unsigned char*) pDecompressionBuffer->pStart;              unsigned char* pSrc = (unsigned char*) pDecompressionBuffer->pStart;
958              int16_t* pDst = static_cast<int16_t*>(pBuffer);              int16_t* pDst = static_cast<int16_t*>(pBuffer);
959                uint8_t* pDst24 = static_cast<uint8_t*>(pBuffer);
960              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);
961    
962              while (remainingsamples && remainingbytes) {              while (remainingsamples && remainingbytes) {
# Line 846  namespace gig { namespace { Line 1038  namespace gig { namespace {
1038                              const unsigned char* const param_r = pSrc;                              const unsigned char* const param_r = pSrc;
1039                              if (mode_r != 2) pSrc += 12;                              if (mode_r != 2) pSrc += 12;
1040    
1041                              Decompress24(mode_l, param_l, 2, pSrc, pDst, skipsamples, copysamples);                              Decompress24(mode_l, param_l, 6, pSrc, pDst24,
1042                              Decompress24(mode_r, param_r, 2, pSrc + rightChannelOffset, pDst + 1,                                           skipsamples, copysamples, TruncatedBits);
1043                                           skipsamples, copysamples);                              Decompress24(mode_r, param_r, 6, pSrc + rightChannelOffset, pDst24 + 3,
1044                              pDst += copysamples << 1;                                           skipsamples, copysamples, TruncatedBits);
1045                                pDst24 += copysamples * 6;
1046                          }                          }
1047                          else { // Mono                          else { // Mono
1048                              Decompress24(mode_l, param_l, 1, pSrc, pDst, skipsamples, copysamples);                              Decompress24(mode_l, param_l, 3, pSrc, pDst24,
1049                              pDst += copysamples;                                           skipsamples, copysamples, TruncatedBits);
1050                                pDst24 += copysamples * 3;
1051                          }                          }
1052                      }                      }
1053                      else { // 16 bit                      else { // 16 bit
# Line 895  namespace gig { namespace { Line 1089  namespace gig { namespace {
1089          }          }
1090      }      }
1091    
1092        /** @brief Write sample wave data.
1093         *
1094         * Writes \a SampleCount number of sample points from the buffer pointed
1095         * by \a pBuffer and increments the position within the sample. Use this
1096         * method to directly write the sample data to disk, i.e. if you don't
1097         * want or cannot load the whole sample data into RAM.
1098         *
1099         * You have to Resize() the sample to the desired size and call
1100         * File::Save() <b>before</b> using Write().
1101         *
1102         * Note: there is currently no support for writing compressed samples.
1103         *
1104         * @param pBuffer     - source buffer
1105         * @param SampleCount - number of sample points to write
1106         * @throws DLS::Exception if current sample size is too small
1107         * @throws gig::Exception if sample is compressed
1108         * @see DLS::LoadSampleData()
1109         */
1110        unsigned long Sample::Write(void* pBuffer, unsigned long SampleCount) {
1111            if (Compressed) throw gig::Exception("There is no support for writing compressed gig samples (yet)");
1112            return DLS::Sample::Write(pBuffer, SampleCount);
1113        }
1114    
1115      /**      /**
1116       * Allocates a decompression buffer for streaming (compressed) samples       * Allocates a decompression buffer for streaming (compressed) samples
1117       * with Sample::Read(). If you are using more than one streaming thread       * with Sample::Read(). If you are using more than one streaming thread
# Line 959  namespace gig { namespace { Line 1176  namespace gig { namespace {
1176      DimensionRegion::DimensionRegion(RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {      DimensionRegion::DimensionRegion(RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {
1177          Instances++;          Instances++;
1178    
1179            pSample = NULL;
1180    
1181          memcpy(&Crossfade, &SamplerOptions, 4);          memcpy(&Crossfade, &SamplerOptions, 4);
1182          if (!pVelocityTables) pVelocityTables = new VelocityTableMap;          if (!pVelocityTables) pVelocityTables = new VelocityTableMap;
1183    
1184          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);
1185          _3ewa->ReadInt32(); // unknown, always 0x0000008C ?          if (_3ewa) { // if '3ewa' chunk exists
1186          LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              _3ewa->ReadInt32(); // unknown, always == chunk size ?
1187          EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1188          _3ewa->ReadInt16(); // unknown              EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1189          LFO1InternalDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1190          _3ewa->ReadInt16(); // unknown              LFO1InternalDepth = _3ewa->ReadUint16();
1191          LFO3InternalDepth = _3ewa->ReadInt16();              _3ewa->ReadInt16(); // unknown
1192          _3ewa->ReadInt16(); // unknown              LFO3InternalDepth = _3ewa->ReadInt16();
1193          LFO1ControlDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1194          _3ewa->ReadInt16(); // unknown              LFO1ControlDepth = _3ewa->ReadUint16();
1195          LFO3ControlDepth = _3ewa->ReadInt16();              _3ewa->ReadInt16(); // unknown
1196          EG1Attack           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO3ControlDepth = _3ewa->ReadInt16();
1197          EG1Decay1           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG1Attack           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1198          _3ewa->ReadInt16(); // unknown              EG1Decay1           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1199          EG1Sustain          = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1200          EG1Release          = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG1Sustain          = _3ewa->ReadUint16();
1201          EG1Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));              EG1Release          = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1202          uint8_t eg1ctrloptions        = _3ewa->ReadUint8();              EG1Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1203          EG1ControllerInvert           = eg1ctrloptions & 0x01;              uint8_t eg1ctrloptions        = _3ewa->ReadUint8();
1204          EG1ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg1ctrloptions);              EG1ControllerInvert           = eg1ctrloptions & 0x01;
1205          EG1ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg1ctrloptions);              EG1ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg1ctrloptions);
1206          EG1ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg1ctrloptions);              EG1ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg1ctrloptions);
1207          EG2Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));              EG1ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg1ctrloptions);
1208          uint8_t eg2ctrloptions        = _3ewa->ReadUint8();              EG2Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1209          EG2ControllerInvert           = eg2ctrloptions & 0x01;              uint8_t eg2ctrloptions        = _3ewa->ReadUint8();
1210          EG2ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg2ctrloptions);              EG2ControllerInvert           = eg2ctrloptions & 0x01;
1211          EG2ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg2ctrloptions);              EG2ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg2ctrloptions);
1212          EG2ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg2ctrloptions);              EG2ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg2ctrloptions);
1213          LFO1Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG2ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg2ctrloptions);
1214          EG2Attack        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO1Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1215          EG2Decay1        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG2Attack        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1216          _3ewa->ReadInt16(); // unknown              EG2Decay1        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1217          EG2Sustain       = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1218          EG2Release       = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG2Sustain       = _3ewa->ReadUint16();
1219          _3ewa->ReadInt16(); // unknown              EG2Release       = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1220          LFO2ControlDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1221          LFO2Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO2ControlDepth = _3ewa->ReadUint16();
1222          _3ewa->ReadInt16(); // unknown              LFO2Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1223          LFO2InternalDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1224          int32_t eg1decay2 = _3ewa->ReadInt32();              LFO2InternalDepth = _3ewa->ReadUint16();
1225          EG1Decay2          = (double) GIG_EXP_DECODE(eg1decay2);              int32_t eg1decay2 = _3ewa->ReadInt32();
1226          EG1InfiniteSustain = (eg1decay2 == 0x7fffffff);              EG1Decay2          = (double) GIG_EXP_DECODE(eg1decay2);
1227          _3ewa->ReadInt16(); // unknown              EG1InfiniteSustain = (eg1decay2 == 0x7fffffff);
1228          EG1PreAttack      = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1229          int32_t eg2decay2 = _3ewa->ReadInt32();              EG1PreAttack      = _3ewa->ReadUint16();
1230          EG2Decay2         = (double) GIG_EXP_DECODE(eg2decay2);              int32_t eg2decay2 = _3ewa->ReadInt32();
1231          EG2InfiniteSustain = (eg2decay2 == 0x7fffffff);              EG2Decay2         = (double) GIG_EXP_DECODE(eg2decay2);
1232          _3ewa->ReadInt16(); // unknown              EG2InfiniteSustain = (eg2decay2 == 0x7fffffff);
1233          EG2PreAttack      = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1234          uint8_t velocityresponse = _3ewa->ReadUint8();              EG2PreAttack      = _3ewa->ReadUint16();
1235          if (velocityresponse < 5) {              uint8_t velocityresponse = _3ewa->ReadUint8();
1236              VelocityResponseCurve = curve_type_nonlinear;              if (velocityresponse < 5) {
1237              VelocityResponseDepth = velocityresponse;                  VelocityResponseCurve = curve_type_nonlinear;
1238          }                  VelocityResponseDepth = velocityresponse;
1239          else if (velocityresponse < 10) {              } else if (velocityresponse < 10) {
1240              VelocityResponseCurve = curve_type_linear;                  VelocityResponseCurve = curve_type_linear;
1241              VelocityResponseDepth = velocityresponse - 5;                  VelocityResponseDepth = velocityresponse - 5;
1242          }              } else if (velocityresponse < 15) {
1243          else if (velocityresponse < 15) {                  VelocityResponseCurve = curve_type_special;
1244              VelocityResponseCurve = curve_type_special;                  VelocityResponseDepth = velocityresponse - 10;
1245              VelocityResponseDepth = velocityresponse - 10;              } else {
1246                    VelocityResponseCurve = curve_type_unknown;
1247                    VelocityResponseDepth = 0;
1248                }
1249                uint8_t releasevelocityresponse = _3ewa->ReadUint8();
1250                if (releasevelocityresponse < 5) {
1251                    ReleaseVelocityResponseCurve = curve_type_nonlinear;
1252                    ReleaseVelocityResponseDepth = releasevelocityresponse;
1253                } else if (releasevelocityresponse < 10) {
1254                    ReleaseVelocityResponseCurve = curve_type_linear;
1255                    ReleaseVelocityResponseDepth = releasevelocityresponse - 5;
1256                } else if (releasevelocityresponse < 15) {
1257                    ReleaseVelocityResponseCurve = curve_type_special;
1258                    ReleaseVelocityResponseDepth = releasevelocityresponse - 10;
1259                } else {
1260                    ReleaseVelocityResponseCurve = curve_type_unknown;
1261                    ReleaseVelocityResponseDepth = 0;
1262                }
1263                VelocityResponseCurveScaling = _3ewa->ReadUint8();
1264                AttenuationControllerThreshold = _3ewa->ReadInt8();
1265                _3ewa->ReadInt32(); // unknown
1266                SampleStartOffset = (uint16_t) _3ewa->ReadInt16();
1267                _3ewa->ReadInt16(); // unknown
1268                uint8_t pitchTrackDimensionBypass = _3ewa->ReadInt8();
1269                PitchTrack = GIG_PITCH_TRACK_EXTRACT(pitchTrackDimensionBypass);
1270                if      (pitchTrackDimensionBypass & 0x10) DimensionBypass = dim_bypass_ctrl_94;
1271                else if (pitchTrackDimensionBypass & 0x20) DimensionBypass = dim_bypass_ctrl_95;
1272                else                                       DimensionBypass = dim_bypass_ctrl_none;
1273                uint8_t pan = _3ewa->ReadUint8();
1274                Pan         = (pan < 64) ? pan : -((int)pan - 63); // signed 7 bit -> signed 8 bit
1275                SelfMask = _3ewa->ReadInt8() & 0x01;
1276                _3ewa->ReadInt8(); // unknown
1277                uint8_t lfo3ctrl = _3ewa->ReadUint8();
1278                LFO3Controller           = static_cast<lfo3_ctrl_t>(lfo3ctrl & 0x07); // lower 3 bits
1279                LFO3Sync                 = lfo3ctrl & 0x20; // bit 5
1280                InvertAttenuationController = lfo3ctrl & 0x80; // bit 7
1281                AttenuationController  = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1282                uint8_t lfo2ctrl       = _3ewa->ReadUint8();
1283                LFO2Controller         = static_cast<lfo2_ctrl_t>(lfo2ctrl & 0x07); // lower 3 bits
1284                LFO2FlipPhase          = lfo2ctrl & 0x80; // bit 7
1285                LFO2Sync               = lfo2ctrl & 0x20; // bit 5
1286                bool extResonanceCtrl  = lfo2ctrl & 0x40; // bit 6
1287                uint8_t lfo1ctrl       = _3ewa->ReadUint8();
1288                LFO1Controller         = static_cast<lfo1_ctrl_t>(lfo1ctrl & 0x07); // lower 3 bits
1289                LFO1FlipPhase          = lfo1ctrl & 0x80; // bit 7
1290                LFO1Sync               = lfo1ctrl & 0x40; // bit 6
1291                VCFResonanceController = (extResonanceCtrl) ? static_cast<vcf_res_ctrl_t>(GIG_VCF_RESONANCE_CTRL_EXTRACT(lfo1ctrl))
1292                                                            : vcf_res_ctrl_none;
1293                uint16_t eg3depth = _3ewa->ReadUint16();
1294                EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */
1295                                            : (-1) * (int16_t) ((eg3depth ^ 0xffff) + 1); /* binary complementary for negatives */
1296                _3ewa->ReadInt16(); // unknown
1297                ChannelOffset = _3ewa->ReadUint8() / 4;
1298                uint8_t regoptions = _3ewa->ReadUint8();
1299                MSDecode           = regoptions & 0x01; // bit 0
1300                SustainDefeat      = regoptions & 0x02; // bit 1
1301                _3ewa->ReadInt16(); // unknown
1302                VelocityUpperLimit = _3ewa->ReadInt8();
1303                _3ewa->ReadInt8(); // unknown
1304                _3ewa->ReadInt16(); // unknown
1305                ReleaseTriggerDecay = _3ewa->ReadUint8(); // release trigger decay
1306                _3ewa->ReadInt8(); // unknown
1307                _3ewa->ReadInt8(); // unknown
1308                EG1Hold = _3ewa->ReadUint8() & 0x80; // bit 7
1309                uint8_t vcfcutoff = _3ewa->ReadUint8();
1310                VCFEnabled = vcfcutoff & 0x80; // bit 7
1311                VCFCutoff  = vcfcutoff & 0x7f; // lower 7 bits
1312                VCFCutoffController = static_cast<vcf_cutoff_ctrl_t>(_3ewa->ReadUint8());
1313                uint8_t vcfvelscale = _3ewa->ReadUint8();
1314                VCFCutoffControllerInvert = vcfvelscale & 0x80; // bit 7
1315                VCFVelocityScale = vcfvelscale & 0x7f; // lower 7 bits
1316                _3ewa->ReadInt8(); // unknown
1317                uint8_t vcfresonance = _3ewa->ReadUint8();
1318                VCFResonance = vcfresonance & 0x7f; // lower 7 bits
1319                VCFResonanceDynamic = !(vcfresonance & 0x80); // bit 7
1320                uint8_t vcfbreakpoint         = _3ewa->ReadUint8();
1321                VCFKeyboardTracking           = vcfbreakpoint & 0x80; // bit 7
1322                VCFKeyboardTrackingBreakpoint = vcfbreakpoint & 0x7f; // lower 7 bits
1323                uint8_t vcfvelocity = _3ewa->ReadUint8();
1324                VCFVelocityDynamicRange = vcfvelocity % 5;
1325                VCFVelocityCurve        = static_cast<curve_type_t>(vcfvelocity / 5);
1326                VCFType = static_cast<vcf_type_t>(_3ewa->ReadUint8());
1327                if (VCFType == vcf_type_lowpass) {
1328                    if (lfo3ctrl & 0x40) // bit 6
1329                        VCFType = vcf_type_lowpassturbo;
1330                }
1331            } else { // '3ewa' chunk does not exist yet
1332                // use default values
1333                LFO3Frequency                   = 1.0;
1334                EG3Attack                       = 0.0;
1335                LFO1InternalDepth               = 0;
1336                LFO3InternalDepth               = 0;
1337                LFO1ControlDepth                = 0;
1338                LFO3ControlDepth                = 0;
1339                EG1Attack                       = 0.0;
1340                EG1Decay1                       = 0.0;
1341                EG1Sustain                      = 0;
1342                EG1Release                      = 0.0;
1343                EG1Controller.type              = eg1_ctrl_t::type_none;
1344                EG1Controller.controller_number = 0;
1345                EG1ControllerInvert             = false;
1346                EG1ControllerAttackInfluence    = 0;
1347                EG1ControllerDecayInfluence     = 0;
1348                EG1ControllerReleaseInfluence   = 0;
1349                EG2Controller.type              = eg2_ctrl_t::type_none;
1350                EG2Controller.controller_number = 0;
1351                EG2ControllerInvert             = false;
1352                EG2ControllerAttackInfluence    = 0;
1353                EG2ControllerDecayInfluence     = 0;
1354                EG2ControllerReleaseInfluence   = 0;
1355                LFO1Frequency                   = 1.0;
1356                EG2Attack                       = 0.0;
1357                EG2Decay1                       = 0.0;
1358                EG2Sustain                      = 0;
1359                EG2Release                      = 0.0;
1360                LFO2ControlDepth                = 0;
1361                LFO2Frequency                   = 1.0;
1362                LFO2InternalDepth               = 0;
1363                EG1Decay2                       = 0.0;
1364                EG1InfiniteSustain              = false;
1365                EG1PreAttack                    = 1000;
1366                EG2Decay2                       = 0.0;
1367                EG2InfiniteSustain              = false;
1368                EG2PreAttack                    = 1000;
1369                VelocityResponseCurve           = curve_type_nonlinear;
1370                VelocityResponseDepth           = 3;
1371                ReleaseVelocityResponseCurve    = curve_type_nonlinear;
1372                ReleaseVelocityResponseDepth    = 3;
1373                VelocityResponseCurveScaling    = 32;
1374                AttenuationControllerThreshold  = 0;
1375                SampleStartOffset               = 0;
1376                PitchTrack                      = true;
1377                DimensionBypass                 = dim_bypass_ctrl_none;
1378                Pan                             = 0;
1379                SelfMask                        = true;
1380                LFO3Controller                  = lfo3_ctrl_modwheel;
1381                LFO3Sync                        = false;
1382                InvertAttenuationController     = false;
1383                AttenuationController.type      = attenuation_ctrl_t::type_none;
1384                AttenuationController.controller_number = 0;
1385                LFO2Controller                  = lfo2_ctrl_internal;
1386                LFO2FlipPhase                   = false;
1387                LFO2Sync                        = false;
1388                LFO1Controller                  = lfo1_ctrl_internal;
1389                LFO1FlipPhase                   = false;
1390                LFO1Sync                        = false;
1391                VCFResonanceController          = vcf_res_ctrl_none;
1392                EG3Depth                        = 0;
1393                ChannelOffset                   = 0;
1394                MSDecode                        = false;
1395                SustainDefeat                   = false;
1396                VelocityUpperLimit              = 0;
1397                ReleaseTriggerDecay             = 0;
1398                EG1Hold                         = false;
1399                VCFEnabled                      = false;
1400                VCFCutoff                       = 0;
1401                VCFCutoffController             = vcf_cutoff_ctrl_none;
1402                VCFCutoffControllerInvert       = false;
1403                VCFVelocityScale                = 0;
1404                VCFResonance                    = 0;
1405                VCFResonanceDynamic             = false;
1406                VCFKeyboardTracking             = false;
1407                VCFKeyboardTrackingBreakpoint   = 0;
1408                VCFVelocityDynamicRange         = 0x04;
1409                VCFVelocityCurve                = curve_type_linear;
1410                VCFType                         = vcf_type_lowpass;
1411            }
1412    
1413            pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,
1414                                                         VelocityResponseDepth,
1415                                                         VelocityResponseCurveScaling);
1416    
1417            curve_type_t curveType = ReleaseVelocityResponseCurve;
1418            uint8_t depth = ReleaseVelocityResponseDepth;
1419    
1420            // this models a strange behaviour or bug in GSt: two of the
1421            // velocity response curves for release time are not used even
1422            // if specified, instead another curve is chosen.
1423            if ((curveType == curve_type_nonlinear && depth == 0) ||
1424                (curveType == curve_type_special   && depth == 4)) {
1425                curveType = curve_type_nonlinear;
1426                depth = 3;
1427            }
1428            pVelocityReleaseTable = GetVelocityTable(curveType, depth, 0);
1429    
1430            curveType = VCFVelocityCurve;
1431            depth = VCFVelocityDynamicRange;
1432    
1433            // even stranger GSt: two of the velocity response curves for
1434            // filter cutoff are not used, instead another special curve
1435            // is chosen. This curve is not used anywhere else.
1436            if ((curveType == curve_type_nonlinear && depth == 0) ||
1437                (curveType == curve_type_special   && depth == 4)) {
1438                curveType = curve_type_special;
1439                depth = 5;
1440          }          }
1441          else {          pVelocityCutoffTable = GetVelocityTable(curveType, depth,
1442              VelocityResponseCurve = curve_type_unknown;                                                  VCFCutoffController <= vcf_cutoff_ctrl_none2 ? VCFVelocityScale : 0);
1443              VelocityResponseDepth = 0;  
1444            SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));
1445            VelocityTable = 0;
1446        }
1447    
1448        /**
1449         * Apply dimension region settings to the respective RIFF chunks. You
1450         * have to call File::Save() to make changes persistent.
1451         *
1452         * Usually there is absolutely no need to call this method explicitly.
1453         * It will be called automatically when File::Save() was called.
1454         */
1455        void DimensionRegion::UpdateChunks() {
1456            // first update base class's chunk
1457            DLS::Sampler::UpdateChunks();
1458    
1459            // make sure '3ewa' chunk exists
1460            RIFF::Chunk* _3ewa = pParentList->GetSubChunk(CHUNK_ID_3EWA);
1461            if (!_3ewa)  _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, 140);
1462            uint8_t* pData = (uint8_t*) _3ewa->LoadChunkData();
1463    
1464            // update '3ewa' chunk with DimensionRegion's current settings
1465    
1466            const uint32_t unknown = _3ewa->GetSize(); // unknown, always chunk size ?
1467            memcpy(&pData[0], &unknown, 4);
1468    
1469            const int32_t lfo3freq = (int32_t) GIG_EXP_ENCODE(LFO3Frequency);
1470            memcpy(&pData[4], &lfo3freq, 4);
1471    
1472            const int32_t eg3attack = (int32_t) GIG_EXP_ENCODE(EG3Attack);
1473            memcpy(&pData[8], &eg3attack, 4);
1474    
1475            // next 2 bytes unknown
1476    
1477            memcpy(&pData[14], &LFO1InternalDepth, 2);
1478    
1479            // next 2 bytes unknown
1480    
1481            memcpy(&pData[18], &LFO3InternalDepth, 2);
1482    
1483            // next 2 bytes unknown
1484    
1485            memcpy(&pData[22], &LFO1ControlDepth, 2);
1486    
1487            // next 2 bytes unknown
1488    
1489            memcpy(&pData[26], &LFO3ControlDepth, 2);
1490    
1491            const int32_t eg1attack = (int32_t) GIG_EXP_ENCODE(EG1Attack);
1492            memcpy(&pData[28], &eg1attack, 4);
1493    
1494            const int32_t eg1decay1 = (int32_t) GIG_EXP_ENCODE(EG1Decay1);
1495            memcpy(&pData[32], &eg1decay1, 4);
1496    
1497            // next 2 bytes unknown
1498    
1499            memcpy(&pData[38], &EG1Sustain, 2);
1500    
1501            const int32_t eg1release = (int32_t) GIG_EXP_ENCODE(EG1Release);
1502            memcpy(&pData[40], &eg1release, 4);
1503    
1504            const uint8_t eg1ctl = (uint8_t) EncodeLeverageController(EG1Controller);
1505            memcpy(&pData[44], &eg1ctl, 1);
1506    
1507            const uint8_t eg1ctrloptions =
1508                (EG1ControllerInvert) ? 0x01 : 0x00 |
1509                GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG1ControllerAttackInfluence) |
1510                GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG1ControllerDecayInfluence) |
1511                GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG1ControllerReleaseInfluence);
1512            memcpy(&pData[45], &eg1ctrloptions, 1);
1513    
1514            const uint8_t eg2ctl = (uint8_t) EncodeLeverageController(EG2Controller);
1515            memcpy(&pData[46], &eg2ctl, 1);
1516    
1517            const uint8_t eg2ctrloptions =
1518                (EG2ControllerInvert) ? 0x01 : 0x00 |
1519                GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG2ControllerAttackInfluence) |
1520                GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG2ControllerDecayInfluence) |
1521                GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG2ControllerReleaseInfluence);
1522            memcpy(&pData[47], &eg2ctrloptions, 1);
1523    
1524            const int32_t lfo1freq = (int32_t) GIG_EXP_ENCODE(LFO1Frequency);
1525            memcpy(&pData[48], &lfo1freq, 4);
1526    
1527            const int32_t eg2attack = (int32_t) GIG_EXP_ENCODE(EG2Attack);
1528            memcpy(&pData[52], &eg2attack, 4);
1529    
1530            const int32_t eg2decay1 = (int32_t) GIG_EXP_ENCODE(EG2Decay1);
1531            memcpy(&pData[56], &eg2decay1, 4);
1532    
1533            // next 2 bytes unknown
1534    
1535            memcpy(&pData[62], &EG2Sustain, 2);
1536    
1537            const int32_t eg2release = (int32_t) GIG_EXP_ENCODE(EG2Release);
1538            memcpy(&pData[64], &eg2release, 4);
1539    
1540            // next 2 bytes unknown
1541    
1542            memcpy(&pData[70], &LFO2ControlDepth, 2);
1543    
1544            const int32_t lfo2freq = (int32_t) GIG_EXP_ENCODE(LFO2Frequency);
1545            memcpy(&pData[72], &lfo2freq, 4);
1546    
1547            // next 2 bytes unknown
1548    
1549            memcpy(&pData[78], &LFO2InternalDepth, 2);
1550    
1551            const int32_t eg1decay2 = (int32_t) (EG1InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG1Decay2);
1552            memcpy(&pData[80], &eg1decay2, 4);
1553    
1554            // next 2 bytes unknown
1555    
1556            memcpy(&pData[86], &EG1PreAttack, 2);
1557    
1558            const int32_t eg2decay2 = (int32_t) (EG2InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG2Decay2);
1559            memcpy(&pData[88], &eg2decay2, 4);
1560    
1561            // next 2 bytes unknown
1562    
1563            memcpy(&pData[94], &EG2PreAttack, 2);
1564    
1565            {
1566                if (VelocityResponseDepth > 4) throw Exception("VelocityResponseDepth must be between 0 and 4");
1567                uint8_t velocityresponse = VelocityResponseDepth;
1568                switch (VelocityResponseCurve) {
1569                    case curve_type_nonlinear:
1570                        break;
1571                    case curve_type_linear:
1572                        velocityresponse += 5;
1573                        break;
1574                    case curve_type_special:
1575                        velocityresponse += 10;
1576                        break;
1577                    case curve_type_unknown:
1578                    default:
1579                        throw Exception("Could not update DimensionRegion's chunk, unknown VelocityResponseCurve selected");
1580                }
1581                memcpy(&pData[96], &velocityresponse, 1);
1582          }          }
1583          uint8_t releasevelocityresponse = _3ewa->ReadUint8();  
1584          if (releasevelocityresponse < 5) {          {
1585              ReleaseVelocityResponseCurve = curve_type_nonlinear;              if (ReleaseVelocityResponseDepth > 4) throw Exception("ReleaseVelocityResponseDepth must be between 0 and 4");
1586              ReleaseVelocityResponseDepth = releasevelocityresponse;              uint8_t releasevelocityresponse = ReleaseVelocityResponseDepth;
1587          }              switch (ReleaseVelocityResponseCurve) {
1588          else if (releasevelocityresponse < 10) {                  case curve_type_nonlinear:
1589              ReleaseVelocityResponseCurve = curve_type_linear;                      break;
1590              ReleaseVelocityResponseDepth = releasevelocityresponse - 5;                  case curve_type_linear:
1591          }                      releasevelocityresponse += 5;
1592          else if (releasevelocityresponse < 15) {                      break;
1593              ReleaseVelocityResponseCurve = curve_type_special;                  case curve_type_special:
1594              ReleaseVelocityResponseDepth = releasevelocityresponse - 10;                      releasevelocityresponse += 10;
1595                        break;
1596                    case curve_type_unknown:
1597                    default:
1598                        throw Exception("Could not update DimensionRegion's chunk, unknown ReleaseVelocityResponseCurve selected");
1599                }
1600                memcpy(&pData[97], &releasevelocityresponse, 1);
1601          }          }
1602          else {  
1603              ReleaseVelocityResponseCurve = curve_type_unknown;          memcpy(&pData[98], &VelocityResponseCurveScaling, 1);
1604              ReleaseVelocityResponseDepth = 0;  
1605            memcpy(&pData[99], &AttenuationControllerThreshold, 1);
1606    
1607            // next 4 bytes unknown
1608    
1609            memcpy(&pData[104], &SampleStartOffset, 2);
1610    
1611            // next 2 bytes unknown
1612    
1613            {
1614                uint8_t pitchTrackDimensionBypass = GIG_PITCH_TRACK_ENCODE(PitchTrack);
1615                switch (DimensionBypass) {
1616                    case dim_bypass_ctrl_94:
1617                        pitchTrackDimensionBypass |= 0x10;
1618                        break;
1619                    case dim_bypass_ctrl_95:
1620                        pitchTrackDimensionBypass |= 0x20;
1621                        break;
1622                    case dim_bypass_ctrl_none:
1623                        //FIXME: should we set anything here?
1624                        break;
1625                    default:
1626                        throw Exception("Could not update DimensionRegion's chunk, unknown DimensionBypass selected");
1627                }
1628                memcpy(&pData[108], &pitchTrackDimensionBypass, 1);
1629            }
1630    
1631            const uint8_t pan = (Pan >= 0) ? Pan : ((-Pan) + 63); // signed 8 bit -> signed 7 bit
1632            memcpy(&pData[109], &pan, 1);
1633    
1634            const uint8_t selfmask = (SelfMask) ? 0x01 : 0x00;
1635            memcpy(&pData[110], &selfmask, 1);
1636    
1637            // next byte unknown
1638    
1639            {
1640                uint8_t lfo3ctrl = LFO3Controller & 0x07; // lower 3 bits
1641                if (LFO3Sync) lfo3ctrl |= 0x20; // bit 5
1642                if (InvertAttenuationController) lfo3ctrl |= 0x80; // bit 7
1643                if (VCFType == vcf_type_lowpassturbo) lfo3ctrl |= 0x40; // bit 6
1644                memcpy(&pData[112], &lfo3ctrl, 1);
1645          }          }
1646          VelocityResponseCurveScaling = _3ewa->ReadUint8();  
1647          AttenuationControllerThreshold = _3ewa->ReadInt8();          const uint8_t attenctl = EncodeLeverageController(AttenuationController);
1648          _3ewa->ReadInt32(); // unknown          memcpy(&pData[113], &attenctl, 1);
1649          SampleStartOffset = (uint16_t) _3ewa->ReadInt16();  
1650          _3ewa->ReadInt16(); // unknown          {
1651          uint8_t pitchTrackDimensionBypass = _3ewa->ReadInt8();              uint8_t lfo2ctrl = LFO2Controller & 0x07; // lower 3 bits
1652          PitchTrack = GIG_PITCH_TRACK_EXTRACT(pitchTrackDimensionBypass);              if (LFO2FlipPhase) lfo2ctrl |= 0x80; // bit 7
1653          if      (pitchTrackDimensionBypass & 0x10) DimensionBypass = dim_bypass_ctrl_94;              if (LFO2Sync)      lfo2ctrl |= 0x20; // bit 5
1654          else if (pitchTrackDimensionBypass & 0x20) DimensionBypass = dim_bypass_ctrl_95;              if (VCFResonanceController != vcf_res_ctrl_none) lfo2ctrl |= 0x40; // bit 6
1655          else                                       DimensionBypass = dim_bypass_ctrl_none;              memcpy(&pData[114], &lfo2ctrl, 1);
1656          uint8_t pan = _3ewa->ReadUint8();          }
1657          Pan         = (pan < 64) ? pan : -((int)pan - 63); // signed 7 bit -> signed 8 bit  
1658          SelfMask = _3ewa->ReadInt8() & 0x01;          {
1659          _3ewa->ReadInt8(); // unknown              uint8_t lfo1ctrl = LFO1Controller & 0x07; // lower 3 bits
1660          uint8_t lfo3ctrl = _3ewa->ReadUint8();              if (LFO1FlipPhase) lfo1ctrl |= 0x80; // bit 7
1661          LFO3Controller           = static_cast<lfo3_ctrl_t>(lfo3ctrl & 0x07); // lower 3 bits              if (LFO1Sync)      lfo1ctrl |= 0x40; // bit 6
1662          LFO3Sync                 = lfo3ctrl & 0x20; // bit 5              if (VCFResonanceController != vcf_res_ctrl_none)
1663          InvertAttenuationController = lfo3ctrl & 0x80; // bit 7                  lfo1ctrl |= GIG_VCF_RESONANCE_CTRL_ENCODE(VCFResonanceController);
1664          AttenuationController  = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));              memcpy(&pData[115], &lfo1ctrl, 1);
         uint8_t lfo2ctrl       = _3ewa->ReadUint8();  
         LFO2Controller         = static_cast<lfo2_ctrl_t>(lfo2ctrl & 0x07); // lower 3 bits  
         LFO2FlipPhase          = lfo2ctrl & 0x80; // bit 7  
         LFO2Sync               = lfo2ctrl & 0x20; // bit 5  
         bool extResonanceCtrl  = lfo2ctrl & 0x40; // bit 6  
         uint8_t lfo1ctrl       = _3ewa->ReadUint8();  
         LFO1Controller         = static_cast<lfo1_ctrl_t>(lfo1ctrl & 0x07); // lower 3 bits  
         LFO1FlipPhase          = lfo1ctrl & 0x80; // bit 7  
         LFO1Sync               = lfo1ctrl & 0x40; // bit 6  
         VCFResonanceController = (extResonanceCtrl) ? static_cast<vcf_res_ctrl_t>(GIG_VCF_RESONANCE_CTRL_EXTRACT(lfo1ctrl))  
                                                     : vcf_res_ctrl_none;  
         uint16_t eg3depth = _3ewa->ReadUint16();  
         EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */  
                                       : (-1) * (int16_t) ((eg3depth ^ 0xffff) + 1); /* binary complementary for negatives */  
         _3ewa->ReadInt16(); // unknown  
         ChannelOffset = _3ewa->ReadUint8() / 4;  
         uint8_t regoptions = _3ewa->ReadUint8();  
         MSDecode           = regoptions & 0x01; // bit 0  
         SustainDefeat      = regoptions & 0x02; // bit 1  
         _3ewa->ReadInt16(); // unknown  
         VelocityUpperLimit = _3ewa->ReadInt8();  
         _3ewa->ReadInt8(); // unknown  
         _3ewa->ReadInt16(); // unknown  
         ReleaseTriggerDecay = _3ewa->ReadUint8(); // release trigger decay  
         _3ewa->ReadInt8(); // unknown  
         _3ewa->ReadInt8(); // unknown  
         EG1Hold = _3ewa->ReadUint8() & 0x80; // bit 7  
         uint8_t vcfcutoff = _3ewa->ReadUint8();  
         VCFEnabled = vcfcutoff & 0x80; // bit 7  
         VCFCutoff  = vcfcutoff & 0x7f; // lower 7 bits  
         VCFCutoffController = static_cast<vcf_cutoff_ctrl_t>(_3ewa->ReadUint8());  
         VCFVelocityScale = _3ewa->ReadUint8();  
         _3ewa->ReadInt8(); // unknown  
         uint8_t vcfresonance = _3ewa->ReadUint8();  
         VCFResonance = vcfresonance & 0x7f; // lower 7 bits  
         VCFResonanceDynamic = !(vcfresonance & 0x80); // bit 7  
         uint8_t vcfbreakpoint         = _3ewa->ReadUint8();  
         VCFKeyboardTracking           = vcfbreakpoint & 0x80; // bit 7  
         VCFKeyboardTrackingBreakpoint = vcfbreakpoint & 0x7f; // lower 7 bits  
         uint8_t vcfvelocity = _3ewa->ReadUint8();  
         VCFVelocityDynamicRange = vcfvelocity % 5;  
         VCFVelocityCurve        = static_cast<curve_type_t>(vcfvelocity / 5);  
         VCFType = static_cast<vcf_type_t>(_3ewa->ReadUint8());  
         if (VCFType == vcf_type_lowpass) {  
             if (lfo3ctrl & 0x40) // bit 6  
                 VCFType = vcf_type_lowpassturbo;  
1665          }          }
1666    
1667          // get the corresponding velocity->volume table from the table map or create & calculate that table if it doesn't exist yet          const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth
1668          uint32_t tableKey = (VelocityResponseCurve<<16) | (VelocityResponseDepth<<8) | VelocityResponseCurveScaling;                                                    : uint16_t(((-EG3Depth) - 1) ^ 0xffff); /* binary complementary for negatives */
1669            memcpy(&pData[116], &eg3depth, 1);
1670    
1671            // next 2 bytes unknown
1672    
1673            const uint8_t channeloffset = ChannelOffset * 4;
1674            memcpy(&pData[120], &channeloffset, 1);
1675    
1676            {
1677                uint8_t regoptions = 0;
1678                if (MSDecode)      regoptions |= 0x01; // bit 0
1679                if (SustainDefeat) regoptions |= 0x02; // bit 1
1680                memcpy(&pData[121], &regoptions, 1);
1681            }
1682    
1683            // next 2 bytes unknown
1684    
1685            memcpy(&pData[124], &VelocityUpperLimit, 1);
1686    
1687            // next 3 bytes unknown
1688    
1689            memcpy(&pData[128], &ReleaseTriggerDecay, 1);
1690    
1691            // next 2 bytes unknown
1692    
1693            const uint8_t eg1hold = (EG1Hold) ? 0x80 : 0x00; // bit 7
1694            memcpy(&pData[131], &eg1hold, 1);
1695    
1696            const uint8_t vcfcutoff = (VCFEnabled) ? 0x80 : 0x00 |  /* bit 7 */
1697                                      (VCFCutoff & 0x7f);   /* lower 7 bits */
1698            memcpy(&pData[132], &vcfcutoff, 1);
1699    
1700            memcpy(&pData[133], &VCFCutoffController, 1);
1701    
1702            const uint8_t vcfvelscale = (VCFCutoffControllerInvert) ? 0x80 : 0x00 | /* bit 7 */
1703                                        (VCFVelocityScale & 0x7f); /* lower 7 bits */
1704            memcpy(&pData[134], &vcfvelscale, 1);
1705    
1706            // next byte unknown
1707    
1708            const uint8_t vcfresonance = (VCFResonanceDynamic) ? 0x00 : 0x80 | /* bit 7 */
1709                                         (VCFResonance & 0x7f); /* lower 7 bits */
1710            memcpy(&pData[136], &vcfresonance, 1);
1711    
1712            const uint8_t vcfbreakpoint = (VCFKeyboardTracking) ? 0x80 : 0x00 | /* bit 7 */
1713                                          (VCFKeyboardTrackingBreakpoint & 0x7f); /* lower 7 bits */
1714            memcpy(&pData[137], &vcfbreakpoint, 1);
1715    
1716            const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 |
1717                                        VCFVelocityCurve * 5;
1718            memcpy(&pData[138], &vcfvelocity, 1);
1719    
1720            const uint8_t vcftype = (VCFType == vcf_type_lowpassturbo) ? vcf_type_lowpass : VCFType;
1721            memcpy(&pData[139], &vcftype, 1);
1722        }
1723    
1724        // get the corresponding velocity table from the table map or create & calculate that table if it doesn't exist yet
1725        double* DimensionRegion::GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling)
1726        {
1727            double* table;
1728            uint32_t tableKey = (curveType<<16) | (depth<<8) | scaling;
1729          if (pVelocityTables->count(tableKey)) { // if key exists          if (pVelocityTables->count(tableKey)) { // if key exists
1730              pVelocityAttenuationTable = (*pVelocityTables)[tableKey];              table = (*pVelocityTables)[tableKey];
1731          }          }
1732          else {          else {
1733              pVelocityAttenuationTable =              table = CreateVelocityTable(curveType, depth, scaling);
1734                  CreateVelocityTable(VelocityResponseCurve,              (*pVelocityTables)[tableKey] = table; // put the new table into the tables map
                                     VelocityResponseDepth,  
                                     VelocityResponseCurveScaling);  
             (*pVelocityTables)[tableKey] = pVelocityAttenuationTable; // put the new table into the tables map  
1735          }          }
1736            return table;
1737      }      }
1738    
1739      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {
# Line 1245  namespace gig { namespace { Line 1854  namespace gig { namespace {
1854          return decodedcontroller;          return decodedcontroller;
1855      }      }
1856    
1857        DimensionRegion::_lev_ctrl_t DimensionRegion::EncodeLeverageController(leverage_ctrl_t DecodedController) {
1858            _lev_ctrl_t encodedcontroller;
1859            switch (DecodedController.type) {
1860                // special controller
1861                case leverage_ctrl_t::type_none:
1862                    encodedcontroller = _lev_ctrl_none;
1863                    break;
1864                case leverage_ctrl_t::type_velocity:
1865                    encodedcontroller = _lev_ctrl_velocity;
1866                    break;
1867                case leverage_ctrl_t::type_channelaftertouch:
1868                    encodedcontroller = _lev_ctrl_channelaftertouch;
1869                    break;
1870    
1871                // ordinary MIDI control change controller
1872                case leverage_ctrl_t::type_controlchange:
1873                    switch (DecodedController.controller_number) {
1874                        case 1:
1875                            encodedcontroller = _lev_ctrl_modwheel;
1876                            break;
1877                        case 2:
1878                            encodedcontroller = _lev_ctrl_breath;
1879                            break;
1880                        case 4:
1881                            encodedcontroller = _lev_ctrl_foot;
1882                            break;
1883                        case 12:
1884                            encodedcontroller = _lev_ctrl_effect1;
1885                            break;
1886                        case 13:
1887                            encodedcontroller = _lev_ctrl_effect2;
1888                            break;
1889                        case 16:
1890                            encodedcontroller = _lev_ctrl_genpurpose1;
1891                            break;
1892                        case 17:
1893                            encodedcontroller = _lev_ctrl_genpurpose2;
1894                            break;
1895                        case 18:
1896                            encodedcontroller = _lev_ctrl_genpurpose3;
1897                            break;
1898                        case 19:
1899                            encodedcontroller = _lev_ctrl_genpurpose4;
1900                            break;
1901                        case 5:
1902                            encodedcontroller = _lev_ctrl_portamentotime;
1903                            break;
1904                        case 64:
1905                            encodedcontroller = _lev_ctrl_sustainpedal;
1906                            break;
1907                        case 65:
1908                            encodedcontroller = _lev_ctrl_portamento;
1909                            break;
1910                        case 66:
1911                            encodedcontroller = _lev_ctrl_sostenutopedal;
1912                            break;
1913                        case 67:
1914                            encodedcontroller = _lev_ctrl_softpedal;
1915                            break;
1916                        case 80:
1917                            encodedcontroller = _lev_ctrl_genpurpose5;
1918                            break;
1919                        case 81:
1920                            encodedcontroller = _lev_ctrl_genpurpose6;
1921                            break;
1922                        case 82:
1923                            encodedcontroller = _lev_ctrl_genpurpose7;
1924                            break;
1925                        case 83:
1926                            encodedcontroller = _lev_ctrl_genpurpose8;
1927                            break;
1928                        case 91:
1929                            encodedcontroller = _lev_ctrl_effect1depth;
1930                            break;
1931                        case 92:
1932                            encodedcontroller = _lev_ctrl_effect2depth;
1933                            break;
1934                        case 93:
1935                            encodedcontroller = _lev_ctrl_effect3depth;
1936                            break;
1937                        case 94:
1938                            encodedcontroller = _lev_ctrl_effect4depth;
1939                            break;
1940                        case 95:
1941                            encodedcontroller = _lev_ctrl_effect5depth;
1942                            break;
1943                        default:
1944                            throw gig::Exception("leverage controller number is not supported by the gig format");
1945                    }
1946                default:
1947                    throw gig::Exception("Unknown leverage controller type.");
1948            }
1949            return encodedcontroller;
1950        }
1951    
1952      DimensionRegion::~DimensionRegion() {      DimensionRegion::~DimensionRegion() {
1953          Instances--;          Instances--;
1954          if (!Instances) {          if (!Instances) {
# Line 1258  namespace gig { namespace { Line 1962  namespace gig { namespace {
1962              delete pVelocityTables;              delete pVelocityTables;
1963              pVelocityTables = NULL;              pVelocityTables = NULL;
1964          }          }
1965            if (VelocityTable) delete[] VelocityTable;
1966      }      }
1967    
1968      /**      /**
# Line 1275  namespace gig { namespace { Line 1980  namespace gig { namespace {
1980          return pVelocityAttenuationTable[MIDIKeyVelocity];          return pVelocityAttenuationTable[MIDIKeyVelocity];
1981      }      }
1982    
1983        double DimensionRegion::GetVelocityRelease(uint8_t MIDIKeyVelocity) {
1984            return pVelocityReleaseTable[MIDIKeyVelocity];
1985        }
1986    
1987        double DimensionRegion::GetVelocityCutoff(uint8_t MIDIKeyVelocity) {
1988            return pVelocityCutoffTable[MIDIKeyVelocity];
1989        }
1990    
1991      double* DimensionRegion::CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling) {      double* DimensionRegion::CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling) {
1992    
1993          // line-segment approximations of the 15 velocity curves          // line-segment approximations of the 15 velocity curves
# Line 1308  namespace gig { namespace { Line 2021  namespace gig { namespace {
2021          const int spe4[] = { 1, 4, 23, 5, 49, 13, 57, 17, 92, 57, 122, 127,          const int spe4[] = { 1, 4, 23, 5, 49, 13, 57, 17, 92, 57, 122, 127,
2022                               127, 127 };                               127, 127 };
2023    
2024            // this is only used by the VCF velocity curve
2025            const int spe5[] = { 1, 2, 30, 5, 60, 19, 77, 70, 83, 85, 88, 106,
2026                                 91, 127, 127, 127 };
2027    
2028          const int* const curves[] = { non0, non1, non2, non3, non4,          const int* const curves[] = { non0, non1, non2, non3, non4,
2029                                        lin0, lin1, lin2, lin3, lin4,                                        lin0, lin1, lin2, lin3, lin4,
2030                                        spe0, spe1, spe2, spe3, spe4 };                                        spe0, spe1, spe2, spe3, spe4, spe5 };
2031    
2032          double* const table = new double[128];          double* const table = new double[128];
2033    
# Line 1343  namespace gig { namespace { Line 2060  namespace gig { namespace {
2060  // *  // *
2061    
2062      Region::Region(Instrument* pInstrument, RIFF::List* rgnList) : DLS::Region((DLS::Instrument*) pInstrument, rgnList) {      Region::Region(Instrument* pInstrument, RIFF::List* rgnList) : DLS::Region((DLS::Instrument*) pInstrument, rgnList) {
2063            pInfo->UseFixedLengthStrings = true;
2064    
2065          // Initialization          // Initialization
2066          Dimensions = 0;          Dimensions = 0;
2067          for (int i = 0; i < 256; i++) {          for (int i = 0; i < 256; i++) {
# Line 1362  namespace gig { namespace { Line 2081  namespace gig { namespace {
2081              for (int i = 0; i < dimensionBits; i++) {              for (int i = 0; i < dimensionBits; i++) {
2082                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());
2083                  uint8_t     bits      = _3lnk->ReadUint8();                  uint8_t     bits      = _3lnk->ReadUint8();
2084                    _3lnk->ReadUint8(); // probably the position of the dimension
2085                    _3lnk->ReadUint8(); // unknown
2086                    uint8_t     zones     = _3lnk->ReadUint8(); // new for v3: number of zones doesn't have to be == pow(2,bits)
2087                  if (dimension == dimension_none) { // inactive dimension                  if (dimension == dimension_none) { // inactive dimension
2088                      pDimensionDefinitions[i].dimension  = dimension_none;                      pDimensionDefinitions[i].dimension  = dimension_none;
2089                      pDimensionDefinitions[i].bits       = 0;                      pDimensionDefinitions[i].bits       = 0;
2090                      pDimensionDefinitions[i].zones      = 0;                      pDimensionDefinitions[i].zones      = 0;
2091                      pDimensionDefinitions[i].split_type = split_type_bit;                      pDimensionDefinitions[i].split_type = split_type_bit;
                     pDimensionDefinitions[i].ranges     = NULL;  
2092                      pDimensionDefinitions[i].zone_size  = 0;                      pDimensionDefinitions[i].zone_size  = 0;
2093                  }                  }
2094                  else { // active dimension                  else { // active dimension
2095                      pDimensionDefinitions[i].dimension = dimension;                      pDimensionDefinitions[i].dimension = dimension;
2096                      pDimensionDefinitions[i].bits      = bits;                      pDimensionDefinitions[i].bits      = bits;
2097                      pDimensionDefinitions[i].zones     = 0x01 << bits; // = pow(2,bits)                      pDimensionDefinitions[i].zones     = zones ? zones : 0x01 << bits; // = pow(2,bits)
2098                      pDimensionDefinitions[i].split_type = (dimension == dimension_layer ||                      pDimensionDefinitions[i].split_type = (dimension == dimension_layer ||
2099                                                             dimension == dimension_samplechannel ||                                                             dimension == dimension_samplechannel ||
2100                                                             dimension == dimension_releasetrigger) ? split_type_bit                                                             dimension == dimension_releasetrigger ||
2101                                                                                                    : split_type_normal;                                                             dimension == dimension_keyboard ||
2102                      pDimensionDefinitions[i].ranges = NULL; // it's not possible to check velocity dimensions for custom defined ranges at this point                                                             dimension == dimension_roundrobin ||
2103                                                               dimension == dimension_random) ? split_type_bit
2104                                                                                              : split_type_normal;
2105                      pDimensionDefinitions[i].zone_size  =                      pDimensionDefinitions[i].zone_size  =
2106                          (pDimensionDefinitions[i].split_type == split_type_normal) ? 128 / pDimensionDefinitions[i].zones                          (pDimensionDefinitions[i].split_type == split_type_normal) ? 128.0 / pDimensionDefinitions[i].zones
2107                                                                                     : 0;                                                                                     : 0;
2108                      Dimensions++;                      Dimensions++;
2109    
2110                      // if this is a layer dimension, remember the amount of layers                      // if this is a layer dimension, remember the amount of layers
2111                      if (dimension == dimension_layer) Layers = pDimensionDefinitions[i].zones;                      if (dimension == dimension_layer) Layers = pDimensionDefinitions[i].zones;
2112                  }                  }
2113                  _3lnk->SetPos(6, RIFF::stream_curpos); // jump forward to next dimension definition                  _3lnk->SetPos(3, RIFF::stream_curpos); // jump forward to next dimension definition
2114              }              }
2115                for (int i = dimensionBits ; i < 8 ; i++) pDimensionDefinitions[i].bits = 0;
2116    
2117              // check velocity dimension (if there is one) for custom defined zone ranges              // if there's a velocity dimension and custom velocity zone splits are used,
2118              for (uint i = 0; i < Dimensions; i++) {              // update the VelocityTables in the dimension regions
2119                  dimension_def_t* pDimDef = pDimensionDefinitions + i;              UpdateVelocityTable();
                 if (pDimDef->dimension == dimension_velocity) {  
                     if (pDimensionRegions[0]->VelocityUpperLimit == 0) {  
                         // no custom defined ranges  
                         pDimDef->split_type = split_type_normal;  
                         pDimDef->ranges     = NULL;  
                     }  
                     else { // custom defined ranges  
                         pDimDef->split_type = split_type_customvelocity;  
                         pDimDef->ranges     = new range_t[pDimDef->zones];  
                         uint8_t bits[8] = { 0 };  
                         int previousUpperLimit = -1;  
                         for (int velocityZone = 0; velocityZone < pDimDef->zones; velocityZone++) {  
                             bits[i] = velocityZone;  
                             DimensionRegion* pDimRegion = GetDimensionRegionByBit(bits);  
   
                             pDimDef->ranges[velocityZone].low  = previousUpperLimit + 1;  
                             pDimDef->ranges[velocityZone].high = pDimRegion->VelocityUpperLimit;  
                             previousUpperLimit = pDimDef->ranges[velocityZone].high;  
                             // fill velocity table  
                             for (int i = pDimDef->ranges[velocityZone].low; i <= pDimDef->ranges[velocityZone].high; i++) {  
                                 VelocityTable[i] = velocityZone;  
                             }  
                         }  
                     }  
                 }  
             }  
2120    
2121              // jump to start of the wave pool indices (if not already there)              // jump to start of the wave pool indices (if not already there)
             File* file = (File*) GetParent()->GetParent();  
2122              if (file->pVersion && file->pVersion->major == 3)              if (file->pVersion && file->pVersion->major == 3)
2123                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure
2124              else              else
# Line 1430  namespace gig { namespace { Line 2127  namespace gig { namespace {
2127              // load sample references              // load sample references
2128              for (uint i = 0; i < DimensionRegions; i++) {              for (uint i = 0; i < DimensionRegions; i++) {
2129                  uint32_t wavepoolindex = _3lnk->ReadUint32();                  uint32_t wavepoolindex = _3lnk->ReadUint32();
2130                  pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);                  if (file->pWavePoolTable) pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);
2131              }              }
2132                GetSample(); // load global region sample reference
2133            }
2134    
2135            // make sure there is at least one dimension region
2136            if (!DimensionRegions) {
2137                RIFF::List* _3prg = rgnList->GetSubList(LIST_TYPE_3PRG);
2138                if (!_3prg) _3prg = rgnList->AddSubList(LIST_TYPE_3PRG);
2139                RIFF::List* _3ewl = _3prg->AddSubList(LIST_TYPE_3EWL);
2140                pDimensionRegions[0] = new DimensionRegion(_3ewl);
2141                DimensionRegions = 1;
2142            }
2143        }
2144    
2145        /**
2146         * Apply Region settings and all its DimensionRegions to the respective
2147         * RIFF chunks. You have to call File::Save() to make changes persistent.
2148         *
2149         * Usually there is absolutely no need to call this method explicitly.
2150         * It will be called automatically when File::Save() was called.
2151         *
2152         * @throws gig::Exception if samples cannot be dereferenced
2153         */
2154        void Region::UpdateChunks() {
2155            // first update base class's chunks
2156            DLS::Region::UpdateChunks();
2157    
2158            // update dimension region's chunks
2159            for (int i = 0; i < DimensionRegions; i++) {
2160                pDimensionRegions[i]->UpdateChunks();
2161            }
2162    
2163            File* pFile = (File*) GetParent()->GetParent();
2164            const int iMaxDimensions = (pFile->pVersion && pFile->pVersion->major == 3) ? 8 : 5;
2165            const int iMaxDimensionRegions = (pFile->pVersion && pFile->pVersion->major == 3) ? 256 : 32;
2166    
2167            // make sure '3lnk' chunk exists
2168            RIFF::Chunk* _3lnk = pCkRegion->GetSubChunk(CHUNK_ID_3LNK);
2169            if (!_3lnk) {
2170                const int _3lnkChunkSize = (pFile->pVersion && pFile->pVersion->major == 3) ? 1092 : 172;
2171                _3lnk = pCkRegion->AddSubChunk(CHUNK_ID_3LNK, _3lnkChunkSize);
2172            }
2173    
2174            // update dimension definitions in '3lnk' chunk
2175            uint8_t* pData = (uint8_t*) _3lnk->LoadChunkData();
2176            memcpy(&pData[0], &DimensionRegions, 4);
2177            for (int i = 0; i < iMaxDimensions; i++) {
2178                pData[4 + i * 8] = (uint8_t) pDimensionDefinitions[i].dimension;
2179                pData[5 + i * 8] = pDimensionDefinitions[i].bits;
2180                // next 2 bytes unknown
2181                pData[8 + i * 8] = pDimensionDefinitions[i].zones;
2182                // next 3 bytes unknown
2183            }
2184    
2185            // update wave pool table in '3lnk' chunk
2186            const int iWavePoolOffset = (pFile->pVersion && pFile->pVersion->major == 3) ? 68 : 44;
2187            for (uint i = 0; i < iMaxDimensionRegions; i++) {
2188                int iWaveIndex = -1;
2189                if (i < DimensionRegions) {
2190                    if (!pFile->pSamples || !pFile->pSamples->size()) throw gig::Exception("Could not update gig::Region, there are no samples");
2191                    File::SampleList::iterator iter = pFile->pSamples->begin();
2192                    File::SampleList::iterator end  = pFile->pSamples->end();
2193                    for (int index = 0; iter != end; ++iter, ++index) {
2194                        if (*iter == pDimensionRegions[i]->pSample) {
2195                            iWaveIndex = index;
2196                            break;
2197                        }
2198                    }
2199                    if (iWaveIndex < 0) throw gig::Exception("Could not update gig::Region, could not find DimensionRegion's sample");
2200                }
2201                memcpy(&pData[iWavePoolOffset + i * 4], &iWaveIndex, 4);
2202          }          }
         else throw gig::Exception("Mandatory <3lnk> chunk not found.");  
2203      }      }
2204    
2205      void Region::LoadDimensionRegions(RIFF::List* rgn) {      void Region::LoadDimensionRegions(RIFF::List* rgn) {
# Line 1452  namespace gig { namespace { Line 2218  namespace gig { namespace {
2218          }          }
2219      }      }
2220    
2221      Region::~Region() {      void Region::UpdateVelocityTable() {
2222          for (uint i = 0; i < Dimensions; i++) {          // get velocity dimension's index
2223              if (pDimensionDefinitions[i].ranges) delete[] pDimensionDefinitions[i].ranges;          int veldim = -1;
2224            for (int i = 0 ; i < Dimensions ; i++) {
2225                if (pDimensionDefinitions[i].dimension == gig::dimension_velocity) {
2226                    veldim = i;
2227                    break;
2228                }
2229            }
2230            if (veldim == -1) return;
2231    
2232            int step = 1;
2233            for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;
2234            int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;
2235            int end = step * pDimensionDefinitions[veldim].zones;
2236    
2237            // loop through all dimension regions for all dimensions except the velocity dimension
2238            int dim[8] = { 0 };
2239            for (int i = 0 ; i < DimensionRegions ; i++) {
2240    
2241                if (pDimensionRegions[i]->VelocityUpperLimit) {
2242                    // create the velocity table
2243                    uint8_t* table = pDimensionRegions[i]->VelocityTable;
2244                    if (!table) {
2245                        table = new uint8_t[128];
2246                        pDimensionRegions[i]->VelocityTable = table;
2247                    }
2248                    int tableidx = 0;
2249                    int velocityZone = 0;
2250                    for (int k = i ; k < end ; k += step) {
2251                        DimensionRegion *d = pDimensionRegions[k];
2252                        for (; tableidx <= d->VelocityUpperLimit ; tableidx++) table[tableidx] = velocityZone;
2253                        velocityZone++;
2254                    }
2255                } else {
2256                    if (pDimensionRegions[i]->VelocityTable) {
2257                        delete[] pDimensionRegions[i]->VelocityTable;
2258                        pDimensionRegions[i]->VelocityTable = 0;
2259                    }
2260                }
2261    
2262                int j;
2263                int shift = 0;
2264                for (j = 0 ; j < Dimensions ; j++) {
2265                    if (j == veldim) i += skipveldim; // skip velocity dimension
2266                    else {
2267                        dim[j]++;
2268                        if (dim[j] < pDimensionDefinitions[j].zones) break;
2269                        else {
2270                            // skip unused dimension regions
2271                            dim[j] = 0;
2272                            i += ((1 << pDimensionDefinitions[j].bits) -
2273                                  pDimensionDefinitions[j].zones) << shift;
2274                        }
2275                    }
2276                    shift += pDimensionDefinitions[j].bits;
2277                }
2278                if (j == Dimensions) break;
2279          }          }
2280        }
2281    
2282        /** @brief Einstein would have dreamed of it - create a new dimension.
2283         *
2284         * Creates a new dimension with the dimension definition given by
2285         * \a pDimDef. The appropriate amount of DimensionRegions will be created.
2286         * There is a hard limit of dimensions and total amount of "bits" all
2287         * dimensions can have. This limit is dependant to what gig file format
2288         * version this file refers to. The gig v2 (and lower) format has a
2289         * dimension limit and total amount of bits limit of 5, whereas the gig v3
2290         * format has a limit of 8.
2291         *
2292         * @param pDimDef - defintion of the new dimension
2293         * @throws gig::Exception if dimension of the same type exists already
2294         * @throws gig::Exception if amount of dimensions or total amount of
2295         *                        dimension bits limit is violated
2296         */
2297        void Region::AddDimension(dimension_def_t* pDimDef) {
2298            // check if max. amount of dimensions reached
2299            File* file = (File*) GetParent()->GetParent();
2300            const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;
2301            if (Dimensions >= iMaxDimensions)
2302                throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimensions already reached");
2303            // check if max. amount of dimension bits reached
2304            int iCurrentBits = 0;
2305            for (int i = 0; i < Dimensions; i++)
2306                iCurrentBits += pDimensionDefinitions[i].bits;
2307            if (iCurrentBits >= iMaxDimensions)
2308                throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimension bits already reached");
2309            const int iNewBits = iCurrentBits + pDimDef->bits;
2310            if (iNewBits > iMaxDimensions)
2311                throw gig::Exception("Could not add new dimension, new dimension would exceed max. amount of " + ToString(iMaxDimensions) + " dimension bits");
2312            // check if there's already a dimensions of the same type
2313            for (int i = 0; i < Dimensions; i++)
2314                if (pDimensionDefinitions[i].dimension == pDimDef->dimension)
2315                    throw gig::Exception("Could not add new dimension, there is already a dimension of the same type");
2316    
2317            // assign definition of new dimension
2318            pDimensionDefinitions[Dimensions] = *pDimDef;
2319    
2320            // create new dimension region(s) for this new dimension
2321            for (int i = 1 << iCurrentBits; i < 1 << iNewBits; i++) {
2322                //TODO: maybe we should copy existing dimension regions if possible instead of simply creating new ones with default values
2323                RIFF::List* pNewDimRgnListChunk = pCkRegion->AddSubList(LIST_TYPE_3EWL);
2324                pDimensionRegions[i] = new DimensionRegion(pNewDimRgnListChunk);
2325                DimensionRegions++;
2326            }
2327    
2328            Dimensions++;
2329    
2330            // if this is a layer dimension, update 'Layers' attribute
2331            if (pDimDef->dimension == dimension_layer) Layers = pDimDef->zones;
2332    
2333            UpdateVelocityTable();
2334        }
2335    
2336        /** @brief Delete an existing dimension.
2337         *
2338         * Deletes the dimension given by \a pDimDef and deletes all respective
2339         * dimension regions, that is all dimension regions where the dimension's
2340         * bit(s) part is greater than 0. In case of a 'sustain pedal' dimension
2341         * for example this would delete all dimension regions for the case(s)
2342         * where the sustain pedal is pressed down.
2343         *
2344         * @param pDimDef - dimension to delete
2345         * @throws gig::Exception if given dimension cannot be found
2346         */
2347        void Region::DeleteDimension(dimension_def_t* pDimDef) {
2348            // get dimension's index
2349            int iDimensionNr = -1;
2350            for (int i = 0; i < Dimensions; i++) {
2351                if (&pDimensionDefinitions[i] == pDimDef) {
2352                    iDimensionNr = i;
2353                    break;
2354                }
2355            }
2356            if (iDimensionNr < 0) throw gig::Exception("Invalid dimension_def_t pointer");
2357    
2358            // get amount of bits below the dimension to delete
2359            int iLowerBits = 0;
2360            for (int i = 0; i < iDimensionNr; i++)
2361                iLowerBits += pDimensionDefinitions[i].bits;
2362    
2363            // get amount ot bits above the dimension to delete
2364            int iUpperBits = 0;
2365            for (int i = iDimensionNr + 1; i < Dimensions; i++)
2366                iUpperBits += pDimensionDefinitions[i].bits;
2367    
2368            // delete dimension regions which belong to the given dimension
2369            // (that is where the dimension's bit > 0)
2370            for (int iUpperBit = 0; iUpperBit < 1 << iUpperBits; iUpperBit++) {
2371                for (int iObsoleteBit = 1; iObsoleteBit < 1 << pDimensionDefinitions[iDimensionNr].bits; iObsoleteBit++) {
2372                    for (int iLowerBit = 0; iLowerBit < 1 << iLowerBits; iLowerBit++) {
2373                        int iToDelete = iUpperBit    << (pDimensionDefinitions[iDimensionNr].bits + iLowerBits) |
2374                                        iObsoleteBit << iLowerBits |
2375                                        iLowerBit;
2376                        delete pDimensionRegions[iToDelete];
2377                        pDimensionRegions[iToDelete] = NULL;
2378                        DimensionRegions--;
2379                    }
2380                }
2381            }
2382    
2383            // defrag pDimensionRegions array
2384            // (that is remove the NULL spaces within the pDimensionRegions array)
2385            for (int iFrom = 2, iTo = 1; iFrom < 256 && iTo < 256 - 1; iTo++) {
2386                if (!pDimensionRegions[iTo]) {
2387                    if (iFrom <= iTo) iFrom = iTo + 1;
2388                    while (!pDimensionRegions[iFrom] && iFrom < 256) iFrom++;
2389                    if (iFrom < 256 && pDimensionRegions[iFrom]) {
2390                        pDimensionRegions[iTo]   = pDimensionRegions[iFrom];
2391                        pDimensionRegions[iFrom] = NULL;
2392                    }
2393                }
2394            }
2395    
2396            // 'remove' dimension definition
2397            for (int i = iDimensionNr + 1; i < Dimensions; i++) {
2398                pDimensionDefinitions[i - 1] = pDimensionDefinitions[i];
2399            }
2400            pDimensionDefinitions[Dimensions - 1].dimension = dimension_none;
2401            pDimensionDefinitions[Dimensions - 1].bits      = 0;
2402            pDimensionDefinitions[Dimensions - 1].zones     = 0;
2403    
2404            Dimensions--;
2405    
2406            // if this was a layer dimension, update 'Layers' attribute
2407            if (pDimDef->dimension == dimension_layer) Layers = 1;
2408        }
2409    
2410        Region::~Region() {
2411          for (int i = 0; i < 256; i++) {          for (int i = 0; i < 256; i++) {
2412              if (pDimensionRegions[i]) delete pDimensionRegions[i];              if (pDimensionRegions[i]) delete pDimensionRegions[i];
2413          }          }
# Line 1480  namespace gig { namespace { Line 2432  namespace gig { namespace {
2432       * @see             Dimensions       * @see             Dimensions
2433       */       */
2434      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {
2435          uint8_t bits[8] = { 0 };          uint8_t bits;
2436            int veldim = -1;
2437            int velbitpos;
2438            int bitpos = 0;
2439            int dimregidx = 0;
2440          for (uint i = 0; i < Dimensions; i++) {          for (uint i = 0; i < Dimensions; i++) {
2441              bits[i] = DimValues[i];              if (pDimensionDefinitions[i].dimension == dimension_velocity) {
2442              switch (pDimensionDefinitions[i].split_type) {                  // the velocity dimension must be handled after the other dimensions
2443                  case split_type_normal:                  veldim = i;
2444                      bits[i] /= pDimensionDefinitions[i].zone_size;                  velbitpos = bitpos;
2445                      break;              } else {
2446                  case split_type_customvelocity:                  switch (pDimensionDefinitions[i].split_type) {
2447                      bits[i] = VelocityTable[bits[i]];                      case split_type_normal:
2448                      break;                          bits = uint8_t(DimValues[i] / pDimensionDefinitions[i].zone_size);
2449                  case split_type_bit: // the value is already the sought dimension bit number                          break;
2450                      const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;                      case split_type_bit: // the value is already the sought dimension bit number
2451                      bits[i] = bits[i] & limiter_mask; // just make sure the value don't uses more bits than allowed                          const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;
2452                      break;                          bits = DimValues[i] & limiter_mask; // just make sure the value doesn't use more bits than allowed
2453              }                          break;
2454                    }
2455                    dimregidx |= bits << bitpos;
2456                }
2457                bitpos += pDimensionDefinitions[i].bits;
2458            }
2459            DimensionRegion* dimreg = pDimensionRegions[dimregidx];
2460            if (veldim != -1) {
2461                // (dimreg is now the dimension region for the lowest velocity)
2462                if (dimreg->VelocityUpperLimit) // custom defined zone ranges
2463                    bits = dimreg->VelocityTable[DimValues[veldim]];
2464                else // normal split type
2465                    bits = uint8_t(DimValues[veldim] / pDimensionDefinitions[veldim].zone_size);
2466    
2467                dimregidx |= bits << velbitpos;
2468                dimreg = pDimensionRegions[dimregidx];
2469          }          }
2470          return GetDimensionRegionByBit(bits);          return dimreg;
2471      }      }
2472    
2473      /**      /**
# Line 1533  namespace gig { namespace { Line 2504  namespace gig { namespace {
2504          else         return static_cast<gig::Sample*>(pSample = GetSampleFromWavePool(WavePoolTableIndex));          else         return static_cast<gig::Sample*>(pSample = GetSampleFromWavePool(WavePoolTableIndex));
2505      }      }
2506    
2507      Sample* Region::GetSampleFromWavePool(unsigned int WavePoolTableIndex) {      Sample* Region::GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress) {
2508          if ((int32_t)WavePoolTableIndex == -1) return NULL;          if ((int32_t)WavePoolTableIndex == -1) return NULL;
2509          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
2510            if (!file->pWavePoolTable) return NULL;
2511          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
2512          Sample* sample = file->GetFirstSample();          unsigned long soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];
2513            Sample* sample = file->GetFirstSample(pProgress);
2514          while (sample) {          while (sample) {
2515              if (sample->ulWavePoolOffset == soughtoffset) return static_cast<gig::Sample*>(pSample = sample);              if (sample->ulWavePoolOffset == soughtoffset &&
2516                    sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);
2517              sample = file->GetNextSample();              sample = file->GetNextSample();
2518          }          }
2519          return NULL;          return NULL;
# Line 1550  namespace gig { namespace { Line 2524  namespace gig { namespace {
2524  // *************** Instrument ***************  // *************** Instrument ***************
2525  // *  // *
2526    
2527      Instrument::Instrument(File* pFile, RIFF::List* insList) : DLS::Instrument((DLS::File*)pFile, insList) {      Instrument::Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress) : DLS::Instrument((DLS::File*)pFile, insList) {
2528            pInfo->UseFixedLengthStrings = true;
2529    
2530          // Initialization          // Initialization
2531          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;
         RegionIndex = -1;  
2532    
2533          // Loading          // Loading
2534          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);
# Line 1569  namespace gig { namespace { Line 2544  namespace gig { namespace {
2544                  DimensionKeyRange.low  = dimkeystart >> 1;                  DimensionKeyRange.low  = dimkeystart >> 1;
2545                  DimensionKeyRange.high = _3ewg->ReadUint8();                  DimensionKeyRange.high = _3ewg->ReadUint8();
2546              }              }
             else throw gig::Exception("Mandatory <3ewg> chunk not found.");  
2547          }          }
         else throw gig::Exception("Mandatory <lart> list chunk not found.");  
2548    
2549            if (!pRegions) pRegions = new RegionList;
2550          RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);          RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);
2551          if (!lrgn) throw gig::Exception("Mandatory chunks in <ins > chunk not found.");          if (lrgn) {
2552          pRegions = new Region*[Regions];              RIFF::List* rgn = lrgn->GetFirstSubList();
2553          for (uint i = 0; i < Regions; i++) pRegions[i] = NULL;              while (rgn) {
2554          RIFF::List* rgn = lrgn->GetFirstSubList();                  if (rgn->GetListType() == LIST_TYPE_RGN) {
2555          unsigned int iRegion = 0;                      __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
2556          while (rgn) {                      pRegions->push_back(new Region(this, rgn));
2557              if (rgn->GetListType() == LIST_TYPE_RGN) {                  }
2558                  pRegions[iRegion] = new Region(this, rgn);                  rgn = lrgn->GetNextSubList();
                 iRegion++;  
             }  
             rgn = lrgn->GetNextSubList();  
         }  
   
         // Creating Region Key Table for fast lookup  
         for (uint iReg = 0; iReg < Regions; iReg++) {  
             for (int iKey = pRegions[iReg]->KeyRange.low; iKey <= pRegions[iReg]->KeyRange.high; iKey++) {  
                 RegionKeyTable[iKey] = pRegions[iReg];  
2559              }              }
2560                // Creating Region Key Table for fast lookup
2561                UpdateRegionKeyTable();
2562          }          }
2563    
2564            __notify_progress(pProgress, 1.0f); // notify done
2565      }      }
2566    
2567      Instrument::~Instrument() {      void Instrument::UpdateRegionKeyTable() {
2568          for (uint i = 0; i < Regions; i++) {          RegionList::iterator iter = pRegions->begin();
2569              if (pRegions) {          RegionList::iterator end  = pRegions->end();
2570                  if (pRegions[i]) delete (pRegions[i]);          for (; iter != end; ++iter) {
2571                gig::Region* pRegion = static_cast<gig::Region*>(*iter);
2572                for (int iKey = pRegion->KeyRange.low; iKey <= pRegion->KeyRange.high; iKey++) {
2573                    RegionKeyTable[iKey] = pRegion;
2574              }              }
2575          }          }
2576          if (pRegions) delete[] pRegions;      }
2577    
2578        Instrument::~Instrument() {
2579        }
2580    
2581        /**
2582         * Apply Instrument with all its Regions to the respective RIFF chunks.
2583         * You have to call File::Save() to make changes persistent.
2584         *
2585         * Usually there is absolutely no need to call this method explicitly.
2586         * It will be called automatically when File::Save() was called.
2587         *
2588         * @throws gig::Exception if samples cannot be dereferenced
2589         */
2590        void Instrument::UpdateChunks() {
2591            // first update base classes' chunks
2592            DLS::Instrument::UpdateChunks();
2593    
2594            // update Regions' chunks
2595            {
2596                RegionList::iterator iter = pRegions->begin();
2597                RegionList::iterator end  = pRegions->end();
2598                for (; iter != end; ++iter)
2599                    (*iter)->UpdateChunks();
2600            }
2601    
2602            // make sure 'lart' RIFF list chunk exists
2603            RIFF::List* lart = pCkInstrument->GetSubList(LIST_TYPE_LART);
2604            if (!lart)  lart = pCkInstrument->AddSubList(LIST_TYPE_LART);
2605            // make sure '3ewg' RIFF chunk exists
2606            RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);
2607            if (!_3ewg)  _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, 12);
2608            // update '3ewg' RIFF chunk
2609            uint8_t* pData = (uint8_t*) _3ewg->LoadChunkData();
2610            memcpy(&pData[0], &EffectSend, 2);
2611            memcpy(&pData[2], &Attenuation, 4);
2612            memcpy(&pData[6], &FineTune, 2);
2613            memcpy(&pData[8], &PitchbendRange, 2);
2614            const uint8_t dimkeystart = (PianoReleaseMode) ? 0x01 : 0x00 |
2615                                        DimensionKeyRange.low << 1;
2616            memcpy(&pData[10], &dimkeystart, 1);
2617            memcpy(&pData[11], &DimensionKeyRange.high, 1);
2618      }      }
2619    
2620      /**      /**
# Line 1612  namespace gig { namespace { Line 2625  namespace gig { namespace {
2625       *             there is no Region defined for the given \a Key       *             there is no Region defined for the given \a Key
2626       */       */
2627      Region* Instrument::GetRegion(unsigned int Key) {      Region* Instrument::GetRegion(unsigned int Key) {
2628          if (!pRegions || Key > 127) return NULL;          if (!pRegions || !pRegions->size() || Key > 127) return NULL;
2629          return RegionKeyTable[Key];          return RegionKeyTable[Key];
2630    
2631          /*for (int i = 0; i < Regions; i++) {          /*for (int i = 0; i < Regions; i++) {
2632              if (Key <= pRegions[i]->KeyRange.high &&              if (Key <= pRegions[i]->KeyRange.high &&
2633                  Key >= pRegions[i]->KeyRange.low) return pRegions[i];                  Key >= pRegions[i]->KeyRange.low) return pRegions[i];
# Line 1629  namespace gig { namespace { Line 2643  namespace gig { namespace {
2643       * @see      GetNextRegion()       * @see      GetNextRegion()
2644       */       */
2645      Region* Instrument::GetFirstRegion() {      Region* Instrument::GetFirstRegion() {
2646          if (!Regions) return NULL;          if (!pRegions) return NULL;
2647          RegionIndex = 1;          RegionsIterator = pRegions->begin();
2648          return pRegions[0];          return static_cast<gig::Region*>( (RegionsIterator != pRegions->end()) ? *RegionsIterator : NULL );
2649      }      }
2650    
2651      /**      /**
# Line 1643  namespace gig { namespace { Line 2657  namespace gig { namespace {
2657       * @see      GetFirstRegion()       * @see      GetFirstRegion()
2658       */       */
2659      Region* Instrument::GetNextRegion() {      Region* Instrument::GetNextRegion() {
2660          if (RegionIndex < 0 || uint32_t(RegionIndex) >= Regions) return NULL;          if (!pRegions) return NULL;
2661          return pRegions[RegionIndex++];          RegionsIterator++;
2662            return static_cast<gig::Region*>( (RegionsIterator != pRegions->end()) ? *RegionsIterator : NULL );
2663        }
2664    
2665        Region* Instrument::AddRegion() {
2666            // create new Region object (and its RIFF chunks)
2667            RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
2668            if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
2669            RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
2670            Region* pNewRegion = new Region(this, rgn);
2671            pRegions->push_back(pNewRegion);
2672            Regions = pRegions->size();
2673            // update Region key table for fast lookup
2674            UpdateRegionKeyTable();
2675            // done
2676            return pNewRegion;
2677        }
2678    
2679        void Instrument::DeleteRegion(Region* pRegion) {
2680            if (!pRegions) return;
2681            DLS::Instrument::DeleteRegion((DLS::Region*) pRegion);
2682            // update Region key table for fast lookup
2683            UpdateRegionKeyTable();
2684        }
2685    
2686    
2687    
2688    // *************** Group ***************
2689    // *
2690    
2691        /** @brief Constructor.
2692         *
2693         * @param file   - pointer to the RIFF::File object of this .gig file
2694         * @param ck3gnm - pointer to 3gnm chunk associated with this group
2695         */
2696        Group::Group(RIFF::File* file, RIFF::Chunk* ck3gnm) {
2697            pFile      = file;
2698            pNameChunk = ck3gnm;
2699            ::LoadString(pNameChunk, Name);
2700        }
2701    
2702        Group::~Group() {
2703        }
2704    
2705        /** @brief Update chunks with current group settings.
2706         *
2707         * Apply current Group field values to the respective. You have to call
2708         * File::Save() to make changes persistent.
2709         */
2710        void Group::UpdateChunks() {
2711            // make sure <3gri> and <3gnl> list chunks exist
2712            RIFF::List* _3gri = pFile->GetSubList(LIST_TYPE_3GRI);
2713            if (!_3gri) _3gri = pFile->AddSubList(LIST_TYPE_3GRI);
2714            RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
2715            if (!_3gnl) _3gnl = pFile->AddSubList(LIST_TYPE_3GNL);
2716            // now store the name of this group as <3gnm> chunk as subchunk of the <3gnl> list chunk
2717            ::SaveString(CHUNK_ID_3GNM, pNameChunk, _3gnl, Name, String("Unnamed Group"), true, 64);
2718      }      }
2719    
2720    
# Line 1652  namespace gig { namespace { Line 2722  namespace gig { namespace {
2722  // *************** File ***************  // *************** File ***************
2723  // *  // *
2724    
2725        File::File() : DLS::File() {
2726            pGroups = NULL;
2727            pInfo->UseFixedLengthStrings = true;
2728        }
2729    
2730      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {
2731          pSamples     = NULL;          pGroups = NULL;
2732          pInstruments = NULL;          pInfo->UseFixedLengthStrings = true;
2733      }      }
2734    
2735      File::~File() {      File::~File() {
2736          // free samples          if (pGroups) {
2737          if (pSamples) {              std::list<Group*>::iterator iter = pGroups->begin();
2738              SamplesIterator = pSamples->begin();              std::list<Group*>::iterator end  = pGroups->end();
2739              while (SamplesIterator != pSamples->end() ) {              while (iter != end) {
2740                  delete (*SamplesIterator);                  delete *iter;
2741                  SamplesIterator++;                  ++iter;
             }  
             pSamples->clear();  
             delete pSamples;  
   
         }  
         // free instruments  
         if (pInstruments) {  
             InstrumentsIterator = pInstruments->begin();  
             while (InstrumentsIterator != pInstruments->end() ) {  
                 delete (*InstrumentsIterator);  
                 InstrumentsIterator++;  
2742              }              }
2743              pInstruments->clear();              delete pGroups;
             delete pInstruments;  
2744          }          }
2745      }      }
2746    
2747      Sample* File::GetFirstSample() {      Sample* File::GetFirstSample(progress_t* pProgress) {
2748          if (!pSamples) LoadSamples();          if (!pSamples) LoadSamples(pProgress);
2749          if (!pSamples) return NULL;          if (!pSamples) return NULL;
2750          SamplesIterator = pSamples->begin();          SamplesIterator = pSamples->begin();
2751          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
# Line 1694  namespace gig { namespace { Line 2757  namespace gig { namespace {
2757          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
2758      }      }
2759    
2760        /** @brief Add a new sample.
2761         *
2762         * This will create a new Sample object for the gig file. You have to
2763         * call Save() to make this persistent to the file.
2764         *
2765         * @returns pointer to new Sample object
2766         */
2767        Sample* File::AddSample() {
2768           if (!pSamples) LoadSamples();
2769           __ensureMandatoryChunksExist();
2770           RIFF::List* wvpl = pRIFF->GetSubList(LIST_TYPE_WVPL);
2771           // create new Sample object and its respective 'wave' list chunk
2772           RIFF::List* wave = wvpl->AddSubList(LIST_TYPE_WAVE);
2773           Sample* pSample = new Sample(this, wave, 0 /*arbitrary value, we update offsets when we save*/);
2774           pSamples->push_back(pSample);
2775           return pSample;
2776        }
2777    
2778        /** @brief Delete a sample.
2779         *
2780         * This will delete the given Sample object from the gig file. You have
2781         * to call Save() to make this persistent to the file.
2782         *
2783         * @param pSample - sample to delete
2784         * @throws gig::Exception if given sample could not be found
2785         */
2786        void File::DeleteSample(Sample* pSample) {
2787            if (!pSamples || !pSamples->size()) throw gig::Exception("Could not delete sample as there are no samples");
2788            SampleList::iterator iter = find(pSamples->begin(), pSamples->end(), (DLS::Sample*) pSample);
2789            if (iter == pSamples->end()) throw gig::Exception("Could not delete sample, could not find given sample");
2790            pSamples->erase(iter);
2791            delete pSample;
2792        }
2793    
2794      void File::LoadSamples() {      void File::LoadSamples() {
2795          RIFF::List* wvpl = pRIFF->GetSubList(LIST_TYPE_WVPL);          LoadSamples(NULL);
2796          if (wvpl) {      }
2797              unsigned long wvplFileOffset = wvpl->GetFilePos();  
2798              RIFF::List* wave = wvpl->GetFirstSubList();      void File::LoadSamples(progress_t* pProgress) {
2799              while (wave) {          if (!pSamples) pSamples = new SampleList;
2800                  if (wave->GetListType() == LIST_TYPE_WAVE) {  
2801                      if (!pSamples) pSamples = new SampleList;          RIFF::File* file = pRIFF;
2802                      unsigned long waveFileOffset = wave->GetFilePos();  
2803                      pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset));          // just for progress calculation
2804            int iSampleIndex  = 0;
2805            int iTotalSamples = WavePoolCount;
2806    
2807            // check if samples should be loaded from extension files
2808            int lastFileNo = 0;
2809            for (int i = 0 ; i < WavePoolCount ; i++) {
2810                if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];
2811            }
2812            String name(pRIFF->GetFileName());
2813            int nameLen = name.length();
2814            char suffix[6];
2815            if (nameLen > 4 && name.substr(nameLen - 4) == ".gig") nameLen -= 4;
2816    
2817            for (int fileNo = 0 ; ; ) {
2818                RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);
2819                if (wvpl) {
2820                    unsigned long wvplFileOffset = wvpl->GetFilePos();
2821                    RIFF::List* wave = wvpl->GetFirstSubList();
2822                    while (wave) {
2823                        if (wave->GetListType() == LIST_TYPE_WAVE) {
2824                            // notify current progress
2825                            const float subprogress = (float) iSampleIndex / (float) iTotalSamples;
2826                            __notify_progress(pProgress, subprogress);
2827    
2828                            unsigned long waveFileOffset = wave->GetFilePos();
2829                            pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));
2830    
2831                            iSampleIndex++;
2832                        }
2833                        wave = wvpl->GetNextSubList();
2834                  }                  }
2835                  wave = wvpl->GetNextSubList();  
2836              }                  if (fileNo == lastFileNo) break;
2837    
2838                    // open extension file (*.gx01, *.gx02, ...)
2839                    fileNo++;
2840                    sprintf(suffix, ".gx%02d", fileNo);
2841                    name.replace(nameLen, 5, suffix);
2842                    file = new RIFF::File(name);
2843                    ExtensionFiles.push_back(file);
2844                } else break;
2845          }          }
2846          else throw gig::Exception("Mandatory <wvpl> chunk not found.");  
2847            __notify_progress(pProgress, 1.0); // notify done
2848      }      }
2849    
2850      Instrument* File::GetFirstInstrument() {      Instrument* File::GetFirstInstrument() {
2851          if (!pInstruments) LoadInstruments();          if (!pInstruments) LoadInstruments();
2852          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
2853          InstrumentsIterator = pInstruments->begin();          InstrumentsIterator = pInstruments->begin();
2854          return (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL;          return static_cast<gig::Instrument*>( (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL );
2855      }      }
2856    
2857      Instrument* File::GetNextInstrument() {      Instrument* File::GetNextInstrument() {
2858          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
2859          InstrumentsIterator++;          InstrumentsIterator++;
2860          return (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL;          return static_cast<gig::Instrument*>( (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL );
2861      }      }
2862    
2863      /**      /**
2864       * Returns the instrument with the given index.       * Returns the instrument with the given index.
2865       *       *
2866         * @param index     - number of the sought instrument (0..n)
2867         * @param pProgress - optional: callback function for progress notification
2868       * @returns  sought instrument or NULL if there's no such instrument       * @returns  sought instrument or NULL if there's no such instrument
2869       */       */
2870      Instrument* File::GetInstrument(uint index) {      Instrument* File::GetInstrument(uint index, progress_t* pProgress) {
2871          if (!pInstruments) LoadInstruments();          if (!pInstruments) {
2872                // TODO: hack - we simply load ALL samples here, it would have been done in the Region constructor anyway (ATM)
2873    
2874                // sample loading subtask
2875                progress_t subprogress;
2876                __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask
2877                __notify_progress(&subprogress, 0.0f);
2878                GetFirstSample(&subprogress); // now force all samples to be loaded
2879                __notify_progress(&subprogress, 1.0f);
2880    
2881                // instrument loading subtask
2882                if (pProgress && pProgress->callback) {
2883                    subprogress.__range_min = subprogress.__range_max;
2884                    subprogress.__range_max = pProgress->__range_max; // schedule remaining percentage for this subtask
2885                }
2886                __notify_progress(&subprogress, 0.0f);
2887                LoadInstruments(&subprogress);
2888                __notify_progress(&subprogress, 1.0f);
2889            }
2890          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
2891          InstrumentsIterator = pInstruments->begin();          InstrumentsIterator = pInstruments->begin();
2892          for (uint i = 0; InstrumentsIterator != pInstruments->end(); i++) {          for (uint i = 0; InstrumentsIterator != pInstruments->end(); i++) {
2893              if (i == index) return *InstrumentsIterator;              if (i == index) return static_cast<gig::Instrument*>( *InstrumentsIterator );
2894              InstrumentsIterator++;              InstrumentsIterator++;
2895          }          }
2896          return NULL;          return NULL;
2897      }      }
2898    
2899        /** @brief Add a new instrument definition.
2900         *
2901         * This will create a new Instrument object for the gig file. You have
2902         * to call Save() to make this persistent to the file.
2903         *
2904         * @returns pointer to new Instrument object
2905         */
2906        Instrument* File::AddInstrument() {
2907           if (!pInstruments) LoadInstruments();
2908           __ensureMandatoryChunksExist();
2909           RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
2910           RIFF::List* lstInstr = lstInstruments->AddSubList(LIST_TYPE_INS);
2911           Instrument* pInstrument = new Instrument(this, lstInstr);
2912           pInstruments->push_back(pInstrument);
2913           return pInstrument;
2914        }
2915    
2916        /** @brief Delete an instrument.
2917         *
2918         * This will delete the given Instrument object from the gig file. You
2919         * have to call Save() to make this persistent to the file.
2920         *
2921         * @param pInstrument - instrument to delete
2922         * @throws gig::Excption if given instrument could not be found
2923         */
2924        void File::DeleteInstrument(Instrument* pInstrument) {
2925            if (!pInstruments) throw gig::Exception("Could not delete instrument as there are no instruments");
2926            InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), (DLS::Instrument*) pInstrument);
2927            if (iter == pInstruments->end()) throw gig::Exception("Could not delete instrument, could not find given instrument");
2928            pInstruments->erase(iter);
2929            delete pInstrument;
2930        }
2931    
2932      void File::LoadInstruments() {      void File::LoadInstruments() {
2933            LoadInstruments(NULL);
2934        }
2935    
2936        void File::LoadInstruments(progress_t* pProgress) {
2937            if (!pInstruments) pInstruments = new InstrumentList;
2938          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
2939          if (lstInstruments) {          if (lstInstruments) {
2940                int iInstrumentIndex = 0;
2941              RIFF::List* lstInstr = lstInstruments->GetFirstSubList();              RIFF::List* lstInstr = lstInstruments->GetFirstSubList();
2942              while (lstInstr) {              while (lstInstr) {
2943                  if (lstInstr->GetListType() == LIST_TYPE_INS) {                  if (lstInstr->GetListType() == LIST_TYPE_INS) {
2944                      if (!pInstruments) pInstruments = new InstrumentList;                      // notify current progress
2945                      pInstruments->push_back(new Instrument(this, lstInstr));                      const float localProgress = (float) iInstrumentIndex / (float) Instruments;
2946                        __notify_progress(pProgress, localProgress);
2947    
2948                        // divide local progress into subprogress for loading current Instrument
2949                        progress_t subprogress;
2950                        __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);
2951    
2952                        pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));
2953    
2954                        iInstrumentIndex++;
2955                  }                  }
2956                  lstInstr = lstInstruments->GetNextSubList();                  lstInstr = lstInstruments->GetNextSubList();
2957              }              }
2958                __notify_progress(pProgress, 1.0); // notify done
2959            }
2960        }
2961    
2962        Group* File::GetFirstGroup() {
2963            if (!pGroups) LoadGroups();
2964            if (!pGroups) return NULL;
2965            GroupsIterator = pGroups->begin();
2966            return (GroupsIterator == pGroups->end()) ? NULL : *GroupsIterator;
2967        }
2968    
2969        Group* File::GetNextGroup() {
2970            if (!pGroups) return NULL;
2971            ++GroupsIterator;
2972            return (GroupsIterator == pGroups->end()) ? NULL : *GroupsIterator;
2973        }
2974    
2975        /**
2976         * Returns the group with the given index.
2977         *
2978         * @param index - number of the sought group (0..n)
2979         * @returns sought group or NULL if there's no such group
2980         */
2981        Group* File::GetGroup(uint index) {
2982            if (!pGroups) LoadGroups();
2983            if (!pGroups) return NULL;
2984            GroupsIterator = pGroups->begin();
2985            for (uint i = 0; GroupsIterator != pGroups->end(); i++) {
2986                if (i == index) return *GroupsIterator;
2987                ++GroupsIterator;
2988            }
2989            return NULL;
2990        }
2991    
2992        Group* File::AddGroup() {
2993            if (!pGroups) LoadGroups();
2994            if (!pGroups) pGroups = new std::list<Group*>;
2995            __ensureMandatoryChunksExist();
2996            Group* pGroup = new Group(pRIFF, NULL);
2997            pGroups->push_back(pGroup);
2998            return pGroup;
2999        }
3000    
3001        void File::DeleteGroup(Group* pGroup) {
3002            if (!pGroups) throw gig::Exception("Could not delete group as there are no groups");
3003            std::list<Group*>::iterator iter = find(pGroups->begin(), pGroups->end(), pGroup);
3004            if (iter == pGroups->end()) throw gig::Exception("Could not delete group, could not find given group");
3005            pGroups->erase(iter);
3006            delete pGroup;
3007        }
3008    
3009        void File::LoadGroups() {
3010            if (!pGroups) pGroups = new std::list<Group*>;
3011            RIFF::List* lst3gri = pRIFF->GetSubList(LIST_TYPE_3GRI);
3012            if (!lst3gri) return;
3013            RIFF::List* lst3gnl = lst3gri->GetSubList(LIST_TYPE_3GNL);
3014            if (!lst3gnl) return;
3015            {
3016                RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();
3017                while (ck) {
3018                    if (ck->GetChunkID() == CHUNK_ID_3GNM) {
3019                        pGroups->push_back(new Group(pRIFF, ck));
3020                    }
3021                    ck = lst3gnl->GetNextSubChunk();
3022                }
3023          }          }
         else throw gig::Exception("Mandatory <lins> list chunk not found.");  
3024      }      }
3025    
3026    
# Line 1767  namespace gig { namespace { Line 3035  namespace gig { namespace {
3035          std::cout << "gig::Exception: " << Message << std::endl;          std::cout << "gig::Exception: " << Message << std::endl;
3036      }      }
3037    
3038    
3039    // *************** functions ***************
3040    // *
3041    
3042        /**
3043         * Returns the name of this C++ library. This is usually "libgig" of
3044         * course. This call is equivalent to RIFF::libraryName() and
3045         * DLS::libraryName().
3046         */
3047        String libraryName() {
3048            return PACKAGE;
3049        }
3050    
3051        /**
3052         * Returns version of this C++ library. This call is equivalent to
3053         * RIFF::libraryVersion() and DLS::libraryVersion().
3054         */
3055        String libraryVersion() {
3056            return VERSION;
3057        }
3058    
3059  } // namespace gig  } // namespace gig

Legend:
Removed from v.384  
changed lines
  Added in v.929

  ViewVC Help
Powered by ViewVC