/[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 809 by schoenebeck, Tue Nov 22 11:26:55 2005 UTC revision 1713 by persson, Thu Mar 6 20:42:22 2008 UTC
# Line 1  Line 1 
1  /***************************************************************************  /***************************************************************************
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file loader library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003-2005 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2007 by Christian Schoenebeck                      *
6   *                              <cuse@users.sourceforge.net>               *   *                              <cuse@users.sourceforge.net>               *
7   *                                                                         *   *                                                                         *
8   *   This library is free software; you can redistribute it and/or modify  *   *   This library is free software; you can redistribute it and/or modify  *
# Line 25  Line 25 
25    
26  #include "helper.h"  #include "helper.h"
27    
28    #include <algorithm>
29  #include <math.h>  #include <math.h>
30  #include <iostream>  #include <iostream>
31    
# Line 51  Line 52 
52    
53  namespace gig {  namespace gig {
54    
 // *************** dimension_def_t ***************  
 // *  
   
     dimension_def_t& dimension_def_t::operator=(const dimension_def_t& arg) {  
         dimension  = arg.dimension;  
         bits       = arg.bits;  
         zones      = arg.zones;  
         split_type = arg.split_type;  
         ranges     = arg.ranges;  
         zone_size  = arg.zone_size;  
         if (ranges) {  
             ranges = new range_t[zones];  
             for (int i = 0; i < zones; i++)  
                 ranges[i] = arg.ranges[i];  
         }  
         return *this;  
     }  
   
   
   
55  // *************** progress_t ***************  // *************** progress_t ***************
56  // *  // *
57    
# Line 131  namespace { Line 112  namespace {
112          return x & 0x800000 ? x - 0x1000000 : x;          return x & 0x800000 ? x - 0x1000000 : x;
113      }      }
114    
115        inline void store24(unsigned char* pDst, int x)
116        {
117            pDst[0] = x;
118            pDst[1] = x >> 8;
119            pDst[2] = x >> 16;
120        }
121    
122      void Decompress16(int compressionmode, const unsigned char* params,      void Decompress16(int compressionmode, const unsigned char* params,
123                        int srcStep, int dstStep,                        int srcStep, int dstStep,
124                        const unsigned char* pSrc, int16_t* pDst,                        const unsigned char* pSrc, int16_t* pDst,
# Line 170  namespace { Line 158  namespace {
158      }      }
159    
160      void Decompress24(int compressionmode, const unsigned char* params,      void Decompress24(int compressionmode, const unsigned char* params,
161                        int dstStep, const unsigned char* pSrc, int16_t* pDst,                        int dstStep, const unsigned char* pSrc, uint8_t* pDst,
162                        unsigned long currentframeoffset,                        unsigned long currentframeoffset,
163                        unsigned long copysamples, int truncatedBits)                        unsigned long copysamples, int truncatedBits)
164      {      {
         // Note: The 24 bits are truncated to 16 bits for now.  
   
165          int y, dy, ddy, dddy;          int y, dy, ddy, dddy;
         const int shift = 8 - truncatedBits;  
166    
167  #define GET_PARAMS(params)                      \  #define GET_PARAMS(params)                      \
168          y    = get24(params);                   \          y    = get24(params);                   \
# Line 193  namespace { Line 178  namespace {
178    
179  #define COPY_ONE(x)                             \  #define COPY_ONE(x)                             \
180          SKIP_ONE(x);                            \          SKIP_ONE(x);                            \
181          *pDst = y >> shift;                     \          store24(pDst, y << truncatedBits);      \
182          pDst += dstStep          pDst += dstStep
183    
184          switch (compressionmode) {          switch (compressionmode) {
185              case 2: // 24 bit uncompressed              case 2: // 24 bit uncompressed
186                  pSrc += currentframeoffset * 3;                  pSrc += currentframeoffset * 3;
187                  while (copysamples) {                  while (copysamples) {
188                      *pDst = get24(pSrc) >> shift;                      store24(pDst, get24(pSrc) << truncatedBits);
189                      pDst += dstStep;                      pDst += dstStep;
190                      pSrc += 3;                      pSrc += 3;
191                      copysamples--;                      copysamples--;
# Line 270  namespace { Line 255  namespace {
255  }  }
256    
257    
258    
259    // *************** Internal CRC-32 (Cyclic Redundancy Check) functions  ***************
260    // *
261    
262        static uint32_t* __initCRCTable() {
263            static uint32_t res[256];
264    
265            for (int i = 0 ; i < 256 ; i++) {
266                uint32_t c = i;
267                for (int j = 0 ; j < 8 ; j++) {
268                    c = (c & 1) ? 0xedb88320 ^ (c >> 1) : c >> 1;
269                }
270                res[i] = c;
271            }
272            return res;
273        }
274    
275        static const uint32_t* __CRCTable = __initCRCTable();
276    
277        /**
278         * Initialize a CRC variable.
279         *
280         * @param crc - variable to be initialized
281         */
282        inline static void __resetCRC(uint32_t& crc) {
283            crc = 0xffffffff;
284        }
285    
286        /**
287         * Used to calculate checksums of the sample data in a gig file. The
288         * checksums are stored in the 3crc chunk of the gig file and
289         * automatically updated when a sample is written with Sample::Write().
290         *
291         * One should call __resetCRC() to initialize the CRC variable to be
292         * used before calling this function the first time.
293         *
294         * After initializing the CRC variable one can call this function
295         * arbitrary times, i.e. to split the overall CRC calculation into
296         * steps.
297         *
298         * Once the whole data was processed by __calculateCRC(), one should
299         * call __encodeCRC() to get the final CRC result.
300         *
301         * @param buf     - pointer to data the CRC shall be calculated of
302         * @param bufSize - size of the data to be processed
303         * @param crc     - variable the CRC sum shall be stored to
304         */
305        static void __calculateCRC(unsigned char* buf, int bufSize, uint32_t& crc) {
306            for (int i = 0 ; i < bufSize ; i++) {
307                crc = __CRCTable[(crc ^ buf[i]) & 0xff] ^ (crc >> 8);
308            }
309        }
310    
311        /**
312         * Returns the final CRC result.
313         *
314         * @param crc - variable previously passed to __calculateCRC()
315         */
316        inline static uint32_t __encodeCRC(const uint32_t& crc) {
317            return crc ^ 0xffffffff;
318        }
319    
320    
321    
322    // *************** Other Internal functions  ***************
323    // *
324    
325        static split_type_t __resolveSplitType(dimension_t dimension) {
326            return (
327                dimension == dimension_layer ||
328                dimension == dimension_samplechannel ||
329                dimension == dimension_releasetrigger ||
330                dimension == dimension_keyboard ||
331                dimension == dimension_roundrobin ||
332                dimension == dimension_random ||
333                dimension == dimension_smartmidi ||
334                dimension == dimension_roundrobinkeyboard
335            ) ? split_type_bit : split_type_normal;
336        }
337    
338        static int __resolveZoneSize(dimension_def_t& dimension_definition) {
339            return (dimension_definition.split_type == split_type_normal)
340            ? int(128.0 / dimension_definition.zones) : 0;
341        }
342    
343    
344    
345  // *************** Sample ***************  // *************** Sample ***************
346  // *  // *
347    
# Line 295  namespace { Line 367  namespace {
367       *                         is located, 0 otherwise       *                         is located, 0 otherwise
368       */       */
369      Sample::Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {      Sample::Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {
370            static const DLS::Info::string_length_t fixedStringLengths[] = {
371                { CHUNK_ID_INAM, 64 },
372                { 0, 0 }
373            };
374            pInfo->SetFixedStringLengths(fixedStringLengths);
375          Instances++;          Instances++;
376          FileNo = fileNo;          FileNo = fileNo;
377    
378            __resetCRC(crc);
379    
380          pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);          pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);
381          if (pCk3gix) {          if (pCk3gix) {
382              SampleGroup = pCk3gix->ReadInt16();              uint16_t iSampleGroup = pCk3gix->ReadInt16();
383                pGroup = pFile->GetGroup(iSampleGroup);
384          } else { // '3gix' chunk missing          } else { // '3gix' chunk missing
385              // use default value(s)              // by default assigned to that mandatory "Default Group"
386              SampleGroup = 0;              pGroup = pFile->GetGroup(0);
387          }          }
388    
389          pCkSmpl = waveList->GetSubChunk(CHUNK_ID_SMPL);          pCkSmpl = waveList->GetSubChunk(CHUNK_ID_SMPL);
# Line 327  namespace { Line 407  namespace {
407              // use default values              // use default values
408              Manufacturer  = 0;              Manufacturer  = 0;
409              Product       = 0;              Product       = 0;
410              SamplePeriod  = 1 / SamplesPerSecond;              SamplePeriod  = uint32_t(1000000000.0 / SamplesPerSecond + 0.5);
411              MIDIUnityNote = 64;              MIDIUnityNote = 60;
412              FineTune      = 0;              FineTune      = 0;
413                SMPTEFormat   = smpte_format_no_offset;
414              SMPTEOffset   = 0;              SMPTEOffset   = 0;
415              Loops         = 0;              Loops         = 0;
416              LoopID        = 0;              LoopID        = 0;
417                LoopType      = loop_type_normal;
418              LoopStart     = 0;              LoopStart     = 0;
419              LoopEnd       = 0;              LoopEnd       = 0;
420              LoopFraction  = 0;              LoopFraction  = 0;
# Line 368  namespace { Line 450  namespace {
450          }          }
451          FrameOffset = 0; // just for streaming compressed samples          FrameOffset = 0; // just for streaming compressed samples
452    
453          LoopSize = LoopEnd - LoopStart;          LoopSize = LoopEnd - LoopStart + 1;
454      }      }
455    
456      /**      /**
# Line 378  namespace { Line 460  namespace {
460       * Usually there is absolutely no need to call this method explicitly.       * Usually there is absolutely no need to call this method explicitly.
461       * It will be called automatically when File::Save() was called.       * It will be called automatically when File::Save() was called.
462       *       *
463       * @throws DLS::Exception if FormatTag != WAVE_FORMAT_PCM or no sample data       * @throws DLS::Exception if FormatTag != DLS_WAVE_FORMAT_PCM or no sample data
464       *                        was provided yet       *                        was provided yet
465       * @throws gig::Exception if there is any invalid sample setting       * @throws gig::Exception if there is any invalid sample setting
466       */       */
# Line 388  namespace { Line 470  namespace {
470    
471          // make sure 'smpl' chunk exists          // make sure 'smpl' chunk exists
472          pCkSmpl = pWaveList->GetSubChunk(CHUNK_ID_SMPL);          pCkSmpl = pWaveList->GetSubChunk(CHUNK_ID_SMPL);
473          if (!pCkSmpl) pCkSmpl = pWaveList->AddSubChunk(CHUNK_ID_SMPL, 60);          if (!pCkSmpl) {
474                pCkSmpl = pWaveList->AddSubChunk(CHUNK_ID_SMPL, 60);
475                memset(pCkSmpl->LoadChunkData(), 0, 60);
476            }
477          // update 'smpl' chunk          // update 'smpl' chunk
478          uint8_t* pData = (uint8_t*) pCkSmpl->LoadChunkData();          uint8_t* pData = (uint8_t*) pCkSmpl->LoadChunkData();
479          SamplePeriod = 1 / SamplesPerSecond;          SamplePeriod = uint32_t(1000000000.0 / SamplesPerSecond + 0.5);
480          memcpy(&pData[0], &Manufacturer, 4);          store32(&pData[0], Manufacturer);
481          memcpy(&pData[4], &Product, 4);          store32(&pData[4], Product);
482          memcpy(&pData[8], &SamplePeriod, 4);          store32(&pData[8], SamplePeriod);
483          memcpy(&pData[12], &MIDIUnityNote, 4);          store32(&pData[12], MIDIUnityNote);
484          memcpy(&pData[16], &FineTune, 4);          store32(&pData[16], FineTune);
485          memcpy(&pData[20], &SMPTEFormat, 4);          store32(&pData[20], SMPTEFormat);
486          memcpy(&pData[24], &SMPTEOffset, 4);          store32(&pData[24], SMPTEOffset);
487          memcpy(&pData[28], &Loops, 4);          store32(&pData[28], Loops);
488    
489          // we skip 'manufByt' for now (4 bytes)          // we skip 'manufByt' for now (4 bytes)
490    
491          memcpy(&pData[36], &LoopID, 4);          store32(&pData[36], LoopID);
492          memcpy(&pData[40], &LoopType, 4);          store32(&pData[40], LoopType);
493          memcpy(&pData[44], &LoopStart, 4);          store32(&pData[44], LoopStart);
494          memcpy(&pData[48], &LoopEnd, 4);          store32(&pData[48], LoopEnd);
495          memcpy(&pData[52], &LoopFraction, 4);          store32(&pData[52], LoopFraction);
496          memcpy(&pData[56], &LoopPlayCount, 4);          store32(&pData[56], LoopPlayCount);
497    
498          // make sure '3gix' chunk exists          // make sure '3gix' chunk exists
499          pCk3gix = pWaveList->GetSubChunk(CHUNK_ID_3GIX);          pCk3gix = pWaveList->GetSubChunk(CHUNK_ID_3GIX);
500          if (!pCk3gix) pCk3gix = pWaveList->AddSubChunk(CHUNK_ID_3GIX, 4);          if (!pCk3gix) pCk3gix = pWaveList->AddSubChunk(CHUNK_ID_3GIX, 4);
501            // determine appropriate sample group index (to be stored in chunk)
502            uint16_t iSampleGroup = 0; // 0 refers to default sample group
503            File* pFile = static_cast<File*>(pParent);
504            if (pFile->pGroups) {
505                std::list<Group*>::iterator iter = pFile->pGroups->begin();
506                std::list<Group*>::iterator end  = pFile->pGroups->end();
507                for (int i = 0; iter != end; i++, iter++) {
508                    if (*iter == pGroup) {
509                        iSampleGroup = i;
510                        break; // found
511                    }
512                }
513            }
514          // update '3gix' chunk          // update '3gix' chunk
515          pData = (uint8_t*) pCk3gix->LoadChunkData();          pData = (uint8_t*) pCk3gix->LoadChunkData();
516          memcpy(&pData[0], &SampleGroup, 2);          store16(&pData[0], iSampleGroup);
517      }      }
518    
519      /// 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 636  namespace { Line 734  namespace {
734       * enlarged samples before calling File::Save() as this might exceed the       * enlarged samples before calling File::Save() as this might exceed the
735       * current sample's boundary!       * current sample's boundary!
736       *       *
737       * Also note: only WAVE_FORMAT_PCM is currently supported, that is       * Also note: only DLS_WAVE_FORMAT_PCM is currently supported, that is
738       * FormatTag must be WAVE_FORMAT_PCM. Trying to resize samples with       * FormatTag must be DLS_WAVE_FORMAT_PCM. Trying to resize samples with
739       * other formats will fail!       * other formats will fail!
740       *       *
741       * @param iNewSize - new sample wave data size in sample points (must be       * @param iNewSize - new sample wave data size in sample points (must be
742       *                   greater than zero)       *                   greater than zero)
743       * @throws DLS::Excecption if FormatTag != WAVE_FORMAT_PCM       * @throws DLS::Excecption if FormatTag != DLS_WAVE_FORMAT_PCM
744       *                         or if \a iNewSize is less than 1       *                         or if \a iNewSize is less than 1
745       * @throws gig::Exception if existing sample is compressed       * @throws gig::Exception if existing sample is compressed
746       * @see DLS::Sample::GetSize(), DLS::Sample::FrameSize,       * @see DLS::Sample::GetSize(), DLS::Sample::FrameSize,
# Line 742  namespace { Line 840  namespace {
840       * @param SampleCount      number of sample points to read       * @param SampleCount      number of sample points to read
841       * @param pPlaybackState   will be used to store and reload the playback       * @param pPlaybackState   will be used to store and reload the playback
842       *                         state for the next ReadAndLoop() call       *                         state for the next ReadAndLoop() call
843         * @param pDimRgn          dimension region with looping information
844       * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression       * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression
845       * @returns                number of successfully read sample points       * @returns                number of successfully read sample points
846       * @see                    CreateDecompressionBuffer()       * @see                    CreateDecompressionBuffer()
847       */       */
848      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,
849                                          DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer) {
850          unsigned long samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;          unsigned long samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;
851          uint8_t* pDst = (uint8_t*) pBuffer;          uint8_t* pDst = (uint8_t*) pBuffer;
852    
853          SetPos(pPlaybackState->position); // recover position from the last time          SetPos(pPlaybackState->position); // recover position from the last time
854    
855          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
856    
857              switch (this->LoopType) {              const DLS::sample_loop_t& loop = pDimRgn->pSampleLoops[0];
858                const uint32_t loopEnd = loop.LoopStart + loop.LoopLength;
859    
860                  case loop_type_bidirectional: { //TODO: not tested yet!              if (GetPos() <= loopEnd) {
861                      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  
862    
863                              // as we can only read forward from disk, we have to                      case loop_type_bidirectional: { //TODO: not tested yet!
864                              // determine the end position within the loop first,                          do {
865                              // read forward from that 'end' and finally after                              // if not endless loop check if max. number of loop cycles have been passed
866                              // reading, swap all sample frames so it reflects                              if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
867                              // backward playback  
868                                if (!pPlaybackState->reverse) { // forward playback
869                              unsigned long swapareastart       = totalreadsamples;                                  do {
870                              unsigned long loopoffset          = GetPos() - this->LoopStart;                                      samplestoloopend  = loopEnd - GetPos();
871                              unsigned long samplestoreadinloop = Min(samplestoread, loopoffset);                                      readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
872                              unsigned long reverseplaybackend  = GetPos() - samplestoreadinloop;                                      samplestoread    -= readsamples;
873                                        totalreadsamples += readsamples;
874                              SetPos(reverseplaybackend);                                      if (readsamples == samplestoloopend) {
875                                            pPlaybackState->reverse = true;
876                              // read samples for backward playback                                          break;
877                              do {                                      }
878                                  readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], samplestoreadinloop, pExternalDecompressionBuffer);                                  } while (samplestoread && readsamples);
879                                  samplestoreadinloop -= readsamples;                              }
880                                  samplestoread       -= readsamples;                              else { // backward playback
                                 totalreadsamples    += readsamples;  
                             } while (samplestoreadinloop && readsamples);  
881    
882                              SetPos(reverseplaybackend); // pretend we really read backwards                                  // as we can only read forward from disk, we have to
883                                    // determine the end position within the loop first,
884                                    // read forward from that 'end' and finally after
885                                    // reading, swap all sample frames so it reflects
886                                    // backward playback
887    
888                                    unsigned long swapareastart       = totalreadsamples;
889                                    unsigned long loopoffset          = GetPos() - loop.LoopStart;
890                                    unsigned long samplestoreadinloop = Min(samplestoread, loopoffset);
891                                    unsigned long reverseplaybackend  = GetPos() - samplestoreadinloop;
892    
893                                    SetPos(reverseplaybackend);
894    
895                                    // read samples for backward playback
896                                    do {
897                                        readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], samplestoreadinloop, pExternalDecompressionBuffer);
898                                        samplestoreadinloop -= readsamples;
899                                        samplestoread       -= readsamples;
900                                        totalreadsamples    += readsamples;
901                                    } while (samplestoreadinloop && readsamples);
902    
903                                    SetPos(reverseplaybackend); // pretend we really read backwards
904    
905                                    if (reverseplaybackend == loop.LoopStart) {
906                                        pPlaybackState->loop_cycles_left--;
907                                        pPlaybackState->reverse = false;
908                                    }
909    
910                              if (reverseplaybackend == this->LoopStart) {                                  // reverse the sample frames for backward playback
911                                  pPlaybackState->loop_cycles_left--;                                  SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
                                 pPlaybackState->reverse = false;  
912                              }                              }
913                            } while (samplestoread && readsamples);
914                            break;
915                        }
916    
917                              // reverse the sample frames for backward playback                      case loop_type_backward: { // TODO: not tested yet!
918                              SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);                          // forward playback (not entered the loop yet)
919                          }                          if (!pPlaybackState->reverse) do {
920                      } while (samplestoread && readsamples);                              samplestoloopend  = loopEnd - GetPos();
921                      break;                              readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
922                  }                              samplestoread    -= readsamples;
923                                totalreadsamples += readsamples;
924                  case loop_type_backward: { // TODO: not tested yet!                              if (readsamples == samplestoloopend) {
925                      // forward playback (not entered the loop yet)                                  pPlaybackState->reverse = true;
926                      if (!pPlaybackState->reverse) do {                                  break;
927                          samplestoloopend  = this->LoopEnd - GetPos();                              }
928                          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);  
929    
930                      if (!samplestoread) break;                          if (!samplestoread) break;
931    
932                      // as we can only read forward from disk, we have to                          // as we can only read forward from disk, we have to
933                      // determine the end position within the loop first,                          // determine the end position within the loop first,
934                      // read forward from that 'end' and finally after                          // read forward from that 'end' and finally after
935                      // reading, swap all sample frames so it reflects                          // reading, swap all sample frames so it reflects
936                      // backward playback                          // backward playback
937    
938                      unsigned long swapareastart       = totalreadsamples;                          unsigned long swapareastart       = totalreadsamples;
939                      unsigned long loopoffset          = GetPos() - this->LoopStart;                          unsigned long loopoffset          = GetPos() - loop.LoopStart;
940                      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)
941                                                                                : samplestoread;                                                                                    : samplestoread;
942                      unsigned long reverseplaybackend  = this->LoopStart + Abs((loopoffset - samplestoreadinloop) % this->LoopSize);                          unsigned long reverseplaybackend  = loop.LoopStart + Abs((loopoffset - samplestoreadinloop) % loop.LoopLength);
943    
944                      SetPos(reverseplaybackend);                          SetPos(reverseplaybackend);
945    
946                      // read samples for backward playback                          // read samples for backward playback
947                      do {                          do {
948                          // 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
949                          if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;                              if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
950                          samplestoloopend     = this->LoopEnd - GetPos();                              samplestoloopend     = loopEnd - GetPos();
951                          readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoreadinloop, samplestoloopend), pExternalDecompressionBuffer);                              readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoreadinloop, samplestoloopend), pExternalDecompressionBuffer);
952                          samplestoreadinloop -= readsamples;                              samplestoreadinloop -= readsamples;
953                          samplestoread       -= readsamples;                              samplestoread       -= readsamples;
954                          totalreadsamples    += readsamples;                              totalreadsamples    += readsamples;
955                          if (readsamples == samplestoloopend) {                              if (readsamples == samplestoloopend) {
956                              pPlaybackState->loop_cycles_left--;                                  pPlaybackState->loop_cycles_left--;
957                              SetPos(this->LoopStart);                                  SetPos(loop.LoopStart);
958                          }                              }
959                      } while (samplestoreadinloop && readsamples);                          } while (samplestoreadinloop && readsamples);
960    
961                      SetPos(reverseplaybackend); // pretend we really read backwards                          SetPos(reverseplaybackend); // pretend we really read backwards
962    
963                      // reverse the sample frames for backward playback                          // reverse the sample frames for backward playback
964                      SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);                          SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
965                      break;                          break;
966                  }                      }
967    
968                  default: case loop_type_normal: {                      default: case loop_type_normal: {
969                      do {                          do {
970                          // 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
971                          if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;                              if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
972                          samplestoloopend  = this->LoopEnd - GetPos();                              samplestoloopend  = loopEnd - GetPos();
973                          readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);                              readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
974                          samplestoread    -= readsamples;                              samplestoread    -= readsamples;
975                          totalreadsamples += readsamples;                              totalreadsamples += readsamples;
976                          if (readsamples == samplestoloopend) {                              if (readsamples == samplestoloopend) {
977                              pPlaybackState->loop_cycles_left--;                                  pPlaybackState->loop_cycles_left--;
978                              SetPos(this->LoopStart);                                  SetPos(loop.LoopStart);
979                          }                              }
980                      } while (samplestoread && readsamples);                          } while (samplestoread && readsamples);
981                      break;                          break;
982                        }
983                  }                  }
984              }              }
985          }          }
# Line 904  namespace { Line 1009  namespace {
1009       * have to use an external decompression buffer for <b>EACH</b>       * have to use an external decompression buffer for <b>EACH</b>
1010       * streaming thread to avoid race conditions and crashes!       * streaming thread to avoid race conditions and crashes!
1011       *       *
1012         * For 16 bit samples, the data in the buffer will be int16_t
1013         * (using native endianness). For 24 bit, the buffer will
1014         * contain three bytes per sample, little-endian.
1015         *
1016       * @param pBuffer      destination buffer       * @param pBuffer      destination buffer
1017       * @param SampleCount  number of sample points to read       * @param SampleCount  number of sample points to read
1018       * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression       * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression
# Line 914  namespace { Line 1023  namespace {
1023          if (SampleCount == 0) return 0;          if (SampleCount == 0) return 0;
1024          if (!Compressed) {          if (!Compressed) {
1025              if (BitDepth == 24) {              if (BitDepth == 24) {
1026                  // 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);  
                 }  
1027              }              }
1028              else { // 16 bit              else { // 16 bit
1029                  // (pCkData->Read does endian correction)                  // (pCkData->Read does endian correction)
# Line 964  namespace { Line 1053  namespace {
1053    
1054              unsigned char* pSrc = (unsigned char*) pDecompressionBuffer->pStart;              unsigned char* pSrc = (unsigned char*) pDecompressionBuffer->pStart;
1055              int16_t* pDst = static_cast<int16_t*>(pBuffer);              int16_t* pDst = static_cast<int16_t*>(pBuffer);
1056                uint8_t* pDst24 = static_cast<uint8_t*>(pBuffer);
1057              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);
1058    
1059              while (remainingsamples && remainingbytes) {              while (remainingsamples && remainingbytes) {
# Line 1045  namespace { Line 1135  namespace {
1135                              const unsigned char* const param_r = pSrc;                              const unsigned char* const param_r = pSrc;
1136                              if (mode_r != 2) pSrc += 12;                              if (mode_r != 2) pSrc += 12;
1137    
1138                              Decompress24(mode_l, param_l, 2, pSrc, pDst,                              Decompress24(mode_l, param_l, 6, pSrc, pDst24,
1139                                           skipsamples, copysamples, TruncatedBits);                                           skipsamples, copysamples, TruncatedBits);
1140                              Decompress24(mode_r, param_r, 2, pSrc + rightChannelOffset, pDst + 1,                              Decompress24(mode_r, param_r, 6, pSrc + rightChannelOffset, pDst24 + 3,
1141                                           skipsamples, copysamples, TruncatedBits);                                           skipsamples, copysamples, TruncatedBits);
1142                              pDst += copysamples << 1;                              pDst24 += copysamples * 6;
1143                          }                          }
1144                          else { // Mono                          else { // Mono
1145                              Decompress24(mode_l, param_l, 1, pSrc, pDst,                              Decompress24(mode_l, param_l, 3, pSrc, pDst24,
1146                                           skipsamples, copysamples, TruncatedBits);                                           skipsamples, copysamples, TruncatedBits);
1147                              pDst += copysamples;                              pDst24 += copysamples * 3;
1148                          }                          }
1149                      }                      }
1150                      else { // 16 bit                      else { // 16 bit
# Line 1108  namespace { Line 1198  namespace {
1198       *       *
1199       * Note: there is currently no support for writing compressed samples.       * Note: there is currently no support for writing compressed samples.
1200       *       *
1201         * For 16 bit samples, the data in the source buffer should be
1202         * int16_t (using native endianness). For 24 bit, the buffer
1203         * should contain three bytes per sample, little-endian.
1204         *
1205       * @param pBuffer     - source buffer       * @param pBuffer     - source buffer
1206       * @param SampleCount - number of sample points to write       * @param SampleCount - number of sample points to write
1207       * @throws DLS::Exception if current sample size is too small       * @throws DLS::Exception if current sample size is too small
# Line 1116  namespace { Line 1210  namespace {
1210       */       */
1211      unsigned long Sample::Write(void* pBuffer, unsigned long SampleCount) {      unsigned long Sample::Write(void* pBuffer, unsigned long SampleCount) {
1212          if (Compressed) throw gig::Exception("There is no support for writing compressed gig samples (yet)");          if (Compressed) throw gig::Exception("There is no support for writing compressed gig samples (yet)");
1213          return DLS::Sample::Write(pBuffer, SampleCount);  
1214            // if this is the first write in this sample, reset the
1215            // checksum calculator
1216            if (pCkData->GetPos() == 0) {
1217                __resetCRC(crc);
1218            }
1219            if (GetSize() < SampleCount) throw Exception("Could not write sample data, current sample size to small");
1220            unsigned long res;
1221            if (BitDepth == 24) {
1222                res = pCkData->Write(pBuffer, SampleCount * FrameSize, 1) / FrameSize;
1223            } else { // 16 bit
1224                res = Channels == 2 ? pCkData->Write(pBuffer, SampleCount << 1, 2) >> 1
1225                                    : pCkData->Write(pBuffer, SampleCount, 2);
1226            }
1227            __calculateCRC((unsigned char *)pBuffer, SampleCount * FrameSize, crc);
1228    
1229            // if this is the last write, update the checksum chunk in the
1230            // file
1231            if (pCkData->GetPos() == pCkData->GetSize()) {
1232                File* pFile = static_cast<File*>(GetParent());
1233                pFile->SetSampleChecksum(this, __encodeCRC(crc));
1234            }
1235            return res;
1236      }      }
1237    
1238      /**      /**
# Line 1161  namespace { Line 1277  namespace {
1277          }          }
1278      }      }
1279    
1280        /**
1281         * Returns pointer to the Group this Sample belongs to. In the .gig
1282         * format a sample always belongs to one group. If it wasn't explicitly
1283         * assigned to a certain group, it will be automatically assigned to a
1284         * default group.
1285         *
1286         * @returns Sample's Group (never NULL)
1287         */
1288        Group* Sample::GetGroup() const {
1289            return pGroup;
1290        }
1291    
1292      Sample::~Sample() {      Sample::~Sample() {
1293          Instances--;          Instances--;
1294          if (!Instances && InternalDecompressionBuffer.Size) {          if (!Instances && InternalDecompressionBuffer.Size) {
# Line 1180  namespace { Line 1308  namespace {
1308      uint                               DimensionRegion::Instances       = 0;      uint                               DimensionRegion::Instances       = 0;
1309      DimensionRegion::VelocityTableMap* DimensionRegion::pVelocityTables = NULL;      DimensionRegion::VelocityTableMap* DimensionRegion::pVelocityTables = NULL;
1310    
1311      DimensionRegion::DimensionRegion(RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {      DimensionRegion::DimensionRegion(Region* pParent, RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {
1312          Instances++;          Instances++;
1313    
1314          memcpy(&Crossfade, &SamplerOptions, 4);          pSample = NULL;
1315            pRegion = pParent;
1316    
1317            if (_3ewl->GetSubChunk(CHUNK_ID_WSMP)) memcpy(&Crossfade, &SamplerOptions, 4);
1318            else memset(&Crossfade, 0, 4);
1319    
1320          if (!pVelocityTables) pVelocityTables = new VelocityTableMap;          if (!pVelocityTables) pVelocityTables = new VelocityTableMap;
1321    
1322          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);
1323          if (_3ewa) { // if '3ewa' chunk exists          if (_3ewa) { // if '3ewa' chunk exists
1324              _3ewa->ReadInt32(); // unknown, always 0x0000008C ?              _3ewa->ReadInt32(); // unknown, always == chunk size ?
1325              LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1326              EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1327              _3ewa->ReadInt16(); // unknown              _3ewa->ReadInt16(); // unknown
# Line 1333  namespace { Line 1466  namespace {
1466                  if (lfo3ctrl & 0x40) // bit 6                  if (lfo3ctrl & 0x40) // bit 6
1467                      VCFType = vcf_type_lowpassturbo;                      VCFType = vcf_type_lowpassturbo;
1468              }              }
1469                if (_3ewa->RemainingBytes() >= 8) {
1470                    _3ewa->Read(DimensionUpperLimits, 1, 8);
1471                } else {
1472                    memset(DimensionUpperLimits, 0, 8);
1473                }
1474          } else { // '3ewa' chunk does not exist yet          } else { // '3ewa' chunk does not exist yet
1475              // use default values              // use default values
1476              LFO3Frequency                   = 1.0;              LFO3Frequency                   = 1.0;
# Line 1342  namespace { Line 1480  namespace {
1480              LFO1ControlDepth                = 0;              LFO1ControlDepth                = 0;
1481              LFO3ControlDepth                = 0;              LFO3ControlDepth                = 0;
1482              EG1Attack                       = 0.0;              EG1Attack                       = 0.0;
1483              EG1Decay1                       = 0.0;              EG1Decay1                       = 0.005;
1484              EG1Sustain                      = 0;              EG1Sustain                      = 1000;
1485              EG1Release                      = 0.0;              EG1Release                      = 0.3;
1486              EG1Controller.type              = eg1_ctrl_t::type_none;              EG1Controller.type              = eg1_ctrl_t::type_none;
1487              EG1Controller.controller_number = 0;              EG1Controller.controller_number = 0;
1488              EG1ControllerInvert             = false;              EG1ControllerInvert             = false;
# Line 1359  namespace { Line 1497  namespace {
1497              EG2ControllerReleaseInfluence   = 0;              EG2ControllerReleaseInfluence   = 0;
1498              LFO1Frequency                   = 1.0;              LFO1Frequency                   = 1.0;
1499              EG2Attack                       = 0.0;              EG2Attack                       = 0.0;
1500              EG2Decay1                       = 0.0;              EG2Decay1                       = 0.005;
1501              EG2Sustain                      = 0;              EG2Sustain                      = 1000;
1502              EG2Release                      = 0.0;              EG2Release                      = 0.3;
1503              LFO2ControlDepth                = 0;              LFO2ControlDepth                = 0;
1504              LFO2Frequency                   = 1.0;              LFO2Frequency                   = 1.0;
1505              LFO2InternalDepth               = 0;              LFO2InternalDepth               = 0;
1506              EG1Decay2                       = 0.0;              EG1Decay2                       = 0.0;
1507              EG1InfiniteSustain              = false;              EG1InfiniteSustain              = true;
1508              EG1PreAttack                    = 1000;              EG1PreAttack                    = 0;
1509              EG2Decay2                       = 0.0;              EG2Decay2                       = 0.0;
1510              EG2InfiniteSustain              = false;              EG2InfiniteSustain              = true;
1511              EG2PreAttack                    = 1000;              EG2PreAttack                    = 0;
1512              VelocityResponseCurve           = curve_type_nonlinear;              VelocityResponseCurve           = curve_type_nonlinear;
1513              VelocityResponseDepth           = 3;              VelocityResponseDepth           = 3;
1514              ReleaseVelocityResponseCurve    = curve_type_nonlinear;              ReleaseVelocityResponseCurve    = curve_type_nonlinear;
# Line 1413  namespace { Line 1551  namespace {
1551              VCFVelocityDynamicRange         = 0x04;              VCFVelocityDynamicRange         = 0x04;
1552              VCFVelocityCurve                = curve_type_linear;              VCFVelocityCurve                = curve_type_linear;
1553              VCFType                         = vcf_type_lowpass;              VCFType                         = vcf_type_lowpass;
1554                memset(DimensionUpperLimits, 127, 8);
1555          }          }
1556    
1557          pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,          pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,
1558                                                       VelocityResponseDepth,                                                       VelocityResponseDepth,
1559                                                       VelocityResponseCurveScaling);                                                       VelocityResponseCurveScaling);
1560    
1561          curve_type_t curveType = ReleaseVelocityResponseCurve;          pVelocityReleaseTable = GetReleaseVelocityTable(
1562          uint8_t depth = ReleaseVelocityResponseDepth;                                      ReleaseVelocityResponseCurve,
1563                                        ReleaseVelocityResponseDepth
1564                                    );
1565    
1566            pVelocityCutoffTable = GetCutoffVelocityTable(VCFVelocityCurve,
1567                                                          VCFVelocityDynamicRange,
1568                                                          VCFVelocityScale,
1569                                                          VCFCutoffController);
1570    
1571          // this models a strange behaviour or bug in GSt: two of the          SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));
1572          // velocity response curves for release time are not used even          VelocityTable = 0;
1573          // if specified, instead another curve is chosen.      }
         if ((curveType == curve_type_nonlinear && depth == 0) ||  
             (curveType == curve_type_special   && depth == 4)) {  
             curveType = curve_type_nonlinear;  
             depth = 3;  
         }  
         pVelocityReleaseTable = GetVelocityTable(curveType, depth, 0);  
1574    
1575          curveType = VCFVelocityCurve;      /*
1576          depth = VCFVelocityDynamicRange;       * Constructs a DimensionRegion by copying all parameters from
1577         * another DimensionRegion
1578         */
1579        DimensionRegion::DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src) : DLS::Sampler(_3ewl) {
1580            Instances++;
1581            *this = src; // default memberwise shallow copy of all parameters
1582            pParentList = _3ewl; // restore the chunk pointer
1583    
1584          // even stranger GSt: two of the velocity response curves for          // deep copy of owned structures
1585          // filter cutoff are not used, instead another special curve          if (src.VelocityTable) {
1586          // is chosen. This curve is not used anywhere else.              VelocityTable = new uint8_t[128];
1587          if ((curveType == curve_type_nonlinear && depth == 0) ||              for (int k = 0 ; k < 128 ; k++)
1588              (curveType == curve_type_special   && depth == 4)) {                  VelocityTable[k] = src.VelocityTable[k];
1589              curveType = curve_type_special;          }
1590              depth = 5;          if (src.pSampleLoops) {
1591                pSampleLoops = new DLS::sample_loop_t[src.SampleLoops];
1592                for (int k = 0 ; k < src.SampleLoops ; k++)
1593                    pSampleLoops[k] = src.pSampleLoops[k];
1594          }          }
1595          pVelocityCutoffTable = GetVelocityTable(curveType, depth,      }
                                                 VCFCutoffController <= vcf_cutoff_ctrl_none2 ? VCFVelocityScale : 0);  
1596    
1597        /**
1598         * Updates the respective member variable and updates @c SampleAttenuation
1599         * which depends on this value.
1600         */
1601        void DimensionRegion::SetGain(int32_t gain) {
1602            DLS::Sampler::SetGain(gain);
1603          SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));          SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));
1604      }      }
1605    
# Line 1460  namespace { Line 1614  namespace {
1614          // first update base class's chunk          // first update base class's chunk
1615          DLS::Sampler::UpdateChunks();          DLS::Sampler::UpdateChunks();
1616    
1617            RIFF::Chunk* wsmp = pParentList->GetSubChunk(CHUNK_ID_WSMP);
1618            uint8_t* pData = (uint8_t*) wsmp->LoadChunkData();
1619            pData[12] = Crossfade.in_start;
1620            pData[13] = Crossfade.in_end;
1621            pData[14] = Crossfade.out_start;
1622            pData[15] = Crossfade.out_end;
1623    
1624          // make sure '3ewa' chunk exists          // make sure '3ewa' chunk exists
1625          RIFF::Chunk* _3ewa = pParentList->GetSubChunk(CHUNK_ID_3EWA);          RIFF::Chunk* _3ewa = pParentList->GetSubChunk(CHUNK_ID_3EWA);
1626          if (!_3ewa)  _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, 140);          if (!_3ewa) {
1627          uint8_t* pData = (uint8_t*) _3ewa->LoadChunkData();              File* pFile = (File*) GetParent()->GetParent()->GetParent();
1628                bool version3 = pFile->pVersion && pFile->pVersion->major == 3;
1629                _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, version3 ? 148 : 140);
1630            }
1631            pData = (uint8_t*) _3ewa->LoadChunkData();
1632    
1633          // update '3ewa' chunk with DimensionRegion's current settings          // update '3ewa' chunk with DimensionRegion's current settings
1634    
1635          const uint32_t unknown = 0x0000008C; // unknown, always 0x0000008C ?          const uint32_t chunksize = _3ewa->GetNewSize();
1636          memcpy(&pData[0], &unknown, 4);          store32(&pData[0], chunksize); // unknown, always chunk size?
1637    
1638          const int32_t lfo3freq = (int32_t) GIG_EXP_ENCODE(LFO3Frequency);          const int32_t lfo3freq = (int32_t) GIG_EXP_ENCODE(LFO3Frequency);
1639          memcpy(&pData[4], &lfo3freq, 4);          store32(&pData[4], lfo3freq);
1640    
1641          const int32_t eg3attack = (int32_t) GIG_EXP_ENCODE(EG3Attack);          const int32_t eg3attack = (int32_t) GIG_EXP_ENCODE(EG3Attack);
1642          memcpy(&pData[4], &eg3attack, 4);          store32(&pData[8], eg3attack);
1643    
1644          // next 2 bytes unknown          // next 2 bytes unknown
1645    
1646          memcpy(&pData[10], &LFO1InternalDepth, 2);          store16(&pData[14], LFO1InternalDepth);
1647    
1648          // next 2 bytes unknown          // next 2 bytes unknown
1649    
1650          memcpy(&pData[14], &LFO3InternalDepth, 2);          store16(&pData[18], LFO3InternalDepth);
1651    
1652          // next 2 bytes unknown          // next 2 bytes unknown
1653    
1654          memcpy(&pData[18], &LFO1ControlDepth, 2);          store16(&pData[22], LFO1ControlDepth);
1655    
1656          // next 2 bytes unknown          // next 2 bytes unknown
1657    
1658          memcpy(&pData[22], &LFO3ControlDepth, 2);          store16(&pData[26], LFO3ControlDepth);
1659    
1660          const int32_t eg1attack = (int32_t) GIG_EXP_ENCODE(EG1Attack);          const int32_t eg1attack = (int32_t) GIG_EXP_ENCODE(EG1Attack);
1661          memcpy(&pData[24], &eg1attack, 4);          store32(&pData[28], eg1attack);
1662    
1663          const int32_t eg1decay1 = (int32_t) GIG_EXP_ENCODE(EG1Decay1);          const int32_t eg1decay1 = (int32_t) GIG_EXP_ENCODE(EG1Decay1);
1664          memcpy(&pData[28], &eg1decay1, 4);          store32(&pData[32], eg1decay1);
1665    
1666          // next 2 bytes unknown          // next 2 bytes unknown
1667    
1668          memcpy(&pData[34], &EG1Sustain, 2);          store16(&pData[38], EG1Sustain);
1669    
1670          const int32_t eg1release = (int32_t) GIG_EXP_ENCODE(EG1Release);          const int32_t eg1release = (int32_t) GIG_EXP_ENCODE(EG1Release);
1671          memcpy(&pData[36], &eg1release, 4);          store32(&pData[40], eg1release);
1672    
1673          const uint8_t eg1ctl = (uint8_t) EncodeLeverageController(EG1Controller);          const uint8_t eg1ctl = (uint8_t) EncodeLeverageController(EG1Controller);
1674          memcpy(&pData[40], &eg1ctl, 1);          pData[44] = eg1ctl;
1675    
1676          const uint8_t eg1ctrloptions =          const uint8_t eg1ctrloptions =
1677              (EG1ControllerInvert) ? 0x01 : 0x00 |              (EG1ControllerInvert ? 0x01 : 0x00) |
1678              GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG1ControllerAttackInfluence) |              GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG1ControllerAttackInfluence) |
1679              GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG1ControllerDecayInfluence) |              GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG1ControllerDecayInfluence) |
1680              GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG1ControllerReleaseInfluence);              GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG1ControllerReleaseInfluence);
1681          memcpy(&pData[41], &eg1ctrloptions, 1);          pData[45] = eg1ctrloptions;
1682    
1683          const uint8_t eg2ctl = (uint8_t) EncodeLeverageController(EG2Controller);          const uint8_t eg2ctl = (uint8_t) EncodeLeverageController(EG2Controller);
1684          memcpy(&pData[42], &eg2ctl, 1);          pData[46] = eg2ctl;
1685    
1686          const uint8_t eg2ctrloptions =          const uint8_t eg2ctrloptions =
1687              (EG2ControllerInvert) ? 0x01 : 0x00 |              (EG2ControllerInvert ? 0x01 : 0x00) |
1688              GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG2ControllerAttackInfluence) |              GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG2ControllerAttackInfluence) |
1689              GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG2ControllerDecayInfluence) |              GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG2ControllerDecayInfluence) |
1690              GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG2ControllerReleaseInfluence);              GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG2ControllerReleaseInfluence);
1691          memcpy(&pData[43], &eg2ctrloptions, 1);          pData[47] = eg2ctrloptions;
1692    
1693          const int32_t lfo1freq = (int32_t) GIG_EXP_ENCODE(LFO1Frequency);          const int32_t lfo1freq = (int32_t) GIG_EXP_ENCODE(LFO1Frequency);
1694          memcpy(&pData[44], &lfo1freq, 4);          store32(&pData[48], lfo1freq);
1695    
1696          const int32_t eg2attack = (int32_t) GIG_EXP_ENCODE(EG2Attack);          const int32_t eg2attack = (int32_t) GIG_EXP_ENCODE(EG2Attack);
1697          memcpy(&pData[48], &eg2attack, 4);          store32(&pData[52], eg2attack);
1698    
1699          const int32_t eg2decay1 = (int32_t) GIG_EXP_ENCODE(EG2Decay1);          const int32_t eg2decay1 = (int32_t) GIG_EXP_ENCODE(EG2Decay1);
1700          memcpy(&pData[52], &eg2decay1, 4);          store32(&pData[56], eg2decay1);
1701    
1702          // next 2 bytes unknown          // next 2 bytes unknown
1703    
1704          memcpy(&pData[58], &EG2Sustain, 2);          store16(&pData[62], EG2Sustain);
1705    
1706          const int32_t eg2release = (int32_t) GIG_EXP_ENCODE(EG2Release);          const int32_t eg2release = (int32_t) GIG_EXP_ENCODE(EG2Release);
1707          memcpy(&pData[60], &eg2release, 4);          store32(&pData[64], eg2release);
1708    
1709          // next 2 bytes unknown          // next 2 bytes unknown
1710    
1711          memcpy(&pData[66], &LFO2ControlDepth, 2);          store16(&pData[70], LFO2ControlDepth);
1712    
1713          const int32_t lfo2freq = (int32_t) GIG_EXP_ENCODE(LFO2Frequency);          const int32_t lfo2freq = (int32_t) GIG_EXP_ENCODE(LFO2Frequency);
1714          memcpy(&pData[68], &lfo2freq, 4);          store32(&pData[72], lfo2freq);
1715    
1716          // next 2 bytes unknown          // next 2 bytes unknown
1717    
1718          memcpy(&pData[72], &LFO2InternalDepth, 2);          store16(&pData[78], LFO2InternalDepth);
1719    
1720          const int32_t eg1decay2 = (int32_t) (EG1InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG1Decay2);          const int32_t eg1decay2 = (int32_t) (EG1InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG1Decay2);
1721          memcpy(&pData[74], &eg1decay2, 4);          store32(&pData[80], eg1decay2);
1722    
1723          // next 2 bytes unknown          // next 2 bytes unknown
1724    
1725          memcpy(&pData[80], &EG1PreAttack, 2);          store16(&pData[86], EG1PreAttack);
1726    
1727          const int32_t eg2decay2 = (int32_t) (EG2InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG2Decay2);          const int32_t eg2decay2 = (int32_t) (EG2InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG2Decay2);
1728          memcpy(&pData[82], &eg2decay2, 4);          store32(&pData[88], eg2decay2);
1729    
1730          // next 2 bytes unknown          // next 2 bytes unknown
1731    
1732          memcpy(&pData[88], &EG2PreAttack, 2);          store16(&pData[94], EG2PreAttack);
1733    
1734          {          {
1735              if (VelocityResponseDepth > 4) throw Exception("VelocityResponseDepth must be between 0 and 4");              if (VelocityResponseDepth > 4) throw Exception("VelocityResponseDepth must be between 0 and 4");
# Line 1582  namespace { Line 1747  namespace {
1747                  default:                  default:
1748                      throw Exception("Could not update DimensionRegion's chunk, unknown VelocityResponseCurve selected");                      throw Exception("Could not update DimensionRegion's chunk, unknown VelocityResponseCurve selected");
1749              }              }
1750              memcpy(&pData[90], &velocityresponse, 1);              pData[96] = velocityresponse;
1751          }          }
1752    
1753          {          {
# Line 1601  namespace { Line 1766  namespace {
1766                  default:                  default:
1767                      throw Exception("Could not update DimensionRegion's chunk, unknown ReleaseVelocityResponseCurve selected");                      throw Exception("Could not update DimensionRegion's chunk, unknown ReleaseVelocityResponseCurve selected");
1768              }              }
1769              memcpy(&pData[91], &releasevelocityresponse, 1);              pData[97] = releasevelocityresponse;
1770          }          }
1771    
1772          memcpy(&pData[92], &VelocityResponseCurveScaling, 1);          pData[98] = VelocityResponseCurveScaling;
1773    
1774          memcpy(&pData[93], &AttenuationControllerThreshold, 1);          pData[99] = AttenuationControllerThreshold;
1775    
1776          // next 4 bytes unknown          // next 4 bytes unknown
1777    
1778          memcpy(&pData[98], &SampleStartOffset, 2);          store16(&pData[104], SampleStartOffset);
1779    
1780          // next 2 bytes unknown          // next 2 bytes unknown
1781    
# Line 1629  namespace { Line 1794  namespace {
1794                  default:                  default:
1795                      throw Exception("Could not update DimensionRegion's chunk, unknown DimensionBypass selected");                      throw Exception("Could not update DimensionRegion's chunk, unknown DimensionBypass selected");
1796              }              }
1797              memcpy(&pData[102], &pitchTrackDimensionBypass, 1);              pData[108] = pitchTrackDimensionBypass;
1798          }          }
1799    
1800          const uint8_t pan = (Pan >= 0) ? Pan : ((-Pan) + 63); // signed 8 bit -> signed 7 bit          const uint8_t pan = (Pan >= 0) ? Pan : ((-Pan) + 63); // signed 8 bit -> signed 7 bit
1801          memcpy(&pData[103], &pan, 1);          pData[109] = pan;
1802    
1803          const uint8_t selfmask = (SelfMask) ? 0x01 : 0x00;          const uint8_t selfmask = (SelfMask) ? 0x01 : 0x00;
1804          memcpy(&pData[104], &selfmask, 1);          pData[110] = selfmask;
1805    
1806          // next byte unknown          // next byte unknown
1807    
# Line 1645  namespace { Line 1810  namespace {
1810              if (LFO3Sync) lfo3ctrl |= 0x20; // bit 5              if (LFO3Sync) lfo3ctrl |= 0x20; // bit 5
1811              if (InvertAttenuationController) lfo3ctrl |= 0x80; // bit 7              if (InvertAttenuationController) lfo3ctrl |= 0x80; // bit 7
1812              if (VCFType == vcf_type_lowpassturbo) lfo3ctrl |= 0x40; // bit 6              if (VCFType == vcf_type_lowpassturbo) lfo3ctrl |= 0x40; // bit 6
1813              memcpy(&pData[106], &lfo3ctrl, 1);              pData[112] = lfo3ctrl;
1814          }          }
1815    
1816          const uint8_t attenctl = EncodeLeverageController(AttenuationController);          const uint8_t attenctl = EncodeLeverageController(AttenuationController);
1817          memcpy(&pData[107], &attenctl, 1);          pData[113] = attenctl;
1818    
1819          {          {
1820              uint8_t lfo2ctrl = LFO2Controller & 0x07; // lower 3 bits              uint8_t lfo2ctrl = LFO2Controller & 0x07; // lower 3 bits
1821              if (LFO2FlipPhase) lfo2ctrl |= 0x80; // bit 7              if (LFO2FlipPhase) lfo2ctrl |= 0x80; // bit 7
1822              if (LFO2Sync)      lfo2ctrl |= 0x20; // bit 5              if (LFO2Sync)      lfo2ctrl |= 0x20; // bit 5
1823              if (VCFResonanceController != vcf_res_ctrl_none) lfo2ctrl |= 0x40; // bit 6              if (VCFResonanceController != vcf_res_ctrl_none) lfo2ctrl |= 0x40; // bit 6
1824              memcpy(&pData[108], &lfo2ctrl, 1);              pData[114] = lfo2ctrl;
1825          }          }
1826    
1827          {          {
# Line 1665  namespace { Line 1830  namespace {
1830              if (LFO1Sync)      lfo1ctrl |= 0x40; // bit 6              if (LFO1Sync)      lfo1ctrl |= 0x40; // bit 6
1831              if (VCFResonanceController != vcf_res_ctrl_none)              if (VCFResonanceController != vcf_res_ctrl_none)
1832                  lfo1ctrl |= GIG_VCF_RESONANCE_CTRL_ENCODE(VCFResonanceController);                  lfo1ctrl |= GIG_VCF_RESONANCE_CTRL_ENCODE(VCFResonanceController);
1833              memcpy(&pData[109], &lfo1ctrl, 1);              pData[115] = lfo1ctrl;
1834          }          }
1835    
1836          const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth          const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth
1837                                                    : uint16_t(((-EG3Depth) - 1) ^ 0xffff); /* binary complementary for negatives */                                                    : uint16_t(((-EG3Depth) - 1) ^ 0xffff); /* binary complementary for negatives */
1838          memcpy(&pData[110], &eg3depth, 1);          pData[116] = eg3depth;
1839    
1840          // next 2 bytes unknown          // next 2 bytes unknown
1841    
1842          const uint8_t channeloffset = ChannelOffset * 4;          const uint8_t channeloffset = ChannelOffset * 4;
1843          memcpy(&pData[113], &channeloffset, 1);          pData[120] = channeloffset;
1844    
1845          {          {
1846              uint8_t regoptions = 0;              uint8_t regoptions = 0;
1847              if (MSDecode)      regoptions |= 0x01; // bit 0              if (MSDecode)      regoptions |= 0x01; // bit 0
1848              if (SustainDefeat) regoptions |= 0x02; // bit 1              if (SustainDefeat) regoptions |= 0x02; // bit 1
1849              memcpy(&pData[114], &regoptions, 1);              pData[121] = regoptions;
1850          }          }
1851    
1852          // next 2 bytes unknown          // next 2 bytes unknown
1853    
1854          memcpy(&pData[117], &VelocityUpperLimit, 1);          pData[124] = VelocityUpperLimit;
1855    
1856          // next 3 bytes unknown          // next 3 bytes unknown
1857    
1858          memcpy(&pData[121], &ReleaseTriggerDecay, 1);          pData[128] = ReleaseTriggerDecay;
1859    
1860          // next 2 bytes unknown          // next 2 bytes unknown
1861    
1862          const uint8_t eg1hold = (EG1Hold) ? 0x80 : 0x00; // bit 7          const uint8_t eg1hold = (EG1Hold) ? 0x80 : 0x00; // bit 7
1863          memcpy(&pData[124], &eg1hold, 1);          pData[131] = eg1hold;
1864    
1865          const uint8_t vcfcutoff = (VCFEnabled) ? 0x80 : 0x00 |  /* bit 7 */          const uint8_t vcfcutoff = (VCFEnabled ? 0x80 : 0x00) |  /* bit 7 */
1866                                    (VCFCutoff)  ? 0x7f : 0x00;   /* lower 7 bits */                                    (VCFCutoff & 0x7f);   /* lower 7 bits */
1867          memcpy(&pData[125], &vcfcutoff, 1);          pData[132] = vcfcutoff;
1868    
1869          memcpy(&pData[126], &VCFCutoffController, 1);          pData[133] = VCFCutoffController;
1870    
1871          const uint8_t vcfvelscale = (VCFCutoffControllerInvert) ? 0x80 : 0x00 | /* bit 7 */          const uint8_t vcfvelscale = (VCFCutoffControllerInvert ? 0x80 : 0x00) | /* bit 7 */
1872                                      (VCFVelocityScale) ? 0x7f : 0x00; /* lower 7 bits */                                      (VCFVelocityScale & 0x7f); /* lower 7 bits */
1873          memcpy(&pData[127], &vcfvelscale, 1);          pData[134] = vcfvelscale;
1874    
1875          // next byte unknown          // next byte unknown
1876    
1877          const uint8_t vcfresonance = (VCFResonanceDynamic) ? 0x00 : 0x80 | /* bit 7 */          const uint8_t vcfresonance = (VCFResonanceDynamic ? 0x00 : 0x80) | /* bit 7 */
1878                                       (VCFResonance) ? 0x7f : 0x00; /* lower 7 bits */                                       (VCFResonance & 0x7f); /* lower 7 bits */
1879          memcpy(&pData[129], &vcfresonance, 1);          pData[136] = vcfresonance;
1880    
1881          const uint8_t vcfbreakpoint = (VCFKeyboardTracking) ? 0x80 : 0x00 | /* bit 7 */          const uint8_t vcfbreakpoint = (VCFKeyboardTracking ? 0x80 : 0x00) | /* bit 7 */
1882                                        (VCFKeyboardTrackingBreakpoint) ? 0x7f : 0x00; /* lower 7 bits */                                        (VCFKeyboardTrackingBreakpoint & 0x7f); /* lower 7 bits */
1883          memcpy(&pData[130], &vcfbreakpoint, 1);          pData[137] = vcfbreakpoint;
1884    
1885          const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 |          const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 |
1886                                      VCFVelocityCurve * 5;                                      VCFVelocityCurve * 5;
1887          memcpy(&pData[131], &vcfvelocity, 1);          pData[138] = vcfvelocity;
1888    
1889          const uint8_t vcftype = (VCFType == vcf_type_lowpassturbo) ? vcf_type_lowpass : VCFType;          const uint8_t vcftype = (VCFType == vcf_type_lowpassturbo) ? vcf_type_lowpass : VCFType;
1890          memcpy(&pData[132], &vcftype, 1);          pData[139] = vcftype;
1891    
1892            if (chunksize >= 148) {
1893                memcpy(&pData[140], DimensionUpperLimits, 8);
1894            }
1895        }
1896    
1897        double* DimensionRegion::GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth) {
1898            curve_type_t curveType = releaseVelocityResponseCurve;
1899            uint8_t depth = releaseVelocityResponseDepth;
1900            // this models a strange behaviour or bug in GSt: two of the
1901            // velocity response curves for release time are not used even
1902            // if specified, instead another curve is chosen.
1903            if ((curveType == curve_type_nonlinear && depth == 0) ||
1904                (curveType == curve_type_special   && depth == 4)) {
1905                curveType = curve_type_nonlinear;
1906                depth = 3;
1907            }
1908            return GetVelocityTable(curveType, depth, 0);
1909        }
1910    
1911        double* DimensionRegion::GetCutoffVelocityTable(curve_type_t vcfVelocityCurve,
1912                                                        uint8_t vcfVelocityDynamicRange,
1913                                                        uint8_t vcfVelocityScale,
1914                                                        vcf_cutoff_ctrl_t vcfCutoffController)
1915        {
1916            curve_type_t curveType = vcfVelocityCurve;
1917            uint8_t depth = vcfVelocityDynamicRange;
1918            // even stranger GSt: two of the velocity response curves for
1919            // filter cutoff are not used, instead another special curve
1920            // is chosen. This curve is not used anywhere else.
1921            if ((curveType == curve_type_nonlinear && depth == 0) ||
1922                (curveType == curve_type_special   && depth == 4)) {
1923                curveType = curve_type_special;
1924                depth = 5;
1925            }
1926            return GetVelocityTable(curveType, depth,
1927                                    (vcfCutoffController <= vcf_cutoff_ctrl_none2)
1928                                        ? vcfVelocityScale : 0);
1929      }      }
1930    
1931      // get the corresponding velocity table from the table map or create & calculate that table if it doesn't exist yet      // get the corresponding velocity table from the table map or create & calculate that table if it doesn't exist yet
# Line 1740  namespace { Line 1943  namespace {
1943          return table;          return table;
1944      }      }
1945    
1946        Region* DimensionRegion::GetParent() const {
1947            return pRegion;
1948        }
1949    
1950      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {
1951          leverage_ctrl_t decodedcontroller;          leverage_ctrl_t decodedcontroller;
1952          switch (EncodedController) {          switch (EncodedController) {
# Line 1947  namespace { Line 2154  namespace {
2154                      default:                      default:
2155                          throw gig::Exception("leverage controller number is not supported by the gig format");                          throw gig::Exception("leverage controller number is not supported by the gig format");
2156                  }                  }
2157                    break;
2158              default:              default:
2159                  throw gig::Exception("Unknown leverage controller type.");                  throw gig::Exception("Unknown leverage controller type.");
2160          }          }
# Line 1966  namespace { Line 2174  namespace {
2174              delete pVelocityTables;              delete pVelocityTables;
2175              pVelocityTables = NULL;              pVelocityTables = NULL;
2176          }          }
2177            if (VelocityTable) delete[] VelocityTable;
2178      }      }
2179    
2180      /**      /**
# Line 1991  namespace { Line 2200  namespace {
2200          return pVelocityCutoffTable[MIDIKeyVelocity];          return pVelocityCutoffTable[MIDIKeyVelocity];
2201      }      }
2202    
2203        /**
2204         * Updates the respective member variable and the lookup table / cache
2205         * that depends on this value.
2206         */
2207        void DimensionRegion::SetVelocityResponseCurve(curve_type_t curve) {
2208            pVelocityAttenuationTable =
2209                GetVelocityTable(
2210                    curve, VelocityResponseDepth, VelocityResponseCurveScaling
2211                );
2212            VelocityResponseCurve = curve;
2213        }
2214    
2215        /**
2216         * Updates the respective member variable and the lookup table / cache
2217         * that depends on this value.
2218         */
2219        void DimensionRegion::SetVelocityResponseDepth(uint8_t depth) {
2220            pVelocityAttenuationTable =
2221                GetVelocityTable(
2222                    VelocityResponseCurve, depth, VelocityResponseCurveScaling
2223                );
2224            VelocityResponseDepth = depth;
2225        }
2226    
2227        /**
2228         * Updates the respective member variable and the lookup table / cache
2229         * that depends on this value.
2230         */
2231        void DimensionRegion::SetVelocityResponseCurveScaling(uint8_t scaling) {
2232            pVelocityAttenuationTable =
2233                GetVelocityTable(
2234                    VelocityResponseCurve, VelocityResponseDepth, scaling
2235                );
2236            VelocityResponseCurveScaling = scaling;
2237        }
2238    
2239        /**
2240         * Updates the respective member variable and the lookup table / cache
2241         * that depends on this value.
2242         */
2243        void DimensionRegion::SetReleaseVelocityResponseCurve(curve_type_t curve) {
2244            pVelocityReleaseTable = GetReleaseVelocityTable(curve, ReleaseVelocityResponseDepth);
2245            ReleaseVelocityResponseCurve = curve;
2246        }
2247    
2248        /**
2249         * Updates the respective member variable and the lookup table / cache
2250         * that depends on this value.
2251         */
2252        void DimensionRegion::SetReleaseVelocityResponseDepth(uint8_t depth) {
2253            pVelocityReleaseTable = GetReleaseVelocityTable(ReleaseVelocityResponseCurve, depth);
2254            ReleaseVelocityResponseDepth = depth;
2255        }
2256    
2257        /**
2258         * Updates the respective member variable and the lookup table / cache
2259         * that depends on this value.
2260         */
2261        void DimensionRegion::SetVCFCutoffController(vcf_cutoff_ctrl_t controller) {
2262            pVelocityCutoffTable = GetCutoffVelocityTable(VCFVelocityCurve, VCFVelocityDynamicRange, VCFVelocityScale, controller);
2263            VCFCutoffController = controller;
2264        }
2265    
2266        /**
2267         * Updates the respective member variable and the lookup table / cache
2268         * that depends on this value.
2269         */
2270        void DimensionRegion::SetVCFVelocityCurve(curve_type_t curve) {
2271            pVelocityCutoffTable = GetCutoffVelocityTable(curve, VCFVelocityDynamicRange, VCFVelocityScale, VCFCutoffController);
2272            VCFVelocityCurve = curve;
2273        }
2274    
2275        /**
2276         * Updates the respective member variable and the lookup table / cache
2277         * that depends on this value.
2278         */
2279        void DimensionRegion::SetVCFVelocityDynamicRange(uint8_t range) {
2280            pVelocityCutoffTable = GetCutoffVelocityTable(VCFVelocityCurve, range, VCFVelocityScale, VCFCutoffController);
2281            VCFVelocityDynamicRange = range;
2282        }
2283    
2284        /**
2285         * Updates the respective member variable and the lookup table / cache
2286         * that depends on this value.
2287         */
2288        void DimensionRegion::SetVCFVelocityScale(uint8_t scaling) {
2289            pVelocityCutoffTable = GetCutoffVelocityTable(VCFVelocityCurve, VCFVelocityDynamicRange, scaling, VCFCutoffController);
2290            VCFVelocityScale = scaling;
2291        }
2292    
2293      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) {
2294    
2295          // line-segment approximations of the 15 velocity curves          // line-segment approximations of the 15 velocity curves
# Line 2074  namespace { Line 2373  namespace {
2373    
2374          // Actual Loading          // Actual Loading
2375    
2376            if (!file->GetAutoLoad()) return;
2377    
2378          LoadDimensionRegions(rgnList);          LoadDimensionRegions(rgnList);
2379    
2380          RIFF::Chunk* _3lnk = rgnList->GetSubChunk(CHUNK_ID_3LNK);          RIFF::Chunk* _3lnk = rgnList->GetSubChunk(CHUNK_ID_3LNK);
# Line 2082  namespace { Line 2383  namespace {
2383              for (int i = 0; i < dimensionBits; i++) {              for (int i = 0; i < dimensionBits; i++) {
2384                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());
2385                  uint8_t     bits      = _3lnk->ReadUint8();                  uint8_t     bits      = _3lnk->ReadUint8();
2386                  _3lnk->ReadUint8(); // probably the position of the dimension                  _3lnk->ReadUint8(); // bit position of the dimension (bits[0] + bits[1] + ... + bits[i-1])
2387                  _3lnk->ReadUint8(); // unknown                  _3lnk->ReadUint8(); // (1 << bit position of next dimension) - (1 << bit position of this dimension)
2388                  uint8_t     zones     = _3lnk->ReadUint8(); // new for v3: number of zones doesn't have to be == pow(2,bits)                  uint8_t     zones     = _3lnk->ReadUint8(); // new for v3: number of zones doesn't have to be == pow(2,bits)
2389                  if (dimension == dimension_none) { // inactive dimension                  if (dimension == dimension_none) { // inactive dimension
2390                      pDimensionDefinitions[i].dimension  = dimension_none;                      pDimensionDefinitions[i].dimension  = dimension_none;
2391                      pDimensionDefinitions[i].bits       = 0;                      pDimensionDefinitions[i].bits       = 0;
2392                      pDimensionDefinitions[i].zones      = 0;                      pDimensionDefinitions[i].zones      = 0;
2393                      pDimensionDefinitions[i].split_type = split_type_bit;                      pDimensionDefinitions[i].split_type = split_type_bit;
                     pDimensionDefinitions[i].ranges     = NULL;  
2394                      pDimensionDefinitions[i].zone_size  = 0;                      pDimensionDefinitions[i].zone_size  = 0;
2395                  }                  }
2396                  else { // active dimension                  else { // active dimension
2397                      pDimensionDefinitions[i].dimension = dimension;                      pDimensionDefinitions[i].dimension = dimension;
2398                      pDimensionDefinitions[i].bits      = bits;                      pDimensionDefinitions[i].bits      = bits;
2399                      pDimensionDefinitions[i].zones     = zones ? zones : 0x01 << bits; // = pow(2,bits)                      pDimensionDefinitions[i].zones     = zones ? zones : 0x01 << bits; // = pow(2,bits)
2400                      pDimensionDefinitions[i].split_type = (dimension == dimension_layer ||                      pDimensionDefinitions[i].split_type = __resolveSplitType(dimension);
2401                                                             dimension == dimension_samplechannel ||                      pDimensionDefinitions[i].zone_size  = __resolveZoneSize(pDimensionDefinitions[i]);
                                                            dimension == dimension_releasetrigger ||  
                                                            dimension == dimension_roundrobin ||  
                                                            dimension == dimension_random) ? split_type_bit  
                                                                                           : split_type_normal;  
                     pDimensionDefinitions[i].ranges = NULL; // it's not possible to check velocity dimensions for custom defined ranges at this point  
                     pDimensionDefinitions[i].zone_size  =  
                         (pDimensionDefinitions[i].split_type == split_type_normal) ? 128.0 / pDimensionDefinitions[i].zones  
                                                                                    : 0;  
2402                      Dimensions++;                      Dimensions++;
2403    
2404                      // if this is a layer dimension, remember the amount of layers                      // if this is a layer dimension, remember the amount of layers
# Line 2114  namespace { Line 2406  namespace {
2406                  }                  }
2407                  _3lnk->SetPos(3, RIFF::stream_curpos); // jump forward to next dimension definition                  _3lnk->SetPos(3, RIFF::stream_curpos); // jump forward to next dimension definition
2408              }              }
2409                for (int i = dimensionBits ; i < 8 ; i++) pDimensionDefinitions[i].bits = 0;
2410    
2411              // 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,
2412              for (uint i = 0; i < Dimensions; i++) {              // update the VelocityTables in the dimension regions
2413                  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];  
                         UpdateVelocityTable(pDimDef);  
                     }  
                 }  
             }  
