/[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 406 by persson, Wed Feb 23 19:11:07 2005 UTC revision 1875 by schoenebeck, Thu Mar 26 13:32:59 2009 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-2009 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 <algorithm>
29    #include <math.h>
30  #include <iostream>  #include <iostream>
31    
32  namespace gig { namespace {  /// Initial size of the sample buffer which is used for decompression of
33    /// compressed sample wave streams - this value should always be bigger than
34    /// the biggest sample piece expected to be read by the sampler engine,
35    /// otherwise the buffer size will be raised at runtime and thus the buffer
36    /// reallocated which is time consuming and unefficient.
37    #define INITIAL_SAMPLE_BUFFER_SIZE              512000 // 512 kB
38    
39    /** (so far) every exponential paramater in the gig format has a basis of 1.000000008813822 */
40    #define GIG_EXP_DECODE(x)                       (pow(1.000000008813822, x))
41    #define GIG_EXP_ENCODE(x)                       (log(x) / log(1.000000008813822))
42    #define GIG_PITCH_TRACK_EXTRACT(x)              (!(x & 0x01))
43    #define GIG_PITCH_TRACK_ENCODE(x)               ((x) ? 0x00 : 0x01)
44    #define GIG_VCF_RESONANCE_CTRL_EXTRACT(x)       ((x >> 4) & 0x03)
45    #define GIG_VCF_RESONANCE_CTRL_ENCODE(x)        ((x & 0x03) << 4)
46    #define GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(x)  ((x >> 1) & 0x03)
47    #define GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(x)   ((x >> 3) & 0x03)
48    #define GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(x) ((x >> 5) & 0x03)
49    #define GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(x)   ((x & 0x03) << 1)
50    #define GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(x)    ((x & 0x03) << 3)
51    #define GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(x)  ((x & 0x03) << 5)
52    
53    namespace gig {
54    
55    // *************** progress_t ***************
56    // *
57    
58        progress_t::progress_t() {
59            callback    = NULL;
60            custom      = NULL;
61            __range_min = 0.0f;
62            __range_max = 1.0f;
63        }
64    
65        // private helper function to convert progress of a subprocess into the global progress
66        static void __notify_progress(progress_t* pProgress, float subprogress) {
67            if (pProgress && pProgress->callback) {
68                const float totalrange    = pProgress->__range_max - pProgress->__range_min;
69                const float totalprogress = pProgress->__range_min + subprogress * totalrange;
70                pProgress->factor         = totalprogress;
71                pProgress->callback(pProgress); // now actually notify about the progress
72            }
73        }
74    
75        // private helper function to divide a progress into subprogresses
76        static void __divide_progress(progress_t* pParentProgress, progress_t* pSubProgress, float totalTasks, float currentTask) {
77            if (pParentProgress && pParentProgress->callback) {
78                const float totalrange    = pParentProgress->__range_max - pParentProgress->__range_min;
79                pSubProgress->callback    = pParentProgress->callback;
80                pSubProgress->custom      = pParentProgress->custom;
81                pSubProgress->__range_min = pParentProgress->__range_min + totalrange * currentTask / totalTasks;
82                pSubProgress->__range_max = pSubProgress->__range_min + totalrange / totalTasks;
83            }
84        }
85    
86  // *************** Internal functions for sample decopmression ***************  
87    // *************** Internal functions for sample decompression ***************
88  // *  // *
89    
90    namespace {
91    
92      inline int get12lo(const unsigned char* pSrc)      inline int get12lo(const unsigned char* pSrc)
93      {      {
94          const int x = pSrc[0] | (pSrc[1] & 0x0f) << 8;          const int x = pSrc[0] | (pSrc[1] & 0x0f) << 8;
# Line 53  namespace gig { namespace { Line 112  namespace gig { namespace {
112          return x & 0x800000 ? x - 0x1000000 : x;          return x & 0x800000 ? x - 0x1000000 : x;
113      }      }
114    
115        inline void store24(unsigned char* pDst, int x)
116        {
117            pDst[0] = x;
118            pDst[1] = x >> 8;
119            pDst[2] = x >> 16;
120        }
121    
122      void Decompress16(int compressionmode, const unsigned char* params,      void Decompress16(int compressionmode, const unsigned char* params,
123                        int srcStep, int dstStep,                        int srcStep, int dstStep,
124                        const unsigned char* pSrc, int16_t* pDst,                        const unsigned char* pSrc, int16_t* pDst,
# Line 92  namespace gig { namespace { Line 158  namespace gig { namespace {
158      }      }
159    
160      void Decompress24(int compressionmode, const unsigned char* params,      void Decompress24(int compressionmode, const unsigned char* params,
161                        int dstStep, const unsigned char* pSrc, int16_t* pDst,                        int dstStep, const unsigned char* pSrc, uint8_t* pDst,
162                        unsigned long currentframeoffset,                        unsigned long currentframeoffset,
163                        unsigned long copysamples)                        unsigned long copysamples, int truncatedBits)
164      {      {
165          // Note: The 24 bits are truncated to 16 bits for now.          int y, dy, ddy, dddy;
166    
167          // Note: The calculation of the initial value of y is strange  #define GET_PARAMS(params)                      \
168          // and not 100% correct. What should the first two parameters          y    = get24(params);                   \
169          // really be used for? Why are they two? The correct value for          dy   = y - get24((params) + 3);         \
170          // y seems to lie somewhere between the values of the first          ddy  = get24((params) + 6);             \
171          // 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 9 steps instead of 8, and also why y is  
         // initialized with a sum instead of a mean value.  
   
         int y, dy, ddy;  
   
 #define GET_PARAMS(params)                              \  
         y = (get24(params) + get24((params) + 3));      \  
         dy  = get24((params) + 6);                      \  
         ddy = get24((params) + 9)  
172    
173  #define SKIP_ONE(x)                             \  #define SKIP_ONE(x)                             \
174          ddy -= (x);                             \          dddy -= (x);                            \
175          dy -= ddy;                              \          ddy  -= dddy;                           \
176          y -= dy          dy   =  -dy - ddy;                      \
177            y    += dy
178    
179  #define COPY_ONE(x)                             \  #define COPY_ONE(x)                             \
180          SKIP_ONE(x);                            \          SKIP_ONE(x);                            \
181          *pDst = y >> 9;                         \          store24(pDst, y << truncatedBits);      \
182          pDst += dstStep          pDst += dstStep
183    
184          switch (compressionmode) {          switch (compressionmode) {
185              case 2: // 24 bit uncompressed              case 2: // 24 bit uncompressed
186                  pSrc += currentframeoffset * 3;                  pSrc += currentframeoffset * 3;
187                  while (copysamples) {                  while (copysamples) {
188                      *pDst = get24(pSrc) >> 8;                      store24(pDst, get24(pSrc) << truncatedBits);
189                      pDst += dstStep;                      pDst += dstStep;
190                      pSrc += 3;                      pSrc += 3;
191                      copysamples--;                      copysamples--;
# Line 200  namespace gig { namespace { Line 255  namespace gig { namespace {
255  }  }
256    
257    
258    
259    // *************** Internal CRC-32 (Cyclic Redundancy Check) functions  ***************
260    // *
261    
262        static uint32_t* __initCRCTable() {
263            static uint32_t res[256];
264    
265            for (int i = 0 ; i < 256 ; i++) {
266                uint32_t c = i;
267                for (int j = 0 ; j < 8 ; j++) {
268                    c = (c & 1) ? 0xedb88320 ^ (c >> 1) : c >> 1;
269                }
270                res[i] = c;
271            }
272            return res;
273        }
274    
275        static const uint32_t* __CRCTable = __initCRCTable();
276    
277        /**
278         * Initialize a CRC variable.
279         *
280         * @param crc - variable to be initialized
281         */
282        inline static void __resetCRC(uint32_t& crc) {
283            crc = 0xffffffff;
284        }
285    
286        /**
287         * Used to calculate checksums of the sample data in a gig file. The
288         * checksums are stored in the 3crc chunk of the gig file and
289         * automatically updated when a sample is written with Sample::Write().
290         *
291         * One should call __resetCRC() to initialize the CRC variable to be
292         * used before calling this function the first time.
293         *
294         * After initializing the CRC variable one can call this function
295         * arbitrary times, i.e. to split the overall CRC calculation into
296         * steps.
297         *
298         * Once the whole data was processed by __calculateCRC(), one should
299         * call __encodeCRC() to get the final CRC result.
300         *
301         * @param buf     - pointer to data the CRC shall be calculated of
302         * @param bufSize - size of the data to be processed
303         * @param crc     - variable the CRC sum shall be stored to
304         */
305        static void __calculateCRC(unsigned char* buf, int bufSize, uint32_t& crc) {
306            for (int i = 0 ; i < bufSize ; i++) {
307                crc = __CRCTable[(crc ^ buf[i]) & 0xff] ^ (crc >> 8);
308            }
309        }
310    
311        /**
312         * Returns the final CRC result.
313         *
314         * @param crc - variable previously passed to __calculateCRC()
315         */
316        inline static uint32_t __encodeCRC(const uint32_t& crc) {
317            return crc ^ 0xffffffff;
318        }
319    
320    
321    
322    // *************** Other Internal functions  ***************
323    // *
324    
325        static split_type_t __resolveSplitType(dimension_t dimension) {
326            return (
327                dimension == dimension_layer ||
328                dimension == dimension_samplechannel ||
329                dimension == dimension_releasetrigger ||
330                dimension == dimension_keyboard ||
331                dimension == dimension_roundrobin ||
332                dimension == dimension_random ||
333                dimension == dimension_smartmidi ||
334                dimension == dimension_roundrobinkeyboard
335            ) ? split_type_bit : split_type_normal;
336        }
337    
338        static int __resolveZoneSize(dimension_def_t& dimension_definition) {
339            return (dimension_definition.split_type == split_type_normal)
340            ? int(128.0 / dimension_definition.zones) : 0;
341        }
342    
343    
344    
345  // *************** Sample ***************  // *************** Sample ***************
346  // *  // *
347    
348      unsigned int Sample::Instances = 0;      unsigned int Sample::Instances = 0;
349      buffer_t     Sample::InternalDecompressionBuffer;      buffer_t     Sample::InternalDecompressionBuffer;
350    
351      Sample::Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {      /** @brief Constructor.
352         *
353         * Load an existing sample or create a new one. A 'wave' list chunk must
354         * be given to this constructor. In case the given 'wave' list chunk
355         * contains a 'fmt', 'data' (and optionally a '3gix', 'smpl') chunk, the
356         * format and sample data will be loaded from there, otherwise default
357         * values will be used and those chunks will be created when
358         * File::Save() will be called later on.
359         *
360         * @param pFile          - pointer to gig::File where this sample is
361         *                         located (or will be located)
362         * @param waveList       - pointer to 'wave' list chunk which is (or
363         *                         will be) associated with this sample
364         * @param WavePoolOffset - offset of this sample data from wave pool
365         *                         ('wvpl') list chunk
366         * @param fileNo         - number of an extension file where this sample
367         *                         is located, 0 otherwise
368         */
369        Sample::Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {
370            static const DLS::Info::string_length_t fixedStringLengths[] = {
371                { CHUNK_ID_INAM, 64 },
372                { 0, 0 }
373            };
374            pInfo->SetFixedStringLengths(fixedStringLengths);
375          Instances++;          Instances++;
376            FileNo = fileNo;
377    
378          RIFF::Chunk* _3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);          __resetCRC(crc);
379          if (!_3gix) throw gig::Exception("Mandatory chunks in <wave> list chunk not found.");  
380          SampleGroup = _3gix->ReadInt16();          pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);
381            if (pCk3gix) {
382          RIFF::Chunk* smpl = waveList->GetSubChunk(CHUNK_ID_SMPL);              uint16_t iSampleGroup = pCk3gix->ReadInt16();
383          if (!smpl) throw gig::Exception("Mandatory chunks in <wave> list chunk not found.");              pGroup = pFile->GetGroup(iSampleGroup);
384          Manufacturer      = smpl->ReadInt32();          } else { // '3gix' chunk missing
385          Product           = smpl->ReadInt32();              // by default assigned to that mandatory "Default Group"
386          SamplePeriod      = smpl->ReadInt32();              pGroup = pFile->GetGroup(0);
387          MIDIUnityNote     = smpl->ReadInt32();          }
388          FineTune          = smpl->ReadInt32();  
389          smpl->Read(&SMPTEFormat, 1, 4);          pCkSmpl = waveList->GetSubChunk(CHUNK_ID_SMPL);
390          SMPTEOffset       = smpl->ReadInt32();          if (pCkSmpl) {
391          Loops             = smpl->ReadInt32();              Manufacturer  = pCkSmpl->ReadInt32();
392          smpl->ReadInt32(); // manufByt              Product       = pCkSmpl->ReadInt32();
393          LoopID            = smpl->ReadInt32();              SamplePeriod  = pCkSmpl->ReadInt32();
394          smpl->Read(&LoopType, 1, 4);              MIDIUnityNote = pCkSmpl->ReadInt32();
395          LoopStart         = smpl->ReadInt32();              FineTune      = pCkSmpl->ReadInt32();
396          LoopEnd           = smpl->ReadInt32();              pCkSmpl->Read(&SMPTEFormat, 1, 4);
397          LoopFraction      = smpl->ReadInt32();              SMPTEOffset   = pCkSmpl->ReadInt32();
398          LoopPlayCount     = smpl->ReadInt32();              Loops         = pCkSmpl->ReadInt32();
399                pCkSmpl->ReadInt32(); // manufByt
400                LoopID        = pCkSmpl->ReadInt32();
401                pCkSmpl->Read(&LoopType, 1, 4);
402                LoopStart     = pCkSmpl->ReadInt32();
403                LoopEnd       = pCkSmpl->ReadInt32();
404                LoopFraction  = pCkSmpl->ReadInt32();
405                LoopPlayCount = pCkSmpl->ReadInt32();
406            } else { // 'smpl' chunk missing
407                // use default values
408                Manufacturer  = 0;
409                Product       = 0;
410                SamplePeriod  = uint32_t(1000000000.0 / SamplesPerSecond + 0.5);
411                MIDIUnityNote = 60;
412                FineTune      = 0;
413                SMPTEFormat   = smpte_format_no_offset;
414                SMPTEOffset   = 0;
415                Loops         = 0;
416                LoopID        = 0;
417                LoopType      = loop_type_normal;
418                LoopStart     = 0;
419                LoopEnd       = 0;
420                LoopFraction  = 0;
421                LoopPlayCount = 0;
422            }
423    
424          FrameTable                 = NULL;          FrameTable                 = NULL;
425          SamplePos                  = 0;          SamplePos                  = 0;
# Line 239  namespace gig { namespace { Line 429  namespace gig { namespace {
429    
430          if (BitDepth > 24) throw gig::Exception("Only samples up to 24 bit supported");          if (BitDepth > 24) throw gig::Exception("Only samples up to 24 bit supported");
431    
432          Compressed = (waveList->GetSubChunk(CHUNK_ID_EWAV));          RIFF::Chunk* ewav = waveList->GetSubChunk(CHUNK_ID_EWAV);
433            Compressed        = ewav;
434            Dithered          = false;
435            TruncatedBits     = 0;
436          if (Compressed) {          if (Compressed) {
437                uint32_t version = ewav->ReadInt32();
438                if (version == 3 && BitDepth == 24) {
439                    Dithered = ewav->ReadInt32();
440                    ewav->SetPos(Channels == 2 ? 84 : 64);
441                    TruncatedBits = ewav->ReadInt32();
442                }
443              ScanCompressedSample();              ScanCompressedSample();
444          }          }
445    
# Line 249  namespace gig { namespace { Line 448  namespace gig { namespace {
448              InternalDecompressionBuffer.pStart = new unsigned char[INITIAL_SAMPLE_BUFFER_SIZE];              InternalDecompressionBuffer.pStart = new unsigned char[INITIAL_SAMPLE_BUFFER_SIZE];
449              InternalDecompressionBuffer.Size   = INITIAL_SAMPLE_BUFFER_SIZE;              InternalDecompressionBuffer.Size   = INITIAL_SAMPLE_BUFFER_SIZE;
450          }          }
451          FrameOffset = 0; // just for streaming compressed samples          FrameOffset = 0; // just for streaming compressed samples
452    
453          LoopSize = LoopEnd - LoopStart;          LoopSize = LoopEnd - LoopStart + 1;
454        }
455    
456        /**
457         * Apply sample and its settings to the respective RIFF chunks. You have
458         * to call File::Save() to make changes persistent.
459         *
460         * Usually there is absolutely no need to call this method explicitly.
461         * It will be called automatically when File::Save() was called.
462         *
463         * @throws DLS::Exception if FormatTag != DLS_WAVE_FORMAT_PCM or no sample data
464         *                        was provided yet
465         * @throws gig::Exception if there is any invalid sample setting
466         */
467        void Sample::UpdateChunks() {
468            // first update base class's chunks
469            DLS::Sample::UpdateChunks();
470    
471            // make sure 'smpl' chunk exists
472            pCkSmpl = pWaveList->GetSubChunk(CHUNK_ID_SMPL);
473            if (!pCkSmpl) {
474                pCkSmpl = pWaveList->AddSubChunk(CHUNK_ID_SMPL, 60);
475                memset(pCkSmpl->LoadChunkData(), 0, 60);
476            }
477            // update 'smpl' chunk
478            uint8_t* pData = (uint8_t*) pCkSmpl->LoadChunkData();
479            SamplePeriod = uint32_t(1000000000.0 / SamplesPerSecond + 0.5);
480            store32(&pData[0], Manufacturer);
481            store32(&pData[4], Product);
482            store32(&pData[8], SamplePeriod);
483            store32(&pData[12], MIDIUnityNote);
484            store32(&pData[16], FineTune);
485            store32(&pData[20], SMPTEFormat);
486            store32(&pData[24], SMPTEOffset);
487            store32(&pData[28], Loops);
488    
489            // we skip 'manufByt' for now (4 bytes)
490    
491            store32(&pData[36], LoopID);
492            store32(&pData[40], LoopType);
493            store32(&pData[44], LoopStart);
494            store32(&pData[48], LoopEnd);
495            store32(&pData[52], LoopFraction);
496            store32(&pData[56], LoopPlayCount);
497    
498            // make sure '3gix' chunk exists
499            pCk3gix = pWaveList->GetSubChunk(CHUNK_ID_3GIX);
500            if (!pCk3gix) pCk3gix = pWaveList->AddSubChunk(CHUNK_ID_3GIX, 4);
501            // determine appropriate sample group index (to be stored in chunk)
502            uint16_t iSampleGroup = 0; // 0 refers to default sample group
503            File* pFile = static_cast<File*>(pParent);
504            if (pFile->pGroups) {
505                std::list<Group*>::iterator iter = pFile->pGroups->begin();
506                std::list<Group*>::iterator end  = pFile->pGroups->end();
507                for (int i = 0; iter != end; i++, iter++) {
508                    if (*iter == pGroup) {
509                        iSampleGroup = i;
510                        break; // found
511                    }
512                }
513            }
514            // update '3gix' chunk
515            pData = (uint8_t*) pCk3gix->LoadChunkData();
516            store16(&pData[0], iSampleGroup);
517      }      }
518    
519      /// Scans compressed samples for mandatory informations (e.g. actual number of total sample points).      /// Scans compressed samples for mandatory informations (e.g. actual number of total sample points).
# Line 415  namespace gig { namespace { Line 677  namespace gig { namespace {
677          if (SampleCount > this->SamplesTotal) SampleCount = this->SamplesTotal;          if (SampleCount > this->SamplesTotal) SampleCount = this->SamplesTotal;
678          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
679          unsigned long allocationsize = (SampleCount + NullSamplesCount) * this->FrameSize;          unsigned long allocationsize = (SampleCount + NullSamplesCount) * this->FrameSize;
680            SetPos(0); // reset read position to begin of sample
681          RAMCache.pStart            = new int8_t[allocationsize];          RAMCache.pStart            = new int8_t[allocationsize];
682          RAMCache.Size              = Read(RAMCache.pStart, SampleCount) * this->FrameSize;          RAMCache.Size              = Read(RAMCache.pStart, SampleCount) * this->FrameSize;
683          RAMCache.NullExtensionSize = allocationsize - RAMCache.Size;          RAMCache.NullExtensionSize = allocationsize - RAMCache.Size;
# Line 452  namespace gig { namespace { Line 715  namespace gig { namespace {
715          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
716          RAMCache.pStart = NULL;          RAMCache.pStart = NULL;
717          RAMCache.Size   = 0;          RAMCache.Size   = 0;
718            RAMCache.NullExtensionSize = 0;
719        }
720    
721        /** @brief Resize sample.
722         *
723         * Resizes the sample's wave form data, that is the actual size of
724         * sample wave data possible to be written for this sample. This call
725         * will return immediately and just schedule the resize operation. You
726         * should call File::Save() to actually perform the resize operation(s)
727         * "physically" to the file. As this can take a while on large files, it
728         * is recommended to call Resize() first on all samples which have to be
729         * resized and finally to call File::Save() to perform all those resize
730         * operations in one rush.
731         *
732         * The actual size (in bytes) is dependant to the current FrameSize
733         * value. You may want to set FrameSize before calling Resize().
734         *
735         * <b>Caution:</b> You cannot directly write (i.e. with Write()) to
736         * enlarged samples before calling File::Save() as this might exceed the
737         * current sample's boundary!
738         *
739         * Also note: only DLS_WAVE_FORMAT_PCM is currently supported, that is
740         * FormatTag must be DLS_WAVE_FORMAT_PCM. Trying to resize samples with
741         * other formats will fail!
742         *
743         * @param iNewSize - new sample wave data size in sample points (must be
744         *                   greater than zero)
745         * @throws DLS::Excecption if FormatTag != DLS_WAVE_FORMAT_PCM
746         *                         or if \a iNewSize is less than 1
747         * @throws gig::Exception if existing sample is compressed
748         * @see DLS::Sample::GetSize(), DLS::Sample::FrameSize,
749         *      DLS::Sample::FormatTag, File::Save()
750         */
751        void Sample::Resize(int iNewSize) {
752            if (Compressed) throw gig::Exception("There is no support for modifying compressed samples (yet)");
753            DLS::Sample::Resize(iNewSize);
754      }      }
755    
756      /**      /**
# Line 543  namespace gig { namespace { Line 842  namespace gig { namespace {
842       * @param SampleCount      number of sample points to read       * @param SampleCount      number of sample points to read
843       * @param pPlaybackState   will be used to store and reload the playback       * @param pPlaybackState   will be used to store and reload the playback
844       *                         state for the next ReadAndLoop() call       *                         state for the next ReadAndLoop() call
845         * @param pDimRgn          dimension region with looping information
846       * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression       * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression
847       * @returns                number of successfully read sample points       * @returns                number of successfully read sample points
848       * @see                    CreateDecompressionBuffer()       * @see                    CreateDecompressionBuffer()
849       */       */
850      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,
851                                          DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer) {
852          unsigned long samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;          unsigned long samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;
853          uint8_t* pDst = (uint8_t*) pBuffer;          uint8_t* pDst = (uint8_t*) pBuffer;
854    
855          SetPos(pPlaybackState->position); // recover position from the last time          SetPos(pPlaybackState->position); // recover position from the last time
856    
857          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
858    
859              switch (this->LoopType) {              const DLS::sample_loop_t& loop = pDimRgn->pSampleLoops[0];
860                const uint32_t loopEnd = loop.LoopStart + loop.LoopLength;
861    
862                  case loop_type_bidirectional: { //TODO: not tested yet!              if (GetPos() <= loopEnd) {
863                      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  
864    
865                              // as we can only read forward from disk, we have to                      case loop_type_bidirectional: { //TODO: not tested yet!
866                              // determine the end position within the loop first,                          do {
867                              // read forward from that 'end' and finally after                              // if not endless loop check if max. number of loop cycles have been passed
868                              // reading, swap all sample frames so it reflects                              if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
869                              // backward playback  
870                                if (!pPlaybackState->reverse) { // forward playback
871                              unsigned long swapareastart       = totalreadsamples;                                  do {
872                              unsigned long loopoffset          = GetPos() - this->LoopStart;                                      samplestoloopend  = loopEnd - GetPos();
873                              unsigned long samplestoreadinloop = Min(samplestoread, loopoffset);                                      readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
874                              unsigned long reverseplaybackend  = GetPos() - samplestoreadinloop;                                      samplestoread    -= readsamples;
875                                        totalreadsamples += readsamples;
876                              SetPos(reverseplaybackend);                                      if (readsamples == samplestoloopend) {
877                                            pPlaybackState->reverse = true;
878                              // read samples for backward playback                                          break;
879                              do {                                      }
880                                  readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], samplestoreadinloop, pExternalDecompressionBuffer);                                  } while (samplestoread && readsamples);
881                                  samplestoreadinloop -= readsamples;                              }
882                                  samplestoread       -= readsamples;                              else { // backward playback
                                 totalreadsamples    += readsamples;  
                             } while (samplestoreadinloop && readsamples);  
883    
884                              SetPos(reverseplaybackend); // pretend we really read backwards                                  // as we can only read forward from disk, we have to
885                                    // determine the end position within the loop first,
886                                    // read forward from that 'end' and finally after
887                                    // reading, swap all sample frames so it reflects
888                                    // backward playback
889    
890                                    unsigned long swapareastart       = totalreadsamples;
891                                    unsigned long loopoffset          = GetPos() - loop.LoopStart;
892                                    unsigned long samplestoreadinloop = Min(samplestoread, loopoffset);
893                                    unsigned long reverseplaybackend  = GetPos() - samplestoreadinloop;
894    
895                                    SetPos(reverseplaybackend);
896    
897                                    // read samples for backward playback
898                                    do {
899                                        readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], samplestoreadinloop, pExternalDecompressionBuffer);
900                                        samplestoreadinloop -= readsamples;
901                                        samplestoread       -= readsamples;
902                                        totalreadsamples    += readsamples;
903                                    } while (samplestoreadinloop && readsamples);
904    
905                                    SetPos(reverseplaybackend); // pretend we really read backwards
906    
907                                    if (reverseplaybackend == loop.LoopStart) {
908                                        pPlaybackState->loop_cycles_left--;
909                                        pPlaybackState->reverse = false;
910                                    }
911    
912                              if (reverseplaybackend == this->LoopStart) {                                  // reverse the sample frames for backward playback
913                                  pPlaybackState->loop_cycles_left--;                                  if (totalreadsamples > swapareastart) //FIXME: this if() is just a crash workaround for now (#102), but totalreadsamples <= swapareastart should never be the case, so there's probably still a bug above!
914                                  pPlaybackState->reverse = false;                                      SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
915                              }                              }
916                            } while (samplestoread && readsamples);
917                            break;
918                        }
919    
920                              // reverse the sample frames for backward playback                      case loop_type_backward: { // TODO: not tested yet!
921                              SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);                          // forward playback (not entered the loop yet)
922                          }                          if (!pPlaybackState->reverse) do {
923                      } while (samplestoread && readsamples);                              samplestoloopend  = loopEnd - GetPos();
924                      break;                              readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
925                  }                              samplestoread    -= readsamples;
926                                totalreadsamples += readsamples;
927                  case loop_type_backward: { // TODO: not tested yet!                              if (readsamples == samplestoloopend) {
928                      // forward playback (not entered the loop yet)                                  pPlaybackState->reverse = true;
929                      if (!pPlaybackState->reverse) do {                                  break;
930                          samplestoloopend  = this->LoopEnd - GetPos();                              }
931                          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);  
932    
933                      if (!samplestoread) break;                          if (!samplestoread) break;
934    
935                      // as we can only read forward from disk, we have to                          // as we can only read forward from disk, we have to
936                      // determine the end position within the loop first,                          // determine the end position within the loop first,
937                      // read forward from that 'end' and finally after                          // read forward from that 'end' and finally after
938                      // reading, swap all sample frames so it reflects                          // reading, swap all sample frames so it reflects
939                      // backward playback                          // backward playback
940    
941                      unsigned long swapareastart       = totalreadsamples;                          unsigned long swapareastart       = totalreadsamples;
942                      unsigned long loopoffset          = GetPos() - this->LoopStart;                          unsigned long loopoffset          = GetPos() - loop.LoopStart;
943                      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)
944                                                                                : samplestoread;                                                                                    : samplestoread;
945                      unsigned long reverseplaybackend  = this->LoopStart + Abs((loopoffset - samplestoreadinloop) % this->LoopSize);                          unsigned long reverseplaybackend  = loop.LoopStart + Abs((loopoffset - samplestoreadinloop) % loop.LoopLength);
946    
947                      SetPos(reverseplaybackend);                          SetPos(reverseplaybackend);
948    
949                      // read samples for backward playback                          // read samples for backward playback
950                      do {                          do {
951                          // 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
952                          if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;                              if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
953                          samplestoloopend     = this->LoopEnd - GetPos();                              samplestoloopend     = loopEnd - GetPos();
954                          readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoreadinloop, samplestoloopend), pExternalDecompressionBuffer);                              readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoreadinloop, samplestoloopend), pExternalDecompressionBuffer);
955                          samplestoreadinloop -= readsamples;                              samplestoreadinloop -= readsamples;
956                          samplestoread       -= readsamples;                              samplestoread       -= readsamples;
957                          totalreadsamples    += readsamples;                              totalreadsamples    += readsamples;
958                          if (readsamples == samplestoloopend) {                              if (readsamples == samplestoloopend) {
959                              pPlaybackState->loop_cycles_left--;                                  pPlaybackState->loop_cycles_left--;
960                              SetPos(this->LoopStart);                                  SetPos(loop.LoopStart);
961                          }                              }
962                      } while (samplestoreadinloop && readsamples);                          } while (samplestoreadinloop && readsamples);
963    
964                      SetPos(reverseplaybackend); // pretend we really read backwards                          SetPos(reverseplaybackend); // pretend we really read backwards
965    
966                      // reverse the sample frames for backward playback                          // reverse the sample frames for backward playback
967                      SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);                          SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
968                      break;                          break;
969                  }                      }
970    
971                  default: case loop_type_normal: {                      default: case loop_type_normal: {
972                      do {                          do {
973                          // 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
974                          if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;                              if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
975                          samplestoloopend  = this->LoopEnd - GetPos();                              samplestoloopend  = loopEnd - GetPos();
976                          readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);                              readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
977                          samplestoread    -= readsamples;                              samplestoread    -= readsamples;
978                          totalreadsamples += readsamples;                              totalreadsamples += readsamples;
979                          if (readsamples == samplestoloopend) {                              if (readsamples == samplestoloopend) {
980                              pPlaybackState->loop_cycles_left--;                                  pPlaybackState->loop_cycles_left--;
981                              SetPos(this->LoopStart);                                  SetPos(loop.LoopStart);
982                          }                              }
983                      } while (samplestoread && readsamples);                          } while (samplestoread && readsamples);
984                      break;                          break;
985                        }
986                  }                  }
987              }              }
988          }          }
# Line 705  namespace gig { namespace { Line 1012  namespace gig { namespace {
1012       * have to use an external decompression buffer for <b>EACH</b>       * have to use an external decompression buffer for <b>EACH</b>
1013       * streaming thread to avoid race conditions and crashes!       * streaming thread to avoid race conditions and crashes!
1014       *       *
1015         * For 16 bit samples, the data in the buffer will be int16_t
1016         * (using native endianness). For 24 bit, the buffer will
1017         * contain three bytes per sample, little-endian.
1018         *
1019       * @param pBuffer      destination buffer       * @param pBuffer      destination buffer
1020       * @param SampleCount  number of sample points to read       * @param SampleCount  number of sample points to read
1021       * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression       * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression
# Line 715  namespace gig { namespace { Line 1026  namespace gig { namespace {
1026          if (SampleCount == 0) return 0;          if (SampleCount == 0) return 0;
1027          if (!Compressed) {          if (!Compressed) {
1028              if (BitDepth == 24) {              if (BitDepth == 24) {
1029                  // 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);  
                 }  
1030              }              }
1031              else { // 16 bit              else { // 16 bit
1032                  // (pCkData->Read does endian correction)                  // (pCkData->Read does endian correction)
# Line 765  namespace gig { namespace { Line 1056  namespace gig { namespace {
1056    
1057              unsigned char* pSrc = (unsigned char*) pDecompressionBuffer->pStart;              unsigned char* pSrc = (unsigned char*) pDecompressionBuffer->pStart;
1058              int16_t* pDst = static_cast<int16_t*>(pBuffer);              int16_t* pDst = static_cast<int16_t*>(pBuffer);
1059                uint8_t* pDst24 = static_cast<uint8_t*>(pBuffer);
1060              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);
1061    
1062              while (remainingsamples && remainingbytes) {              while (remainingsamples && remainingbytes) {
# Line 846  namespace gig { namespace { Line 1138  namespace gig { namespace {
1138                              const unsigned char* const param_r = pSrc;                              const unsigned char* const param_r = pSrc;
1139                              if (mode_r != 2) pSrc += 12;                              if (mode_r != 2) pSrc += 12;
1140    
1141                              Decompress24(mode_l, param_l, 2, pSrc, pDst, skipsamples, copysamples);                              Decompress24(mode_l, param_l, 6, pSrc, pDst24,
1142                              Decompress24(mode_r, param_r, 2, pSrc + rightChannelOffset, pDst + 1,                                           skipsamples, copysamples, TruncatedBits);
1143                                           skipsamples, copysamples);                              Decompress24(mode_r, param_r, 6, pSrc + rightChannelOffset, pDst24 + 3,
1144                              pDst += copysamples << 1;                                           skipsamples, copysamples, TruncatedBits);
1145                                pDst24 += copysamples * 6;
1146                          }                          }
1147                          else { // Mono                          else { // Mono
1148                              Decompress24(mode_l, param_l, 1, pSrc, pDst, skipsamples, copysamples);                              Decompress24(mode_l, param_l, 3, pSrc, pDst24,
1149                              pDst += copysamples;                                           skipsamples, copysamples, TruncatedBits);
1150                                pDst24 += copysamples * 3;
1151                          }                          }
1152                      }                      }
1153                      else { // 16 bit                      else { // 16 bit
# Line 895  namespace gig { namespace { Line 1189  namespace gig { namespace {
1189          }          }
1190      }      }
1191    
1192        /** @brief Write sample wave data.
1193         *
1194         * Writes \a SampleCount number of sample points from the buffer pointed
1195         * by \a pBuffer and increments the position within the sample. Use this
1196         * method to directly write the sample data to disk, i.e. if you don't
1197         * want or cannot load the whole sample data into RAM.
1198         *
1199         * You have to Resize() the sample to the desired size and call
1200         * File::Save() <b>before</b> using Write().
1201         *
1202         * Note: there is currently no support for writing compressed samples.
1203         *
1204         * For 16 bit samples, the data in the source buffer should be
1205         * int16_t (using native endianness). For 24 bit, the buffer
1206         * should contain three bytes per sample, little-endian.
1207         *
1208         * @param pBuffer     - source buffer
1209         * @param SampleCount - number of sample points to write
1210         * @throws DLS::Exception if current sample size is too small
1211         * @throws gig::Exception if sample is compressed
1212         * @see DLS::LoadSampleData()
1213         */
1214        unsigned long Sample::Write(void* pBuffer, unsigned long SampleCount) {
1215            if (Compressed) throw gig::Exception("There is no support for writing compressed gig samples (yet)");
1216    
1217            // if this is the first write in this sample, reset the
1218            // checksum calculator
1219            if (pCkData->GetPos() == 0) {
1220                __resetCRC(crc);
1221            }
1222            if (GetSize() < SampleCount) throw Exception("Could not write sample data, current sample size to small");
1223            unsigned long res;
1224            if (BitDepth == 24) {
1225                res = pCkData->Write(pBuffer, SampleCount * FrameSize, 1) / FrameSize;
1226            } else { // 16 bit
1227                res = Channels == 2 ? pCkData->Write(pBuffer, SampleCount << 1, 2) >> 1
1228                                    : pCkData->Write(pBuffer, SampleCount, 2);
1229            }
1230            __calculateCRC((unsigned char *)pBuffer, SampleCount * FrameSize, crc);
1231    
1232            // if this is the last write, update the checksum chunk in the
1233            // file
1234            if (pCkData->GetPos() == pCkData->GetSize()) {
1235                File* pFile = static_cast<File*>(GetParent());
1236                pFile->SetSampleChecksum(this, __encodeCRC(crc));
1237            }
1238            return res;
1239        }
1240    
1241      /**      /**
1242       * Allocates a decompression buffer for streaming (compressed) samples       * Allocates a decompression buffer for streaming (compressed) samples
1243       * 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 937  namespace gig { namespace { Line 1280  namespace gig { namespace {
1280          }          }
1281      }      }
1282    
1283        /**
1284         * Returns pointer to the Group this Sample belongs to. In the .gig
1285         * format a sample always belongs to one group. If it wasn't explicitly
1286         * assigned to a certain group, it will be automatically assigned to a
1287         * default group.
1288         *
1289         * @returns Sample's Group (never NULL)
1290         */
1291        Group* Sample::GetGroup() const {
1292            return pGroup;
1293        }
1294    
1295      Sample::~Sample() {      Sample::~Sample() {
1296          Instances--;          Instances--;
1297          if (!Instances && InternalDecompressionBuffer.Size) {          if (!Instances && InternalDecompressionBuffer.Size) {
# Line 956  namespace gig { namespace { Line 1311  namespace gig { namespace {
1311      uint                               DimensionRegion::Instances       = 0;      uint                               DimensionRegion::Instances       = 0;
1312      DimensionRegion::VelocityTableMap* DimensionRegion::pVelocityTables = NULL;      DimensionRegion::VelocityTableMap* DimensionRegion::pVelocityTables = NULL;
1313    
1314      DimensionRegion::DimensionRegion(RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {      DimensionRegion::DimensionRegion(Region* pParent, RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {
1315          Instances++;          Instances++;
1316    
1317          memcpy(&Crossfade, &SamplerOptions, 4);          pSample = NULL;
1318            pRegion = pParent;
1319    
1320            if (_3ewl->GetSubChunk(CHUNK_ID_WSMP)) memcpy(&Crossfade, &SamplerOptions, 4);
1321            else memset(&Crossfade, 0, 4);
1322    
1323          if (!pVelocityTables) pVelocityTables = new VelocityTableMap;          if (!pVelocityTables) pVelocityTables = new VelocityTableMap;
1324    
1325          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);
1326          _3ewa->ReadInt32(); // unknown, always 0x0000008C ?          if (_3ewa) { // if '3ewa' chunk exists
1327          LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              _3ewa->ReadInt32(); // unknown, always == chunk size ?
1328          EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1329          _3ewa->ReadInt16(); // unknown              EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1330          LFO1InternalDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1331          _3ewa->ReadInt16(); // unknown              LFO1InternalDepth = _3ewa->ReadUint16();
1332          LFO3InternalDepth = _3ewa->ReadInt16();              _3ewa->ReadInt16(); // unknown
1333          _3ewa->ReadInt16(); // unknown              LFO3InternalDepth = _3ewa->ReadInt16();
1334          LFO1ControlDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1335          _3ewa->ReadInt16(); // unknown              LFO1ControlDepth = _3ewa->ReadUint16();
1336          LFO3ControlDepth = _3ewa->ReadInt16();              _3ewa->ReadInt16(); // unknown
1337          EG1Attack           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO3ControlDepth = _3ewa->ReadInt16();
1338          EG1Decay1           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG1Attack           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1339          _3ewa->ReadInt16(); // unknown              EG1Decay1           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1340          EG1Sustain          = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1341          EG1Release          = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG1Sustain          = _3ewa->ReadUint16();
1342          EG1Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));              EG1Release          = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1343          uint8_t eg1ctrloptions        = _3ewa->ReadUint8();              EG1Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1344          EG1ControllerInvert           = eg1ctrloptions & 0x01;              uint8_t eg1ctrloptions        = _3ewa->ReadUint8();
1345          EG1ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg1ctrloptions);              EG1ControllerInvert           = eg1ctrloptions & 0x01;
1346          EG1ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg1ctrloptions);              EG1ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg1ctrloptions);
1347          EG1ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg1ctrloptions);              EG1ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg1ctrloptions);
1348          EG2Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));              EG1ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg1ctrloptions);
1349          uint8_t eg2ctrloptions        = _3ewa->ReadUint8();              EG2Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1350          EG2ControllerInvert           = eg2ctrloptions & 0x01;              uint8_t eg2ctrloptions        = _3ewa->ReadUint8();
1351          EG2ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg2ctrloptions);              EG2ControllerInvert           = eg2ctrloptions & 0x01;
1352          EG2ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg2ctrloptions);              EG2ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg2ctrloptions);
1353          EG2ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg2ctrloptions);              EG2ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg2ctrloptions);
1354          LFO1Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG2ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg2ctrloptions);
1355          EG2Attack        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO1Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1356          EG2Decay1        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG2Attack        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1357          _3ewa->ReadInt16(); // unknown              EG2Decay1        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1358          EG2Sustain       = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1359          EG2Release       = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG2Sustain       = _3ewa->ReadUint16();
1360          _3ewa->ReadInt16(); // unknown              EG2Release       = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1361          LFO2ControlDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1362          LFO2Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO2ControlDepth = _3ewa->ReadUint16();
1363          _3ewa->ReadInt16(); // unknown              LFO2Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1364          LFO2InternalDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1365          int32_t eg1decay2 = _3ewa->ReadInt32();              LFO2InternalDepth = _3ewa->ReadUint16();
1366          EG1Decay2          = (double) GIG_EXP_DECODE(eg1decay2);              int32_t eg1decay2 = _3ewa->ReadInt32();
1367          EG1InfiniteSustain = (eg1decay2 == 0x7fffffff);              EG1Decay2          = (double) GIG_EXP_DECODE(eg1decay2);
1368          _3ewa->ReadInt16(); // unknown              EG1InfiniteSustain = (eg1decay2 == 0x7fffffff);
1369          EG1PreAttack      = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1370          int32_t eg2decay2 = _3ewa->ReadInt32();              EG1PreAttack      = _3ewa->ReadUint16();
1371          EG2Decay2         = (double) GIG_EXP_DECODE(eg2decay2);              int32_t eg2decay2 = _3ewa->ReadInt32();
1372          EG2InfiniteSustain = (eg2decay2 == 0x7fffffff);              EG2Decay2         = (double) GIG_EXP_DECODE(eg2decay2);
1373          _3ewa->ReadInt16(); // unknown              EG2InfiniteSustain = (eg2decay2 == 0x7fffffff);
1374          EG2PreAttack      = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1375          uint8_t velocityresponse = _3ewa->ReadUint8();              EG2PreAttack      = _3ewa->ReadUint16();
1376          if (velocityresponse < 5) {              uint8_t velocityresponse = _3ewa->ReadUint8();
1377              VelocityResponseCurve = curve_type_nonlinear;              if (velocityresponse < 5) {
1378              VelocityResponseDepth = velocityresponse;                  VelocityResponseCurve = curve_type_nonlinear;
1379          }                  VelocityResponseDepth = velocityresponse;
1380          else if (velocityresponse < 10) {              } else if (velocityresponse < 10) {
1381              VelocityResponseCurve = curve_type_linear;                  VelocityResponseCurve = curve_type_linear;
1382              VelocityResponseDepth = velocityresponse - 5;                  VelocityResponseDepth = velocityresponse - 5;
1383          }              } else if (velocityresponse < 15) {
1384          else if (velocityresponse < 15) {                  VelocityResponseCurve = curve_type_special;
1385              VelocityResponseCurve = curve_type_special;                  VelocityResponseDepth = velocityresponse - 10;
1386              VelocityResponseDepth = velocityresponse - 10;              } else {
1387                    VelocityResponseCurve = curve_type_unknown;
1388                    VelocityResponseDepth = 0;
1389                }
1390                uint8_t releasevelocityresponse = _3ewa->ReadUint8();
1391                if (releasevelocityresponse < 5) {
1392                    ReleaseVelocityResponseCurve = curve_type_nonlinear;
1393                    ReleaseVelocityResponseDepth = releasevelocityresponse;
1394                } else if (releasevelocityresponse < 10) {
1395                    ReleaseVelocityResponseCurve = curve_type_linear;
1396                    ReleaseVelocityResponseDepth = releasevelocityresponse - 5;
1397                } else if (releasevelocityresponse < 15) {
1398                    ReleaseVelocityResponseCurve = curve_type_special;
1399                    ReleaseVelocityResponseDepth = releasevelocityresponse - 10;
1400                } else {
1401                    ReleaseVelocityResponseCurve = curve_type_unknown;
1402                    ReleaseVelocityResponseDepth = 0;
1403                }
1404                VelocityResponseCurveScaling = _3ewa->ReadUint8();
1405                AttenuationControllerThreshold = _3ewa->ReadInt8();
1406                _3ewa->ReadInt32(); // unknown
1407                SampleStartOffset = (uint16_t) _3ewa->ReadInt16();
1408                _3ewa->ReadInt16(); // unknown
1409                uint8_t pitchTrackDimensionBypass = _3ewa->ReadInt8();
1410                PitchTrack = GIG_PITCH_TRACK_EXTRACT(pitchTrackDimensionBypass);
1411                if      (pitchTrackDimensionBypass & 0x10) DimensionBypass = dim_bypass_ctrl_94;
1412                else if (pitchTrackDimensionBypass & 0x20) DimensionBypass = dim_bypass_ctrl_95;
1413                else                                       DimensionBypass = dim_bypass_ctrl_none;
1414                uint8_t pan = _3ewa->ReadUint8();
1415                Pan         = (pan < 64) ? pan : -((int)pan - 63); // signed 7 bit -> signed 8 bit
1416                SelfMask = _3ewa->ReadInt8() & 0x01;
1417                _3ewa->ReadInt8(); // unknown
1418                uint8_t lfo3ctrl = _3ewa->ReadUint8();
1419                LFO3Controller           = static_cast<lfo3_ctrl_t>(lfo3ctrl & 0x07); // lower 3 bits
1420                LFO3Sync                 = lfo3ctrl & 0x20; // bit 5
1421                InvertAttenuationController = lfo3ctrl & 0x80; // bit 7
1422                AttenuationController  = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1423                uint8_t lfo2ctrl       = _3ewa->ReadUint8();
1424                LFO2Controller         = static_cast<lfo2_ctrl_t>(lfo2ctrl & 0x07); // lower 3 bits
1425                LFO2FlipPhase          = lfo2ctrl & 0x80; // bit 7
1426                LFO2Sync               = lfo2ctrl & 0x20; // bit 5
1427                bool extResonanceCtrl  = lfo2ctrl & 0x40; // bit 6
1428                uint8_t lfo1ctrl       = _3ewa->ReadUint8();
1429                LFO1Controller         = static_cast<lfo1_ctrl_t>(lfo1ctrl & 0x07); // lower 3 bits
1430                LFO1FlipPhase          = lfo1ctrl & 0x80; // bit 7
1431                LFO1Sync               = lfo1ctrl & 0x40; // bit 6
1432                VCFResonanceController = (extResonanceCtrl) ? static_cast<vcf_res_ctrl_t>(GIG_VCF_RESONANCE_CTRL_EXTRACT(lfo1ctrl))
1433                                                            : vcf_res_ctrl_none;
1434                uint16_t eg3depth = _3ewa->ReadUint16();
1435                EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */
1436                                            : (-1) * (int16_t) ((eg3depth ^ 0xffff) + 1); /* binary complementary for negatives */
1437                _3ewa->ReadInt16(); // unknown
1438                ChannelOffset = _3ewa->ReadUint8() / 4;
1439                uint8_t regoptions = _3ewa->ReadUint8();
1440                MSDecode           = regoptions & 0x01; // bit 0
1441                SustainDefeat      = regoptions & 0x02; // bit 1
1442                _3ewa->ReadInt16(); // unknown
1443                VelocityUpperLimit = _3ewa->ReadInt8();
1444                _3ewa->ReadInt8(); // unknown
1445                _3ewa->ReadInt16(); // unknown
1446                ReleaseTriggerDecay = _3ewa->ReadUint8(); // release trigger decay
1447                _3ewa->ReadInt8(); // unknown
1448                _3ewa->ReadInt8(); // unknown
1449                EG1Hold = _3ewa->ReadUint8() & 0x80; // bit 7
1450                uint8_t vcfcutoff = _3ewa->ReadUint8();
1451                VCFEnabled = vcfcutoff & 0x80; // bit 7
1452                VCFCutoff  = vcfcutoff & 0x7f; // lower 7 bits
1453                VCFCutoffController = static_cast<vcf_cutoff_ctrl_t>(_3ewa->ReadUint8());
1454                uint8_t vcfvelscale = _3ewa->ReadUint8();
1455                VCFCutoffControllerInvert = vcfvelscale & 0x80; // bit 7
1456                VCFVelocityScale = vcfvelscale & 0x7f; // lower 7 bits
1457                _3ewa->ReadInt8(); // unknown
1458                uint8_t vcfresonance = _3ewa->ReadUint8();
1459                VCFResonance = vcfresonance & 0x7f; // lower 7 bits
1460                VCFResonanceDynamic = !(vcfresonance & 0x80); // bit 7
1461                uint8_t vcfbreakpoint         = _3ewa->ReadUint8();
1462                VCFKeyboardTracking           = vcfbreakpoint & 0x80; // bit 7
1463                VCFKeyboardTrackingBreakpoint = vcfbreakpoint & 0x7f; // lower 7 bits
1464                uint8_t vcfvelocity = _3ewa->ReadUint8();
1465                VCFVelocityDynamicRange = vcfvelocity % 5;
1466                VCFVelocityCurve        = static_cast<curve_type_t>(vcfvelocity / 5);
1467                VCFType = static_cast<vcf_type_t>(_3ewa->ReadUint8());
1468                if (VCFType == vcf_type_lowpass) {
1469                    if (lfo3ctrl & 0x40) // bit 6
1470                        VCFType = vcf_type_lowpassturbo;
1471                }
1472                if (_3ewa->RemainingBytes() >= 8) {
1473                    _3ewa->Read(DimensionUpperLimits, 1, 8);
1474                } else {
1475                    memset(DimensionUpperLimits, 0, 8);
1476                }
1477            } else { // '3ewa' chunk does not exist yet
1478                // use default values
1479                LFO3Frequency                   = 1.0;
1480                EG3Attack                       = 0.0;
1481                LFO1InternalDepth               = 0;
1482                LFO3InternalDepth               = 0;
1483                LFO1ControlDepth                = 0;
1484                LFO3ControlDepth                = 0;
1485                EG1Attack                       = 0.0;
1486                EG1Decay1                       = 0.005;
1487                EG1Sustain                      = 1000;
1488                EG1Release                      = 0.3;
1489                EG1Controller.type              = eg1_ctrl_t::type_none;
1490                EG1Controller.controller_number = 0;
1491                EG1ControllerInvert             = false;
1492                EG1ControllerAttackInfluence    = 0;
1493                EG1ControllerDecayInfluence     = 0;
1494                EG1ControllerReleaseInfluence   = 0;
1495                EG2Controller.type              = eg2_ctrl_t::type_none;
1496                EG2Controller.controller_number = 0;
1497                EG2ControllerInvert             = false;
1498                EG2ControllerAttackInfluence    = 0;
1499                EG2ControllerDecayInfluence     = 0;
1500                EG2ControllerReleaseInfluence   = 0;
1501                LFO1Frequency                   = 1.0;
1502                EG2Attack                       = 0.0;
1503                EG2Decay1                       = 0.005;
1504                EG2Sustain                      = 1000;
1505                EG2Release                      = 0.3;
1506                LFO2ControlDepth                = 0;
1507                LFO2Frequency                   = 1.0;
1508                LFO2InternalDepth               = 0;
1509                EG1Decay2                       = 0.0;
1510                EG1InfiniteSustain              = true;
1511                EG1PreAttack                    = 0;
1512                EG2Decay2                       = 0.0;
1513                EG2InfiniteSustain              = true;
1514                EG2PreAttack                    = 0;
1515                VelocityResponseCurve           = curve_type_nonlinear;
1516                VelocityResponseDepth           = 3;
1517                ReleaseVelocityResponseCurve    = curve_type_nonlinear;
1518                ReleaseVelocityResponseDepth    = 3;
1519                VelocityResponseCurveScaling    = 32;
1520                AttenuationControllerThreshold  = 0;
1521                SampleStartOffset               = 0;
1522                PitchTrack                      = true;
1523                DimensionBypass                 = dim_bypass_ctrl_none;
1524                Pan                             = 0;
1525                SelfMask                        = true;
1526                LFO3Controller                  = lfo3_ctrl_modwheel;
1527                LFO3Sync                        = false;
1528                InvertAttenuationController     = false;
1529                AttenuationController.type      = attenuation_ctrl_t::type_none;
1530                AttenuationController.controller_number = 0;
1531                LFO2Controller                  = lfo2_ctrl_internal;
1532                LFO2FlipPhase                   = false;
1533                LFO2Sync                        = false;
1534                LFO1Controller                  = lfo1_ctrl_internal;
1535                LFO1FlipPhase                   = false;
1536                LFO1Sync                        = false;
1537                VCFResonanceController          = vcf_res_ctrl_none;
1538                EG3Depth                        = 0;
1539                ChannelOffset                   = 0;
1540                MSDecode                        = false;
1541                SustainDefeat                   = false;
1542                VelocityUpperLimit              = 0;
1543                ReleaseTriggerDecay             = 0;
1544                EG1Hold                         = false;
1545                VCFEnabled                      = false;
1546                VCFCutoff                       = 0;
1547                VCFCutoffController             = vcf_cutoff_ctrl_none;
1548                VCFCutoffControllerInvert       = false;
1549                VCFVelocityScale                = 0;
1550                VCFResonance                    = 0;
1551                VCFResonanceDynamic             = false;
1552                VCFKeyboardTracking             = false;
1553                VCFKeyboardTrackingBreakpoint   = 0;
1554                VCFVelocityDynamicRange         = 0x04;
1555                VCFVelocityCurve                = curve_type_linear;
1556                VCFType                         = vcf_type_lowpass;
1557                memset(DimensionUpperLimits, 127, 8);
1558            }
1559    
1560            pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,
1561                                                         VelocityResponseDepth,
1562                                                         VelocityResponseCurveScaling);
1563    
1564            pVelocityReleaseTable = GetReleaseVelocityTable(
1565                                        ReleaseVelocityResponseCurve,
1566                                        ReleaseVelocityResponseDepth
1567                                    );
1568    
1569            pVelocityCutoffTable = GetCutoffVelocityTable(VCFVelocityCurve,
1570                                                          VCFVelocityDynamicRange,
1571                                                          VCFVelocityScale,
1572                                                          VCFCutoffController);
1573    
1574            SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));
1575            VelocityTable = 0;
1576        }
1577    
1578        /*
1579         * Constructs a DimensionRegion by copying all parameters from
1580         * another DimensionRegion
1581         */
1582        DimensionRegion::DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src) : DLS::Sampler(_3ewl) {
1583            Instances++;
1584            *this = src; // default memberwise shallow copy of all parameters
1585            pParentList = _3ewl; // restore the chunk pointer
1586    
1587            // deep copy of owned structures
1588            if (src.VelocityTable) {
1589                VelocityTable = new uint8_t[128];
1590                for (int k = 0 ; k < 128 ; k++)
1591                    VelocityTable[k] = src.VelocityTable[k];
1592            }
1593            if (src.pSampleLoops) {
1594                pSampleLoops = new DLS::sample_loop_t[src.SampleLoops];
1595                for (int k = 0 ; k < src.SampleLoops ; k++)
1596                    pSampleLoops[k] = src.pSampleLoops[k];
1597          }          }
1598          else {      }
1599              VelocityResponseCurve = curve_type_unknown;  
1600              VelocityResponseDepth = 0;      /**
1601         * Updates the respective member variable and updates @c SampleAttenuation
1602         * which depends on this value.
1603         */
1604        void DimensionRegion::SetGain(int32_t gain) {
1605            DLS::Sampler::SetGain(gain);
1606            SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));
1607        }
1608    
1609        /**
1610         * Apply dimension region settings to the respective RIFF chunks. You
1611         * have to call File::Save() to make changes persistent.
1612         *
1613         * Usually there is absolutely no need to call this method explicitly.
1614         * It will be called automatically when File::Save() was called.
1615         */
1616        void DimensionRegion::UpdateChunks() {
1617            // first update base class's chunk
1618            DLS::Sampler::UpdateChunks();
1619    
1620            RIFF::Chunk* wsmp = pParentList->GetSubChunk(CHUNK_ID_WSMP);
1621            uint8_t* pData = (uint8_t*) wsmp->LoadChunkData();
1622            pData[12] = Crossfade.in_start;
1623            pData[13] = Crossfade.in_end;
1624            pData[14] = Crossfade.out_start;
1625            pData[15] = Crossfade.out_end;
1626    
1627            // make sure '3ewa' chunk exists
1628            RIFF::Chunk* _3ewa = pParentList->GetSubChunk(CHUNK_ID_3EWA);
1629            if (!_3ewa) {
1630                File* pFile = (File*) GetParent()->GetParent()->GetParent();
1631                bool version3 = pFile->pVersion && pFile->pVersion->major == 3;
1632                _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, version3 ? 148 : 140);
1633          }          }
1634          uint8_t releasevelocityresponse = _3ewa->ReadUint8();          pData = (uint8_t*) _3ewa->LoadChunkData();
1635          if (releasevelocityresponse < 5) {  
1636              ReleaseVelocityResponseCurve = curve_type_nonlinear;          // update '3ewa' chunk with DimensionRegion's current settings
1637              ReleaseVelocityResponseDepth = releasevelocityresponse;  
1638          }          const uint32_t chunksize = _3ewa->GetNewSize();
1639          else if (releasevelocityresponse < 10) {          store32(&pData[0], chunksize); // unknown, always chunk size?
1640              ReleaseVelocityResponseCurve = curve_type_linear;  
1641              ReleaseVelocityResponseDepth = releasevelocityresponse - 5;          const int32_t lfo3freq = (int32_t) GIG_EXP_ENCODE(LFO3Frequency);
1642          }          store32(&pData[4], lfo3freq);
1643          else if (releasevelocityresponse < 15) {  
1644              ReleaseVelocityResponseCurve = curve_type_special;          const int32_t eg3attack = (int32_t) GIG_EXP_ENCODE(EG3Attack);
1645              ReleaseVelocityResponseDepth = releasevelocityresponse - 10;          store32(&pData[8], eg3attack);
1646    
1647            // next 2 bytes unknown
1648    
1649            store16(&pData[14], LFO1InternalDepth);
1650    
1651            // next 2 bytes unknown
1652    
1653            store16(&pData[18], LFO3InternalDepth);
1654    
1655            // next 2 bytes unknown
1656    
1657            store16(&pData[22], LFO1ControlDepth);
1658    
1659            // next 2 bytes unknown
1660    
1661            store16(&pData[26], LFO3ControlDepth);
1662    
1663            const int32_t eg1attack = (int32_t) GIG_EXP_ENCODE(EG1Attack);
1664            store32(&pData[28], eg1attack);
1665    
1666            const int32_t eg1decay1 = (int32_t) GIG_EXP_ENCODE(EG1Decay1);
1667            store32(&pData[32], eg1decay1);
1668    
1669            // next 2 bytes unknown
1670    
1671            store16(&pData[38], EG1Sustain);
1672    
1673            const int32_t eg1release = (int32_t) GIG_EXP_ENCODE(EG1Release);
1674            store32(&pData[40], eg1release);
1675    
1676            const uint8_t eg1ctl = (uint8_t) EncodeLeverageController(EG1Controller);
1677            pData[44] = eg1ctl;
1678    
1679            const uint8_t eg1ctrloptions =
1680                (EG1ControllerInvert ? 0x01 : 0x00) |
1681                GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG1ControllerAttackInfluence) |
1682                GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG1ControllerDecayInfluence) |
1683                GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG1ControllerReleaseInfluence);
1684            pData[45] = eg1ctrloptions;
1685    
1686            const uint8_t eg2ctl = (uint8_t) EncodeLeverageController(EG2Controller);
1687            pData[46] = eg2ctl;
1688    
1689            const uint8_t eg2ctrloptions =
1690                (EG2ControllerInvert ? 0x01 : 0x00) |
1691                GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG2ControllerAttackInfluence) |
1692                GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG2ControllerDecayInfluence) |
1693                GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG2ControllerReleaseInfluence);
1694            pData[47] = eg2ctrloptions;
1695    
1696            const int32_t lfo1freq = (int32_t) GIG_EXP_ENCODE(LFO1Frequency);
1697            store32(&pData[48], lfo1freq);
1698    
1699            const int32_t eg2attack = (int32_t) GIG_EXP_ENCODE(EG2Attack);
1700            store32(&pData[52], eg2attack);
1701    
1702            const int32_t eg2decay1 = (int32_t) GIG_EXP_ENCODE(EG2Decay1);
1703            store32(&pData[56], eg2decay1);
1704    
1705            // next 2 bytes unknown
1706    
1707            store16(&pData[62], EG2Sustain);
1708    
1709            const int32_t eg2release = (int32_t) GIG_EXP_ENCODE(EG2Release);
1710            store32(&pData[64], eg2release);
1711    
1712            // next 2 bytes unknown
1713    
1714            store16(&pData[70], LFO2ControlDepth);
1715    
1716            const int32_t lfo2freq = (int32_t) GIG_EXP_ENCODE(LFO2Frequency);
1717            store32(&pData[72], lfo2freq);
1718    
1719            // next 2 bytes unknown
1720    
1721            store16(&pData[78], LFO2InternalDepth);
1722    
1723            const int32_t eg1decay2 = (int32_t) (EG1InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG1Decay2);
1724            store32(&pData[80], eg1decay2);
1725    
1726            // next 2 bytes unknown
1727    
1728            store16(&pData[86], EG1PreAttack);
1729    
1730            const int32_t eg2decay2 = (int32_t) (EG2InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG2Decay2);
1731            store32(&pData[88], eg2decay2);
1732    
1733            // next 2 bytes unknown
1734    
1735            store16(&pData[94], EG2PreAttack);
1736    
1737            {
1738                if (VelocityResponseDepth > 4) throw Exception("VelocityResponseDepth must be between 0 and 4");
1739                uint8_t velocityresponse = VelocityResponseDepth;
1740                switch (VelocityResponseCurve) {
1741                    case curve_type_nonlinear:
1742                        break;
1743                    case curve_type_linear:
1744                        velocityresponse += 5;
1745                        break;
1746                    case curve_type_special:
1747                        velocityresponse += 10;
1748                        break;
1749                    case curve_type_unknown:
1750                    default:
1751                        throw Exception("Could not update DimensionRegion's chunk, unknown VelocityResponseCurve selected");
1752                }
1753                pData[96] = velocityresponse;
1754          }          }
1755          else {  
1756              ReleaseVelocityResponseCurve = curve_type_unknown;          {
1757              ReleaseVelocityResponseDepth = 0;              if (ReleaseVelocityResponseDepth > 4) throw Exception("ReleaseVelocityResponseDepth must be between 0 and 4");
1758                uint8_t releasevelocityresponse = ReleaseVelocityResponseDepth;
1759                switch (ReleaseVelocityResponseCurve) {
1760                    case curve_type_nonlinear:
1761                        break;
1762                    case curve_type_linear:
1763                        releasevelocityresponse += 5;
1764                        break;
1765                    case curve_type_special:
1766                        releasevelocityresponse += 10;
1767                        break;
1768                    case curve_type_unknown:
1769                    default:
1770                        throw Exception("Could not update DimensionRegion's chunk, unknown ReleaseVelocityResponseCurve selected");
1771                }
1772                pData[97] = releasevelocityresponse;
1773          }          }
1774          VelocityResponseCurveScaling = _3ewa->ReadUint8();  
1775          AttenuationControllerThreshold = _3ewa->ReadInt8();          pData[98] = VelocityResponseCurveScaling;
1776          _3ewa->ReadInt32(); // unknown  
1777          SampleStartOffset = (uint16_t) _3ewa->ReadInt16();          pData[99] = AttenuationControllerThreshold;
1778          _3ewa->ReadInt16(); // unknown  
1779          uint8_t pitchTrackDimensionBypass = _3ewa->ReadInt8();          // next 4 bytes unknown
1780          PitchTrack = GIG_PITCH_TRACK_EXTRACT(pitchTrackDimensionBypass);  
1781          if      (pitchTrackDimensionBypass & 0x10) DimensionBypass = dim_bypass_ctrl_94;          store16(&pData[104], SampleStartOffset);
1782          else if (pitchTrackDimensionBypass & 0x20) DimensionBypass = dim_bypass_ctrl_95;  
1783          else                                       DimensionBypass = dim_bypass_ctrl_none;          // next 2 bytes unknown
1784          uint8_t pan = _3ewa->ReadUint8();  
1785          Pan         = (pan < 64) ? pan : -((int)pan - 63); // signed 7 bit -> signed 8 bit          {
1786          SelfMask = _3ewa->ReadInt8() & 0x01;              uint8_t pitchTrackDimensionBypass = GIG_PITCH_TRACK_ENCODE(PitchTrack);
1787          _3ewa->ReadInt8(); // unknown              switch (DimensionBypass) {
1788          uint8_t lfo3ctrl = _3ewa->ReadUint8();                  case dim_bypass_ctrl_94:
1789          LFO3Controller           = static_cast<lfo3_ctrl_t>(lfo3ctrl & 0x07); // lower 3 bits                      pitchTrackDimensionBypass |= 0x10;
1790          LFO3Sync                 = lfo3ctrl & 0x20; // bit 5                      break;
1791          InvertAttenuationController = lfo3ctrl & 0x80; // bit 7                  case dim_bypass_ctrl_95:
1792          AttenuationController  = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));                      pitchTrackDimensionBypass |= 0x20;
1793          uint8_t lfo2ctrl       = _3ewa->ReadUint8();                      break;
1794          LFO2Controller         = static_cast<lfo2_ctrl_t>(lfo2ctrl & 0x07); // lower 3 bits                  case dim_bypass_ctrl_none:
1795          LFO2FlipPhase          = lfo2ctrl & 0x80; // bit 7                      //FIXME: should we set anything here?
1796          LFO2Sync               = lfo2ctrl & 0x20; // bit 5                      break;
1797          bool extResonanceCtrl  = lfo2ctrl & 0x40; // bit 6                  default:
1798          uint8_t lfo1ctrl       = _3ewa->ReadUint8();                      throw Exception("Could not update DimensionRegion's chunk, unknown DimensionBypass selected");
1799          LFO1Controller         = static_cast<lfo1_ctrl_t>(lfo1ctrl & 0x07); // lower 3 bits              }
1800          LFO1FlipPhase          = lfo1ctrl & 0x80; // bit 7              pData[108] = pitchTrackDimensionBypass;
         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;  
