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

Legend:
Removed from v.834  
changed lines
  Added in v.1524

  ViewVC Help
Powered by ViewVC