/[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 728 by persson, Tue Jul 26 11:13:53 2005 UTC revision 1182 by persson, Sun May 13 05:48:51 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 23  Line 23 
23    
24  #include "gig.h"  #include "gig.h"
25    
26    #include "helper.h"
27    
28    #include <math.h>
29  #include <iostream>  #include <iostream>
30    
31    /// Initial size of the sample buffer which is used for decompression of
32    /// compressed sample wave streams - this value should always be bigger than
33    /// the biggest sample piece expected to be read by the sampler engine,
34    /// otherwise the buffer size will be raised at runtime and thus the buffer
35    /// reallocated which is time consuming and unefficient.
36    #define INITIAL_SAMPLE_BUFFER_SIZE              512000 // 512 kB
37    
38    /** (so far) every exponential paramater in the gig format has a basis of 1.000000008813822 */
39    #define GIG_EXP_DECODE(x)                       (pow(1.000000008813822, x))
40    #define GIG_EXP_ENCODE(x)                       (log(x) / log(1.000000008813822))
41    #define GIG_PITCH_TRACK_EXTRACT(x)              (!(x & 0x01))
42    #define GIG_PITCH_TRACK_ENCODE(x)               ((x) ? 0x00 : 0x01)
43    #define GIG_VCF_RESONANCE_CTRL_EXTRACT(x)       ((x >> 4) & 0x03)
44    #define GIG_VCF_RESONANCE_CTRL_ENCODE(x)        ((x & 0x03) << 4)
45    #define GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(x)  ((x >> 1) & 0x03)
46    #define GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(x)   ((x >> 3) & 0x03)
47    #define GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(x) ((x >> 5) & 0x03)
48    #define GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(x)   ((x & 0x03) << 1)
49    #define GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(x)    ((x & 0x03) << 3)
50    #define GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(x)  ((x & 0x03) << 5)
51    
52  namespace gig {  namespace gig {
53    
54  // *************** progress_t ***************  // *************** progress_t ***************
# Line 59  namespace gig { Line 83  namespace gig {
83      }      }
84    
85    
86  // *************** Internal functions for sample decopmression ***************  // *************** Internal functions for sample decompression ***************
87  // *  // *
88    
89  namespace {  namespace {
# Line 87  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 126  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 149  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 226  namespace { Line 254  namespace {
254  }  }
255    
256    
257    
258    // *************** Other Internal functions  ***************
259    // *
260    
261        static split_type_t __resolveSplitType(dimension_t dimension) {
262            return (
263                dimension == dimension_layer ||
264                dimension == dimension_samplechannel ||
265                dimension == dimension_releasetrigger ||
266                dimension == dimension_keyboard ||
267                dimension == dimension_roundrobin ||
268                dimension == dimension_random ||
269                dimension == dimension_smartmidi ||
270                dimension == dimension_roundrobinkeyboard
271            ) ? split_type_bit : split_type_normal;
272        }
273    
274        static int __resolveZoneSize(dimension_def_t& dimension_definition) {
275            return (dimension_definition.split_type == split_type_normal)
276            ? int(128.0 / dimension_definition.zones) : 0;
277        }
278    
279    
280    
281  // *************** Sample ***************  // *************** Sample ***************
282  // *  // *
283    
284      unsigned int Sample::Instances = 0;      unsigned int Sample::Instances = 0;
285      buffer_t     Sample::InternalDecompressionBuffer;      buffer_t     Sample::InternalDecompressionBuffer;
286    
287        /** @brief Constructor.
288         *
289         * Load an existing sample or create a new one. A 'wave' list chunk must
290         * be given to this constructor. In case the given 'wave' list chunk
291         * contains a 'fmt', 'data' (and optionally a '3gix', 'smpl') chunk, the
292         * format and sample data will be loaded from there, otherwise default
293         * values will be used and those chunks will be created when
294         * File::Save() will be called later on.
295         *
296         * @param pFile          - pointer to gig::File where this sample is
297         *                         located (or will be located)
298         * @param waveList       - pointer to 'wave' list chunk which is (or
299         *                         will be) associated with this sample
300         * @param WavePoolOffset - offset of this sample data from wave pool
301         *                         ('wvpl') list chunk
302         * @param fileNo         - number of an extension file where this sample
303         *                         is located, 0 otherwise
304         */
305      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) {
306            static const DLS::Info::FixedStringLength fixedStringLengths[] = {
307                { CHUNK_ID_INAM, 64 },
308                { 0, 0 }
309            };
310            pInfo->FixedStringLengths = fixedStringLengths;
311          Instances++;          Instances++;
312          FileNo = fileNo;          FileNo = fileNo;
313    
314          RIFF::Chunk* _3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);          pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);
315          if (!_3gix) throw gig::Exception("Mandatory chunks in <wave> list chunk not found.");          if (pCk3gix) {
316          SampleGroup = _3gix->ReadInt16();              uint16_t iSampleGroup = pCk3gix->ReadInt16();
317                pGroup = pFile->GetGroup(iSampleGroup);
318          RIFF::Chunk* smpl = waveList->GetSubChunk(CHUNK_ID_SMPL);          } else { // '3gix' chunk missing
319          if (!smpl) throw gig::Exception("Mandatory chunks in <wave> list chunk not found.");              // by default assigned to that mandatory "Default Group"
320          Manufacturer      = smpl->ReadInt32();              pGroup = pFile->GetGroup(0);
321          Product           = smpl->ReadInt32();          }
322          SamplePeriod      = smpl->ReadInt32();  
323          MIDIUnityNote     = smpl->ReadInt32();          pCkSmpl = waveList->GetSubChunk(CHUNK_ID_SMPL);
324          FineTune          = smpl->ReadInt32();          if (pCkSmpl) {
325          smpl->Read(&SMPTEFormat, 1, 4);              Manufacturer  = pCkSmpl->ReadInt32();
326          SMPTEOffset       = smpl->ReadInt32();              Product       = pCkSmpl->ReadInt32();
327          Loops             = smpl->ReadInt32();              SamplePeriod  = pCkSmpl->ReadInt32();
328          smpl->ReadInt32(); // manufByt              MIDIUnityNote = pCkSmpl->ReadInt32();
329          LoopID            = smpl->ReadInt32();              FineTune      = pCkSmpl->ReadInt32();
330          smpl->Read(&LoopType, 1, 4);              pCkSmpl->Read(&SMPTEFormat, 1, 4);
331          LoopStart         = smpl->ReadInt32();              SMPTEOffset   = pCkSmpl->ReadInt32();
332          LoopEnd           = smpl->ReadInt32();              Loops         = pCkSmpl->ReadInt32();
333          LoopFraction      = smpl->ReadInt32();              pCkSmpl->ReadInt32(); // manufByt
334          LoopPlayCount     = smpl->ReadInt32();              LoopID        = pCkSmpl->ReadInt32();
335                pCkSmpl->Read(&LoopType, 1, 4);
336                LoopStart     = pCkSmpl->ReadInt32();
337                LoopEnd       = pCkSmpl->ReadInt32();
338                LoopFraction  = pCkSmpl->ReadInt32();
339                LoopPlayCount = pCkSmpl->ReadInt32();
340            } else { // 'smpl' chunk missing
341                // use default values
342                Manufacturer  = 0;
343                Product       = 0;
344                SamplePeriod  = uint32_t(1000000000.0 / SamplesPerSecond + 0.5);
345                MIDIUnityNote = 64;
346                FineTune      = 0;
347                SMPTEFormat   = smpte_format_no_offset;
348                SMPTEOffset   = 0;
349                Loops         = 0;
350                LoopID        = 0;
351                LoopType      = loop_type_normal;
352                LoopStart     = 0;
353                LoopEnd       = 0;
354                LoopFraction  = 0;
355                LoopPlayCount = 0;
356            }
357    
358          FrameTable                 = NULL;          FrameTable                 = NULL;
359          SamplePos                  = 0;          SamplePos                  = 0;
# Line 287  namespace { Line 384  namespace {
384          }          }
385          FrameOffset = 0; // just for streaming compressed samples          FrameOffset = 0; // just for streaming compressed samples
386    
387          LoopSize = LoopEnd - LoopStart;          LoopSize = LoopEnd - LoopStart + 1;
388        }
389    
390        /**
391         * Apply sample and its settings to the respective RIFF chunks. You have
392         * to call File::Save() to make changes persistent.
393         *
394         * Usually there is absolutely no need to call this method explicitly.
395         * It will be called automatically when File::Save() was called.
396         *
397         * @throws DLS::Exception if FormatTag != DLS_WAVE_FORMAT_PCM or no sample data
398         *                        was provided yet
399         * @throws gig::Exception if there is any invalid sample setting
400         */
401        void Sample::UpdateChunks() {
402            // first update base class's chunks
403            DLS::Sample::UpdateChunks();
404    
405            // make sure 'smpl' chunk exists
406            pCkSmpl = pWaveList->GetSubChunk(CHUNK_ID_SMPL);
407            if (!pCkSmpl) {
408                pCkSmpl = pWaveList->AddSubChunk(CHUNK_ID_SMPL, 60);
409                memset(pCkSmpl->LoadChunkData(), 0, 60);
410            }
411            // update 'smpl' chunk
412            uint8_t* pData = (uint8_t*) pCkSmpl->LoadChunkData();
413            SamplePeriod = uint32_t(1000000000.0 / SamplesPerSecond + 0.5);
414            store32(&pData[0], Manufacturer);
415            store32(&pData[4], Product);
416            store32(&pData[8], SamplePeriod);
417            store32(&pData[12], MIDIUnityNote);
418            store32(&pData[16], FineTune);
419            store32(&pData[20], SMPTEFormat);
420            store32(&pData[24], SMPTEOffset);
421            store32(&pData[28], Loops);
422    
423            // we skip 'manufByt' for now (4 bytes)
424    
425            store32(&pData[36], LoopID);
426            store32(&pData[40], LoopType);
427            store32(&pData[44], LoopStart);
428            store32(&pData[48], LoopEnd);
429            store32(&pData[52], LoopFraction);
430            store32(&pData[56], LoopPlayCount);
431    
432            // make sure '3gix' chunk exists
433            pCk3gix = pWaveList->GetSubChunk(CHUNK_ID_3GIX);
434            if (!pCk3gix) pCk3gix = pWaveList->AddSubChunk(CHUNK_ID_3GIX, 4);
435            // determine appropriate sample group index (to be stored in chunk)
436            uint16_t iSampleGroup = 0; // 0 refers to default sample group
437            File* pFile = static_cast<File*>(pParent);
438            if (pFile->pGroups) {
439                std::list<Group*>::iterator iter = pFile->pGroups->begin();
440                std::list<Group*>::iterator end  = pFile->pGroups->end();
441                for (int i = 0; iter != end; i++, iter++) {
442                    if (*iter == pGroup) {
443                        iSampleGroup = i;
444                        break; // found
445                    }
446                }
447            }
448            // update '3gix' chunk
449            pData = (uint8_t*) pCk3gix->LoadChunkData();
450            store16(&pData[0], iSampleGroup);
451      }      }
452    
453      /// 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 490  namespace { Line 650  namespace {
650          RAMCache.Size   = 0;          RAMCache.Size   = 0;
651      }      }
652    
653        /** @brief Resize sample.
654         *
655         * Resizes the sample's wave form data, that is the actual size of
656         * sample wave data possible to be written for this sample. This call
657         * will return immediately and just schedule the resize operation. You
658         * should call File::Save() to actually perform the resize operation(s)
659         * "physically" to the file. As this can take a while on large files, it
660         * is recommended to call Resize() first on all samples which have to be
661         * resized and finally to call File::Save() to perform all those resize
662         * operations in one rush.
663         *
664         * The actual size (in bytes) is dependant to the current FrameSize
665         * value. You may want to set FrameSize before calling Resize().
666         *
667         * <b>Caution:</b> You cannot directly write (i.e. with Write()) to
668         * enlarged samples before calling File::Save() as this might exceed the
669         * current sample's boundary!
670         *
671         * Also note: only DLS_WAVE_FORMAT_PCM is currently supported, that is
672         * FormatTag must be DLS_WAVE_FORMAT_PCM. Trying to resize samples with
673         * other formats will fail!
674         *
675         * @param iNewSize - new sample wave data size in sample points (must be
676         *                   greater than zero)
677         * @throws DLS::Excecption if FormatTag != DLS_WAVE_FORMAT_PCM
678         *                         or if \a iNewSize is less than 1
679         * @throws gig::Exception if existing sample is compressed
680         * @see DLS::Sample::GetSize(), DLS::Sample::FrameSize,
681         *      DLS::Sample::FormatTag, File::Save()
682         */
683        void Sample::Resize(int iNewSize) {
684            if (Compressed) throw gig::Exception("There is no support for modifying compressed samples (yet)");
685            DLS::Sample::Resize(iNewSize);
686        }
687    
688      /**      /**
689       * Sets the position within the sample (in sample points, not in       * Sets the position within the sample (in sample points, not in
690       * bytes). Use this method and <i>Read()</i> if you don't want to load       * bytes). Use this method and <i>Read()</i> if you don't want to load
# Line 579  namespace { Line 774  namespace {
774       * @param SampleCount      number of sample points to read       * @param SampleCount      number of sample points to read
775       * @param pPlaybackState   will be used to store and reload the playback       * @param pPlaybackState   will be used to store and reload the playback
776       *                         state for the next ReadAndLoop() call       *                         state for the next ReadAndLoop() call
777         * @param pDimRgn          dimension region with looping information
778       * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression       * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression
779       * @returns                number of successfully read sample points       * @returns                number of successfully read sample points
780       * @see                    CreateDecompressionBuffer()       * @see                    CreateDecompressionBuffer()
781       */       */
782      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,
783                                          DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer) {
784          unsigned long samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;          unsigned long samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;
785          uint8_t* pDst = (uint8_t*) pBuffer;          uint8_t* pDst = (uint8_t*) pBuffer;
786    
787          SetPos(pPlaybackState->position); // recover position from the last time          SetPos(pPlaybackState->position); // recover position from the last time
788    
789          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
790    
791              switch (this->LoopType) {              const DLS::sample_loop_t& loop = pDimRgn->pSampleLoops[0];
792                const uint32_t loopEnd = loop.LoopStart + loop.LoopLength;
793    
794                  case loop_type_bidirectional: { //TODO: not tested yet!              if (GetPos() <= loopEnd) {
795                      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  
796    
797                              // as we can only read forward from disk, we have to                      case loop_type_bidirectional: { //TODO: not tested yet!
798                              // determine the end position within the loop first,                          do {
799                              // read forward from that 'end' and finally after                              // if not endless loop check if max. number of loop cycles have been passed
800                              // reading, swap all sample frames so it reflects                              if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
801                              // backward playback  
802                                if (!pPlaybackState->reverse) { // forward playback
803                              unsigned long swapareastart       = totalreadsamples;                                  do {
804                              unsigned long loopoffset          = GetPos() - this->LoopStart;                                      samplestoloopend  = loopEnd - GetPos();
805                              unsigned long samplestoreadinloop = Min(samplestoread, loopoffset);                                      readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
806                              unsigned long reverseplaybackend  = GetPos() - samplestoreadinloop;                                      samplestoread    -= readsamples;
807                                        totalreadsamples += readsamples;
808                              SetPos(reverseplaybackend);                                      if (readsamples == samplestoloopend) {
809                                            pPlaybackState->reverse = true;
810                              // read samples for backward playback                                          break;
811                              do {                                      }
812                                  readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], samplestoreadinloop, pExternalDecompressionBuffer);                                  } while (samplestoread && readsamples);
813                                  samplestoreadinloop -= readsamples;                              }
814                                  samplestoread       -= readsamples;                              else { // backward playback
                                 totalreadsamples    += readsamples;  
                             } while (samplestoreadinloop && readsamples);  
815    
816                              SetPos(reverseplaybackend); // pretend we really read backwards                                  // as we can only read forward from disk, we have to
817                                    // determine the end position within the loop first,
818                                    // read forward from that 'end' and finally after
819                                    // reading, swap all sample frames so it reflects
820                                    // backward playback
821    
822                                    unsigned long swapareastart       = totalreadsamples;
823                                    unsigned long loopoffset          = GetPos() - loop.LoopStart;
824                                    unsigned long samplestoreadinloop = Min(samplestoread, loopoffset);
825                                    unsigned long reverseplaybackend  = GetPos() - samplestoreadinloop;
826    
827                                    SetPos(reverseplaybackend);
828    
829                                    // read samples for backward playback
830                                    do {
831                                        readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], samplestoreadinloop, pExternalDecompressionBuffer);
832                                        samplestoreadinloop -= readsamples;
833                                        samplestoread       -= readsamples;
834                                        totalreadsamples    += readsamples;
835                                    } while (samplestoreadinloop && readsamples);
836    
837                                    SetPos(reverseplaybackend); // pretend we really read backwards
838    
839                                    if (reverseplaybackend == loop.LoopStart) {
840                                        pPlaybackState->loop_cycles_left--;
841                                        pPlaybackState->reverse = false;
842                                    }
843    
844                              if (reverseplaybackend == this->LoopStart) {                                  // reverse the sample frames for backward playback
845                                  pPlaybackState->loop_cycles_left--;                                  SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
                                 pPlaybackState->reverse = false;  
846                              }                              }
847                            } while (samplestoread && readsamples);
848                            break;
849                        }
850    
851                              // reverse the sample frames for backward playback                      case loop_type_backward: { // TODO: not tested yet!
852                              SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);                          // forward playback (not entered the loop yet)
853                          }                          if (!pPlaybackState->reverse) do {
854                      } while (samplestoread && readsamples);                              samplestoloopend  = loopEnd - GetPos();
855                      break;                              readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
856                  }                              samplestoread    -= readsamples;
857                                totalreadsamples += readsamples;
858                  case loop_type_backward: { // TODO: not tested yet!                              if (readsamples == samplestoloopend) {
859                      // forward playback (not entered the loop yet)                                  pPlaybackState->reverse = true;
860                      if (!pPlaybackState->reverse) do {                                  break;
861                          samplestoloopend  = this->LoopEnd - GetPos();                              }
862                          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);  
863    
864                      if (!samplestoread) break;                          if (!samplestoread) break;
865    
866                      // as we can only read forward from disk, we have to                          // as we can only read forward from disk, we have to
867                      // determine the end position within the loop first,                          // determine the end position within the loop first,
868                      // read forward from that 'end' and finally after                          // read forward from that 'end' and finally after
869                      // reading, swap all sample frames so it reflects                          // reading, swap all sample frames so it reflects
870                      // backward playback                          // backward playback
871    
872                      unsigned long swapareastart       = totalreadsamples;                          unsigned long swapareastart       = totalreadsamples;
873                      unsigned long loopoffset          = GetPos() - this->LoopStart;                          unsigned long loopoffset          = GetPos() - loop.LoopStart;
874                      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)
875                                                                                : samplestoread;                                                                                    : samplestoread;
876                      unsigned long reverseplaybackend  = this->LoopStart + Abs((loopoffset - samplestoreadinloop) % this->LoopSize);                          unsigned long reverseplaybackend  = loop.LoopStart + Abs((loopoffset - samplestoreadinloop) % loop.LoopLength);
877    
878                      SetPos(reverseplaybackend);                          SetPos(reverseplaybackend);
879    
880                      // read samples for backward playback                          // read samples for backward playback
881                      do {                          do {
882                          // 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
883                          if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;                              if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
884                          samplestoloopend     = this->LoopEnd - GetPos();                              samplestoloopend     = loopEnd - GetPos();
885                          readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoreadinloop, samplestoloopend), pExternalDecompressionBuffer);                              readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoreadinloop, samplestoloopend), pExternalDecompressionBuffer);
886                          samplestoreadinloop -= readsamples;                              samplestoreadinloop -= readsamples;
887                          samplestoread       -= readsamples;                              samplestoread       -= readsamples;
888                          totalreadsamples    += readsamples;                              totalreadsamples    += readsamples;
889                          if (readsamples == samplestoloopend) {                              if (readsamples == samplestoloopend) {
890                              pPlaybackState->loop_cycles_left--;                                  pPlaybackState->loop_cycles_left--;
891                              SetPos(this->LoopStart);                                  SetPos(loop.LoopStart);
892                          }                              }
893                      } while (samplestoreadinloop && readsamples);                          } while (samplestoreadinloop && readsamples);
894    
895                      SetPos(reverseplaybackend); // pretend we really read backwards                          SetPos(reverseplaybackend); // pretend we really read backwards
896    
897                      // reverse the sample frames for backward playback                          // reverse the sample frames for backward playback
898                      SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);                          SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
899                      break;                          break;
900                  }                      }
901    
902                  default: case loop_type_normal: {                      default: case loop_type_normal: {
903                      do {                          do {
904                          // 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
905                          if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;                              if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
906                          samplestoloopend  = this->LoopEnd - GetPos();                              samplestoloopend  = loopEnd - GetPos();
907                          readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);                              readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
908                          samplestoread    -= readsamples;                              samplestoread    -= readsamples;
909                          totalreadsamples += readsamples;                              totalreadsamples += readsamples;
910                          if (readsamples == samplestoloopend) {                              if (readsamples == samplestoloopend) {
911                              pPlaybackState->loop_cycles_left--;                                  pPlaybackState->loop_cycles_left--;
912                              SetPos(this->LoopStart);                                  SetPos(loop.LoopStart);
913                          }                              }
914                      } while (samplestoread && readsamples);                          } while (samplestoread && readsamples);
915                      break;                          break;
916                        }
917                  }                  }
918              }              }
919          }          }
# Line 741  namespace { Line 943  namespace {
943       * have to use an external decompression buffer for <b>EACH</b>       * have to use an external decompression buffer for <b>EACH</b>
944       * streaming thread to avoid race conditions and crashes!       * streaming thread to avoid race conditions and crashes!
945       *       *
946         * For 16 bit samples, the data in the buffer will be int16_t
947         * (using native endianness). For 24 bit, the buffer will
948         * contain three bytes per sample, little-endian.
949         *
950       * @param pBuffer      destination buffer       * @param pBuffer      destination buffer
951       * @param SampleCount  number of sample points to read       * @param SampleCount  number of sample points to read
952       * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression       * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression
# Line 751  namespace { Line 957  namespace {
957          if (SampleCount == 0) return 0;          if (SampleCount == 0) return 0;
958          if (!Compressed) {          if (!Compressed) {
959              if (BitDepth == 24) {              if (BitDepth == 24) {
960                  // 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);  
                 }  
961              }              }
962              else { // 16 bit              else { // 16 bit
963                  // (pCkData->Read does endian correction)                  // (pCkData->Read does endian correction)
# Line 801  namespace { Line 987  namespace {
987    
988              unsigned char* pSrc = (unsigned char*) pDecompressionBuffer->pStart;              unsigned char* pSrc = (unsigned char*) pDecompressionBuffer->pStart;
989              int16_t* pDst = static_cast<int16_t*>(pBuffer);              int16_t* pDst = static_cast<int16_t*>(pBuffer);
990                uint8_t* pDst24 = static_cast<uint8_t*>(pBuffer);
991              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);
992    
993              while (remainingsamples && remainingbytes) {              while (remainingsamples && remainingbytes) {
# Line 882  namespace { Line 1069  namespace {
1069                              const unsigned char* const param_r = pSrc;                              const unsigned char* const param_r = pSrc;
1070                              if (mode_r != 2) pSrc += 12;                              if (mode_r != 2) pSrc += 12;
1071    
1072                              Decompress24(mode_l, param_l, 2, pSrc, pDst,                              Decompress24(mode_l, param_l, 6, pSrc, pDst24,
1073                                           skipsamples, copysamples, TruncatedBits);                                           skipsamples, copysamples, TruncatedBits);
1074                              Decompress24(mode_r, param_r, 2, pSrc + rightChannelOffset, pDst + 1,                              Decompress24(mode_r, param_r, 6, pSrc + rightChannelOffset, pDst24 + 3,
1075                                           skipsamples, copysamples, TruncatedBits);                                           skipsamples, copysamples, TruncatedBits);
1076                              pDst += copysamples << 1;                              pDst24 += copysamples * 6;
1077                          }                          }
1078                          else { // Mono                          else { // Mono
1079                              Decompress24(mode_l, param_l, 1, pSrc, pDst,                              Decompress24(mode_l, param_l, 3, pSrc, pDst24,
1080                                           skipsamples, copysamples, TruncatedBits);                                           skipsamples, copysamples, TruncatedBits);
1081                              pDst += copysamples;                              pDst24 += copysamples * 3;
1082                          }                          }
1083                      }                      }
1084                      else { // 16 bit                      else { // 16 bit
# Line 933  namespace { Line 1120  namespace {
1120          }          }
1121      }      }
1122    
1123        /** @brief Write sample wave data.
1124         *
1125         * Writes \a SampleCount number of sample points from the buffer pointed
1126         * by \a pBuffer and increments the position within the sample. Use this
1127         * method to directly write the sample data to disk, i.e. if you don't
1128         * want or cannot load the whole sample data into RAM.
1129         *
1130         * You have to Resize() the sample to the desired size and call
1131         * File::Save() <b>before</b> using Write().
1132         *
1133         * Note: there is currently no support for writing compressed samples.
1134         *
1135         * @param pBuffer     - source buffer
1136         * @param SampleCount - number of sample points to write
1137         * @throws DLS::Exception if current sample size is too small
1138         * @throws gig::Exception if sample is compressed
1139         * @see DLS::LoadSampleData()
1140         */
1141        unsigned long Sample::Write(void* pBuffer, unsigned long SampleCount) {
1142            if (Compressed) throw gig::Exception("There is no support for writing compressed gig samples (yet)");
1143            return DLS::Sample::Write(pBuffer, SampleCount);
1144        }
1145    
1146      /**      /**
1147       * Allocates a decompression buffer for streaming (compressed) samples       * Allocates a decompression buffer for streaming (compressed) samples
1148       * with Sample::Read(). If you are using more than one streaming thread       * with Sample::Read(). If you are using more than one streaming thread
# Line 975  namespace { Line 1185  namespace {
1185          }          }
1186      }      }
1187    
1188        /**
1189         * Returns pointer to the Group this Sample belongs to. In the .gig
1190         * format a sample always belongs to one group. If it wasn't explicitly
1191         * assigned to a certain group, it will be automatically assigned to a
1192         * default group.
1193         *
1194         * @returns Sample's Group (never NULL)
1195         */
1196        Group* Sample::GetGroup() const {
1197            return pGroup;
1198        }
1199    
1200      Sample::~Sample() {      Sample::~Sample() {
1201          Instances--;          Instances--;
1202          if (!Instances && InternalDecompressionBuffer.Size) {          if (!Instances && InternalDecompressionBuffer.Size) {
# Line 997  namespace { Line 1219  namespace {
1219      DimensionRegion::DimensionRegion(RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {      DimensionRegion::DimensionRegion(RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {
1220          Instances++;          Instances++;
1221    
1222            pSample = NULL;
1223    
1224          memcpy(&Crossfade, &SamplerOptions, 4);          memcpy(&Crossfade, &SamplerOptions, 4);
1225          if (!pVelocityTables) pVelocityTables = new VelocityTableMap;          if (!pVelocityTables) pVelocityTables = new VelocityTableMap;
1226    
1227          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);
1228          _3ewa->ReadInt32(); // unknown, always 0x0000008C ?          if (_3ewa) { // if '3ewa' chunk exists
1229          LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              _3ewa->ReadInt32(); // unknown, always == chunk size ?
1230          EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1231          _3ewa->ReadInt16(); // unknown              EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1232          LFO1InternalDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1233          _3ewa->ReadInt16(); // unknown              LFO1InternalDepth = _3ewa->ReadUint16();
1234          LFO3InternalDepth = _3ewa->ReadInt16();              _3ewa->ReadInt16(); // unknown
1235          _3ewa->ReadInt16(); // unknown              LFO3InternalDepth = _3ewa->ReadInt16();
1236          LFO1ControlDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1237          _3ewa->ReadInt16(); // unknown              LFO1ControlDepth = _3ewa->ReadUint16();
1238          LFO3ControlDepth = _3ewa->ReadInt16();              _3ewa->ReadInt16(); // unknown
1239          EG1Attack           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO3ControlDepth = _3ewa->ReadInt16();
1240          EG1Decay1           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG1Attack           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1241          _3ewa->ReadInt16(); // unknown              EG1Decay1           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1242          EG1Sustain          = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1243          EG1Release          = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG1Sustain          = _3ewa->ReadUint16();
1244          EG1Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));              EG1Release          = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1245          uint8_t eg1ctrloptions        = _3ewa->ReadUint8();              EG1Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1246          EG1ControllerInvert           = eg1ctrloptions & 0x01;              uint8_t eg1ctrloptions        = _3ewa->ReadUint8();
1247          EG1ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg1ctrloptions);              EG1ControllerInvert           = eg1ctrloptions & 0x01;
1248          EG1ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg1ctrloptions);              EG1ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg1ctrloptions);
1249          EG1ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg1ctrloptions);              EG1ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg1ctrloptions);
1250          EG2Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));              EG1ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg1ctrloptions);
1251          uint8_t eg2ctrloptions        = _3ewa->ReadUint8();              EG2Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1252          EG2ControllerInvert           = eg2ctrloptions & 0x01;              uint8_t eg2ctrloptions        = _3ewa->ReadUint8();
1253          EG2ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg2ctrloptions);              EG2ControllerInvert           = eg2ctrloptions & 0x01;
1254          EG2ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg2ctrloptions);              EG2ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg2ctrloptions);
1255          EG2ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg2ctrloptions);              EG2ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg2ctrloptions);
1256          LFO1Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG2ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg2ctrloptions);
1257          EG2Attack        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO1Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1258          EG2Decay1        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG2Attack        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1259          _3ewa->ReadInt16(); // unknown              EG2Decay1        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1260          EG2Sustain       = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1261          EG2Release       = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG2Sustain       = _3ewa->ReadUint16();
1262          _3ewa->ReadInt16(); // unknown              EG2Release       = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1263          LFO2ControlDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1264          LFO2Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO2ControlDepth = _3ewa->ReadUint16();
1265          _3ewa->ReadInt16(); // unknown              LFO2Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1266          LFO2InternalDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1267          int32_t eg1decay2 = _3ewa->ReadInt32();              LFO2InternalDepth = _3ewa->ReadUint16();
1268          EG1Decay2          = (double) GIG_EXP_DECODE(eg1decay2);              int32_t eg1decay2 = _3ewa->ReadInt32();
1269          EG1InfiniteSustain = (eg1decay2 == 0x7fffffff);              EG1Decay2          = (double) GIG_EXP_DECODE(eg1decay2);
1270          _3ewa->ReadInt16(); // unknown              EG1InfiniteSustain = (eg1decay2 == 0x7fffffff);
1271          EG1PreAttack      = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1272          int32_t eg2decay2 = _3ewa->ReadInt32();              EG1PreAttack      = _3ewa->ReadUint16();
1273          EG2Decay2         = (double) GIG_EXP_DECODE(eg2decay2);              int32_t eg2decay2 = _3ewa->ReadInt32();
1274          EG2InfiniteSustain = (eg2decay2 == 0x7fffffff);              EG2Decay2         = (double) GIG_EXP_DECODE(eg2decay2);
1275          _3ewa->ReadInt16(); // unknown              EG2InfiniteSustain = (eg2decay2 == 0x7fffffff);
1276          EG2PreAttack      = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1277          uint8_t velocityresponse = _3ewa->ReadUint8();              EG2PreAttack      = _3ewa->ReadUint16();
1278          if (velocityresponse < 5) {              uint8_t velocityresponse = _3ewa->ReadUint8();
1279              VelocityResponseCurve = curve_type_nonlinear;              if (velocityresponse < 5) {
1280              VelocityResponseDepth = velocityresponse;                  VelocityResponseCurve = curve_type_nonlinear;
1281          }                  VelocityResponseDepth = velocityresponse;
1282          else if (velocityresponse < 10) {              } else if (velocityresponse < 10) {
1283              VelocityResponseCurve = curve_type_linear;                  VelocityResponseCurve = curve_type_linear;
1284              VelocityResponseDepth = velocityresponse - 5;                  VelocityResponseDepth = velocityresponse - 5;
1285          }              } else if (velocityresponse < 15) {
1286          else if (velocityresponse < 15) {                  VelocityResponseCurve = curve_type_special;
1287              VelocityResponseCurve = curve_type_special;                  VelocityResponseDepth = velocityresponse - 10;
1288              VelocityResponseDepth = velocityresponse - 10;              } else {
1289          }                  VelocityResponseCurve = curve_type_unknown;
1290          else {                  VelocityResponseDepth = 0;
1291              VelocityResponseCurve = curve_type_unknown;              }
1292              VelocityResponseDepth = 0;              uint8_t releasevelocityresponse = _3ewa->ReadUint8();
1293          }              if (releasevelocityresponse < 5) {
1294          uint8_t releasevelocityresponse = _3ewa->ReadUint8();                  ReleaseVelocityResponseCurve = curve_type_nonlinear;
1295          if (releasevelocityresponse < 5) {                  ReleaseVelocityResponseDepth = releasevelocityresponse;
1296              ReleaseVelocityResponseCurve = curve_type_nonlinear;              } else if (releasevelocityresponse < 10) {
1297              ReleaseVelocityResponseDepth = releasevelocityresponse;                  ReleaseVelocityResponseCurve = curve_type_linear;
1298          }                  ReleaseVelocityResponseDepth = releasevelocityresponse - 5;
1299          else if (releasevelocityresponse < 10) {              } else if (releasevelocityresponse < 15) {
1300              ReleaseVelocityResponseCurve = curve_type_linear;                  ReleaseVelocityResponseCurve = curve_type_special;
1301              ReleaseVelocityResponseDepth = releasevelocityresponse - 5;                  ReleaseVelocityResponseDepth = releasevelocityresponse - 10;
1302          }              } else {
1303          else if (releasevelocityresponse < 15) {                  ReleaseVelocityResponseCurve = curve_type_unknown;
1304              ReleaseVelocityResponseCurve = curve_type_special;                  ReleaseVelocityResponseDepth = 0;
1305              ReleaseVelocityResponseDepth = releasevelocityresponse - 10;              }
1306          }              VelocityResponseCurveScaling = _3ewa->ReadUint8();
1307          else {              AttenuationControllerThreshold = _3ewa->ReadInt8();
1308              ReleaseVelocityResponseCurve = curve_type_unknown;              _3ewa->ReadInt32(); // unknown
1309              ReleaseVelocityResponseDepth = 0;              SampleStartOffset = (uint16_t) _3ewa->ReadInt16();
1310          }              _3ewa->ReadInt16(); // unknown
1311          VelocityResponseCurveScaling = _3ewa->ReadUint8();              uint8_t pitchTrackDimensionBypass = _3ewa->ReadInt8();
1312          AttenuationControllerThreshold = _3ewa->ReadInt8();              PitchTrack = GIG_PITCH_TRACK_EXTRACT(pitchTrackDimensionBypass);
1313          _3ewa->ReadInt32(); // unknown              if      (pitchTrackDimensionBypass & 0x10) DimensionBypass = dim_bypass_ctrl_94;
1314          SampleStartOffset = (uint16_t) _3ewa->ReadInt16();              else if (pitchTrackDimensionBypass & 0x20) DimensionBypass = dim_bypass_ctrl_95;
1315          _3ewa->ReadInt16(); // unknown              else                                       DimensionBypass = dim_bypass_ctrl_none;
1316          uint8_t pitchTrackDimensionBypass = _3ewa->ReadInt8();              uint8_t pan = _3ewa->ReadUint8();
1317          PitchTrack = GIG_PITCH_TRACK_EXTRACT(pitchTrackDimensionBypass);              Pan         = (pan < 64) ? pan : -((int)pan - 63); // signed 7 bit -> signed 8 bit
1318          if      (pitchTrackDimensionBypass & 0x10) DimensionBypass = dim_bypass_ctrl_94;              SelfMask = _3ewa->ReadInt8() & 0x01;
1319          else if (pitchTrackDimensionBypass & 0x20) DimensionBypass = dim_bypass_ctrl_95;              _3ewa->ReadInt8(); // unknown
1320          else                                       DimensionBypass = dim_bypass_ctrl_none;              uint8_t lfo3ctrl = _3ewa->ReadUint8();
1321          uint8_t pan = _3ewa->ReadUint8();              LFO3Controller           = static_cast<lfo3_ctrl_t>(lfo3ctrl & 0x07); // lower 3 bits
1322          Pan         = (pan < 64) ? pan : -((int)pan - 63); // signed 7 bit -> signed 8 bit              LFO3Sync                 = lfo3ctrl & 0x20; // bit 5
1323          SelfMask = _3ewa->ReadInt8() & 0x01;              InvertAttenuationController = lfo3ctrl & 0x80; // bit 7
1324          _3ewa->ReadInt8(); // unknown              AttenuationController  = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1325          uint8_t lfo3ctrl = _3ewa->ReadUint8();              uint8_t lfo2ctrl       = _3ewa->ReadUint8();
1326          LFO3Controller           = static_cast<lfo3_ctrl_t>(lfo3ctrl & 0x07); // lower 3 bits              LFO2Controller         = static_cast<lfo2_ctrl_t>(lfo2ctrl & 0x07); // lower 3 bits
1327          LFO3Sync                 = lfo3ctrl & 0x20; // bit 5              LFO2FlipPhase          = lfo2ctrl & 0x80; // bit 7
1328          InvertAttenuationController = lfo3ctrl & 0x80; // bit 7              LFO2Sync               = lfo2ctrl & 0x20; // bit 5
1329          AttenuationController  = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));              bool extResonanceCtrl  = lfo2ctrl & 0x40; // bit 6
1330          uint8_t lfo2ctrl       = _3ewa->ReadUint8();              uint8_t lfo1ctrl       = _3ewa->ReadUint8();
1331          LFO2Controller         = static_cast<lfo2_ctrl_t>(lfo2ctrl & 0x07); // lower 3 bits              LFO1Controller         = static_cast<lfo1_ctrl_t>(lfo1ctrl & 0x07); // lower 3 bits
1332          LFO2FlipPhase          = lfo2ctrl & 0x80; // bit 7              LFO1FlipPhase          = lfo1ctrl & 0x80; // bit 7
1333          LFO2Sync               = lfo2ctrl & 0x20; // bit 5              LFO1Sync               = lfo1ctrl & 0x40; // bit 6
1334          bool extResonanceCtrl  = lfo2ctrl & 0x40; // bit 6              VCFResonanceController = (extResonanceCtrl) ? static_cast<vcf_res_ctrl_t>(GIG_VCF_RESONANCE_CTRL_EXTRACT(lfo1ctrl))
1335          uint8_t lfo1ctrl       = _3ewa->ReadUint8();                                                          : vcf_res_ctrl_none;
1336          LFO1Controller         = static_cast<lfo1_ctrl_t>(lfo1ctrl & 0x07); // lower 3 bits              uint16_t eg3depth = _3ewa->ReadUint16();
1337          LFO1FlipPhase          = lfo1ctrl & 0x80; // bit 7              EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */
1338          LFO1Sync               = lfo1ctrl & 0x40; // bit 6                                          : (-1) * (int16_t) ((eg3depth ^ 0xffff) + 1); /* binary complementary for negatives */
1339          VCFResonanceController = (extResonanceCtrl) ? static_cast<vcf_res_ctrl_t>(GIG_VCF_RESONANCE_CTRL_EXTRACT(lfo1ctrl))              _3ewa->ReadInt16(); // unknown
1340                                                      : vcf_res_ctrl_none;              ChannelOffset = _3ewa->ReadUint8() / 4;
1341          uint16_t eg3depth = _3ewa->ReadUint16();              uint8_t regoptions = _3ewa->ReadUint8();
1342          EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */              MSDecode           = regoptions & 0x01; // bit 0
1343                                        : (-1) * (int16_t) ((eg3depth ^ 0xffff) + 1); /* binary complementary for negatives */              SustainDefeat      = regoptions & 0x02; // bit 1
1344          _3ewa->ReadInt16(); // unknown              _3ewa->ReadInt16(); // unknown
1345          ChannelOffset = _3ewa->ReadUint8() / 4;              VelocityUpperLimit = _3ewa->ReadInt8();
1346          uint8_t regoptions = _3ewa->ReadUint8();              _3ewa->ReadInt8(); // unknown
1347          MSDecode           = regoptions & 0x01; // bit 0              _3ewa->ReadInt16(); // unknown
1348          SustainDefeat      = regoptions & 0x02; // bit 1              ReleaseTriggerDecay = _3ewa->ReadUint8(); // release trigger decay
1349          _3ewa->ReadInt16(); // unknown              _3ewa->ReadInt8(); // unknown
1350          VelocityUpperLimit = _3ewa->ReadInt8();              _3ewa->ReadInt8(); // unknown
1351          _3ewa->ReadInt8(); // unknown              EG1Hold = _3ewa->ReadUint8() & 0x80; // bit 7
1352          _3ewa->ReadInt16(); // unknown              uint8_t vcfcutoff = _3ewa->ReadUint8();
1353          ReleaseTriggerDecay = _3ewa->ReadUint8(); // release trigger decay              VCFEnabled = vcfcutoff & 0x80; // bit 7
1354          _3ewa->ReadInt8(); // unknown              VCFCutoff  = vcfcutoff & 0x7f; // lower 7 bits
1355          _3ewa->ReadInt8(); // unknown              VCFCutoffController = static_cast<vcf_cutoff_ctrl_t>(_3ewa->ReadUint8());
1356          EG1Hold = _3ewa->ReadUint8() & 0x80; // bit 7              uint8_t vcfvelscale = _3ewa->ReadUint8();
1357          uint8_t vcfcutoff = _3ewa->ReadUint8();              VCFCutoffControllerInvert = vcfvelscale & 0x80; // bit 7
1358          VCFEnabled = vcfcutoff & 0x80; // bit 7              VCFVelocityScale = vcfvelscale & 0x7f; // lower 7 bits
1359          VCFCutoff  = vcfcutoff & 0x7f; // lower 7 bits              _3ewa->ReadInt8(); // unknown
1360          VCFCutoffController = static_cast<vcf_cutoff_ctrl_t>(_3ewa->ReadUint8());              uint8_t vcfresonance = _3ewa->ReadUint8();
1361          uint8_t vcfvelscale = _3ewa->ReadUint8();              VCFResonance = vcfresonance & 0x7f; // lower 7 bits
1362          VCFCutoffControllerInvert = vcfvelscale & 0x80; // bit 7              VCFResonanceDynamic = !(vcfresonance & 0x80); // bit 7
1363          VCFVelocityScale = vcfvelscale & 0x7f; // lower 7 bits              uint8_t vcfbreakpoint         = _3ewa->ReadUint8();
1364          _3ewa->ReadInt8(); // unknown              VCFKeyboardTracking           = vcfbreakpoint & 0x80; // bit 7
1365          uint8_t vcfresonance = _3ewa->ReadUint8();              VCFKeyboardTrackingBreakpoint = vcfbreakpoint & 0x7f; // lower 7 bits
1366          VCFResonance = vcfresonance & 0x7f; // lower 7 bits              uint8_t vcfvelocity = _3ewa->ReadUint8();
1367          VCFResonanceDynamic = !(vcfresonance & 0x80); // bit 7              VCFVelocityDynamicRange = vcfvelocity % 5;
1368          uint8_t vcfbreakpoint         = _3ewa->ReadUint8();              VCFVelocityCurve        = static_cast<curve_type_t>(vcfvelocity / 5);
1369          VCFKeyboardTracking           = vcfbreakpoint & 0x80; // bit 7              VCFType = static_cast<vcf_type_t>(_3ewa->ReadUint8());
1370          VCFKeyboardTrackingBreakpoint = vcfbreakpoint & 0x7f; // lower 7 bits              if (VCFType == vcf_type_lowpass) {
1371          uint8_t vcfvelocity = _3ewa->ReadUint8();                  if (lfo3ctrl & 0x40) // bit 6
1372          VCFVelocityDynamicRange = vcfvelocity % 5;                      VCFType = vcf_type_lowpassturbo;
1373          VCFVelocityCurve        = static_cast<curve_type_t>(vcfvelocity / 5);              }
1374          VCFType = static_cast<vcf_type_t>(_3ewa->ReadUint8());              if (_3ewa->RemainingBytes() >= 8) {
1375          if (VCFType == vcf_type_lowpass) {                  _3ewa->Read(DimensionUpperLimits, 1, 8);
1376              if (lfo3ctrl & 0x40) // bit 6              } else {
1377                  VCFType = vcf_type_lowpassturbo;                  memset(DimensionUpperLimits, 0, 8);
1378                }
1379            } else { // '3ewa' chunk does not exist yet
1380                // use default values
1381                LFO3Frequency                   = 1.0;
1382                EG3Attack                       = 0.0;
1383                LFO1InternalDepth               = 0;
1384                LFO3InternalDepth               = 0;
1385                LFO1ControlDepth                = 0;
1386                LFO3ControlDepth                = 0;
1387                EG1Attack                       = 0.0;
1388                EG1Decay1                       = 0.0;
1389                EG1Sustain                      = 0;
1390                EG1Release                      = 0.0;
1391                EG1Controller.type              = eg1_ctrl_t::type_none;
1392                EG1Controller.controller_number = 0;
1393                EG1ControllerInvert             = false;
1394                EG1ControllerAttackInfluence    = 0;
1395                EG1ControllerDecayInfluence     = 0;
1396                EG1ControllerReleaseInfluence   = 0;
1397                EG2Controller.type              = eg2_ctrl_t::type_none;
1398                EG2Controller.controller_number = 0;
1399                EG2ControllerInvert             = false;
1400                EG2ControllerAttackInfluence    = 0;
1401                EG2ControllerDecayInfluence     = 0;
1402                EG2ControllerReleaseInfluence   = 0;
1403                LFO1Frequency                   = 1.0;
1404                EG2Attack                       = 0.0;
1405                EG2Decay1                       = 0.0;
1406                EG2Sustain                      = 0;
1407                EG2Release                      = 0.0;
1408                LFO2ControlDepth                = 0;
1409                LFO2Frequency                   = 1.0;
1410                LFO2InternalDepth               = 0;
1411                EG1Decay2                       = 0.0;
1412                EG1InfiniteSustain              = false;
1413                EG1PreAttack                    = 1000;
1414                EG2Decay2                       = 0.0;
1415                EG2InfiniteSustain              = false;
1416                EG2PreAttack                    = 1000;
1417                VelocityResponseCurve           = curve_type_nonlinear;
1418                VelocityResponseDepth           = 3;
1419                ReleaseVelocityResponseCurve    = curve_type_nonlinear;
1420                ReleaseVelocityResponseDepth    = 3;
1421                VelocityResponseCurveScaling    = 32;
1422                AttenuationControllerThreshold  = 0;
1423                SampleStartOffset               = 0;
1424                PitchTrack                      = true;
1425                DimensionBypass                 = dim_bypass_ctrl_none;
1426                Pan                             = 0;
1427                SelfMask                        = true;
1428                LFO3Controller                  = lfo3_ctrl_modwheel;
1429                LFO3Sync                        = false;
1430                InvertAttenuationController     = false;
1431                AttenuationController.type      = attenuation_ctrl_t::type_none;
1432                AttenuationController.controller_number = 0;
1433                LFO2Controller                  = lfo2_ctrl_internal;
1434                LFO2FlipPhase                   = false;
1435                LFO2Sync                        = false;
1436                LFO1Controller                  = lfo1_ctrl_internal;
1437                LFO1FlipPhase                   = false;
1438                LFO1Sync                        = false;
1439                VCFResonanceController          = vcf_res_ctrl_none;
1440                EG3Depth                        = 0;
1441                ChannelOffset                   = 0;
1442                MSDecode                        = false;
1443                SustainDefeat                   = false;
1444                VelocityUpperLimit              = 0;
1445                ReleaseTriggerDecay             = 0;
1446                EG1Hold                         = false;
1447                VCFEnabled                      = false;
1448                VCFCutoff                       = 0;
1449                VCFCutoffController             = vcf_cutoff_ctrl_none;
1450                VCFCutoffControllerInvert       = false;
1451                VCFVelocityScale                = 0;
1452                VCFResonance                    = 0;
1453                VCFResonanceDynamic             = false;
1454                VCFKeyboardTracking             = false;
1455                VCFKeyboardTrackingBreakpoint   = 0;
1456                VCFVelocityDynamicRange         = 0x04;
1457                VCFVelocityCurve                = curve_type_linear;
1458                VCFType                         = vcf_type_lowpass;
1459                memset(DimensionUpperLimits, 0, 8);
1460          }          }
1461    
1462          pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,          pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,
# Line 1182  namespace { Line 1488  namespace {
1488              depth = 5;              depth = 5;
1489          }          }
1490          pVelocityCutoffTable = GetVelocityTable(curveType, depth,          pVelocityCutoffTable = GetVelocityTable(curveType, depth,
1491                                                  VCFCutoffController == vcf_cutoff_ctrl_none ? VCFVelocityScale : 0);                                                  VCFCutoffController <= vcf_cutoff_ctrl_none2 ? VCFVelocityScale : 0);
1492    
1493          SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));          SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));
1494            VelocityTable = 0;
1495        }
1496    
1497        /**
1498         * Apply dimension region settings to the respective RIFF chunks. You
1499         * have to call File::Save() to make changes persistent.
1500         *
1501         * Usually there is absolutely no need to call this method explicitly.
1502         * It will be called automatically when File::Save() was called.
1503         */
1504        void DimensionRegion::UpdateChunks() {
1505            // first update base class's chunk
1506            DLS::Sampler::UpdateChunks();
1507    
1508            // make sure '3ewa' chunk exists
1509            RIFF::Chunk* _3ewa = pParentList->GetSubChunk(CHUNK_ID_3EWA);
1510            if (!_3ewa)  _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, 140);
1511            uint8_t* pData = (uint8_t*) _3ewa->LoadChunkData();
1512    
1513            // update '3ewa' chunk with DimensionRegion's current settings
1514    
1515            const uint32_t chunksize = _3ewa->GetNewSize();
1516            store32(&pData[0], chunksize); // unknown, always chunk size?
1517    
1518            const int32_t lfo3freq = (int32_t) GIG_EXP_ENCODE(LFO3Frequency);
1519            store32(&pData[4], lfo3freq);
1520    
1521            const int32_t eg3attack = (int32_t) GIG_EXP_ENCODE(EG3Attack);
1522            store32(&pData[8], eg3attack);
1523    
1524            // next 2 bytes unknown
1525    
1526            store16(&pData[14], LFO1InternalDepth);
1527    
1528            // next 2 bytes unknown
1529    
1530            store16(&pData[18], LFO3InternalDepth);
1531    
1532            // next 2 bytes unknown
1533    
1534            store16(&pData[22], LFO1ControlDepth);
1535    
1536            // next 2 bytes unknown
1537    
1538            store16(&pData[26], LFO3ControlDepth);
1539    
1540            const int32_t eg1attack = (int32_t) GIG_EXP_ENCODE(EG1Attack);
1541            store32(&pData[28], eg1attack);
1542    
1543            const int32_t eg1decay1 = (int32_t) GIG_EXP_ENCODE(EG1Decay1);
1544            store32(&pData[32], eg1decay1);
1545    
1546            // next 2 bytes unknown
1547    
1548            store16(&pData[38], EG1Sustain);
1549    
1550            const int32_t eg1release = (int32_t) GIG_EXP_ENCODE(EG1Release);
1551            store32(&pData[40], eg1release);
1552    
1553            const uint8_t eg1ctl = (uint8_t) EncodeLeverageController(EG1Controller);
1554            pData[44] = eg1ctl;
1555    
1556            const uint8_t eg1ctrloptions =
1557                (EG1ControllerInvert) ? 0x01 : 0x00 |
1558                GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG1ControllerAttackInfluence) |
1559                GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG1ControllerDecayInfluence) |
1560                GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG1ControllerReleaseInfluence);
1561            pData[45] = eg1ctrloptions;
1562    
1563            const uint8_t eg2ctl = (uint8_t) EncodeLeverageController(EG2Controller);
1564            pData[46] = eg2ctl;
1565    
1566            const uint8_t eg2ctrloptions =
1567                (EG2ControllerInvert) ? 0x01 : 0x00 |
1568                GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG2ControllerAttackInfluence) |
1569                GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG2ControllerDecayInfluence) |
1570                GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG2ControllerReleaseInfluence);
1571            pData[47] = eg2ctrloptions;
1572    
1573            const int32_t lfo1freq = (int32_t) GIG_EXP_ENCODE(LFO1Frequency);
1574            store32(&pData[48], lfo1freq);
1575    
1576            const int32_t eg2attack = (int32_t) GIG_EXP_ENCODE(EG2Attack);
1577            store32(&pData[52], eg2attack);
1578    
1579            const int32_t eg2decay1 = (int32_t) GIG_EXP_ENCODE(EG2Decay1);
1580            store32(&pData[56], eg2decay1);
1581    
1582            // next 2 bytes unknown
1583    
1584            store16(&pData[62], EG2Sustain);
1585    
1586            const int32_t eg2release = (int32_t) GIG_EXP_ENCODE(EG2Release);
1587            store32(&pData[64], eg2release);
1588    
1589            // next 2 bytes unknown
1590    
1591            store16(&pData[70], LFO2ControlDepth);
1592    
1593            const int32_t lfo2freq = (int32_t) GIG_EXP_ENCODE(LFO2Frequency);
1594            store32(&pData[72], lfo2freq);
1595    
1596            // next 2 bytes unknown
1597    
1598            store16(&pData[78], LFO2InternalDepth);
1599    
1600            const int32_t eg1decay2 = (int32_t) (EG1InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG1Decay2);
1601            store32(&pData[80], eg1decay2);
1602    
1603            // next 2 bytes unknown
1604    
1605            store16(&pData[86], EG1PreAttack);
1606    
1607            const int32_t eg2decay2 = (int32_t) (EG2InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG2Decay2);
1608            store32(&pData[88], eg2decay2);
1609    
1610            // next 2 bytes unknown
1611    
1612            store16(&pData[94], EG2PreAttack);
1613    
1614            {
1615                if (VelocityResponseDepth > 4) throw Exception("VelocityResponseDepth must be between 0 and 4");
1616                uint8_t velocityresponse = VelocityResponseDepth;
1617                switch (VelocityResponseCurve) {
1618                    case curve_type_nonlinear:
1619                        break;
1620                    case curve_type_linear:
1621                        velocityresponse += 5;
1622                        break;
1623                    case curve_type_special:
1624                        velocityresponse += 10;
1625                        break;
1626                    case curve_type_unknown:
1627                    default:
1628                        throw Exception("Could not update DimensionRegion's chunk, unknown VelocityResponseCurve selected");
1629                }
1630                pData[96] = velocityresponse;
1631            }
1632    
1633            {
1634                if (ReleaseVelocityResponseDepth > 4) throw Exception("ReleaseVelocityResponseDepth must be between 0 and 4");
1635                uint8_t releasevelocityresponse = ReleaseVelocityResponseDepth;
1636                switch (ReleaseVelocityResponseCurve) {
1637                    case curve_type_nonlinear:
1638                        break;
1639                    case curve_type_linear:
1640                        releasevelocityresponse += 5;
1641                        break;
1642                    case curve_type_special:
1643                        releasevelocityresponse += 10;
1644                        break;
1645                    case curve_type_unknown:
1646                    default:
1647                        throw Exception("Could not update DimensionRegion's chunk, unknown ReleaseVelocityResponseCurve selected");
1648                }
1649                pData[97] = releasevelocityresponse;
1650            }
1651    
1652            pData[98] = VelocityResponseCurveScaling;
1653    
1654            pData[99] = AttenuationControllerThreshold;
1655    
1656            // next 4 bytes unknown
1657    
1658            store16(&pData[104], SampleStartOffset);
1659    
1660            // next 2 bytes unknown
1661    
1662            {
1663                uint8_t pitchTrackDimensionBypass = GIG_PITCH_TRACK_ENCODE(PitchTrack);
1664                switch (DimensionBypass) {
1665                    case dim_bypass_ctrl_94:
1666                        pitchTrackDimensionBypass |= 0x10;
1667                        break;
1668                    case dim_bypass_ctrl_95:
1669                        pitchTrackDimensionBypass |= 0x20;
1670                        break;
1671                    case dim_bypass_ctrl_none:
1672                        //FIXME: should we set anything here?
1673                        break;
1674                    default:
1675                        throw Exception("Could not update DimensionRegion's chunk, unknown DimensionBypass selected");
1676                }
1677                pData[108] = pitchTrackDimensionBypass;
1678            }
1679    
1680            const uint8_t pan = (Pan >= 0) ? Pan : ((-Pan) + 63); // signed 8 bit -> signed 7 bit
1681            pData[109] = pan;
1682    
1683            const uint8_t selfmask = (SelfMask) ? 0x01 : 0x00;
1684            pData[110] = selfmask;
1685    
1686            // next byte unknown
1687    
1688            {
1689                uint8_t lfo3ctrl = LFO3Controller & 0x07; // lower 3 bits
1690                if (LFO3Sync) lfo3ctrl |= 0x20; // bit 5
1691                if (InvertAttenuationController) lfo3ctrl |= 0x80; // bit 7
1692                if (VCFType == vcf_type_lowpassturbo) lfo3ctrl |= 0x40; // bit 6
1693                pData[112] = lfo3ctrl;
1694            }
1695    
1696            const uint8_t attenctl = EncodeLeverageController(AttenuationController);
1697            pData[113] = attenctl;
1698    
1699            {
1700                uint8_t lfo2ctrl = LFO2Controller & 0x07; // lower 3 bits
1701                if (LFO2FlipPhase) lfo2ctrl |= 0x80; // bit 7
1702                if (LFO2Sync)      lfo2ctrl |= 0x20; // bit 5
1703                if (VCFResonanceController != vcf_res_ctrl_none) lfo2ctrl |= 0x40; // bit 6
1704                pData[114] = lfo2ctrl;
1705            }
1706    
1707            {
1708                uint8_t lfo1ctrl = LFO1Controller & 0x07; // lower 3 bits
1709                if (LFO1FlipPhase) lfo1ctrl |= 0x80; // bit 7
1710                if (LFO1Sync)      lfo1ctrl |= 0x40; // bit 6
1711                if (VCFResonanceController != vcf_res_ctrl_none)
1712                    lfo1ctrl |= GIG_VCF_RESONANCE_CTRL_ENCODE(VCFResonanceController);
1713                pData[115] = lfo1ctrl;
1714            }
1715    
1716            const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth
1717                                                      : uint16_t(((-EG3Depth) - 1) ^ 0xffff); /* binary complementary for negatives */
1718            pData[116] = eg3depth;
1719    
1720            // next 2 bytes unknown
1721    
1722            const uint8_t channeloffset = ChannelOffset * 4;
1723            pData[120] = channeloffset;
1724    
1725            {
1726                uint8_t regoptions = 0;
1727                if (MSDecode)      regoptions |= 0x01; // bit 0
1728                if (SustainDefeat) regoptions |= 0x02; // bit 1
1729                pData[121] = regoptions;
1730            }
1731    
1732            // next 2 bytes unknown
1733    
1734            pData[124] = VelocityUpperLimit;
1735    
1736            // next 3 bytes unknown
1737    
1738            pData[128] = ReleaseTriggerDecay;
1739    
1740            // next 2 bytes unknown
1741    
1742            const uint8_t eg1hold = (EG1Hold) ? 0x80 : 0x00; // bit 7
1743            pData[131] = eg1hold;
1744    
1745            const uint8_t vcfcutoff = (VCFEnabled) ? 0x80 : 0x00 |  /* bit 7 */
1746                                      (VCFCutoff & 0x7f);   /* lower 7 bits */
1747            pData[132] = vcfcutoff;
1748    
1749            pData[133] = VCFCutoffController;
1750    
1751            const uint8_t vcfvelscale = (VCFCutoffControllerInvert) ? 0x80 : 0x00 | /* bit 7 */
1752                                        (VCFVelocityScale & 0x7f); /* lower 7 bits */
1753            pData[134] = vcfvelscale;
1754    
1755            // next byte unknown
1756    
1757            const uint8_t vcfresonance = (VCFResonanceDynamic) ? 0x00 : 0x80 | /* bit 7 */
1758                                         (VCFResonance & 0x7f); /* lower 7 bits */
1759            pData[136] = vcfresonance;
1760    
1761            const uint8_t vcfbreakpoint = (VCFKeyboardTracking) ? 0x80 : 0x00 | /* bit 7 */
1762                                          (VCFKeyboardTrackingBreakpoint & 0x7f); /* lower 7 bits */
1763            pData[137] = vcfbreakpoint;
1764    
1765            const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 |
1766                                        VCFVelocityCurve * 5;
1767            pData[138] = vcfvelocity;
1768    
1769            const uint8_t vcftype = (VCFType == vcf_type_lowpassturbo) ? vcf_type_lowpass : VCFType;
1770            pData[139] = vcftype;
1771    
1772            if (chunksize >= 148) {
1773                memcpy(&pData[140], DimensionUpperLimits, 8);
1774            }
1775      }      }
1776    
1777      // 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 1320  namespace { Line 1907  namespace {
1907          return decodedcontroller;          return decodedcontroller;
1908      }      }
1909    
1910        DimensionRegion::_lev_ctrl_t DimensionRegion::EncodeLeverageController(leverage_ctrl_t DecodedController) {
1911            _lev_ctrl_t encodedcontroller;
1912            switch (DecodedController.type) {
1913                // special controller
1914                case leverage_ctrl_t::type_none:
1915                    encodedcontroller = _lev_ctrl_none;
1916                    break;
1917                case leverage_ctrl_t::type_velocity:
1918                    encodedcontroller = _lev_ctrl_velocity;
1919                    break;
1920                case leverage_ctrl_t::type_channelaftertouch:
1921                    encodedcontroller = _lev_ctrl_channelaftertouch;
1922                    break;
1923    
1924                // ordinary MIDI control change controller
1925                case leverage_ctrl_t::type_controlchange:
1926                    switch (DecodedController.controller_number) {
1927                        case 1:
1928                            encodedcontroller = _lev_ctrl_modwheel;
1929                            break;
1930                        case 2:
1931                            encodedcontroller = _lev_ctrl_breath;
1932                            break;
1933                        case 4:
1934                            encodedcontroller = _lev_ctrl_foot;
1935                            break;
1936                        case 12:
1937                            encodedcontroller = _lev_ctrl_effect1;
1938                            break;
1939                        case 13:
1940                            encodedcontroller = _lev_ctrl_effect2;
1941                            break;
1942                        case 16:
1943                            encodedcontroller = _lev_ctrl_genpurpose1;
1944                            break;
1945                        case 17:
1946                            encodedcontroller = _lev_ctrl_genpurpose2;
1947                            break;
1948                        case 18:
1949                            encodedcontroller = _lev_ctrl_genpurpose3;
1950                            break;
1951                        case 19:
1952                            encodedcontroller = _lev_ctrl_genpurpose4;
1953                            break;
1954                        case 5:
1955                            encodedcontroller = _lev_ctrl_portamentotime;
1956                            break;
1957                        case 64:
1958                            encodedcontroller = _lev_ctrl_sustainpedal;
1959                            break;
1960                        case 65:
1961                            encodedcontroller = _lev_ctrl_portamento;
1962                            break;
1963                        case 66:
1964                            encodedcontroller = _lev_ctrl_sostenutopedal;
1965                            break;
1966                        case 67:
1967                            encodedcontroller = _lev_ctrl_softpedal;
1968                            break;
1969                        case 80:
1970                            encodedcontroller = _lev_ctrl_genpurpose5;
1971                            break;
1972                        case 81:
1973                            encodedcontroller = _lev_ctrl_genpurpose6;
1974                            break;
1975                        case 82:
1976                            encodedcontroller = _lev_ctrl_genpurpose7;
1977                            break;
1978                        case 83:
1979                            encodedcontroller = _lev_ctrl_genpurpose8;
1980                            break;
1981                        case 91:
1982                            encodedcontroller = _lev_ctrl_effect1depth;
1983                            break;
1984                        case 92:
1985                            encodedcontroller = _lev_ctrl_effect2depth;
1986                            break;
1987                        case 93:
1988                            encodedcontroller = _lev_ctrl_effect3depth;
1989                            break;
1990                        case 94:
1991                            encodedcontroller = _lev_ctrl_effect4depth;
1992                            break;
1993                        case 95:
1994                            encodedcontroller = _lev_ctrl_effect5depth;
1995                            break;
1996                        default:
1997                            throw gig::Exception("leverage controller number is not supported by the gig format");
1998                    }
1999                    break;
2000                default:
2001                    throw gig::Exception("Unknown leverage controller type.");
2002            }
2003            return encodedcontroller;
2004        }
2005    
2006      DimensionRegion::~DimensionRegion() {      DimensionRegion::~DimensionRegion() {
2007          Instances--;          Instances--;
2008          if (!Instances) {          if (!Instances) {
# Line 1333  namespace { Line 2016  namespace {
2016              delete pVelocityTables;              delete pVelocityTables;
2017              pVelocityTables = NULL;              pVelocityTables = NULL;
2018          }          }
2019            if (VelocityTable) delete[] VelocityTable;
2020      }      }
2021    
2022      /**      /**
# Line 1449  namespace { Line 2133  namespace {
2133              for (int i = 0; i < dimensionBits; i++) {              for (int i = 0; i < dimensionBits; i++) {
2134                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());
2135                  uint8_t     bits      = _3lnk->ReadUint8();                  uint8_t     bits      = _3lnk->ReadUint8();
2136                    _3lnk->ReadUint8(); // probably the position of the dimension
2137                    _3lnk->ReadUint8(); // unknown
2138                    uint8_t     zones     = _3lnk->ReadUint8(); // new for v3: number of zones doesn't have to be == pow(2,bits)
2139                  if (dimension == dimension_none) { // inactive dimension                  if (dimension == dimension_none) { // inactive dimension
2140                      pDimensionDefinitions[i].dimension  = dimension_none;                      pDimensionDefinitions[i].dimension  = dimension_none;
2141                      pDimensionDefinitions[i].bits       = 0;                      pDimensionDefinitions[i].bits       = 0;
2142                      pDimensionDefinitions[i].zones      = 0;                      pDimensionDefinitions[i].zones      = 0;
2143                      pDimensionDefinitions[i].split_type = split_type_bit;                      pDimensionDefinitions[i].split_type = split_type_bit;
                     pDimensionDefinitions[i].ranges     = NULL;  
2144                      pDimensionDefinitions[i].zone_size  = 0;                      pDimensionDefinitions[i].zone_size  = 0;
2145                  }                  }
2146                  else { // active dimension                  else { // active dimension
2147                      pDimensionDefinitions[i].dimension = dimension;                      pDimensionDefinitions[i].dimension = dimension;
2148                      pDimensionDefinitions[i].bits      = bits;                      pDimensionDefinitions[i].bits      = bits;
2149                      pDimensionDefinitions[i].zones     = 0x01 << bits; // = pow(2,bits)                      pDimensionDefinitions[i].zones     = zones ? zones : 0x01 << bits; // = pow(2,bits)
2150                      pDimensionDefinitions[i].split_type = (dimension == dimension_layer ||                      pDimensionDefinitions[i].split_type = __resolveSplitType(dimension);
2151                                                             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 / pDimensionDefinitions[i].zones  
                                                                                    : 0;  
2152                      Dimensions++;                      Dimensions++;
2153    
2154                      // if this is a layer dimension, remember the amount of layers                      // if this is a layer dimension, remember the amount of layers
2155                      if (dimension == dimension_layer) Layers = pDimensionDefinitions[i].zones;                      if (dimension == dimension_layer) Layers = pDimensionDefinitions[i].zones;
2156                  }                  }
2157                  _3lnk->SetPos(6, RIFF::stream_curpos); // jump forward to next dimension definition                  _3lnk->SetPos(3, RIFF::stream_curpos); // jump forward to next dimension definition
2158              }              }
2159                for (int i = dimensionBits ; i < 8 ; i++) pDimensionDefinitions[i].bits = 0;
2160    
2161              // 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,
2162              for (uint i = 0; i < Dimensions; i++) {              // update the VelocityTables in the dimension regions
2163                  dimension_def_t* pDimDef = pDimensionDefinitions + i;              UpdateVelocityTable();
                 if (pDimDef->dimension == dimension_velocity) {  
                     if (pDimensionRegions[0]->VelocityUpperLimit == 0) {  
                         // no custom defined ranges  
                         pDimDef->split_type = split_type_normal;  
                         pDimDef->ranges     = NULL;  
                     }  
                     else { // custom defined ranges  
                         pDimDef->split_type = split_type_customvelocity;  
                         pDimDef->ranges     = new range_t[pDimDef->zones];  
                         uint8_t bits[8] = { 0 };  
                         int previousUpperLimit = -1;  
                         for (int velocityZone = 0; velocityZone < pDimDef->zones; velocityZone++) {  
                             bits[i] = velocityZone;  
                             DimensionRegion* pDimRegion = GetDimensionRegionByBit(bits);  
   
                             pDimDef->ranges[velocityZone].low  = previousUpperLimit + 1;  
                             pDimDef->ranges[velocityZone].high = pDimRegion->VelocityUpperLimit;  
                             previousUpperLimit = pDimDef->ranges[velocityZone].high;  
                             // fill velocity table  
                             for (int i = pDimDef->ranges[velocityZone].low; i <= pDimDef->ranges[velocityZone].high; i++) {  
                                 VelocityTable[i] = velocityZone;  
                             }  
                         }  
                     }  
                 }  
             }  
2164    
2165              // 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();  
2166              if (file->pVersion && file->pVersion->major == 3)              if (file->pVersion && file->pVersion->major == 3)
2167                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure
2168              else              else
# Line 1519  namespace { Line 2171  namespace {
2171              // load sample references              // load sample references
2172              for (uint i = 0; i < DimensionRegions; i++) {              for (uint i = 0; i < DimensionRegions; i++) {
2173                  uint32_t wavepoolindex = _3lnk->ReadUint32();                  uint32_t wavepoolindex = _3lnk->ReadUint32();
2174                  pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);                  if (file->pWavePoolTable) pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);
2175                }
2176                GetSample(); // load global region sample reference
2177            } else {
2178                DimensionRegions = 0;
2179                for (int i = 0 ; i < 8 ; i++) {
2180                    pDimensionDefinitions[i].dimension  = dimension_none;
2181                    pDimensionDefinitions[i].bits       = 0;
2182                    pDimensionDefinitions[i].zones      = 0;
2183                }
2184            }
2185    
2186            // make sure there is at least one dimension region
2187            if (!DimensionRegions) {
2188                RIFF::List* _3prg = rgnList->GetSubList(LIST_TYPE_3PRG);
2189                if (!_3prg) _3prg = rgnList->AddSubList(LIST_TYPE_3PRG);
2190                RIFF::List* _3ewl = _3prg->AddSubList(LIST_TYPE_3EWL);
2191                pDimensionRegions[0] = new DimensionRegion(_3ewl);
2192                DimensionRegions = 1;
2193            }
2194        }
2195    
2196        /**
2197         * Apply Region settings and all its DimensionRegions to the respective
2198         * RIFF chunks. You have to call File::Save() to make changes persistent.
2199         *
2200         * Usually there is absolutely no need to call this method explicitly.
2201         * It will be called automatically when File::Save() was called.
2202         *
2203         * @throws gig::Exception if samples cannot be dereferenced
2204         */
2205        void Region::UpdateChunks() {
2206            // in the gig format we don't care about the Region's sample reference
2207            // but we still have to provide some existing one to not corrupt the
2208            // file, so to avoid the latter we simply always assign the sample of
2209            // the first dimension region of this region
2210            pSample = pDimensionRegions[0]->pSample;
2211    
2212            // first update base class's chunks
2213            DLS::Region::UpdateChunks();
2214    
2215            // update dimension region's chunks
2216            for (int i = 0; i < DimensionRegions; i++) {
2217                pDimensionRegions[i]->UpdateChunks();
2218            }
2219    
2220            File* pFile = (File*) GetParent()->GetParent();
2221            const int iMaxDimensions = (pFile->pVersion && pFile->pVersion->major == 3) ? 8 : 5;
2222            const int iMaxDimensionRegions = (pFile->pVersion && pFile->pVersion->major == 3) ? 256 : 32;
2223    
2224            // make sure '3lnk' chunk exists
2225            RIFF::Chunk* _3lnk = pCkRegion->GetSubChunk(CHUNK_ID_3LNK);
2226            if (!_3lnk) {
2227                const int _3lnkChunkSize = (pFile->pVersion && pFile->pVersion->major == 3) ? 1092 : 172;
2228                _3lnk = pCkRegion->AddSubChunk(CHUNK_ID_3LNK, _3lnkChunkSize);
2229                memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);
2230            }
2231    
2232            // update dimension definitions in '3lnk' chunk
2233            uint8_t* pData = (uint8_t*) _3lnk->LoadChunkData();
2234            store32(&pData[0], DimensionRegions);
2235            for (int i = 0; i < iMaxDimensions; i++) {
2236                pData[4 + i * 8] = (uint8_t) pDimensionDefinitions[i].dimension;
2237                pData[5 + i * 8] = pDimensionDefinitions[i].bits;
2238                // next 2 bytes unknown
2239                pData[8 + i * 8] = pDimensionDefinitions[i].zones;
2240                // next 3 bytes unknown
2241            }
2242    
2243            // update wave pool table in '3lnk' chunk
2244            const int iWavePoolOffset = (pFile->pVersion && pFile->pVersion->major == 3) ? 68 : 44;
2245            for (uint i = 0; i < iMaxDimensionRegions; i++) {
2246                int iWaveIndex = -1;
2247                if (i < DimensionRegions) {
2248                    if (!pFile->pSamples || !pFile->pSamples->size()) throw gig::Exception("Could not update gig::Region, there are no samples");
2249                    File::SampleList::iterator iter = pFile->pSamples->begin();
2250                    File::SampleList::iterator end  = pFile->pSamples->end();
2251                    for (int index = 0; iter != end; ++iter, ++index) {
2252                        if (*iter == pDimensionRegions[i]->pSample) {
2253                            iWaveIndex = index;
2254                            break;
2255                        }
2256                    }
2257                    if (iWaveIndex < 0) throw gig::Exception("Could not update gig::Region, could not find DimensionRegion's sample");
2258              }              }
2259                store32(&pData[iWavePoolOffset + i * 4], iWaveIndex);
2260          }          }
         else throw gig::Exception("Mandatory <3lnk> chunk not found.");  