1801          }          }
1802    
1803          // get the corresponding velocity->volume table from the table map or create & calculate that table if it doesn't exist yet          const uint8_t pan = (Pan >= 0) ? Pan : ((-Pan) + 63); // signed 8 bit -> signed 7 bit
1804          uint32_t tableKey = (VelocityResponseCurve<<16) | (VelocityResponseDepth<<8) | VelocityResponseCurveScaling;          pData[109] = pan;
1805    
1806            const uint8_t selfmask = (SelfMask) ? 0x01 : 0x00;
1807            pData[110] = selfmask;
1808    
1809            // next byte unknown
1810    
1811            {
1812                uint8_t lfo3ctrl = LFO3Controller & 0x07; // lower 3 bits
1813                if (LFO3Sync) lfo3ctrl |= 0x20; // bit 5
1814                if (InvertAttenuationController) lfo3ctrl |= 0x80; // bit 7
1815                if (VCFType == vcf_type_lowpassturbo) lfo3ctrl |= 0x40; // bit 6
1816                pData[112] = lfo3ctrl;
1817            }
1818    
1819            const uint8_t attenctl = EncodeLeverageController(AttenuationController);
1820            pData[113] = attenctl;
1821    
1822            {
1823                uint8_t lfo2ctrl = LFO2Controller & 0x07; // lower 3 bits
1824                if (LFO2FlipPhase) lfo2ctrl |= 0x80; // bit 7
1825                if (LFO2Sync)      lfo2ctrl |= 0x20; // bit 5
1826                if (VCFResonanceController != vcf_res_ctrl_none) lfo2ctrl |= 0x40; // bit 6
1827                pData[114] = lfo2ctrl;
1828            }
1829    
1830            {
1831                uint8_t lfo1ctrl = LFO1Controller & 0x07; // lower 3 bits
1832                if (LFO1FlipPhase) lfo1ctrl |= 0x80; // bit 7
1833                if (LFO1Sync)      lfo1ctrl |= 0x40; // bit 6
1834                if (VCFResonanceController != vcf_res_ctrl_none)
1835                    lfo1ctrl |= GIG_VCF_RESONANCE_CTRL_ENCODE(VCFResonanceController);
1836                pData[115] = lfo1ctrl;
1837            }
1838    
1839            const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth
1840                                                      : uint16_t(((-EG3Depth) - 1) ^ 0xffff); /* binary complementary for negatives */
1841            store16(&pData[116], eg3depth);
1842    
1843            // next 2 bytes unknown
1844    
1845            const uint8_t channeloffset = ChannelOffset * 4;
1846            pData[120] = channeloffset;
1847    
1848            {
1849                uint8_t regoptions = 0;
1850                if (MSDecode)      regoptions |= 0x01; // bit 0
1851                if (SustainDefeat) regoptions |= 0x02; // bit 1
1852                pData[121] = regoptions;
1853            }
1854    
1855            // next 2 bytes unknown
1856    
1857            pData[124] = VelocityUpperLimit;
1858    
1859            // next 3 bytes unknown
1860    
1861            pData[128] = ReleaseTriggerDecay;
1862    
1863            // next 2 bytes unknown
1864    
1865            const uint8_t eg1hold = (EG1Hold) ? 0x80 : 0x00; // bit 7
1866            pData[131] = eg1hold;
1867    
1868            const uint8_t vcfcutoff = (VCFEnabled ? 0x80 : 0x00) |  /* bit 7 */
1869                                      (VCFCutoff & 0x7f);   /* lower 7 bits */
1870            pData[132] = vcfcutoff;
1871    
1872            pData[133] = VCFCutoffController;
1873    
1874            const uint8_t vcfvelscale = (VCFCutoffControllerInvert ? 0x80 : 0x00) | /* bit 7 */
1875                                        (VCFVelocityScale & 0x7f); /* lower 7 bits */
1876            pData[134] = vcfvelscale;
1877    
1878            // next byte unknown
1879    
1880            const uint8_t vcfresonance = (VCFResonanceDynamic ? 0x00 : 0x80) | /* bit 7 */
1881                                         (VCFResonance & 0x7f); /* lower 7 bits */
1882            pData[136] = vcfresonance;
1883    
1884            const uint8_t vcfbreakpoint = (VCFKeyboardTracking ? 0x80 : 0x00) | /* bit 7 */
1885                                          (VCFKeyboardTrackingBreakpoint & 0x7f); /* lower 7 bits */
1886            pData[137] = vcfbreakpoint;
1887    
1888            const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 |
1889                                        VCFVelocityCurve * 5;
1890            pData[138] = vcfvelocity;
1891    
1892            const uint8_t vcftype = (VCFType == vcf_type_lowpassturbo) ? vcf_type_lowpass : VCFType;
1893            pData[139] = vcftype;
1894    
1895            if (chunksize >= 148) {
1896                memcpy(&pData[140], DimensionUpperLimits, 8);
1897            }
1898        }
1899    
1900        double* DimensionRegion::GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth) {
1901            curve_type_t curveType = releaseVelocityResponseCurve;
1902            uint8_t depth = releaseVelocityResponseDepth;
1903            // this models a strange behaviour or bug in GSt: two of the
1904            // velocity response curves for release time are not used even
1905            // if specified, instead another curve is chosen.
1906            if ((curveType == curve_type_nonlinear && depth == 0) ||
1907                (curveType == curve_type_special   && depth == 4)) {
1908                curveType = curve_type_nonlinear;
1909                depth = 3;
1910            }
1911            return GetVelocityTable(curveType, depth, 0);
1912        }
1913    
1914        double* DimensionRegion::GetCutoffVelocityTable(curve_type_t vcfVelocityCurve,
1915                                                        uint8_t vcfVelocityDynamicRange,
1916                                                        uint8_t vcfVelocityScale,
1917                                                        vcf_cutoff_ctrl_t vcfCutoffController)
1918        {
1919            curve_type_t curveType = vcfVelocityCurve;
1920            uint8_t depth = vcfVelocityDynamicRange;
1921            // even stranger GSt: two of the velocity response curves for
1922            // filter cutoff are not used, instead another special curve
1923            // is chosen. This curve is not used anywhere else.
1924            if ((curveType == curve_type_nonlinear && depth == 0) ||
1925                (curveType == curve_type_special   && depth == 4)) {
1926                curveType = curve_type_special;
1927                depth = 5;
1928            }
1929            return GetVelocityTable(curveType, depth,
1930                                    (vcfCutoffController <= vcf_cutoff_ctrl_none2)
1931                                        ? vcfVelocityScale : 0);
1932        }
1933    
1934        // get the corresponding velocity table from the table map or create & calculate that table if it doesn't exist yet
1935        double* DimensionRegion::GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling)
1936        {
1937            double* table;
1938            uint32_t tableKey = (curveType<<16) | (depth<<8) | scaling;
1939          if (pVelocityTables->count(tableKey)) { // if key exists          if (pVelocityTables->count(tableKey)) { // if key exists
1940              pVelocityAttenuationTable = (*pVelocityTables)[tableKey];              table = (*pVelocityTables)[tableKey];
1941          }          }
1942          else {          else {
1943              pVelocityAttenuationTable =              table = CreateVelocityTable(curveType, depth, scaling);
1944                  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  
1945          }          }
1946            return table;
1947        }
1948    
1949          SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));      Region* DimensionRegion::GetParent() const {
1950            return pRegion;
1951      }      }
1952    
1953      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {
# Line 1247  namespace gig { namespace { Line 2068  namespace gig { namespace {
2068          return decodedcontroller;          return decodedcontroller;
2069      }      }
2070    
2071        DimensionRegion::_lev_ctrl_t DimensionRegion::EncodeLeverageController(leverage_ctrl_t DecodedController) {
2072            _lev_ctrl_t encodedcontroller;
2073            switch (DecodedController.type) {
2074                // special controller
2075                case leverage_ctrl_t::type_none:
2076                    encodedcontroller = _lev_ctrl_none;
2077                    break;
2078                case leverage_ctrl_t::type_velocity:
2079                    encodedcontroller = _lev_ctrl_velocity;
2080                    break;
2081                case leverage_ctrl_t::type_channelaftertouch:
2082                    encodedcontroller = _lev_ctrl_channelaftertouch;
2083                    break;
2084    
2085                // ordinary MIDI control change controller
2086                case leverage_ctrl_t::type_controlchange:
2087                    switch (DecodedController.controller_number) {
2088                        case 1:
2089                            encodedcontroller = _lev_ctrl_modwheel;
2090                            break;
2091                        case 2:
2092                            encodedcontroller = _lev_ctrl_breath;
2093                            break;
2094                        case 4:
2095                            encodedcontroller = _lev_ctrl_foot;
2096                            break;
2097                        case 12:
2098                            encodedcontroller = _lev_ctrl_effect1;
2099                            break;
2100                        case 13:
2101                            encodedcontroller = _lev_ctrl_effect2;
2102                            break;
2103                        case 16:
2104                            encodedcontroller = _lev_ctrl_genpurpose1;
2105                            break;
2106                        case 17:
2107                            encodedcontroller = _lev_ctrl_genpurpose2;
2108                            break;
2109                        case 18:
2110                            encodedcontroller = _lev_ctrl_genpurpose3;
2111                            break;
2112                        case 19:
2113                            encodedcontroller = _lev_ctrl_genpurpose4;
2114                            break;
2115                        case 5:
2116                            encodedcontroller = _lev_ctrl_portamentotime;
2117                            break;
2118                        case 64:
2119                            encodedcontroller = _lev_ctrl_sustainpedal;
2120                            break;
2121                        case 65:
2122                            encodedcontroller = _lev_ctrl_portamento;
2123                            break;
2124                        case 66:
2125                            encodedcontroller = _lev_ctrl_sostenutopedal;
2126                            break;
2127                        case 67:
2128                            encodedcontroller = _lev_ctrl_softpedal;
2129                            break;
2130                        case 80:
2131                            encodedcontroller = _lev_ctrl_genpurpose5;
2132                            break;
2133                        case 81:
2134                            encodedcontroller = _lev_ctrl_genpurpose6;
2135                            break;
2136                        case 82:
2137                            encodedcontroller = _lev_ctrl_genpurpose7;
2138                            break;
2139                        case 83:
2140                            encodedcontroller = _lev_ctrl_genpurpose8;
2141                            break;
2142                        case 91:
2143                            encodedcontroller = _lev_ctrl_effect1depth;
2144                            break;
2145                        case 92:
2146                            encodedcontroller = _lev_ctrl_effect2depth;
2147                            break;
2148                        case 93:
2149                            encodedcontroller = _lev_ctrl_effect3depth;
2150                            break;
2151                        case 94:
2152                            encodedcontroller = _lev_ctrl_effect4depth;
2153                            break;
2154                        case 95:
2155                            encodedcontroller = _lev_ctrl_effect5depth;
2156                            break;
2157                        default:
2158                            throw gig::Exception("leverage controller number is not supported by the gig format");
2159                    }
2160                    break;
2161                default:
2162                    throw gig::Exception("Unknown leverage controller type.");
2163            }
2164            return encodedcontroller;
2165        }
2166    
2167      DimensionRegion::~DimensionRegion() {      DimensionRegion::~DimensionRegion() {
2168          Instances--;          Instances--;
2169          if (!Instances) {          if (!Instances) {
# Line 1260  namespace gig { namespace { Line 2177  namespace gig { namespace {
2177              delete pVelocityTables;              delete pVelocityTables;
2178              pVelocityTables = NULL;              pVelocityTables = NULL;
2179          }          }
2180            if (VelocityTable) delete[] VelocityTable;
2181      }      }
2182    
2183      /**      /**
# Line 1277  namespace gig { namespace { Line 2195  namespace gig { namespace {
2195          return pVelocityAttenuationTable[MIDIKeyVelocity];          return pVelocityAttenuationTable[MIDIKeyVelocity];
2196      }      }
2197    
2198        double DimensionRegion::GetVelocityRelease(uint8_t MIDIKeyVelocity) {
2199            return pVelocityReleaseTable[MIDIKeyVelocity];
2200        }
2201    
2202        double DimensionRegion::GetVelocityCutoff(uint8_t MIDIKeyVelocity) {
2203            return pVelocityCutoffTable[MIDIKeyVelocity];
2204        }
2205    
2206        /**
2207         * Updates the respective member variable and the lookup table / cache
2208         * that depends on this value.
2209         */
2210        void DimensionRegion::SetVelocityResponseCurve(curve_type_t curve) {
2211            pVelocityAttenuationTable =
2212                GetVelocityTable(
2213                    curve, VelocityResponseDepth, VelocityResponseCurveScaling
2214                );
2215            VelocityResponseCurve = curve;
2216        }
2217    
2218        /**
2219         * Updates the respective member variable and the lookup table / cache
2220         * that depends on this value.
2221         */
2222        void DimensionRegion::SetVelocityResponseDepth(uint8_t depth) {
2223            pVelocityAttenuationTable =
2224                GetVelocityTable(
2225                    VelocityResponseCurve, depth, VelocityResponseCurveScaling
2226                );
2227            VelocityResponseDepth = depth;
2228        }
2229    
2230        /**
2231         * Updates the respective member variable and the lookup table / cache
2232         * that depends on this value.
2233         */
2234        void DimensionRegion::SetVelocityResponseCurveScaling(uint8_t scaling) {
2235            pVelocityAttenuationTable =
2236                GetVelocityTable(
2237                    VelocityResponseCurve, VelocityResponseDepth, scaling
2238                );
2239            VelocityResponseCurveScaling = scaling;
2240        }
2241    
2242        /**
2243         * Updates the respective member variable and the lookup table / cache
2244         * that depends on this value.
2245         */
2246        void DimensionRegion::SetReleaseVelocityResponseCurve(curve_type_t curve) {
2247            pVelocityReleaseTable = GetReleaseVelocityTable(curve, ReleaseVelocityResponseDepth);
2248            ReleaseVelocityResponseCurve = curve;
2249        }
2250    
2251        /**
2252         * Updates the respective member variable and the lookup table / cache
2253         * that depends on this value.
2254         */
2255        void DimensionRegion::SetReleaseVelocityResponseDepth(uint8_t depth) {
2256            pVelocityReleaseTable = GetReleaseVelocityTable(ReleaseVelocityResponseCurve, depth);
2257            ReleaseVelocityResponseDepth = depth;
2258        }
2259    
2260        /**
2261         * Updates the respective member variable and the lookup table / cache
2262         * that depends on this value.
2263         */
2264        void DimensionRegion::SetVCFCutoffController(vcf_cutoff_ctrl_t controller) {
2265            pVelocityCutoffTable = GetCutoffVelocityTable(VCFVelocityCurve, VCFVelocityDynamicRange, VCFVelocityScale, controller);
2266            VCFCutoffController = controller;
2267        }
2268    
2269        /**
2270         * Updates the respective member variable and the lookup table / cache
2271         * that depends on this value.
2272         */
2273        void DimensionRegion::SetVCFVelocityCurve(curve_type_t curve) {
2274            pVelocityCutoffTable = GetCutoffVelocityTable(curve, VCFVelocityDynamicRange, VCFVelocityScale, VCFCutoffController);
2275            VCFVelocityCurve = curve;
2276        }
2277    
2278        /**
2279         * Updates the respective member variable and the lookup table / cache
2280         * that depends on this value.
2281         */
2282        void DimensionRegion::SetVCFVelocityDynamicRange(uint8_t range) {
2283            pVelocityCutoffTable = GetCutoffVelocityTable(VCFVelocityCurve, range, VCFVelocityScale, VCFCutoffController);
2284            VCFVelocityDynamicRange = range;
2285        }
2286    
2287        /**
2288         * Updates the respective member variable and the lookup table / cache
2289         * that depends on this value.
2290         */
2291        void DimensionRegion::SetVCFVelocityScale(uint8_t scaling) {
2292            pVelocityCutoffTable = GetCutoffVelocityTable(VCFVelocityCurve, VCFVelocityDynamicRange, scaling, VCFCutoffController);
2293            VCFVelocityScale = scaling;
2294        }
2295    
2296      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) {
2297    
2298          // line-segment approximations of the 15 velocity curves          // line-segment approximations of the 15 velocity curves
# Line 1310  namespace gig { namespace { Line 2326  namespace gig { namespace {
2326          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,
2327                               127, 127 };                               127, 127 };
2328    
2329            // this is only used by the VCF velocity curve
2330            const int spe5[] = { 1, 2, 30, 5, 60, 19, 77, 70, 83, 85, 88, 106,
2331                                 91, 127, 127, 127 };
2332    
2333          const int* const curves[] = { non0, non1, non2, non3, non4,          const int* const curves[] = { non0, non1, non2, non3, non4,
2334                                        lin0, lin1, lin2, lin3, lin4,                                        lin0, lin1, lin2, lin3, lin4,
2335                                        spe0, spe1, spe2, spe3, spe4 };                                        spe0, spe1, spe2, spe3, spe4, spe5 };
2336    
2337          double* const table = new double[128];          double* const table = new double[128];
2338    
# Line 1356  namespace gig { namespace { Line 2376  namespace gig { namespace {
2376    
2377          // Actual Loading          // Actual Loading
2378    
2379            if (!file->GetAutoLoad()) return;
2380    
2381          LoadDimensionRegions(rgnList);          LoadDimensionRegions(rgnList);
2382    
2383          RIFF::Chunk* _3lnk = rgnList->GetSubChunk(CHUNK_ID_3LNK);          RIFF::Chunk* _3lnk = rgnList->GetSubChunk(CHUNK_ID_3LNK);
# Line 1364  namespace gig { namespace { Line 2386  namespace gig { namespace {
2386              for (int i = 0; i < dimensionBits; i++) {              for (int i = 0; i < dimensionBits; i++) {
2387                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());
2388                  uint8_t     bits      = _3lnk->ReadUint8();                  uint8_t     bits      = _3lnk->ReadUint8();
2389                    _3lnk->ReadUint8(); // bit position of the dimension (bits[0] + bits[1] + ... + bits[i-1])
2390                    _3lnk->ReadUint8(); // (1 << bit position of next dimension) - (1 << bit position of this dimension)
2391                    uint8_t     zones     = _3lnk->ReadUint8(); // new for v3: number of zones doesn't have to be == pow(2,bits)
2392                  if (dimension == dimension_none) { // inactive dimension                  if (dimension == dimension_none) { // inactive dimension
2393                      pDimensionDefinitions[i].dimension  = dimension_none;                      pDimensionDefinitions[i].dimension  = dimension_none;
2394                      pDimensionDefinitions[i].bits       = 0;                      pDimensionDefinitions[i].bits       = 0;
2395                      pDimensionDefinitions[i].zones      = 0;                      pDimensionDefinitions[i].zones      = 0;
2396                      pDimensionDefinitions[i].split_type = split_type_bit;                      pDimensionDefinitions[i].split_type = split_type_bit;
                     pDimensionDefinitions[i].ranges     = NULL;  
2397                      pDimensionDefinitions[i].zone_size  = 0;                      pDimensionDefinitions[i].zone_size  = 0;
2398                  }                  }
2399                  else { // active dimension                  else { // active dimension
2400                      pDimensionDefinitions[i].dimension = dimension;                      pDimensionDefinitions[i].dimension = dimension;
2401                      pDimensionDefinitions[i].bits      = bits;                      pDimensionDefinitions[i].bits      = bits;
2402                      pDimensionDefinitions[i].zones     = 0x01 << bits; // = pow(2,bits)                      pDimensionDefinitions[i].zones     = zones ? zones : 0x01 << bits; // = pow(2,bits)
2403                      pDimensionDefinitions[i].split_type = (dimension == dimension_layer ||                      pDimensionDefinitions[i].split_type = __resolveSplitType(dimension);
2404                                                             dimension == dimension_samplechannel ||                      pDimensionDefinitions[i].zone_size  = __resolveZoneSize(pDimensionDefinitions[i]);
                                                            dimension == dimension_releasetrigger) ? 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;  
2405                      Dimensions++;                      Dimensions++;
2406    
2407                      // if this is a layer dimension, remember the amount of layers                      // if this is a layer dimension, remember the amount of layers
2408                      if (dimension == dimension_layer) Layers = pDimensionDefinitions[i].zones;                      if (dimension == dimension_layer) Layers = pDimensionDefinitions[i].zones;
2409                  }                  }
2410                  _3lnk->SetPos(6, RIFF::stream_curpos); // jump forward to next dimension definition                  _3lnk->SetPos(3, RIFF::stream_curpos); // jump forward to next dimension definition
2411              }              }
2412                for (int i = dimensionBits ; i < 8 ; i++) pDimensionDefinitions[i].bits = 0;
2413    
2414              // 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,
2415              for (uint i = 0; i < Dimensions; i++) {              // update the VelocityTables in the dimension regions
2416                  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;  
                             }  
                         }  
                     }  
                 }  
             }  
