/[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 516 by schoenebeck, Sat May 7 21:24:04 2005 UTC revision 1316 by schoenebeck, Fri Aug 31 19:09:13 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      {      {
164          // Note: The 24 bits are truncated to 16 bits for now.          int y, dy, ddy, dddy;
165    
166          // Note: The calculation of the initial value of y is strange  #define GET_PARAMS(params)                      \
167          // and not 100% correct. What should the first two parameters          y    = get24(params);                   \
168          // really be used for? Why are they two? The correct value for          dy   = y - get24((params) + 3);         \
169          // y seems to lie somewhere between the values of the first          ddy  = get24((params) + 6);             \
170          // two parameters.          dddy = get24((params) + 9)
         //  
         // Strange thing #2: The formula in SKIP_ONE gives values for  
         // y that are twice as high as they should be. That's why  
         // COPY_ONE shifts an extra step, and also why y is  
         // initialized with a sum instead of a mean value.  
   
         int y, dy, ddy;  
   
         const int shift = 8 - truncatedBits;  
         const int shift1 = shift + 1;  
   
 #define GET_PARAMS(params)                              \  
         y = (get24(params) + get24((params) + 3));      \  
         dy  = get24((params) + 6);                      \  
         ddy = get24((params) + 9)  
171    
172  #define SKIP_ONE(x)                             \  #define SKIP_ONE(x)                             \
173          ddy -= (x);                             \          dddy -= (x);                            \
174          dy -= ddy;                              \          ddy  -= dddy;                           \
175          y -= dy          dy   =  -dy - ddy;                      \
176            y    += dy
177    
178  #define COPY_ONE(x)                             \  #define COPY_ONE(x)                             \
179          SKIP_ONE(x);                            \          SKIP_ONE(x);                            \
180          *pDst = y >> shift1;                    \          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 237  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    // *************** CRC ***************
282    // *
283    
284        const uint32_t* CRC::table(initTable());
285    
286        uint32_t* CRC::initTable() {
287            uint32_t* res = new uint32_t[256];
288    
289            for (int i = 0 ; i < 256 ; i++) {
290                uint32_t c = i;
291                for (int j = 0 ; j < 8 ; j++) {
292                    c = (c & 1) ? 0xedb88320 ^ (c >> 1) : c >> 1;
293                }
294                res[i] = c;
295            }
296            return res;
297        }
298    
299    
300    
301  // *************** Sample ***************  // *************** Sample ***************
302  // *  // *
303    
304      unsigned int Sample::Instances = 0;      unsigned int Sample::Instances = 0;
305      buffer_t     Sample::InternalDecompressionBuffer;      buffer_t     Sample::InternalDecompressionBuffer;
306    
307      Sample::Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {      /** @brief Constructor.
308         *
309         * Load an existing sample or create a new one. A 'wave' list chunk must
310         * be given to this constructor. In case the given 'wave' list chunk
311         * contains a 'fmt', 'data' (and optionally a '3gix', 'smpl') chunk, the
312         * format and sample data will be loaded from there, otherwise default
313         * values will be used and those chunks will be created when
314         * File::Save() will be called later on.
315         *
316         * @param pFile          - pointer to gig::File where this sample is
317         *                         located (or will be located)
318         * @param waveList       - pointer to 'wave' list chunk which is (or
319         *                         will be) associated with this sample
320         * @param WavePoolOffset - offset of this sample data from wave pool
321         *                         ('wvpl') list chunk
322         * @param fileNo         - number of an extension file where this sample
323         *                         is located, 0 otherwise
324         */
325        Sample::Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {
326            static const DLS::Info::FixedStringLength fixedStringLengths[] = {
327                { CHUNK_ID_INAM, 64 },
328                { 0, 0 }
329            };
330            pInfo->FixedStringLengths = fixedStringLengths;
331          Instances++;          Instances++;
332            FileNo = fileNo;
333    
334          RIFF::Chunk* _3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);          pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);
335          if (!_3gix) throw gig::Exception("Mandatory chunks in <wave> list chunk not found.");          if (pCk3gix) {
336          SampleGroup = _3gix->ReadInt16();              uint16_t iSampleGroup = pCk3gix->ReadInt16();
337                pGroup = pFile->GetGroup(iSampleGroup);
338          RIFF::Chunk* smpl = waveList->GetSubChunk(CHUNK_ID_SMPL);          } else { // '3gix' chunk missing
339          if (!smpl) throw gig::Exception("Mandatory chunks in <wave> list chunk not found.");              // by default assigned to that mandatory "Default Group"
340          Manufacturer      = smpl->ReadInt32();              pGroup = pFile->GetGroup(0);
341          Product           = smpl->ReadInt32();          }
342          SamplePeriod      = smpl->ReadInt32();  
343          MIDIUnityNote     = smpl->ReadInt32();          pCkSmpl = waveList->GetSubChunk(CHUNK_ID_SMPL);
344          FineTune          = smpl->ReadInt32();          if (pCkSmpl) {
345          smpl->Read(&SMPTEFormat, 1, 4);              Manufacturer  = pCkSmpl->ReadInt32();
346          SMPTEOffset       = smpl->ReadInt32();              Product       = pCkSmpl->ReadInt32();
347          Loops             = smpl->ReadInt32();              SamplePeriod  = pCkSmpl->ReadInt32();
348          smpl->ReadInt32(); // manufByt              MIDIUnityNote = pCkSmpl->ReadInt32();
349          LoopID            = smpl->ReadInt32();              FineTune      = pCkSmpl->ReadInt32();
350          smpl->Read(&LoopType, 1, 4);              pCkSmpl->Read(&SMPTEFormat, 1, 4);
351          LoopStart         = smpl->ReadInt32();              SMPTEOffset   = pCkSmpl->ReadInt32();
352          LoopEnd           = smpl->ReadInt32();              Loops         = pCkSmpl->ReadInt32();
353          LoopFraction      = smpl->ReadInt32();              pCkSmpl->ReadInt32(); // manufByt
354          LoopPlayCount     = smpl->ReadInt32();              LoopID        = pCkSmpl->ReadInt32();
355                pCkSmpl->Read(&LoopType, 1, 4);
356                LoopStart     = pCkSmpl->ReadInt32();
357                LoopEnd       = pCkSmpl->ReadInt32();
358                LoopFraction  = pCkSmpl->ReadInt32();
359                LoopPlayCount = pCkSmpl->ReadInt32();
360            } else { // 'smpl' chunk missing
361                // use default values
362                Manufacturer  = 0;
363                Product       = 0;
364                SamplePeriod  = uint32_t(1000000000.0 / SamplesPerSecond + 0.5);
365                MIDIUnityNote = 60;
366                FineTune      = 0;
367                SMPTEFormat   = smpte_format_no_offset;
368                SMPTEOffset   = 0;
369                Loops         = 0;
370                LoopID        = 0;
371                LoopType      = loop_type_normal;
372                LoopStart     = 0;
373                LoopEnd       = 0;
374                LoopFraction  = 0;
375                LoopPlayCount = 0;
376            }
377    
378          FrameTable                 = NULL;          FrameTable                 = NULL;
379          SamplePos                  = 0;          SamplePos                  = 0;
# Line 297  namespace { Line 404  namespace {
404          }          }
405          FrameOffset = 0; // just for streaming compressed samples          FrameOffset = 0; // just for streaming compressed samples
406    
407          LoopSize = LoopEnd - LoopStart;          LoopSize = LoopEnd - LoopStart + 1;
408        }
409    
410        /**
411         * Apply sample and its settings to the respective RIFF chunks. You have
412         * to call File::Save() to make changes persistent.
413         *
414         * Usually there is absolutely no need to call this method explicitly.
415         * It will be called automatically when File::Save() was called.
416         *
417         * @throws DLS::Exception if FormatTag != DLS_WAVE_FORMAT_PCM or no sample data
418         *                        was provided yet
419         * @throws gig::Exception if there is any invalid sample setting
420         */
421        void Sample::UpdateChunks() {
422            // first update base class's chunks
423            DLS::Sample::UpdateChunks();
424    
425            // make sure 'smpl' chunk exists
426            pCkSmpl = pWaveList->GetSubChunk(CHUNK_ID_SMPL);
427            if (!pCkSmpl) {
428                pCkSmpl = pWaveList->AddSubChunk(CHUNK_ID_SMPL, 60);
429                memset(pCkSmpl->LoadChunkData(), 0, 60);
430            }
431            // update 'smpl' chunk
432            uint8_t* pData = (uint8_t*) pCkSmpl->LoadChunkData();
433            SamplePeriod = uint32_t(1000000000.0 / SamplesPerSecond + 0.5);
434            store32(&pData[0], Manufacturer);
435            store32(&pData[4], Product);
436            store32(&pData[8], SamplePeriod);
437            store32(&pData[12], MIDIUnityNote);
438            store32(&pData[16], FineTune);
439            store32(&pData[20], SMPTEFormat);
440            store32(&pData[24], SMPTEOffset);
441            store32(&pData[28], Loops);
442    
443            // we skip 'manufByt' for now (4 bytes)
444    
445            store32(&pData[36], LoopID);
446            store32(&pData[40], LoopType);
447            store32(&pData[44], LoopStart);
448            store32(&pData[48], LoopEnd);
449            store32(&pData[52], LoopFraction);
450            store32(&pData[56], LoopPlayCount);
451    
452            // make sure '3gix' chunk exists
453            pCk3gix = pWaveList->GetSubChunk(CHUNK_ID_3GIX);
454            if (!pCk3gix) pCk3gix = pWaveList->AddSubChunk(CHUNK_ID_3GIX, 4);
455            // determine appropriate sample group index (to be stored in chunk)
456            uint16_t iSampleGroup = 0; // 0 refers to default sample group
457            File* pFile = static_cast<File*>(pParent);
458            if (pFile->pGroups) {
459                std::list<Group*>::iterator iter = pFile->pGroups->begin();
460                std::list<Group*>::iterator end  = pFile->pGroups->end();
461                for (int i = 0; iter != end; i++, iter++) {
462                    if (*iter == pGroup) {
463                        iSampleGroup = i;
464                        break; // found
465                    }
466                }
467            }
468            // update '3gix' chunk
469            pData = (uint8_t*) pCk3gix->LoadChunkData();
470            store16(&pData[0], iSampleGroup);
471      }      }
472    
473      /// 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 500  namespace { Line 670  namespace {
670          RAMCache.Size   = 0;          RAMCache.Size   = 0;
671      }      }
672    
673        /** @brief Resize sample.
674         *
675         * Resizes the sample's wave form data, that is the actual size of
676         * sample wave data possible to be written for this sample. This call
677         * will return immediately and just schedule the resize operation. You
678         * should call File::Save() to actually perform the resize operation(s)
679         * "physically" to the file. As this can take a while on large files, it
680         * is recommended to call Resize() first on all samples which have to be
681         * resized and finally to call File::Save() to perform all those resize
682         * operations in one rush.
683         *
684         * The actual size (in bytes) is dependant to the current FrameSize
685         * value. You may want to set FrameSize before calling Resize().
686         *
687         * <b>Caution:</b> You cannot directly write (i.e. with Write()) to
688         * enlarged samples before calling File::Save() as this might exceed the
689         * current sample's boundary!
690         *
691         * Also note: only DLS_WAVE_FORMAT_PCM is currently supported, that is
692         * FormatTag must be DLS_WAVE_FORMAT_PCM. Trying to resize samples with
693         * other formats will fail!
694         *
695         * @param iNewSize - new sample wave data size in sample points (must be
696         *                   greater than zero)
697         * @throws DLS::Excecption if FormatTag != DLS_WAVE_FORMAT_PCM
698         *                         or if \a iNewSize is less than 1
699         * @throws gig::Exception if existing sample is compressed
700         * @see DLS::Sample::GetSize(), DLS::Sample::FrameSize,
701         *      DLS::Sample::FormatTag, File::Save()
702         */
703        void Sample::Resize(int iNewSize) {
704            if (Compressed) throw gig::Exception("There is no support for modifying compressed samples (yet)");
705            DLS::Sample::Resize(iNewSize);
706        }
707    
708      /**      /**
709       * Sets the position within the sample (in sample points, not in       * Sets the position within the sample (in sample points, not in
710       * 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 589  namespace { Line 794  namespace {
794       * @param SampleCount      number of sample points to read       * @param SampleCount      number of sample points to read
795       * @param pPlaybackState   will be used to store and reload the playback       * @param pPlaybackState   will be used to store and reload the playback
796       *                         state for the next ReadAndLoop() call       *                         state for the next ReadAndLoop() call
797         * @param pDimRgn          dimension region with looping information
798       * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression       * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression
799       * @returns                number of successfully read sample points       * @returns                number of successfully read sample points
800       * @see                    CreateDecompressionBuffer()       * @see                    CreateDecompressionBuffer()
801       */       */
802      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,
803                                          DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer) {
804          unsigned long samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;          unsigned long samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;
805          uint8_t* pDst = (uint8_t*) pBuffer;          uint8_t* pDst = (uint8_t*) pBuffer;
806    
807          SetPos(pPlaybackState->position); // recover position from the last time          SetPos(pPlaybackState->position); // recover position from the last time
808    
809          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
810    
811              switch (this->LoopType) {              const DLS::sample_loop_t& loop = pDimRgn->pSampleLoops[0];
812                const uint32_t loopEnd = loop.LoopStart + loop.LoopLength;
813    
814                  case loop_type_bidirectional: { //TODO: not tested yet!              if (GetPos() <= loopEnd) {
815                      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  
816    
817                              // as we can only read forward from disk, we have to                      case loop_type_bidirectional: { //TODO: not tested yet!
818                              // determine the end position within the loop first,                          do {
819                              // read forward from that 'end' and finally after                              // if not endless loop check if max. number of loop cycles have been passed
820                              // reading, swap all sample frames so it reflects                              if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
821                              // backward playback  
822                                if (!pPlaybackState->reverse) { // forward playback
823                              unsigned long swapareastart       = totalreadsamples;                                  do {
824                              unsigned long loopoffset          = GetPos() - this->LoopStart;                                      samplestoloopend  = loopEnd - GetPos();
825                              unsigned long samplestoreadinloop = Min(samplestoread, loopoffset);                                      readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
826                              unsigned long reverseplaybackend  = GetPos() - samplestoreadinloop;                                      samplestoread    -= readsamples;
827                                        totalreadsamples += readsamples;
828                              SetPos(reverseplaybackend);                                      if (readsamples == samplestoloopend) {
829                                            pPlaybackState->reverse = true;
830                              // read samples for backward playback                                          break;
831                              do {                                      }
832                                  readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], samplestoreadinloop, pExternalDecompressionBuffer);                                  } while (samplestoread && readsamples);
833                                  samplestoreadinloop -= readsamples;                              }
834                                  samplestoread       -= readsamples;                              else { // backward playback
                                 totalreadsamples    += readsamples;  
                             } while (samplestoreadinloop && readsamples);  
835    
836                              SetPos(reverseplaybackend); // pretend we really read backwards                                  // as we can only read forward from disk, we have to
837                                    // determine the end position within the loop first,
838                                    // read forward from that 'end' and finally after
839                                    // reading, swap all sample frames so it reflects
840                                    // backward playback
841    
842                                    unsigned long swapareastart       = totalreadsamples;
843                                    unsigned long loopoffset          = GetPos() - loop.LoopStart;
844                                    unsigned long samplestoreadinloop = Min(samplestoread, loopoffset);
845                                    unsigned long reverseplaybackend  = GetPos() - samplestoreadinloop;
846    
847                                    SetPos(reverseplaybackend);
848    
849                                    // read samples for backward playback
850                                    do {
851                                        readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], samplestoreadinloop, pExternalDecompressionBuffer);
852                                        samplestoreadinloop -= readsamples;
853                                        samplestoread       -= readsamples;
854                                        totalreadsamples    += readsamples;
855                                    } while (samplestoreadinloop && readsamples);
856    
857                                    SetPos(reverseplaybackend); // pretend we really read backwards
858    
859                                    if (reverseplaybackend == loop.LoopStart) {
860                                        pPlaybackState->loop_cycles_left--;
861                                        pPlaybackState->reverse = false;
862                                    }
863    
864                              if (reverseplaybackend == this->LoopStart) {                                  // reverse the sample frames for backward playback
865                                  pPlaybackState->loop_cycles_left--;                                  SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
                                 pPlaybackState->reverse = false;  
866                              }                              }
867                            } while (samplestoread && readsamples);
868                            break;
869                        }
870    
871                              // reverse the sample frames for backward playback                      case loop_type_backward: { // TODO: not tested yet!
872                              SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);                          // forward playback (not entered the loop yet)
873                          }                          if (!pPlaybackState->reverse) do {
874                      } while (samplestoread && readsamples);                              samplestoloopend  = loopEnd - GetPos();
875                      break;                              readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
876                  }                              samplestoread    -= readsamples;
877                                totalreadsamples += readsamples;
878                  case loop_type_backward: { // TODO: not tested yet!                              if (readsamples == samplestoloopend) {
879                      // forward playback (not entered the loop yet)                                  pPlaybackState->reverse = true;
880                      if (!pPlaybackState->reverse) do {                                  break;
881                          samplestoloopend  = this->LoopEnd - GetPos();                              }
882                          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);  
883    
884                      if (!samplestoread) break;                          if (!samplestoread) break;
885    
886                      // as we can only read forward from disk, we have to                          // as we can only read forward from disk, we have to
887                      // determine the end position within the loop first,                          // determine the end position within the loop first,
888                      // read forward from that 'end' and finally after                          // read forward from that 'end' and finally after
889                      // reading, swap all sample frames so it reflects                          // reading, swap all sample frames so it reflects
890                      // backward playback                          // backward playback
891    
892                      unsigned long swapareastart       = totalreadsamples;                          unsigned long swapareastart       = totalreadsamples;
893                      unsigned long loopoffset          = GetPos() - this->LoopStart;                          unsigned long loopoffset          = GetPos() - loop.LoopStart;
894                      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)
895                                                                                : samplestoread;                                                                                    : samplestoread;
896                      unsigned long reverseplaybackend  = this->LoopStart + Abs((loopoffset - samplestoreadinloop) % this->LoopSize);                          unsigned long reverseplaybackend  = loop.LoopStart + Abs((loopoffset - samplestoreadinloop) % loop.LoopLength);
897    
898                      SetPos(reverseplaybackend);                          SetPos(reverseplaybackend);
899    
900                      // read samples for backward playback                          // read samples for backward playback
901                      do {                          do {
902                          // 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
903                          if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;                              if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
904                          samplestoloopend     = this->LoopEnd - GetPos();                              samplestoloopend     = loopEnd - GetPos();
905                          readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoreadinloop, samplestoloopend), pExternalDecompressionBuffer);                              readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoreadinloop, samplestoloopend), pExternalDecompressionBuffer);
906                          samplestoreadinloop -= readsamples;                              samplestoreadinloop -= readsamples;
907                          samplestoread       -= readsamples;                              samplestoread       -= readsamples;
908                          totalreadsamples    += readsamples;                              totalreadsamples    += readsamples;
909                          if (readsamples == samplestoloopend) {                              if (readsamples == samplestoloopend) {
910                              pPlaybackState->loop_cycles_left--;                                  pPlaybackState->loop_cycles_left--;
911                              SetPos(this->LoopStart);                                  SetPos(loop.LoopStart);
912                          }                              }
913                      } while (samplestoreadinloop && readsamples);                          } while (samplestoreadinloop && readsamples);
914    
915                      SetPos(reverseplaybackend); // pretend we really read backwards                          SetPos(reverseplaybackend); // pretend we really read backwards
916    
917                      // reverse the sample frames for backward playback                          // reverse the sample frames for backward playback
918                      SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);                          SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
919                      break;                          break;
920                  }                      }
921    
922                  default: case loop_type_normal: {                      default: case loop_type_normal: {
923                      do {                          do {
924                          // 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
925                          if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;                              if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
926                          samplestoloopend  = this->LoopEnd - GetPos();                              samplestoloopend  = loopEnd - GetPos();
927                          readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);                              readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
928                          samplestoread    -= readsamples;                              samplestoread    -= readsamples;
929                          totalreadsamples += readsamples;                              totalreadsamples += readsamples;
930                          if (readsamples == samplestoloopend) {                              if (readsamples == samplestoloopend) {
931                              pPlaybackState->loop_cycles_left--;                                  pPlaybackState->loop_cycles_left--;
932                              SetPos(this->LoopStart);                                  SetPos(loop.LoopStart);
933                          }                              }
934                      } while (samplestoread && readsamples);                          } while (samplestoread && readsamples);
935                      break;                          break;
936                        }
937                  }                  }
938              }              }
939          }          }
# Line 751  namespace { Line 963  namespace {
963       * have to use an external decompression buffer for <b>EACH</b>       * have to use an external decompression buffer for <b>EACH</b>
964       * streaming thread to avoid race conditions and crashes!       * streaming thread to avoid race conditions and crashes!
965       *       *
966         * For 16 bit samples, the data in the buffer will be int16_t
967         * (using native endianness). For 24 bit, the buffer will
968         * contain three bytes per sample, little-endian.
969         *
970       * @param pBuffer      destination buffer       * @param pBuffer      destination buffer
971       * @param SampleCount  number of sample points to read       * @param SampleCount  number of sample points to read
972       * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression       * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression
# Line 761  namespace { Line 977  namespace {
977          if (SampleCount == 0) return 0;          if (SampleCount == 0) return 0;
978          if (!Compressed) {          if (!Compressed) {
979              if (BitDepth == 24) {              if (BitDepth == 24) {
980                  // 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);  
                 }  
981              }              }
982              else { // 16 bit              else { // 16 bit
983                  // (pCkData->Read does endian correction)                  // (pCkData->Read does endian correction)
# Line 811  namespace { Line 1007  namespace {
1007    
1008              unsigned char* pSrc = (unsigned char*) pDecompressionBuffer->pStart;              unsigned char* pSrc = (unsigned char*) pDecompressionBuffer->pStart;
1009              int16_t* pDst = static_cast<int16_t*>(pBuffer);              int16_t* pDst = static_cast<int16_t*>(pBuffer);
1010                uint8_t* pDst24 = static_cast<uint8_t*>(pBuffer);
1011              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);
1012    
1013              while (remainingsamples && remainingbytes) {              while (remainingsamples && remainingbytes) {
# Line 892  namespace { Line 1089  namespace {
1089                              const unsigned char* const param_r = pSrc;                              const unsigned char* const param_r = pSrc;
1090                              if (mode_r != 2) pSrc += 12;                              if (mode_r != 2) pSrc += 12;
1091    
1092                              Decompress24(mode_l, param_l, 2, pSrc, pDst,                              Decompress24(mode_l, param_l, 6, pSrc, pDst24,
1093                                           skipsamples, copysamples, TruncatedBits);                                           skipsamples, copysamples, TruncatedBits);
1094                              Decompress24(mode_r, param_r, 2, pSrc + rightChannelOffset, pDst + 1,                              Decompress24(mode_r, param_r, 6, pSrc + rightChannelOffset, pDst24 + 3,
1095                                           skipsamples, copysamples, TruncatedBits);                                           skipsamples, copysamples, TruncatedBits);
1096                              pDst += copysamples << 1;                              pDst24 += copysamples * 6;
1097                          }                          }
1098                          else { // Mono                          else { // Mono
1099                              Decompress24(mode_l, param_l, 1, pSrc, pDst,                              Decompress24(mode_l, param_l, 3, pSrc, pDst24,
1100                                           skipsamples, copysamples, TruncatedBits);                                           skipsamples, copysamples, TruncatedBits);
1101                              pDst += copysamples;                              pDst24 += copysamples * 3;
1102                          }                          }
1103                      }                      }
1104                      else { // 16 bit                      else { // 16 bit
# Line 943  namespace { Line 1140  namespace {
1140          }          }
1141      }      }
1142    
1143        /** @brief Write sample wave data.
1144         *
1145         * Writes \a SampleCount number of sample points from the buffer pointed
1146         * by \a pBuffer and increments the position within the sample. Use this
1147         * method to directly write the sample data to disk, i.e. if you don't
1148         * want or cannot load the whole sample data into RAM.
1149         *
1150         * You have to Resize() the sample to the desired size and call
1151         * File::Save() <b>before</b> using Write().
1152         *
1153         * Note: there is currently no support for writing compressed samples.
1154         *
1155         * For 16 bit samples, the data in the source buffer should be
1156         * int16_t (using native endianness). For 24 bit, the buffer
1157         * should contain three bytes per sample, little-endian.
1158         *
1159         * @param pBuffer     - source buffer
1160         * @param SampleCount - number of sample points to write
1161         * @throws DLS::Exception if current sample size is too small
1162         * @throws gig::Exception if sample is compressed
1163         * @see DLS::LoadSampleData()
1164         */
1165        unsigned long Sample::Write(void* pBuffer, unsigned long SampleCount) {
1166            if (Compressed) throw gig::Exception("There is no support for writing compressed gig samples (yet)");
1167    
1168            // if this is the first write in this sample, reset the
1169            // checksum calculator
1170            if (pCkData->GetPos() == 0) {
1171                crc.reset();
1172            }
1173            if (GetSize() < SampleCount) throw Exception("Could not write sample data, current sample size to small");
1174            unsigned long res;
1175            if (BitDepth == 24) {
1176                res = pCkData->Write(pBuffer, SampleCount * FrameSize, 1) / FrameSize;
1177            } else { // 16 bit
1178                res = Channels == 2 ? pCkData->Write(pBuffer, SampleCount << 1, 2) >> 1
1179                                    : pCkData->Write(pBuffer, SampleCount, 2);
1180            }
1181            crc.update((unsigned char *)pBuffer, SampleCount * FrameSize);
1182    
1183            // if this is the last write, update the checksum chunk in the
1184            // file
1185            if (pCkData->GetPos() == pCkData->GetSize()) {
1186                File* pFile = static_cast<File*>(GetParent());
1187                pFile->SetSampleChecksum(this, crc.getValue());
1188            }
1189            return res;
1190        }
1191    
1192      /**      /**
1193       * Allocates a decompression buffer for streaming (compressed) samples       * Allocates a decompression buffer for streaming (compressed) samples
1194       * 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 985  namespace { Line 1231  namespace {
1231          }          }
1232      }      }
1233    
1234        /**
1235         * Returns pointer to the Group this Sample belongs to. In the .gig
1236         * format a sample always belongs to one group. If it wasn't explicitly
1237         * assigned to a certain group, it will be automatically assigned to a
1238         * default group.
1239         *
1240         * @returns Sample's Group (never NULL)
1241         */
1242        Group* Sample::GetGroup() const {
1243            return pGroup;
1244        }
1245    
1246      Sample::~Sample() {      Sample::~Sample() {
1247          Instances--;          Instances--;
1248          if (!Instances && InternalDecompressionBuffer.Size) {          if (!Instances && InternalDecompressionBuffer.Size) {
# Line 1004  namespace { Line 1262  namespace {
1262      uint                               DimensionRegion::Instances       = 0;      uint                               DimensionRegion::Instances       = 0;
1263      DimensionRegion::VelocityTableMap* DimensionRegion::pVelocityTables = NULL;      DimensionRegion::VelocityTableMap* DimensionRegion::pVelocityTables = NULL;
1264    
1265      DimensionRegion::DimensionRegion(RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {      DimensionRegion::DimensionRegion(Region* pParent, RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {
1266          Instances++;          Instances++;
1267    
1268          memcpy(&Crossfade, &SamplerOptions, 4);          pSample = NULL;
1269            pRegion = pParent;
1270    
1271            if (_3ewl->GetSubChunk(CHUNK_ID_WSMP)) memcpy(&Crossfade, &SamplerOptions, 4);
1272            else memset(&Crossfade, 0, 4);
1273    
1274          if (!pVelocityTables) pVelocityTables = new VelocityTableMap;          if (!pVelocityTables) pVelocityTables = new VelocityTableMap;
1275    
1276          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);
1277          _3ewa->ReadInt32(); // unknown, always 0x0000008C ?          if (_3ewa) { // if '3ewa' chunk exists
1278          LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              _3ewa->ReadInt32(); // unknown, always == chunk size ?
1279          EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1280          _3ewa->ReadInt16(); // unknown              EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1281          LFO1InternalDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1282          _3ewa->ReadInt16(); // unknown              LFO1InternalDepth = _3ewa->ReadUint16();
1283          LFO3InternalDepth = _3ewa->ReadInt16();              _3ewa->ReadInt16(); // unknown
1284          _3ewa->ReadInt16(); // unknown              LFO3InternalDepth = _3ewa->ReadInt16();
1285          LFO1ControlDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1286          _3ewa->ReadInt16(); // unknown              LFO1ControlDepth = _3ewa->ReadUint16();
1287          LFO3ControlDepth = _3ewa->ReadInt16();              _3ewa->ReadInt16(); // unknown
1288          EG1Attack           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO3ControlDepth = _3ewa->ReadInt16();
1289          EG1Decay1           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG1Attack           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1290          _3ewa->ReadInt16(); // unknown              EG1Decay1           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1291          EG1Sustain          = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1292          EG1Release          = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG1Sustain          = _3ewa->ReadUint16();
1293          EG1Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));              EG1Release          = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1294          uint8_t eg1ctrloptions        = _3ewa->ReadUint8();              EG1Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1295          EG1ControllerInvert           = eg1ctrloptions & 0x01;              uint8_t eg1ctrloptions        = _3ewa->ReadUint8();
1296          EG1ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg1ctrloptions);              EG1ControllerInvert           = eg1ctrloptions & 0x01;
1297          EG1ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg1ctrloptions);              EG1ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg1ctrloptions);
1298          EG1ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg1ctrloptions);              EG1ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg1ctrloptions);
1299          EG2Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));              EG1ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg1ctrloptions);
1300          uint8_t eg2ctrloptions        = _3ewa->ReadUint8();              EG2Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1301          EG2ControllerInvert           = eg2ctrloptions & 0x01;              uint8_t eg2ctrloptions        = _3ewa->ReadUint8();
1302          EG2ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg2ctrloptions);              EG2ControllerInvert           = eg2ctrloptions & 0x01;
1303          EG2ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg2ctrloptions);              EG2ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg2ctrloptions);
1304          EG2ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg2ctrloptions);              EG2ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg2ctrloptions);
1305          LFO1Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG2ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg2ctrloptions);
1306          EG2Attack        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO1Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1307          EG2Decay1        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG2Attack        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1308          _3ewa->ReadInt16(); // unknown              EG2Decay1        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1309          EG2Sustain       = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1310          EG2Release       = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG2Sustain       = _3ewa->ReadUint16();
1311          _3ewa->ReadInt16(); // unknown              EG2Release       = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1312          LFO2ControlDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1313          LFO2Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO2ControlDepth = _3ewa->ReadUint16();
1314          _3ewa->ReadInt16(); // unknown              LFO2Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1315          LFO2InternalDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1316          int32_t eg1decay2 = _3ewa->ReadInt32();              LFO2InternalDepth = _3ewa->ReadUint16();
1317          EG1Decay2          = (double) GIG_EXP_DECODE(eg1decay2);              int32_t eg1decay2 = _3ewa->ReadInt32();
1318          EG1InfiniteSustain = (eg1decay2 == 0x7fffffff);              EG1Decay2          = (double) GIG_EXP_DECODE(eg1decay2);
1319          _3ewa->ReadInt16(); // unknown              EG1InfiniteSustain = (eg1decay2 == 0x7fffffff);
1320          EG1PreAttack      = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1321          int32_t eg2decay2 = _3ewa->ReadInt32();              EG1PreAttack      = _3ewa->ReadUint16();
1322          EG2Decay2         = (double) GIG_EXP_DECODE(eg2decay2);              int32_t eg2decay2 = _3ewa->ReadInt32();
1323          EG2InfiniteSustain = (eg2decay2 == 0x7fffffff);              EG2Decay2         = (double) GIG_EXP_DECODE(eg2decay2);
1324          _3ewa->ReadInt16(); // unknown              EG2InfiniteSustain = (eg2decay2 == 0x7fffffff);
1325          EG2PreAttack      = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1326          uint8_t velocityresponse = _3ewa->ReadUint8();              EG2PreAttack      = _3ewa->ReadUint16();
1327          if (velocityresponse < 5) {              uint8_t velocityresponse = _3ewa->ReadUint8();
1328              VelocityResponseCurve = curve_type_nonlinear;              if (velocityresponse < 5) {
1329              VelocityResponseDepth = velocityresponse;                  VelocityResponseCurve = curve_type_nonlinear;
1330          }                  VelocityResponseDepth = velocityresponse;
1331          else if (velocityresponse < 10) {              } else if (velocityresponse < 10) {
1332              VelocityResponseCurve = curve_type_linear;                  VelocityResponseCurve = curve_type_linear;
1333              VelocityResponseDepth = velocityresponse - 5;                  VelocityResponseDepth = velocityresponse - 5;
1334          }              } else if (velocityresponse < 15) {
1335          else if (velocityresponse < 15) {                  VelocityResponseCurve = curve_type_special;
1336              VelocityResponseCurve = curve_type_special;                  VelocityResponseDepth = velocityresponse - 10;
1337              VelocityResponseDepth = velocityresponse - 10;              } else {
1338                    VelocityResponseCurve = curve_type_unknown;
1339                    VelocityResponseDepth = 0;
1340                }
1341                uint8_t releasevelocityresponse = _3ewa->ReadUint8();
1342                if (releasevelocityresponse < 5) {
1343                    ReleaseVelocityResponseCurve = curve_type_nonlinear;
1344                    ReleaseVelocityResponseDepth = releasevelocityresponse;
1345                } else if (releasevelocityresponse < 10) {
1346                    ReleaseVelocityResponseCurve = curve_type_linear;
1347                    ReleaseVelocityResponseDepth = releasevelocityresponse - 5;
1348                } else if (releasevelocityresponse < 15) {
1349                    ReleaseVelocityResponseCurve = curve_type_special;
1350                    ReleaseVelocityResponseDepth = releasevelocityresponse - 10;
1351                } else {
1352                    ReleaseVelocityResponseCurve = curve_type_unknown;
1353                    ReleaseVelocityResponseDepth = 0;
1354                }
1355                VelocityResponseCurveScaling = _3ewa->ReadUint8();
1356                AttenuationControllerThreshold = _3ewa->ReadInt8();
1357                _3ewa->ReadInt32(); // unknown
1358                SampleStartOffset = (uint16_t) _3ewa->ReadInt16();
1359                _3ewa->ReadInt16(); // unknown
1360                uint8_t pitchTrackDimensionBypass = _3ewa->ReadInt8();
1361                PitchTrack = GIG_PITCH_TRACK_EXTRACT(pitchTrackDimensionBypass);
1362                if      (pitchTrackDimensionBypass & 0x10) DimensionBypass = dim_bypass_ctrl_94;
1363                else if (pitchTrackDimensionBypass & 0x20) DimensionBypass = dim_bypass_ctrl_95;
1364                else                                       DimensionBypass = dim_bypass_ctrl_none;
1365                uint8_t pan = _3ewa->ReadUint8();
1366                Pan         = (pan < 64) ? pan : -((int)pan - 63); // signed 7 bit -> signed 8 bit
1367                SelfMask = _3ewa->ReadInt8() & 0x01;
1368                _3ewa->ReadInt8(); // unknown
1369                uint8_t lfo3ctrl = _3ewa->ReadUint8();
1370                LFO3Controller           = static_cast<lfo3_ctrl_t>(lfo3ctrl & 0x07); // lower 3 bits
1371                LFO3Sync                 = lfo3ctrl & 0x20; // bit 5
1372                InvertAttenuationController = lfo3ctrl & 0x80; // bit 7
1373                AttenuationController  = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1374                uint8_t lfo2ctrl       = _3ewa->ReadUint8();
1375                LFO2Controller         = static_cast<lfo2_ctrl_t>(lfo2ctrl & 0x07); // lower 3 bits
1376                LFO2FlipPhase          = lfo2ctrl & 0x80; // bit 7
1377                LFO2Sync               = lfo2ctrl & 0x20; // bit 5
1378                bool extResonanceCtrl  = lfo2ctrl & 0x40; // bit 6
1379                uint8_t lfo1ctrl       = _3ewa->ReadUint8();
1380                LFO1Controller         = static_cast<lfo1_ctrl_t>(lfo1ctrl & 0x07); // lower 3 bits
1381                LFO1FlipPhase          = lfo1ctrl & 0x80; // bit 7
1382                LFO1Sync               = lfo1ctrl & 0x40; // bit 6
1383                VCFResonanceController = (extResonanceCtrl) ? static_cast<vcf_res_ctrl_t>(GIG_VCF_RESONANCE_CTRL_EXTRACT(lfo1ctrl))
1384                                                            : vcf_res_ctrl_none;
1385                uint16_t eg3depth = _3ewa->ReadUint16();
1386                EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */
1387                                            : (-1) * (int16_t) ((eg3depth ^ 0xffff) + 1); /* binary complementary for negatives */
1388                _3ewa->ReadInt16(); // unknown
1389                ChannelOffset = _3ewa->ReadUint8() / 4;
1390                uint8_t regoptions = _3ewa->ReadUint8();
1391                MSDecode           = regoptions & 0x01; // bit 0
1392                SustainDefeat      = regoptions & 0x02; // bit 1
1393                _3ewa->ReadInt16(); // unknown
1394                VelocityUpperLimit = _3ewa->ReadInt8();
1395                _3ewa->ReadInt8(); // unknown
1396                _3ewa->ReadInt16(); // unknown
1397                ReleaseTriggerDecay = _3ewa->ReadUint8(); // release trigger decay
1398                _3ewa->ReadInt8(); // unknown
1399                _3ewa->ReadInt8(); // unknown
1400                EG1Hold = _3ewa->ReadUint8() & 0x80; // bit 7
1401                uint8_t vcfcutoff = _3ewa->ReadUint8();
1402                VCFEnabled = vcfcutoff & 0x80; // bit 7
1403                VCFCutoff  = vcfcutoff & 0x7f; // lower 7 bits
1404                VCFCutoffController = static_cast<vcf_cutoff_ctrl_t>(_3ewa->ReadUint8());
1405                uint8_t vcfvelscale = _3ewa->ReadUint8();
1406                VCFCutoffControllerInvert = vcfvelscale & 0x80; // bit 7
1407                VCFVelocityScale = vcfvelscale & 0x7f; // lower 7 bits
1408                _3ewa->ReadInt8(); // unknown
1409                uint8_t vcfresonance = _3ewa->ReadUint8();
1410                VCFResonance = vcfresonance & 0x7f; // lower 7 bits
1411                VCFResonanceDynamic = !(vcfresonance & 0x80); // bit 7
1412                uint8_t vcfbreakpoint         = _3ewa->ReadUint8();
1413                VCFKeyboardTracking           = vcfbreakpoint & 0x80; // bit 7
1414                VCFKeyboardTrackingBreakpoint = vcfbreakpoint & 0x7f; // lower 7 bits
1415                uint8_t vcfvelocity = _3ewa->ReadUint8();
1416                VCFVelocityDynamicRange = vcfvelocity % 5;
1417                VCFVelocityCurve        = static_cast<curve_type_t>(vcfvelocity / 5);
1418                VCFType = static_cast<vcf_type_t>(_3ewa->ReadUint8());
1419                if (VCFType == vcf_type_lowpass) {
1420                    if (lfo3ctrl & 0x40) // bit 6
1421                        VCFType = vcf_type_lowpassturbo;
1422                }
1423                if (_3ewa->RemainingBytes() >= 8) {
1424                    _3ewa->Read(DimensionUpperLimits, 1, 8);
1425                } else {
1426                    memset(DimensionUpperLimits, 0, 8);
1427                }
1428            } else { // '3ewa' chunk does not exist yet
1429                // use default values
1430                LFO3Frequency                   = 1.0;
1431                EG3Attack                       = 0.0;
1432                LFO1InternalDepth               = 0;
1433                LFO3InternalDepth               = 0;
1434                LFO1ControlDepth                = 0;
1435                LFO3ControlDepth                = 0;
1436                EG1Attack                       = 0.0;
1437                EG1Decay1                       = 0.005;
1438                EG1Sustain                      = 1000;
1439                EG1Release                      = 0.3;
1440                EG1Controller.type              = eg1_ctrl_t::type_none;
1441                EG1Controller.controller_number = 0;
1442                EG1ControllerInvert             = false;
1443                EG1ControllerAttackInfluence    = 0;
1444                EG1ControllerDecayInfluence     = 0;
1445                EG1ControllerReleaseInfluence   = 0;
1446                EG2Controller.type              = eg2_ctrl_t::type_none;
1447                EG2Controller.controller_number = 0;
1448                EG2ControllerInvert             = false;
1449                EG2ControllerAttackInfluence    = 0;
1450                EG2ControllerDecayInfluence     = 0;
1451                EG2ControllerReleaseInfluence   = 0;
1452                LFO1Frequency                   = 1.0;
1453                EG2Attack                       = 0.0;
1454                EG2Decay1                       = 0.005;
1455                EG2Sustain                      = 1000;
1456                EG2Release                      = 0.3;
1457                LFO2ControlDepth                = 0;
1458                LFO2Frequency                   = 1.0;
1459                LFO2InternalDepth               = 0;
1460                EG1Decay2                       = 0.0;
1461                EG1InfiniteSustain              = true;
1462                EG1PreAttack                    = 0;
1463                EG2Decay2                       = 0.0;
1464                EG2InfiniteSustain              = true;
1465                EG2PreAttack                    = 0;
1466                VelocityResponseCurve           = curve_type_nonlinear;
1467                VelocityResponseDepth           = 3;
1468                ReleaseVelocityResponseCurve    = curve_type_nonlinear;
1469                ReleaseVelocityResponseDepth    = 3;
1470                VelocityResponseCurveScaling    = 32;
1471                AttenuationControllerThreshold  = 0;
1472                SampleStartOffset               = 0;
1473                PitchTrack                      = true;
1474                DimensionBypass                 = dim_bypass_ctrl_none;
1475                Pan                             = 0;
1476                SelfMask                        = true;
1477                LFO3Controller                  = lfo3_ctrl_modwheel;
1478                LFO3Sync                        = false;
1479                InvertAttenuationController     = false;
1480                AttenuationController.type      = attenuation_ctrl_t::type_none;
1481                AttenuationController.controller_number = 0;
1482                LFO2Controller                  = lfo2_ctrl_internal;
1483                LFO2FlipPhase                   = false;
1484                LFO2Sync                        = false;
1485                LFO1Controller                  = lfo1_ctrl_internal;
1486                LFO1FlipPhase                   = false;
1487                LFO1Sync                        = false;
1488                VCFResonanceController          = vcf_res_ctrl_none;
1489                EG3Depth                        = 0;
1490                ChannelOffset                   = 0;
1491                MSDecode                        = false;
1492                SustainDefeat                   = false;
1493                VelocityUpperLimit              = 0;
1494                ReleaseTriggerDecay             = 0;
1495                EG1Hold                         = false;
1496                VCFEnabled                      = false;
1497                VCFCutoff                       = 0;
1498                VCFCutoffController             = vcf_cutoff_ctrl_none;
1499                VCFCutoffControllerInvert       = false;
1500                VCFVelocityScale                = 0;
1501                VCFResonance                    = 0;
1502                VCFResonanceDynamic             = false;
1503                VCFKeyboardTracking             = false;
1504                VCFKeyboardTrackingBreakpoint   = 0;
1505                VCFVelocityDynamicRange         = 0x04;
1506                VCFVelocityCurve                = curve_type_linear;
1507                VCFType                         = vcf_type_lowpass;
1508                memset(DimensionUpperLimits, 127, 8);
1509            }
1510    
1511            pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,
1512                                                         VelocityResponseDepth,
1513                                                         VelocityResponseCurveScaling);
1514    
1515            curve_type_t curveType = ReleaseVelocityResponseCurve;
1516            uint8_t depth = ReleaseVelocityResponseDepth;
1517    
1518            // this models a strange behaviour or bug in GSt: two of the
1519            // velocity response curves for release time are not used even
1520            // if specified, instead another curve is chosen.
1521            if ((curveType == curve_type_nonlinear && depth == 0) ||
1522                (curveType == curve_type_special   && depth == 4)) {
1523                curveType = curve_type_nonlinear;
1524                depth = 3;
1525            }
1526            pVelocityReleaseTable = GetVelocityTable(curveType, depth, 0);
1527    
1528            curveType = VCFVelocityCurve;
1529            depth = VCFVelocityDynamicRange;
1530    
1531            // even stranger GSt: two of the velocity response curves for
1532            // filter cutoff are not used, instead another special curve
1533            // is chosen. This curve is not used anywhere else.
1534            if ((curveType == curve_type_nonlinear && depth == 0) ||
1535                (curveType == curve_type_special   && depth == 4)) {
1536                curveType = curve_type_special;
1537                depth = 5;
1538          }          }
1539          else {          pVelocityCutoffTable = GetVelocityTable(curveType, depth,
1540              VelocityResponseCurve = curve_type_unknown;                                                  VCFCutoffController <= vcf_cutoff_ctrl_none2 ? VCFVelocityScale : 0);
1541              VelocityResponseDepth = 0;  
1542            SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));
1543            VelocityTable = 0;
1544        }
1545    
1546        /*
1547         * Constructs a DimensionRegion by copying all parameters from
1548         * another DimensionRegion
1549         */
1550        DimensionRegion::DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src) : DLS::Sampler(_3ewl) {
1551            Instances++;
1552            *this = src; // default memberwise shallow copy of all parameters
1553            pParentList = _3ewl; // restore the chunk pointer
1554    
1555            // deep copy of owned structures
1556            if (src.VelocityTable) {
1557                VelocityTable = new uint8_t[128];
1558                for (int k = 0 ; k < 128 ; k++)
1559                    VelocityTable[k] = src.VelocityTable[k];
1560            }
1561            if (src.pSampleLoops) {
1562                pSampleLoops = new DLS::sample_loop_t[src.SampleLoops];
1563                for (int k = 0 ; k < src.SampleLoops ; k++)
1564                    pSampleLoops[k] = src.pSampleLoops[k];
1565          }          }
1566          uint8_t releasevelocityresponse = _3ewa->ReadUint8();      }
1567          if (releasevelocityresponse < 5) {  
1568              ReleaseVelocityResponseCurve = curve_type_nonlinear;      /**
1569              ReleaseVelocityResponseDepth = releasevelocityresponse;       * Apply dimension region settings to the respective RIFF chunks. You
1570          }       * have to call File::Save() to make changes persistent.
1571          else if (releasevelocityresponse < 10) {       *
1572              ReleaseVelocityResponseCurve = curve_type_linear;       * Usually there is absolutely no need to call this method explicitly.
1573              ReleaseVelocityResponseDepth = releasevelocityresponse - 5;       * It will be called automatically when File::Save() was called.
1574          }       */
1575          else if (releasevelocityresponse < 15) {      void DimensionRegion::UpdateChunks() {
1576              ReleaseVelocityResponseCurve = curve_type_special;          // check if wsmp is going to be created by
1577              ReleaseVelocityResponseDepth = releasevelocityresponse - 10;          // DLS::Sampler::UpdateChunks
1578            bool wsmp_created = !pParentList->GetSubChunk(CHUNK_ID_WSMP);
1579    
1580            // first update base class's chunk
1581            DLS::Sampler::UpdateChunks();
1582    
1583            RIFF::Chunk* wsmp = pParentList->GetSubChunk(CHUNK_ID_WSMP);
1584            uint8_t* pData = (uint8_t*) wsmp->LoadChunkData();
1585            pData[12] = Crossfade.in_start;
1586            pData[13] = Crossfade.in_end;
1587            pData[14] = Crossfade.out_start;
1588            pData[15] = Crossfade.out_end;
1589    
1590            // make sure '3ewa' chunk exists
1591            RIFF::Chunk* _3ewa = pParentList->GetSubChunk(CHUNK_ID_3EWA);
1592            if (!_3ewa)  _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, 140);
1593            else if (wsmp_created) {
1594                // make sure the chunk order is: wsmp, 3ewa
1595                pParentList->MoveSubChunk(_3ewa, 0);
1596          }          }
1597          else {          pData = (uint8_t*) _3ewa->LoadChunkData();
1598              ReleaseVelocityResponseCurve = curve_type_unknown;  
1599              ReleaseVelocityResponseDepth = 0;          // update '3ewa' chunk with DimensionRegion's current settings
1600    
1601            const uint32_t chunksize = _3ewa->GetNewSize();
1602            store32(&pData[0], chunksize); // unknown, always chunk size?
1603    
1604            const int32_t lfo3freq = (int32_t) GIG_EXP_ENCODE(LFO3Frequency);
1605            store32(&pData[4], lfo3freq);
1606    
1607            const int32_t eg3attack = (int32_t) GIG_EXP_ENCODE(EG3Attack);
1608            store32(&pData[8], eg3attack);
1609    
1610            // next 2 bytes unknown
1611    
1612            store16(&pData[14], LFO1InternalDepth);
1613    
1614            // next 2 bytes unknown
1615    
1616            store16(&pData[18], LFO3InternalDepth);
1617    
1618            // next 2 bytes unknown
1619    
1620            store16(&pData[22], LFO1ControlDepth);
1621    
1622            // next 2 bytes unknown
1623    
1624            store16(&pData[26], LFO3ControlDepth);
1625    
1626            const int32_t eg1attack = (int32_t) GIG_EXP_ENCODE(EG1Attack);
1627            store32(&pData[28], eg1attack);
1628    
1629            const int32_t eg1decay1 = (int32_t) GIG_EXP_ENCODE(EG1Decay1);
1630            store32(&pData[32], eg1decay1);
1631    
1632            // next 2 bytes unknown
1633    
1634            store16(&pData[38], EG1Sustain);
1635    
1636            const int32_t eg1release = (int32_t) GIG_EXP_ENCODE(EG1Release);
1637            store32(&pData[40], eg1release);
1638    
1639            const uint8_t eg1ctl = (uint8_t) EncodeLeverageController(EG1Controller);
1640            pData[44] = eg1ctl;
1641    
1642            const uint8_t eg1ctrloptions =
1643                (EG1ControllerInvert ? 0x01 : 0x00) |
1644                GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG1ControllerAttackInfluence) |
1645                GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG1ControllerDecayInfluence) |
1646                GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG1ControllerReleaseInfluence);
1647            pData[45] = eg1ctrloptions;
1648    
1649            const uint8_t eg2ctl = (uint8_t) EncodeLeverageController(EG2Controller);
1650            pData[46] = eg2ctl;
1651    
1652            const uint8_t eg2ctrloptions =
1653                (EG2ControllerInvert ? 0x01 : 0x00) |
1654                GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG2ControllerAttackInfluence) |
1655                GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG2ControllerDecayInfluence) |
1656                GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG2ControllerReleaseInfluence);
1657            pData[47] = eg2ctrloptions;
1658    
1659            const int32_t lfo1freq = (int32_t) GIG_EXP_ENCODE(LFO1Frequency);
1660            store32(&pData[48], lfo1freq);
1661    
1662            const int32_t eg2attack = (int32_t) GIG_EXP_ENCODE(EG2Attack);
1663            store32(&pData[52], eg2attack);
1664    
1665            const int32_t eg2decay1 = (int32_t) GIG_EXP_ENCODE(EG2Decay1);
1666            store32(&pData[56], eg2decay1);
1667    
1668            // next 2 bytes unknown
1669    
1670            store16(&pData[62], EG2Sustain);
1671    
1672            const int32_t eg2release = (int32_t) GIG_EXP_ENCODE(EG2Release);
1673            store32(&pData[64], eg2release);
1674    
1675            // next 2 bytes unknown
1676    
1677            store16(&pData[70], LFO2ControlDepth);
1678    
1679            const int32_t lfo2freq = (int32_t) GIG_EXP_ENCODE(LFO2Frequency);
1680            store32(&pData[72], lfo2freq);
1681    
1682            // next 2 bytes unknown
1683    
1684            store16(&pData[78], LFO2InternalDepth);
1685    
1686            const int32_t eg1decay2 = (int32_t) (EG1InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG1Decay2);
1687            store32(&pData[80], eg1decay2);
1688    
1689            // next 2 bytes unknown
1690    
1691            store16(&pData[86], EG1PreAttack);
1692    
1693            const int32_t eg2decay2 = (int32_t) (EG2InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG2Decay2);
1694            store32(&pData[88], eg2decay2);
1695    
1696            // next 2 bytes unknown
1697    
1698            store16(&pData[94], EG2PreAttack);
1699    
1700            {
1701                if (VelocityResponseDepth > 4) throw Exception("VelocityResponseDepth must be between 0 and 4");
1702                uint8_t velocityresponse = VelocityResponseDepth;
1703                switch (VelocityResponseCurve) {
1704                    case curve_type_nonlinear:
1705                        break;
1706                    case curve_type_linear:
1707                        velocityresponse += 5;
1708                        break;
1709                    case curve_type_special:
1710                        velocityresponse += 10;
1711                        break;
1712                    case curve_type_unknown:
1713                    default:
1714                        throw Exception("Could not update DimensionRegion's chunk, unknown VelocityResponseCurve selected");
1715                }
1716                pData[96] = velocityresponse;
1717            }
1718    
1719            {
1720                if (ReleaseVelocityResponseDepth > 4) throw Exception("ReleaseVelocityResponseDepth must be between 0 and 4");
1721                uint8_t releasevelocityresponse = ReleaseVelocityResponseDepth;
1722                switch (ReleaseVelocityResponseCurve) {
1723                    case curve_type_nonlinear:
1724                        break;
1725                    case curve_type_linear:
1726                        releasevelocityresponse += 5;
1727                        break;
1728                    case curve_type_special:
1729                        releasevelocityresponse += 10;
1730                        break;
1731                    case curve_type_unknown:
1732                    default:
1733                        throw Exception("Could not update DimensionRegion's chunk, unknown ReleaseVelocityResponseCurve selected");
1734                }
1735                pData[97] = releasevelocityresponse;
1736            }
1737    
1738            pData[98] = VelocityResponseCurveScaling;
1739    
1740            pData[99] = AttenuationControllerThreshold;
1741    
1742            // next 4 bytes unknown
1743    
1744            store16(&pData[104], SampleStartOffset);
1745    
1746            // next 2 bytes unknown
1747    
1748            {
1749                uint8_t pitchTrackDimensionBypass = GIG_PITCH_TRACK_ENCODE(PitchTrack);
1750                switch (DimensionBypass) {
1751                    case dim_bypass_ctrl_94:
1752                        pitchTrackDimensionBypass |= 0x10;
1753                        break;
1754                    case dim_bypass_ctrl_95:
1755                        pitchTrackDimensionBypass |= 0x20;
1756                        break;
1757                    case dim_bypass_ctrl_none:
1758                        //FIXME: should we set anything here?
1759                        break;
1760                    default:
1761                        throw Exception("Could not update DimensionRegion's chunk, unknown DimensionBypass selected");
1762                }
1763                pData[108] = pitchTrackDimensionBypass;
1764            }
1765    
1766            const uint8_t pan = (Pan >= 0) ? Pan : ((-Pan) + 63); // signed 8 bit -> signed 7 bit
1767            pData[109] = pan;
1768    
1769            const uint8_t selfmask = (SelfMask) ? 0x01 : 0x00;
1770            pData[110] = selfmask;
1771    
1772            // next byte unknown
1773    
1774            {
1775                uint8_t lfo3ctrl = LFO3Controller & 0x07; // lower 3 bits
1776                if (LFO3Sync) lfo3ctrl |= 0x20; // bit 5
1777                if (InvertAttenuationController) lfo3ctrl |= 0x80; // bit 7
1778                if (VCFType == vcf_type_lowpassturbo) lfo3ctrl |= 0x40; // bit 6
1779                pData[112] = lfo3ctrl;
1780            }
1781    
1782            const uint8_t attenctl = EncodeLeverageController(AttenuationController);
1783            pData[113] = attenctl;
1784    
1785            {
1786                uint8_t lfo2ctrl = LFO2Controller & 0x07; // lower 3 bits
1787                if (LFO2FlipPhase) lfo2ctrl |= 0x80; // bit 7
1788                if (LFO2Sync)      lfo2ctrl |= 0x20; // bit 5
1789                if (VCFResonanceController != vcf_res_ctrl_none) lfo2ctrl |= 0x40; // bit 6
1790                pData[114] = lfo2ctrl;
1791            }
1792    
1793            {
1794                uint8_t lfo1ctrl = LFO1Controller & 0x07; // lower 3 bits
1795                if (LFO1FlipPhase) lfo1ctrl |= 0x80; // bit 7
1796                if (LFO1Sync)      lfo1ctrl |= 0x40; // bit 6
1797                if (VCFResonanceController != vcf_res_ctrl_none)
1798                    lfo1ctrl |= GIG_VCF_RESONANCE_CTRL_ENCODE(VCFResonanceController);
1799                pData[115] = lfo1ctrl;
1800          }          }
1801          VelocityResponseCurveScaling = _3ewa->ReadUint8();  
1802          AttenuationControllerThreshold = _3ewa->ReadInt8();          const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth
1803          _3ewa->ReadInt32(); // unknown                                                    : uint16_t(((-EG3Depth) - 1) ^ 0xffff); /* binary complementary for negatives */
1804          SampleStartOffset = (uint16_t) _3ewa->ReadInt16();          pData[116] = eg3depth;
1805          _3ewa->ReadInt16(); // unknown  
1806          uint8_t pitchTrackDimensionBypass = _3ewa->ReadInt8();          // next 2 bytes unknown
1807          PitchTrack = GIG_PITCH_TRACK_EXTRACT(pitchTrackDimensionBypass);  
1808          if      (pitchTrackDimensionBypass & 0x10) DimensionBypass = dim_bypass_ctrl_94;          const uint8_t channeloffset = ChannelOffset * 4;
1809          else if (pitchTrackDimensionBypass & 0x20) DimensionBypass = dim_bypass_ctrl_95;          pData[120] = channeloffset;
1810          else                                       DimensionBypass = dim_bypass_ctrl_none;  
1811          uint8_t pan = _3ewa->ReadUint8();          {
1812          Pan         = (pan < 64) ? pan : -((int)pan - 63); // signed 7 bit -> signed 8 bit              uint8_t regoptions = 0;
1813          SelfMask = _3ewa->ReadInt8() & 0x01;              if (MSDecode)      regoptions |= 0x01; // bit 0
1814          _3ewa->ReadInt8(); // unknown              if (SustainDefeat) regoptions |= 0x02; // bit 1
1815          uint8_t lfo3ctrl = _3ewa->ReadUint8();              pData[121] = regoptions;
         LFO3Controller           = static_cast<lfo3_ctrl_t>(lfo3ctrl & 0x07); // lower 3 bits  
         LFO3Sync                 = lfo3ctrl & 0x20; // bit 5  
         InvertAttenuationController = lfo3ctrl & 0x80; // bit 7  
         AttenuationController  = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));  
         uint8_t lfo2ctrl       = _3ewa->ReadUint8();  
         LFO2Controller         = static_cast<lfo2_ctrl_t>(lfo2ctrl & 0x07); // lower 3 bits  
         LFO2FlipPhase          = lfo2ctrl & 0x80; // bit 7  
         LFO2Sync               = lfo2ctrl & 0x20; // bit 5  
         bool extResonanceCtrl  = lfo2ctrl & 0x40; // bit 6  
         uint8_t lfo1ctrl       = _3ewa->ReadUint8();  
         LFO1Controller         = static_cast<lfo1_ctrl_t>(lfo1ctrl & 0x07); // lower 3 bits  
         LFO1FlipPhase          = lfo1ctrl & 0x80; // bit 7  
         LFO1Sync               = lfo1ctrl & 0x40; // bit 6  
         VCFResonanceController = (extResonanceCtrl) ? static_cast<vcf_res_ctrl_t>(GIG_VCF_RESONANCE_CTRL_EXTRACT(lfo1ctrl))  
                                                     : vcf_res_ctrl_none;  
         uint16_t eg3depth = _3ewa->ReadUint16();  
         EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */  
                                       : (-1) * (int16_t) ((eg3depth ^ 0xffff) + 1); /* binary complementary for negatives */  
         _3ewa->ReadInt16(); // unknown  
         ChannelOffset = _3ewa->ReadUint8() / 4;  
         uint8_t regoptions = _3ewa->ReadUint8();  
         MSDecode           = regoptions & 0x01; // bit 0  
         SustainDefeat      = regoptions & 0x02; // bit 1  
         _3ewa->ReadInt16(); // unknown  
         VelocityUpperLimit = _3ewa->ReadInt8();  
         _3ewa->ReadInt8(); // unknown  
         _3ewa->ReadInt16(); // unknown  
         ReleaseTriggerDecay = _3ewa->ReadUint8(); // release trigger decay  
         _3ewa->ReadInt8(); // unknown  
         _3ewa->ReadInt8(); // unknown  
         EG1Hold = _3ewa->ReadUint8() & 0x80; // bit 7  
         uint8_t vcfcutoff = _3ewa->ReadUint8();  
         VCFEnabled = vcfcutoff & 0x80; // bit 7  
         VCFCutoff  = vcfcutoff & 0x7f; // lower 7 bits  
         VCFCutoffController = static_cast<vcf_cutoff_ctrl_t>(_3ewa->ReadUint8());  
         VCFVelocityScale = _3ewa->ReadUint8();  
         _3ewa->ReadInt8(); // unknown  
         uint8_t vcfresonance = _3ewa->ReadUint8();  
         VCFResonance = vcfresonance & 0x7f; // lower 7 bits  
         VCFResonanceDynamic = !(vcfresonance & 0x80); // bit 7  
         uint8_t vcfbreakpoint         = _3ewa->ReadUint8();  
         VCFKeyboardTracking           = vcfbreakpoint & 0x80; // bit 7  
         VCFKeyboardTrackingBreakpoint = vcfbreakpoint & 0x7f; // lower 7 bits  
         uint8_t vcfvelocity = _3ewa->ReadUint8();  
         VCFVelocityDynamicRange = vcfvelocity % 5;  
         VCFVelocityCurve        = static_cast<curve_type_t>(vcfvelocity / 5);  
         VCFType = static_cast<vcf_type_t>(_3ewa->ReadUint8());  
         if (VCFType == vcf_type_lowpass) {  
             if (lfo3ctrl & 0x40) // bit 6  
                 VCFType = vcf_type_lowpassturbo;  
1816          }          }
1817    
1818          // get the corresponding velocity->volume table from the table map or create & calculate that table if it doesn't exist yet          // next 2 bytes unknown
1819          uint32_t tableKey = (VelocityResponseCurve<<16) | (VelocityResponseDepth<<8) | VelocityResponseCurveScaling;  
1820            pData[124] = VelocityUpperLimit;
1821    
1822            // next 3 bytes unknown
1823    
1824            pData[128] = ReleaseTriggerDecay;
1825    
1826            // next 2 bytes unknown
1827    
1828            const uint8_t eg1hold = (EG1Hold) ? 0x80 : 0x00; // bit 7
1829            pData[131] = eg1hold;
1830    
1831            const uint8_t vcfcutoff = (VCFEnabled ? 0x80 : 0x00) |  /* bit 7 */
1832                                      (VCFCutoff & 0x7f);   /* lower 7 bits */
1833            pData[132] = vcfcutoff;
1834    
1835            pData[133] = VCFCutoffController;
1836    
1837            const uint8_t vcfvelscale = (VCFCutoffControllerInvert ? 0x80 : 0x00) | /* bit 7 */
1838                                        (VCFVelocityScale & 0x7f); /* lower 7 bits */
1839            pData[134] = vcfvelscale;
1840    
1841            // next byte unknown
1842    
1843            const uint8_t vcfresonance = (VCFResonanceDynamic ? 0x00 : 0x80) | /* bit 7 */
1844                                         (VCFResonance & 0x7f); /* lower 7 bits */
1845            pData[136] = vcfresonance;
1846    
1847            const uint8_t vcfbreakpoint = (VCFKeyboardTracking ? 0x80 : 0x00) | /* bit 7 */
1848                                          (VCFKeyboardTrackingBreakpoint & 0x7f); /* lower 7 bits */
1849            pData[137] = vcfbreakpoint;
1850    
1851            const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 |
1852                                        VCFVelocityCurve * 5;
1853            pData[138] = vcfvelocity;
1854    
1855            const uint8_t vcftype = (VCFType == vcf_type_lowpassturbo) ? vcf_type_lowpass : VCFType;
1856            pData[139] = vcftype;
1857    
1858            if (chunksize >= 148) {
1859                memcpy(&pData[140], DimensionUpperLimits, 8);
1860            }
1861        }
1862    
1863        // get the corresponding velocity table from the table map or create & calculate that table if it doesn't exist yet
1864        double* DimensionRegion::GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling)
1865        {
1866            double* table;
1867            uint32_t tableKey = (curveType<<16) | (depth<<8) | scaling;
1868          if (pVelocityTables->count(tableKey)) { // if key exists          if (pVelocityTables->count(tableKey)) { // if key exists
1869              pVelocityAttenuationTable = (*pVelocityTables)[tableKey];              table = (*pVelocityTables)[tableKey];
1870          }          }
1871          else {          else {
1872              pVelocityAttenuationTable =              table = CreateVelocityTable(curveType, depth, scaling);
1873                  CreateVelocityTable(VelocityResponseCurve,              (*pVelocityTables)[tableKey] = table; // put the new table into the tables map
                                     VelocityResponseDepth,  
                                     VelocityResponseCurveScaling);  
             (*pVelocityTables)[tableKey] = pVelocityAttenuationTable; // put the new table into the tables map  
1874          }          }
1875            return table;
1876        }
1877    
1878          SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));      Region* DimensionRegion::GetParent() const {
1879            return pRegion;
1880      }      }
1881    
1882      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {
# Line 1295  namespace { Line 1997  namespace {
1997          return decodedcontroller;          return decodedcontroller;
1998      }      }
1999    
2000        DimensionRegion::_lev_ctrl_t DimensionRegion::EncodeLeverageController(leverage_ctrl_t DecodedController) {
2001            _lev_ctrl_t encodedcontroller;
2002            switch (DecodedController.type) {
2003                // special controller
2004                case leverage_ctrl_t::type_none:
2005                    encodedcontroller = _lev_ctrl_none;
2006                    break;
2007                case leverage_ctrl_t::type_velocity:
2008                    encodedcontroller = _lev_ctrl_velocity;
2009                    break;
2010                case leverage_ctrl_t::type_channelaftertouch:
2011                    encodedcontroller = _lev_ctrl_channelaftertouch;
2012                    break;
2013    
2014                // ordinary MIDI control change controller
2015                case leverage_ctrl_t::type_controlchange:
2016                    switch (DecodedController.controller_number) {
2017                        case 1:
2018                            encodedcontroller = _lev_ctrl_modwheel;
2019                            break;
2020                        case 2:
2021                            encodedcontroller = _lev_ctrl_breath;
2022                            break;
2023                        case 4:
2024                            encodedcontroller = _lev_ctrl_foot;
2025                            break;
2026                        case 12:
2027                            encodedcontroller = _lev_ctrl_effect1;
2028                            break;
2029                        case 13:
2030                            encodedcontroller = _lev_ctrl_effect2;
2031                            break;
2032                        case 16:
2033                            encodedcontroller = _lev_ctrl_genpurpose1;
2034                            break;
2035                        case 17:
2036                            encodedcontroller = _lev_ctrl_genpurpose2;
2037                            break;
2038                        case 18:
2039                            encodedcontroller = _lev_ctrl_genpurpose3;
2040                            break;
2041                        case 19:
2042                            encodedcontroller = _lev_ctrl_genpurpose4;
2043                            break;
2044                        case 5:
2045                            encodedcontroller = _lev_ctrl_portamentotime;
2046                            break;
2047                        case 64:
2048                            encodedcontroller = _lev_ctrl_sustainpedal;
2049                            break;
2050                        case 65:
2051                            encodedcontroller = _lev_ctrl_portamento;
2052                            break;
2053                        case 66:
2054                            encodedcontroller = _lev_ctrl_sostenutopedal;
2055                            break;
2056                        case 67:
2057                            encodedcontroller = _lev_ctrl_softpedal;
2058                            break;
2059                        case 80:
2060                            encodedcontroller = _lev_ctrl_genpurpose5;
2061                            break;
2062                        case 81:
2063                            encodedcontroller = _lev_ctrl_genpurpose6;
2064                            break;
2065                        case 82:
2066                            encodedcontroller = _lev_ctrl_genpurpose7;
2067                            break;
2068                        case 83:
2069                            encodedcontroller = _lev_ctrl_genpurpose8;
2070                            break;
2071                        case 91:
2072                            encodedcontroller = _lev_ctrl_effect1depth;
2073                            break;
2074                        case 92:
2075                            encodedcontroller = _lev_ctrl_effect2depth;
2076                            break;
2077                        case 93:
2078                            encodedcontroller = _lev_ctrl_effect3depth;
2079                            break;
2080                        case 94:
2081                            encodedcontroller = _lev_ctrl_effect4depth;
2082                            break;
2083                        case 95:
2084                            encodedcontroller = _lev_ctrl_effect5depth;
2085                            break;
2086                        default:
2087                            throw gig::Exception("leverage controller number is not supported by the gig format");
2088                    }
2089                    break;
2090                default:
2091                    throw gig::Exception("Unknown leverage controller type.");
2092            }
2093            return encodedcontroller;
2094        }
2095    
2096      DimensionRegion::~DimensionRegion() {      DimensionRegion::~DimensionRegion() {
2097          Instances--;          Instances--;
2098          if (!Instances) {          if (!Instances) {
# Line 1308  namespace { Line 2106  namespace {
2106              delete pVelocityTables;              delete pVelocityTables;
2107              pVelocityTables = NULL;              pVelocityTables = NULL;
2108          }          }
2109            if (VelocityTable) delete[] VelocityTable;
2110      }      }
2111    
2112      /**      /**
# Line 1325  namespace { Line 2124  namespace {
2124          return pVelocityAttenuationTable[MIDIKeyVelocity];          return pVelocityAttenuationTable[MIDIKeyVelocity];
2125      }      }
2126    
2127        double DimensionRegion::GetVelocityRelease(uint8_t MIDIKeyVelocity) {
2128            return pVelocityReleaseTable[MIDIKeyVelocity];
2129        }
2130    
2131        double DimensionRegion::GetVelocityCutoff(uint8_t MIDIKeyVelocity) {
2132            return pVelocityCutoffTable[MIDIKeyVelocity];
2133        }
2134    
2135      double* DimensionRegion::CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling) {      double* DimensionRegion::CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling) {
2136    
2137          // line-segment approximations of the 15 velocity curves          // line-segment approximations of the 15 velocity curves
# Line 1358  namespace { Line 2165  namespace {
2165          const int spe4[] = { 1, 4, 23, 5, 49, 13, 57, 17, 92, 57, 122, 127,          const int spe4[] = { 1, 4, 23, 5, 49, 13, 57, 17, 92, 57, 122, 127,
2166                               127, 127 };                               127, 127 };
2167    
2168            // this is only used by the VCF velocity curve
2169            const int spe5[] = { 1, 2, 30, 5, 60, 19, 77, 70, 83, 85, 88, 106,
2170                                 91, 127, 127, 127 };
2171    
2172          const int* const curves[] = { non0, non1, non2, non3, non4,          const int* const curves[] = { non0, non1, non2, non3, non4,
2173                                        lin0, lin1, lin2, lin3, lin4,                                        lin0, lin1, lin2, lin3, lin4,
2174                                        spe0, spe1, spe2, spe3, spe4 };                                        spe0, spe1, spe2, spe3, spe4, spe5 };
2175    
2176          double* const table = new double[128];          double* const table = new double[128];
2177    
# Line 1412  namespace { Line 2223  namespace {
2223              for (int i = 0; i < dimensionBits; i++) {              for (int i = 0; i < dimensionBits; i++) {
2224                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());
2225                  uint8_t     bits      = _3lnk->ReadUint8();                  uint8_t     bits      = _3lnk->ReadUint8();
2226                    _3lnk->ReadUint8(); // bit position of the dimension (bits[0] + bits[1] + ... + bits[i-1])
2227                    _3lnk->ReadUint8(); // (1 << bit position of next dimension) - (1 << bit position of this dimension)
2228                    uint8_t     zones     = _3lnk->ReadUint8(); // new for v3: number of zones doesn't have to be == pow(2,bits)
2229                  if (dimension == dimension_none) { // inactive dimension                  if (dimension == dimension_none) { // inactive dimension
2230                      pDimensionDefinitions[i].dimension  = dimension_none;                      pDimensionDefinitions[i].dimension  = dimension_none;
2231                      pDimensionDefinitions[i].bits       = 0;                      pDimensionDefinitions[i].bits       = 0;
2232                      pDimensionDefinitions[i].zones      = 0;                      pDimensionDefinitions[i].zones      = 0;
2233                      pDimensionDefinitions[i].split_type = split_type_bit;                      pDimensionDefinitions[i].split_type = split_type_bit;
                     pDimensionDefinitions[i].ranges     = NULL;  
2234                      pDimensionDefinitions[i].zone_size  = 0;                      pDimensionDefinitions[i].zone_size  = 0;
2235                  }                  }
2236                  else { // active dimension                  else { // active dimension
2237                      pDimensionDefinitions[i].dimension = dimension;                      pDimensionDefinitions[i].dimension = dimension;
2238                      pDimensionDefinitions[i].bits      = bits;                      pDimensionDefinitions[i].bits      = bits;
2239                      pDimensionDefinitions[i].zones     = 0x01 << bits; // = pow(2,bits)                      pDimensionDefinitions[i].zones     = zones ? zones : 0x01 << bits; // = pow(2,bits)
2240                      pDimensionDefinitions[i].split_type = (dimension == dimension_layer ||                      pDimensionDefinitions[i].split_type = __resolveSplitType(dimension);
2241                                                             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;  
2242                      Dimensions++;                      Dimensions++;
2243    
2244                      // if this is a layer dimension, remember the amount of layers                      // if this is a layer dimension, remember the amount of layers
2245                      if (dimension == dimension_layer) Layers = pDimensionDefinitions[i].zones;                      if (dimension == dimension_layer) Layers = pDimensionDefinitions[i].zones;
2246                  }                  }
2247                  _3lnk->SetPos(6, RIFF::stream_curpos); // jump forward to next dimension definition                  _3lnk->SetPos(3, RIFF::stream_curpos); // jump forward to next dimension definition
2248              }              }
2249                for (int i = dimensionBits ; i < 8 ; i++) pDimensionDefinitions[i].bits = 0;
2250    
2251              // 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,
2252              for (uint i = 0; i < Dimensions; i++) {              // update the VelocityTables in the dimension regions
2253                  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;  
                             }  
                         }  
                     }  
                 }  
             }  
2254    
2255              // 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();  
2256              if (file->pVersion && file->pVersion->major == 3)              if (file->pVersion && file->pVersion->major == 3)
2257                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure
2258              else              else
# Line 1482  namespace { Line 2261  namespace {
2261              // load sample references              // load sample references
2262              for (uint i = 0; i < DimensionRegions; i++) {              for (uint i = 0; i < DimensionRegions; i++) {
2263                  uint32_t wavepoolindex = _3lnk->ReadUint32();                  uint32_t wavepoolindex = _3lnk->ReadUint32();
2264                  pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);                  if (file->pWavePoolTable) pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);
2265                }
2266                GetSample(); // load global region sample reference
2267            } else {
2268                DimensionRegions = 0;
2269                for (int i = 0 ; i < 8 ; i++) {
2270                    pDimensionDefinitions[i].dimension  = dimension_none;
2271                    pDimensionDefinitions[i].bits       = 0;
2272                    pDimensionDefinitions[i].zones      = 0;
2273              }              }
2274          }          }
2275          else throw gig::Exception("Mandatory <3lnk> chunk not found.");  
2276            // make sure there is at least one dimension region
2277            if (!DimensionRegions) {
2278                RIFF::List* _3prg = rgnList->GetSubList(LIST_TYPE_3PRG);
2279                if (!_3prg) _3prg = rgnList->AddSubList(LIST_TYPE_3PRG);
2280                RIFF::List* _3ewl = _3prg->AddSubList(LIST_TYPE_3EWL);
2281                pDimensionRegions[0] = new DimensionRegion(this, _3ewl);
2282                DimensionRegions = 1;
2283            }
2284        }
2285    
2286        /**
2287         * Apply Region settings and all its DimensionRegions to the respective
2288         * RIFF chunks. You have to call File::Save() to make changes persistent.
2289         *
2290         * Usually there is absolutely no need to call this method explicitly.
2291         * It will be called automatically when File::Save() was called.
2292         *
2293         * @throws gig::Exception if samples cannot be dereferenced
2294         */
2295        void Region::UpdateChunks() {
2296            // in the gig format we don't care about the Region's sample reference
2297            // but we still have to provide some existing one to not corrupt the
2298            // file, so to avoid the latter we simply always assign the sample of
2299            // the first dimension region of this region
2300            pSample = pDimensionRegions[0]->pSample;
2301    
2302            // first update base class's chunks
2303            DLS::Region::UpdateChunks();
2304    
2305            File* pFile = (File*) GetParent()->GetParent();
2306            bool version3 = pFile->pVersion && pFile->pVersion->major == 3;
2307    
2308            // update dimension region's chunks
2309            for (int i = 0; i < DimensionRegions; i++) {
2310                DimensionRegion* d = pDimensionRegions[i];
2311    
2312                // make sure '3ewa' chunk exists (we need to this before
2313                // calling DimensionRegion::UpdateChunks, as
2314                // DimensionRegion doesn't know which file version it is)
2315                RIFF::Chunk* _3ewa = d->pParentList->GetSubChunk(CHUNK_ID_3EWA);
2316                if (!_3ewa) d->pParentList->AddSubChunk(CHUNK_ID_3EWA, version3 ? 148 : 140);
2317    
2318                d->UpdateChunks();
2319            }
2320    
2321            const int iMaxDimensions =  version3 ? 8 : 5;
2322            const int iMaxDimensionRegions = version3 ? 256 : 32;
2323    
2324            // make sure '3lnk' chunk exists
2325            RIFF::Chunk* _3lnk = pCkRegion->GetSubChunk(CHUNK_ID_3LNK);
2326            if (!_3lnk) {
2327                const int _3lnkChunkSize = version3 ? 1092 : 172;
2328                _3lnk = pCkRegion->AddSubChunk(CHUNK_ID_3LNK, _3lnkChunkSize);
2329                memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);
2330    
2331                // move 3prg to last position
2332                pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3PRG), 0);
2333            }
2334    
2335            // update dimension definitions in '3lnk' chunk
2336            uint8_t* pData = (uint8_t*) _3lnk->LoadChunkData();
2337            store32(&pData[0], DimensionRegions);
2338            int shift = 0;
2339            for (int i = 0; i < iMaxDimensions; i++) {
2340                pData[4 + i * 8] = (uint8_t) pDimensionDefinitions[i].dimension;
2341                pData[5 + i * 8] = pDimensionDefinitions[i].bits;
2342                pData[6 + i * 8] = pDimensionDefinitions[i].dimension == dimension_none ? 0 : shift;
2343                pData[7 + i * 8] = (1 << (shift + pDimensionDefinitions[i].bits)) - (1 << shift);
2344                pData[8 + i * 8] = pDimensionDefinitions[i].zones;
2345                // next 3 bytes unknown, always zero?
2346    
2347                shift += pDimensionDefinitions[i].bits;
2348            }
2349    
2350            // update wave pool table in '3lnk' chunk
2351            const int iWavePoolOffset = version3 ? 68 : 44;
2352            for (uint i = 0; i < iMaxDimensionRegions; i++) {
2353                int iWaveIndex = -1;
2354                if (i < DimensionRegions) {
2355                    if (!pFile->pSamples || !pFile->pSamples->size()) throw gig::Exception("Could not update gig::Region, there are no samples");
2356                    File::SampleList::iterator iter = pFile->pSamples->begin();
2357                    File::SampleList::iterator end  = pFile->pSamples->end();
2358                    for (int index = 0; iter != end; ++iter, ++index) {
2359                        if (*iter == pDimensionRegions[i]->pSample) {
2360                            iWaveIndex = index;
2361                            break;
2362                        }
2363                    }
2364                }
2365                store32(&pData[iWavePoolOffset + i * 4], iWaveIndex);
2366            }
2367      }      }
2368    
2369      void Region::LoadDimensionRegions(RIFF::List* rgn) {      void Region::LoadDimensionRegions(RIFF::List* rgn) {
# Line 1495  namespace { Line 2373  namespace {
2373              RIFF::List* _3ewl = _3prg->GetFirstSubList();              RIFF::List* _3ewl = _3prg->GetFirstSubList();
2374              while (_3ewl) {              while (_3ewl) {
2375                  if (_3ewl->GetListType() == LIST_TYPE_3EWL) {                  if (_3ewl->GetListType() == LIST_TYPE_3EWL) {
2376                      pDimensionRegions[dimensionRegionNr] = new DimensionRegion(_3ewl);                      pDimensionRegions[dimensionRegionNr] = new DimensionRegion(this, _3ewl);
2377                      dimensionRegionNr++;                      dimensionRegionNr++;
2378                  }                  }
2379                  _3ewl = _3prg->GetNextSubList();                  _3ewl = _3prg->GetNextSubList();
# Line 1504  namespace { Line 2382  namespace {
2382          }          }
2383      }      }
2384    
2385      Region::~Region() {      void Region::UpdateVelocityTable() {
2386          for (uint i = 0; i < Dimensions; i++) {          // get velocity dimension's index
2387              if (pDimensionDefinitions[i].ranges) delete[] pDimensionDefinitions[i].ranges;          int veldim = -1;
2388            for (int i = 0 ; i < Dimensions ; i++) {
2389                if (pDimensionDefinitions[i].dimension == gig::dimension_velocity) {
2390                    veldim = i;
2391                    break;
2392                }
2393          }          }
2394            if (veldim == -1) return;
2395    
2396            int step = 1;
2397            for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;
2398            int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;
2399            int end = step * pDimensionDefinitions[veldim].zones;
2400    
2401            // loop through all dimension regions for all dimensions except the velocity dimension
2402            int dim[8] = { 0 };
2403            for (int i = 0 ; i < DimensionRegions ; i++) {
2404    
2405                if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||
2406                    pDimensionRegions[i]->VelocityUpperLimit) {
2407                    // create the velocity table
2408                    uint8_t* table = pDimensionRegions[i]->VelocityTable;
2409                    if (!table) {
2410                        table = new uint8_t[128];
2411                        pDimensionRegions[i]->VelocityTable = table;
2412                    }
2413                    int tableidx = 0;
2414                    int velocityZone = 0;
2415                    if (pDimensionRegions[i]->DimensionUpperLimits[veldim]) { // gig3
2416                        for (int k = i ; k < end ; k += step) {
2417                            DimensionRegion *d = pDimensionRegions[k];
2418                            for (; tableidx <= d->DimensionUpperLimits[veldim] ; tableidx++) table[tableidx] = velocityZone;
2419                            velocityZone++;
2420                        }
2421                    } else { // gig2
2422                        for (int k = i ; k < end ; k += step) {
2423                            DimensionRegion *d = pDimensionRegions[k];
2424                            for (; tableidx <= d->VelocityUpperLimit ; tableidx++) table[tableidx] = velocityZone;
2425                            velocityZone++;
2426                        }
2427                    }
2428                } else {
2429                    if (pDimensionRegions[i]->VelocityTable) {
2430                        delete[] pDimensionRegions[i]->VelocityTable;
2431                        pDimensionRegions[i]->VelocityTable = 0;
2432                    }
2433                }
2434    
2435                int j;
2436                int shift = 0;
2437                for (j = 0 ; j < Dimensions ; j++) {
2438                    if (j == veldim) i += skipveldim; // skip velocity dimension
2439                    else {
2440                        dim[j]++;
2441                        if (dim[j] < pDimensionDefinitions[j].zones) break;
2442                        else {
2443                            // skip unused dimension regions
2444                            dim[j] = 0;
2445                            i += ((1 << pDimensionDefinitions[j].bits) -
2446                                  pDimensionDefinitions[j].zones) << shift;
2447                        }
2448                    }
2449                    shift += pDimensionDefinitions[j].bits;
2450                }
2451                if (j == Dimensions) break;
2452            }
2453        }
2454    
2455        /** @brief Einstein would have dreamed of it - create a new dimension.
2456         *
2457         * Creates a new dimension with the dimension definition given by
2458         * \a pDimDef. The appropriate amount of DimensionRegions will be created.
2459         * There is a hard limit of dimensions and total amount of "bits" all
2460         * dimensions can have. This limit is dependant to what gig file format
2461         * version this file refers to. The gig v2 (and lower) format has a
2462         * dimension limit and total amount of bits limit of 5, whereas the gig v3
2463         * format has a limit of 8.
2464         *
2465         * @param pDimDef - defintion of the new dimension
2466         * @throws gig::Exception if dimension of the same type exists already
2467         * @throws gig::Exception if amount of dimensions or total amount of
2468         *                        dimension bits limit is violated
2469         */
2470        void Region::AddDimension(dimension_def_t* pDimDef) {
2471            // check if max. amount of dimensions reached
2472            File* file = (File*) GetParent()->GetParent();
2473            const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;
2474            if (Dimensions >= iMaxDimensions)
2475                throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimensions already reached");
2476            // check if max. amount of dimension bits reached
2477            int iCurrentBits = 0;
2478            for (int i = 0; i < Dimensions; i++)
2479                iCurrentBits += pDimensionDefinitions[i].bits;
2480            if (iCurrentBits >= iMaxDimensions)
2481                throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimension bits already reached");
2482            const int iNewBits = iCurrentBits + pDimDef->bits;
2483            if (iNewBits > iMaxDimensions)
2484                throw gig::Exception("Could not add new dimension, new dimension would exceed max. amount of " + ToString(iMaxDimensions) + " dimension bits");
2485            // check if there's already a dimensions of the same type
2486            for (int i = 0; i < Dimensions; i++)
2487                if (pDimensionDefinitions[i].dimension == pDimDef->dimension)
2488                    throw gig::Exception("Could not add new dimension, there is already a dimension of the same type");
2489    
2490            // pos is where the new dimension should be placed, normally
2491            // last in list, except for the samplechannel dimension which
2492            // has to be first in list
2493            int pos = pDimDef->dimension == dimension_samplechannel ? 0 : Dimensions;
2494            int bitpos = 0;
2495            for (int i = 0 ; i < pos ; i++)
2496                bitpos += pDimensionDefinitions[i].bits;
2497    
2498            // make room for the new dimension
2499            for (int i = Dimensions ; i > pos ; i--) pDimensionDefinitions[i] = pDimensionDefinitions[i - 1];
2500            for (int i = 0 ; i < (1 << iCurrentBits) ; i++) {
2501                for (int j = Dimensions ; j > pos ; j--) {
2502                    pDimensionRegions[i]->DimensionUpperLimits[j] =
2503                        pDimensionRegions[i]->DimensionUpperLimits[j - 1];
2504                }
2505            }
2506    
2507            // assign definition of new dimension
2508            pDimensionDefinitions[pos] = *pDimDef;
2509    
2510            // auto correct certain dimension definition fields (where possible)
2511            pDimensionDefinitions[pos].split_type  =
2512                __resolveSplitType(pDimensionDefinitions[pos].dimension);
2513            pDimensionDefinitions[pos].zone_size =
2514                __resolveZoneSize(pDimensionDefinitions[pos]);
2515    
2516            // create new dimension region(s) for this new dimension, and make
2517            // sure that the dimension regions are placed correctly in both the
2518            // RIFF list and the pDimensionRegions array
2519            RIFF::Chunk* moveTo = NULL;
2520            RIFF::List* _3prg = pCkRegion->GetSubList(LIST_TYPE_3PRG);
2521            for (int i = (1 << iCurrentBits) - (1 << bitpos) ; i >= 0 ; i -= (1 << bitpos)) {
2522                for (int k = 0 ; k < (1 << bitpos) ; k++) {
2523                    pDimensionRegions[(i << pDimDef->bits) + k] = pDimensionRegions[i + k];
2524                }
2525                for (int j = 1 ; j < (1 << pDimDef->bits) ; j++) {
2526                    for (int k = 0 ; k < (1 << bitpos) ; k++) {
2527                        RIFF::List* pNewDimRgnListChunk = _3prg->AddSubList(LIST_TYPE_3EWL);
2528                        if (moveTo) _3prg->MoveSubChunk(pNewDimRgnListChunk, moveTo);
2529                        // create a new dimension region and copy all parameter values from
2530                        // an existing dimension region
2531                        pDimensionRegions[(i << pDimDef->bits) + (j << bitpos) + k] =
2532                            new DimensionRegion(pNewDimRgnListChunk, *pDimensionRegions[i + k]);
2533    
2534                        DimensionRegions++;
2535                    }
2536                }
2537                moveTo = pDimensionRegions[i]->pParentList;
2538            }
2539    
2540            // initialize the upper limits for this dimension
2541            int mask = (1 << bitpos) - 1;
2542            for (int z = 0 ; z < pDimDef->zones ; z++) {
2543                uint8_t upperLimit = uint8_t((z + 1) * 128.0 / pDimDef->zones - 1);
2544                for (int i = 0 ; i < 1 << iCurrentBits ; i++) {
2545                    pDimensionRegions[((i & ~mask) << pDimDef->bits) |
2546                                      (z << bitpos) |
2547                                      (i & mask)]->DimensionUpperLimits[pos] = upperLimit;
2548                }
2549            }
2550    
2551            Dimensions++;
2552    
2553            // if this is a layer dimension, update 'Layers' attribute
2554            if (pDimDef->dimension == dimension_layer) Layers = pDimDef->zones;
2555    
2556            UpdateVelocityTable();
2557        }
2558    
2559        /** @brief Delete an existing dimension.
2560         *
2561         * Deletes the dimension given by \a pDimDef and deletes all respective
2562         * dimension regions, that is all dimension regions where the dimension's
2563         * bit(s) part is greater than 0. In case of a 'sustain pedal' dimension
2564         * for example this would delete all dimension regions for the case(s)
2565         * where the sustain pedal is pressed down.
2566         *
2567         * @param pDimDef - dimension to delete
2568         * @throws gig::Exception if given dimension cannot be found
2569         */
2570        void Region::DeleteDimension(dimension_def_t* pDimDef) {
2571            // get dimension's index
2572            int iDimensionNr = -1;
2573            for (int i = 0; i < Dimensions; i++) {
2574                if (&pDimensionDefinitions[i] == pDimDef) {
2575                    iDimensionNr = i;
2576                    break;
2577                }
2578            }
2579            if (iDimensionNr < 0) throw gig::Exception("Invalid dimension_def_t pointer");
2580    
2581            // get amount of bits below the dimension to delete
2582            int iLowerBits = 0;
2583            for (int i = 0; i < iDimensionNr; i++)
2584                iLowerBits += pDimensionDefinitions[i].bits;
2585    
2586            // get amount ot bits above the dimension to delete
2587            int iUpperBits = 0;
2588            for (int i = iDimensionNr + 1; i < Dimensions; i++)
2589                iUpperBits += pDimensionDefinitions[i].bits;
2590    
2591            RIFF::List* _3prg = pCkRegion->GetSubList(LIST_TYPE_3PRG);
2592    
2593            // delete dimension regions which belong to the given dimension
2594            // (that is where the dimension's bit > 0)
2595            for (int iUpperBit = 0; iUpperBit < 1 << iUpperBits; iUpperBit++) {
2596                for (int iObsoleteBit = 1; iObsoleteBit < 1 << pDimensionDefinitions[iDimensionNr].bits; iObsoleteBit++) {
2597                    for (int iLowerBit = 0; iLowerBit < 1 << iLowerBits; iLowerBit++) {
2598                        int iToDelete = iUpperBit    << (pDimensionDefinitions[iDimensionNr].bits + iLowerBits) |
2599                                        iObsoleteBit << iLowerBits |
2600                                        iLowerBit;
2601    
2602                        _3prg->DeleteSubChunk(pDimensionRegions[iToDelete]->pParentList);
2603                        delete pDimensionRegions[iToDelete];
2604                        pDimensionRegions[iToDelete] = NULL;
2605                        DimensionRegions--;
2606                    }
2607                }
2608            }
2609    
2610            // defrag pDimensionRegions array
2611            // (that is remove the NULL spaces within the pDimensionRegions array)
2612            for (int iFrom = 2, iTo = 1; iFrom < 256 && iTo < 256 - 1; iTo++) {
2613                if (!pDimensionRegions[iTo]) {
2614                    if (iFrom <= iTo) iFrom = iTo + 1;
2615                    while (!pDimensionRegions[iFrom] && iFrom < 256) iFrom++;
2616                    if (iFrom < 256 && pDimensionRegions[iFrom]) {
2617                        pDimensionRegions[iTo]   = pDimensionRegions[iFrom];
2618                        pDimensionRegions[iFrom] = NULL;
2619                    }
2620                }
2621            }
2622    
2623            // remove the this dimension from the upper limits arrays
2624            for (int j = 0 ; j < 256 && pDimensionRegions[j] ; j++) {
2625                DimensionRegion* d = pDimensionRegions[j];
2626                for (int i = iDimensionNr + 1; i < Dimensions; i++) {
2627                    d->DimensionUpperLimits[i - 1] = d->DimensionUpperLimits[i];
2628                }
2629                d->DimensionUpperLimits[Dimensions - 1] = 127;
2630            }
2631    
2632            // 'remove' dimension definition
2633            for (int i = iDimensionNr + 1; i < Dimensions; i++) {
2634                pDimensionDefinitions[i - 1] = pDimensionDefinitions[i];
2635            }
2636            pDimensionDefinitions[Dimensions - 1].dimension = dimension_none;
2637            pDimensionDefinitions[Dimensions - 1].bits      = 0;
2638            pDimensionDefinitions[Dimensions - 1].zones     = 0;
2639    
2640            Dimensions--;
2641    
2642            // if this was a layer dimension, update 'Layers' attribute
2643            if (pDimDef->dimension == dimension_layer) Layers = 1;
2644        }
2645    
2646        Region::~Region() {
2647          for (int i = 0; i < 256; i++) {          for (int i = 0; i < 256; i++) {
2648              if (pDimensionRegions[i]) delete pDimensionRegions[i];              if (pDimensionRegions[i]) delete pDimensionRegions[i];
2649          }          }
# Line 1532  namespace { Line 2668  namespace {
2668       * @see             Dimensions       * @see             Dimensions
2669       */       */
2670      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {
2671          uint8_t bits[8] = { 0 };          uint8_t bits;
2672            int veldim = -1;
2673            int velbitpos;
2674            int bitpos = 0;
2675            int dimregidx = 0;
2676          for (uint i = 0; i < Dimensions; i++) {          for (uint i = 0; i < Dimensions; i++) {
2677              bits[i] = DimValues[i];              if (pDimensionDefinitions[i].dimension == dimension_velocity) {
2678              switch (pDimensionDefinitions[i].split_type) {                  // the velocity dimension must be handled after the other dimensions
2679                  case split_type_normal:                  veldim = i;
2680                      bits[i] /= pDimensionDefinitions[i].zone_size;                  velbitpos = bitpos;
2681                      break;              } else {
2682                  case split_type_customvelocity:                  switch (pDimensionDefinitions[i].split_type) {
2683                      bits[i] = VelocityTable[bits[i]];                      case split_type_normal:
2684                      break;                          if (pDimensionRegions[0]->DimensionUpperLimits[i]) {
2685                  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
2686                      const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;                              for (bits = 0 ; bits < pDimensionDefinitions[i].zones ; bits++) {
2687                      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;
2688                      break;                              }
2689              }                          } else {
2690                                // gig2: evenly sized zones
2691                                bits = uint8_t(DimValues[i] / pDimensionDefinitions[i].zone_size);
2692                            }
2693                            break;
2694                        case split_type_bit: // the value is already the sought dimension bit number
2695                            const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;
2696                            bits = DimValues[i] & limiter_mask; // just make sure the value doesn't use more bits than allowed
2697                            break;
2698                    }
2699                    dimregidx |= bits << bitpos;
2700                }
2701                bitpos += pDimensionDefinitions[i].bits;
2702            }
2703            DimensionRegion* dimreg = pDimensionRegions[dimregidx];
2704            if (veldim != -1) {
2705                // (dimreg is now the dimension region for the lowest velocity)
2706                if (dimreg->VelocityTable) // custom defined zone ranges
2707                    bits = dimreg->VelocityTable[DimValues[veldim]];
2708                else // normal split type
2709                    bits = uint8_t(DimValues[veldim] / pDimensionDefinitions[veldim].zone_size);
2710    
2711                dimregidx |= bits << velbitpos;
2712                dimreg = pDimensionRegions[dimregidx];
2713          }          }
2714          return GetDimensionRegionByBit(bits);          return dimreg;
2715      }      }
2716    
2717      /**      /**
# Line 1588  namespace { Line 2751  namespace {
2751      Sample* Region::GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress) {      Sample* Region::GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress) {
2752          if ((int32_t)WavePoolTableIndex == -1) return NULL;          if ((int32_t)WavePoolTableIndex == -1) return NULL;
2753          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
2754            if (!file->pWavePoolTable) return NULL;
2755          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
2756            unsigned long soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];
2757          Sample* sample = file->GetFirstSample(pProgress);          Sample* sample = file->GetFirstSample(pProgress);
2758          while (sample) {          while (sample) {
2759              if (sample->ulWavePoolOffset == soughtoffset) return static_cast<gig::Sample*>(pSample = sample);              if (sample->ulWavePoolOffset == soughtoffset &&
2760                    sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);
2761              sample = file->GetNextSample();              sample = file->GetNextSample();
2762          }          }
2763          return NULL;          return NULL;
# Line 1603  namespace { Line 2769  namespace {
2769  // *  // *
2770    
2771      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) {
2772            static const DLS::Info::FixedStringLength fixedStringLengths[] = {
2773                { CHUNK_ID_INAM, 64 },
2774                { CHUNK_ID_ISFT, 12 },
2775                { 0, 0 }
2776            };
2777            pInfo->FixedStringLengths = fixedStringLengths;
2778    
2779          // Initialization          // Initialization
2780          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;
2781          RegionIndex = -1;          EffectSend = 0;
2782            Attenuation = 0;
2783            FineTune = 0;
2784            PitchbendRange = 0;
2785            PianoReleaseMode = false;
2786            DimensionKeyRange.low = 0;
2787            DimensionKeyRange.high = 0;
2788    
2789          // Loading          // Loading
2790          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);
# Line 1621  namespace { Line 2800  namespace {
2800                  DimensionKeyRange.low  = dimkeystart >> 1;                  DimensionKeyRange.low  = dimkeystart >> 1;
2801                  DimensionKeyRange.high = _3ewg->ReadUint8();                  DimensionKeyRange.high = _3ewg->ReadUint8();
2802              }              }
             else throw gig::Exception("Mandatory <3ewg> chunk not found.");  
2803          }          }
         else throw gig::Exception("Mandatory <lart> list chunk not found.");  
2804    
2805            if (!pRegions) pRegions = new RegionList;
2806          RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);          RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);
2807          if (!lrgn) throw gig::Exception("Mandatory chunks in <ins > chunk not found.");          if (lrgn) {
2808          pRegions = new Region*[Regions];              RIFF::List* rgn = lrgn->GetFirstSubList();
2809          for (uint i = 0; i < Regions; i++) pRegions[i] = NULL;              while (rgn) {
2810          RIFF::List* rgn = lrgn->GetFirstSubList();                  if (rgn->GetListType() == LIST_TYPE_RGN) {
2811          unsigned int iRegion = 0;                      __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
2812          while (rgn) {                      pRegions->push_back(new Region(this, rgn));
2813              if (rgn->GetListType() == LIST_TYPE_RGN) {                  }
2814                  __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];  
2815              }              }
2816                // Creating Region Key Table for fast lookup
2817                UpdateRegionKeyTable();
2818          }          }
2819    
2820          __notify_progress(pProgress, 1.0f); // notify done          __notify_progress(pProgress, 1.0f); // notify done
2821      }      }
2822    
2823      Instrument::~Instrument() {      void Instrument::UpdateRegionKeyTable() {
2824          for (uint i = 0; i < Regions; i++) {          RegionList::iterator iter = pRegions->begin();
2825              if (pRegions) {          RegionList::iterator end  = pRegions->end();
2826                  if (pRegions[i]) delete (pRegions[i]);          for (; iter != end; ++iter) {
2827                gig::Region* pRegion = static_cast<gig::Region*>(*iter);
2828                for (int iKey = pRegion->KeyRange.low; iKey <= pRegion->KeyRange.high; iKey++) {
2829                    RegionKeyTable[iKey] = pRegion;
2830              }              }
2831          }          }
2832          if (pRegions) delete[] pRegions;      }
2833    
2834        Instrument::~Instrument() {
2835        }
2836    
2837        /**
2838         * Apply Instrument with all its Regions to the respective RIFF chunks.
2839         * You have to call File::Save() to make changes persistent.
2840         *
2841         * Usually there is absolutely no need to call this method explicitly.
2842         * It will be called automatically when File::Save() was called.
2843         *
2844         * @throws gig::Exception if samples cannot be dereferenced
2845         */
2846        void Instrument::UpdateChunks() {
2847            // first update base classes' chunks
2848            DLS::Instrument::UpdateChunks();
2849    
2850            // update Regions' chunks
2851            {
2852                RegionList::iterator iter = pRegions->begin();
2853                RegionList::iterator end  = pRegions->end();
2854                for (; iter != end; ++iter)
2855                    (*iter)->UpdateChunks();
2856            }
2857    
2858            // make sure 'lart' RIFF list chunk exists
2859            RIFF::List* lart = pCkInstrument->GetSubList(LIST_TYPE_LART);
2860            if (!lart)  lart = pCkInstrument->AddSubList(LIST_TYPE_LART);
2861            // make sure '3ewg' RIFF chunk exists
2862            RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);
2863            if (!_3ewg)  {
2864                File* pFile = (File*) GetParent();
2865    
2866                // 3ewg is bigger in gig3, as it includes the iMIDI rules
2867                int size = (pFile->pVersion && pFile->pVersion->major == 3) ? 16416 : 12;
2868                _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, size);
2869                memset(_3ewg->LoadChunkData(), 0, size);
2870            }
2871            // update '3ewg' RIFF chunk
2872            uint8_t* pData = (uint8_t*) _3ewg->LoadChunkData();
2873            store16(&pData[0], EffectSend);
2874            store32(&pData[2], Attenuation);
2875            store16(&pData[6], FineTune);
2876            store16(&pData[8], PitchbendRange);
2877            const uint8_t dimkeystart = (PianoReleaseMode ? 0x01 : 0x00) |
2878                                        DimensionKeyRange.low << 1;
2879            pData[10] = dimkeystart;
2880            pData[11] = DimensionKeyRange.high;
2881      }      }
2882    
2883      /**      /**
# Line 1667  namespace { Line 2888  namespace {
2888       *             there is no Region defined for the given \a Key       *             there is no Region defined for the given \a Key
2889       */       */
2890      Region* Instrument::GetRegion(unsigned int Key) {      Region* Instrument::GetRegion(unsigned int Key) {
2891          if (!pRegions || Key > 127) return NULL;          if (!pRegions || !pRegions->size() || Key > 127) return NULL;
2892          return RegionKeyTable[Key];          return RegionKeyTable[Key];
2893    
2894          /*for (int i = 0; i < Regions; i++) {          /*for (int i = 0; i < Regions; i++) {
2895              if (Key <= pRegions[i]->KeyRange.high &&              if (Key <= pRegions[i]->KeyRange.high &&
2896                  Key >= pRegions[i]->KeyRange.low) return pRegions[i];                  Key >= pRegions[i]->KeyRange.low) return pRegions[i];
# Line 1684  namespace { Line 2906  namespace {
2906       * @see      GetNextRegion()       * @see      GetNextRegion()
2907       */       */
2908      Region* Instrument::GetFirstRegion() {      Region* Instrument::GetFirstRegion() {
2909          if (!Regions) return NULL;          if (!pRegions) return NULL;
2910          RegionIndex = 1;          RegionsIterator = pRegions->begin();
2911          return pRegions[0];          return static_cast<gig::Region*>( (RegionsIterator != pRegions->end()) ? *RegionsIterator : NULL );
2912      }      }
2913    
2914      /**      /**
# Line 1698  namespace { Line 2920  namespace {
2920       * @see      GetFirstRegion()       * @see      GetFirstRegion()
2921       */       */
2922      Region* Instrument::GetNextRegion() {      Region* Instrument::GetNextRegion() {
2923          if (RegionIndex < 0 || uint32_t(RegionIndex) >= Regions) return NULL;          if (!pRegions) return NULL;
2924          return pRegions[RegionIndex++];          RegionsIterator++;
2925            return static_cast<gig::Region*>( (RegionsIterator != pRegions->end()) ? *RegionsIterator : NULL );
2926        }
2927    
2928        Region* Instrument::AddRegion() {
2929            // create new Region object (and its RIFF chunks)
2930            RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
2931            if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
2932            RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
2933            Region* pNewRegion = new Region(this, rgn);
2934            pRegions->push_back(pNewRegion);
2935            Regions = pRegions->size();
2936            // update Region key table for fast lookup
2937            UpdateRegionKeyTable();
2938            // done
2939            return pNewRegion;
2940        }
2941    
2942        void Instrument::DeleteRegion(Region* pRegion) {
2943            if (!pRegions) return;
2944            DLS::Instrument::DeleteRegion((DLS::Region*) pRegion);
2945            // update Region key table for fast lookup
2946            UpdateRegionKeyTable();
2947        }
2948    
2949    
2950    
2951    // *************** Group ***************
2952    // *
2953    
2954        /** @brief Constructor.
2955         *
2956         * @param file   - pointer to the gig::File object
2957         * @param ck3gnm - pointer to 3gnm chunk associated with this group or
2958         *                 NULL if this is a new Group
2959         */
2960        Group::Group(File* file, RIFF::Chunk* ck3gnm) {
2961            pFile      = file;
2962            pNameChunk = ck3gnm;
2963            ::LoadString(pNameChunk, Name);
2964        }
2965    
2966        Group::~Group() {
2967            // remove the chunk associated with this group (if any)
2968            if (pNameChunk) pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);
2969        }
2970    
2971        /** @brief Update chunks with current group settings.
2972         *
2973         * Apply current Group field values to the respective chunks. You have
2974         * to call File::Save() to make changes persistent.
2975         *
2976         * Usually there is absolutely no need to call this method explicitly.
2977         * It will be called automatically when File::Save() was called.
2978         */
2979        void Group::UpdateChunks() {
2980            // make sure <3gri> and <3gnl> list chunks exist
2981            RIFF::List* _3gri = pFile->pRIFF->GetSubList(LIST_TYPE_3GRI);
2982            if (!_3gri) {
2983                _3gri = pFile->pRIFF->AddSubList(LIST_TYPE_3GRI);
2984                pFile->pRIFF->MoveSubChunk(_3gri, pFile->pRIFF->GetSubChunk(CHUNK_ID_PTBL));
2985            }
2986            RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
2987            if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
2988    
2989            if (!pNameChunk && pFile->pVersion && pFile->pVersion->major == 3) {
2990                // v3 has a fixed list of 128 strings, find a free one
2991                for (RIFF::Chunk* ck = _3gnl->GetFirstSubChunk() ; ck ; ck = _3gnl->GetNextSubChunk()) {
2992                    if (strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) {
2993                        pNameChunk = ck;
2994                        break;
2995                    }
2996                }
2997            }
2998    
2999            // now store the name of this group as <3gnm> chunk as subchunk of the <3gnl> list chunk
3000            ::SaveString(CHUNK_ID_3GNM, pNameChunk, _3gnl, Name, String("Unnamed Group"), true, 64);
3001        }
3002    
3003        /**
3004         * Returns the first Sample of this Group. You have to call this method
3005         * once before you use GetNextSample().
3006         *
3007         * <b>Notice:</b> this method might block for a long time, in case the
3008         * samples of this .gig file were not scanned yet
3009         *
3010         * @returns  pointer address to first Sample or NULL if there is none
3011         *           applied to this Group
3012         * @see      GetNextSample()
3013         */
3014        Sample* Group::GetFirstSample() {
3015            // FIXME: lazy und unsafe implementation, should be an autonomous iterator
3016            for (Sample* pSample = pFile->GetFirstSample(); pSample; pSample = pFile->GetNextSample()) {
3017                if (pSample->GetGroup() == this) return pSample;
3018            }
3019            return NULL;
3020        }
3021    
3022        /**
3023         * Returns the next Sample of the Group. You have to call
3024         * GetFirstSample() once before you can use this method. By calling this
3025         * method multiple times it iterates through the Samples assigned to
3026         * this Group.
3027         *
3028         * @returns  pointer address to the next Sample of this Group or NULL if
3029         *           end reached
3030         * @see      GetFirstSample()
3031         */
3032        Sample* Group::GetNextSample() {
3033            // FIXME: lazy und unsafe implementation, should be an autonomous iterator
3034            for (Sample* pSample = pFile->GetNextSample(); pSample; pSample = pFile->GetNextSample()) {
3035                if (pSample->GetGroup() == this) return pSample;
3036            }
3037            return NULL;
3038        }
3039    
3040        /**
3041         * Move Sample given by \a pSample from another Group to this Group.
3042         */
3043        void Group::AddSample(Sample* pSample) {
3044            pSample->pGroup = this;
3045        }
3046    
3047        /**
3048         * Move all members of this group to another group (preferably the 1st
3049         * one except this). This method is called explicitly by
3050         * File::DeleteGroup() thus when a Group was deleted. This code was
3051         * intentionally not placed in the destructor!
3052         */
3053        void Group::MoveAll() {
3054            // get "that" other group first
3055            Group* pOtherGroup = NULL;
3056            for (pOtherGroup = pFile->GetFirstGroup(); pOtherGroup; pOtherGroup = pFile->GetNextGroup()) {
3057                if (pOtherGroup != this) break;
3058            }
3059            if (!pOtherGroup) throw Exception(
3060                "Could not move samples to another group, since there is no "
3061                "other Group. This is a bug, report it!"
3062            );
3063            // now move all samples of this group to the other group
3064            for (Sample* pSample = GetFirstSample(); pSample; pSample = GetNextSample()) {
3065                pOtherGroup->AddSample(pSample);
3066            }
3067      }      }
3068    
3069    
# Line 1707  namespace { Line 3071  namespace {
3071  // *************** File ***************  // *************** File ***************
3072  // *  // *
3073    
3074        // File version 2.0, 1998-06-28
3075        const DLS::version_t File::VERSION_2 = {
3076            0, 2, 19980628 & 0xffff, 19980628 >> 16
3077        };
3078    
3079        // File version 3.0, 2003-03-31
3080        const DLS::version_t File::VERSION_3 = {
3081            0, 3, 20030331 & 0xffff, 20030331 >> 16
3082        };
3083    
3084        const DLS::Info::FixedStringLength File::FixedStringLengths[] = {
3085            { CHUNK_ID_IARL, 256 },
3086            { CHUNK_ID_IART, 128 },
3087            { CHUNK_ID_ICMS, 128 },
3088            { CHUNK_ID_ICMT, 1024 },
3089            { CHUNK_ID_ICOP, 128 },
3090            { CHUNK_ID_ICRD, 128 },
3091            { CHUNK_ID_IENG, 128 },
3092            { CHUNK_ID_IGNR, 128 },
3093            { CHUNK_ID_IKEY, 128 },
3094            { CHUNK_ID_IMED, 128 },
3095            { CHUNK_ID_INAM, 128 },
3096            { CHUNK_ID_IPRD, 128 },
3097            { CHUNK_ID_ISBJ, 128 },
3098            { CHUNK_ID_ISFT, 128 },
3099            { CHUNK_ID_ISRC, 128 },
3100            { CHUNK_ID_ISRF, 128 },
3101            { CHUNK_ID_ITCH, 128 },
3102            { 0, 0 }
3103        };
3104    
3105        File::File() : DLS::File() {
3106            *pVersion = VERSION_3;
3107            pGroups = NULL;
3108            pInfo->FixedStringLengths = FixedStringLengths;
3109            pInfo->ArchivalLocation = String(256, ' ');
3110    
3111            // add some mandatory chunks to get the file chunks in right
3112            // order (INFO chunk will be moved to first position later)
3113            pRIFF->AddSubChunk(CHUNK_ID_VERS, 8);
3114            pRIFF->AddSubChunk(CHUNK_ID_COLH, 4);
3115            pRIFF->AddSubChunk(CHUNK_ID_DLID, 16);
3116    
3117            GenerateDLSID();
3118        }
3119    
3120      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {
3121          pSamples     = NULL;          pGroups = NULL;
3122          pInstruments = NULL;          pInfo->FixedStringLengths = FixedStringLengths;
3123      }      }
3124    
3125      File::~File() {      File::~File() {
3126          // free samples          if (pGroups) {
3127          if (pSamples) {              std::list<Group*>::iterator iter = pGroups->begin();
3128              SamplesIterator = pSamples->begin();              std::list<Group*>::iterator end  = pGroups->end();
3129              while (SamplesIterator != pSamples->end() ) {              while (iter != end) {
3130                  delete (*SamplesIterator);                  delete *iter;
3131                  SamplesIterator++;                  ++iter;
             }  
             pSamples->clear();  
             delete pSamples;  
   
         }  
         // free instruments  
         if (pInstruments) {  
             InstrumentsIterator = pInstruments->begin();  
             while (InstrumentsIterator != pInstruments->end() ) {  
                 delete (*InstrumentsIterator);  
                 InstrumentsIterator++;  
3132              }              }
3133              pInstruments->clear();              delete pGroups;
             delete pInstruments;  
3134          }          }
3135      }      }
3136    
# Line 1749  namespace { Line 3147  namespace {
3147          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
3148      }      }
3149    
3150      void File::LoadSamples(progress_t* pProgress) {      /** @brief Add a new sample.
3151          RIFF::List* wvpl = pRIFF->GetSubList(LIST_TYPE_WVPL);       *
3152          if (wvpl) {       * This will create a new Sample object for the gig file. You have to
3153              // just for progress calculation       * call Save() to make this persistent to the file.
3154              int iSampleIndex  = 0;       *
3155              int iTotalSamples = wvpl->CountSubLists(LIST_TYPE_WAVE);       * @returns pointer to new Sample object
3156         */
3157              unsigned long wvplFileOffset = wvpl->GetFilePos();      Sample* File::AddSample() {
3158              RIFF::List* wave = wvpl->GetFirstSubList();         if (!pSamples) LoadSamples();
3159              while (wave) {         __ensureMandatoryChunksExist();
3160                  if (wave->GetListType() == LIST_TYPE_WAVE) {         RIFF::List* wvpl = pRIFF->GetSubList(LIST_TYPE_WVPL);
3161                      // notify current progress         // create new Sample object and its respective 'wave' list chunk
3162                      const float subprogress = (float) iSampleIndex / (float) iTotalSamples;         RIFF::List* wave = wvpl->AddSubList(LIST_TYPE_WAVE);
3163                      __notify_progress(pProgress, subprogress);         Sample* pSample = new Sample(this, wave, 0 /*arbitrary value, we update offsets when we save*/);
3164    
3165           // add mandatory chunks to get the chunks in right order
3166           wave->AddSubChunk(CHUNK_ID_FMT, 16);
3167           wave->AddSubList(LIST_TYPE_INFO);
3168    
3169           pSamples->push_back(pSample);
3170           return pSample;
3171        }
3172    
3173        /** @brief Delete a sample.
3174         *
3175         * This will delete the given Sample object from the gig file. Any
3176         * references to this sample from Regions and DimensionRegions will be
3177         * removed. You have to call Save() to make this persistent to the file.
3178         *
3179         * @param pSample - sample to delete
3180         * @throws gig::Exception if given sample could not be found
3181         */
3182        void File::DeleteSample(Sample* pSample) {
3183            if (!pSamples || !pSamples->size()) throw gig::Exception("Could not delete sample as there are no samples");
3184            SampleList::iterator iter = find(pSamples->begin(), pSamples->end(), (DLS::Sample*) pSample);
3185            if (iter == pSamples->end()) throw gig::Exception("Could not delete sample, could not find given sample");
3186            if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation
3187            pSamples->erase(iter);
3188            delete pSample;
3189    
3190                      if (!pSamples) pSamples = new SampleList;          // remove all references to the sample
3191                      unsigned long waveFileOffset = wave->GetFilePos();          for (Instrument* instrument = GetFirstInstrument() ; instrument ;
3192                      pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset));               instrument = GetNextInstrument()) {
3193                for (Region* region = instrument->GetFirstRegion() ; region ;
3194                     region = instrument->GetNextRegion()) {
3195    
3196                      iSampleIndex++;                  if (region->GetSample() == pSample) region->SetSample(NULL);
3197    
3198                    for (int i = 0 ; i < region->DimensionRegions ; i++) {
3199                        gig::DimensionRegion *d = region->pDimensionRegions[i];
3200                        if (d->pSample == pSample) d->pSample = NULL;
3201                  }                  }
                 wave = wvpl->GetNextSubList();  
3202              }              }
             __notify_progress(pProgress, 1.0); // notify done  
3203          }          }
3204          else throw gig::Exception("Mandatory <wvpl> chunk not found.");      }
3205    
3206        void File::LoadSamples() {
3207            LoadSamples(NULL);
3208        }
3209    
3210        void File::LoadSamples(progress_t* pProgress) {
3211            // Groups must be loaded before samples, because samples will try
3212            // to resolve the group they belong to
3213            if (!pGroups) LoadGroups();
3214    
3215            if (!pSamples) pSamples = new SampleList;
3216    
3217            RIFF::File* file = pRIFF;
3218    
3219            // just for progress calculation
3220            int iSampleIndex  = 0;
3221            int iTotalSamples = WavePoolCount;
3222    
3223            // check if samples should be loaded from extension files
3224            int lastFileNo = 0;
3225            for (int i = 0 ; i < WavePoolCount ; i++) {
3226                if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];
3227            }
3228            String name(pRIFF->GetFileName());
3229            int nameLen = name.length();
3230            char suffix[6];
3231            if (nameLen > 4 && name.substr(nameLen - 4) == ".gig") nameLen -= 4;
3232    
3233            for (int fileNo = 0 ; ; ) {
3234                RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);
3235                if (wvpl) {
3236                    unsigned long wvplFileOffset = wvpl->GetFilePos();
3237                    RIFF::List* wave = wvpl->GetFirstSubList();
3238                    while (wave) {
3239                        if (wave->GetListType() == LIST_TYPE_WAVE) {
3240                            // notify current progress
3241                            const float subprogress = (float) iSampleIndex / (float) iTotalSamples;
3242                            __notify_progress(pProgress, subprogress);
3243    
3244                            unsigned long waveFileOffset = wave->GetFilePos();
3245                            pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));
3246    
3247                            iSampleIndex++;
3248                        }
3249                        wave = wvpl->GetNextSubList();
3250                    }
3251    
3252                    if (fileNo == lastFileNo) break;
3253    
3254                    // open extension file (*.gx01, *.gx02, ...)
3255                    fileNo++;
3256                    sprintf(suffix, ".gx%02d", fileNo);
3257                    name.replace(nameLen, 5, suffix);
3258                    file = new RIFF::File(name);
3259                    ExtensionFiles.push_back(file);
3260                } else break;
3261            }
3262    
3263            __notify_progress(pProgress, 1.0); // notify done
3264      }      }
3265    
3266      Instrument* File::GetFirstInstrument() {      Instrument* File::GetFirstInstrument() {
3267          if (!pInstruments) LoadInstruments();          if (!pInstruments) LoadInstruments();
3268          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
3269          InstrumentsIterator = pInstruments->begin();          InstrumentsIterator = pInstruments->begin();
3270          return (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL;          return static_cast<gig::Instrument*>( (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL );
3271      }      }
3272    
3273      Instrument* File::GetNextInstrument() {      Instrument* File::GetNextInstrument() {
3274          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
3275          InstrumentsIterator++;          InstrumentsIterator++;
3276          return (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL;          return static_cast<gig::Instrument*>( (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL );
3277      }      }
3278    
3279      /**      /**
# Line 1820  namespace { Line 3306  namespace {
3306          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
3307          InstrumentsIterator = pInstruments->begin();          InstrumentsIterator = pInstruments->begin();
3308          for (uint i = 0; InstrumentsIterator != pInstruments->end(); i++) {          for (uint i = 0; InstrumentsIterator != pInstruments->end(); i++) {
3309              if (i == index) return *InstrumentsIterator;              if (i == index) return static_cast<gig::Instrument*>( *InstrumentsIterator );
3310              InstrumentsIterator++;              InstrumentsIterator++;
3311          }          }
3312          return NULL;          return NULL;
3313      }      }
3314    
3315        /** @brief Add a new instrument definition.
3316         *
3317         * This will create a new Instrument object for the gig file. You have
3318         * to call Save() to make this persistent to the file.
3319         *
3320         * @returns pointer to new Instrument object
3321         */
3322        Instrument* File::AddInstrument() {
3323           if (!pInstruments) LoadInstruments();
3324           __ensureMandatoryChunksExist();
3325           RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
3326           RIFF::List* lstInstr = lstInstruments->AddSubList(LIST_TYPE_INS);
3327    
3328           // add mandatory chunks to get the chunks in right order
3329           lstInstr->AddSubList(LIST_TYPE_INFO);
3330           lstInstr->AddSubChunk(CHUNK_ID_DLID, 16);
3331    
3332           Instrument* pInstrument = new Instrument(this, lstInstr);
3333           pInstrument->GenerateDLSID();
3334    
3335           lstInstr->AddSubChunk(CHUNK_ID_INSH, 12);
3336    
3337           // this string is needed for the gig to be loadable in GSt:
3338           pInstrument->pInfo->Software = "Endless Wave";
3339    
3340           pInstruments->push_back(pInstrument);
3341           return pInstrument;
3342        }
3343    
3344        /** @brief Delete an instrument.
3345         *
3346         * This will delete the given Instrument object from the gig file. You
3347         * have to call Save() to make this persistent to the file.
3348         *
3349         * @param pInstrument - instrument to delete
3350         * @throws gig::Exception if given instrument could not be found
3351         */
3352        void File::DeleteInstrument(Instrument* pInstrument) {
3353            if (!pInstruments) throw gig::Exception("Could not delete instrument as there are no instruments");
3354            InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), (DLS::Instrument*) pInstrument);
3355            if (iter == pInstruments->end()) throw gig::Exception("Could not delete instrument, could not find given instrument");
3356            pInstruments->erase(iter);
3357            delete pInstrument;
3358        }
3359    
3360        void File::LoadInstruments() {
3361            LoadInstruments(NULL);
3362        }
3363    
3364      void File::LoadInstruments(progress_t* pProgress) {      void File::LoadInstruments(progress_t* pProgress) {
3365            if (!pInstruments) pInstruments = new InstrumentList;
3366          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
3367          if (lstInstruments) {          if (lstInstruments) {
3368              int iInstrumentIndex = 0;              int iInstrumentIndex = 0;
# Line 1841  namespace { Line 3377  namespace {
3377                      progress_t subprogress;                      progress_t subprogress;
3378                      __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);                      __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);
3379    
                     if (!pInstruments) pInstruments = new InstrumentList;  
3380                      pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));                      pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));
3381    
3382                      iInstrumentIndex++;                      iInstrumentIndex++;
# Line 1850  namespace { Line 3385  namespace {
3385              }              }
3386              __notify_progress(pProgress, 1.0); // notify done              __notify_progress(pProgress, 1.0); // notify done
3387          }          }
3388          else throw gig::Exception("Mandatory <lins> list chunk not found.");      }
3389    
3390        /// Updates the 3crc chunk with the checksum of a sample. The
3391        /// update is done directly to disk, as this method is called
3392        /// after File::Save()
3393        void File::SetSampleChecksum(Sample* pSample, uint32_t crc) {
3394            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
3395            if (!_3crc) return;
3396    
3397            // get the index of the sample
3398            int iWaveIndex = -1;
3399            File::SampleList::iterator iter = pSamples->begin();
3400            File::SampleList::iterator end  = pSamples->end();
3401            for (int index = 0; iter != end; ++iter, ++index) {
3402                if (*iter == pSample) {
3403                    iWaveIndex = index;
3404                    break;
3405                }
3406            }
3407            if (iWaveIndex < 0) throw gig::Exception("Could not update crc, could not find sample");
3408    
3409            // write the CRC-32 checksum to disk
3410            _3crc->SetPos(iWaveIndex * 8);
3411            uint32_t tmp = 1;
3412            _3crc->WriteUint32(&tmp); // unknown, always 1?
3413            _3crc->WriteUint32(&crc);
3414        }
3415    
3416        Group* File::GetFirstGroup() {
3417            if (!pGroups) LoadGroups();
3418            // there must always be at least one group
3419            GroupsIterator = pGroups->begin();
3420            return *GroupsIterator;
3421        }
3422    
3423        Group* File::GetNextGroup() {
3424            if (!pGroups) return NULL;
3425            ++GroupsIterator;
3426            return (GroupsIterator == pGroups->end()) ? NULL : *GroupsIterator;
3427        }
3428    
3429        /**
3430         * Returns the group with the given index.
3431         *
3432         * @param index - number of the sought group (0..n)
3433         * @returns sought group or NULL if there's no such group
3434         */
3435        Group* File::GetGroup(uint index) {
3436            if (!pGroups) LoadGroups();
3437            GroupsIterator = pGroups->begin();
3438            for (uint i = 0; GroupsIterator != pGroups->end(); i++) {
3439                if (i == index) return *GroupsIterator;
3440                ++GroupsIterator;
3441            }
3442            return NULL;
3443        }
3444    
3445        Group* File::AddGroup() {
3446            if (!pGroups) LoadGroups();
3447            // there must always be at least one group
3448            __ensureMandatoryChunksExist();
3449            Group* pGroup = new Group(this, NULL);
3450            pGroups->push_back(pGroup);
3451            return pGroup;
3452        }
3453    
3454        /** @brief Delete a group and its samples.
3455         *
3456         * This will delete the given Group object and all the samples that
3457         * belong to this group from the gig file. You have to call Save() to
3458         * make this persistent to the file.
3459         *
3460         * @param pGroup - group to delete
3461         * @throws gig::Exception if given group could not be found
3462         */
3463        void File::DeleteGroup(Group* pGroup) {
3464            if (!pGroups) LoadGroups();
3465            std::list<Group*>::iterator iter = find(pGroups->begin(), pGroups->end(), pGroup);
3466            if (iter == pGroups->end()) throw gig::Exception("Could not delete group, could not find given group");
3467            if (pGroups->size() == 1) throw gig::Exception("Cannot delete group, there must be at least one default group!");
3468            // delete all members of this group
3469            for (Sample* pSample = pGroup->GetFirstSample(); pSample; pSample = pGroup->GetNextSample()) {
3470                DeleteSample(pSample);
3471            }
3472            // now delete this group object
3473            pGroups->erase(iter);
3474            delete pGroup;
3475        }
3476    
3477        /** @brief Delete a group.
3478         *
3479         * This will delete the given Group object from the gig file. All the
3480         * samples that belong to this group will not be deleted, but instead
3481         * be moved to another group. You have to call Save() to make this
3482         * persistent to the file.
3483         *
3484         * @param pGroup - group to delete
3485         * @throws gig::Exception if given group could not be found
3486         */
3487        void File::DeleteGroupOnly(Group* pGroup) {
3488            if (!pGroups) LoadGroups();
3489            std::list<Group*>::iterator iter = find(pGroups->begin(), pGroups->end(), pGroup);
3490            if (iter == pGroups->end()) throw gig::Exception("Could not delete group, could not find given group");
3491            if (pGroups->size() == 1) throw gig::Exception("Cannot delete group, there must be at least one default group!");
3492            // move all members of this group to another group
3493            pGroup->MoveAll();
3494            pGroups->erase(iter);
3495            delete pGroup;
3496        }
3497    
3498        void File::LoadGroups() {
3499            if (!pGroups) pGroups = new std::list<Group*>;
3500            // try to read defined groups from file
3501            RIFF::List* lst3gri = pRIFF->GetSubList(LIST_TYPE_3GRI);
3502            if (lst3gri) {
3503                RIFF::List* lst3gnl = lst3gri->GetSubList(LIST_TYPE_3GNL);
3504                if (lst3gnl) {
3505                    RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();
3506                    while (ck) {
3507                        if (ck->GetChunkID() == CHUNK_ID_3GNM) {
3508                            if (pVersion && pVersion->major == 3 &&
3509                                strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) break;
3510    
3511                            pGroups->push_back(new Group(this, ck));
3512                        }
3513                        ck = lst3gnl->GetNextSubChunk();
3514                    }
3515                }
3516            }
3517            // if there were no group(s), create at least the mandatory default group
3518            if (!pGroups->size()) {
3519                Group* pGroup = new Group(this, NULL);
3520                pGroup->Name = "Default Group";
3521                pGroups->push_back(pGroup);
3522            }
3523        }
3524    
3525        /**
3526         * Apply all the gig file's current instruments, samples, groups and settings
3527         * to the respective RIFF chunks. You have to call Save() to make changes
3528         * persistent.
3529         *
3530         * Usually there is absolutely no need to call this method explicitly.
3531         * It will be called automatically when File::Save() was called.
3532         *
3533         * @throws Exception - on errors
3534         */
3535        void File::UpdateChunks() {
3536            bool newFile = pRIFF->GetSubList(LIST_TYPE_INFO) == NULL;
3537    
3538            b64BitWavePoolOffsets = pVersion && pVersion->major == 3;
3539    
3540            // first update base class's chunks
3541            DLS::File::UpdateChunks();
3542    
3543            if (newFile) {
3544                // INFO was added by Resource::UpdateChunks - make sure it
3545                // is placed first in file
3546                RIFF::Chunk* info = pRIFF->GetSubList(LIST_TYPE_INFO);
3547                RIFF::Chunk* first = pRIFF->GetFirstSubChunk();
3548                if (first != info) {
3549                    pRIFF->MoveSubChunk(info, first);
3550                }
3551            }
3552    
3553            // update group's chunks
3554            if (pGroups) {
3555                std::list<Group*>::iterator iter = pGroups->begin();
3556                std::list<Group*>::iterator end  = pGroups->end();
3557                for (; iter != end; ++iter) {
3558                    (*iter)->UpdateChunks();
3559                }
3560    
3561                // v3: make sure the file has 128 3gnm chunks
3562                if (pVersion && pVersion->major == 3) {
3563                    RIFF::List* _3gnl = pRIFF->GetSubList(LIST_TYPE_3GRI)->GetSubList(LIST_TYPE_3GNL);
3564                    RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();
3565                    for (int i = 0 ; i < 128 ; i++) {
3566                        if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);
3567                        if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();
3568                    }
3569                }
3570            }
3571    
3572            // update einf chunk
3573    
3574            // The einf chunk contains statistics about the gig file, such
3575            // as the number of regions and samples used by each
3576            // instrument. It is divided in equally sized parts, where the
3577            // first part contains information about the whole gig file,
3578            // and the rest of the parts map to each instrument in the
3579            // file.
3580            //
3581            // At the end of each part there is a bit map of each sample
3582            // in the file, where a set bit means that the sample is used
3583            // by the file/instrument.
3584            //
3585            // Note that there are several fields with unknown use. These
3586            // are set to zero.
3587    
3588            int sublen = pSamples->size() / 8 + 49;
3589            int einfSize = (Instruments + 1) * sublen;
3590    
3591            RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
3592            if (einf) {
3593                if (einf->GetSize() != einfSize) {
3594                    einf->Resize(einfSize);
3595                    memset(einf->LoadChunkData(), 0, einfSize);
3596                }
3597            } else if (newFile) {
3598                einf = pRIFF->AddSubChunk(CHUNK_ID_EINF, einfSize);
3599            }
3600            if (einf) {
3601                uint8_t* pData = (uint8_t*) einf->LoadChunkData();
3602    
3603                std::map<gig::Sample*,int> sampleMap;
3604                int sampleIdx = 0;
3605                for (Sample* pSample = GetFirstSample(); pSample; pSample = GetNextSample()) {
3606                    sampleMap[pSample] = sampleIdx++;
3607                }
3608    
3609                int totnbusedsamples = 0;
3610                int totnbusedchannels = 0;
3611                int totnbregions = 0;
3612                int totnbdimregions = 0;
3613                int totnbloops = 0;
3614                int instrumentIdx = 0;
3615    
3616                memset(&pData[48], 0, sublen - 48);
3617    
3618                for (Instrument* instrument = GetFirstInstrument() ; instrument ;
3619                     instrument = GetNextInstrument()) {
3620                    int nbusedsamples = 0;
3621                    int nbusedchannels = 0;
3622                    int nbdimregions = 0;
3623                    int nbloops = 0;
3624    
3625                    memset(&pData[(instrumentIdx + 1) * sublen + 48], 0, sublen - 48);
3626    
3627                    for (Region* region = instrument->GetFirstRegion() ; region ;
3628                         region = instrument->GetNextRegion()) {
3629                        for (int i = 0 ; i < region->DimensionRegions ; i++) {
3630                            gig::DimensionRegion *d = region->pDimensionRegions[i];
3631                            if (d->pSample) {
3632                                int sampleIdx = sampleMap[d->pSample];
3633                                int byte = 48 + sampleIdx / 8;
3634                                int bit = 1 << (sampleIdx & 7);
3635                                if ((pData[(instrumentIdx + 1) * sublen + byte] & bit) == 0) {
3636                                    pData[(instrumentIdx + 1) * sublen + byte] |= bit;
3637                                    nbusedsamples++;
3638                                    nbusedchannels += d->pSample->Channels;
3639    
3640                                    if ((pData[byte] & bit) == 0) {
3641                                        pData[byte] |= bit;
3642                                        totnbusedsamples++;
3643                                        totnbusedchannels += d->pSample->Channels;
3644                                    }
3645                                }
3646                            }
3647                            if (d->SampleLoops) nbloops++;
3648                        }
3649                        nbdimregions += region->DimensionRegions;
3650                    }
3651                    // first 4 bytes unknown - sometimes 0, sometimes length of einf part
3652                    // store32(&pData[(instrumentIdx + 1) * sublen], sublen);
3653                    store32(&pData[(instrumentIdx + 1) * sublen + 4], nbusedchannels);
3654                    store32(&pData[(instrumentIdx + 1) * sublen + 8], nbusedsamples);
3655                    store32(&pData[(instrumentIdx + 1) * sublen + 12], 1);
3656                    store32(&pData[(instrumentIdx + 1) * sublen + 16], instrument->Regions);
3657                    store32(&pData[(instrumentIdx + 1) * sublen + 20], nbdimregions);
3658                    store32(&pData[(instrumentIdx + 1) * sublen + 24], nbloops);
3659                    // next 8 bytes unknown
3660                    store32(&pData[(instrumentIdx + 1) * sublen + 36], instrumentIdx);
3661                    store32(&pData[(instrumentIdx + 1) * sublen + 40], pSamples->size());
3662                    // next 4 bytes unknown
3663    
3664                    totnbregions += instrument->Regions;
3665                    totnbdimregions += nbdimregions;
3666                    totnbloops += nbloops;
3667                    instrumentIdx++;
3668                }
3669                // first 4 bytes unknown - sometimes 0, sometimes length of einf part
3670                // store32(&pData[0], sublen);
3671                store32(&pData[4], totnbusedchannels);
3672                store32(&pData[8], totnbusedsamples);
3673                store32(&pData[12], Instruments);
3674                store32(&pData[16], totnbregions);
3675                store32(&pData[20], totnbdimregions);
3676                store32(&pData[24], totnbloops);
3677                // next 8 bytes unknown
3678                // next 4 bytes unknown, not always 0
3679                store32(&pData[40], pSamples->size());
3680                // next 4 bytes unknown
3681            }
3682    
3683            // update 3crc chunk
3684    
3685            // The 3crc chunk contains CRC-32 checksums for the
3686            // samples. The actual checksum values will be filled in
3687            // later, by Sample::Write.
3688    
3689            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
3690            if (_3crc) {
3691                _3crc->Resize(pSamples->size() * 8);
3692            } else if (newFile) {
3693                _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
3694                _3crc->LoadChunkData();
3695    
3696                // the order of einf and 3crc is not the same in v2 and v3
3697                if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);
3698            }
3699      }      }
3700    
3701    
# Line 1865  namespace { Line 3710  namespace {
3710          std::cout << "gig::Exception: " << Message << std::endl;          std::cout << "gig::Exception: " << Message << std::endl;
3711      }      }
3712    
3713    
3714    // *************** functions ***************
3715    // *
3716    
3717        /**
3718         * Returns the name of this C++ library. This is usually "libgig" of
3719         * course. This call is equivalent to RIFF::libraryName() and
3720         * DLS::libraryName().
3721         */
3722        String libraryName() {
3723            return PACKAGE;
3724        }
3725    
3726        /**
3727         * Returns version of this C++ library. This call is equivalent to
3728         * RIFF::libraryVersion() and DLS::libraryVersion().
3729         */
3730        String libraryVersion() {
3731            return VERSION;
3732        }
3733    
3734  } // namespace gig  } // namespace gig

Legend:
Removed from v.516  
changed lines
  Added in v.1316

  ViewVC Help
Powered by ViewVC