/[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 518 by schoenebeck, Sun May 8 16:19:34 2005 UTC revision 1209 by persson, Sun May 27 13:54:24 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 = 64;
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         * @param pBuffer     - source buffer
1156         * @param SampleCount - number of sample points to write
1157         * @throws DLS::Exception if current sample size is too small
1158         * @throws gig::Exception if sample is compressed
1159         * @see DLS::LoadSampleData()
1160         */
1161        unsigned long Sample::Write(void* pBuffer, unsigned long SampleCount) {
1162            if (Compressed) throw gig::Exception("There is no support for writing compressed gig samples (yet)");
1163    
1164            // if this is the first write in this sample, reset the
1165            // checksum calculator
1166            if (pCkData->GetPos() == 0) {
1167                crc.reset();
1168            }
1169            unsigned long res = DLS::Sample::Write(pBuffer, SampleCount);
1170            crc.update((unsigned char *)pBuffer, SampleCount * FrameSize);
1171    
1172            // if this is the last write, update the checksum chunk in the
1173            // file
1174            if (pCkData->GetPos() == pCkData->GetSize()) {
1175                File* pFile = static_cast<File*>(GetParent());
1176                pFile->SetSampleChecksum(this, crc.getValue());
1177            }
1178            return res;
1179        }
1180    
1181      /**      /**
1182       * Allocates a decompression buffer for streaming (compressed) samples       * Allocates a decompression buffer for streaming (compressed) samples
1183       * 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 1220  namespace {
1220          }          }
1221      }      }
1222    
1223        /**
1224         * Returns pointer to the Group this Sample belongs to. In the .gig
1225         * format a sample always belongs to one group. If it wasn't explicitly
1226         * assigned to a certain group, it will be automatically assigned to a
1227         * default group.
1228         *
1229         * @returns Sample's Group (never NULL)
1230         */
1231        Group* Sample::GetGroup() const {
1232            return pGroup;
1233        }
1234    
1235      Sample::~Sample() {      Sample::~Sample() {
1236          Instances--;          Instances--;
1237          if (!Instances && InternalDecompressionBuffer.Size) {          if (!Instances && InternalDecompressionBuffer.Size) {
# Line 1007  namespace { Line 1254  namespace {
1254      DimensionRegion::DimensionRegion(RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {      DimensionRegion::DimensionRegion(RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {
1255          Instances++;          Instances++;
1256    
1257            pSample = NULL;
1258    
1259          memcpy(&Crossfade, &SamplerOptions, 4);          memcpy(&Crossfade, &SamplerOptions, 4);
1260          if (!pVelocityTables) pVelocityTables = new VelocityTableMap;          if (!pVelocityTables) pVelocityTables = new VelocityTableMap;
1261    
1262          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);
1263          _3ewa->ReadInt32(); // unknown, always 0x0000008C ?          if (_3ewa) { // if '3ewa' chunk exists
1264          LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              _3ewa->ReadInt32(); // unknown, always == chunk size ?
1265          EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1266          _3ewa->ReadInt16(); // unknown              EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1267          LFO1InternalDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1268          _3ewa->ReadInt16(); // unknown              LFO1InternalDepth = _3ewa->ReadUint16();
1269          LFO3InternalDepth = _3ewa->ReadInt16();              _3ewa->ReadInt16(); // unknown
1270          _3ewa->ReadInt16(); // unknown              LFO3InternalDepth = _3ewa->ReadInt16();
1271          LFO1ControlDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1272          _3ewa->ReadInt16(); // unknown              LFO1ControlDepth = _3ewa->ReadUint16();
1273          LFO3ControlDepth = _3ewa->ReadInt16();              _3ewa->ReadInt16(); // unknown
1274          EG1Attack           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO3ControlDepth = _3ewa->ReadInt16();
1275          EG1Decay1           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG1Attack           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1276          _3ewa->ReadInt16(); // unknown              EG1Decay1           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1277          EG1Sustain          = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1278          EG1Release          = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG1Sustain          = _3ewa->ReadUint16();
1279          EG1Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));              EG1Release          = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1280          uint8_t eg1ctrloptions        = _3ewa->ReadUint8();              EG1Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1281          EG1ControllerInvert           = eg1ctrloptions & 0x01;              uint8_t eg1ctrloptions        = _3ewa->ReadUint8();
1282          EG1ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg1ctrloptions);              EG1ControllerInvert           = eg1ctrloptions & 0x01;
1283          EG1ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg1ctrloptions);              EG1ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg1ctrloptions);
1284          EG1ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg1ctrloptions);              EG1ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg1ctrloptions);
1285          EG2Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));              EG1ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg1ctrloptions);
1286          uint8_t eg2ctrloptions        = _3ewa->ReadUint8();              EG2Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1287          EG2ControllerInvert           = eg2ctrloptions & 0x01;              uint8_t eg2ctrloptions        = _3ewa->ReadUint8();
1288          EG2ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg2ctrloptions);              EG2ControllerInvert           = eg2ctrloptions & 0x01;
1289          EG2ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg2ctrloptions);              EG2ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg2ctrloptions);
1290          EG2ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg2ctrloptions);              EG2ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg2ctrloptions);
1291          LFO1Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG2ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg2ctrloptions);
1292          EG2Attack        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO1Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1293          EG2Decay1        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG2Attack        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1294          _3ewa->ReadInt16(); // unknown              EG2Decay1        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1295          EG2Sustain       = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1296          EG2Release       = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG2Sustain       = _3ewa->ReadUint16();
1297          _3ewa->ReadInt16(); // unknown              EG2Release       = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1298          LFO2ControlDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1299          LFO2Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO2ControlDepth = _3ewa->ReadUint16();
1300          _3ewa->ReadInt16(); // unknown              LFO2Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1301          LFO2InternalDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1302          int32_t eg1decay2 = _3ewa->ReadInt32();              LFO2InternalDepth = _3ewa->ReadUint16();
1303          EG1Decay2          = (double) GIG_EXP_DECODE(eg1decay2);              int32_t eg1decay2 = _3ewa->ReadInt32();
1304          EG1InfiniteSustain = (eg1decay2 == 0x7fffffff);              EG1Decay2          = (double) GIG_EXP_DECODE(eg1decay2);
1305          _3ewa->ReadInt16(); // unknown              EG1InfiniteSustain = (eg1decay2 == 0x7fffffff);
1306          EG1PreAttack      = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1307          int32_t eg2decay2 = _3ewa->ReadInt32();              EG1PreAttack      = _3ewa->ReadUint16();
1308          EG2Decay2         = (double) GIG_EXP_DECODE(eg2decay2);              int32_t eg2decay2 = _3ewa->ReadInt32();
1309          EG2InfiniteSustain = (eg2decay2 == 0x7fffffff);              EG2Decay2         = (double) GIG_EXP_DECODE(eg2decay2);
1310          _3ewa->ReadInt16(); // unknown              EG2InfiniteSustain = (eg2decay2 == 0x7fffffff);
1311          EG2PreAttack      = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1312          uint8_t velocityresponse = _3ewa->ReadUint8();              EG2PreAttack      = _3ewa->ReadUint16();
1313          if (velocityresponse < 5) {              uint8_t velocityresponse = _3ewa->ReadUint8();
1314              VelocityResponseCurve = curve_type_nonlinear;              if (velocityresponse < 5) {
1315              VelocityResponseDepth = velocityresponse;                  VelocityResponseCurve = curve_type_nonlinear;
1316          }                  VelocityResponseDepth = velocityresponse;
1317          else if (velocityresponse < 10) {              } else if (velocityresponse < 10) {
1318              VelocityResponseCurve = curve_type_linear;                  VelocityResponseCurve = curve_type_linear;
1319              VelocityResponseDepth = velocityresponse - 5;                  VelocityResponseDepth = velocityresponse - 5;
1320          }              } else if (velocityresponse < 15) {
1321          else if (velocityresponse < 15) {                  VelocityResponseCurve = curve_type_special;
1322              VelocityResponseCurve = curve_type_special;                  VelocityResponseDepth = velocityresponse - 10;
1323              VelocityResponseDepth = velocityresponse - 10;              } else {
1324                    VelocityResponseCurve = curve_type_unknown;
1325                    VelocityResponseDepth = 0;
1326                }
1327                uint8_t releasevelocityresponse = _3ewa->ReadUint8();
1328                if (releasevelocityresponse < 5) {
1329                    ReleaseVelocityResponseCurve = curve_type_nonlinear;
1330                    ReleaseVelocityResponseDepth = releasevelocityresponse;
1331                } else if (releasevelocityresponse < 10) {
1332                    ReleaseVelocityResponseCurve = curve_type_linear;
1333                    ReleaseVelocityResponseDepth = releasevelocityresponse - 5;
1334                } else if (releasevelocityresponse < 15) {
1335                    ReleaseVelocityResponseCurve = curve_type_special;
1336                    ReleaseVelocityResponseDepth = releasevelocityresponse - 10;
1337                } else {
1338                    ReleaseVelocityResponseCurve = curve_type_unknown;
1339                    ReleaseVelocityResponseDepth = 0;
1340                }
1341                VelocityResponseCurveScaling = _3ewa->ReadUint8();
1342                AttenuationControllerThreshold = _3ewa->ReadInt8();
1343                _3ewa->ReadInt32(); // unknown
1344                SampleStartOffset = (uint16_t) _3ewa->ReadInt16();
1345                _3ewa->ReadInt16(); // unknown
1346                uint8_t pitchTrackDimensionBypass = _3ewa->ReadInt8();
1347                PitchTrack = GIG_PITCH_TRACK_EXTRACT(pitchTrackDimensionBypass);
1348                if      (pitchTrackDimensionBypass & 0x10) DimensionBypass = dim_bypass_ctrl_94;
1349                else if (pitchTrackDimensionBypass & 0x20) DimensionBypass = dim_bypass_ctrl_95;
1350                else                                       DimensionBypass = dim_bypass_ctrl_none;
1351                uint8_t pan = _3ewa->ReadUint8();
1352                Pan         = (pan < 64) ? pan : -((int)pan - 63); // signed 7 bit -> signed 8 bit
1353                SelfMask = _3ewa->ReadInt8() & 0x01;
1354                _3ewa->ReadInt8(); // unknown
1355                uint8_t lfo3ctrl = _3ewa->ReadUint8();
1356                LFO3Controller           = static_cast<lfo3_ctrl_t>(lfo3ctrl & 0x07); // lower 3 bits
1357                LFO3Sync                 = lfo3ctrl & 0x20; // bit 5
1358                InvertAttenuationController = lfo3ctrl & 0x80; // bit 7
1359                AttenuationController  = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1360                uint8_t lfo2ctrl       = _3ewa->ReadUint8();
1361                LFO2Controller         = static_cast<lfo2_ctrl_t>(lfo2ctrl & 0x07); // lower 3 bits
1362                LFO2FlipPhase          = lfo2ctrl & 0x80; // bit 7
1363                LFO2Sync               = lfo2ctrl & 0x20; // bit 5
1364                bool extResonanceCtrl  = lfo2ctrl & 0x40; // bit 6
1365                uint8_t lfo1ctrl       = _3ewa->ReadUint8();
1366                LFO1Controller         = static_cast<lfo1_ctrl_t>(lfo1ctrl & 0x07); // lower 3 bits
1367                LFO1FlipPhase          = lfo1ctrl & 0x80; // bit 7
1368                LFO1Sync               = lfo1ctrl & 0x40; // bit 6
1369                VCFResonanceController = (extResonanceCtrl) ? static_cast<vcf_res_ctrl_t>(GIG_VCF_RESONANCE_CTRL_EXTRACT(lfo1ctrl))
1370                                                            : vcf_res_ctrl_none;
1371                uint16_t eg3depth = _3ewa->ReadUint16();
1372                EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */
1373                                            : (-1) * (int16_t) ((eg3depth ^ 0xffff) + 1); /* binary complementary for negatives */
1374                _3ewa->ReadInt16(); // unknown
1375                ChannelOffset = _3ewa->ReadUint8() / 4;
1376                uint8_t regoptions = _3ewa->ReadUint8();
1377                MSDecode           = regoptions & 0x01; // bit 0
1378                SustainDefeat      = regoptions & 0x02; // bit 1
1379                _3ewa->ReadInt16(); // unknown
1380                VelocityUpperLimit = _3ewa->ReadInt8();
1381                _3ewa->ReadInt8(); // unknown
1382                _3ewa->ReadInt16(); // unknown
1383                ReleaseTriggerDecay = _3ewa->ReadUint8(); // release trigger decay
1384                _3ewa->ReadInt8(); // unknown
1385                _3ewa->ReadInt8(); // unknown
1386                EG1Hold = _3ewa->ReadUint8() & 0x80; // bit 7
1387                uint8_t vcfcutoff = _3ewa->ReadUint8();
1388                VCFEnabled = vcfcutoff & 0x80; // bit 7
1389                VCFCutoff  = vcfcutoff & 0x7f; // lower 7 bits
1390                VCFCutoffController = static_cast<vcf_cutoff_ctrl_t>(_3ewa->ReadUint8());
1391                uint8_t vcfvelscale = _3ewa->ReadUint8();
1392                VCFCutoffControllerInvert = vcfvelscale & 0x80; // bit 7
1393                VCFVelocityScale = vcfvelscale & 0x7f; // lower 7 bits
1394                _3ewa->ReadInt8(); // unknown
1395                uint8_t vcfresonance = _3ewa->ReadUint8();
1396                VCFResonance = vcfresonance & 0x7f; // lower 7 bits
1397                VCFResonanceDynamic = !(vcfresonance & 0x80); // bit 7
1398                uint8_t vcfbreakpoint         = _3ewa->ReadUint8();
1399                VCFKeyboardTracking           = vcfbreakpoint & 0x80; // bit 7
1400                VCFKeyboardTrackingBreakpoint = vcfbreakpoint & 0x7f; // lower 7 bits
1401                uint8_t vcfvelocity = _3ewa->ReadUint8();
1402                VCFVelocityDynamicRange = vcfvelocity % 5;
1403                VCFVelocityCurve        = static_cast<curve_type_t>(vcfvelocity / 5);
1404                VCFType = static_cast<vcf_type_t>(_3ewa->ReadUint8());
1405                if (VCFType == vcf_type_lowpass) {
1406                    if (lfo3ctrl & 0x40) // bit 6
1407                        VCFType = vcf_type_lowpassturbo;
1408                }
1409                if (_3ewa->RemainingBytes() >= 8) {
1410                    _3ewa->Read(DimensionUpperLimits, 1, 8);
1411                } else {
1412                    memset(DimensionUpperLimits, 0, 8);
1413                }
1414            } else { // '3ewa' chunk does not exist yet
1415                // use default values
1416                LFO3Frequency                   = 1.0;
1417                EG3Attack                       = 0.0;
1418                LFO1InternalDepth               = 0;
1419                LFO3InternalDepth               = 0;
1420                LFO1ControlDepth                = 0;
1421                LFO3ControlDepth                = 0;
1422                EG1Attack                       = 0.0;
1423                EG1Decay1                       = 0.0;
1424                EG1Sustain                      = 0;
1425                EG1Release                      = 0.0;
1426                EG1Controller.type              = eg1_ctrl_t::type_none;
1427                EG1Controller.controller_number = 0;
1428                EG1ControllerInvert             = false;
1429                EG1ControllerAttackInfluence    = 0;
1430                EG1ControllerDecayInfluence     = 0;
1431                EG1ControllerReleaseInfluence   = 0;
1432                EG2Controller.type              = eg2_ctrl_t::type_none;
1433                EG2Controller.controller_number = 0;
1434                EG2ControllerInvert             = false;
1435                EG2ControllerAttackInfluence    = 0;
1436                EG2ControllerDecayInfluence     = 0;
1437                EG2ControllerReleaseInfluence   = 0;
1438                LFO1Frequency                   = 1.0;
1439                EG2Attack                       = 0.0;
1440                EG2Decay1                       = 0.0;
1441                EG2Sustain                      = 0;
1442                EG2Release                      = 0.0;
1443                LFO2ControlDepth                = 0;
1444                LFO2Frequency                   = 1.0;
1445                LFO2InternalDepth               = 0;
1446                EG1Decay2                       = 0.0;
1447                EG1InfiniteSustain              = false;
1448                EG1PreAttack                    = 1000;
1449                EG2Decay2                       = 0.0;
1450                EG2InfiniteSustain              = false;
1451                EG2PreAttack                    = 1000;
1452                VelocityResponseCurve           = curve_type_nonlinear;
1453                VelocityResponseDepth           = 3;
1454                ReleaseVelocityResponseCurve    = curve_type_nonlinear;
1455                ReleaseVelocityResponseDepth    = 3;
1456                VelocityResponseCurveScaling    = 32;
1457                AttenuationControllerThreshold  = 0;
1458                SampleStartOffset               = 0;
1459                PitchTrack                      = true;
1460                DimensionBypass                 = dim_bypass_ctrl_none;
1461                Pan                             = 0;
1462                SelfMask                        = true;
1463                LFO3Controller                  = lfo3_ctrl_modwheel;
1464                LFO3Sync                        = false;
1465                InvertAttenuationController     = false;
1466                AttenuationController.type      = attenuation_ctrl_t::type_none;
1467                AttenuationController.controller_number = 0;
1468                LFO2Controller                  = lfo2_ctrl_internal;
1469                LFO2FlipPhase                   = false;
1470                LFO2Sync                        = false;
1471                LFO1Controller                  = lfo1_ctrl_internal;
1472                LFO1FlipPhase                   = false;
1473                LFO1Sync                        = false;
1474                VCFResonanceController          = vcf_res_ctrl_none;
1475                EG3Depth                        = 0;
1476                ChannelOffset                   = 0;
1477                MSDecode                        = false;
1478                SustainDefeat                   = false;
1479                VelocityUpperLimit              = 0;
1480                ReleaseTriggerDecay             = 0;
1481                EG1Hold                         = false;
1482                VCFEnabled                      = false;
1483                VCFCutoff                       = 0;
1484                VCFCutoffController             = vcf_cutoff_ctrl_none;
1485                VCFCutoffControllerInvert       = false;
1486                VCFVelocityScale                = 0;
1487                VCFResonance                    = 0;
1488                VCFResonanceDynamic             = false;
1489                VCFKeyboardTracking             = false;
1490                VCFKeyboardTrackingBreakpoint   = 0;
1491                VCFVelocityDynamicRange         = 0x04;
1492                VCFVelocityCurve                = curve_type_linear;
1493                VCFType                         = vcf_type_lowpass;
1494                memset(DimensionUpperLimits, 0, 8);
1495            }
1496    
1497            pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,
1498                                                         VelocityResponseDepth,
1499                                                         VelocityResponseCurveScaling);
1500    
1501            curve_type_t curveType = ReleaseVelocityResponseCurve;
1502            uint8_t depth = ReleaseVelocityResponseDepth;
1503    
1504            // this models a strange behaviour or bug in GSt: two of the
1505            // velocity response curves for release time are not used even
1506            // if specified, instead another curve is chosen.
1507            if ((curveType == curve_type_nonlinear && depth == 0) ||
1508                (curveType == curve_type_special   && depth == 4)) {
1509                curveType = curve_type_nonlinear;
1510                depth = 3;
1511            }
1512            pVelocityReleaseTable = GetVelocityTable(curveType, depth, 0);
1513    
1514            curveType = VCFVelocityCurve;
1515            depth = VCFVelocityDynamicRange;
1516    
1517            // even stranger GSt: two of the velocity response curves for
1518            // filter cutoff are not used, instead another special curve
1519            // is chosen. This curve is not used anywhere else.
1520            if ((curveType == curve_type_nonlinear && depth == 0) ||
1521                (curveType == curve_type_special   && depth == 4)) {
1522                curveType = curve_type_special;
1523                depth = 5;
1524          }          }
1525          else {          pVelocityCutoffTable = GetVelocityTable(curveType, depth,
1526              VelocityResponseCurve = curve_type_unknown;                                                  VCFCutoffController <= vcf_cutoff_ctrl_none2 ? VCFVelocityScale : 0);
1527              VelocityResponseDepth = 0;  
1528            SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));
1529            VelocityTable = 0;
1530        }
1531    
1532        /**
1533         * Apply dimension region settings to the respective RIFF chunks. You
1534         * have to call File::Save() to make changes persistent.
1535         *
1536         * Usually there is absolutely no need to call this method explicitly.
1537         * It will be called automatically when File::Save() was called.
1538         */
1539        void DimensionRegion::UpdateChunks() {
1540            // first update base class's chunk
1541            DLS::Sampler::UpdateChunks();
1542    
1543            // make sure '3ewa' chunk exists
1544            RIFF::Chunk* _3ewa = pParentList->GetSubChunk(CHUNK_ID_3EWA);
1545            if (!_3ewa)  _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, 140);
1546            uint8_t* pData = (uint8_t*) _3ewa->LoadChunkData();
1547    
1548            // update '3ewa' chunk with DimensionRegion's current settings
1549    
1550            const uint32_t chunksize = _3ewa->GetNewSize();
1551            store32(&pData[0], chunksize); // unknown, always chunk size?
1552    
1553            const int32_t lfo3freq = (int32_t) GIG_EXP_ENCODE(LFO3Frequency);
1554            store32(&pData[4], lfo3freq);
1555    
1556            const int32_t eg3attack = (int32_t) GIG_EXP_ENCODE(EG3Attack);
1557            store32(&pData[8], eg3attack);
1558    
1559            // next 2 bytes unknown
1560    
1561            store16(&pData[14], LFO1InternalDepth);
1562    
1563            // next 2 bytes unknown
1564    
1565            store16(&pData[18], LFO3InternalDepth);
1566    
1567            // next 2 bytes unknown
1568    
1569            store16(&pData[22], LFO1ControlDepth);
1570    
1571            // next 2 bytes unknown
1572    
1573            store16(&pData[26], LFO3ControlDepth);
1574    
1575            const int32_t eg1attack = (int32_t) GIG_EXP_ENCODE(EG1Attack);
1576            store32(&pData[28], eg1attack);
1577    
1578            const int32_t eg1decay1 = (int32_t) GIG_EXP_ENCODE(EG1Decay1);
1579            store32(&pData[32], eg1decay1);
1580    
1581            // next 2 bytes unknown
1582    
1583            store16(&pData[38], EG1Sustain);
1584    
1585            const int32_t eg1release = (int32_t) GIG_EXP_ENCODE(EG1Release);
1586            store32(&pData[40], eg1release);
1587    
1588            const uint8_t eg1ctl = (uint8_t) EncodeLeverageController(EG1Controller);
1589            pData[44] = eg1ctl;
1590    
1591            const uint8_t eg1ctrloptions =
1592                (EG1ControllerInvert) ? 0x01 : 0x00 |
1593                GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG1ControllerAttackInfluence) |
1594                GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG1ControllerDecayInfluence) |
1595                GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG1ControllerReleaseInfluence);
1596            pData[45] = eg1ctrloptions;
1597    
1598            const uint8_t eg2ctl = (uint8_t) EncodeLeverageController(EG2Controller);
1599            pData[46] = eg2ctl;
1600    
1601            const uint8_t eg2ctrloptions =
1602                (EG2ControllerInvert) ? 0x01 : 0x00 |
1603                GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG2ControllerAttackInfluence) |
1604                GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG2ControllerDecayInfluence) |
1605                GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG2ControllerReleaseInfluence);
1606            pData[47] = eg2ctrloptions;
1607    
1608            const int32_t lfo1freq = (int32_t) GIG_EXP_ENCODE(LFO1Frequency);
1609            store32(&pData[48], lfo1freq);
1610    
1611            const int32_t eg2attack = (int32_t) GIG_EXP_ENCODE(EG2Attack);
1612            store32(&pData[52], eg2attack);
1613    
1614            const int32_t eg2decay1 = (int32_t) GIG_EXP_ENCODE(EG2Decay1);
1615            store32(&pData[56], eg2decay1);
1616    
1617            // next 2 bytes unknown
1618    
1619            store16(&pData[62], EG2Sustain);
1620    
1621            const int32_t eg2release = (int32_t) GIG_EXP_ENCODE(EG2Release);
1622            store32(&pData[64], eg2release);
1623    
1624            // next 2 bytes unknown
1625    
1626            store16(&pData[70], LFO2ControlDepth);
1627    
1628            const int32_t lfo2freq = (int32_t) GIG_EXP_ENCODE(LFO2Frequency);
1629            store32(&pData[72], lfo2freq);
1630    
1631            // next 2 bytes unknown
1632    
1633            store16(&pData[78], LFO2InternalDepth);
1634    
1635            const int32_t eg1decay2 = (int32_t) (EG1InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG1Decay2);
1636            store32(&pData[80], eg1decay2);
1637    
1638            // next 2 bytes unknown
1639    
1640            store16(&pData[86], EG1PreAttack);
1641    
1642            const int32_t eg2decay2 = (int32_t) (EG2InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG2Decay2);
1643            store32(&pData[88], eg2decay2);
1644    
1645            // next 2 bytes unknown
1646    
1647            store16(&pData[94], EG2PreAttack);
1648    
1649            {
1650                if (VelocityResponseDepth > 4) throw Exception("VelocityResponseDepth must be between 0 and 4");
1651                uint8_t velocityresponse = VelocityResponseDepth;
1652                switch (VelocityResponseCurve) {
1653                    case curve_type_nonlinear:
1654                        break;
1655                    case curve_type_linear:
1656                        velocityresponse += 5;
1657                        break;
1658                    case curve_type_special:
1659                        velocityresponse += 10;
1660                        break;
1661                    case curve_type_unknown:
1662                    default:
1663                        throw Exception("Could not update DimensionRegion's chunk, unknown VelocityResponseCurve selected");
1664                }
1665                pData[96] = velocityresponse;
1666          }          }
1667          uint8_t releasevelocityresponse = _3ewa->ReadUint8();  
1668          if (releasevelocityresponse < 5) {          {
1669              ReleaseVelocityResponseCurve = curve_type_nonlinear;              if (ReleaseVelocityResponseDepth > 4) throw Exception("ReleaseVelocityResponseDepth must be between 0 and 4");
1670              ReleaseVelocityResponseDepth = releasevelocityresponse;              uint8_t releasevelocityresponse = ReleaseVelocityResponseDepth;
1671          }              switch (ReleaseVelocityResponseCurve) {
1672          else if (releasevelocityresponse < 10) {                  case curve_type_nonlinear:
1673              ReleaseVelocityResponseCurve = curve_type_linear;                      break;
1674              ReleaseVelocityResponseDepth = releasevelocityresponse - 5;                  case curve_type_linear:
1675          }                      releasevelocityresponse += 5;
1676          else if (releasevelocityresponse < 15) {                      break;
1677              ReleaseVelocityResponseCurve = curve_type_special;                  case curve_type_special:
1678              ReleaseVelocityResponseDepth = releasevelocityresponse - 10;                      releasevelocityresponse += 10;
1679                        break;
1680                    case curve_type_unknown:
1681                    default:
1682                        throw Exception("Could not update DimensionRegion's chunk, unknown ReleaseVelocityResponseCurve selected");
1683                }
1684                pData[97] = releasevelocityresponse;
1685          }          }
1686          else {  
1687              ReleaseVelocityResponseCurve = curve_type_unknown;          pData[98] = VelocityResponseCurveScaling;
1688              ReleaseVelocityResponseDepth = 0;  
1689            pData[99] = AttenuationControllerThreshold;
1690    
1691            // next 4 bytes unknown
1692    
1693            store16(&pData[104], SampleStartOffset);
1694    
1695            // next 2 bytes unknown
1696    
1697            {
1698                uint8_t pitchTrackDimensionBypass = GIG_PITCH_TRACK_ENCODE(PitchTrack);
1699                switch (DimensionBypass) {
1700                    case dim_bypass_ctrl_94:
1701                        pitchTrackDimensionBypass |= 0x10;
1702                        break;
1703                    case dim_bypass_ctrl_95:
1704                        pitchTrackDimensionBypass |= 0x20;
1705                        break;
1706                    case dim_bypass_ctrl_none:
1707                        //FIXME: should we set anything here?
1708                        break;
1709                    default:
1710                        throw Exception("Could not update DimensionRegion's chunk, unknown DimensionBypass selected");
1711                }
1712                pData[108] = pitchTrackDimensionBypass;
1713          }          }
1714          VelocityResponseCurveScaling = _3ewa->ReadUint8();  
1715          AttenuationControllerThreshold = _3ewa->ReadInt8();          const uint8_t pan = (Pan >= 0) ? Pan : ((-Pan) + 63); // signed 8 bit -> signed 7 bit
1716          _3ewa->ReadInt32(); // unknown          pData[109] = pan;
1717          SampleStartOffset = (uint16_t) _3ewa->ReadInt16();  
1718          _3ewa->ReadInt16(); // unknown          const uint8_t selfmask = (SelfMask) ? 0x01 : 0x00;
1719          uint8_t pitchTrackDimensionBypass = _3ewa->ReadInt8();          pData[110] = selfmask;
1720          PitchTrack = GIG_PITCH_TRACK_EXTRACT(pitchTrackDimensionBypass);  
1721          if      (pitchTrackDimensionBypass & 0x10) DimensionBypass = dim_bypass_ctrl_94;          // next byte unknown
1722          else if (pitchTrackDimensionBypass & 0x20) DimensionBypass = dim_bypass_ctrl_95;  
1723          else                                       DimensionBypass = dim_bypass_ctrl_none;          {
1724          uint8_t pan = _3ewa->ReadUint8();              uint8_t lfo3ctrl = LFO3Controller & 0x07; // lower 3 bits
1725          Pan         = (pan < 64) ? pan : -((int)pan - 63); // signed 7 bit -> signed 8 bit              if (LFO3Sync) lfo3ctrl |= 0x20; // bit 5
1726          SelfMask = _3ewa->ReadInt8() & 0x01;              if (InvertAttenuationController) lfo3ctrl |= 0x80; // bit 7
1727          _3ewa->ReadInt8(); // unknown              if (VCFType == vcf_type_lowpassturbo) lfo3ctrl |= 0x40; // bit 6
1728          uint8_t lfo3ctrl = _3ewa->ReadUint8();              pData[112] = lfo3ctrl;
         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;  
1729          }          }
1730    
1731          // get the corresponding velocity->volume table from the table map or create & calculate that table if it doesn't exist yet          const uint8_t attenctl = EncodeLeverageController(AttenuationController);
1732          uint32_t tableKey = (VelocityResponseCurve<<16) | (VelocityResponseDepth<<8) | VelocityResponseCurveScaling;          pData[113] = attenctl;
1733    
1734            {
1735                uint8_t lfo2ctrl = LFO2Controller & 0x07; // lower 3 bits
1736                if (LFO2FlipPhase) lfo2ctrl |= 0x80; // bit 7
1737                if (LFO2Sync)      lfo2ctrl |= 0x20; // bit 5
1738                if (VCFResonanceController != vcf_res_ctrl_none) lfo2ctrl |= 0x40; // bit 6
1739                pData[114] = lfo2ctrl;
1740            }
1741    
1742            {
1743                uint8_t lfo1ctrl = LFO1Controller & 0x07; // lower 3 bits
1744                if (LFO1FlipPhase) lfo1ctrl |= 0x80; // bit 7
1745                if (LFO1Sync)      lfo1ctrl |= 0x40; // bit 6
1746                if (VCFResonanceController != vcf_res_ctrl_none)
1747                    lfo1ctrl |= GIG_VCF_RESONANCE_CTRL_ENCODE(VCFResonanceController);
1748                pData[115] = lfo1ctrl;
1749            }
1750    
1751            const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth
1752                                                      : uint16_t(((-EG3Depth) - 1) ^ 0xffff); /* binary complementary for negatives */
1753            pData[116] = eg3depth;
1754    
1755            // next 2 bytes unknown
1756    
1757            const uint8_t channeloffset = ChannelOffset * 4;
1758            pData[120] = channeloffset;
1759    
1760            {
1761                uint8_t regoptions = 0;
1762                if (MSDecode)      regoptions |= 0x01; // bit 0
1763                if (SustainDefeat) regoptions |= 0x02; // bit 1
1764                pData[121] = regoptions;
1765            }
1766    
1767            // next 2 bytes unknown
1768    
1769            pData[124] = VelocityUpperLimit;
1770    
1771            // next 3 bytes unknown
1772    
1773            pData[128] = ReleaseTriggerDecay;
1774    
1775            // next 2 bytes unknown
1776    
1777            const uint8_t eg1hold = (EG1Hold) ? 0x80 : 0x00; // bit 7
1778            pData[131] = eg1hold;
1779    
1780            const uint8_t vcfcutoff = (VCFEnabled) ? 0x80 : 0x00 |  /* bit 7 */
1781                                      (VCFCutoff & 0x7f);   /* lower 7 bits */
1782            pData[132] = vcfcutoff;
1783    
1784            pData[133] = VCFCutoffController;
1785    
1786            const uint8_t vcfvelscale = (VCFCutoffControllerInvert) ? 0x80 : 0x00 | /* bit 7 */
1787                                        (VCFVelocityScale & 0x7f); /* lower 7 bits */
1788            pData[134] = vcfvelscale;
1789    
1790            // next byte unknown
1791    
1792            const uint8_t vcfresonance = (VCFResonanceDynamic) ? 0x00 : 0x80 | /* bit 7 */
1793                                         (VCFResonance & 0x7f); /* lower 7 bits */
1794            pData[136] = vcfresonance;
1795    
1796            const uint8_t vcfbreakpoint = (VCFKeyboardTracking) ? 0x80 : 0x00 | /* bit 7 */
1797                                          (VCFKeyboardTrackingBreakpoint & 0x7f); /* lower 7 bits */
1798            pData[137] = vcfbreakpoint;
1799    
1800            const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 |
1801                                        VCFVelocityCurve * 5;
1802            pData[138] = vcfvelocity;
1803    
1804            const uint8_t vcftype = (VCFType == vcf_type_lowpassturbo) ? vcf_type_lowpass : VCFType;
1805            pData[139] = vcftype;
1806    
1807            if (chunksize >= 148) {
1808                memcpy(&pData[140], DimensionUpperLimits, 8);
1809            }
1810        }
1811    
1812        // get the corresponding velocity table from the table map or create & calculate that table if it doesn't exist yet
1813        double* DimensionRegion::GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling)
1814        {
1815            double* table;
1816            uint32_t tableKey = (curveType<<16) | (depth<<8) | scaling;
1817          if (pVelocityTables->count(tableKey)) { // if key exists          if (pVelocityTables->count(tableKey)) { // if key exists
1818              pVelocityAttenuationTable = (*pVelocityTables)[tableKey];              table = (*pVelocityTables)[tableKey];
1819          }          }
1820          else {          else {
1821              pVelocityAttenuationTable =              table = CreateVelocityTable(curveType, depth, scaling);
1822                  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  
1823          }          }
1824            return table;
         SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));  