2414    
2415              // 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();  
2416              if (file->pVersion && file->pVersion->major == 3)              if (file->pVersion && file->pVersion->major == 3)
2417                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure
2418              else              else
2419                  _3lnk->SetPos(44);                  _3lnk->SetPos(44);
2420    
2421              // load sample references              // load sample references (if auto loading is enabled)
2422              for (uint i = 0; i < DimensionRegions; i++) {              if (file->GetAutoLoad()) {
2423                  uint32_t wavepoolindex = _3lnk->ReadUint32();                  for (uint i = 0; i < DimensionRegions; i++) {
2424                  pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);                      uint32_t wavepoolindex = _3lnk->ReadUint32();
2425                        if (file->pWavePoolTable) pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);
2426                    }
2427                    GetSample(); // load global region sample reference
2428                }
2429            } else {
2430                DimensionRegions = 0;
2431                for (int i = 0 ; i < 8 ; i++) {
2432                    pDimensionDefinitions[i].dimension  = dimension_none;
2433                    pDimensionDefinitions[i].bits       = 0;
2434                    pDimensionDefinitions[i].zones      = 0;
2435              }              }
2436          }          }
2437    
2438            // make sure there is at least one dimension region
2439            if (!DimensionRegions) {
2440                RIFF::List* _3prg = rgnList->GetSubList(LIST_TYPE_3PRG);
2441                if (!_3prg) _3prg = rgnList->AddSubList(LIST_TYPE_3PRG);
2442                RIFF::List* _3ewl = _3prg->AddSubList(LIST_TYPE_3EWL);
2443                pDimensionRegions[0] = new DimensionRegion(this, _3ewl);
2444                DimensionRegions = 1;
2445            }
2446      }      }
2447    
2448      /**      /**
# Line 2157  namespace { Line 2455  namespace {
2455       * @throws gig::Exception if samples cannot be dereferenced       * @throws gig::Exception if samples cannot be dereferenced
2456       */       */
2457      void Region::UpdateChunks() {      void Region::UpdateChunks() {
2458            // in the gig format we don't care about the Region's sample reference
2459            // but we still have to provide some existing one to not corrupt the
2460            // file, so to avoid the latter we simply always assign the sample of
2461            // the first dimension region of this region
2462            pSample = pDimensionRegions[0]->pSample;
2463    
2464          // first update base class's chunks          // first update base class's chunks
2465          DLS::Region::UpdateChunks();          DLS::Region::UpdateChunks();
2466    
2467          // update dimension region's chunks          // update dimension region's chunks
2468          for (int i = 0; i < Dimensions; i++)          for (int i = 0; i < DimensionRegions; i++) {
2469              pDimensionRegions[i]->UpdateChunks();              pDimensionRegions[i]->UpdateChunks();
2470            }
2471    
2472          File* pFile = (File*) GetParent()->GetParent();          File* pFile = (File*) GetParent()->GetParent();
2473          const int iMaxDimensions = (pFile->pVersion && pFile->pVersion->major == 3) ? 8 : 5;          bool version3 = pFile->pVersion && pFile->pVersion->major == 3;
2474          const int iMaxDimensionRegions = (pFile->pVersion && pFile->pVersion->major == 3) ? 256 : 32;          const int iMaxDimensions =  version3 ? 8 : 5;
2475            const int iMaxDimensionRegions = version3 ? 256 : 32;
2476    
2477          // make sure '3lnk' chunk exists          // make sure '3lnk' chunk exists
2478          RIFF::Chunk* _3lnk = pCkRegion->GetSubChunk(CHUNK_ID_3LNK);          RIFF::Chunk* _3lnk = pCkRegion->GetSubChunk(CHUNK_ID_3LNK);
2479          if (!_3lnk) {          if (!_3lnk) {
2480              const int _3lnkChunkSize = (pFile->pVersion && pFile->pVersion->major == 3) ? 1092 : 172;              const int _3lnkChunkSize = version3 ? 1092 : 172;
2481              _3lnk = pCkRegion->AddSubChunk(CHUNK_ID_3LNK, _3lnkChunkSize);              _3lnk = pCkRegion->AddSubChunk(CHUNK_ID_3LNK, _3lnkChunkSize);
2482                memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);
2483    
2484                // move 3prg to last position
2485                pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3PRG), 0);
2486          }          }
2487    
2488          // update dimension definitions in '3lnk' chunk          // update dimension definitions in '3lnk' chunk
2489          uint8_t* pData = (uint8_t*) _3lnk->LoadChunkData();          uint8_t* pData = (uint8_t*) _3lnk->LoadChunkData();
2490            store32(&pData[0], DimensionRegions);
2491            int shift = 0;
2492          for (int i = 0; i < iMaxDimensions; i++) {          for (int i = 0; i < iMaxDimensions; i++) {
2493              pData[i * 8]     = (uint8_t) pDimensionDefinitions[i].dimension;              pData[4 + i * 8] = (uint8_t) pDimensionDefinitions[i].dimension;
2494              pData[i * 8 + 1] = pDimensionDefinitions[i].bits;              pData[5 + i * 8] = pDimensionDefinitions[i].bits;
2495              // next 2 bytes unknown              pData[6 + i * 8] = pDimensionDefinitions[i].dimension == dimension_none ? 0 : shift;
2496              pData[i * 8 + 4] = pDimensionDefinitions[i].zones;              pData[7 + i * 8] = (1 << (shift + pDimensionDefinitions[i].bits)) - (1 << shift);
2497              // next 3 bytes unknown              pData[8 + i * 8] = pDimensionDefinitions[i].zones;
2498                // next 3 bytes unknown, always zero?
2499    
2500                shift += pDimensionDefinitions[i].bits;
2501          }          }
2502    
2503          // update wave pool table in '3lnk' chunk          // update wave pool table in '3lnk' chunk
2504          const int iWavePoolOffset = (pFile->pVersion && pFile->pVersion->major == 3) ? 68 : 44;          const int iWavePoolOffset = version3 ? 68 : 44;
2505          for (uint i = 0; i < iMaxDimensionRegions; i++) {          for (uint i = 0; i < iMaxDimensionRegions; i++) {
2506              int iWaveIndex = -1;              int iWaveIndex = -1;
2507              if (i < DimensionRegions) {              if (i < DimensionRegions) {
2508                  if (!pFile->pSamples) throw gig::Exception("Could not update gig::Region, there are no samples");                  if (!pFile->pSamples || !pFile->pSamples->size()) throw gig::Exception("Could not update gig::Region, there are no samples");
2509                  std::list<Sample*>::iterator iter = pFile->pSamples->begin();                  File::SampleList::iterator iter = pFile->pSamples->begin();
2510                  std::list<Sample*>::iterator end  = pFile->pSamples->end();                  File::SampleList::iterator end  = pFile->pSamples->end();
2511                  for (int index = 0; iter != end; ++iter, ++index) {                  for (int index = 0; iter != end; ++iter, ++index) {
2512                      if (*iter == pDimensionRegions[i]->pSample) iWaveIndex = index;                      if (*iter == pDimensionRegions[i]->pSample) {
2513                      break;                          iWaveIndex = index;
2514                            break;
2515                        }
2516                  }                  }
                 if (iWaveIndex < 0) throw gig::Exception("Could not update gig::Region, could not find DimensionRegion's sample");  
2517              }              }
2518              memcpy(&pData[iWavePoolOffset + i * 4], &iWaveIndex, 4);              store32(&pData[iWavePoolOffset + i * 4], iWaveIndex);
2519          }          }
2520      }      }
2521    
# Line 2210  namespace { Line 2526  namespace {
2526              RIFF::List* _3ewl = _3prg->GetFirstSubList();              RIFF::List* _3ewl = _3prg->GetFirstSubList();
2527              while (_3ewl) {              while (_3ewl) {
2528                  if (_3ewl->GetListType() == LIST_TYPE_3EWL) {                  if (_3ewl->GetListType() == LIST_TYPE_3EWL) {
2529                      pDimensionRegions[dimensionRegionNr] = new DimensionRegion(_3ewl);                      pDimensionRegions[dimensionRegionNr] = new DimensionRegion(this, _3ewl);
2530                      dimensionRegionNr++;                      dimensionRegionNr++;
2531                  }                  }
2532                  _3ewl = _3prg->GetNextSubList();                  _3ewl = _3prg->GetNextSubList();
# Line 2219  namespace { Line 2535  namespace {
2535          }          }
2536      }      }
2537    
2538      void Region::UpdateVelocityTable(dimension_def_t* pDimDef) {      void Region::SetKeyRange(uint16_t Low, uint16_t High) {
2539          // get dimension's index          // update KeyRange struct and make sure regions are in correct order
2540          int iDimensionNr = -1;          DLS::Region::SetKeyRange(Low, High);
2541          for (int i = 0; i < Dimensions; i++) {          // update Region key table for fast lookup
2542              if (&pDimensionDefinitions[i] == pDimDef) {          ((gig::Instrument*)GetParent())->UpdateRegionKeyTable();
2543                  iDimensionNr = i;      }
2544    
2545        void Region::UpdateVelocityTable() {
2546            // get velocity dimension's index
2547            int veldim = -1;
2548            for (int i = 0 ; i < Dimensions ; i++) {
2549                if (pDimensionDefinitions[i].dimension == gig::dimension_velocity) {
2550                    veldim = i;
2551                  break;                  break;
2552              }              }
2553          }          }
2554          if (iDimensionNr < 0) throw gig::Exception("Invalid dimension_def_t pointer");          if (veldim == -1) return;
2555    
2556            int step = 1;
2557            for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;
2558            int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;
2559            int end = step * pDimensionDefinitions[veldim].zones;
2560    
2561            // loop through all dimension regions for all dimensions except the velocity dimension
2562            int dim[8] = { 0 };
2563            for (int i = 0 ; i < DimensionRegions ; i++) {
2564    
2565                if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||
2566                    pDimensionRegions[i]->VelocityUpperLimit) {
2567                    // create the velocity table
2568                    uint8_t* table = pDimensionRegions[i]->VelocityTable;
2569                    if (!table) {
2570                        table = new uint8_t[128];
2571                        pDimensionRegions[i]->VelocityTable = table;
2572                    }
2573                    int tableidx = 0;
2574                    int velocityZone = 0;
2575                    if (pDimensionRegions[i]->DimensionUpperLimits[veldim]) { // gig3
2576                        for (int k = i ; k < end ; k += step) {
2577                            DimensionRegion *d = pDimensionRegions[k];
2578                            for (; tableidx <= d->DimensionUpperLimits[veldim] ; tableidx++) table[tableidx] = velocityZone;
2579                            velocityZone++;
2580                        }
2581                    } else { // gig2
2582                        for (int k = i ; k < end ; k += step) {
2583                            DimensionRegion *d = pDimensionRegions[k];
2584                            for (; tableidx <= d->VelocityUpperLimit ; tableidx++) table[tableidx] = velocityZone;
2585                            velocityZone++;
2586                        }
2587                    }
2588                } else {
2589                    if (pDimensionRegions[i]->VelocityTable) {
2590                        delete[] pDimensionRegions[i]->VelocityTable;
2591                        pDimensionRegions[i]->VelocityTable = 0;
2592                    }
2593                }
2594    
2595          uint8_t bits[8] = { 0 };              int j;
2596          int previousUpperLimit = -1;              int shift = 0;
2597          for (int velocityZone = 0; velocityZone < pDimDef->zones; velocityZone++) {              for (j = 0 ; j < Dimensions ; j++) {
2598              bits[iDimensionNr] = velocityZone;                  if (j == veldim) i += skipveldim; // skip velocity dimension
2599              DimensionRegion* pDimRegion = GetDimensionRegionByBit(bits);                  else {
2600                        dim[j]++;
2601              pDimDef->ranges[velocityZone].low  = previousUpperLimit + 1;                      if (dim[j] < pDimensionDefinitions[j].zones) break;
2602              pDimDef->ranges[velocityZone].high = pDimRegion->VelocityUpperLimit;                      else {
2603              previousUpperLimit = pDimDef->ranges[velocityZone].high;                          // skip unused dimension regions
2604              // fill velocity table                          dim[j] = 0;
2605              for (int i = pDimDef->ranges[velocityZone].low; i <= pDimDef->ranges[velocityZone].high; i++) {                          i += ((1 << pDimensionDefinitions[j].bits) -
2606                  VelocityTable[i] = velocityZone;                                pDimensionDefinitions[j].zones) << shift;
2607                        }
2608                    }
2609                    shift += pDimensionDefinitions[j].bits;
2610              }              }
2611                if (j == Dimensions) break;
2612          }          }
2613      }      }
2614    
# Line 2281  namespace { Line 2647  namespace {
2647              if (pDimensionDefinitions[i].dimension == pDimDef->dimension)              if (pDimensionDefinitions[i].dimension == pDimDef->dimension)
2648                  throw gig::Exception("Could not add new dimension, there is already a dimension of the same type");                  throw gig::Exception("Could not add new dimension, there is already a dimension of the same type");
2649    
2650            // pos is where the new dimension should be placed, normally
2651            // last in list, except for the samplechannel dimension which
2652            // has to be first in list
2653            int pos = pDimDef->dimension == dimension_samplechannel ? 0 : Dimensions;
2654            int bitpos = 0;
2655            for (int i = 0 ; i < pos ; i++)
2656                bitpos += pDimensionDefinitions[i].bits;
2657    
2658            // make room for the new dimension
2659            for (int i = Dimensions ; i > pos ; i--) pDimensionDefinitions[i] = pDimensionDefinitions[i - 1];
2660            for (int i = 0 ; i < (1 << iCurrentBits) ; i++) {
2661                for (int j = Dimensions ; j > pos ; j--) {
2662                    pDimensionRegions[i]->DimensionUpperLimits[j] =
2663                        pDimensionRegions[i]->DimensionUpperLimits[j - 1];
2664                }
2665            }
2666    
2667          // assign definition of new dimension          // assign definition of new dimension
2668          pDimensionDefinitions[Dimensions] = *pDimDef;          pDimensionDefinitions[pos] = *pDimDef;
2669    
2670          // create new dimension region(s) for this new dimension          // auto correct certain dimension definition fields (where possible)
2671          for (int i = 1 << iCurrentBits; i < 1 << iNewBits; i++) {          pDimensionDefinitions[pos].split_type  =
2672              //TODO: maybe we should copy existing dimension regions if possible instead of simply creating new ones with default values              __resolveSplitType(pDimensionDefinitions[pos].dimension);
2673              RIFF::List* pNewDimRgnListChunk = pCkRegion->AddSubList(LIST_TYPE_3EWL);          pDimensionDefinitions[pos].zone_size =
2674              pDimensionRegions[i] = new DimensionRegion(pNewDimRgnListChunk);              __resolveZoneSize(pDimensionDefinitions[pos]);
2675              DimensionRegions++;  
2676            // create new dimension region(s) for this new dimension, and make
2677            // sure that the dimension regions are placed correctly in both the
2678            // RIFF list and the pDimensionRegions array
2679            RIFF::Chunk* moveTo = NULL;
2680            RIFF::List* _3prg = pCkRegion->GetSubList(LIST_TYPE_3PRG);
2681            for (int i = (1 << iCurrentBits) - (1 << bitpos) ; i >= 0 ; i -= (1 << bitpos)) {
2682                for (int k = 0 ; k < (1 << bitpos) ; k++) {
2683                    pDimensionRegions[(i << pDimDef->bits) + k] = pDimensionRegions[i + k];
2684                }
2685                for (int j = 1 ; j < (1 << pDimDef->bits) ; j++) {
2686                    for (int k = 0 ; k < (1 << bitpos) ; k++) {
2687                        RIFF::List* pNewDimRgnListChunk = _3prg->AddSubList(LIST_TYPE_3EWL);
2688                        if (moveTo) _3prg->MoveSubChunk(pNewDimRgnListChunk, moveTo);
2689                        // create a new dimension region and copy all parameter values from
2690                        // an existing dimension region
2691                        pDimensionRegions[(i << pDimDef->bits) + (j << bitpos) + k] =
2692                            new DimensionRegion(pNewDimRgnListChunk, *pDimensionRegions[i + k]);
2693    
2694                        DimensionRegions++;
2695                    }
2696                }
2697                moveTo = pDimensionRegions[i]->pParentList;
2698            }
2699    
2700            // initialize the upper limits for this dimension
2701            int mask = (1 << bitpos) - 1;
2702            for (int z = 0 ; z < pDimDef->zones ; z++) {
2703                uint8_t upperLimit = uint8_t((z + 1) * 128.0 / pDimDef->zones - 1);
2704                for (int i = 0 ; i < 1 << iCurrentBits ; i++) {
2705                    pDimensionRegions[((i & ~mask) << pDimDef->bits) |
2706                                      (z << bitpos) |
2707                                      (i & mask)]->DimensionUpperLimits[pos] = upperLimit;
2708                }
2709          }          }
2710    
2711          Dimensions++;          Dimensions++;
# Line 2297  namespace { Line 2713  namespace {
2713          // if this is a layer dimension, update 'Layers' attribute          // if this is a layer dimension, update 'Layers' attribute
2714          if (pDimDef->dimension == dimension_layer) Layers = pDimDef->zones;          if (pDimDef->dimension == dimension_layer) Layers = pDimDef->zones;
2715    
2716          // if this is velocity dimension and got custom defined ranges, update velocity table          UpdateVelocityTable();
         if (pDimDef->dimension  == dimension_velocity &&  
             pDimDef->split_type == split_type_customvelocity) {  
             UpdateVelocityTable(pDimDef);  
         }  