2417    
2418              // 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();  
2419              if (file->pVersion && file->pVersion->major == 3)              if (file->pVersion && file->pVersion->major == 3)
2420                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure
2421              else              else
2422                  _3lnk->SetPos(44);                  _3lnk->SetPos(44);
2423    
2424              // load sample references              // load sample references (if auto loading is enabled)
2425              for (uint i = 0; i < DimensionRegions; i++) {              if (file->GetAutoLoad()) {
2426                  uint32_t wavepoolindex = _3lnk->ReadUint32();                  for (uint i = 0; i < DimensionRegions; i++) {
2427                  pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);                      uint32_t wavepoolindex = _3lnk->ReadUint32();
2428                        if (file->pWavePoolTable) pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);
2429                    }
2430                    GetSample(); // load global region sample reference
2431                }
2432            } else {
2433                DimensionRegions = 0;
2434                for (int i = 0 ; i < 8 ; i++) {
2435                    pDimensionDefinitions[i].dimension  = dimension_none;
2436                    pDimensionDefinitions[i].bits       = 0;
2437                    pDimensionDefinitions[i].zones      = 0;
2438                }
2439            }
2440    
2441            // make sure there is at least one dimension region
2442            if (!DimensionRegions) {
2443                RIFF::List* _3prg = rgnList->GetSubList(LIST_TYPE_3PRG);
2444                if (!_3prg) _3prg = rgnList->AddSubList(LIST_TYPE_3PRG);
2445                RIFF::List* _3ewl = _3prg->AddSubList(LIST_TYPE_3EWL);
2446                pDimensionRegions[0] = new DimensionRegion(this, _3ewl);
2447                DimensionRegions = 1;
2448            }
2449        }
2450    
2451        /**
2452         * Apply Region settings and all its DimensionRegions to the respective
2453         * RIFF chunks. You have to call File::Save() to make changes persistent.
2454         *
2455         * Usually there is absolutely no need to call this method explicitly.
2456         * It will be called automatically when File::Save() was called.
2457         *
2458         * @throws gig::Exception if samples cannot be dereferenced
2459         */
2460        void Region::UpdateChunks() {
2461            // in the gig format we don't care about the Region's sample reference
2462            // but we still have to provide some existing one to not corrupt the
2463            // file, so to avoid the latter we simply always assign the sample of
2464            // the first dimension region of this region
2465            pSample = pDimensionRegions[0]->pSample;
2466    
2467            // first update base class's chunks
2468            DLS::Region::UpdateChunks();
2469    
2470            // update dimension region's chunks
2471            for (int i = 0; i < DimensionRegions; i++) {
2472                pDimensionRegions[i]->UpdateChunks();
2473            }
2474    
2475            File* pFile = (File*) GetParent()->GetParent();
2476            bool version3 = pFile->pVersion && pFile->pVersion->major == 3;
2477            const int iMaxDimensions =  version3 ? 8 : 5;
2478            const int iMaxDimensionRegions = version3 ? 256 : 32;
2479    
2480            // make sure '3lnk' chunk exists
2481            RIFF::Chunk* _3lnk = pCkRegion->GetSubChunk(CHUNK_ID_3LNK);
2482            if (!_3lnk) {
2483                const int _3lnkChunkSize = version3 ? 1092 : 172;
2484                _3lnk = pCkRegion->AddSubChunk(CHUNK_ID_3LNK, _3lnkChunkSize);
2485                memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);
2486    
2487                // move 3prg to last position
2488                pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3PRG), 0);
2489            }
2490    
2491            // update dimension definitions in '3lnk' chunk
2492            uint8_t* pData = (uint8_t*) _3lnk->LoadChunkData();
2493            store32(&pData[0], DimensionRegions);
2494            int shift = 0;
2495            for (int i = 0; i < iMaxDimensions; i++) {
2496                pData[4 + i * 8] = (uint8_t) pDimensionDefinitions[i].dimension;
2497                pData[5 + i * 8] = pDimensionDefinitions[i].bits;
2498                pData[6 + i * 8] = pDimensionDefinitions[i].dimension == dimension_none ? 0 : shift;
2499                pData[7 + i * 8] = (1 << (shift + pDimensionDefinitions[i].bits)) - (1 << shift);
2500                pData[8 + i * 8] = pDimensionDefinitions[i].zones;
2501                // next 3 bytes unknown, always zero?
2502    
2503                shift += pDimensionDefinitions[i].bits;
2504            }
2505    
2506            // update wave pool table in '3lnk' chunk
2507            const int iWavePoolOffset = version3 ? 68 : 44;
2508            for (uint i = 0; i < iMaxDimensionRegions; i++) {
2509                int iWaveIndex = -1;
2510                if (i < DimensionRegions) {
2511                    if (!pFile->pSamples || !pFile->pSamples->size()) throw gig::Exception("Could not update gig::Region, there are no samples");
2512                    File::SampleList::iterator iter = pFile->pSamples->begin();
2513                    File::SampleList::iterator end  = pFile->pSamples->end();
2514                    for (int index = 0; iter != end; ++iter, ++index) {
2515                        if (*iter == pDimensionRegions[i]->pSample) {
2516                            iWaveIndex = index;
2517                            break;
2518                        }
2519                    }
2520              }              }
2521                store32(&pData[iWavePoolOffset + i * 4], iWaveIndex);
2522          }          }
         else throw gig::Exception("Mandatory <3lnk> chunk not found.");  