1825      }      }
1826    
1827      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {
# Line 1295  namespace { Line 1942  namespace {
1942          return decodedcontroller;          return decodedcontroller;
1943      }      }
1944    
1945        DimensionRegion::_lev_ctrl_t DimensionRegion::EncodeLeverageController(leverage_ctrl_t DecodedController) {
1946            _lev_ctrl_t encodedcontroller;
1947            switch (DecodedController.type) {
1948                // special controller
1949                case leverage_ctrl_t::type_none:
1950                    encodedcontroller = _lev_ctrl_none;
1951                    break;
1952                case leverage_ctrl_t::type_velocity:
1953                    encodedcontroller = _lev_ctrl_velocity;
1954                    break;
1955                case leverage_ctrl_t::type_channelaftertouch:
1956                    encodedcontroller = _lev_ctrl_channelaftertouch;
1957                    break;
1958    
1959                // ordinary MIDI control change controller
1960                case leverage_ctrl_t::type_controlchange:
1961                    switch (DecodedController.controller_number) {
1962                        case 1:
1963                            encodedcontroller = _lev_ctrl_modwheel;
1964                            break;
1965                        case 2:
1966                            encodedcontroller = _lev_ctrl_breath;
1967                            break;
1968                        case 4:
1969                            encodedcontroller = _lev_ctrl_foot;
1970                            break;
1971                        case 12:
1972                            encodedcontroller = _lev_ctrl_effect1;
1973                            break;
1974                        case 13:
1975                            encodedcontroller = _lev_ctrl_effect2;
1976                            break;
1977                        case 16:
1978                            encodedcontroller = _lev_ctrl_genpurpose1;
1979                            break;
1980                        case 17:
1981                            encodedcontroller = _lev_ctrl_genpurpose2;
1982                            break;
1983                        case 18:
1984                            encodedcontroller = _lev_ctrl_genpurpose3;
1985                            break;
1986                        case 19:
1987                            encodedcontroller = _lev_ctrl_genpurpose4;
1988                            break;
1989                        case 5:
1990                            encodedcontroller = _lev_ctrl_portamentotime;
1991                            break;
1992                        case 64:
1993                            encodedcontroller = _lev_ctrl_sustainpedal;
1994                            break;
1995                        case 65:
1996                            encodedcontroller = _lev_ctrl_portamento;
1997                            break;
1998                        case 66:
1999                            encodedcontroller = _lev_ctrl_sostenutopedal;
2000                            break;
2001                        case 67:
2002                            encodedcontroller = _lev_ctrl_softpedal;
2003                            break;
2004                        case 80:
2005                            encodedcontroller = _lev_ctrl_genpurpose5;
2006                            break;
2007                        case 81:
2008                            encodedcontroller = _lev_ctrl_genpurpose6;
2009                            break;
2010                        case 82:
2011                            encodedcontroller = _lev_ctrl_genpurpose7;
2012                            break;
2013                        case 83:
2014                            encodedcontroller = _lev_ctrl_genpurpose8;
2015                            break;
2016                        case 91:
2017                            encodedcontroller = _lev_ctrl_effect1depth;
2018                            break;
2019                        case 92:
2020                            encodedcontroller = _lev_ctrl_effect2depth;
2021                            break;
2022                        case 93:
2023                            encodedcontroller = _lev_ctrl_effect3depth;
2024                            break;
2025                        case 94:
2026                            encodedcontroller = _lev_ctrl_effect4depth;
2027                            break;
2028                        case 95:
2029                            encodedcontroller = _lev_ctrl_effect5depth;
2030                            break;
2031                        default:
2032                            throw gig::Exception("leverage controller number is not supported by the gig format");
2033                    }
2034                    break;
2035                default:
2036                    throw gig::Exception("Unknown leverage controller type.");
2037            }
2038            return encodedcontroller;
2039        }
2040    
2041      DimensionRegion::~DimensionRegion() {      DimensionRegion::~DimensionRegion() {
2042          Instances--;          Instances--;
2043          if (!Instances) {          if (!Instances) {
# Line 1308  namespace { Line 2051  namespace {
2051              delete pVelocityTables;              delete pVelocityTables;
2052              pVelocityTables = NULL;              pVelocityTables = NULL;
2053          }          }
2054            if (VelocityTable) delete[] VelocityTable;
2055      }      }
2056    
2057      /**      /**
# Line 1325  namespace { Line 2069  namespace {
2069          return pVelocityAttenuationTable[MIDIKeyVelocity];          return pVelocityAttenuationTable[MIDIKeyVelocity];
2070      }      }
2071    
2072        double DimensionRegion::GetVelocityRelease(uint8_t MIDIKeyVelocity) {
2073            return pVelocityReleaseTable[MIDIKeyVelocity];
2074        }
2075    
2076        double DimensionRegion::GetVelocityCutoff(uint8_t MIDIKeyVelocity) {
2077            return pVelocityCutoffTable[MIDIKeyVelocity];
2078        }
2079    
2080      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) {
2081    
2082          // line-segment approximations of the 15 velocity curves          // line-segment approximations of the 15 velocity curves
# Line 1358  namespace { Line 2110  namespace {
2110          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,
2111                               127, 127 };                               127, 127 };
2112    
2113            // this is only used by the VCF velocity curve
2114            const int spe5[] = { 1, 2, 30, 5, 60, 19, 77, 70, 83, 85, 88, 106,
2115                                 91, 127, 127, 127 };
2116    
2117          const int* const curves[] = { non0, non1, non2, non3, non4,          const int* const curves[] = { non0, non1, non2, non3, non4,
2118                                        lin0, lin1, lin2, lin3, lin4,                                        lin0, lin1, lin2, lin3, lin4,
2119                                        spe0, spe1, spe2, spe3, spe4 };                                        spe0, spe1, spe2, spe3, spe4, spe5 };
2120    
2121          double* const table = new double[128];          double* const table = new double[128];
2122    
# Line 1412  namespace { Line 2168  namespace {
2168              for (int i = 0; i < dimensionBits; i++) {              for (int i = 0; i < dimensionBits; i++) {
2169                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());
2170                  uint8_t     bits      = _3lnk->ReadUint8();                  uint8_t     bits      = _3lnk->ReadUint8();
2171                    _3lnk->ReadUint8(); // bit position of the dimension (bits[0] + bits[1] + ... + bits[i-1])
2172                    _3lnk->ReadUint8(); // (1 << bit position of next dimension) - (1 << bit position of this dimension)
2173                    uint8_t     zones     = _3lnk->ReadUint8(); // new for v3: number of zones doesn't have to be == pow(2,bits)
2174                  if (dimension == dimension_none) { // inactive dimension                  if (dimension == dimension_none) { // inactive dimension
2175                      pDimensionDefinitions[i].dimension  = dimension_none;                      pDimensionDefinitions[i].dimension  = dimension_none;
2176                      pDimensionDefinitions[i].bits       = 0;                      pDimensionDefinitions[i].bits       = 0;
2177                      pDimensionDefinitions[i].zones      = 0;                      pDimensionDefinitions[i].zones      = 0;
2178                      pDimensionDefinitions[i].split_type = split_type_bit;                      pDimensionDefinitions[i].split_type = split_type_bit;
                     pDimensionDefinitions[i].ranges     = NULL;  
2179                      pDimensionDefinitions[i].zone_size  = 0;                      pDimensionDefinitions[i].zone_size  = 0;
2180                  }                  }
2181                  else { // active dimension                  else { // active dimension
2182                      pDimensionDefinitions[i].dimension = dimension;                      pDimensionDefinitions[i].dimension = dimension;
2183                      pDimensionDefinitions[i].bits      = bits;                      pDimensionDefinitions[i].bits      = bits;
2184                      pDimensionDefinitions[i].zones     = 0x01 << bits; // = pow(2,bits)                      pDimensionDefinitions[i].zones     = zones ? zones : 0x01 << bits; // = pow(2,bits)
2185                      pDimensionDefinitions[i].split_type = (dimension == dimension_layer ||                      pDimensionDefinitions[i].split_type = __resolveSplitType(dimension);
2186                                                             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;  
2187                      Dimensions++;                      Dimensions++;
2188    
2189                      // if this is a layer dimension, remember the amount of layers                      // if this is a layer dimension, remember the amount of layers
2190                      if (dimension == dimension_layer) Layers = pDimensionDefinitions[i].zones;                      if (dimension == dimension_layer) Layers = pDimensionDefinitions[i].zones;
2191                  }                  }
2192                  _3lnk->SetPos(6, RIFF::stream_curpos); // jump forward to next dimension definition                  _3lnk->SetPos(3, RIFF::stream_curpos); // jump forward to next dimension definition
2193              }              }
2194                for (int i = dimensionBits ; i < 8 ; i++) pDimensionDefinitions[i].bits = 0;
2195    
2196              // 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,
2197              for (uint i = 0; i < Dimensions; i++) {              // update the VelocityTables in the dimension regions
2198                  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;  
                             }  
                         }  
                     }  
                 }  
             }  
2199    
2200              // 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();  
2201              if (file->pVersion && file->pVersion->major == 3)              if (file->pVersion && file->pVersion->major == 3)
2202                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure
2203              else              else
# Line 1482  namespace { Line 2206  namespace {
2206              // load sample references              // load sample references
2207              for (uint i = 0; i < DimensionRegions; i++) {              for (uint i = 0; i < DimensionRegions; i++) {
2208                  uint32_t wavepoolindex = _3lnk->ReadUint32();                  uint32_t wavepoolindex = _3lnk->ReadUint32();
2209                  pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);                  if (file->pWavePoolTable) pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);
2210                }
2211                GetSample(); // load global region sample reference
2212            } else {
2213                DimensionRegions = 0;
2214                for (int i = 0 ; i < 8 ; i++) {
2215                    pDimensionDefinitions[i].dimension  = dimension_none;
2216                    pDimensionDefinitions[i].bits       = 0;
2217                    pDimensionDefinitions[i].zones      = 0;
2218                }
2219            }
2220    
2221            // make sure there is at least one dimension region
2222            if (!DimensionRegions) {
2223                RIFF::List* _3prg = rgnList->GetSubList(LIST_TYPE_3PRG);
2224                if (!_3prg) _3prg = rgnList->AddSubList(LIST_TYPE_3PRG);
2225                RIFF::List* _3ewl = _3prg->AddSubList(LIST_TYPE_3EWL);
2226                pDimensionRegions[0] = new DimensionRegion(_3ewl);
2227                DimensionRegions = 1;
2228            }
2229        }
2230    
2231        /**
2232         * Apply Region settings and all its DimensionRegions to the respective
2233         * RIFF chunks. You have to call File::Save() to make changes persistent.
2234         *
2235         * Usually there is absolutely no need to call this method explicitly.
2236         * It will be called automatically when File::Save() was called.
2237         *
2238         * @throws gig::Exception if samples cannot be dereferenced
2239         */
2240        void Region::UpdateChunks() {
2241            // in the gig format we don't care about the Region's sample reference
2242            // but we still have to provide some existing one to not corrupt the
2243            // file, so to avoid the latter we simply always assign the sample of
2244            // the first dimension region of this region
2245            pSample = pDimensionRegions[0]->pSample;
2246    
2247            // first update base class's chunks
2248            DLS::Region::UpdateChunks();
2249    
2250            // update dimension region's chunks
2251            for (int i = 0; i < DimensionRegions; i++) {
2252                pDimensionRegions[i]->UpdateChunks();
2253            }
2254    
2255            File* pFile = (File*) GetParent()->GetParent();
2256            const int iMaxDimensions = (pFile->pVersion && pFile->pVersion->major == 3) ? 8 : 5;
2257            const int iMaxDimensionRegions = (pFile->pVersion && pFile->pVersion->major == 3) ? 256 : 32;
2258    
2259            // make sure '3lnk' chunk exists
2260            RIFF::Chunk* _3lnk = pCkRegion->GetSubChunk(CHUNK_ID_3LNK);
2261            if (!_3lnk) {
2262                const int _3lnkChunkSize = (pFile->pVersion && pFile->pVersion->major == 3) ? 1092 : 172;
2263                _3lnk = pCkRegion->AddSubChunk(CHUNK_ID_3LNK, _3lnkChunkSize);
2264                memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);
2265    
2266                // move 3prg to last position
2267                pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3PRG), 0);
2268            }
2269    
2270            // update dimension definitions in '3lnk' chunk
2271            uint8_t* pData = (uint8_t*) _3lnk->LoadChunkData();
2272            store32(&pData[0], DimensionRegions);
2273            int shift = 0;
2274            for (int i = 0; i < iMaxDimensions; i++) {
2275                pData[4 + i * 8] = (uint8_t) pDimensionDefinitions[i].dimension;
2276                pData[5 + i * 8] = pDimensionDefinitions[i].bits;
2277                pData[6 + i * 8] = shift;
2278                pData[7 + i * 8] = (1 << (shift + pDimensionDefinitions[i].bits)) - (1 << shift);
2279                pData[8 + i * 8] = pDimensionDefinitions[i].zones;
2280                // next 3 bytes unknown, always zero?
2281    
2282                shift += pDimensionDefinitions[i].bits;
2283            }
2284    
2285            // update wave pool table in '3lnk' chunk
2286            const int iWavePoolOffset = (pFile->pVersion && pFile->pVersion->major == 3) ? 68 : 44;
2287            for (uint i = 0; i < iMaxDimensionRegions; i++) {
2288                int iWaveIndex = -1;
2289                if (i < DimensionRegions) {
2290                    if (!pFile->pSamples || !pFile->pSamples->size()) throw gig::Exception("Could not update gig::Region, there are no samples");
2291                    File::SampleList::iterator iter = pFile->pSamples->begin();
2292                    File::SampleList::iterator end  = pFile->pSamples->end();
2293                    for (int index = 0; iter != end; ++iter, ++index) {
2294                        if (*iter == pDimensionRegions[i]->pSample) {
2295                            iWaveIndex = index;
2296                            break;
2297                        }
2298                    }
2299                    if (iWaveIndex < 0) throw gig::Exception("Could not update gig::Region, could not find DimensionRegion's sample");
2300              }              }
2301                store32(&pData[iWavePoolOffset + i * 4], iWaveIndex);
2302          }          }
         else throw gig::Exception("Mandatory <3lnk> chunk not found.");  