2717      }      }
2718    
2719      /** @brief Delete an existing dimension.      /** @brief Delete an existing dimension.
# Line 2336  namespace { Line 2748  namespace {
2748          for (int i = iDimensionNr + 1; i < Dimensions; i++)          for (int i = iDimensionNr + 1; i < Dimensions; i++)
2749              iUpperBits += pDimensionDefinitions[i].bits;              iUpperBits += pDimensionDefinitions[i].bits;
2750    
2751            RIFF::List* _3prg = pCkRegion->GetSubList(LIST_TYPE_3PRG);
2752    
2753          // delete dimension regions which belong to the given dimension          // delete dimension regions which belong to the given dimension
2754          // (that is where the dimension's bit > 0)          // (that is where the dimension's bit > 0)
2755          for (int iUpperBit = 0; iUpperBit < 1 << iUpperBits; iUpperBit++) {          for (int iUpperBit = 0; iUpperBit < 1 << iUpperBits; iUpperBit++) {
# Line 2344  namespace { Line 2758  namespace {
2758                      int iToDelete = iUpperBit    << (pDimensionDefinitions[iDimensionNr].bits + iLowerBits) |                      int iToDelete = iUpperBit    << (pDimensionDefinitions[iDimensionNr].bits + iLowerBits) |
2759                                      iObsoleteBit << iLowerBits |                                      iObsoleteBit << iLowerBits |
2760                                      iLowerBit;                                      iLowerBit;
2761    
2762                        _3prg->DeleteSubChunk(pDimensionRegions[iToDelete]->pParentList);
2763                      delete pDimensionRegions[iToDelete];                      delete pDimensionRegions[iToDelete];
2764                      pDimensionRegions[iToDelete] = NULL;                      pDimensionRegions[iToDelete] = NULL;
2765                      DimensionRegions--;                      DimensionRegions--;
# Line 2364  namespace { Line 2780  namespace {
2780              }              }
2781          }          }
2782    
2783            // remove the this dimension from the upper limits arrays
2784            for (int j = 0 ; j < 256 && pDimensionRegions[j] ; j++) {
2785                DimensionRegion* d = pDimensionRegions[j];
2786                for (int i = iDimensionNr + 1; i < Dimensions; i++) {
2787                    d->DimensionUpperLimits[i - 1] = d->DimensionUpperLimits[i];
2788                }
2789                d->DimensionUpperLimits[Dimensions - 1] = 127;
2790            }
2791    
2792          // 'remove' dimension definition          // 'remove' dimension definition
2793          for (int i = iDimensionNr + 1; i < Dimensions; i++) {          for (int i = iDimensionNr + 1; i < Dimensions; i++) {
2794              pDimensionDefinitions[i - 1] = pDimensionDefinitions[i];              pDimensionDefinitions[i - 1] = pDimensionDefinitions[i];
# Line 2371  namespace { Line 2796  namespace {
2796          pDimensionDefinitions[Dimensions - 1].dimension = dimension_none;          pDimensionDefinitions[Dimensions - 1].dimension = dimension_none;
2797          pDimensionDefinitions[Dimensions - 1].bits      = 0;          pDimensionDefinitions[Dimensions - 1].bits      = 0;
2798          pDimensionDefinitions[Dimensions - 1].zones     = 0;          pDimensionDefinitions[Dimensions - 1].zones     = 0;
         if (pDimensionDefinitions[Dimensions - 1].ranges) {  
             delete[] pDimensionDefinitions[Dimensions - 1].ranges;  
             pDimensionDefinitions[Dimensions - 1].ranges = NULL;  
         }  
2799    
2800          Dimensions--;          Dimensions--;
2801    
# Line 2383  namespace { Line 2804  namespace {
2804      }      }
2805    
2806      Region::~Region() {      Region::~Region() {
         for (uint i = 0; i < Dimensions; i++) {  
             if (pDimensionDefinitions[i].ranges) delete[] pDimensionDefinitions[i].ranges;  
         }  
2807          for (int i = 0; i < 256; i++) {          for (int i = 0; i < 256; i++) {
2808              if (pDimensionRegions[i]) delete pDimensionRegions[i];              if (pDimensionRegions[i]) delete pDimensionRegions[i];
2809          }          }
# Line 2410  namespace { Line 2828  namespace {
2828       * @see             Dimensions       * @see             Dimensions
2829       */       */
2830      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {
2831          uint8_t bits[8] = { 0 };          uint8_t bits;
2832            int veldim = -1;
2833            int velbitpos;
2834            int bitpos = 0;
2835            int dimregidx = 0;
2836          for (uint i = 0; i < Dimensions; i++) {          for (uint i = 0; i < Dimensions; i++) {
2837              bits[i] = DimValues[i];              if (pDimensionDefinitions[i].dimension == dimension_velocity) {
2838              switch (pDimensionDefinitions[i].split_type) {                  // the velocity dimension must be handled after the other dimensions
2839                  case split_type_normal:                  veldim = i;
2840                      bits[i] = uint8_t(bits[i] / pDimensionDefinitions[i].zone_size);                  velbitpos = bitpos;
2841                      break;              } else {
2842                  case split_type_customvelocity:                  switch (pDimensionDefinitions[i].split_type) {
2843                      bits[i] = VelocityTable[bits[i]];                      case split_type_normal:
2844                      break;                          if (pDimensionRegions[0]->DimensionUpperLimits[i]) {
2845                  case split_type_bit: // the value is already the sought dimension bit number                              // gig3: all normal dimensions (not just the velocity dimension) have custom zone ranges
2846                      const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;                              for (bits = 0 ; bits < pDimensionDefinitions[i].zones ; bits++) {
2847                      bits[i] = bits[i] & limiter_mask; // just make sure the value don't uses more bits than allowed                                  if (DimValues[i] <= pDimensionRegions[bits << bitpos]->DimensionUpperLimits[i]) break;
2848                      break;                              }
2849                            } else {
2850                                // gig2: evenly sized zones
2851                                bits = uint8_t(DimValues[i] / pDimensionDefinitions[i].zone_size);
2852                            }
2853                            break;
2854                        case split_type_bit: // the value is already the sought dimension bit number
2855                            const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;
2856                            bits = DimValues[i] & limiter_mask; // just make sure the value doesn't use more bits than allowed
2857                            break;
2858                    }
2859                    dimregidx |= bits << bitpos;
2860              }              }
2861                bitpos += pDimensionDefinitions[i].bits;
2862          }          }
2863          return GetDimensionRegionByBit(bits);          DimensionRegion* dimreg = pDimensionRegions[dimregidx];
2864            if (veldim != -1) {
2865                // (dimreg is now the dimension region for the lowest velocity)
2866                if (dimreg->VelocityTable) // custom defined zone ranges
2867                    bits = dimreg->VelocityTable[DimValues[veldim]];
2868                else // normal split type
2869                    bits = uint8_t(DimValues[veldim] / pDimensionDefinitions[veldim].zone_size);
2870    
2871                dimregidx |= bits << velbitpos;
2872                dimreg = pDimensionRegions[dimregidx];
2873            }
2874            return dimreg;
2875      }      }
2876    
2877      /**      /**
# Line 2466  namespace { Line 2911  namespace {
2911      Sample* Region::GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress) {      Sample* Region::GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress) {
2912          if ((int32_t)WavePoolTableIndex == -1) return NULL;          if ((int32_t)WavePoolTableIndex == -1) return NULL;
2913          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
2914            if (!file->pWavePoolTable) return NULL;
2915          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
2916          unsigned long soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];          unsigned long soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];
2917          Sample* sample = file->GetFirstSample(pProgress);          Sample* sample = file->GetFirstSample(pProgress);
2918          while (sample) {          while (sample) {
2919              if (sample->ulWavePoolOffset == soughtoffset &&              if (sample->ulWavePoolOffset == soughtoffset &&
2920                  sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(pSample = sample);                  sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);
2921              sample = file->GetNextSample();              sample = file->GetNextSample();
2922          }          }
2923          return NULL;          return NULL;
2924      }      }
2925    
2926    
2927    // *************** MidiRule ***************
2928    // *
2929    
2930    MidiRuleCtrlTrigger::MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg) {
2931        _3ewg->SetPos(36);
2932        Triggers = _3ewg->ReadUint8();
2933        _3ewg->SetPos(40);
2934        ControllerNumber = _3ewg->ReadUint8();
2935        _3ewg->SetPos(46);
2936        for (int i = 0 ; i < Triggers ; i++) {
2937            pTriggers[i].TriggerPoint = _3ewg->ReadUint8();
2938            pTriggers[i].Descending = _3ewg->ReadUint8();
2939            pTriggers[i].VelSensitivity = _3ewg->ReadUint8();
2940            pTriggers[i].Key = _3ewg->ReadUint8();
2941            pTriggers[i].NoteOff = _3ewg->ReadUint8();
2942            pTriggers[i].Velocity = _3ewg->ReadUint8();
2943            pTriggers[i].OverridePedal = _3ewg->ReadUint8();
2944            _3ewg->ReadUint8();
2945        }
2946    }
2947    
2948    
2949  // *************** Instrument ***************  // *************** Instrument ***************
2950  // *  // *
2951    
2952      Instrument::Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress) : DLS::Instrument((DLS::File*)pFile, insList) {      Instrument::Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress) : DLS::Instrument((DLS::File*)pFile, insList) {
2953            static const DLS::Info::string_length_t fixedStringLengths[] = {
2954                { CHUNK_ID_INAM, 64 },
2955                { CHUNK_ID_ISFT, 12 },
2956                { 0, 0 }
2957            };
2958            pInfo->SetFixedStringLengths(fixedStringLengths);
2959    
2960          // Initialization          // Initialization
2961          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;
2962          RegionIndex = -1;          EffectSend = 0;
2963            Attenuation = 0;
2964            FineTune = 0;
2965            PitchbendRange = 0;
2966            PianoReleaseMode = false;
2967            DimensionKeyRange.low = 0;
2968            DimensionKeyRange.high = 0;
2969            pMidiRules = new MidiRule*[3];
2970            pMidiRules[0] = NULL;
2971    
2972          // Loading          // Loading
2973          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);
# Line 2500  namespace { Line 2982  namespace {
2982                  PianoReleaseMode       = dimkeystart & 0x01;                  PianoReleaseMode       = dimkeystart & 0x01;
2983                  DimensionKeyRange.low  = dimkeystart >> 1;                  DimensionKeyRange.low  = dimkeystart >> 1;
2984                  DimensionKeyRange.high = _3ewg->ReadUint8();                  DimensionKeyRange.high = _3ewg->ReadUint8();
2985    
2986                    if (_3ewg->GetSize() > 32) {
2987                        // read MIDI rules
2988                        int i = 0;
2989                        _3ewg->SetPos(32);
2990                        uint8_t id1 = _3ewg->ReadUint8();
2991                        uint8_t id2 = _3ewg->ReadUint8();
2992    
2993                        if (id1 == 4 && id2 == 16) {
2994                            pMidiRules[i++] = new MidiRuleCtrlTrigger(_3ewg);
2995                        }
2996                        //TODO: all the other types of rules
2997    
2998                        pMidiRules[i] = NULL;
2999                    }
3000              }              }
3001          }          }
3002    
3003          pRegions = new Region*[Regions];          if (pFile->GetAutoLoad()) {
3004          RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);              if (!pRegions) pRegions = new RegionList;
3005          if (lrgn) {              RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);
3006              for (uint i = 0; i < Regions; i++) pRegions[i] = NULL;              if (lrgn) {
3007              RIFF::List* rgn = lrgn->GetFirstSubList();                  RIFF::List* rgn = lrgn->GetFirstSubList();
3008              unsigned int iRegion = 0;                  while (rgn) {
3009              while (rgn) {                      if (rgn->GetListType() == LIST_TYPE_RGN) {
3010                  if (rgn->GetListType() == LIST_TYPE_RGN) {                          __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
3011                      __notify_progress(pProgress, (float) iRegion / (float) Regions);                          pRegions->push_back(new Region(this, rgn));
3012                      pRegions[iRegion] = new Region(this, rgn);                      }
3013                      iRegion++;                      rgn = lrgn->GetNextSubList();
3014                  }                  }
3015                  rgn = lrgn->GetNextSubList();                  // Creating Region Key Table for fast lookup
3016                    UpdateRegionKeyTable();
3017              }              }
             // Creating Region Key Table for fast lookup  
             UpdateRegionKeyTable();  
3018          }          }
3019    
3020          __notify_progress(pProgress, 1.0f); // notify done          __notify_progress(pProgress, 1.0f); // notify done
3021      }      }
3022    
3023      void Instrument::UpdateRegionKeyTable() {      void Instrument::UpdateRegionKeyTable() {
3024          for (uint iReg = 0; iReg < Regions; iReg++) {          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;
3025              for (int iKey = pRegions[iReg]->KeyRange.low; iKey <= pRegions[iReg]->KeyRange.high; iKey++) {          RegionList::iterator iter = pRegions->begin();
3026                  RegionKeyTable[iKey] = pRegions[iReg];          RegionList::iterator end  = pRegions->end();
3027            for (; iter != end; ++iter) {
3028                gig::Region* pRegion = static_cast<gig::Region*>(*iter);
3029                for (int iKey = pRegion->KeyRange.low; iKey <= pRegion->KeyRange.high; iKey++) {
3030                    RegionKeyTable[iKey] = pRegion;
3031              }              }
3032          }          }
3033      }      }
3034    
3035      Instrument::~Instrument() {      Instrument::~Instrument() {
3036          for (uint i = 0; i < Regions; i++) {          delete[] pMidiRules;
             if (pRegions) {  
                 if (pRegions[i]) delete (pRegions[i]);  
             }  
         }  
         if (pRegions) delete[] pRegions;  
3037      }      }
3038    
3039      /**      /**
# Line 2555  namespace { Line 3050  namespace {
3050          DLS::Instrument::UpdateChunks();          DLS::Instrument::UpdateChunks();
3051    
3052          // update Regions' chunks          // update Regions' chunks
3053          for (int i = 0; i < Regions; i++)          {
3054              pRegions[i]->UpdateChunks();              RegionList::iterator iter = pRegions->begin();
3055                RegionList::iterator end  = pRegions->end();
3056                for (; iter != end; ++iter)
3057                    (*iter)->UpdateChunks();
3058            }
3059    
3060          // make sure 'lart' RIFF list chunk exists          // make sure 'lart' RIFF list chunk exists
3061          RIFF::List* lart = pCkInstrument->GetSubList(LIST_TYPE_LART);          RIFF::List* lart = pCkInstrument->GetSubList(LIST_TYPE_LART);
3062          if (!lart)  lart = pCkInstrument->AddSubList(LIST_TYPE_LART);          if (!lart)  lart = pCkInstrument->AddSubList(LIST_TYPE_LART);
3063          // make sure '3ewg' RIFF chunk exists          // make sure '3ewg' RIFF chunk exists
3064          RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);          RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);
3065          if (!_3ewg)  _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, 12);          if (!_3ewg)  {
3066                File* pFile = (File*) GetParent();
3067    
3068                // 3ewg is bigger in gig3, as it includes the iMIDI rules
3069                int size = (pFile->pVersion && pFile->pVersion->major == 3) ? 16416 : 12;
3070                _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, size);
3071                memset(_3ewg->LoadChunkData(), 0, size);
3072            }
3073          // update '3ewg' RIFF chunk          // update '3ewg' RIFF chunk
3074          uint8_t* pData = (uint8_t*) _3ewg->LoadChunkData();          uint8_t* pData = (uint8_t*) _3ewg->LoadChunkData();
3075          memcpy(&pData[0], &EffectSend, 2);          store16(&pData[0], EffectSend);
3076          memcpy(&pData[2], &Attenuation, 4);          store32(&pData[2], Attenuation);
3077          memcpy(&pData[6], &FineTune, 2);          store16(&pData[6], FineTune);
3078          memcpy(&pData[8], &PitchbendRange, 2);          store16(&pData[8], PitchbendRange);
3079          const uint8_t dimkeystart = (PianoReleaseMode) ? 0x01 : 0x00 |          const uint8_t dimkeystart = (PianoReleaseMode ? 0x01 : 0x00) |
3080                                      DimensionKeyRange.low << 1;                                      DimensionKeyRange.low << 1;
3081          memcpy(&pData[10], &dimkeystart, 1);          pData[10] = dimkeystart;
3082          memcpy(&pData[11], &DimensionKeyRange.high, 1);          pData[11] = DimensionKeyRange.high;
3083      }      }
3084    
3085      /**      /**
# Line 2584  namespace { Line 3090  namespace {
3090       *             there is no Region defined for the given \a Key       *             there is no Region defined for the given \a Key
3091       */       */
3092      Region* Instrument::GetRegion(unsigned int Key) {      Region* Instrument::GetRegion(unsigned int Key) {
3093          if (!pRegions || Key > 127) return NULL;          if (!pRegions || pRegions->empty() || Key > 127) return NULL;
3094          return RegionKeyTable[Key];          return RegionKeyTable[Key];
3095    
3096          /*for (int i = 0; i < Regions; i++) {          /*for (int i = 0; i < Regions; i++) {
3097              if (Key <= pRegions[i]->KeyRange.high &&              if (Key <= pRegions[i]->KeyRange.high &&
3098                  Key >= pRegions[i]->KeyRange.low) return pRegions[i];                  Key >= pRegions[i]->KeyRange.low) return pRegions[i];
# Line 2601  namespace { Line 3108  namespace {
3108       * @see      GetNextRegion()       * @see      GetNextRegion()
3109       */       */
3110      Region* Instrument::GetFirstRegion() {      Region* Instrument::GetFirstRegion() {
3111          if (!Regions) return NULL;          if (!pRegions) return NULL;
3112          RegionIndex = 1;          RegionsIterator = pRegions->begin();
3113          return pRegions[0];          return static_cast<gig::Region*>( (RegionsIterator != pRegions->end()) ? *RegionsIterator : NULL );
3114      }      }
3115    
3116      /**      /**
# Line 2615  namespace { Line 3122  namespace {
3122       * @see      GetFirstRegion()       * @see      GetFirstRegion()
3123       */       */
3124      Region* Instrument::GetNextRegion() {      Region* Instrument::GetNextRegion() {
3125          if (RegionIndex < 0 || uint32_t(RegionIndex) >= Regions) return NULL;          if (!pRegions) return NULL;
3126          return pRegions[RegionIndex++];          RegionsIterator++;
3127            return static_cast<gig::Region*>( (RegionsIterator != pRegions->end()) ? *RegionsIterator : NULL );
3128      }      }
3129    
3130      Region* Instrument::AddRegion() {      Region* Instrument::AddRegion() {
# Line 2625  namespace { Line 3133  namespace {
3133          if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);          if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
3134          RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);          RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
3135          Region* pNewRegion = new Region(this, rgn);          Region* pNewRegion = new Region(this, rgn);
3136          // resize 'pRegions' array (increase by one)          pRegions->push_back(pNewRegion);
3137          Region** pNewRegions = new Region*[Regions + 1];          Regions = pRegions->size();
         memcpy(pNewRegions, pRegions, Regions * sizeof(Region*));  
         // add new Region object  
         pNewRegions[Regions] = pNewRegion;  
         // replace old 'pRegions' array by the new increased array  
         if (pRegions) delete[] pRegions;  
         pRegions = pNewRegions;  
         Regions++;  
3138          // update Region key table for fast lookup          // update Region key table for fast lookup
3139          UpdateRegionKeyTable();          UpdateRegionKeyTable();
3140          // done          // done
# Line 2642  namespace { Line 3143  namespace {
3143    
3144      void Instrument::DeleteRegion(Region* pRegion) {      void Instrument::DeleteRegion(Region* pRegion) {
3145          if (!pRegions) return;          if (!pRegions) return;
3146          int iOffset = 0;          DLS::Instrument::DeleteRegion((DLS::Region*) pRegion);
         // resize 'pRegions' array (decrease by one)  
         Region** pNewRegions = new Region*[Regions - 1];  
         for (int i = 0; i < Regions; i++) {  
             if (pRegions[i] == pRegion) { // found Region to delete  
                 iOffset = 1;  
                 delete pRegion;  
             }  
             if (i < Regions - 1) pNewRegions[i] = pRegions[i + iOffset];  
         }  
         if (!iOffset) throw gig::Exception("There is no such gig::Region to delete");  
         // replace old 'pRegions' array by the new decreased array  
         if (pRegions) delete[] pRegions;  
         pRegions = pNewRegions;  
         Regions--;  
3147          // update Region key table for fast lookup          // update Region key table for fast lookup
3148          UpdateRegionKeyTable();          UpdateRegionKeyTable();
3149      }      }
3150    
3151        /**
3152         * Returns a MIDI rule of the instrument.
3153         *
3154         * The list of MIDI rules, at least in gig v3, always contains at
3155         * most two rules. The second rule can only be the DEF filter
3156         * (which currently isn't supported by libgig).
3157         *
3158         * @param i - MIDI rule number
3159         * @returns   pointer address to MIDI rule number i or NULL if there is none
3160         */
3161        MidiRule* Instrument::GetMidiRule(int i) {
3162            return pMidiRules[i];
3163        }
3164    
3165    
3166    // *************** Group ***************
3167    // *
3168    
3169        /** @brief Constructor.
3170         *
3171         * @param file   - pointer to the gig::File object
3172         * @param ck3gnm - pointer to 3gnm chunk associated with this group or
3173         *                 NULL if this is a new Group
3174         */
3175        Group::Group(File* file, RIFF::Chunk* ck3gnm) {
3176            pFile      = file;
3177            pNameChunk = ck3gnm;
3178            ::LoadString(pNameChunk, Name);
3179        }
3180    
3181        Group::~Group() {
3182            // remove the chunk associated with this group (if any)
3183            if (pNameChunk) pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);
3184        }
3185    
3186        /** @brief Update chunks with current group settings.
3187         *
3188         * Apply current Group field values to the respective chunks. You have
3189         * to call File::Save() to make changes persistent.
3190         *
3191         * Usually there is absolutely no need to call this method explicitly.
3192         * It will be called automatically when File::Save() was called.
3193         */
3194        void Group::UpdateChunks() {
3195            // make sure <3gri> and <3gnl> list chunks exist
3196            RIFF::List* _3gri = pFile->pRIFF->GetSubList(LIST_TYPE_3GRI);
3197            if (!_3gri) {
3198                _3gri = pFile->pRIFF->AddSubList(LIST_TYPE_3GRI);
3199                pFile->pRIFF->MoveSubChunk(_3gri, pFile->pRIFF->GetSubChunk(CHUNK_ID_PTBL));
3200            }
3201            RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
3202            if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
3203    
3204            if (!pNameChunk && pFile->pVersion && pFile->pVersion->major == 3) {
3205                // v3 has a fixed list of 128 strings, find a free one
3206                for (RIFF::Chunk* ck = _3gnl->GetFirstSubChunk() ; ck ; ck = _3gnl->GetNextSubChunk()) {
3207                    if (strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) {
3208                        pNameChunk = ck;
3209                        break;
3210                    }
3211                }
3212            }
3213    
3214            // now store the name of this group as <3gnm> chunk as subchunk of the <3gnl> list chunk
3215            ::SaveString(CHUNK_ID_3GNM, pNameChunk, _3gnl, Name, String("Unnamed Group"), true, 64);
3216        }
3217    
3218        /**
3219         * Returns the first Sample of this Group. You have to call this method
3220         * once before you use GetNextSample().
3221         *
3222         * <b>Notice:</b> this method might block for a long time, in case the
3223         * samples of this .gig file were not scanned yet
3224         *
3225         * @returns  pointer address to first Sample or NULL if there is none
3226         *           applied to this Group
3227         * @see      GetNextSample()
3228         */
3229        Sample* Group::GetFirstSample() {
3230            // FIXME: lazy und unsafe implementation, should be an autonomous iterator
3231            for (Sample* pSample = pFile->GetFirstSample(); pSample; pSample = pFile->GetNextSample()) {
3232                if (pSample->GetGroup() == this) return pSample;
3233            }
3234            return NULL;
3235        }
3236    
3237        /**
3238         * Returns the next Sample of the Group. You have to call
3239         * GetFirstSample() once before you can use this method. By calling this
3240         * method multiple times it iterates through the Samples assigned to
3241         * this Group.
3242         *
3243         * @returns  pointer address to the next Sample of this Group or NULL if
3244         *           end reached
3245         * @see      GetFirstSample()
3246         */
3247        Sample* Group::GetNextSample() {
3248            // FIXME: lazy und unsafe implementation, should be an autonomous iterator
3249            for (Sample* pSample = pFile->GetNextSample(); pSample; pSample = pFile->GetNextSample()) {
3250                if (pSample->GetGroup() == this) return pSample;
3251            }
3252            return NULL;
3253        }
3254    
3255        /**
3256         * Move Sample given by \a pSample from another Group to this Group.
3257         */
3258        void Group::AddSample(Sample* pSample) {
3259            pSample->pGroup = this;
3260        }
3261    
3262        /**
3263         * Move all members of this group to another group (preferably the 1st
3264         * one except this). This method is called explicitly by
3265         * File::DeleteGroup() thus when a Group was deleted. This code was
3266         * intentionally not placed in the destructor!
3267         */
3268        void Group::MoveAll() {
3269            // get "that" other group first
3270            Group* pOtherGroup = NULL;
3271            for (pOtherGroup = pFile->GetFirstGroup(); pOtherGroup; pOtherGroup = pFile->GetNextGroup()) {
3272                if (pOtherGroup != this) break;
3273            }
3274            if (!pOtherGroup) throw Exception(
3275                "Could not move samples to another group, since there is no "
3276                "other Group. This is a bug, report it!"
3277            );
3278            // now move all samples of this group to the other group
3279            for (Sample* pSample = GetFirstSample(); pSample; pSample = GetNextSample()) {
3280                pOtherGroup->AddSample(pSample);
3281            }
3282        }
3283    
3284    
3285    
3286  // *************** File ***************  // *************** File ***************
3287  // *  // *
3288    
3289        /// Reflects Gigasampler file format version 2.0 (1998-06-28).
3290        const DLS::version_t File::VERSION_2 = {
3291            0, 2, 19980628 & 0xffff, 19980628 >> 16
3292        };
3293    
3294        /// Reflects Gigasampler file format version 3.0 (2003-03-31).
3295        const DLS::version_t File::VERSION_3 = {
3296            0, 3, 20030331 & 0xffff, 20030331 >> 16
3297        };
3298    
3299        static const DLS::Info::string_length_t _FileFixedStringLengths[] = {
3300            { CHUNK_ID_IARL, 256 },
3301            { CHUNK_ID_IART, 128 },
3302            { CHUNK_ID_ICMS, 128 },
3303            { CHUNK_ID_ICMT, 1024 },
3304            { CHUNK_ID_ICOP, 128 },
3305            { CHUNK_ID_ICRD, 128 },
3306            { CHUNK_ID_IENG, 128 },
3307            { CHUNK_ID_IGNR, 128 },
3308            { CHUNK_ID_IKEY, 128 },
3309            { CHUNK_ID_IMED, 128 },
3310            { CHUNK_ID_INAM, 128 },
3311            { CHUNK_ID_IPRD, 128 },
3312            { CHUNK_ID_ISBJ, 128 },
3313            { CHUNK_ID_ISFT, 128 },
3314            { CHUNK_ID_ISRC, 128 },
3315            { CHUNK_ID_ISRF, 128 },
3316            { CHUNK_ID_ITCH, 128 },
3317            { 0, 0 }
3318        };
3319    
3320      File::File() : DLS::File() {      File::File() : DLS::File() {
3321          pSamples     = NULL;          bAutoLoad = true;
3322          pInstruments = NULL;          *pVersion = VERSION_3;
3323            pGroups = NULL;
3324            pInfo->SetFixedStringLengths(_FileFixedStringLengths);
3325            pInfo->ArchivalLocation = String(256, ' ');
3326    
3327            // add some mandatory chunks to get the file chunks in right
3328            // order (INFO chunk will be moved to first position later)
3329            pRIFF->AddSubChunk(CHUNK_ID_VERS, 8);
3330            pRIFF->AddSubChunk(CHUNK_ID_COLH, 4);
3331            pRIFF->AddSubChunk(CHUNK_ID_DLID, 16);
3332    
3333            GenerateDLSID();
3334      }      }
3335    
3336      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {
3337          pSamples     = NULL;          bAutoLoad = true;
3338          pInstruments = NULL;          pGroups = NULL;
3339            pInfo->SetFixedStringLengths(_FileFixedStringLengths);
3340      }      }
3341    
3342      File::~File() {      File::~File() {
3343          // free samples          if (pGroups) {
3344          if (pSamples) {              std::list<Group*>::iterator iter = pGroups->begin();
3345              SamplesIterator = pSamples->begin();              std::list<Group*>::iterator end  = pGroups->end();
3346              while (SamplesIterator != pSamples->end() ) {              while (iter != end) {
3347                  delete (*SamplesIterator);                  delete *iter;
3348                  SamplesIterator++;                  ++iter;
3349              }              }
3350              pSamples->clear();              delete pGroups;
3351              delete pSamples;          }
   
         }  
         // free instruments  
         if (pInstruments) {  
             InstrumentsIterator = pInstruments->begin();  
             while (InstrumentsIterator != pInstruments->end() ) {  
                 delete (*InstrumentsIterator);  
                 InstrumentsIterator++;  
             }  
             pInstruments->clear();  
             delete pInstruments;  
         }  
         // free extension files  
         for (std::list<RIFF::File*>::iterator i = ExtensionFiles.begin() ; i != ExtensionFiles.end() ; i++)  
             delete *i;  
3352      }      }
3353    
3354      Sample* File::GetFirstSample(progress_t* pProgress) {      Sample* File::GetFirstSample(progress_t* pProgress) {
# Line 2728  namespace { Line 3376  namespace {
3376         __ensureMandatoryChunksExist();         __ensureMandatoryChunksExist();
3377         RIFF::List* wvpl = pRIFF->GetSubList(LIST_TYPE_WVPL);         RIFF::List* wvpl = pRIFF->GetSubList(LIST_TYPE_WVPL);
3378         // create new Sample object and its respective 'wave' list chunk         // create new Sample object and its respective 'wave' list chunk
        if (!pSamples) pSamples = new SampleList;  
3379         RIFF::List* wave = wvpl->AddSubList(LIST_TYPE_WAVE);         RIFF::List* wave = wvpl->AddSubList(LIST_TYPE_WAVE);
3380         Sample* pSample = new Sample(this, wave, 0 /*arbitrary value, we update offsets when we save*/);         Sample* pSample = new Sample(this, wave, 0 /*arbitrary value, we update offsets when we save*/);
3381    
3382           // add mandatory chunks to get the chunks in right order
3383           wave->AddSubChunk(CHUNK_ID_FMT, 16);
3384           wave->AddSubList(LIST_TYPE_INFO);
3385    
3386         pSamples->push_back(pSample);         pSamples->push_back(pSample);
3387         return pSample;         return pSample;
3388      }      }
3389    
3390      /** @brief Delete a sample.      /** @brief Delete a sample.
3391       *       *
3392       * This will delete the given Sample object from the gig file. You have       * This will delete the given Sample object from the gig file. Any
3393       * to call Save() to make this persistent to the file.       * references to this sample from Regions and DimensionRegions will be
3394         * removed. You have to call Save() to make this persistent to the file.
3395       *       *
3396       * @param pSample - sample to delete       * @param pSample - sample to delete
3397       * @throws gig::Exception if given sample could not be found       * @throws gig::Exception if given sample could not be found
3398       */       */
3399      void File::DeleteSample(Sample* pSample) {      void File::DeleteSample(Sample* pSample) {
3400          if (!pSamples) throw gig::Exception("Could not delete sample as there are no samples");          if (!pSamples || !pSamples->size()) throw gig::Exception("Could not delete sample as there are no samples");
3401          SampleList::iterator iter = find(pSamples->begin(), pSamples->end(), pSample);          SampleList::iterator iter = find(pSamples->begin(), pSamples->end(), (DLS::Sample*) pSample);
3402          if (iter == pSamples->end()) throw gig::Exception("Could not delete sample, could not find given sample");          if (iter == pSamples->end()) throw gig::Exception("Could not delete sample, could not find given sample");
3403            if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation
3404          pSamples->erase(iter);          pSamples->erase(iter);
3405          delete pSample;          delete pSample;
3406    
3407            SampleList::iterator tmp = SamplesIterator;
3408            // remove all references to the sample
3409            for (Instrument* instrument = GetFirstInstrument() ; instrument ;
3410                 instrument = GetNextInstrument()) {
3411                for (Region* region = instrument->GetFirstRegion() ; region ;
3412                     region = instrument->GetNextRegion()) {
3413    
3414                    if (region->GetSample() == pSample) region->SetSample(NULL);
3415    
3416                    for (int i = 0 ; i < region->DimensionRegions ; i++) {
3417                        gig::DimensionRegion *d = region->pDimensionRegions[i];
3418                        if (d->pSample == pSample) d->pSample = NULL;
3419                    }
3420                }
3421            }
3422            SamplesIterator = tmp; // restore iterator
3423        }
3424    
3425        void File::LoadSamples() {
3426            LoadSamples(NULL);
3427      }      }
3428    
3429      void File::LoadSamples(progress_t* pProgress) {      void File::LoadSamples(progress_t* pProgress) {
3430            // Groups must be loaded before samples, because samples will try
3431            // to resolve the group they belong to
3432            if (!pGroups) LoadGroups();
3433    
3434            if (!pSamples) pSamples = new SampleList;
3435    
3436          RIFF::File* file = pRIFF;          RIFF::File* file = pRIFF;
3437    
3438          // just for progress calculation          // just for progress calculation
# Line 2779  namespace { Line 3460  namespace {
3460                          const float subprogress = (float) iSampleIndex / (float) iTotalSamples;                          const float subprogress = (float) iSampleIndex / (float) iTotalSamples;
3461                          __notify_progress(pProgress, subprogress);                          __notify_progress(pProgress, subprogress);
3462    
                         if (!pSamples) pSamples = new SampleList;  
3463                          unsigned long waveFileOffset = wave->GetFilePos();                          unsigned long waveFileOffset = wave->GetFilePos();
3464                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));
3465    
# Line 2796  namespace { Line 3476  namespace {
3476                  name.replace(nameLen, 5, suffix);                  name.replace(nameLen, 5, suffix);
3477                  file = new RIFF::File(name);                  file = new RIFF::File(name);
3478                  ExtensionFiles.push_back(file);                  ExtensionFiles.push_back(file);
3479              }              } else break;
             else throw gig::Exception("Mandatory <wvpl> chunk not found.");  