2523      }      }
2524    
2525      void Region::LoadDimensionRegions(RIFF::List* rgn) {      void Region::LoadDimensionRegions(RIFF::List* rgn) {
# Line 1445  namespace gig { namespace { Line 2529  namespace gig { namespace {
2529              RIFF::List* _3ewl = _3prg->GetFirstSubList();              RIFF::List* _3ewl = _3prg->GetFirstSubList();
2530              while (_3ewl) {              while (_3ewl) {
2531                  if (_3ewl->GetListType() == LIST_TYPE_3EWL) {                  if (_3ewl->GetListType() == LIST_TYPE_3EWL) {
2532                      pDimensionRegions[dimensionRegionNr] = new DimensionRegion(_3ewl);                      pDimensionRegions[dimensionRegionNr] = new DimensionRegion(this, _3ewl);
2533                      dimensionRegionNr++;                      dimensionRegionNr++;
2534                  }                  }
2535                  _3ewl = _3prg->GetNextSubList();                  _3ewl = _3prg->GetNextSubList();
# Line 1454  namespace gig { namespace { Line 2538  namespace gig { namespace {
2538          }          }
2539      }      }
2540    
2541      Region::~Region() {      void Region::SetKeyRange(uint16_t Low, uint16_t High) {
2542          for (uint i = 0; i < Dimensions; i++) {          // update KeyRange struct and make sure regions are in correct order
2543              if (pDimensionDefinitions[i].ranges) delete[] pDimensionDefinitions[i].ranges;          DLS::Region::SetKeyRange(Low, High);
2544            // update Region key table for fast lookup
2545            ((gig::Instrument*)GetParent())->UpdateRegionKeyTable();
2546        }
2547    
2548        void Region::UpdateVelocityTable() {
2549            // get velocity dimension's index
2550            int veldim = -1;
2551            for (int i = 0 ; i < Dimensions ; i++) {
2552                if (pDimensionDefinitions[i].dimension == gig::dimension_velocity) {
2553                    veldim = i;
2554                    break;
2555                }
2556          }          }
2557            if (veldim == -1) return;
2558    
2559            int step = 1;
2560            for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;
2561            int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;
2562            int end = step * pDimensionDefinitions[veldim].zones;
2563    
2564            // loop through all dimension regions for all dimensions except the velocity dimension
2565            int dim[8] = { 0 };
2566            for (int i = 0 ; i < DimensionRegions ; i++) {
2567    
2568                if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||
2569                    pDimensionRegions[i]->VelocityUpperLimit) {
2570                    // create the velocity table
2571                    uint8_t* table = pDimensionRegions[i]->VelocityTable;
2572                    if (!table) {
2573                        table = new uint8_t[128];
2574                        pDimensionRegions[i]->VelocityTable = table;
2575                    }
2576                    int tableidx = 0;
2577                    int velocityZone = 0;
2578                    if (pDimensionRegions[i]->DimensionUpperLimits[veldim]) { // gig3
2579                        for (int k = i ; k < end ; k += step) {
2580                            DimensionRegion *d = pDimensionRegions[k];
2581                            for (; tableidx <= d->DimensionUpperLimits[veldim] ; tableidx++) table[tableidx] = velocityZone;
2582                            velocityZone++;
2583                        }
2584                    } else { // gig2
2585                        for (int k = i ; k < end ; k += step) {
2586                            DimensionRegion *d = pDimensionRegions[k];
2587                            for (; tableidx <= d->VelocityUpperLimit ; tableidx++) table[tableidx] = velocityZone;
2588                            velocityZone++;
2589                        }
2590                    }
2591                } else {
2592                    if (pDimensionRegions[i]->VelocityTable) {
2593                        delete[] pDimensionRegions[i]->VelocityTable;
2594                        pDimensionRegions[i]->VelocityTable = 0;
2595                    }
2596                }
2597    
2598                int j;
2599                int shift = 0;
2600                for (j = 0 ; j < Dimensions ; j++) {
2601                    if (j == veldim) i += skipveldim; // skip velocity dimension
2602                    else {
2603                        dim[j]++;
2604                        if (dim[j] < pDimensionDefinitions[j].zones) break;
2605                        else {
2606                            // skip unused dimension regions
2607                            dim[j] = 0;
2608                            i += ((1 << pDimensionDefinitions[j].bits) -
2609                                  pDimensionDefinitions[j].zones) << shift;
2610                        }
2611                    }
2612                    shift += pDimensionDefinitions[j].bits;
2613                }
2614                if (j == Dimensions) break;
2615            }
2616        }
2617    
2618        /** @brief Einstein would have dreamed of it - create a new dimension.
2619         *
2620         * Creates a new dimension with the dimension definition given by
2621         * \a pDimDef. The appropriate amount of DimensionRegions will be created.
2622         * There is a hard limit of dimensions and total amount of "bits" all
2623         * dimensions can have. This limit is dependant to what gig file format
2624         * version this file refers to. The gig v2 (and lower) format has a
2625         * dimension limit and total amount of bits limit of 5, whereas the gig v3
2626         * format has a limit of 8.
2627         *
2628         * @param pDimDef - defintion of the new dimension
2629         * @throws gig::Exception if dimension of the same type exists already
2630         * @throws gig::Exception if amount of dimensions or total amount of
2631         *                        dimension bits limit is violated
2632         */
2633        void Region::AddDimension(dimension_def_t* pDimDef) {
2634            // check if max. amount of dimensions reached
2635            File* file = (File*) GetParent()->GetParent();
2636            const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;
2637            if (Dimensions >= iMaxDimensions)
2638                throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimensions already reached");
2639            // check if max. amount of dimension bits reached
2640            int iCurrentBits = 0;
2641            for (int i = 0; i < Dimensions; i++)
2642                iCurrentBits += pDimensionDefinitions[i].bits;
2643            if (iCurrentBits >= iMaxDimensions)
2644                throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimension bits already reached");
2645            const int iNewBits = iCurrentBits + pDimDef->bits;
2646            if (iNewBits > iMaxDimensions)
2647                throw gig::Exception("Could not add new dimension, new dimension would exceed max. amount of " + ToString(iMaxDimensions) + " dimension bits");
2648            // check if there's already a dimensions of the same type
2649            for (int i = 0; i < Dimensions; i++)
2650                if (pDimensionDefinitions[i].dimension == pDimDef->dimension)
2651                    throw gig::Exception("Could not add new dimension, there is already a dimension of the same type");
2652    
2653            // pos is where the new dimension should be placed, normally
2654            // last in list, except for the samplechannel dimension which
2655            // has to be first in list
2656            int pos = pDimDef->dimension == dimension_samplechannel ? 0 : Dimensions;
2657            int bitpos = 0;
2658            for (int i = 0 ; i < pos ; i++)
2659                bitpos += pDimensionDefinitions[i].bits;
2660    
2661            // make room for the new dimension
2662            for (int i = Dimensions ; i > pos ; i--) pDimensionDefinitions[i] = pDimensionDefinitions[i - 1];
2663            for (int i = 0 ; i < (1 << iCurrentBits) ; i++) {
2664                for (int j = Dimensions ; j > pos ; j--) {
2665                    pDimensionRegions[i]->DimensionUpperLimits[j] =
2666                        pDimensionRegions[i]->DimensionUpperLimits[j - 1];
2667                }
2668            }
2669    
2670            // assign definition of new dimension
2671            pDimensionDefinitions[pos] = *pDimDef;
2672    
2673            // auto correct certain dimension definition fields (where possible)
2674            pDimensionDefinitions[pos].split_type  =
2675                __resolveSplitType(pDimensionDefinitions[pos].dimension);
2676            pDimensionDefinitions[pos].zone_size =
2677                __resolveZoneSize(pDimensionDefinitions[pos]);
2678    
2679            // create new dimension region(s) for this new dimension, and make
2680            // sure that the dimension regions are placed correctly in both the
2681            // RIFF list and the pDimensionRegions array
2682            RIFF::Chunk* moveTo = NULL;
2683            RIFF::List* _3prg = pCkRegion->GetSubList(LIST_TYPE_3PRG);
2684            for (int i = (1 << iCurrentBits) - (1 << bitpos) ; i >= 0 ; i -= (1 << bitpos)) {
2685                for (int k = 0 ; k < (1 << bitpos) ; k++) {
2686                    pDimensionRegions[(i << pDimDef->bits) + k] = pDimensionRegions[i + k];
2687                }
2688                for (int j = 1 ; j < (1 << pDimDef->bits) ; j++) {
2689                    for (int k = 0 ; k < (1 << bitpos) ; k++) {
2690                        RIFF::List* pNewDimRgnListChunk = _3prg->AddSubList(LIST_TYPE_3EWL);
2691                        if (moveTo) _3prg->MoveSubChunk(pNewDimRgnListChunk, moveTo);
2692                        // create a new dimension region and copy all parameter values from
2693                        // an existing dimension region
2694                        pDimensionRegions[(i << pDimDef->bits) + (j << bitpos) + k] =
2695                            new DimensionRegion(pNewDimRgnListChunk, *pDimensionRegions[i + k]);
2696    
2697                        DimensionRegions++;
2698                    }
2699                }
2700                moveTo = pDimensionRegions[i]->pParentList;
2701            }
2702    
2703            // initialize the upper limits for this dimension
2704            int mask = (1 << bitpos) - 1;
2705            for (int z = 0 ; z < pDimDef->zones ; z++) {
2706                uint8_t upperLimit = uint8_t((z + 1) * 128.0 / pDimDef->zones - 1);
2707                for (int i = 0 ; i < 1 << iCurrentBits ; i++) {
2708                    pDimensionRegions[((i & ~mask) << pDimDef->bits) |
2709                                      (z << bitpos) |
2710                                      (i & mask)]->DimensionUpperLimits[pos] = upperLimit;
2711                }
2712            }
2713    
2714            Dimensions++;
2715    
2716            // if this is a layer dimension, update 'Layers' attribute
2717            if (pDimDef->dimension == dimension_layer) Layers = pDimDef->zones;
2718    
2719            UpdateVelocityTable();
2720        }
2721    
2722        /** @brief Delete an existing dimension.
2723         *
2724         * Deletes the dimension given by \a pDimDef and deletes all respective
2725         * dimension regions, that is all dimension regions where the dimension's
2726         * bit(s) part is greater than 0. In case of a 'sustain pedal' dimension
2727         * for example this would delete all dimension regions for the case(s)
2728         * where the sustain pedal is pressed down.
2729         *
2730         * @param pDimDef - dimension to delete
2731         * @throws gig::Exception if given dimension cannot be found
2732         */
2733        void Region::DeleteDimension(dimension_def_t* pDimDef) {
2734            // get dimension's index
2735            int iDimensionNr = -1;
2736            for (int i = 0; i < Dimensions; i++) {
2737                if (&pDimensionDefinitions[i] == pDimDef) {
2738                    iDimensionNr = i;
2739                    break;
2740                }
2741            }
2742            if (iDimensionNr < 0) throw gig::Exception("Invalid dimension_def_t pointer");
2743    
2744            // get amount of bits below the dimension to delete
2745            int iLowerBits = 0;
2746            for (int i = 0; i < iDimensionNr; i++)
2747                iLowerBits += pDimensionDefinitions[i].bits;
2748    
2749            // get amount ot bits above the dimension to delete
2750            int iUpperBits = 0;
2751            for (int i = iDimensionNr + 1; i < Dimensions; i++)
2752                iUpperBits += pDimensionDefinitions[i].bits;
2753    
2754            RIFF::List* _3prg = pCkRegion->GetSubList(LIST_TYPE_3PRG);
2755    
2756            // delete dimension regions which belong to the given dimension
2757            // (that is where the dimension's bit > 0)
2758            for (int iUpperBit = 0; iUpperBit < 1 << iUpperBits; iUpperBit++) {
2759                for (int iObsoleteBit = 1; iObsoleteBit < 1 << pDimensionDefinitions[iDimensionNr].bits; iObsoleteBit++) {
2760                    for (int iLowerBit = 0; iLowerBit < 1 << iLowerBits; iLowerBit++) {
2761                        int iToDelete = iUpperBit    << (pDimensionDefinitions[iDimensionNr].bits + iLowerBits) |
2762                                        iObsoleteBit << iLowerBits |
2763                                        iLowerBit;
2764    
2765                        _3prg->DeleteSubChunk(pDimensionRegions[iToDelete]->pParentList);
2766                        delete pDimensionRegions[iToDelete];
2767                        pDimensionRegions[iToDelete] = NULL;
2768                        DimensionRegions--;
2769                    }
2770                }
2771            }
2772    
2773            // defrag pDimensionRegions array
2774            // (that is remove the NULL spaces within the pDimensionRegions array)
2775            for (int iFrom = 2, iTo = 1; iFrom < 256 && iTo < 256 - 1; iTo++) {
2776                if (!pDimensionRegions[iTo]) {
2777                    if (iFrom <= iTo) iFrom = iTo + 1;
2778                    while (!pDimensionRegions[iFrom] && iFrom < 256) iFrom++;
2779                    if (iFrom < 256 && pDimensionRegions[iFrom]) {
2780                        pDimensionRegions[iTo]   = pDimensionRegions[iFrom];
2781                        pDimensionRegions[iFrom] = NULL;
2782                    }
2783                }
2784            }
2785    
2786            // remove the this dimension from the upper limits arrays
2787            for (int j = 0 ; j < 256 && pDimensionRegions[j] ; j++) {
2788                DimensionRegion* d = pDimensionRegions[j];
2789                for (int i = iDimensionNr + 1; i < Dimensions; i++) {
2790                    d->DimensionUpperLimits[i - 1] = d->DimensionUpperLimits[i];
2791                }
2792                d->DimensionUpperLimits[Dimensions - 1] = 127;
2793            }
2794    
2795            // 'remove' dimension definition
2796            for (int i = iDimensionNr + 1; i < Dimensions; i++) {
2797                pDimensionDefinitions[i - 1] = pDimensionDefinitions[i];
2798            }
2799            pDimensionDefinitions[Dimensions - 1].dimension = dimension_none;
2800            pDimensionDefinitions[Dimensions - 1].bits      = 0;
2801            pDimensionDefinitions[Dimensions - 1].zones     = 0;
2802    
2803            Dimensions--;
2804    
2805            // if this was a layer dimension, update 'Layers' attribute
2806            if (pDimDef->dimension == dimension_layer) Layers = 1;
2807        }
2808    
2809        Region::~Region() {
2810          for (int i = 0; i < 256; i++) {          for (int i = 0; i < 256; i++) {
2811              if (pDimensionRegions[i]) delete pDimensionRegions[i];              if (pDimensionRegions[i]) delete pDimensionRegions[i];
2812          }          }
# Line 1482  namespace gig { namespace { Line 2831  namespace gig { namespace {
2831       * @see             Dimensions       * @see             Dimensions
2832       */       */
2833      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {
2834          uint8_t bits[8] = { 0 };          uint8_t bits;
2835            int veldim = -1;
2836            int velbitpos;
2837            int bitpos = 0;
2838            int dimregidx = 0;
2839          for (uint i = 0; i < Dimensions; i++) {          for (uint i = 0; i < Dimensions; i++) {
2840              bits[i] = DimValues[i];              if (pDimensionDefinitions[i].dimension == dimension_velocity) {
2841              switch (pDimensionDefinitions[i].split_type) {                  // the velocity dimension must be handled after the other dimensions
2842                  case split_type_normal:                  veldim = i;
2843                      bits[i] /= pDimensionDefinitions[i].zone_size;                  velbitpos = bitpos;
2844                      break;              } else {
2845                  case split_type_customvelocity:                  switch (pDimensionDefinitions[i].split_type) {
2846                      bits[i] = VelocityTable[bits[i]];                      case split_type_normal:
2847                      break;                          if (pDimensionRegions[0]->DimensionUpperLimits[i]) {
2848                  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
2849                      const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;                              for (bits = 0 ; bits < pDimensionDefinitions[i].zones ; bits++) {
2850                      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;
2851                      break;                              }
2852              }                          } else {
2853                                // gig2: evenly sized zones
2854                                bits = uint8_t(DimValues[i] / pDimensionDefinitions[i].zone_size);
2855                            }
2856                            break;
2857                        case split_type_bit: // the value is already the sought dimension bit number
2858                            const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;
2859                            bits = DimValues[i] & limiter_mask; // just make sure the value doesn't use more bits than allowed
2860                            break;
2861                    }
2862                    dimregidx |= bits << bitpos;
2863                }
2864                bitpos += pDimensionDefinitions[i].bits;
2865            }
2866            DimensionRegion* dimreg = pDimensionRegions[dimregidx];
2867            if (veldim != -1) {
2868                // (dimreg is now the dimension region for the lowest velocity)
2869                if (dimreg->VelocityTable) // custom defined zone ranges
2870                    bits = dimreg->VelocityTable[DimValues[veldim]];
2871                else // normal split type
2872                    bits = uint8_t(DimValues[veldim] / pDimensionDefinitions[veldim].zone_size);
2873    
2874                dimregidx |= bits << velbitpos;
2875                dimreg = pDimensionRegions[dimregidx];
2876          }          }
2877          return GetDimensionRegionByBit(bits);          return dimreg;
2878      }      }
2879    
2880      /**      /**
# Line 1535  namespace gig { namespace { Line 2911  namespace gig { namespace {
2911          else         return static_cast<gig::Sample*>(pSample = GetSampleFromWavePool(WavePoolTableIndex));          else         return static_cast<gig::Sample*>(pSample = GetSampleFromWavePool(WavePoolTableIndex));
2912      }      }
2913    
2914      Sample* Region::GetSampleFromWavePool(unsigned int WavePoolTableIndex) {      Sample* Region::GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress) {
2915          if ((int32_t)WavePoolTableIndex == -1) return NULL;          if ((int32_t)WavePoolTableIndex == -1) return NULL;
2916          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
2917            if (!file->pWavePoolTable) return NULL;
2918          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
2919          Sample* sample = file->GetFirstSample();          unsigned long soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];
2920            Sample* sample = file->GetFirstSample(pProgress);
2921          while (sample) {          while (sample) {
2922              if (sample->ulWavePoolOffset == soughtoffset) return static_cast<gig::Sample*>(pSample = sample);              if (sample->ulWavePoolOffset == soughtoffset &&
2923                    sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);
2924              sample = file->GetNextSample();              sample = file->GetNextSample();
2925          }          }
2926          return NULL;          return NULL;
2927      }      }
2928    
2929    
2930    // *************** MidiRule ***************
2931    // *
2932    
2933    MidiRuleCtrlTrigger::MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg) {
2934        _3ewg->SetPos(36);
2935        Triggers = _3ewg->ReadUint8();
2936        _3ewg->SetPos(40);
2937        ControllerNumber = _3ewg->ReadUint8();
2938        _3ewg->SetPos(46);
2939        for (int i = 0 ; i < Triggers ; i++) {
2940            pTriggers[i].TriggerPoint = _3ewg->ReadUint8();
2941            pTriggers[i].Descending = _3ewg->ReadUint8();
2942            pTriggers[i].VelSensitivity = _3ewg->ReadUint8();
2943            pTriggers[i].Key = _3ewg->ReadUint8();
2944            pTriggers[i].NoteOff = _3ewg->ReadUint8();
2945            pTriggers[i].Velocity = _3ewg->ReadUint8();
2946            pTriggers[i].OverridePedal = _3ewg->ReadUint8();
2947            _3ewg->ReadUint8();
2948        }
2949    }
2950    
2951    
2952  // *************** Instrument ***************  // *************** Instrument ***************
2953  // *  // *
2954    
2955      Instrument::Instrument(File* pFile, RIFF::List* insList) : DLS::Instrument((DLS::File*)pFile, insList) {      Instrument::Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress) : DLS::Instrument((DLS::File*)pFile, insList) {
2956            static const DLS::Info::string_length_t fixedStringLengths[] = {
2957                { CHUNK_ID_INAM, 64 },
2958                { CHUNK_ID_ISFT, 12 },
2959                { 0, 0 }
2960            };
2961            pInfo->SetFixedStringLengths(fixedStringLengths);
2962    
2963          // Initialization          // Initialization
2964          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;
2965          RegionIndex = -1;          EffectSend = 0;
2966            Attenuation = 0;
2967            FineTune = 0;
2968            PitchbendRange = 0;
2969            PianoReleaseMode = false;
2970            DimensionKeyRange.low = 0;
2971            DimensionKeyRange.high = 0;
2972            pMidiRules = new MidiRule*[3];
2973            pMidiRules[0] = NULL;
2974    
2975          // Loading          // Loading
2976          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);
# Line 1570  namespace gig { namespace { Line 2985  namespace gig { namespace {
2985                  PianoReleaseMode       = dimkeystart & 0x01;                  PianoReleaseMode       = dimkeystart & 0x01;
2986                  DimensionKeyRange.low  = dimkeystart >> 1;                  DimensionKeyRange.low  = dimkeystart >> 1;
2987                  DimensionKeyRange.high = _3ewg->ReadUint8();                  DimensionKeyRange.high = _3ewg->ReadUint8();
2988    
2989                    if (_3ewg->GetSize() > 32) {
2990                        // read MIDI rules
2991                        int i = 0;
2992                        _3ewg->SetPos(32);
2993                        uint8_t id1 = _3ewg->ReadUint8();
2994                        uint8_t id2 = _3ewg->ReadUint8();
2995    
2996                        if (id1 == 4 && id2 == 16) {
2997                            pMidiRules[i++] = new MidiRuleCtrlTrigger(_3ewg);
2998                        }
2999                        //TODO: all the other types of rules
3000    
3001                        pMidiRules[i] = NULL;
3002                    }
3003              }              }
             else throw gig::Exception("Mandatory <3ewg> chunk not found.");  
3004          }          }
         else throw gig::Exception("Mandatory <lart> list chunk not found.");  
3005    
3006          RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);          if (pFile->GetAutoLoad()) {
3007          if (!lrgn) throw gig::Exception("Mandatory chunks in <ins > chunk not found.");              if (!pRegions) pRegions = new RegionList;
3008          pRegions = new Region*[Regions];              RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);
3009          for (uint i = 0; i < Regions; i++) pRegions[i] = NULL;              if (lrgn) {
3010          RIFF::List* rgn = lrgn->GetFirstSubList();                  RIFF::List* rgn = lrgn->GetFirstSubList();
3011          unsigned int iRegion = 0;                  while (rgn) {
3012          while (rgn) {                      if (rgn->GetListType() == LIST_TYPE_RGN) {
3013              if (rgn->GetListType() == LIST_TYPE_RGN) {                          __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
3014                  pRegions[iRegion] = new Region(this, rgn);                          pRegions->push_back(new Region(this, rgn));
3015                  iRegion++;                      }
3016              }                      rgn = lrgn->GetNextSubList();
3017              rgn = lrgn->GetNextSubList();                  }
3018          }                  // Creating Region Key Table for fast lookup
3019                    UpdateRegionKeyTable();
         // 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];  
3020              }              }
3021          }          }
3022    
3023            __notify_progress(pProgress, 1.0f); // notify done
3024      }      }
3025    
3026      Instrument::~Instrument() {      void Instrument::UpdateRegionKeyTable() {
3027          for (uint i = 0; i < Regions; i++) {          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;
3028              if (pRegions) {          RegionList::iterator iter = pRegions->begin();
3029                  if (pRegions[i]) delete (pRegions[i]);          RegionList::iterator end  = pRegions->end();
3030            for (; iter != end; ++iter) {
3031                gig::Region* pRegion = static_cast<gig::Region*>(*iter);
3032                for (int iKey = pRegion->KeyRange.low; iKey <= pRegion->KeyRange.high; iKey++) {
3033                    RegionKeyTable[iKey] = pRegion;
3034              }              }
3035          }          }
3036          if (pRegions) delete[] pRegions;      }
3037    
3038        Instrument::~Instrument() {
3039            delete[] pMidiRules;
3040        }
3041    
3042        /**
3043         * Apply Instrument with all its Regions to the respective RIFF chunks.
3044         * You have to call File::Save() to make changes persistent.
3045         *
3046         * Usually there is absolutely no need to call this method explicitly.
3047         * It will be called automatically when File::Save() was called.
3048         *
3049         * @throws gig::Exception if samples cannot be dereferenced
3050         */
3051        void Instrument::UpdateChunks() {
3052            // first update base classes' chunks
3053            DLS::Instrument::UpdateChunks();
3054    
3055            // update Regions' chunks
3056            {
3057                RegionList::iterator iter = pRegions->begin();
3058                RegionList::iterator end  = pRegions->end();
3059                for (; iter != end; ++iter)
3060                    (*iter)->UpdateChunks();
3061            }
3062    
3063            // make sure 'lart' RIFF list chunk exists
3064            RIFF::List* lart = pCkInstrument->GetSubList(LIST_TYPE_LART);
3065            if (!lart)  lart = pCkInstrument->AddSubList(LIST_TYPE_LART);
3066            // make sure '3ewg' RIFF chunk exists
3067            RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);
3068            if (!_3ewg)  {
3069                File* pFile = (File*) GetParent();
3070    
3071                // 3ewg is bigger in gig3, as it includes the iMIDI rules
3072                int size = (pFile->pVersion && pFile->pVersion->major == 3) ? 16416 : 12;
3073                _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, size);
3074                memset(_3ewg->LoadChunkData(), 0, size);
3075            }
3076            // update '3ewg' RIFF chunk
3077            uint8_t* pData = (uint8_t*) _3ewg->LoadChunkData();
3078            store16(&pData[0], EffectSend);
3079            store32(&pData[2], Attenuation);
3080            store16(&pData[6], FineTune);
3081            store16(&pData[8], PitchbendRange);
3082            const uint8_t dimkeystart = (PianoReleaseMode ? 0x01 : 0x00) |
3083                                        DimensionKeyRange.low << 1;
3084            pData[10] = dimkeystart;
3085            pData[11] = DimensionKeyRange.high;
3086      }      }
3087    
3088      /**      /**
# Line 1614  namespace gig { namespace { Line 3093  namespace gig { namespace {
3093       *             there is no Region defined for the given \a Key       *             there is no Region defined for the given \a Key
3094       */       */
3095      Region* Instrument::GetRegion(unsigned int Key) {      Region* Instrument::GetRegion(unsigned int Key) {
3096          if (!pRegions || Key > 127) return NULL;          if (!pRegions || pRegions->empty() || Key > 127) return NULL;
3097          return RegionKeyTable[Key];          return RegionKeyTable[Key];
3098    
3099          /*for (int i = 0; i < Regions; i++) {          /*for (int i = 0; i < Regions; i++) {
3100              if (Key <= pRegions[i]->KeyRange.high &&              if (Key <= pRegions[i]->KeyRange.high &&
3101                  Key >= pRegions[i]->KeyRange.low) return pRegions[i];                  Key >= pRegions[i]->KeyRange.low) return pRegions[i];
# Line 1631  namespace gig { namespace { Line 3111  namespace gig { namespace {
3111       * @see      GetNextRegion()       * @see      GetNextRegion()
3112       */       */
3113      Region* Instrument::GetFirstRegion() {      Region* Instrument::GetFirstRegion() {
3114          if (!Regions) return NULL;          if (!pRegions) return NULL;
3115          RegionIndex = 1;          RegionsIterator = pRegions->begin();
3116          return pRegions[0];          return static_cast<gig::Region*>( (RegionsIterator != pRegions->end()) ? *RegionsIterator : NULL );
3117      }      }
3118    
3119      /**      /**
# Line 1645  namespace gig { namespace { Line 3125  namespace gig { namespace {
3125       * @see      GetFirstRegion()       * @see      GetFirstRegion()
3126       */       */
3127      Region* Instrument::GetNextRegion() {      Region* Instrument::GetNextRegion() {
3128          if (RegionIndex < 0 || uint32_t(RegionIndex) >= Regions) return NULL;          if (!pRegions) return NULL;
3129          return pRegions[RegionIndex++];          RegionsIterator++;
3130            return static_cast<gig::Region*>( (RegionsIterator != pRegions->end()) ? *RegionsIterator : NULL );
3131        }
3132    
3133        Region* Instrument::AddRegion() {
3134            // create new Region object (and its RIFF chunks)
3135            RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
3136            if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
3137            RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
3138            Region* pNewRegion = new Region(this, rgn);
3139            pRegions->push_back(pNewRegion);
3140            Regions = pRegions->size();
3141            // update Region key table for fast lookup
3142            UpdateRegionKeyTable();
3143            // done
3144            return pNewRegion;
3145        }
3146    
3147        void Instrument::DeleteRegion(Region* pRegion) {
3148            if (!pRegions) return;
3149            DLS::Instrument::DeleteRegion((DLS::Region*) pRegion);
3150            // update Region key table for fast lookup
3151            UpdateRegionKeyTable();
3152      }      }
3153    
3154        /**
3155         * Returns a MIDI rule of the instrument.
3156         *
3157         * The list of MIDI rules, at least in gig v3, always contains at
3158         * most two rules. The second rule can only be the DEF filter
3159         * (which currently isn't supported by libgig).
3160         *
3161         * @param i - MIDI rule number
3162         * @returns   pointer address to MIDI rule number i or NULL if there is none
3163         */
3164        MidiRule* Instrument::GetMidiRule(int i) {
3165            return pMidiRules[i];
3166        }
3167    
3168    
3169  // *************** File ***************  // *************** Group ***************
3170  // *  // *
3171    
3172      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {      /** @brief Constructor.
3173          pSamples     = NULL;       *
3174          pInstruments = NULL;       * @param file   - pointer to the gig::File object
3175         * @param ck3gnm - pointer to 3gnm chunk associated with this group or
3176         *                 NULL if this is a new Group
3177         */
3178        Group::Group(File* file, RIFF::Chunk* ck3gnm) {
3179            pFile      = file;
3180            pNameChunk = ck3gnm;
3181            ::LoadString(pNameChunk, Name);
3182      }      }
3183    
3184      File::~File() {      Group::~Group() {
3185          // free samples          // remove the chunk associated with this group (if any)
3186          if (pSamples) {          if (pNameChunk) pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);
3187              SamplesIterator = pSamples->begin();      }
3188              while (SamplesIterator != pSamples->end() ) {  
3189                  delete (*SamplesIterator);      /** @brief Update chunks with current group settings.
3190                  SamplesIterator++;       *
3191         * Apply current Group field values to the respective chunks. You have
3192         * to call File::Save() to make changes persistent.
3193         *
3194         * Usually there is absolutely no need to call this method explicitly.
3195         * It will be called automatically when File::Save() was called.
3196         */
3197        void Group::UpdateChunks() {
3198            // make sure <3gri> and <3gnl> list chunks exist
3199            RIFF::List* _3gri = pFile->pRIFF->GetSubList(LIST_TYPE_3GRI);
3200            if (!_3gri) {
3201                _3gri = pFile->pRIFF->AddSubList(LIST_TYPE_3GRI);
3202                pFile->pRIFF->MoveSubChunk(_3gri, pFile->pRIFF->GetSubChunk(CHUNK_ID_PTBL));
3203            }
3204            RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
3205            if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
3206    
3207            if (!pNameChunk && pFile->pVersion && pFile->pVersion->major == 3) {
3208                // v3 has a fixed list of 128 strings, find a free one
3209                for (RIFF::Chunk* ck = _3gnl->GetFirstSubChunk() ; ck ; ck = _3gnl->GetNextSubChunk()) {
3210                    if (strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) {
3211                        pNameChunk = ck;
3212                        break;
3213                    }
3214              }              }
3215              pSamples->clear();          }
3216              delete pSamples;  
3217            // now store the name of this group as <3gnm> chunk as subchunk of the <3gnl> list chunk
3218            ::SaveString(CHUNK_ID_3GNM, pNameChunk, _3gnl, Name, String("Unnamed Group"), true, 64);
3219        }
3220    
3221        /**
3222         * Returns the first Sample of this Group. You have to call this method
3223         * once before you use GetNextSample().
3224         *
3225         * <b>Notice:</b> this method might block for a long time, in case the
3226         * samples of this .gig file were not scanned yet
3227         *
3228         * @returns  pointer address to first Sample or NULL if there is none
3229         *           applied to this Group
3230         * @see      GetNextSample()
3231         */
3232        Sample* Group::GetFirstSample() {
3233            // FIXME: lazy und unsafe implementation, should be an autonomous iterator
3234            for (Sample* pSample = pFile->GetFirstSample(); pSample; pSample = pFile->GetNextSample()) {
3235                if (pSample->GetGroup() == this) return pSample;
3236            }
3237            return NULL;
3238        }
3239    
3240        /**
3241         * Returns the next Sample of the Group. You have to call
3242         * GetFirstSample() once before you can use this method. By calling this
3243         * method multiple times it iterates through the Samples assigned to
3244         * this Group.
3245         *
3246         * @returns  pointer address to the next Sample of this Group or NULL if
3247         *           end reached
3248         * @see      GetFirstSample()
3249         */
3250        Sample* Group::GetNextSample() {
3251            // FIXME: lazy und unsafe implementation, should be an autonomous iterator
3252            for (Sample* pSample = pFile->GetNextSample(); pSample; pSample = pFile->GetNextSample()) {
3253                if (pSample->GetGroup() == this) return pSample;
3254            }
3255            return NULL;
3256        }
3257    
3258        /**
3259         * Move Sample given by \a pSample from another Group to this Group.
3260         */
3261        void Group::AddSample(Sample* pSample) {
3262            pSample->pGroup = this;
3263        }
3264    
3265        /**
3266         * Move all members of this group to another group (preferably the 1st
3267         * one except this). This method is called explicitly by
3268         * File::DeleteGroup() thus when a Group was deleted. This code was
3269         * intentionally not placed in the destructor!
3270         */
3271        void Group::MoveAll() {
3272            // get "that" other group first
3273            Group* pOtherGroup = NULL;
3274            for (pOtherGroup = pFile->GetFirstGroup(); pOtherGroup; pOtherGroup = pFile->GetNextGroup()) {
3275                if (pOtherGroup != this) break;
3276            }
3277            if (!pOtherGroup) throw Exception(
3278                "Could not move samples to another group, since there is no "
3279                "other Group. This is a bug, report it!"
3280            );
3281            // now move all samples of this group to the other group
3282            for (Sample* pSample = GetFirstSample(); pSample; pSample = GetNextSample()) {
3283                pOtherGroup->AddSample(pSample);
3284          }          }
3285          // free instruments      }
3286          if (pInstruments) {  
3287              InstrumentsIterator = pInstruments->begin();  
3288              while (InstrumentsIterator != pInstruments->end() ) {  
3289                  delete (*InstrumentsIterator);  // *************** File ***************
3290                  InstrumentsIterator++;  // *
3291    
3292        /// Reflects Gigasampler file format version 2.0 (1998-06-28).
3293        const DLS::version_t File::VERSION_2 = {
3294            0, 2, 19980628 & 0xffff, 19980628 >> 16
3295        };
3296    
3297        /// Reflects Gigasampler file format version 3.0 (2003-03-31).
3298        const DLS::version_t File::VERSION_3 = {
3299            0, 3, 20030331 & 0xffff, 20030331 >> 16
3300        };
3301    
3302        static const DLS::Info::string_length_t _FileFixedStringLengths[] = {
3303            { CHUNK_ID_IARL, 256 },
3304            { CHUNK_ID_IART, 128 },
3305            { CHUNK_ID_ICMS, 128 },
3306            { CHUNK_ID_ICMT, 1024 },
3307            { CHUNK_ID_ICOP, 128 },
3308            { CHUNK_ID_ICRD, 128 },
3309            { CHUNK_ID_IENG, 128 },
3310            { CHUNK_ID_IGNR, 128 },
3311            { CHUNK_ID_IKEY, 128 },
3312            { CHUNK_ID_IMED, 128 },
3313            { CHUNK_ID_INAM, 128 },
3314            { CHUNK_ID_IPRD, 128 },
3315            { CHUNK_ID_ISBJ, 128 },
3316            { CHUNK_ID_ISFT, 128 },
3317            { CHUNK_ID_ISRC, 128 },
3318            { CHUNK_ID_ISRF, 128 },
3319            { CHUNK_ID_ITCH, 128 },
3320            { 0, 0 }
3321        };
3322    
3323        File::File() : DLS::File() {
3324            bAutoLoad = true;
3325            *pVersion = VERSION_3;
3326            pGroups = NULL;
3327            pInfo->SetFixedStringLengths(_FileFixedStringLengths);
3328            pInfo->ArchivalLocation = String(256, ' ');
3329    
3330            // add some mandatory chunks to get the file chunks in right
3331            // order (INFO chunk will be moved to first position later)
3332            pRIFF->AddSubChunk(CHUNK_ID_VERS, 8);
3333            pRIFF->AddSubChunk(CHUNK_ID_COLH, 4);
3334            pRIFF->AddSubChunk(CHUNK_ID_DLID, 16);
3335    
3336            GenerateDLSID();
3337        }
3338    
3339        File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {
3340            bAutoLoad = true;
3341            pGroups = NULL;
3342            pInfo->SetFixedStringLengths(_FileFixedStringLengths);
3343        }
3344    
3345        File::~File() {
3346            if (pGroups) {
3347                std::list<Group*>::iterator iter = pGroups->begin();
3348                std::list<Group*>::iterator end  = pGroups->end();
3349                while (iter != end) {
3350                    delete *iter;
3351                    ++iter;
3352              }              }
3353              pInstruments->clear();              delete pGroups;
             delete pInstruments;  
3354          }          }
3355      }      }
3356    
3357      Sample* File::GetFirstSample() {      Sample* File::GetFirstSample(progress_t* pProgress) {
3358          if (!pSamples) LoadSamples();          if (!pSamples) LoadSamples(pProgress);
3359          if (!pSamples) return NULL;          if (!pSamples) return NULL;
3360          SamplesIterator = pSamples->begin();          SamplesIterator = pSamples->begin();
3361          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
# Line 1696  namespace gig { namespace { Line 3367  namespace gig { namespace {
3367          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
3368      }      }
3369    
3370      void File::LoadSamples() {      /** @brief Add a new sample.
3371          RIFF::List* wvpl = pRIFF->GetSubList(LIST_TYPE_WVPL);       *
3372          if (wvpl) {       * This will create a new Sample object for the gig file. You have to
3373              unsigned long wvplFileOffset = wvpl->GetFilePos();       * call Save() to make this persistent to the file.
3374              RIFF::List* wave = wvpl->GetFirstSubList();       *
3375              while (wave) {       * @returns pointer to new Sample object
3376                  if (wave->GetListType() == LIST_TYPE_WAVE) {       */
3377                      if (!pSamples) pSamples = new SampleList;      Sample* File::AddSample() {
3378                      unsigned long waveFileOffset = wave->GetFilePos();         if (!pSamples) LoadSamples();
3379                      pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset));         __ensureMandatoryChunksExist();
3380           RIFF::List* wvpl = pRIFF->GetSubList(LIST_TYPE_WVPL);
3381           // create new Sample object and its respective 'wave' list chunk
3382           RIFF::List* wave = wvpl->AddSubList(LIST_TYPE_WAVE);
3383           Sample* pSample = new Sample(this, wave, 0 /*arbitrary value, we update offsets when we save*/);
3384    
3385           // add mandatory chunks to get the chunks in right order
3386           wave->AddSubChunk(CHUNK_ID_FMT, 16);
3387           wave->AddSubList(LIST_TYPE_INFO);
3388    
3389           pSamples->push_back(pSample);
3390           return pSample;
3391        }
3392    
3393        /** @brief Delete a sample.
3394         *
3395         * This will delete the given Sample object from the gig file. Any
3396         * references to this sample from Regions and DimensionRegions will be
3397         * removed. You have to call Save() to make this persistent to the file.
3398         *
3399         * @param pSample - sample to delete
3400         * @throws gig::Exception if given sample could not be found
3401         */
3402        void File::DeleteSample(Sample* pSample) {
3403            if (!pSamples || !pSamples->size()) throw gig::Exception("Could not delete sample as there are no samples");
3404            SampleList::iterator iter = find(pSamples->begin(), pSamples->end(), (DLS::Sample*) pSample);
3405            if (iter == pSamples->end()) throw gig::Exception("Could not delete sample, could not find given sample");
3406            if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation
3407            pSamples->erase(iter);
3408            delete pSample;
3409    
3410            SampleList::iterator tmp = SamplesIterator;
3411            // remove all references to the sample
3412            for (Instrument* instrument = GetFirstInstrument() ; instrument ;
3413                 instrument = GetNextInstrument()) {
3414                for (Region* region = instrument->GetFirstRegion() ; region ;
3415                     region = instrument->GetNextRegion()) {
3416    
3417                    if (region->GetSample() == pSample) region->SetSample(NULL);
3418    
3419                    for (int i = 0 ; i < region->DimensionRegions ; i++) {
3420                        gig::DimensionRegion *d = region->pDimensionRegions[i];
3421                        if (d->pSample == pSample) d->pSample = NULL;
3422                  }                  }
                 wave = wvpl->GetNextSubList();  
3423              }              }
3424          }          }
3425          else throw gig::Exception("Mandatory <wvpl> chunk not found.");          SamplesIterator = tmp; // restore iterator
3426        }
3427    
3428        void File::LoadSamples() {
3429            LoadSamples(NULL);
3430        }
3431    
3432        void File::LoadSamples(progress_t* pProgress) {
3433            // Groups must be loaded before samples, because samples will try
3434            // to resolve the group they belong to
3435            if (!pGroups) LoadGroups();
3436    
3437            if (!pSamples) pSamples = new SampleList;
3438    
3439            RIFF::File* file = pRIFF;
3440    
3441            // just for progress calculation
3442            int iSampleIndex  = 0;
3443            int iTotalSamples = WavePoolCount;
3444    
3445            // check if samples should be loaded from extension files
3446            int lastFileNo = 0;
3447            for (int i = 0 ; i < WavePoolCount ; i++) {
3448                if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];
3449            }
3450            String name(pRIFF->GetFileName());
3451            int nameLen = name.length();
3452            char suffix[6];
3453            if (nameLen > 4 && name.substr(nameLen - 4) == ".gig") nameLen -= 4;
3454    
3455            for (int fileNo = 0 ; ; ) {
3456                RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);
3457                if (wvpl) {
3458                    unsigned long wvplFileOffset = wvpl->GetFilePos();
3459                    RIFF::List* wave = wvpl->GetFirstSubList();
3460                    while (wave) {
3461                        if (wave->GetListType() == LIST_TYPE_WAVE) {
3462                            // notify current progress
3463                            const float subprogress = (float) iSampleIndex / (float) iTotalSamples;
3464                            __notify_progress(pProgress, subprogress);
3465    
3466                            unsigned long waveFileOffset = wave->GetFilePos();
3467                            pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));
3468    
3469                            iSampleIndex++;
3470                        }
3471                        wave = wvpl->GetNextSubList();
3472                    }
3473    
3474                    if (fileNo == lastFileNo) break;
3475    
3476                    // open extension file (*.gx01, *.gx02, ...)
3477                    fileNo++;
3478                    sprintf(suffix, ".gx%02d", fileNo);
3479                    name.replace(nameLen, 5, suffix);
3480                    file = new RIFF::File(name);
3481                    ExtensionFiles.push_back(file);
3482                } else break;
3483            }
3484    
3485            __notify_progress(pProgress, 1.0); // notify done
3486      }      }
3487    
3488      Instrument* File::GetFirstInstrument() {      Instrument* File::GetFirstInstrument() {
3489          if (!pInstruments) LoadInstruments();          if (!pInstruments) LoadInstruments();
3490          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
3491          InstrumentsIterator = pInstruments->begin();          InstrumentsIterator = pInstruments->begin();
3492          return (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL;          return static_cast<gig::Instrument*>( (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL );
3493      }      }
3494    
3495      Instrument* File::GetNextInstrument() {      Instrument* File::GetNextInstrument() {
3496          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
3497          InstrumentsIterator++;          InstrumentsIterator++;
3498          return (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL;          return static_cast<gig::Instrument*>( (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL );
3499      }      }
3500    
3501      /**      /**
3502       * Returns the instrument with the given index.       * Returns the instrument with the given index.
3503       *       *
3504         * @param index     - number of the sought instrument (0..n)
3505         * @param pProgress - optional: callback function for progress notification
3506       * @returns  sought instrument or NULL if there's no such instrument       * @returns  sought instrument or NULL if there's no such instrument
3507       */       */
3508      Instrument* File::GetInstrument(uint index) {      Instrument* File::GetInstrument(uint index, progress_t* pProgress) {
3509          if (!pInstruments) LoadInstruments();          if (!pInstruments) {
3510                // TODO: hack - we simply load ALL samples here, it would have been done in the Region constructor anyway (ATM)
3511    
3512                // sample loading subtask
3513                progress_t subprogress;
3514                __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask
3515                __notify_progress(&subprogress, 0.0f);
3516                if (GetAutoLoad())
3517                    GetFirstSample(&subprogress); // now force all samples to be loaded
3518                __notify_progress(&subprogress, 1.0f);
3519    
3520                // instrument loading subtask
3521                if (pProgress && pProgress->callback) {
3522                    subprogress.__range_min = subprogress.__range_max;
3523                    subprogress.__range_max = pProgress->__range_max; // schedule remaining percentage for this subtask
3524                }
3525                __notify_progress(&subprogress, 0.0f);
3526                LoadInstruments(&subprogress);
3527                __notify_progress(&subprogress, 1.0f);
3528            }
3529          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
3530          InstrumentsIterator = pInstruments->begin();          InstrumentsIterator = pInstruments->begin();
3531          for (uint i = 0; InstrumentsIterator != pInstruments->end(); i++) {          for (uint i = 0; InstrumentsIterator != pInstruments->end(); i++) {
3532              if (i == index) return *InstrumentsIterator;              if (i == index) return static_cast<gig::Instrument*>( *InstrumentsIterator );
3533              InstrumentsIterator++;              InstrumentsIterator++;
3534          }          }
3535          return NULL;          return NULL;
3536      }      }
3537    
3538        /** @brief Add a new instrument definition.
3539         *
3540         * This will create a new Instrument object for the gig file. You have
3541         * to call Save() to make this persistent to the file.
3542         *
3543         * @returns pointer to new Instrument object
3544         */
3545        Instrument* File::AddInstrument() {
3546           if (!pInstruments) LoadInstruments();
3547           __ensureMandatoryChunksExist();
3548           RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
3549           RIFF::List* lstInstr = lstInstruments->AddSubList(LIST_TYPE_INS);
3550    
3551           // add mandatory chunks to get the chunks in right order
3552           lstInstr->AddSubList(LIST_TYPE_INFO);
3553           lstInstr->AddSubChunk(CHUNK_ID_DLID, 16);
3554    
3555           Instrument* pInstrument = new Instrument(this, lstInstr);
3556           pInstrument->GenerateDLSID();
3557    
3558           lstInstr->AddSubChunk(CHUNK_ID_INSH, 12);
3559    
3560           // this string is needed for the gig to be loadable in GSt:
3561           pInstrument->pInfo->Software = "Endless Wave";
3562    
3563           pInstruments->push_back(pInstrument);
3564           return pInstrument;
3565        }
3566    
3567        /** @brief Delete an instrument.
3568         *
3569         * This will delete the given Instrument object from the gig file. You
3570         * have to call Save() to make this persistent to the file.
3571         *
3572         * @param pInstrument - instrument to delete
3573         * @throws gig::Exception if given instrument could not be found
3574         */
3575        void File::DeleteInstrument(Instrument* pInstrument) {
3576            if (!pInstruments) throw gig::Exception("Could not delete instrument as there are no instruments");
3577            InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), (DLS::Instrument*) pInstrument);
3578            if (iter == pInstruments->end()) throw gig::Exception("Could not delete instrument, could not find given instrument");
3579            pInstruments->erase(iter);
3580            delete pInstrument;
3581        }
3582    
3583      void File::LoadInstruments() {      void File::LoadInstruments() {
3584            LoadInstruments(NULL);
3585        }
3586    
3587        void File::LoadInstruments(progress_t* pProgress) {
3588            if (!pInstruments) pInstruments = new InstrumentList;
3589          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
3590          if (lstInstruments) {          if (lstInstruments) {
3591                int iInstrumentIndex = 0;
3592              RIFF::List* lstInstr = lstInstruments->GetFirstSubList();              RIFF::List* lstInstr = lstInstruments->GetFirstSubList();
3593              while (lstInstr) {              while (lstInstr) {
3594                  if (lstInstr->GetListType() == LIST_TYPE_INS) {                  if (lstInstr->GetListType() == LIST_TYPE_INS) {
3595                      if (!pInstruments) pInstruments = new InstrumentList;                      // notify current progress
3596                      pInstruments->push_back(new Instrument(this, lstInstr));                      const float localProgress = (float) iInstrumentIndex / (float) Instruments;
3597                        __notify_progress(pProgress, localProgress);
3598    
3599                        // divide local progress into subprogress for loading current Instrument
3600                        progress_t subprogress;
3601                        __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);
3602    
3603                        pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));
3604    
3605                        iInstrumentIndex++;
3606                  }                  }
3607                  lstInstr = lstInstruments->GetNextSubList();                  lstInstr = lstInstruments->GetNextSubList();
3608              }              }
3609                __notify_progress(pProgress, 1.0); // notify done
3610          }          }
3611          else throw gig::Exception("Mandatory <lins> list chunk not found.");      }
3612    
3613        /// Updates the 3crc chunk with the checksum of a sample. The
3614        /// update is done directly to disk, as this method is called
3615        /// after File::Save()
3616        void File::SetSampleChecksum(Sample* pSample, uint32_t crc) {
3617            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
3618            if (!_3crc) return;
3619    
3620            // get the index of the sample
3621            int iWaveIndex = -1;
3622            File::SampleList::iterator iter = pSamples->begin();
3623            File::SampleList::iterator end  = pSamples->end();
3624            for (int index = 0; iter != end; ++iter, ++index) {
3625                if (*iter == pSample) {
3626                    iWaveIndex = index;
3627                    break;
3628                }
3629            }
3630            if (iWaveIndex < 0) throw gig::Exception("Could not update crc, could not find sample");
3631    
3632            // write the CRC-32 checksum to disk
3633            _3crc->SetPos(iWaveIndex * 8);
3634            uint32_t tmp = 1;
3635            _3crc->WriteUint32(&tmp); // unknown, always 1?
3636            _3crc->WriteUint32(&crc);
3637        }
3638    
3639        Group* File::GetFirstGroup() {
3640            if (!pGroups) LoadGroups();
3641            // there must always be at least one group
3642            GroupsIterator = pGroups->begin();
3643            return *GroupsIterator;
3644        }
3645    
3646        Group* File::GetNextGroup() {
3647            if (!pGroups) return NULL;
3648            ++GroupsIterator;
3649            return (GroupsIterator == pGroups->end()) ? NULL : *GroupsIterator;
3650        }
3651    
3652        /**
3653         * Returns the group with the given index.
3654         *
3655         * @param index - number of the sought group (0..n)
3656         * @returns sought group or NULL if there's no such group
3657         */
3658        Group* File::GetGroup(uint index) {
3659            if (!pGroups) LoadGroups();
3660            GroupsIterator = pGroups->begin();
3661            for (uint i = 0; GroupsIterator != pGroups->end(); i++) {
3662                if (i == index) return *GroupsIterator;
3663                ++GroupsIterator;
3664            }
3665            return NULL;
3666        }
3667    
3668        Group* File::AddGroup() {
3669            if (!pGroups) LoadGroups();
3670            // there must always be at least one group
3671            __ensureMandatoryChunksExist();
3672            Group* pGroup = new Group(this, NULL);
3673            pGroups->push_back(pGroup);
3674            return pGroup;
3675        }
3676    
3677        /** @brief Delete a group and its samples.
3678         *
3679         * This will delete the given Group object and all the samples that
3680         * belong to this group from the gig file. You have to call Save() to
3681         * make this persistent to the file.
3682         *
3683         * @param pGroup - group to delete
3684         * @throws gig::Exception if given group could not be found
3685         */
3686        void File::DeleteGroup(Group* pGroup) {
3687            if (!pGroups) LoadGroups();
3688            std::list<Group*>::iterator iter = find(pGroups->begin(), pGroups->end(), pGroup);
3689            if (iter == pGroups->end()) throw gig::Exception("Could not delete group, could not find given group");
3690            if (pGroups->size() == 1) throw gig::Exception("Cannot delete group, there must be at least one default group!");
3691            // delete all members of this group
3692            for (Sample* pSample = pGroup->GetFirstSample(); pSample; pSample = pGroup->GetNextSample()) {
3693                DeleteSample(pSample);
3694            }
3695            // now delete this group object
3696            pGroups->erase(iter);
3697            delete pGroup;
3698        }
3699    
3700        /** @brief Delete a group.
3701         *
3702         * This will delete the given Group object from the gig file. All the
3703         * samples that belong to this group will not be deleted, but instead
3704         * be moved to another group. You have to call Save() to make this
3705         * persistent to the file.
3706         *
3707         * @param pGroup - group to delete
3708         * @throws gig::Exception if given group could not be found
3709         */
3710        void File::DeleteGroupOnly(Group* pGroup) {
3711            if (!pGroups) LoadGroups();
3712            std::list<Group*>::iterator iter = find(pGroups->begin(), pGroups->end(), pGroup)