2303      }      }
2304    
2305      void Region::LoadDimensionRegions(RIFF::List* rgn) {      void Region::LoadDimensionRegions(RIFF::List* rgn) {
# Line 1504  namespace { Line 2318  namespace {
2318          }          }
2319      }      }
2320    
2321      Region::~Region() {      void Region::UpdateVelocityTable() {
2322          for (uint i = 0; i < Dimensions; i++) {          // get velocity dimension's index
2323              if (pDimensionDefinitions[i].ranges) delete[] pDimensionDefinitions[i].ranges;          int veldim = -1;
2324            for (int i = 0 ; i < Dimensions ; i++) {
2325                if (pDimensionDefinitions[i].dimension == gig::dimension_velocity) {
2326                    veldim = i;
2327                    break;
2328                }
2329            }
2330            if (veldim == -1) return;
2331    
2332            int step = 1;
2333            for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;
2334            int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;
2335            int end = step * pDimensionDefinitions[veldim].zones;
2336    
2337            // loop through all dimension regions for all dimensions except the velocity dimension
2338            int dim[8] = { 0 };
2339            for (int i = 0 ; i < DimensionRegions ; i++) {
2340    
2341                if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||
2342                    pDimensionRegions[i]->VelocityUpperLimit) {
2343                    // create the velocity table
2344                    uint8_t* table = pDimensionRegions[i]->VelocityTable;
2345                    if (!table) {
2346                        table = new uint8_t[128];
2347                        pDimensionRegions[i]->VelocityTable = table;
2348                    }
2349                    int tableidx = 0;
2350                    int velocityZone = 0;
2351                    if (pDimensionRegions[i]->DimensionUpperLimits[veldim]) { // gig3
2352                        for (int k = i ; k < end ; k += step) {
2353                            DimensionRegion *d = pDimensionRegions[k];
2354                            for (; tableidx <= d->DimensionUpperLimits[veldim] ; tableidx++) table[tableidx] = velocityZone;
2355                            velocityZone++;
2356                        }
2357                    } else { // gig2
2358                        for (int k = i ; k < end ; k += step) {
2359                            DimensionRegion *d = pDimensionRegions[k];
2360                            for (; tableidx <= d->VelocityUpperLimit ; tableidx++) table[tableidx] = velocityZone;
2361                            velocityZone++;
2362                        }
2363                    }
2364                } else {
2365                    if (pDimensionRegions[i]->VelocityTable) {
2366                        delete[] pDimensionRegions[i]->VelocityTable;
2367                        pDimensionRegions[i]->VelocityTable = 0;
2368                    }
2369                }
2370    
2371                int j;
2372                int shift = 0;
2373                for (j = 0 ; j < Dimensions ; j++) {
2374                    if (j == veldim) i += skipveldim; // skip velocity dimension
2375                    else {
2376                        dim[j]++;
2377                        if (dim[j] < pDimensionDefinitions[j].zones) break;
2378                        else {
2379                            // skip unused dimension regions
2380                            dim[j] = 0;
2381                            i += ((1 << pDimensionDefinitions[j].bits) -
2382                                  pDimensionDefinitions[j].zones) << shift;
2383                        }
2384                    }
2385                    shift += pDimensionDefinitions[j].bits;
2386                }
2387                if (j == Dimensions) break;
2388            }
2389        }
2390    
2391        /** @brief Einstein would have dreamed of it - create a new dimension.
2392         *
2393         * Creates a new dimension with the dimension definition given by
2394         * \a pDimDef. The appropriate amount of DimensionRegions will be created.
2395         * There is a hard limit of dimensions and total amount of "bits" all
2396         * dimensions can have. This limit is dependant to what gig file format
2397         * version this file refers to. The gig v2 (and lower) format has a
2398         * dimension limit and total amount of bits limit of 5, whereas the gig v3
2399         * format has a limit of 8.
2400         *
2401         * @param pDimDef - defintion of the new dimension
2402         * @throws gig::Exception if dimension of the same type exists already
2403         * @throws gig::Exception if amount of dimensions or total amount of
2404         *                        dimension bits limit is violated
2405         */
2406        void Region::AddDimension(dimension_def_t* pDimDef) {
2407            // check if max. amount of dimensions reached
2408            File* file = (File*) GetParent()->GetParent();
2409            const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;
2410            if (Dimensions >= iMaxDimensions)
2411                throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimensions already reached");
2412            // check if max. amount of dimension bits reached
2413            int iCurrentBits = 0;
2414            for (int i = 0; i < Dimensions; i++)
2415                iCurrentBits += pDimensionDefinitions[i].bits;
2416            if (iCurrentBits >= iMaxDimensions)
2417                throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimension bits already reached");
2418            const int iNewBits = iCurrentBits + pDimDef->bits;
2419            if (iNewBits > iMaxDimensions)
2420                throw gig::Exception("Could not add new dimension, new dimension would exceed max. amount of " + ToString(iMaxDimensions) + " dimension bits");
2421            // check if there's already a dimensions of the same type
2422            for (int i = 0; i < Dimensions; i++)
2423                if (pDimensionDefinitions[i].dimension == pDimDef->dimension)
2424                    throw gig::Exception("Could not add new dimension, there is already a dimension of the same type");
2425    
2426            // assign definition of new dimension
2427            pDimensionDefinitions[Dimensions] = *pDimDef;
2428    
2429            // auto correct certain dimension definition fields (where possible)
2430            pDimensionDefinitions[Dimensions].split_type  =
2431                __resolveSplitType(pDimensionDefinitions[Dimensions].dimension);
2432            pDimensionDefinitions[Dimensions].zone_size =
2433                __resolveZoneSize(pDimensionDefinitions[Dimensions]);
2434    
2435            // create new dimension region(s) for this new dimension
2436            for (int i = 1 << iCurrentBits; i < 1 << iNewBits; i++) {
2437                //TODO: maybe we should copy existing dimension regions if possible instead of simply creating new ones with default values
2438                RIFF::List* _3prg = pCkRegion->GetSubList(LIST_TYPE_3PRG);
2439                RIFF::List* pNewDimRgnListChunk = _3prg->AddSubList(LIST_TYPE_3EWL);
2440                pDimensionRegions[i] = new DimensionRegion(pNewDimRgnListChunk);
2441                DimensionRegions++;
2442            }
2443    
2444            Dimensions++;
2445    
2446            // if this is a layer dimension, update 'Layers' attribute
2447            if (pDimDef->dimension == dimension_layer) Layers = pDimDef->zones;
2448    
2449            UpdateVelocityTable();
2450        }
2451    
2452        /** @brief Delete an existing dimension.
2453         *
2454         * Deletes the dimension given by \a pDimDef and deletes all respective
2455         * dimension regions, that is all dimension regions where the dimension's
2456         * bit(s) part is greater than 0. In case of a 'sustain pedal' dimension
2457         * for example this would delete all dimension regions for the case(s)
2458         * where the sustain pedal is pressed down.
2459         *
2460         * @param pDimDef - dimension to delete
2461         * @throws gig::Exception if given dimension cannot be found
2462         */
2463        void Region::DeleteDimension(dimension_def_t* pDimDef) {
2464            // get dimension's index
2465            int iDimensionNr = -1;
2466            for (int i = 0; i < Dimensions; i++) {
2467                if (&pDimensionDefinitions[i] == pDimDef) {
2468                    iDimensionNr = i;
2469                    break;
2470                }
2471            }
2472            if (iDimensionNr < 0) throw gig::Exception("Invalid dimension_def_t pointer");
2473    
2474            // get amount of bits below the dimension to delete
2475            int iLowerBits = 0;
2476            for (int i = 0; i < iDimensionNr; i++)
2477                iLowerBits += pDimensionDefinitions[i].bits;
2478    
2479            // get amount ot bits above the dimension to delete
2480            int iUpperBits = 0;
2481            for (int i = iDimensionNr + 1; i < Dimensions; i++)
2482                iUpperBits += pDimensionDefinitions[i].bits;
2483    
2484            // delete dimension regions which belong to the given dimension
2485            // (that is where the dimension's bit > 0)
2486            for (int iUpperBit = 0; iUpperBit < 1 << iUpperBits; iUpperBit++) {
2487                for (int iObsoleteBit = 1; iObsoleteBit < 1 << pDimensionDefinitions[iDimensionNr].bits; iObsoleteBit++) {
2488                    for (int iLowerBit = 0; iLowerBit < 1 << iLowerBits; iLowerBit++) {
2489                        int iToDelete = iUpperBit    << (pDimensionDefinitions[iDimensionNr].bits + iLowerBits) |
2490                                        iObsoleteBit << iLowerBits |
2491                                        iLowerBit;
2492                        delete pDimensionRegions[iToDelete];
2493                        pDimensionRegions[iToDelete] = NULL;
2494                        DimensionRegions--;
2495                    }
2496                }
2497            }
2498    
2499            // defrag pDimensionRegions array
2500            // (that is remove the NULL spaces within the pDimensionRegions array)
2501            for (int iFrom = 2, iTo = 1; iFrom < 256 && iTo < 256 - 1; iTo++) {
2502                if (!pDimensionRegions[iTo]) {
2503                    if (iFrom <= iTo) iFrom = iTo + 1;
2504                    while (!pDimensionRegions[iFrom] && iFrom < 256) iFrom++;
2505                    if (iFrom < 256 && pDimensionRegions[iFrom]) {
2506                        pDimensionRegions[iTo]   = pDimensionRegions[iFrom];
2507                        pDimensionRegions[iFrom] = NULL;
2508                    }
2509                }
2510            }
2511    
2512            // 'remove' dimension definition
2513            for (int i = iDimensionNr + 1; i < Dimensions; i++) {
2514                pDimensionDefinitions[i - 1] = pDimensionDefinitions[i];
2515          }          }
2516            pDimensionDefinitions[Dimensions - 1].dimension = dimension_none;
2517            pDimensionDefinitions[Dimensions - 1].bits      = 0;
2518            pDimensionDefinitions[Dimensions - 1].zones     = 0;
2519    
2520            Dimensions--;
2521    
2522            // if this was a layer dimension, update 'Layers' attribute
2523            if (pDimDef->dimension == dimension_layer) Layers = 1;
2524        }
2525    
2526        Region::~Region() {
2527          for (int i = 0; i < 256; i++) {          for (int i = 0; i < 256; i++) {
2528              if (pDimensionRegions[i]) delete pDimensionRegions[i];              if (pDimensionRegions[i]) delete pDimensionRegions[i];
2529          }          }
# Line 1532  namespace { Line 2548  namespace {
2548       * @see             Dimensions       * @see             Dimensions
2549       */       */
2550      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {
2551          uint8_t bits[8] = { 0 };          uint8_t bits;
2552            int veldim = -1;
2553            int velbitpos;
2554            int bitpos = 0;
2555            int dimregidx = 0;
2556          for (uint i = 0; i < Dimensions; i++) {          for (uint i = 0; i < Dimensions; i++) {
2557              bits[i] = DimValues[i];              if (pDimensionDefinitions[i].dimension == dimension_velocity) {
2558              switch (pDimensionDefinitions[i].split_type) {                  // the velocity dimension must be handled after the other dimensions
2559                  case split_type_normal:                  veldim = i;
2560                      bits[i] /= pDimensionDefinitions[i].zone_size;                  velbitpos = bitpos;
2561                      break;              } else {
2562                  case split_type_customvelocity:                  switch (pDimensionDefinitions[i].split_type) {
2563                      bits[i] = VelocityTable[bits[i]];                      case split_type_normal:
2564                      break;                          if (pDimensionRegions[0]->DimensionUpperLimits[i]) {
2565                  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
2566                      const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;                              for (bits = 0 ; bits < pDimensionDefinitions[i].zones ; bits++) {
2567                      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;
2568                      break;                              }
2569              }                          } else {
2570                                // gig2: evenly sized zones
2571                                bits = uint8_t(DimValues[i] / pDimensionDefinitions[i].zone_size);
2572                            }
2573                            break;
2574                        case split_type_bit: // the value is already the sought dimension bit number
2575                            const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;
2576                            bits = DimValues[i] & limiter_mask; // just make sure the value doesn't use more bits than allowed
2577                            break;
2578                    }
2579                    dimregidx |= bits << bitpos;
2580                }
2581                bitpos += pDimensionDefinitions[i].bits;
2582            }
2583            DimensionRegion* dimreg = pDimensionRegions[dimregidx];
2584            if (veldim != -1) {
2585                // (dimreg is now the dimension region for the lowest velocity)
2586                if (dimreg->VelocityTable) // custom defined zone ranges
2587                    bits = dimreg->VelocityTable[DimValues[veldim]];
2588                else // normal split type
2589                    bits = uint8_t(DimValues[veldim] / pDimensionDefinitions[veldim].zone_size);
2590    
2591                dimregidx |= bits << velbitpos;
2592                dimreg = pDimensionRegions[dimregidx];
2593          }          }
2594          return GetDimensionRegionByBit(bits);          return dimreg;
2595      }      }
2596    
2597      /**      /**
# Line 1588  namespace { Line 2631  namespace {
2631      Sample* Region::GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress) {      Sample* Region::GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress) {
2632          if ((int32_t)WavePoolTableIndex == -1) return NULL;          if ((int32_t)WavePoolTableIndex == -1) return NULL;
2633          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
2634            if (!file->pWavePoolTable) return NULL;
2635          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
2636            unsigned long soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];
2637          Sample* sample = file->GetFirstSample(pProgress);          Sample* sample = file->GetFirstSample(pProgress);
2638          while (sample) {          while (sample) {
2639              if (sample->ulWavePoolOffset == soughtoffset) return static_cast<gig::Sample*>(pSample = sample);              if (sample->ulWavePoolOffset == soughtoffset &&
2640                    sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);
2641              sample = file->GetNextSample();              sample = file->GetNextSample();
2642          }          }
2643          return NULL;          return NULL;
# Line 1603  namespace { Line 2649  namespace {
2649  // *  // *
2650    
2651      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) {
2652            static const DLS::Info::FixedStringLength fixedStringLengths[] = {
2653                { CHUNK_ID_INAM, 64 },
2654                { CHUNK_ID_ISFT, 12 },
2655                { 0, 0 }
2656            };
2657            pInfo->FixedStringLengths = fixedStringLengths;
2658    
2659          // Initialization          // Initialization
2660          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;
2661          RegionIndex = -1;          EffectSend = 0;
2662            Attenuation = 0;
2663            FineTune = 0;
2664            PitchbendRange = 0;
2665            PianoReleaseMode = false;
2666            DimensionKeyRange.low = 0;
2667            DimensionKeyRange.high = 0;
2668    
2669          // Loading          // Loading
2670          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);
# Line 1621  namespace { Line 2680  namespace {
2680                  DimensionKeyRange.low  = dimkeystart >> 1;                  DimensionKeyRange.low  = dimkeystart >> 1;
2681                  DimensionKeyRange.high = _3ewg->ReadUint8();                  DimensionKeyRange.high = _3ewg->ReadUint8();
2682              }              }
             else throw gig::Exception("Mandatory <3ewg> chunk not found.");  
2683          }          }
         else throw gig::Exception("Mandatory <lart> list chunk not found.");  
2684    
2685            if (!pRegions) pRegions = new RegionList;
2686          RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);          RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);
2687          if (!lrgn) throw gig::Exception("Mandatory chunks in <ins > chunk not found.");          if (lrgn) {
2688          pRegions = new Region*[Regions];              RIFF::List* rgn = lrgn->GetFirstSubList();
2689          for (uint i = 0; i < Regions; i++) pRegions[i] = NULL;              while (rgn) {
2690          RIFF::List* rgn = lrgn->GetFirstSubList();                  if (rgn->GetListType() == LIST_TYPE_RGN) {
2691          unsigned int iRegion = 0;                      __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
2692          while (rgn) {                      pRegions->push_back(new Region(this, rgn));
2693              if (rgn->GetListType() == LIST_TYPE_RGN) {                  }
2694                  __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];  
2695              }              }
2696                // Creating Region Key Table for fast lookup
2697                UpdateRegionKeyTable();
2698          }          }
2699    
2700          __notify_progress(pProgress, 1.0f); // notify done          __notify_progress(pProgress, 1.0f); // notify done
2701      }      }
2702    
2703      Instrument::~Instrument() {      void Instrument::UpdateRegionKeyTable() {
2704          for (uint i = 0; i < Regions; i++) {          RegionList::iterator iter = pRegions->begin();
2705              if (pRegions) {          RegionList::iterator end  = pRegions->end();
2706                  if (pRegions[i]) delete (pRegions[i]);          for (; iter != end; ++iter) {
2707                gig::Region* pRegion = static_cast<gig::Region*>(*iter);
2708                for (int iKey = pRegion->KeyRange.low; iKey <= pRegion->KeyRange.high; iKey++) {
2709                    RegionKeyTable[iKey] = pRegion;
2710              }              }
2711          }          }
2712          if (pRegions) delete[] pRegions;      }
2713    
2714        Instrument::~Instrument() {
2715        }
2716    
2717        /**
2718         * Apply Instrument with all its Regions to the respective RIFF chunks.
2719         * You have to call File::Save() to make changes persistent.
2720         *
2721         * Usually there is absolutely no need to call this method explicitly.
2722         * It will be called automatically when File::Save() was called.
2723         *
2724         * @throws gig::Exception if samples cannot be dereferenced
2725         */
2726        void Instrument::UpdateChunks() {
2727            // first update base classes' chunks
2728            DLS::Instrument::UpdateChunks();
2729    
2730            // update Regions' chunks
2731            {
2732                RegionList::iterator iter = pRegions->begin();
2733                RegionList::iterator end  = pRegions->end();
2734                for (; iter != end; ++iter)
2735                    (*iter)->UpdateChunks();
2736            }
2737    
2738            // make sure 'lart' RIFF list chunk exists
2739            RIFF::List* lart = pCkInstrument->GetSubList(LIST_TYPE_LART);
2740            if (!lart)  lart = pCkInstrument->AddSubList(LIST_TYPE_LART);
2741            // make sure '3ewg' RIFF chunk exists
2742            RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);
2743            if (!_3ewg)  _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, 12);
2744            // update '3ewg' RIFF chunk
2745            uint8_t* pData = (uint8_t*) _3ewg->LoadChunkData();
2746            store16(&pData[0], EffectSend);
2747            store32(&pData[2], Attenuation);
2748            store16(&pData[6], FineTune);
2749            store16(&pData[8], PitchbendRange);
2750            const uint8_t dimkeystart = (PianoReleaseMode) ? 0x01 : 0x00 |
2751                                        DimensionKeyRange.low << 1;
2752            pData[10] = dimkeystart;
2753            pData[11] = DimensionKeyRange.high;
2754      }      }
2755    
2756      /**      /**
# Line 1667  namespace { Line 2761  namespace {
2761       *             there is no Region defined for the given \a Key       *             there is no Region defined for the given \a Key
2762       */       */
2763      Region* Instrument::GetRegion(unsigned int Key) {      Region* Instrument::GetRegion(unsigned int Key) {
2764          if (!pRegions || Key > 127) return NULL;          if (!pRegions || !pRegions->size() || Key > 127) return NULL;
2765          return RegionKeyTable[Key];          return RegionKeyTable[Key];
2766    
2767          /*for (int i = 0; i < Regions; i++) {          /*for (int i = 0; i < Regions; i++) {
2768              if (Key <= pRegions[i]->KeyRange.high &&              if (Key <= pRegions[i]->KeyRange.high &&
2769                  Key >= pRegions[i]->KeyRange.low) return pRegions[i];                  Key >= pRegions[i]->KeyRange.low) return pRegions[i];
# Line 1684  namespace { Line 2779  namespace {
2779       * @see      GetNextRegion()       * @see      GetNextRegion()
2780       */       */
2781      Region* Instrument::GetFirstRegion() {      Region* Instrument::GetFirstRegion() {
2782          if (!Regions) return NULL;          if (!pRegions) return NULL;
2783          RegionIndex = 1;          RegionsIterator = pRegions->begin();
2784          return pRegions[0];          return static_cast<gig::Region*>( (RegionsIterator != pRegions->end()) ? *RegionsIterator : NULL );
2785      }      }
2786    
2787      /**      /**
# Line 1698  namespace { Line 2793  namespace {
2793       * @see      GetFirstRegion()       * @see      GetFirstRegion()
2794       */       */
2795      Region* Instrument::GetNextRegion() {      Region* Instrument::GetNextRegion() {
2796          if (RegionIndex < 0 || uint32_t(RegionIndex) >= Regions) return NULL;          if (!pRegions) return NULL;
2797          return pRegions[RegionIndex++];          RegionsIterator++;
2798            return static_cast<gig::Region*>( (RegionsIterator != pRegions->end()) ? *RegionsIterator : NULL );
2799        }
2800    
2801        Region* Instrument::AddRegion() {
2802            // create new Region object (and its RIFF chunks)
2803            RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
2804            if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
2805            RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
2806            Region* pNewRegion = new Region(this, rgn);
2807            pRegions->push_back(pNewRegion);
2808            Regions = pRegions->size();
2809            // update Region key table for fast lookup
2810            UpdateRegionKeyTable();
2811            // done
2812            return pNewRegion;
2813        }
2814    
2815        void Instrument::DeleteRegion(Region* pRegion) {
2816            if (!pRegions) return;
2817            DLS::Instrument::DeleteRegion((DLS::Region*) pRegion);
2818            // update Region key table for fast lookup
2819            UpdateRegionKeyTable();
2820        }
2821    
2822    
2823    
2824    // *************** Group ***************
2825    // *
2826    
2827        /** @brief Constructor.
2828         *
2829         * @param file   - pointer to the gig::File object
2830         * @param ck3gnm - pointer to 3gnm chunk associated with this group or
2831         *                 NULL if this is a new Group
2832         */
2833        Group::Group(File* file, RIFF::Chunk* ck3gnm) {
2834            pFile      = file;
2835            pNameChunk = ck3gnm;
2836            ::LoadString(pNameChunk, Name);
2837        }
2838    
2839        Group::~Group() {
2840            // remove the chunk associated with this group (if any)
2841            if (pNameChunk) pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);
2842        }
2843    
2844        /** @brief Update chunks with current group settings.
2845         *
2846         * Apply current Group field values to the respective chunks. You have
2847         * to call File::Save() to make changes persistent.
2848         *
2849         * Usually there is absolutely no need to call this method explicitly.
2850         * It will be called automatically when File::Save() was called.
2851         */
2852        void Group::UpdateChunks() {
2853            // make sure <3gri> and <3gnl> list chunks exist
2854            RIFF::List* _3gri = pFile->pRIFF->GetSubList(LIST_TYPE_3GRI);
2855            if (!_3gri) {
2856                _3gri = pFile->pRIFF->AddSubList(LIST_TYPE_3GRI);
2857                pFile->pRIFF->MoveSubChunk(_3gri, pFile->pRIFF->GetSubChunk(CHUNK_ID_PTBL));
2858            }
2859            RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
2860            if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
2861            // now store the name of this group as <3gnm> chunk as subchunk of the <3gnl> list chunk
2862            ::SaveString(CHUNK_ID_3GNM, pNameChunk, _3gnl, Name, String("Unnamed Group"), true, 64);
2863        }
2864    
2865        /**
2866         * Returns the first Sample of this Group. You have to call this method
2867         * once before you use GetNextSample().
2868         *
2869         * <b>Notice:</b> this method might block for a long time, in case the
2870         * samples of this .gig file were not scanned yet
2871         *
2872         * @returns  pointer address to first Sample or NULL if there is none
2873         *           applied to this Group
2874         * @see      GetNextSample()
2875         */
2876        Sample* Group::GetFirstSample() {
2877            // FIXME: lazy und unsafe implementation, should be an autonomous iterator
2878            for (Sample* pSample = pFile->GetFirstSample(); pSample; pSample = pFile->GetNextSample()) {
2879                if (pSample->GetGroup() == this) return pSample;
2880            }
2881            return NULL;
2882        }
2883    
2884        /**
2885         * Returns the next Sample of the Group. You have to call
2886         * GetFirstSample() once before you can use this method. By calling this
2887         * method multiple times it iterates through the Samples assigned to
2888         * this Group.
2889         *
2890         * @returns  pointer address to the next Sample of this Group or NULL if
2891         *           end reached
2892         * @see      GetFirstSample()
2893         */
2894        Sample* Group::GetNextSample() {
2895            // FIXME: lazy und unsafe implementation, should be an autonomous iterator
2896            for (Sample* pSample = pFile->GetNextSample(); pSample; pSample = pFile->GetNextSample()) {
2897                if (pSample->GetGroup() == this) return pSample;
2898            }
2899            return NULL;
2900        }
2901    
2902        /**
2903         * Move Sample given by \a pSample from another Group to this Group.
2904         */
2905        void Group::AddSample(Sample* pSample) {
2906            pSample->pGroup = this;
2907        }
2908    
2909        /**
2910         * Move all members of this group to another group (preferably the 1st
2911         * one except this). This method is called explicitly by
2912         * File::DeleteGroup() thus when a Group was deleted. This code was
2913         * intentionally not placed in the destructor!
2914         */
2915        void Group::MoveAll() {
2916            // get "that" other group first
2917            Group* pOtherGroup = NULL;
2918            for (pOtherGroup = pFile->GetFirstGroup(); pOtherGroup; pOtherGroup = pFile->GetNextGroup()) {
2919                if (pOtherGroup != this) break;
2920            }
2921            if (!pOtherGroup) throw Exception(
2922                "Could not move samples to another group, since there is no "
2923                "other Group. This is a bug, report it!"
2924            );
2925            // now move all samples of this group to the other group
2926            for (Sample* pSample = GetFirstSample(); pSample; pSample = GetNextSample()) {
2927                pOtherGroup->AddSample(pSample);
2928            }
2929      }      }
2930    
2931    
# Line 1707  namespace { Line 2933  namespace {
2933  // *************** File ***************  // *************** File ***************
2934  // *  // *
2935    
2936        // File version 2.0, 1998-06-28
2937        const DLS::version_t File::VERSION_2 = {
2938            0, 2, 19980628 & 0xffff, 19980628 >> 16
2939        };
2940    
2941        // File version 3.0, 2003-03-31
2942        const DLS::version_t File::VERSION_3 = {
2943            0, 3, 20030331 & 0xffff, 20030331 >> 16
2944        };
2945    
2946        const DLS::Info::FixedStringLength File::FixedStringLengths[] = {
2947            { CHUNK_ID_IARL, 256 },
2948            { CHUNK_ID_IART, 128 },
2949            { CHUNK_ID_ICMS, 128 },
2950            { CHUNK_ID_ICMT, 1024 },
2951            { CHUNK_ID_ICOP, 128 },
2952            { CHUNK_ID_ICRD, 128 },
2953            { CHUNK_ID_IENG, 128 },
2954            { CHUNK_ID_IGNR, 128 },
2955            { CHUNK_ID_IKEY, 128 },
2956            { CHUNK_ID_IMED, 128 },
2957            { CHUNK_ID_INAM, 128 },
2958            { CHUNK_ID_IPRD, 128 },
2959            { CHUNK_ID_ISBJ, 128 },
2960            { CHUNK_ID_ISFT, 128 },
2961            { CHUNK_ID_ISRC, 128 },
2962            { CHUNK_ID_ISRF, 128 },
2963            { CHUNK_ID_ITCH, 128 },
2964            { 0, 0 }
2965        };
2966    
2967        File::File() : DLS::File() {
2968            pGroups = NULL;
2969            pInfo->FixedStringLengths = FixedStringLengths;
2970            pInfo->ArchivalLocation = String(256, ' ');
2971    
2972            // add some mandatory chunks to get the file chunks in right
2973            // order (INFO chunk will be moved to first position later)
2974            pRIFF->AddSubChunk(CHUNK_ID_VERS, 8);
2975            pRIFF->AddSubChunk(CHUNK_ID_COLH, 4);
2976            pRIFF->AddSubChunk(CHUNK_ID_DLID, 16);
2977    
2978            GenerateDLSID();
2979        }
2980    
2981      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {
2982          pSamples     = NULL;          pGroups = NULL;
2983          pInstruments = NULL;          pInfo->FixedStringLengths = FixedStringLengths;
2984      }      }
2985    
2986      File::~File() {      File::~File() {
2987          // free samples          if (pGroups) {
2988          if (pSamples) {              std::list<Group*>::iterator iter = pGroups->begin();
2989              SamplesIterator = pSamples->begin();              std::list<Group*>::iterator end  = pGroups->end();
2990              while (SamplesIterator != pSamples->end() ) {              while (iter != end) {
2991                  delete (*SamplesIterator);                  delete *iter;
2992                  SamplesIterator++;                  ++iter;
             }  
             pSamples->clear();  
             delete pSamples;  
   
         }  
         // free instruments  
         if (pInstruments) {  
             InstrumentsIterator = pInstruments->begin();  
             while (InstrumentsIterator != pInstruments->end() ) {  
                 delete (*InstrumentsIterator);  
                 InstrumentsIterator++;  
2993              }              }
2994              pInstruments->clear();              delete pGroups;
             delete pInstruments;  
2995          }          }
2996      }      }
2997    
# Line 1749  namespace { Line 3008  namespace {
3008          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
3009      }      }
3010    
3011        /** @brief Add a new sample.
3012         *
3013         * This will create a new Sample object for the gig file. You have to
3014         * call Save() to make this persistent to the file.
3015         *
3016         * @returns pointer to new Sample object
3017         */
3018        Sample* File::AddSample() {
3019           if (!pSamples) LoadSamples();
3020           __ensureMandatoryChunksExist();
3021           RIFF::List* wvpl = pRIFF->GetSubList(LIST_TYPE_WVPL);
3022           // create new Sample object and its respective 'wave' list chunk
3023           RIFF::List* wave = wvpl->AddSubList(LIST_TYPE_WAVE);
3024           Sample* pSample = new Sample(this, wave, 0 /*arbitrary value, we update offsets when we save*/);
3025    
3026           // add mandatory chunks to get the chunks in right order
3027           wave->AddSubChunk(CHUNK_ID_FMT, 16);
3028           wave->AddSubList(LIST_TYPE_INFO);
3029    
3030           pSamples->push_back(pSample);
3031           return pSample;
3032        }
3033    
3034        /** @brief Delete a sample.
3035         *
3036         * This will delete the given Sample object from the gig file. You have
3037         * to call Save() to make this persistent to the file.
3038         *
3039         * @param pSample - sample to delete
3040         * @throws gig::Exception if given sample could not be found
3041         */
3042        void File::DeleteSample(Sample* pSample) {
3043            if (!pSamples || !pSamples->size()) throw gig::Exception("Could not delete sample as there are no samples");
3044            SampleList::iterator iter = find(pSamples->begin(), pSamples->end(), (DLS::Sample*) pSample);
3045            if (iter == pSamples->end()) throw gig::Exception("Could not delete sample, could not find given sample");
3046            if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation
3047            pSamples->erase(iter);
3048            delete pSample;
3049        }
3050    
3051        void File::LoadSamples() {
3052            LoadSamples(NULL);
3053        }
3054    
3055      void File::LoadSamples(progress_t* pProgress) {      void File::LoadSamples(progress_t* pProgress) {
3056          RIFF::List* wvpl = pRIFF->GetSubList(LIST_TYPE_WVPL);          // Groups must be loaded before samples, because samples will try
3057          if (wvpl) {          // to resolve the group they belong to
3058              // just for progress calculation          if (!pGroups) LoadGroups();
3059              int iSampleIndex  = 0;  
3060              int iTotalSamples = wvpl->CountSubLists(LIST_TYPE_WAVE);          if (!pSamples) pSamples = new SampleList;
3061    
3062              unsigned long wvplFileOffset = wvpl->GetFilePos();          RIFF::File* file = pRIFF;
3063              RIFF::List* wave = wvpl->GetFirstSubList();  
3064              while (wave) {          // just for progress calculation
3065                  if (wave->GetListType() == LIST_TYPE_WAVE) {          int iSampleIndex  = 0;
3066                      // notify current progress          int iTotalSamples = WavePoolCount;
3067                      const float subprogress = (float) iSampleIndex / (float) iTotalSamples;  
3068                      __notify_progress(pProgress, subprogress);          // check if samples should be loaded from extension files
3069            int lastFileNo = 0;
3070            for (int i = 0 ; i < WavePoolCount ; i++) {
3071                if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];
3072            }
3073            String name(pRIFF->GetFileName());
3074            int nameLen = name.length();
3075            char suffix[6];
3076            if (nameLen > 4 && name.substr(nameLen - 4) == ".gig") nameLen -= 4;
3077    
3078            for (int fileNo = 0 ; ; ) {
3079                RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);
3080                if (wvpl) {
3081                    unsigned long wvplFileOffset = wvpl->GetFilePos();
3082                    RIFF::List* wave = wvpl->GetFirstSubList();
3083                    while (wave) {
3084                        if (wave->GetListType() == LIST_TYPE_WAVE) {
3085                            // notify current progress
3086                            const float subprogress = (float) iSampleIndex / (float) iTotalSamples;
3087                            __notify_progress(pProgress, subprogress);
3088    
3089                      if (!pSamples) pSamples = new SampleList;                          unsigned long waveFileOffset = wave->GetFilePos();
3090                      unsigned long waveFileOffset = wave->GetFilePos();                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));
                     pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset));  
3091    
3092                      iSampleIndex++;                          iSampleIndex++;
3093                        }
3094                        wave = wvpl->GetNextSubList();
3095                  }                  }
3096                  wave = wvpl->GetNextSubList();  
3097              }                  if (fileNo == lastFileNo) break;
3098              __notify_progress(pProgress, 1.0); // notify done  
3099                    // open extension file (*.gx01, *.gx02, ...)
3100                    fileNo++;
3101                    sprintf(suffix, ".gx%02d", fileNo);
3102                    name.replace(nameLen, 5, suffix);
3103                    file = new RIFF::File(name);
3104                    ExtensionFiles.push_back(file);
3105                } else break;
3106          }          }
3107          else throw gig::Exception("Mandatory <wvpl> chunk not found.");  
3108            __notify_progress(pProgress, 1.0); // notify done
3109      }      }
3110    
3111      Instrument* File::GetFirstInstrument() {      Instrument* File::GetFirstInstrument() {
3112          if (!pInstruments) LoadInstruments();          if (!pInstruments) LoadInstruments();
3113          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
3114          InstrumentsIterator = pInstruments->begin();          InstrumentsIterator = pInstruments->begin();
3115          return (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL;          return static_cast<gig::Instrument*>( (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL );
3116      }      }
3117    
3118      Instrument* File::GetNextInstrument() {      Instrument* File::GetNextInstrument() {
3119          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
3120          InstrumentsIterator++;          InstrumentsIterator++;
3121          return (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL;          return static_cast<gig::Instrument*>( (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL );
3122      }      }
3123    
3124      /**      /**
# Line 1820  namespace { Line 3151  namespace {
3151          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
3152          InstrumentsIterator = pInstruments->begin();          InstrumentsIterator = pInstruments->begin();
3153          for (uint i = 0; InstrumentsIterator != pInstruments->end(); i++) {          for (uint i = 0; InstrumentsIterator != pInstruments->end(); i++) {
3154              if (i == index) return *InstrumentsIterator;              if (i == index) return static_cast<gig::Instrument*>( *InstrumentsIterator );
3155              InstrumentsIterator++;              InstrumentsIterator++;
3156          }          }
3157          return NULL;          return NULL;
3158      }      }
3159    
3160        /** @brief Add a new instrument definition.
3161         *
3162         * This will create a new Instrument object for the gig file. You have
3163         * to call Save() to make this persistent to the file.
3164         *
3165         * @returns pointer to new Instrument object
3166         */
3167        Instrument* File::AddInstrument() {
3168           if (!pInstruments) LoadInstruments();
3169           __ensureMandatoryChunksExist();
3170           RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
3171           RIFF::List* lstInstr = lstInstruments->AddSubList(LIST_TYPE_INS);
3172    
3173           // add mandatory chunks to get the chunks in right order
3174           lstInstr->AddSubList(LIST_TYPE_INFO);
3175           lstInstr->AddSubChunk(CHUNK_ID_DLID, 16);
3176    
3177           Instrument* pInstrument = new Instrument(this, lstInstr);
3178           pInstrument->GenerateDLSID();
3179    
3180           lstInstr->AddSubChunk(CHUNK_ID_INSH, 12);
3181    
3182           // this string is needed for the gig to be loadable in GSt:
3183           pInstrument->pInfo->Software = "Endless Wave";
3184    
3185           pInstruments->push_back(pInstrument);
3186           return pInstrument;
3187        }
3188    
3189        /** @brief Delete an instrument.
3190         *
3191         * This will delete the given Instrument object from the gig file. You
3192         * have to call Save() to make this persistent to the file.
3193         *
3194         * @param pInstrument - instrument to delete
3195         * @throws gig::Exception if given instrument could not be found
3196         */
3197        void File::DeleteInstrument(Instrument* pInstrument) {
3198            if (!pInstruments) throw gig::Exception("Could not delete instrument as there are no instruments");
3199            InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), (DLS::Instrument*) pInstrument);
3200            if (iter == pInstruments->end()) throw gig::Exception("Could not delete instrument, could not find given instrument");
3201            pInstruments->erase(iter);
3202            delete pInstrument;
3203        }
3204    
3205        void File::LoadInstruments() {
3206            LoadInstruments(NULL);
3207        }
3208    
3209      void File::LoadInstruments(progress_t* pProgress) {      void File::LoadInstruments(progress_t* pProgress) {
3210            if (!pInstruments) pInstruments = new InstrumentList;
3211          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
3212          if (lstInstruments) {          if (lstInstruments) {
3213              int iInstrumentIndex = 0;              int iInstrumentIndex = 0;
# Line 1841  namespace { Line 3222  namespace {
3222                      progress_t subprogress;                      progress_t subprogress;
3223                      __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);                      __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);
3224    
                     if (!pInstruments) pInstruments = new InstrumentList;  
3225                      pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));                      pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));
3226    
3227                      iInstrumentIndex++;                      iInstrumentIndex++;
# Line 1850  namespace { Line 3230  namespace {
3230              }              }
3231              __notify_progress(pProgress, 1.0); // notify done              __notify_progress(pProgress, 1.0); // notify done
3232          }          }
3233          else throw gig::Exception("Mandatory <lins> list chunk not found.");      }
3234    
3235        /// Updates the 3crc chunk with the checksum of a sample. The
3236        /// update is done directly to disk, as this method is called
3237        /// after File::Save()
3238        void File::SetSampleChecksum(Sample* pSample, uint32_t crc) {
3239            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
3240            if (!_3crc) return;
3241    
3242            // get the index of the sample
3243            int iWaveIndex = -1;
3244            File::SampleList::iterator iter = pSamples->begin();
3245            File::SampleList::iterator end  = pSamples->end();
3246            for (int index = 0; iter != end; ++iter, ++index) {
3247                if (*iter == pSample) {
3248                    iWaveIndex = index;
3249                    break;
3250                }
3251            }
3252            if (iWaveIndex < 0) throw gig::Exception("Could not update crc, could not find sample");
3253    
3254            // write the CRC-32 checksum to disk
3255            _3crc->SetPos(iWaveIndex * 8);
3256            uint32_t tmp = 1;
3257            _3crc->WriteUint32(&tmp); // unknown, always 1?
3258            _3crc->WriteUint32(&crc);
3259        }
3260    
3261        Group* File::GetFirstGroup() {
3262            if (!pGroups) LoadGroups();
3263            // there must always be at least one group
3264            GroupsIterator = pGroups->begin();
3265            return *GroupsIterator;
3266        }
3267    
3268        Group* File::GetNextGroup() {
3269            if (!pGroups) return NULL;
3270            ++GroupsIterator;
3271            return (GroupsIterator == pGroups->end()) ? NULL : *GroupsIterator;
3272        }
3273    
3274        /**
3275         * Returns the group with the given index.
3276         *
3277         * @param index - number of the sought group (0..n)
3278         * @returns sought group or NULL if there's no such group
3279         */
3280        Group* File::GetGroup(uint index) {
3281            if (!pGroups) LoadGroups();
3282            GroupsIterator = pGroups->begin();
3283            for (uint i = 0; GroupsIterator != pGroups->end(); i++) {
3284                if (i == index) return *GroupsIterator;
3285                ++GroupsIterator;
3286            }
3287            return NULL;
3288        }
3289    
3290        Group* File::AddGroup() {
3291            if (!pGroups) LoadGroups();
3292            // there must always be at least one group
3293            __ensureMandatoryChunksExist();
3294            Group* pGroup = new Group(this, NULL);
3295            pGroups->push_back(pGroup);
3296            return pGroup;
3297        }
3298    
3299        /** @brief Delete a group and its samples.
3300         *
3301         * This will delete the given Group object and all the samples that
3302         * belong to this group from the gig file. You have to call Save() to
3303         * make this persistent to the file.
3304         *
3305         * @param pGroup - group to delete
3306         * @throws gig::Exception if given group could not be found
3307         */
3308        void File::DeleteGroup(Group* pGroup) {
3309            if (!pGroups) LoadGroups();
3310            std::list<Group*>::iterator iter = find(pGroups->begin(), pGroups->end(), pGroup);
3311            if (iter == pGroups->end()) throw gig::Exception("Could not delete group, could not find given group");
3312            if (pGroups->size() == 1) throw gig::Exception("Cannot delete group, there must be at least one default group!");
3313            // delete all members of this group
3314            for (Sample* pSample = pGroup->GetFirstSample(); pSample; pSample = pGroup->GetNextSample()) {
3315                DeleteSample(pSample);
3316            }
3317            // now delete this group object
3318            pGroups->erase(iter);
3319            delete pGroup;
3320        }
3321    
3322        /** @brief Delete a group.
3323         *
3324         * This will delete the given Group object from the gig file. All the
3325         * samples that belong to this group will not be deleted, but instead
3326         * be moved to another group. You have to call Save() to make this
3327         * persistent to the file.
3328         *
3329         * @param pGroup - group to delete
3330         * @throws gig::Exception if given group could not be found
3331         */
3332        void File::DeleteGroupOnly(Group* pGroup) {
3333            if (!pGroups) LoadGroups();
3334            std::list<Group*>::iterator iter = find(pGroups->begin(), pGroups->end(), pGroup);
3335            if (iter == pGroups->end()) throw gig::Exception("Could not delete group, could not find given group");
3336            if (pGroups->size() == 1) throw gig::Exception("Cannot delete group, there must be at least one default group!");
3337            // move all members of this group to another group
3338            pGroup->MoveAll();
3339            pGroups->erase(iter);
3340            delete pGroup;
3341        }
3342    
3343        void File::LoadGroups() {
3344            if (!pGroups) pGroups = new std::list<Group*>;
3345            // try to read defined groups from file
3346            RIFF::List* lst3gri = pRIFF->GetSubList(LIST_TYPE_3GRI);
3347            if (lst3gri) {
3348                RIFF::List* lst3gnl = lst3gri->GetSubList(LIST_TYPE_3GNL);
3349                if (lst3gnl) {
3350                    RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();
3351                    while (ck) {
3352                        if (ck->GetChunkID() == CHUNK_ID_3GNM) {
3353                            pGroups->push_back(new Group(this, ck));
3354                        }
3355                        ck = lst3gnl->GetNextSubChunk();
3356                    }
3357                }
3358            }
3359            // if there were no group(s), create at least the mandatory default group
3360            if (!pGroups->size()) {
3361                Group* pGroup = new Group(this, NULL);
3362                pGroup->Name = "Default Group";
3363                pGroups->push_back(pGroup);
3364            }
3365        }
3366    
3367        /**
3368         * Apply all the gig file's current instruments, samples, groups and settings
3369         * to the respective RIFF chunks. You have to call Save() to make changes
3370         * persistent.
3371         *
3372         * Usually there is absolutely no need to call this method explicitly.
3373         * It will be called automatically when File::Save() was called.
3374         *
3375         * @throws Exception - on errors
3376         */
3377        void File::UpdateChunks() {
3378            bool newFile = pRIFF->GetSubList(LIST_TYPE_INFO) == NULL;
3379    
3380            // first update base class's chunks
3381            DLS::File::UpdateChunks();
3382    
3383            if (newFile) {
3384                // INFO was added by Resource::UpdateChunks - make sure it
3385                // is placed first in file
3386                RIFF::Chunk* info = pRIFF->GetSubList(LIST_TYPE_INFO);
3387                RIFF::Chunk* first = pRIFF->GetFirstSubChunk();
3388                if (first != info) {
3389                    pRIFF->MoveSubChunk(info, first);
3390                }
3391            }
3392    
3393            // update group's chunks
3394            if (pGroups) {
3395                std::list<Group*>::iterator iter = pGroups->begin();
3396                std::list<Group*>::iterator end  = pGroups->end();
3397                for (; iter != end; ++iter) {
3398                    (*iter)->UpdateChunks();
3399                }
3400            }
3401    
3402            // update einf chunk
3403    
3404            // The einf chunk contains statistics about the gig file, such
3405            // as the number of regions and samples used by each
3406            // instrument. It is divided in equally sized parts, where the
3407            // first part contains information about the whole gig file,
3408            // and the rest of the parts map to each instrument in the
3409            // file.
3410            //
3411            // At the end of each part there is a bit map of each sample
3412            // in the file, where a set bit means that the sample is used
3413            // by the file/instrument.
3414            //
3415            // Note that there are several fields with unknown use. These
3416            // are set to zero.
3417    
3418            int sublen = pSamples->size() / 8 + 49;
3419            int einfSize = (Instruments + 1) * sublen;
3420    
3421            RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
3422            if (einf) {
3423                if (einf->GetSize() != einfSize) {
3424                    einf->Resize(einfSize);
3425                    memset(einf->LoadChunkData(), 0, einfSize);
3426                }
3427            } else if (newFile) {
3428                einf = pRIFF->AddSubChunk(CHUNK_ID_EINF, einfSize);
3429            }
3430            if (einf) {
3431                uint8_t* pData = (uint8_t*) einf->LoadChunkData();
3432    
3433                std::map<gig::Sample*,int> sampleMap;
3434                int sampleIdx = 0;
3435                for (Sample* pSample = GetFirstSample(); pSample; pSample = GetNextSample()) {
3436                    sampleMap[pSample] = sampleIdx++;
3437                }
3438    
3439                int totnbusedsamples = 0;
3440                int totnbusedchannels = 0;
3441                int totnbregions = 0;
3442                int totnbdimregions = 0;
3443                int instrumentIdx = 0;
3444    
3445                memset(&pData[48], 0, sublen - 48);
3446    
3447                for (Instrument* instrument = GetFirstInstrument() ; instrument ;
3448                     instrument = GetNextInstrument()) {
3449                    int nbusedsamples = 0;
3450                    int nbusedchannels = 0;
3451                    int nbdimregions = 0;
3452    
3453                    memset(&pData[(instrumentIdx + 1) * sublen + 48], 0, sublen - 48);
3454    
3455                    for (Region* region = instrument->GetFirstRegion() ; region ;
3456                         region = instrument->GetNextRegion()) {
3457                        for (int i = 0 ; i < region->DimensionRegions ; i++) {
3458                            gig::DimensionRegion *d = region->pDimensionRegions[i];
3459                            if (d->pSample) {
3460                                int sampleIdx = sampleMap[d->pSample];
3461                                int byte = 48 + sampleIdx / 8;
3462                                int bit = 1 << (sampleIdx & 7);
3463                                if ((pData[(instrumentIdx + 1) * sublen + byte] & bit) == 0) {
3464                                    pData[(instrumentIdx + 1) * sublen + byte] |= bit;
3465                                    nbusedsamples++;
3466                                    nbusedchannels += d->pSample->Channels;
3467    
3468                                    if ((pData[byte] & bit) == 0) {
3469                                        pData[byte] |= bit;
3470                                        totnbusedsamples++;
3471                                        totnbusedchannels += d->pSample->Channels;
3472                                    }
3473                                }
3474                            }
3475                        }
3476                        nbdimregions += region->DimensionRegions;
3477                    }
3478                    // first 4 bytes unknown - sometimes 0, sometimes length of einf part
3479                    // store32(&pData[(instrumentIdx + 1) * sublen], sublen);
3480                    store32(&pData[(instrumentIdx + 1) * sublen + 4], nbusedchannels);
3481                    store32(&pData[(instrumentIdx + 1) * sublen + 8], nbusedsamples);
3482                    store32(&pData[(instrumentIdx + 1) * sublen + 12], 1);
3483                    store32(&pData[(instrumentIdx + 1) * sublen + 16], instrument->Regions);
3484                    store32(&pData[(instrumentIdx + 1) * sublen + 20], nbdimregions);
3485                    // next 12 bytes unknown
3486                    store32(&pData[(instrumentIdx + 1) * sublen + 36], instrumentIdx);
3487                    store32(&pData[(instrumentIdx + 1) * sublen + 40], pSamples->size());
3488                    // next 4 bytes unknown
3489    
3490                    totnbregions += instrument->Regions;
3491                    totnbdimregions += nbdimregions;
3492                    instrumentIdx++;
3493                }
3494                // first 4 bytes unknown - sometimes 0, sometimes length of einf part
3495                // store32(&pData[0], sublen);
3496                store32(&pData[4], totnbusedchannels);
3497                store32(&pData[8], totnbusedsamples);
3498                store32(&pData[12], Instruments);
3499                store32(&pData[16], totnbregions);
3500                store32(&pData[20], totnbdimregions);
3501                // next 12 bytes unknown
3502                // next 4 bytes unknown, always 0?
3503                store32(&pData[40], pSamples->size());
3504                // next 4 bytes unknown
3505            }
3506    
3507            // update 3crc chunk
3508    
3509            // The 3crc chunk contains CRC-32 checksums for the
3510            // samples. The actual checksum values will be filled in
3511            // later, by Sample::Write.
3512    
3513            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
3514            if (_3crc) {
3515                _3crc->Resize(pSamples->size() * 8);
3516            } else if (newFile) {
3517                _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
3518                _3crc->LoadChunkData();
3519            }
3520      }      }
3521    
3522    

Legend:
Removed from v.518  
changed lines
  Added in v.1209

  ViewVC Help
Powered by ViewVC