2261      }      }
2262    
2263      void Region::LoadDimensionRegions(RIFF::List* rgn) {      void Region::LoadDimensionRegions(RIFF::List* rgn) {
# Line 1541  namespace { Line 2276  namespace {
2276          }          }
2277      }      }
2278    
2279      Region::~Region() {      void Region::UpdateVelocityTable() {
2280          for (uint i = 0; i < Dimensions; i++) {          // get velocity dimension's index
2281              if (pDimensionDefinitions[i].ranges) delete[] pDimensionDefinitions[i].ranges;          int veldim = -1;
2282            for (int i = 0 ; i < Dimensions ; i++) {
2283                if (pDimensionDefinitions[i].dimension == gig::dimension_velocity) {
2284                    veldim = i;
2285                    break;
2286                }
2287            }
2288            if (veldim == -1) return;
2289    
2290            int step = 1;
2291            for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;
2292            int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;
2293            int end = step * pDimensionDefinitions[veldim].zones;
2294    
2295            // loop through all dimension regions for all dimensions except the velocity dimension
2296            int dim[8] = { 0 };
2297            for (int i = 0 ; i < DimensionRegions ; i++) {
2298    
2299                if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||
2300                    pDimensionRegions[i]->VelocityUpperLimit) {
2301                    // create the velocity table
2302                    uint8_t* table = pDimensionRegions[i]->VelocityTable;
2303                    if (!table) {
2304                        table = new uint8_t[128];
2305                        pDimensionRegions[i]->VelocityTable = table;
2306                    }
2307                    int tableidx = 0;
2308                    int velocityZone = 0;
2309                    if (pDimensionRegions[i]->DimensionUpperLimits[veldim]) { // gig3
2310                        for (int k = i ; k < end ; k += step) {
2311                            DimensionRegion *d = pDimensionRegions[k];
2312                            for (; tableidx <= d->DimensionUpperLimits[veldim] ; tableidx++) table[tableidx] = velocityZone;
2313                            velocityZone++;
2314                        }
2315                    } else { // gig2
2316                        for (int k = i ; k < end ; k += step) {
2317                            DimensionRegion *d = pDimensionRegions[k];
2318                            for (; tableidx <= d->VelocityUpperLimit ; tableidx++) table[tableidx] = velocityZone;
2319                            velocityZone++;
2320                        }
2321                    }
2322                } else {
2323                    if (pDimensionRegions[i]->VelocityTable) {
2324                        delete[] pDimensionRegions[i]->VelocityTable;
2325                        pDimensionRegions[i]->VelocityTable = 0;
2326                    }
2327                }
2328    
2329                int j;
2330                int shift = 0;
2331                for (j = 0 ; j < Dimensions ; j++) {
2332                    if (j == veldim) i += skipveldim; // skip velocity dimension
2333                    else {
2334                        dim[j]++;
2335                        if (dim[j] < pDimensionDefinitions[j].zones) break;
2336                        else {
2337                            // skip unused dimension regions
2338                            dim[j] = 0;
2339                            i += ((1 << pDimensionDefinitions[j].bits) -
2340                                  pDimensionDefinitions[j].zones) << shift;
2341                        }
2342                    }
2343                    shift += pDimensionDefinitions[j].bits;
2344                }
2345                if (j == Dimensions) break;
2346            }
2347        }
2348    
2349        /** @brief Einstein would have dreamed of it - create a new dimension.
2350         *
2351         * Creates a new dimension with the dimension definition given by
2352         * \a pDimDef. The appropriate amount of DimensionRegions will be created.
2353         * There is a hard limit of dimensions and total amount of "bits" all
2354         * dimensions can have. This limit is dependant to what gig file format
2355         * version this file refers to. The gig v2 (and lower) format has a
2356         * dimension limit and total amount of bits limit of 5, whereas the gig v3
2357         * format has a limit of 8.
2358         *
2359         * @param pDimDef - defintion of the new dimension
2360         * @throws gig::Exception if dimension of the same type exists already
2361         * @throws gig::Exception if amount of dimensions or total amount of
2362         *                        dimension bits limit is violated
2363         */
2364        void Region::AddDimension(dimension_def_t* pDimDef) {
2365            // check if max. amount of dimensions reached
2366            File* file = (File*) GetParent()->GetParent();
2367            const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;
2368            if (Dimensions >= iMaxDimensions)
2369                throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimensions already reached");
2370            // check if max. amount of dimension bits reached
2371            int iCurrentBits = 0;
2372            for (int i = 0; i < Dimensions; i++)
2373                iCurrentBits += pDimensionDefinitions[i].bits;
2374            if (iCurrentBits >= iMaxDimensions)
2375                throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimension bits already reached");
2376            const int iNewBits = iCurrentBits + pDimDef->bits;
2377            if (iNewBits > iMaxDimensions)
2378                throw gig::Exception("Could not add new dimension, new dimension would exceed max. amount of " + ToString(iMaxDimensions) + " dimension bits");
2379            // check if there's already a dimensions of the same type
2380            for (int i = 0; i < Dimensions; i++)
2381                if (pDimensionDefinitions[i].dimension == pDimDef->dimension)
2382                    throw gig::Exception("Could not add new dimension, there is already a dimension of the same type");
2383    
2384            // assign definition of new dimension
2385            pDimensionDefinitions[Dimensions] = *pDimDef;
2386    
2387            // auto correct certain dimension definition fields (where possible)
2388            pDimensionDefinitions[Dimensions].split_type  =
2389                __resolveSplitType(pDimensionDefinitions[Dimensions].dimension);
2390            pDimensionDefinitions[Dimensions].zone_size =
2391                __resolveZoneSize(pDimensionDefinitions[Dimensions]);
2392    
2393            // create new dimension region(s) for this new dimension
2394            for (int i = 1 << iCurrentBits; i < 1 << iNewBits; i++) {
2395                //TODO: maybe we should copy existing dimension regions if possible instead of simply creating new ones with default values
2396                RIFF::List* pNewDimRgnListChunk = pCkRegion->AddSubList(LIST_TYPE_3EWL);
2397                pDimensionRegions[i] = new DimensionRegion(pNewDimRgnListChunk);
2398                DimensionRegions++;
2399            }
2400    
2401            Dimensions++;
2402    
2403            // if this is a layer dimension, update 'Layers' attribute
2404            if (pDimDef->dimension == dimension_layer) Layers = pDimDef->zones;
2405    
2406            UpdateVelocityTable();
2407        }
2408    
2409        /** @brief Delete an existing dimension.
2410         *
2411         * Deletes the dimension given by \a pDimDef and deletes all respective
2412         * dimension regions, that is all dimension regions where the dimension's
2413         * bit(s) part is greater than 0. In case of a 'sustain pedal' dimension
2414         * for example this would delete all dimension regions for the case(s)
2415         * where the sustain pedal is pressed down.
2416         *
2417         * @param pDimDef - dimension to delete
2418         * @throws gig::Exception if given dimension cannot be found
2419         */
2420        void Region::DeleteDimension(dimension_def_t* pDimDef) {
2421            // get dimension's index
2422            int iDimensionNr = -1;
2423            for (int i = 0; i < Dimensions; i++) {
2424                if (&pDimensionDefinitions[i] == pDimDef) {
2425                    iDimensionNr = i;
2426                    break;
2427                }
2428            }
2429            if (iDimensionNr < 0) throw gig::Exception("Invalid dimension_def_t pointer");
2430    
2431            // get amount of bits below the dimension to delete
2432            int iLowerBits = 0;
2433            for (int i = 0; i < iDimensionNr; i++)
2434                iLowerBits += pDimensionDefinitions[i].bits;
2435    
2436            // get amount ot bits above the dimension to delete
2437            int iUpperBits = 0;
2438            for (int i = iDimensionNr + 1; i < Dimensions; i++)
2439                iUpperBits += pDimensionDefinitions[i].bits;
2440    
2441            // delete dimension regions which belong to the given dimension
2442            // (that is where the dimension's bit > 0)
2443            for (int iUpperBit = 0; iUpperBit < 1 << iUpperBits; iUpperBit++) {
2444                for (int iObsoleteBit = 1; iObsoleteBit < 1 << pDimensionDefinitions[iDimensionNr].bits; iObsoleteBit++) {
2445                    for (int iLowerBit = 0; iLowerBit < 1 << iLowerBits; iLowerBit++) {
2446                        int iToDelete = iUpperBit    << (pDimensionDefinitions[iDimensionNr].bits + iLowerBits) |
2447                                        iObsoleteBit << iLowerBits |
2448                                        iLowerBit;
2449                        delete pDimensionRegions[iToDelete];
2450                        pDimensionRegions[iToDelete] = NULL;
2451                        DimensionRegions--;
2452                    }
2453                }
2454            }
2455    
2456            // defrag pDimensionRegions array
2457            // (that is remove the NULL spaces within the pDimensionRegions array)
2458            for (int iFrom = 2, iTo = 1; iFrom < 256 && iTo < 256 - 1; iTo++) {
2459                if (!pDimensionRegions[iTo]) {
2460                    if (iFrom <= iTo) iFrom = iTo + 1;
2461                    while (!pDimensionRegions[iFrom] && iFrom < 256) iFrom++;
2462                    if (iFrom < 256 && pDimensionRegions[iFrom]) {
2463                        pDimensionRegions[iTo]   = pDimensionRegions[iFrom];
2464                        pDimensionRegions[iFrom] = NULL;
2465                    }
2466                }
2467            }
2468    
2469            // 'remove' dimension definition
2470            for (int i = iDimensionNr + 1; i < Dimensions; i++) {
2471                pDimensionDefinitions[i - 1] = pDimensionDefinitions[i];
2472          }          }
2473            pDimensionDefinitions[Dimensions - 1].dimension = dimension_none;
2474            pDimensionDefinitions[Dimensions - 1].bits      = 0;
2475            pDimensionDefinitions[Dimensions - 1].zones     = 0;
2476    
2477            Dimensions--;
2478    
2479            // if this was a layer dimension, update 'Layers' attribute
2480            if (pDimDef->dimension == dimension_layer) Layers = 1;
2481        }
2482    
2483        Region::~Region() {
2484          for (int i = 0; i < 256; i++) {          for (int i = 0; i < 256; i++) {
2485              if (pDimensionRegions[i]) delete pDimensionRegions[i];              if (pDimensionRegions[i]) delete pDimensionRegions[i];
2486          }          }
# Line 1569  namespace { Line 2505  namespace {
2505       * @see             Dimensions       * @see             Dimensions
2506       */       */
2507      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {
2508          uint8_t bits[8] = { 0 };          uint8_t bits;
2509            int veldim = -1;
2510            int velbitpos;
2511            int bitpos = 0;
2512            int dimregidx = 0;
2513          for (uint i = 0; i < Dimensions; i++) {          for (uint i = 0; i < Dimensions; i++) {
2514              bits[i] = DimValues[i];              if (pDimensionDefinitions[i].dimension == dimension_velocity) {
2515              switch (pDimensionDefinitions[i].split_type) {                  // the velocity dimension must be handled after the other dimensions
2516                  case split_type_normal:                  veldim = i;
2517                      bits[i] /= pDimensionDefinitions[i].zone_size;                  velbitpos = bitpos;
2518                      break;              } else {
2519                  case split_type_customvelocity:                  switch (pDimensionDefinitions[i].split_type) {
2520                      bits[i] = VelocityTable[bits[i]];                      case split_type_normal:
2521                      break;                          if (pDimensionRegions[0]->DimensionUpperLimits[i]) {
2522                  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
2523                      const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;                              for (bits = 0 ; bits < pDimensionDefinitions[i].zones ; bits++) {
2524                      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;
2525                      break;                              }
2526              }                          } else {
2527                                // gig2: evenly sized zones
2528                                bits = uint8_t(DimValues[i] / pDimensionDefinitions[i].zone_size);
2529                            }
2530                            break;
2531                        case split_type_bit: // the value is already the sought dimension bit number
2532                            const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;
2533                            bits = DimValues[i] & limiter_mask; // just make sure the value doesn't use more bits than allowed
2534                            break;
2535                    }
2536                    dimregidx |= bits << bitpos;
2537                }
2538                bitpos += pDimensionDefinitions[i].bits;
2539            }
2540            DimensionRegion* dimreg = pDimensionRegions[dimregidx];
2541            if (veldim != -1) {
2542                // (dimreg is now the dimension region for the lowest velocity)
2543                if (dimreg->VelocityTable) // custom defined zone ranges
2544                    bits = dimreg->VelocityTable[DimValues[veldim]];
2545                else // normal split type
2546                    bits = uint8_t(DimValues[veldim] / pDimensionDefinitions[veldim].zone_size);
2547    
2548                dimregidx |= bits << velbitpos;
2549                dimreg = pDimensionRegions[dimregidx];
2550          }          }
2551          return GetDimensionRegionByBit(bits);          return dimreg;
2552      }      }
2553    
2554      /**      /**
# Line 1625  namespace { Line 2588  namespace {
2588      Sample* Region::GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress) {      Sample* Region::GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress) {
2589          if ((int32_t)WavePoolTableIndex == -1) return NULL;          if ((int32_t)WavePoolTableIndex == -1) return NULL;
2590          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
2591            if (!file->pWavePoolTable) return NULL;
2592          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
2593          unsigned long soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];          unsigned long soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];
2594          Sample* sample = file->GetFirstSample(pProgress);          Sample* sample = file->GetFirstSample(pProgress);
2595          while (sample) {          while (sample) {
2596              if (sample->ulWavePoolOffset == soughtoffset &&              if (sample->ulWavePoolOffset == soughtoffset &&
2597                  sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(pSample = sample);                  sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);
2598              sample = file->GetNextSample();              sample = file->GetNextSample();
2599          }          }
2600          return NULL;          return NULL;
# Line 1642  namespace { Line 2606  namespace {
2606  // *  // *
2607    
2608      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) {
2609            static const DLS::Info::FixedStringLength fixedStringLengths[] = {
2610                { CHUNK_ID_INAM, 64 },
2611                { CHUNK_ID_ISFT, 12 },
2612                { 0, 0 }
2613            };
2614            pInfo->FixedStringLengths = fixedStringLengths;
2615    
2616          // Initialization          // Initialization
2617          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;
2618          RegionIndex = -1;          EffectSend = 0;
2619            Attenuation = 0;
2620            FineTune = 0;
2621            PitchbendRange = 0;
2622            PianoReleaseMode = false;
2623            DimensionKeyRange.low = 0;
2624            DimensionKeyRange.high = 0;
2625    
2626          // Loading          // Loading
2627          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);
# Line 1660  namespace { Line 2637  namespace {
2637                  DimensionKeyRange.low  = dimkeystart >> 1;                  DimensionKeyRange.low  = dimkeystart >> 1;
2638                  DimensionKeyRange.high = _3ewg->ReadUint8();                  DimensionKeyRange.high = _3ewg->ReadUint8();
2639              }              }
             else throw gig::Exception("Mandatory <3ewg> chunk not found.");  
2640          }          }
         else throw gig::Exception("Mandatory <lart> list chunk not found.");  
2641    
2642            if (!pRegions) pRegions = new RegionList;
2643          RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);          RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);
2644          if (!lrgn) throw gig::Exception("Mandatory chunks in <ins > chunk not found.");          if (lrgn) {
2645          pRegions = new Region*[Regions];              RIFF::List* rgn = lrgn->GetFirstSubList();
2646          for (uint i = 0; i < Regions; i++) pRegions[i] = NULL;              while (rgn) {
2647          RIFF::List* rgn = lrgn->GetFirstSubList();                  if (rgn->GetListType() == LIST_TYPE_RGN) {
2648          unsigned int iRegion = 0;                      __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
2649          while (rgn) {                      pRegions->push_back(new Region(this, rgn));
2650              if (rgn->GetListType() == LIST_TYPE_RGN) {                  }
2651                  __notify_progress(pProgress, (float) iRegion / (float) Regions);                  rgn = lrgn->GetNextSubList();
                 pRegions[iRegion] = new Region(this, rgn);  
                 iRegion++;  
             }  
             rgn = lrgn->GetNextSubList();  
         }  
   
         // Creating Region Key Table for fast lookup  
         for (uint iReg = 0; iReg < Regions; iReg++) {  
             for (int iKey = pRegions[iReg]->KeyRange.low; iKey <= pRegions[iReg]->KeyRange.high; iKey++) {  
                 RegionKeyTable[iKey] = pRegions[iReg];  
2652              }              }
2653                // Creating Region Key Table for fast lookup
2654                UpdateRegionKeyTable();
2655          }          }
2656    
2657          __notify_progress(pProgress, 1.0f); // notify done          __notify_progress(pProgress, 1.0f); // notify done
2658      }      }
2659    
2660      Instrument::~Instrument() {      void Instrument::UpdateRegionKeyTable() {
2661          for (uint i = 0; i < Regions; i++) {          RegionList::iterator iter = pRegions->begin();
2662              if (pRegions) {          RegionList::iterator end  = pRegions->end();
2663                  if (pRegions[i]) delete (pRegions[i]);          for (; iter != end; ++iter) {
2664                gig::Region* pRegion = static_cast<gig::Region*>(*iter);
2665                for (int iKey = pRegion->KeyRange.low; iKey <= pRegion->KeyRange.high; iKey++) {
2666                    RegionKeyTable[iKey] = pRegion;
2667              }              }
2668          }          }
2669          if (pRegions) delete[] pRegions;      }
2670    
2671        Instrument::~Instrument() {
2672        }
2673    
2674        /**
2675         * Apply Instrument with all its Regions to the respective RIFF chunks.
2676         * You have to call File::Save() to make changes persistent.
2677         *
2678         * Usually there is absolutely no need to call this method explicitly.
2679         * It will be called automatically when File::Save() was called.
2680         *
2681         * @throws gig::Exception if samples cannot be dereferenced
2682         */
2683        void Instrument::UpdateChunks() {
2684            // first update base classes' chunks
2685            DLS::Instrument::UpdateChunks();
2686    
2687            // update Regions' chunks
2688            {
2689                RegionList::iterator iter = pRegions->begin();
2690                RegionList::iterator end  = pRegions->end();
2691                for (; iter != end; ++iter)
2692                    (*iter)->UpdateChunks();
2693            }
2694    
2695            // make sure 'lart' RIFF list chunk exists
2696            RIFF::List* lart = pCkInstrument->GetSubList(LIST_TYPE_LART);
2697            if (!lart)  lart = pCkInstrument->AddSubList(LIST_TYPE_LART);
2698            // make sure '3ewg' RIFF chunk exists
2699            RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);
2700            if (!_3ewg)  _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, 12);
2701            // update '3ewg' RIFF chunk
2702            uint8_t* pData = (uint8_t*) _3ewg->LoadChunkData();
2703            store16(&pData[0], EffectSend);
2704            store32(&pData[2], Attenuation);
2705            store16(&pData[6], FineTune);
2706            store16(&pData[8], PitchbendRange);
2707            const uint8_t dimkeystart = (PianoReleaseMode) ? 0x01 : 0x00 |
2708                                        DimensionKeyRange.low << 1;
2709            pData[10] = dimkeystart;
2710            pData[11] = DimensionKeyRange.high;
2711      }      }
2712    
2713      /**      /**
# Line 1706  namespace { Line 2718  namespace {
2718       *             there is no Region defined for the given \a Key       *             there is no Region defined for the given \a Key
2719       */       */
2720      Region* Instrument::GetRegion(unsigned int Key) {      Region* Instrument::GetRegion(unsigned int Key) {
2721          if (!pRegions || Key > 127) return NULL;          if (!pRegions || !pRegions->size() || Key > 127) return NULL;
2722          return RegionKeyTable[Key];          return RegionKeyTable[Key];
2723    
2724          /*for (int i = 0; i < Regions; i++) {          /*for (int i = 0; i < Regions; i++) {
2725              if (Key <= pRegions[i]->KeyRange.high &&              if (Key <= pRegions[i]->KeyRange.high &&
2726                  Key >= pRegions[i]->KeyRange.low) return pRegions[i];                  Key >= pRegions[i]->KeyRange.low) return pRegions[i];
# Line 1723  namespace { Line 2736  namespace {
2736       * @see      GetNextRegion()       * @see      GetNextRegion()
2737       */       */
2738      Region* Instrument::GetFirstRegion() {      Region* Instrument::GetFirstRegion() {
2739          if (!Regions) return NULL;          if (!pRegions) return NULL;
2740          RegionIndex = 1;          RegionsIterator = pRegions->begin();
2741          return pRegions[0];          return static_cast<gig::Region*>( (RegionsIterator != pRegions->end()) ? *RegionsIterator : NULL );
2742      }      }
2743    
2744      /**      /**
# Line 1737  namespace { Line 2750  namespace {
2750       * @see      GetFirstRegion()       * @see      GetFirstRegion()
2751       */       */
2752      Region* Instrument::GetNextRegion() {      Region* Instrument::GetNextRegion() {
2753          if (RegionIndex < 0 || uint32_t(RegionIndex) >= Regions) return NULL;          if (!pRegions) return NULL;
2754          return pRegions[RegionIndex++];          RegionsIterator++;
2755            return static_cast<gig::Region*>( (RegionsIterator != pRegions->end()) ? *RegionsIterator : NULL );
2756        }
2757    
2758        Region* Instrument::AddRegion() {
2759            // create new Region object (and its RIFF chunks)
2760            RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
2761            if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
2762            RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
2763            Region* pNewRegion = new Region(this, rgn);
2764            pRegions->push_back(pNewRegion);
2765            Regions = pRegions->size();
2766            // update Region key table for fast lookup
2767            UpdateRegionKeyTable();
2768            // done
2769            return pNewRegion;
2770        }
2771    
2772        void Instrument::DeleteRegion(Region* pRegion) {
2773            if (!pRegions) return;
2774            DLS::Instrument::DeleteRegion((DLS::Region*) pRegion);
2775            // update Region key table for fast lookup
2776            UpdateRegionKeyTable();
2777        }
2778    
2779    
2780    
2781    // *************** Group ***************
2782    // *
2783    
2784        /** @brief Constructor.
2785         *
2786         * @param file   - pointer to the gig::File object
2787         * @param ck3gnm - pointer to 3gnm chunk associated with this group or
2788         *                 NULL if this is a new Group
2789         */
2790        Group::Group(File* file, RIFF::Chunk* ck3gnm) {
2791            pFile      = file;
2792            pNameChunk = ck3gnm;
2793            ::LoadString(pNameChunk, Name);
2794        }
2795    
2796        Group::~Group() {
2797            // remove the chunk associated with this group (if any)
2798            if (pNameChunk) pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);
2799        }
2800    
2801        /** @brief Update chunks with current group settings.
2802         *
2803         * Apply current Group field values to the respective chunks. You have
2804         * to call File::Save() to make changes persistent.
2805         *
2806         * Usually there is absolutely no need to call this method explicitly.
2807         * It will be called automatically when File::Save() was called.
2808         */
2809        void Group::UpdateChunks() {
2810            // make sure <3gri> and <3gnl> list chunks exist
2811            RIFF::List* _3gri = pFile->pRIFF->GetSubList(LIST_TYPE_3GRI);
2812            if (!_3gri) _3gri = pFile->pRIFF->AddSubList(LIST_TYPE_3GRI);
2813            RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
2814            if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
2815            // now store the name of this group as <3gnm> chunk as subchunk of the <3gnl> list chunk
2816            ::SaveString(CHUNK_ID_3GNM, pNameChunk, _3gnl, Name, String("Unnamed Group"), true, 64);
2817        }
2818    
2819        /**
2820         * Returns the first Sample of this Group. You have to call this method
2821         * once before you use GetNextSample().
2822         *
2823         * <b>Notice:</b> this method might block for a long time, in case the
2824         * samples of this .gig file were not scanned yet
2825         *
2826         * @returns  pointer address to first Sample or NULL if there is none
2827         *           applied to this Group
2828         * @see      GetNextSample()
2829         */
2830        Sample* Group::GetFirstSample() {
2831            // FIXME: lazy und unsafe implementation, should be an autonomous iterator
2832            for (Sample* pSample = pFile->GetFirstSample(); pSample; pSample = pFile->GetNextSample()) {
2833                if (pSample->GetGroup() == this) return pSample;
2834            }
2835            return NULL;
2836        }
2837    
2838        /**
2839         * Returns the next Sample of the Group. You have to call
2840         * GetFirstSample() once before you can use this method. By calling this
2841         * method multiple times it iterates through the Samples assigned to
2842         * this Group.
2843         *
2844         * @returns  pointer address to the next Sample of this Group or NULL if
2845         *           end reached
2846         * @see      GetFirstSample()
2847         */
2848        Sample* Group::GetNextSample() {
2849            // FIXME: lazy und unsafe implementation, should be an autonomous iterator
2850            for (Sample* pSample = pFile->GetNextSample(); pSample; pSample = pFile->GetNextSample()) {
2851                if (pSample->GetGroup() == this) return pSample;
2852            }
2853            return NULL;
2854        }
2855    
2856        /**
2857         * Move Sample given by \a pSample from another Group to this Group.
2858         */
2859        void Group::AddSample(Sample* pSample) {
2860            pSample->pGroup = this;
2861        }
2862    
2863        /**
2864         * Move all members of this group to another group (preferably the 1st
2865         * one except this). This method is called explicitly by
2866         * File::DeleteGroup() thus when a Group was deleted. This code was
2867         * intentionally not placed in the destructor!
2868         */
2869        void Group::MoveAll() {
2870            // get "that" other group first
2871            Group* pOtherGroup = NULL;
2872            for (pOtherGroup = pFile->GetFirstGroup(); pOtherGroup; pOtherGroup = pFile->GetNextGroup()) {
2873                if (pOtherGroup != this) break;
2874            }
2875            if (!pOtherGroup) throw Exception(
2876                "Could not move samples to another group, since there is no "
2877                "other Group. This is a bug, report it!"
2878            );
2879            // now move all samples of this group to the other group
2880            for (Sample* pSample = GetFirstSample(); pSample; pSample = GetNextSample()) {
2881                pOtherGroup->AddSample(pSample);
2882            }
2883      }      }
2884    
2885    
# Line 1746  namespace { Line 2887  namespace {
2887  // *************** File ***************  // *************** File ***************
2888  // *  // *
2889    
2890        const DLS::Info::FixedStringLength File::FixedStringLengths[] = {
2891            { CHUNK_ID_IARL, 256 },
2892            { CHUNK_ID_IART, 128 },
2893            { CHUNK_ID_ICMS, 128 },
2894            { CHUNK_ID_ICMT, 1024 },
2895            { CHUNK_ID_ICOP, 128 },
2896            { CHUNK_ID_ICRD, 128 },
2897            { CHUNK_ID_IENG, 128 },
2898            { CHUNK_ID_IGNR, 128 },
2899            { CHUNK_ID_IKEY, 128 },
2900            { CHUNK_ID_IMED, 128 },
2901            { CHUNK_ID_INAM, 128 },
2902            { CHUNK_ID_IPRD, 128 },
2903            { CHUNK_ID_ISBJ, 128 },
2904            { CHUNK_ID_ISFT, 128 },
2905            { CHUNK_ID_ISRC, 128 },
2906            { CHUNK_ID_ISRF, 128 },
2907            { CHUNK_ID_ITCH, 128 },
2908            { 0, 0 }
2909        };
2910    
2911        File::File() : DLS::File() {
2912            pGroups = NULL;
2913            pInfo->FixedStringLengths = FixedStringLengths;
2914            pInfo->ArchivalLocation = String(256, ' ');
2915        }
2916    
2917      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {
2918          pSamples     = NULL;          pGroups = NULL;
2919          pInstruments = NULL;          pInfo->FixedStringLengths = FixedStringLengths;
2920      }      }
2921    
2922      File::~File() {      File::~File() {
2923          // free samples          if (pGroups) {
2924          if (pSamples) {              std::list<Group*>::iterator iter = pGroups->begin();
2925              SamplesIterator = pSamples->begin();              std::list<Group*>::iterator end  = pGroups->end();
2926              while (SamplesIterator != pSamples->end() ) {              while (iter != end) {
2927                  delete (*SamplesIterator);                  delete *iter;
2928                  SamplesIterator++;                  ++iter;
2929              }              }
2930              pSamples->clear();              delete pGroups;
2931              delete pSamples;          }
   
         }  
         // free instruments  
         if (pInstruments) {  
             InstrumentsIterator = pInstruments->begin();  
             while (InstrumentsIterator != pInstruments->end() ) {  
                 delete (*InstrumentsIterator);  
                 InstrumentsIterator++;  
             }  
             pInstruments->clear();  
             delete pInstruments;  
         }  
         // free extension files  
         for (std::list<RIFF::File*>::iterator i = ExtensionFiles.begin() ; i != ExtensionFiles.end() ; i++)  
             delete *i;  
2932      }      }
2933    
2934      Sample* File::GetFirstSample(progress_t* pProgress) {      Sample* File::GetFirstSample(progress_t* pProgress) {
# Line 1791  namespace { Line 2944  namespace {
2944          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
2945      }      }
2946    
2947        /** @brief Add a new sample.
2948         *
2949         * This will create a new Sample object for the gig file. You have to
2950         * call Save() to make this persistent to the file.
2951         *
2952         * @returns pointer to new Sample object
2953         */
2954        Sample* File::AddSample() {
2955           if (!pSamples) LoadSamples();
2956           __ensureMandatoryChunksExist();
2957           RIFF::List* wvpl = pRIFF->GetSubList(LIST_TYPE_WVPL);
2958           // create new Sample object and its respective 'wave' list chunk
2959           RIFF::List* wave = wvpl->AddSubList(LIST_TYPE_WAVE);
2960           Sample* pSample = new Sample(this, wave, 0 /*arbitrary value, we update offsets when we save*/);
2961           pSamples->push_back(pSample);
2962           return pSample;
2963        }
2964    
2965        /** @brief Delete a sample.
2966         *
2967         * This will delete the given Sample object from the gig file. You have
2968         * to call Save() to make this persistent to the file.
2969         *
2970         * @param pSample - sample to delete
2971         * @throws gig::Exception if given sample could not be found
2972         */
2973        void File::DeleteSample(Sample* pSample) {
2974            if (!pSamples || !pSamples->size()) throw gig::Exception("Could not delete sample as there are no samples");
2975            SampleList::iterator iter = find(pSamples->begin(), pSamples->end(), (DLS::Sample*) pSample);
2976            if (iter == pSamples->end()) throw gig::Exception("Could not delete sample, could not find given sample");
2977            if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation
2978            pSamples->erase(iter);
2979            delete pSample;
2980        }
2981    
2982        void File::LoadSamples() {
2983            LoadSamples(NULL);
2984        }
2985    
2986      void File::LoadSamples(progress_t* pProgress) {      void File::LoadSamples(progress_t* pProgress) {
2987            // Groups must be loaded before samples, because samples will try
2988            // to resolve the group they belong to
2989            if (!pGroups) LoadGroups();
2990    
2991            if (!pSamples) pSamples = new SampleList;
2992    
2993          RIFF::File* file = pRIFF;          RIFF::File* file = pRIFF;
2994    
2995          // just for progress calculation          // just for progress calculation
# Line 1803  namespace { Line 3001  namespace {
3001          for (int i = 0 ; i < WavePoolCount ; i++) {          for (int i = 0 ; i < WavePoolCount ; i++) {
3002              if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];              if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];
3003          }          }
3004          String name(pRIFF->Filename);          String name(pRIFF->GetFileName());
3005          int nameLen = pRIFF->Filename.length();          int nameLen = name.length();
3006          char suffix[6];          char suffix[6];
3007          if (nameLen > 4 && pRIFF->Filename.substr(nameLen - 4) == ".gig") nameLen -= 4;          if (nameLen > 4 && name.substr(nameLen - 4) == ".gig") nameLen -= 4;
3008    
3009          for (int fileNo = 0 ; ; ) {          for (int fileNo = 0 ; ; ) {
3010              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);
# Line 1819  namespace { Line 3017  namespace {
3017                          const float subprogress = (float) iSampleIndex / (float) iTotalSamples;                          const float subprogress = (float) iSampleIndex / (float) iTotalSamples;
3018                          __notify_progress(pProgress, subprogress);                          __notify_progress(pProgress, subprogress);
3019    
                         if (!pSamples) pSamples = new SampleList;  
3020                          unsigned long waveFileOffset = wave->GetFilePos();                          unsigned long waveFileOffset = wave->GetFilePos();
3021                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));
3022    
# Line 1836  namespace { Line 3033  namespace {
3033                  name.replace(nameLen, 5, suffix);                  name.replace(nameLen, 5, suffix);
3034                  file = new RIFF::File(name);                  file = new RIFF::File(name);
3035                  ExtensionFiles.push_back(file);                  ExtensionFiles.push_back(file);
3036              }              } else break;
             else throw gig::Exception("Mandatory <wvpl> chunk not found.");  