3480          }          }
3481    
3482          __notify_progress(pProgress, 1.0); // notify done          __notify_progress(pProgress, 1.0); // notify done
# Line 2807  namespace { Line 3486  namespace {
3486          if (!pInstruments) LoadInstruments();          if (!pInstruments) LoadInstruments();
3487          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
3488          InstrumentsIterator = pInstruments->begin();          InstrumentsIterator = pInstruments->begin();
3489          return (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL;          return static_cast<gig::Instrument*>( (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL );
3490      }      }
3491    
3492      Instrument* File::GetNextInstrument() {      Instrument* File::GetNextInstrument() {
3493          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
3494          InstrumentsIterator++;          InstrumentsIterator++;
3495          return (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL;          return static_cast<gig::Instrument*>( (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL );
3496      }      }
3497    
3498      /**      /**
# Line 2831  namespace { Line 3510  namespace {
3510              progress_t subprogress;              progress_t subprogress;
3511              __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask              __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask
3512              __notify_progress(&subprogress, 0.0f);              __notify_progress(&subprogress, 0.0f);
3513              GetFirstSample(&subprogress); // now force all samples to be loaded              if (GetAutoLoad())
3514                    GetFirstSample(&subprogress); // now force all samples to be loaded
3515              __notify_progress(&subprogress, 1.0f);              __notify_progress(&subprogress, 1.0f);
3516    
3517              // instrument loading subtask              // instrument loading subtask
# Line 2846  namespace { Line 3526  namespace {
3526          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
3527          InstrumentsIterator = pInstruments->begin();          InstrumentsIterator = pInstruments->begin();
3528          for (uint i = 0; InstrumentsIterator != pInstruments->end(); i++) {          for (uint i = 0; InstrumentsIterator != pInstruments->end(); i++) {
3529              if (i == index) return *InstrumentsIterator;              if (i == index) return static_cast<gig::Instrument*>( *InstrumentsIterator );
3530              InstrumentsIterator++;              InstrumentsIterator++;
3531          }          }
3532          return NULL;          return NULL;
# Line 2862  namespace { Line 3542  namespace {
3542      Instrument* File::AddInstrument() {      Instrument* File::AddInstrument() {
3543         if (!pInstruments) LoadInstruments();         if (!pInstruments) LoadInstruments();
3544         __ensureMandatoryChunksExist();         __ensureMandatoryChunksExist();
        if (!pInstruments) pInstruments = new InstrumentList;  
3545         RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);         RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
3546         RIFF::List* lstInstr = lstInstruments->AddSubList(LIST_TYPE_INS);         RIFF::List* lstInstr = lstInstruments->AddSubList(LIST_TYPE_INS);
3547    
3548           // add mandatory chunks to get the chunks in right order
3549           lstInstr->AddSubList(LIST_TYPE_INFO);
3550           lstInstr->AddSubChunk(CHUNK_ID_DLID, 16);
3551    
3552         Instrument* pInstrument = new Instrument(this, lstInstr);         Instrument* pInstrument = new Instrument(this, lstInstr);
3553           pInstrument->GenerateDLSID();
3554    
3555           lstInstr->AddSubChunk(CHUNK_ID_INSH, 12);
3556    
3557           // this string is needed for the gig to be loadable in GSt:
3558           pInstrument->pInfo->Software = "Endless Wave";
3559    
3560         pInstruments->push_back(pInstrument);         pInstruments->push_back(pInstrument);
3561         return pInstrument;         return pInstrument;
3562      }      }
# Line 2876  namespace { Line 3567  namespace {
3567       * have to call Save() to make this persistent to the file.       * have to call Save() to make this persistent to the file.
3568       *       *
3569       * @param pInstrument - instrument to delete       * @param pInstrument - instrument to delete
3570       * @throws gig::Excption if given instrument could not be found       * @throws gig::Exception if given instrument could not be found
3571       */       */
3572      void File::DeleteInstrument(Instrument* pInstrument) {      void File::DeleteInstrument(Instrument* pInstrument) {
3573          if (!pInstruments) throw gig::Exception("Could not delete instrument as there are no instruments");          if (!pInstruments) throw gig::Exception("Could not delete instrument as there are no instruments");
3574          InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), pInstrument);          InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), (DLS::Instrument*) pInstrument);
3575          if (iter == pInstruments->end()) throw gig::Exception("Could not delete instrument, could not find given instrument");          if (iter == pInstruments->end()) throw gig::Exception("Could not delete instrument, could not find given instrument");
3576          pInstruments->erase(iter);          pInstruments->erase(iter);
3577          delete pInstrument;          delete pInstrument;
3578      }      }
3579    
3580        void File::LoadInstruments() {
3581            LoadInstruments(NULL);
3582        }
3583    
3584      void File::LoadInstruments(progress_t* pProgress) {      void File::LoadInstruments(progress_t* pProgress) {
3585            if (!pInstruments) pInstruments = new InstrumentList;
3586          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
3587          if (lstInstruments) {          if (lstInstruments) {
3588              int iInstrumentIndex = 0;              int iInstrumentIndex = 0;
# Line 2901  namespace { Line 3597  namespace {
3597                      progress_t subprogress;                      progress_t subprogress;
3598                      __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);                      __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);
3599    
                     if (!pInstruments) pInstruments = new InstrumentList;  
3600                      pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));                      pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));
3601    
3602                      iInstrumentIndex++;                      iInstrumentIndex++;
# Line 2910  namespace { Line 3605  namespace {
3605              }              }
3606              __notify_progress(pProgress, 1.0); // notify done              __notify_progress(pProgress, 1.0); // notify done
3607          }          }
3608          else throw gig::Exception("Mandatory <lins> list chunk not found.");      }
3609    
3610        /// Updates the 3crc chunk with the checksum of a sample. The
3611        /// update is done directly to disk, as this method is called
3612        /// after File::Save()
3613        void File::SetSampleChecksum(Sample* pSample, uint32_t crc) {
3614            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
3615            if (!_3crc) return;
3616    
3617            // get the index of the sample
3618            int iWaveIndex = -1;
3619            File::SampleList::iterator iter = pSamples->begin();
3620            File::SampleList::iterator end  = pSamples->end();
3621            for (int index = 0; iter != end; ++iter, ++index) {
3622                if (*iter == pSample) {
3623                    iWaveIndex = index;
3624                    break;
3625                }
3626            }
3627            if (iWaveIndex < 0) throw gig::Exception("Could not update crc, could not find sample");
3628    
3629            // write the CRC-32 checksum to disk
3630            _3crc->SetPos(iWaveIndex * 8);
3631            uint32_t tmp = 1;
3632            _3crc->WriteUint32(&tmp); // unknown, always 1?
3633            _3crc->WriteUint32(&crc);
3634        }
3635    
3636        Group* File::GetFirstGroup() {
3637            if (!pGroups) LoadGroups();
3638            // there must always be at least one group
3639            GroupsIterator = pGroups->begin();
3640            return *GroupsIterator;
3641        }
3642    
3643        Group* File::GetNextGroup() {
3644            if (!pGroups) return NULL;
3645            ++GroupsIterator;
3646            return (GroupsIterator == pGroups->end()) ? NULL : *GroupsIterator;
3647        }
3648    
3649        /**
3650         * Returns the group with the given index.
3651         *
3652         * @param index - number of the sought group (0..n)
3653         * @returns sought group or NULL if there's no such group
3654         */
3655        Group* File::GetGroup(uint index) {
3656            if (!pGroups) LoadGroups();
3657            GroupsIterator = pGroups->begin();
3658            for (uint i = 0; GroupsIterator != pGroups->end(); i++) {
3659                if (i == index) return *GroupsIterator;
3660                ++GroupsIterator;
3661            }
3662            return NULL;
3663        }
3664    
3665        Group* File::AddGroup() {
3666            if (!pGroups) LoadGroups();
3667            // there must always be at least one group
3668            __ensureMandatoryChunksExist();
3669            Group* pGroup = new Group(this, NULL);
3670            pGroups->push_back(pGroup);
3671            return pGroup;
3672        }
3673    
3674        /** @brief Delete a group and its samples.
3675         *
3676         * This will delete the given Group object and all the samples that
3677         * belong to this group from the gig file. You have to call Save() to
3678         * make this persistent to the file.
3679         *
3680         * @param pGroup - group to delete
3681         * @throws gig::Exception if given group could not be found
3682         */
3683        void File::DeleteGroup(Group* pGroup) {
3684            if (!pGroups) LoadGroups();
3685            std::list<Group*>::iterator iter = find(pGroups->begin(), pGroups->end(), pGroup);
3686            if (iter == pGroups->end()) throw gig::Exception("Could not delete group, could not find given group");
3687            if (pGroups->size() == 1) throw gig::Exception("Cannot delete group, there must be at least one default group!");
3688            // delete all members of this group
3689            for (Sample* pSample = pGroup->GetFirstSample(); pSample; pSample = pGroup->GetNextSample()) {
3690                DeleteSample(pSample);
3691            }
3692            // now delete this group object
3693            pGroups->erase(iter);
3694            delete pGroup;
3695        }
3696    
3697        /** @brief Delete a group.
3698         *
3699         * This will delete the given Group object from the gig file. All the
3700         * samples that belong to this group will not be deleted, but instead
3701         * be moved to another group. You have to call Save() to make this
3702         * persistent to the file.
3703         *
3704         * @param pGroup - group to delete
3705         * @throws gig::Exception if given group could not be found
3706         */
3707        void File::DeleteGroupOnly(Group* pGroup) {
3708            if (!pGroups) LoadGroups();
3709            std::list<Group*>::iterator iter = find(pGroups->begin(), pGroups->end(), pGroup);
3710            if (iter == pGroups->end()) throw gig::Exception("Could not delete group, could not find given group");
3711            if (pGroups->size() == 1) throw gig::Exception("Cannot delete group, there must be at least one default group!");
3712            // move all members of this group to another group
3713            pGroup->MoveAll();
3714            pGroups->erase(iter);
3715            delete pGroup;
3716        }
3717    
3718        void File::LoadGroups() {
3719            if (!pGroups) pGroups = new std::list<Group*>;
3720            // try to read defined groups from file
3721            RIFF::List* lst3gri = pRIFF->GetSubList(LIST_TYPE_3GRI);
3722            if (lst3gri) {
3723                RIFF::List* lst3gnl = lst3gri->GetSubList(LIST_TYPE_3GNL);
3724                if (lst3gnl) {
3725                    RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();
3726                    while (ck) {
3727                        if (ck->GetChunkID() == CHUNK_ID_3GNM) {
3728                            if (pVersion && pVersion->major == 3 &&
3729                                strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) break;
3730    
3731                            pGroups->push_back(new Group(this, ck));
3732                        }
3733                        ck = lst3gnl->GetNextSubChunk();
3734                    }
3735                }
3736            }
3737            // if there were no group(s), create at least the mandatory default group
3738            if (!pGroups->size()) {
3739                Group* pGroup = new Group(this, NULL);
3740                pGroup->Name = "Default Group";
3741                pGroups->push_back(pGroup);
3742            }
3743        }
3744    
3745        /**
3746         * Apply all the gig file's current instruments, samples, groups and settings
3747         * to the respective RIFF chunks. You have to call Save() to make changes
3748         * persistent.
3749         *
3750         * Usually there is absolutely no need to call this method explicitly.
3751         * It will be called automatically when File::Save() was called.
3752         *
3753         * @throws Exception - on errors
3754         */
3755        void File::UpdateChunks() {
3756            bool newFile = pRIFF->GetSubList(LIST_TYPE_INFO) == NULL;
3757    
3758            b64BitWavePoolOffsets = pVersion && pVersion->major == 3;
3759    
3760            // first update base class's chunks
3761            DLS::File::UpdateChunks();
3762    
3763            if (newFile) {
3764                // INFO was added by Resource::UpdateChunks - make sure it
3765                // is placed first in file
3766                RIFF::Chunk* info = pRIFF->GetSubList(LIST_TYPE_INFO);
3767                RIFF::Chunk* first = pRIFF->GetFirstSubChunk();
3768                if (first != info) {
3769                    pRIFF->MoveSubChunk(info, first);
3770                }
3771            }
3772    
3773            // update group's chunks
3774            if (pGroups) {
3775                std::list<Group*>::iterator iter = pGroups->begin();
3776                std::list<Group*>::iterator end  = pGroups->end();
3777                for (; iter != end; ++iter) {
3778                    (*iter)->UpdateChunks();
3779                }
3780    
3781                // v3: make sure the file has 128 3gnm chunks
3782                if (pVersion && pVersion->major == 3) {
3783                    RIFF::List* _3gnl = pRIFF->GetSubList(LIST_TYPE_3GRI)->GetSubList(LIST_TYPE_3GNL);
3784                    RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();
3785                    for (int i = 0 ; i < 128 ; i++) {
3786                        if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);
3787                        if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();
3788                    }
3789                }
3790            }
3791    
3792            // update einf chunk
3793    
3794            // The einf chunk contains statistics about the gig file, such
3795            // as the number of regions and samples used by each
3796            // instrument. It is divided in equally sized parts, where the
3797            // first part contains information about the whole gig file,
3798            // and the rest of the parts map to each instrument in the
3799            // file.
3800            //
3801            // At the end of each part there is a bit map of each sample
3802            // in the file, where a set bit means that the sample is used
3803            // by the file/instrument.
3804            //
3805            // Note that there are several fields with unknown use. These
3806            // are set to zero.
3807    
3808            int sublen = pSamples->size() / 8 + 49;
3809            int einfSize = (Instruments + 1) * sublen;
3810    
3811            RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
3812            if (einf) {
3813                if (einf->GetSize() != einfSize) {
3814                    einf->Resize(einfSize);
3815                    memset(einf->LoadChunkData(), 0, einfSize);
3816                }
3817            } else if (newFile) {
3818                einf = pRIFF->AddSubChunk(CHUNK_ID_EINF, einfSize);
3819            }
3820            if (einf) {
3821                uint8_t* pData = (uint8_t*) einf->LoadChunkData();
3822    
3823                std::map<gig::Sample*,int> sampleMap;
3824                int sampleIdx = 0;
3825                for (Sample* pSample = GetFirstSample(); pSample; pSample = GetNextSample()) {
3826                    sampleMap[pSample] = sampleIdx++;
3827                }
3828    
3829                int totnbusedsamples = 0;
3830                int totnbusedchannels = 0;
3831                int totnbregions = 0;
3832                int totnbdimregions = 0;
3833                int totnbloops = 0;
3834                int instrumentIdx = 0;
3835    
3836                memset(&pData[48], 0, sublen - 48);
3837    
3838                for (Instrument* instrument = GetFirstInstrument() ; instrument ;
3839                     instrument = GetNextInstrument()) {
3840                    int nbusedsamples = 0;
3841                    int nbusedchannels = 0;
3842                    int nbdimregions = 0;
3843                    int nbloops = 0;
3844    
3845                    memset(&pData[(instrumentIdx + 1) * sublen + 48], 0, sublen - 48);
3846    
3847                    for (Region* region = instrument->GetFirstRegion() ; region ;
3848                         region = instrument->GetNextRegion()) {
3849                        for (int i = 0 ; i < region->DimensionRegions ; i++) {
3850                            gig::DimensionRegion *d = region->pDimensionRegions[i];
3851                            if (d->pSample) {
3852                                int sampleIdx = sampleMap[d->pSample];
3853                                int byte = 48 + sampleIdx / 8;
3854                                int bit = 1 << (sampleIdx & 7);
3855                                if ((pData[(instrumentIdx + 1) * sublen + byte] & bit) == 0) {
3856                                    pData[(instrumentIdx + 1) * sublen + byte] |= bit;
3857                                    nbusedsamples++;
3858                                    nbusedchannels += d->pSample->Channels;
3859    
3860                                    if ((pData[byte] & bit) == 0) {
3861                                        pData[byte] |= bit;
3862                                        totnbusedsamples++;
3863                                        totnbusedchannels += d->pSample->Channels;
3864                                    }
3865                                }
3866                            }
3867                            if (d->SampleLoops) nbloops++;
3868                        }
3869                        nbdimregions += region->DimensionRegions;
3870                    }
3871                    // first 4 bytes unknown - sometimes 0, sometimes length of einf part
3872                    // store32(&pData[(instrumentIdx + 1) * sublen], sublen);
3873                    store32(&pData[(instrumentIdx + 1) * sublen + 4], nbusedchannels);
3874                    store32(&pData[(instrumentIdx + 1) * sublen + 8], nbusedsamples);
3875                    store32(&pData[(instrumentIdx + 1) * sublen + 12], 1);
3876                    store32(&pData[(instrumentIdx + 1) * sublen + 16], instrument->Regions);
3877                    store32(&pData[(instrumentIdx + 1) * sublen + 20], nbdimregions);
3878                    store32(&pData[(instrumentIdx + 1) * sublen + 24], nbloops);
3879                    // next 8 bytes unknown
3880                    store32(&pData[(instrumentIdx + 1) * sublen + 36], instrumentIdx);
3881                    store32(&pData[(instrumentIdx + 1) * sublen + 40], pSamples->size());
3882                    // next 4 bytes unknown
3883    
3884                    totnbregions += instrument->Regions;
3885                    totnbdimregions += nbdimregions;
3886                    totnbloops += nbloops;
3887                    instrumentIdx++;
3888                }
3889                // first 4 bytes unknown - sometimes 0, sometimes length of einf part
3890                // store32(&pData[0], sublen);
3891                store32(&pData[4], totnbusedchannels);
3892                store32(&pData[8], totnbusedsamples);
3893                store32(&pData[12], Instruments);
3894                store32(&pData[16], totnbregions);
3895                store32(&pData[20], totnbdimregions);
3896                store32(&pData[24], totnbloops);
3897                // next 8 bytes unknown
3898                // next 4 bytes unknown, not always 0
3899                store32(&pData[40], pSamples->size());
3900                // next 4 bytes unknown
3901            }
3902    
3903            // update 3crc chunk
3904    
3905            // The 3crc chunk contains CRC-32 checksums for the
3906            // samples. The actual checksum values will be filled in
3907            // later, by Sample::Write.
3908    
3909            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
3910            if (_3crc) {
3911                _3crc->Resize(pSamples->size() * 8);
3912            } else if (newFile) {
3913                _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
3914                _3crc->LoadChunkData();
3915    
3916                // the order of einf and 3crc is not the same in v2 and v3
3917                if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);
3918            }
3919        }
3920    
3921        /**
3922         * Enable / disable automatic loading. By default this properyt is
3923         * enabled and all informations are loaded automatically. However
3924         * loading all Regions, DimensionRegions and especially samples might
3925         * take a long time for large .gig files, and sometimes one might only
3926         * be interested in retrieving very superficial informations like the
3927         * amount of instruments and their names. In this case one might disable
3928         * automatic loading to avoid very slow response times.
3929         *
3930         * @e CAUTION: by disabling this property many pointers (i.e. sample
3931         * references) and informations will have invalid or even undefined
3932         * data! This feature is currently only intended for retrieving very
3933         * superficial informations in a very fast way. Don't use it to retrieve
3934         * details like synthesis informations or even to modify .gig files!
3935         */
3936        void File::SetAutoLoad(bool b) {
3937            bAutoLoad = b;
3938        }
3939    
3940        /**
3941         * Returns whether automatic loading is enabled.
3942         * @see SetAutoLoad()
3943         */
3944        bool File::GetAutoLoad() {
3945            return bAutoLoad;
3946      }      }
3947    
3948    

Legend:
Removed from v.809  
changed lines
  Added in v.1713

  ViewVC Help
Powered by ViewVC