3037          }          }
3038    
3039          __notify_progress(pProgress, 1.0); // notify done          __notify_progress(pProgress, 1.0); // notify done
# Line 1847  namespace { Line 3043  namespace {
3043          if (!pInstruments) LoadInstruments();          if (!pInstruments) LoadInstruments();
3044          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
3045          InstrumentsIterator = pInstruments->begin();          InstrumentsIterator = pInstruments->begin();
3046          return (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL;          return static_cast<gig::Instrument*>( (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL );
3047      }      }
3048    
3049      Instrument* File::GetNextInstrument() {      Instrument* File::GetNextInstrument() {
3050          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
3051          InstrumentsIterator++;          InstrumentsIterator++;
3052          return (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL;          return static_cast<gig::Instrument*>( (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL );
3053      }      }
3054    
3055      /**      /**
# Line 1886  namespace { Line 3082  namespace {
3082          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
3083          InstrumentsIterator = pInstruments->begin();          InstrumentsIterator = pInstruments->begin();
3084          for (uint i = 0; InstrumentsIterator != pInstruments->end(); i++) {          for (uint i = 0; InstrumentsIterator != pInstruments->end(); i++) {
3085              if (i == index) return *InstrumentsIterator;              if (i == index) return static_cast<gig::Instrument*>( *InstrumentsIterator );
3086              InstrumentsIterator++;              InstrumentsIterator++;
3087          }          }
3088          return NULL;          return NULL;
3089      }      }
3090    
3091        /** @brief Add a new instrument definition.
3092         *
3093         * This will create a new Instrument object for the gig file. You have
3094         * to call Save() to make this persistent to the file.
3095         *
3096         * @returns pointer to new Instrument object
3097         */
3098        Instrument* File::AddInstrument() {
3099           if (!pInstruments) LoadInstruments();
3100           __ensureMandatoryChunksExist();
3101           RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
3102           RIFF::List* lstInstr = lstInstruments->AddSubList(LIST_TYPE_INS);
3103           Instrument* pInstrument = new Instrument(this, lstInstr);
3104    
3105           // this string is needed for the gig to be loadable in GSt:
3106           pInstrument->pInfo->Software = "Endless Wave";
3107    
3108           pInstruments->push_back(pInstrument);
3109           return pInstrument;
3110        }
3111    
3112        /** @brief Delete an instrument.
3113         *
3114         * This will delete the given Instrument object from the gig file. You
3115         * have to call Save() to make this persistent to the file.
3116         *
3117         * @param pInstrument - instrument to delete
3118         * @throws gig::Exception if given instrument could not be found
3119         */
3120        void File::DeleteInstrument(Instrument* pInstrument) {
3121            if (!pInstruments) throw gig::Exception("Could not delete instrument as there are no instruments");
3122            InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), (DLS::Instrument*) pInstrument);
3123            if (iter == pInstruments->end()) throw gig::Exception("Could not delete instrument, could not find given instrument");
3124            pInstruments->erase(iter);
3125            delete pInstrument;
3126        }
3127    
3128        void File::LoadInstruments() {
3129            LoadInstruments(NULL);
3130        }
3131    
3132      void File::LoadInstruments(progress_t* pProgress) {      void File::LoadInstruments(progress_t* pProgress) {
3133            if (!pInstruments) pInstruments = new InstrumentList;
3134          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
3135          if (lstInstruments) {          if (lstInstruments) {
3136              int iInstrumentIndex = 0;              int iInstrumentIndex = 0;
# Line 1907  namespace { Line 3145  namespace {
3145                      progress_t subprogress;                      progress_t subprogress;
3146                      __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);                      __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);
3147    
                     if (!pInstruments) pInstruments = new InstrumentList;  
3148                      pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));                      pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));
3149    
3150                      iInstrumentIndex++;                      iInstrumentIndex++;
# Line 1916  namespace { Line 3153  namespace {
3153              }              }
3154              __notify_progress(pProgress, 1.0); // notify done              __notify_progress(pProgress, 1.0); // notify done
3155          }          }
3156          else throw gig::Exception("Mandatory <lins> list chunk not found.");      }
3157    
3158        Group* File::GetFirstGroup() {
3159            if (!pGroups) LoadGroups();
3160            // there must always be at least one group
3161            GroupsIterator = pGroups->begin();
3162            return *GroupsIterator;
3163        }
3164    
3165        Group* File::GetNextGroup() {
3166            if (!pGroups) return NULL;
3167            ++GroupsIterator;
3168            return (GroupsIterator == pGroups->end()) ? NULL : *GroupsIterator;
3169        }
3170    
3171        /**
3172         * Returns the group with the given index.
3173         *
3174         * @param index - number of the sought group (0..n)
3175         * @returns sought group or NULL if there's no such group
3176         */
3177        Group* File::GetGroup(uint index) {
3178            if (!pGroups) LoadGroups();
3179            GroupsIterator = pGroups->begin();
3180            for (uint i = 0; GroupsIterator != pGroups->end(); i++) {
3181                if (i == index) return *GroupsIterator;
3182                ++GroupsIterator;
3183            }
3184            return NULL;
3185        }
3186    
3187        Group* File::AddGroup() {
3188            if (!pGroups) LoadGroups();
3189            // there must always be at least one group
3190            __ensureMandatoryChunksExist();
3191            Group* pGroup = new Group(this, NULL);
3192            pGroups->push_back(pGroup);
3193            return pGroup;
3194        }
3195    
3196        /** @brief Delete a group and its samples.
3197         *
3198         * This will delete the given Group object and all the samples that
3199         * belong to this group from the gig file. You have to call Save() to
3200         * make this persistent to the file.
3201         *
3202         * @param pGroup - group to delete
3203         * @throws gig::Exception if given group could not be found
3204         */
3205        void File::DeleteGroup(Group* pGroup) {
3206            if (!pGroups) LoadGroups();
3207            std::list<Group*>::iterator iter = find(pGroups->begin(), pGroups->end(), pGroup);
3208            if (iter == pGroups->end()) throw gig::Exception("Could not delete group, could not find given group");
3209            if (pGroups->size() == 1) throw gig::Exception("Cannot delete group, there must be at least one default group!");
3210            // delete all members of this group
3211            for (Sample* pSample = pGroup->GetFirstSample(); pSample; pSample = pGroup->GetNextSample()) {
3212                DeleteSample(pSample);
3213            }
3214            // now delete this group object
3215            pGroups->erase(iter);
3216            delete pGroup;
3217        }
3218    
3219        /** @brief Delete a group.
3220         *
3221         * This will delete the given Group object from the gig file. All the
3222         * samples that belong to this group will not be deleted, but instead
3223         * be moved to another group. You have to call Save() to make this
3224         * persistent to the file.
3225         *
3226         * @param pGroup - group to delete
3227         * @throws gig::Exception if given group could not be found
3228         */
3229        void File::DeleteGroupOnly(Group* pGroup) {
3230            if (!pGroups) LoadGroups();
3231            std::list<Group*>::iterator iter = find(pGroups->begin(), pGroups->end(), pGroup);
3232            if (iter == pGroups->end()) throw gig::Exception("Could not delete group, could not find given group");
3233            if (pGroups->size() == 1) throw gig::Exception("Cannot delete group, there must be at least one default group!");
3234            // move all members of this group to another group
3235            pGroup->MoveAll();
3236            pGroups->erase(iter);
3237            delete pGroup;
3238        }
3239    
3240        void File::LoadGroups() {
3241            if (!pGroups) pGroups = new std::list<Group*>;
3242            // try to read defined groups from file
3243            RIFF::List* lst3gri = pRIFF->GetSubList(LIST_TYPE_3GRI);
3244            if (lst3gri) {
3245                RIFF::List* lst3gnl = lst3gri->GetSubList(LIST_TYPE_3GNL);
3246                if (lst3gnl) {
3247                    RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();
3248                    while (ck) {
3249                        if (ck->GetChunkID() == CHUNK_ID_3GNM) {
3250                            pGroups->push_back(new Group(this, ck));
3251                        }
3252                        ck = lst3gnl->GetNextSubChunk();
3253                    }
3254                }
3255            }
3256            // if there were no group(s), create at least the mandatory default group
3257            if (!pGroups->size()) {
3258                Group* pGroup = new Group(this, NULL);
3259                pGroup->Name = "Default Group";
3260                pGroups->push_back(pGroup);
3261            }
3262        }
3263    
3264        /**
3265         * Apply all the gig file's current instruments, samples, groups and settings
3266         * to the respective RIFF chunks. You have to call Save() to make changes
3267         * persistent.
3268         *
3269         * Usually there is absolutely no need to call this method explicitly.
3270         * It will be called automatically when File::Save() was called.
3271         *
3272         * @throws Exception - on errors
3273         */
3274        void File::UpdateChunks() {
3275            // first update base class's chunks
3276            DLS::File::UpdateChunks();
3277    
3278            // update group's chunks
3279            if (pGroups) {
3280                std::list<Group*>::iterator iter = pGroups->begin();
3281                std::list<Group*>::iterator end  = pGroups->end();
3282                for (; iter != end; ++iter) {
3283                    (*iter)->UpdateChunks();
3284                }
3285            }
3286      }      }
3287    
3288    

Legend:
Removed from v.728  
changed lines
  Added in v.1182

  ViewVC Help
Powered by ViewVC