/[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 352 by schoenebeck, Sat Jan 29 14:24:11 2005 UTC revision 1266 by persson, Thu Aug 2 14:12:55 2007 UTC
# Line 1  Line 1 
1  /***************************************************************************  /***************************************************************************
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file loader library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003, 2004 by Christian Schoenebeck                     *   *   Copyright (C) 2003-2007 by Christian Schoenebeck                      *
6   *                               <cuse@users.sourceforge.net>              *   *                              <cuse@users.sourceforge.net>               *
7   *                                                                         *   *                                                                         *
8   *   This library is free software; you can redistribute it and/or modify  *   *   This library is free software; you can redistribute it and/or modify  *
9   *   it under the terms of the GNU General Public License as published by  *   *   it under the terms of the GNU General Public License as published by  *
# Line 23  Line 23 
23    
24  #include "gig.h"  #include "gig.h"
25    
26    #include "helper.h"
27    
28    #include <math.h>
29    #include <iostream>
30    
31    /// Initial size of the sample buffer which is used for decompression of
32    /// compressed sample wave streams - this value should always be bigger than
33    /// the biggest sample piece expected to be read by the sampler engine,
34    /// otherwise the buffer size will be raised at runtime and thus the buffer
35    /// reallocated which is time consuming and unefficient.
36    #define INITIAL_SAMPLE_BUFFER_SIZE              512000 // 512 kB
37    
38    /** (so far) every exponential paramater in the gig format has a basis of 1.000000008813822 */
39    #define GIG_EXP_DECODE(x)                       (pow(1.000000008813822, x))
40    #define GIG_EXP_ENCODE(x)                       (log(x) / log(1.000000008813822))
41    #define GIG_PITCH_TRACK_EXTRACT(x)              (!(x & 0x01))
42    #define GIG_PITCH_TRACK_ENCODE(x)               ((x) ? 0x00 : 0x01)
43    #define GIG_VCF_RESONANCE_CTRL_EXTRACT(x)       ((x >> 4) & 0x03)
44    #define GIG_VCF_RESONANCE_CTRL_ENCODE(x)        ((x & 0x03) << 4)
45    #define GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(x)  ((x >> 1) & 0x03)
46    #define GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(x)   ((x >> 3) & 0x03)
47    #define GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(x) ((x >> 5) & 0x03)
48    #define GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(x)   ((x & 0x03) << 1)
49    #define GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(x)    ((x & 0x03) << 3)
50    #define GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(x)  ((x & 0x03) << 5)
51    
52  namespace gig {  namespace gig {
53    
54    // *************** progress_t ***************
55    // *
56    
57        progress_t::progress_t() {
58            callback    = NULL;
59            custom      = NULL;
60            __range_min = 0.0f;
61            __range_max = 1.0f;
62        }
63    
64        // private helper function to convert progress of a subprocess into the global progress
65        static void __notify_progress(progress_t* pProgress, float subprogress) {
66            if (pProgress && pProgress->callback) {
67                const float totalrange    = pProgress->__range_max - pProgress->__range_min;
68                const float totalprogress = pProgress->__range_min + subprogress * totalrange;
69                pProgress->factor         = totalprogress;
70                pProgress->callback(pProgress); // now actually notify about the progress
71            }
72        }
73    
74        // private helper function to divide a progress into subprogresses
75        static void __divide_progress(progress_t* pParentProgress, progress_t* pSubProgress, float totalTasks, float currentTask) {
76            if (pParentProgress && pParentProgress->callback) {
77                const float totalrange    = pParentProgress->__range_max - pParentProgress->__range_min;
78                pSubProgress->callback    = pParentProgress->callback;
79                pSubProgress->custom      = pParentProgress->custom;
80                pSubProgress->__range_min = pParentProgress->__range_min + totalrange * currentTask / totalTasks;
81                pSubProgress->__range_max = pSubProgress->__range_min + totalrange / totalTasks;
82            }
83        }
84    
85    
86    // *************** Internal functions for sample decompression ***************
87    // *
88    
89    namespace {
90    
91        inline int get12lo(const unsigned char* pSrc)
92        {
93            const int x = pSrc[0] | (pSrc[1] & 0x0f) << 8;
94            return x & 0x800 ? x - 0x1000 : x;
95        }
96    
97        inline int get12hi(const unsigned char* pSrc)
98        {
99            const int x = pSrc[1] >> 4 | pSrc[2] << 4;
100            return x & 0x800 ? x - 0x1000 : x;
101        }
102    
103        inline int16_t get16(const unsigned char* pSrc)
104        {
105            return int16_t(pSrc[0] | pSrc[1] << 8);
106        }
107    
108        inline int get24(const unsigned char* pSrc)
109        {
110            const int x = pSrc[0] | pSrc[1] << 8 | pSrc[2] << 16;
111            return x & 0x800000 ? x - 0x1000000 : x;
112        }
113    
114        inline void store24(unsigned char* pDst, int x)
115        {
116            pDst[0] = x;
117            pDst[1] = x >> 8;
118            pDst[2] = x >> 16;
119        }
120    
121        void Decompress16(int compressionmode, const unsigned char* params,
122                          int srcStep, int dstStep,
123                          const unsigned char* pSrc, int16_t* pDst,
124                          unsigned long currentframeoffset,
125                          unsigned long copysamples)
126        {
127            switch (compressionmode) {
128                case 0: // 16 bit uncompressed
129                    pSrc += currentframeoffset * srcStep;
130                    while (copysamples) {
131                        *pDst = get16(pSrc);
132                        pDst += dstStep;
133                        pSrc += srcStep;
134                        copysamples--;
135                    }
136                    break;
137    
138                case 1: // 16 bit compressed to 8 bit
139                    int y  = get16(params);
140                    int dy = get16(params + 2);
141                    while (currentframeoffset) {
142                        dy -= int8_t(*pSrc);
143                        y  -= dy;
144                        pSrc += srcStep;
145                        currentframeoffset--;
146                    }
147                    while (copysamples) {
148                        dy -= int8_t(*pSrc);
149                        y  -= dy;
150                        *pDst = y;
151                        pDst += dstStep;
152                        pSrc += srcStep;
153                        copysamples--;
154                    }
155                    break;
156            }
157        }
158    
159        void Decompress24(int compressionmode, const unsigned char* params,
160                          int dstStep, const unsigned char* pSrc, uint8_t* pDst,
161                          unsigned long currentframeoffset,
162                          unsigned long copysamples, int truncatedBits)
163        {
164            int y, dy, ddy, dddy;
165    
166    #define GET_PARAMS(params)                      \
167            y    = get24(params);                   \
168            dy   = y - get24((params) + 3);         \
169            ddy  = get24((params) + 6);             \
170            dddy = get24((params) + 9)
171    
172    #define SKIP_ONE(x)                             \
173            dddy -= (x);                            \
174            ddy  -= dddy;                           \
175            dy   =  -dy - ddy;                      \
176            y    += dy
177    
178    #define COPY_ONE(x)                             \
179            SKIP_ONE(x);                            \
180            store24(pDst, y << truncatedBits);      \
181            pDst += dstStep
182    
183            switch (compressionmode) {
184                case 2: // 24 bit uncompressed
185                    pSrc += currentframeoffset * 3;
186                    while (copysamples) {
187                        store24(pDst, get24(pSrc) << truncatedBits);
188                        pDst += dstStep;
189                        pSrc += 3;
190                        copysamples--;
191                    }
192                    break;
193    
194                case 3: // 24 bit compressed to 16 bit
195                    GET_PARAMS(params);
196                    while (currentframeoffset) {
197                        SKIP_ONE(get16(pSrc));
198                        pSrc += 2;
199                        currentframeoffset--;
200                    }
201                    while (copysamples) {
202                        COPY_ONE(get16(pSrc));
203                        pSrc += 2;
204                        copysamples--;
205                    }
206                    break;
207    
208                case 4: // 24 bit compressed to 12 bit
209                    GET_PARAMS(params);
210                    while (currentframeoffset > 1) {
211                        SKIP_ONE(get12lo(pSrc));
212                        SKIP_ONE(get12hi(pSrc));
213                        pSrc += 3;
214                        currentframeoffset -= 2;
215                    }
216                    if (currentframeoffset) {
217                        SKIP_ONE(get12lo(pSrc));
218                        currentframeoffset--;
219                        if (copysamples) {
220                            COPY_ONE(get12hi(pSrc));
221                            pSrc += 3;
222                            copysamples--;
223                        }
224                    }
225                    while (copysamples > 1) {
226                        COPY_ONE(get12lo(pSrc));
227                        COPY_ONE(get12hi(pSrc));
228                        pSrc += 3;
229                        copysamples -= 2;
230                    }
231                    if (copysamples) {
232                        COPY_ONE(get12lo(pSrc));
233                    }
234                    break;
235    
236                case 5: // 24 bit compressed to 8 bit
237                    GET_PARAMS(params);
238                    while (currentframeoffset) {
239                        SKIP_ONE(int8_t(*pSrc++));
240                        currentframeoffset--;
241                    }
242                    while (copysamples) {
243                        COPY_ONE(int8_t(*pSrc++));
244                        copysamples--;
245                    }
246                    break;
247            }
248        }
249    
250        const int bytesPerFrame[] =      { 4096, 2052, 768, 524, 396, 268 };
251        const int bytesPerFrameNoHdr[] = { 4096, 2048, 768, 512, 384, 256 };
252        const int headerSize[] =         { 0, 4, 0, 12, 12, 12 };
253        const int bitsPerSample[] =      { 16, 8, 24, 16, 12, 8 };
254    }
255    
256    
257    
258    // *************** Other Internal functions  ***************
259    // *
260    
261        static split_type_t __resolveSplitType(dimension_t dimension) {
262            return (
263                dimension == dimension_layer ||
264                dimension == dimension_samplechannel ||
265                dimension == dimension_releasetrigger ||
266                dimension == dimension_keyboard ||
267                dimension == dimension_roundrobin ||
268                dimension == dimension_random ||
269                dimension == dimension_smartmidi ||
270                dimension == dimension_roundrobinkeyboard
271            ) ? split_type_bit : split_type_normal;
272        }
273    
274        static int __resolveZoneSize(dimension_def_t& dimension_definition) {
275            return (dimension_definition.split_type == split_type_normal)
276            ? int(128.0 / dimension_definition.zones) : 0;
277        }
278    
279    
280    
281    // *************** CRC ***************
282    // *
283    
284        const uint32_t* CRC::table(initTable());
285    
286        uint32_t* CRC::initTable() {
287            uint32_t* res = new uint32_t[256];
288    
289            for (int i = 0 ; i < 256 ; i++) {
290                uint32_t c = i;
291                for (int j = 0 ; j < 8 ; j++) {
292                    c = (c & 1) ? 0xedb88320 ^ (c >> 1) : c >> 1;
293                }
294                res[i] = c;
295            }
296            return res;
297        }
298    
299    
300    
301  // *************** Sample ***************  // *************** Sample ***************
302  // *  // *
303    
304      unsigned int  Sample::Instances               = 0;      unsigned int Sample::Instances = 0;
305      void*         Sample::pDecompressionBuffer    = NULL;      buffer_t     Sample::InternalDecompressionBuffer;
     unsigned long Sample::DecompressionBufferSize = 0;  
306    
307      Sample::Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {      /** @brief Constructor.
308         *
309         * Load an existing sample or create a new one. A 'wave' list chunk must
310         * be given to this constructor. In case the given 'wave' list chunk
311         * contains a 'fmt', 'data' (and optionally a '3gix', 'smpl') chunk, the
312         * format and sample data will be loaded from there, otherwise default
313         * values will be used and those chunks will be created when
314         * File::Save() will be called later on.
315         *
316         * @param pFile          - pointer to gig::File where this sample is
317         *                         located (or will be located)
318         * @param waveList       - pointer to 'wave' list chunk which is (or
319         *                         will be) associated with this sample
320         * @param WavePoolOffset - offset of this sample data from wave pool
321         *                         ('wvpl') list chunk
322         * @param fileNo         - number of an extension file where this sample
323         *                         is located, 0 otherwise
324         */
325        Sample::Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {
326            static const DLS::Info::FixedStringLength fixedStringLengths[] = {
327                { CHUNK_ID_INAM, 64 },
328                { 0, 0 }
329            };
330            pInfo->FixedStringLengths = fixedStringLengths;
331          Instances++;          Instances++;
332            FileNo = fileNo;
333    
334          RIFF::Chunk* _3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);          pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);
335          if (!_3gix) throw gig::Exception("Mandatory chunks in <wave> list chunk not found.");          if (pCk3gix) {
336          SampleGroup = _3gix->ReadInt16();              uint16_t iSampleGroup = pCk3gix->ReadInt16();
337                pGroup = pFile->GetGroup(iSampleGroup);
338          RIFF::Chunk* smpl = waveList->GetSubChunk(CHUNK_ID_SMPL);          } else { // '3gix' chunk missing
339          if (!smpl) throw gig::Exception("Mandatory chunks in <wave> list chunk not found.");              // by default assigned to that mandatory "Default Group"
340          Manufacturer      = smpl->ReadInt32();              pGroup = pFile->GetGroup(0);
341          Product           = smpl->ReadInt32();          }
342          SamplePeriod      = smpl->ReadInt32();  
343          MIDIUnityNote     = smpl->ReadInt32();          pCkSmpl = waveList->GetSubChunk(CHUNK_ID_SMPL);
344          FineTune          = smpl->ReadInt32();          if (pCkSmpl) {
345          smpl->Read(&SMPTEFormat, 1, 4);              Manufacturer  = pCkSmpl->ReadInt32();
346          SMPTEOffset       = smpl->ReadInt32();              Product       = pCkSmpl->ReadInt32();
347          Loops             = smpl->ReadInt32();              SamplePeriod  = pCkSmpl->ReadInt32();
348          uint32_t manufByt = smpl->ReadInt32();              MIDIUnityNote = pCkSmpl->ReadInt32();
349          LoopID            = smpl->ReadInt32();              FineTune      = pCkSmpl->ReadInt32();
350          smpl->Read(&LoopType, 1, 4);              pCkSmpl->Read(&SMPTEFormat, 1, 4);
351          LoopStart         = smpl->ReadInt32();              SMPTEOffset   = pCkSmpl->ReadInt32();
352          LoopEnd           = smpl->ReadInt32();              Loops         = pCkSmpl->ReadInt32();
353          LoopFraction      = smpl->ReadInt32();              pCkSmpl->ReadInt32(); // manufByt
354          LoopPlayCount     = smpl->ReadInt32();              LoopID        = pCkSmpl->ReadInt32();
355                pCkSmpl->Read(&LoopType, 1, 4);
356                LoopStart     = pCkSmpl->ReadInt32();
357                LoopEnd       = pCkSmpl->ReadInt32();
358                LoopFraction  = pCkSmpl->ReadInt32();
359                LoopPlayCount = pCkSmpl->ReadInt32();
360            } else { // 'smpl' chunk missing
361                // use default values
362                Manufacturer  = 0;
363                Product       = 0;
364                SamplePeriod  = uint32_t(1000000000.0 / SamplesPerSecond + 0.5);
365                MIDIUnityNote = 60;
366                FineTune      = 0;
367                SMPTEFormat   = smpte_format_no_offset;
368                SMPTEOffset   = 0;
369                Loops         = 0;
370                LoopID        = 0;
371                LoopType      = loop_type_normal;
372                LoopStart     = 0;
373                LoopEnd       = 0;
374                LoopFraction  = 0;
375                LoopPlayCount = 0;
376            }
377    
378          FrameTable                 = NULL;          FrameTable                 = NULL;
379          SamplePos                  = 0;          SamplePos                  = 0;
# Line 63  namespace gig { Line 381  namespace gig {
381          RAMCache.pStart            = NULL;          RAMCache.pStart            = NULL;
382          RAMCache.NullExtensionSize = 0;          RAMCache.NullExtensionSize = 0;
383    
384          Compressed = (waveList->GetSubChunk(CHUNK_ID_EWAV));          if (BitDepth > 24) throw gig::Exception("Only samples up to 24 bit supported");
385    
386            RIFF::Chunk* ewav = waveList->GetSubChunk(CHUNK_ID_EWAV);
387            Compressed        = ewav;
388            Dithered          = false;
389            TruncatedBits     = 0;
390          if (Compressed) {          if (Compressed) {
391                uint32_t version = ewav->ReadInt32();
392                if (version == 3 && BitDepth == 24) {
393                    Dithered = ewav->ReadInt32();
394                    ewav->SetPos(Channels == 2 ? 84 : 64);
395                    TruncatedBits = ewav->ReadInt32();
396                }
397              ScanCompressedSample();              ScanCompressedSample();
398          }          }
399    
         if (BitDepth > 24)                throw gig::Exception("Only samples up to 24 bit supported");  
         if (Compressed && Channels == 1)  throw gig::Exception("Mono compressed samples not yet supported");  
         if (Compressed && BitDepth == 24) throw gig::Exception("24 bit compressed samples not yet supported");  
   
400          // we use a buffer for decompression and for truncating 24 bit samples to 16 bit          // we use a buffer for decompression and for truncating 24 bit samples to 16 bit
401          if ((Compressed || BitDepth == 24) && !pDecompressionBuffer) {          if ((Compressed || BitDepth == 24) && !InternalDecompressionBuffer.Size) {
402              pDecompressionBuffer    = new int8_t[INITIAL_SAMPLE_BUFFER_SIZE];              InternalDecompressionBuffer.pStart = new unsigned char[INITIAL_SAMPLE_BUFFER_SIZE];
403              DecompressionBufferSize = INITIAL_SAMPLE_BUFFER_SIZE;              InternalDecompressionBuffer.Size   = INITIAL_SAMPLE_BUFFER_SIZE;
404          }          }
405          FrameOffset = 0; // just for streaming compressed samples          FrameOffset = 0; // just for streaming compressed samples
406    
407          LoopSize = LoopEnd - LoopStart;          LoopSize = LoopEnd - LoopStart + 1;
408        }
409    
410        /**
411         * Apply sample and its settings to the respective RIFF chunks. You have
412         * to call File::Save() to make changes persistent.
413         *
414         * Usually there is absolutely no need to call this method explicitly.
415         * It will be called automatically when File::Save() was called.
416         *
417         * @throws DLS::Exception if FormatTag != DLS_WAVE_FORMAT_PCM or no sample data
418         *                        was provided yet
419         * @throws gig::Exception if there is any invalid sample setting
420         */
421        void Sample::UpdateChunks() {
422            // first update base class's chunks
423            DLS::Sample::UpdateChunks();
424    
425            // make sure 'smpl' chunk exists
426            pCkSmpl = pWaveList->GetSubChunk(CHUNK_ID_SMPL);
427            if (!pCkSmpl) {
428                pCkSmpl = pWaveList->AddSubChunk(CHUNK_ID_SMPL, 60);
429                memset(pCkSmpl->LoadChunkData(), 0, 60);
430            }
431            // update 'smpl' chunk
432            uint8_t* pData = (uint8_t*) pCkSmpl->LoadChunkData();
433            SamplePeriod = uint32_t(1000000000.0 / SamplesPerSecond + 0.5);
434            store32(&pData[0], Manufacturer);
435            store32(&pData[4], Product);
436            store32(&pData[8], SamplePeriod);
437            store32(&pData[12], MIDIUnityNote);
438            store32(&pData[16], FineTune);
439            store32(&pData[20], SMPTEFormat);
440            store32(&pData[24], SMPTEOffset);
441            store32(&pData[28], Loops);
442    
443            // we skip 'manufByt' for now (4 bytes)
444    
445            store32(&pData[36], LoopID);
446            store32(&pData[40], LoopType);
447            store32(&pData[44], LoopStart);
448            store32(&pData[48], LoopEnd);
449            store32(&pData[52], LoopFraction);
450            store32(&pData[56], LoopPlayCount);
451    
452            // make sure '3gix' chunk exists
453            pCk3gix = pWaveList->GetSubChunk(CHUNK_ID_3GIX);
454            if (!pCk3gix) pCk3gix = pWaveList->AddSubChunk(CHUNK_ID_3GIX, 4);
455            // determine appropriate sample group index (to be stored in chunk)
456            uint16_t iSampleGroup = 0; // 0 refers to default sample group
457            File* pFile = static_cast<File*>(pParent);
458            if (pFile->pGroups) {
459                std::list<Group*>::iterator iter = pFile->pGroups->begin();
460                std::list<Group*>::iterator end  = pFile->pGroups->end();
461                for (int i = 0; iter != end; i++, iter++) {
462                    if (*iter == pGroup) {
463                        iSampleGroup = i;
464                        break; // found
465                    }
466                }
467            }
468            // update '3gix' chunk
469            pData = (uint8_t*) pCk3gix->LoadChunkData();
470            store16(&pData[0], iSampleGroup);
471      }      }
472    
473      /// Scans compressed samples for mandatory informations (e.g. actual number of total sample points).      /// Scans compressed samples for mandatory informations (e.g. actual number of total sample points).
# Line 88  namespace gig { Line 476  namespace gig {
476          this->SamplesTotal = 0;          this->SamplesTotal = 0;
477          std::list<unsigned long> frameOffsets;          std::list<unsigned long> frameOffsets;
478    
479            SamplesPerFrame = BitDepth == 24 ? 256 : 2048;
480            WorstCaseFrameSize = SamplesPerFrame * FrameSize + Channels; // +Channels for compression flag
481    
482          // Scanning          // Scanning
483          pCkData->SetPos(0);          pCkData->SetPos(0);
484          while (pCkData->GetState() == RIFF::stream_ready) {          if (Channels == 2) { // Stereo
485              frameOffsets.push_back(pCkData->GetPos());              for (int i = 0 ; ; i++) {
486              int16_t compressionmode = pCkData->ReadInt16();                  // for 24 bit samples every 8:th frame offset is
487              this->SamplesTotal += 2048;                  // stored, to save some memory
488              switch (compressionmode) {                  if (BitDepth != 24 || (i & 7) == 0) frameOffsets.push_back(pCkData->GetPos());
489                  case 1:   // left channel compressed  
490                  case 256: // right channel compressed                  const int mode_l = pCkData->ReadUint8();
491                      pCkData->SetPos(6148, RIFF::stream_curpos);                  const int mode_r = pCkData->ReadUint8();
492                    if (mode_l > 5 || mode_r > 5) throw gig::Exception("Unknown compression mode");
493                    const unsigned long frameSize = bytesPerFrame[mode_l] + bytesPerFrame[mode_r];
494    
495                    if (pCkData->RemainingBytes() <= frameSize) {
496                        SamplesInLastFrame =
497                            ((pCkData->RemainingBytes() - headerSize[mode_l] - headerSize[mode_r]) << 3) /
498                            (bitsPerSample[mode_l] + bitsPerSample[mode_r]);
499                        SamplesTotal += SamplesInLastFrame;
500                      break;                      break;
501                  case 257: // both channels compressed                  }
502                      pCkData->SetPos(4104, RIFF::stream_curpos);                  SamplesTotal += SamplesPerFrame;
503                    pCkData->SetPos(frameSize, RIFF::stream_curpos);
504                }
505            }
506            else { // Mono
507                for (int i = 0 ; ; i++) {
508                    if (BitDepth != 24 || (i & 7) == 0) frameOffsets.push_back(pCkData->GetPos());
509    
510                    const int mode = pCkData->ReadUint8();
511                    if (mode > 5) throw gig::Exception("Unknown compression mode");
512                    const unsigned long frameSize = bytesPerFrame[mode];
513    
514                    if (pCkData->RemainingBytes() <= frameSize) {
515                        SamplesInLastFrame =
516                            ((pCkData->RemainingBytes() - headerSize[mode]) << 3) / bitsPerSample[mode];
517                        SamplesTotal += SamplesInLastFrame;
518                      break;                      break;
519                  default: // both channels uncompressed                  }
520                      pCkData->SetPos(8192, RIFF::stream_curpos);                  SamplesTotal += SamplesPerFrame;
521                    pCkData->SetPos(frameSize, RIFF::stream_curpos);
522              }              }
523          }          }
524          pCkData->SetPos(0);          pCkData->SetPos(0);
525    
         //FIXME: only seen compressed samples with 16 bit stereo so far  
         this->FrameSize = 4;  
         this->BitDepth  = 16;  
   
526          // Build the frames table (which is used for fast resolving of a frame's chunk offset)          // Build the frames table (which is used for fast resolving of a frame's chunk offset)
527          if (FrameTable) delete[] FrameTable;          if (FrameTable) delete[] FrameTable;
528          FrameTable = new unsigned long[frameOffsets.size()];          FrameTable = new unsigned long[frameOffsets.size()];
# Line 147  namespace gig { Line 558  namespace gig {
558       * that will be returned to determine the actual cached samples, but note       * that will be returned to determine the actual cached samples, but note
559       * that the size is given in bytes! You get the number of actually cached       * that the size is given in bytes! You get the number of actually cached
560       * samples by dividing it by the frame size of the sample:       * samples by dividing it by the frame size of the sample:
561       *       * @code
562       *  buffer_t buf       = pSample->LoadSampleData(acquired_samples);       *  buffer_t buf       = pSample->LoadSampleData(acquired_samples);
563       *  long cachedsamples = buf.Size / pSample->FrameSize;       *  long cachedsamples = buf.Size / pSample->FrameSize;
564         * @endcode
565       *       *
566       * @param SampleCount - number of sample points to load into RAM       * @param SampleCount - number of sample points to load into RAM
567       * @returns             buffer_t structure with start address and size of       * @returns             buffer_t structure with start address and size of
# Line 195  namespace gig { Line 607  namespace gig {
607       * that will be returned to determine the actual cached samples, but note       * that will be returned to determine the actual cached samples, but note
608       * that the size is given in bytes! You get the number of actually cached       * that the size is given in bytes! You get the number of actually cached
609       * samples by dividing it by the frame size of the sample:       * samples by dividing it by the frame size of the sample:
610       *       * @code
611       *  buffer_t buf       = pSample->LoadSampleDataWithNullSamplesExtension(acquired_samples, null_samples);       *  buffer_t buf       = pSample->LoadSampleDataWithNullSamplesExtension(acquired_samples, null_samples);
612       *  long cachedsamples = buf.Size / pSample->FrameSize;       *  long cachedsamples = buf.Size / pSample->FrameSize;
613       *       * @endcode
614       * The method will add \a NullSamplesCount silence samples past the       * The method will add \a NullSamplesCount silence samples past the
615       * official buffer end (this won't affect the 'Size' member of the       * official buffer end (this won't affect the 'Size' member of the
616       * buffer_t structure, that means 'Size' always reflects the size of the       * buffer_t structure, that means 'Size' always reflects the size of the
# Line 258  namespace gig { Line 670  namespace gig {
670          RAMCache.Size   = 0;          RAMCache.Size   = 0;
671      }      }
672    
673        /** @brief Resize sample.
674         *
675         * Resizes the sample's wave form data, that is the actual size of
676         * sample wave data possible to be written for this sample. This call
677         * will return immediately and just schedule the resize operation. You
678         * should call File::Save() to actually perform the resize operation(s)
679         * "physically" to the file. As this can take a while on large files, it
680         * is recommended to call Resize() first on all samples which have to be
681         * resized and finally to call File::Save() to perform all those resize
682         * operations in one rush.
683         *
684         * The actual size (in bytes) is dependant to the current FrameSize
685         * value. You may want to set FrameSize before calling Resize().
686         *
687         * <b>Caution:</b> You cannot directly write (i.e. with Write()) to
688         * enlarged samples before calling File::Save() as this might exceed the
689         * current sample's boundary!
690         *
691         * Also note: only DLS_WAVE_FORMAT_PCM is currently supported, that is
692         * FormatTag must be DLS_WAVE_FORMAT_PCM. Trying to resize samples with
693         * other formats will fail!
694         *
695         * @param iNewSize - new sample wave data size in sample points (must be
696         *                   greater than zero)
697         * @throws DLS::Excecption if FormatTag != DLS_WAVE_FORMAT_PCM
698         *                         or if \a iNewSize is less than 1
699         * @throws gig::Exception if existing sample is compressed
700         * @see DLS::Sample::GetSize(), DLS::Sample::FrameSize,
701         *      DLS::Sample::FormatTag, File::Save()
702         */
703        void Sample::Resize(int iNewSize) {
704            if (Compressed) throw gig::Exception("There is no support for modifying compressed samples (yet)");
705            DLS::Sample::Resize(iNewSize);
706        }
707    
708      /**      /**
709       * Sets the position within the sample (in sample points, not in       * Sets the position within the sample (in sample points, not in
710       * bytes). Use this method and <i>Read()</i> if you don't want to load       * bytes). Use this method and <i>Read()</i> if you don't want to load
# Line 329  namespace gig { Line 776  namespace gig {
776       * for the next time you call this method is stored in \a pPlaybackState.       * for the next time you call this method is stored in \a pPlaybackState.
777       * You have to allocate and initialize the playback_state_t structure by       * You have to allocate and initialize the playback_state_t structure by
778       * yourself before you use it to stream a sample:       * yourself before you use it to stream a sample:
779       *       * @code
780       * <i>       * gig::playback_state_t playbackstate;
781       * gig::playback_state_t playbackstate;                           <br>       * playbackstate.position         = 0;
782       * playbackstate.position         = 0;                            <br>       * playbackstate.reverse          = false;
783       * playbackstate.reverse          = false;                        <br>       * playbackstate.loop_cycles_left = pSample->LoopPlayCount;
784       * playbackstate.loop_cycles_left = pSample->LoopPlayCount;       <br>       * @endcode
      * </i>  
      *  
785       * You don't have to take care of things like if there is actually a loop       * You don't have to take care of things like if there is actually a loop
786       * defined or if the current read position is located within a loop area.       * defined or if the current read position is located within a loop area.
787       * The method already handles such cases by itself.       * The method already handles such cases by itself.
788       *       *
789         * <b>Caution:</b> If you are using more than one streaming thread, you
790         * have to use an external decompression buffer for <b>EACH</b>
791         * streaming thread to avoid race conditions and crashes!
792         *
793       * @param pBuffer          destination buffer       * @param pBuffer          destination buffer
794       * @param SampleCount      number of sample points to read       * @param SampleCount      number of sample points to read
795       * @param pPlaybackState   will be used to store and reload the playback       * @param pPlaybackState   will be used to store and reload the playback
796       *                         state for the next ReadAndLoop() call       *                         state for the next ReadAndLoop() call
797         * @param pDimRgn          dimension region with looping information
798         * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression
799       * @returns                number of successfully read sample points       * @returns                number of successfully read sample points
800         * @see                    CreateDecompressionBuffer()
801       */       */
802      unsigned long Sample::ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState) {      unsigned long Sample::ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState,
803                                          DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer) {
804          unsigned long samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;          unsigned long samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;
805          uint8_t* pDst = (uint8_t*) pBuffer;          uint8_t* pDst = (uint8_t*) pBuffer;
806    
807          SetPos(pPlaybackState->position); // recover position from the last time          SetPos(pPlaybackState->position); // recover position from the last time
808    
809          if (this->Loops && GetPos() <= this->LoopEnd) { // honor looping if there are loop points defined          if (pDimRgn->SampleLoops) { // honor looping if there are loop points defined
810    
811              switch (this->LoopType) {              const DLS::sample_loop_t& loop = pDimRgn->pSampleLoops[0];
812                const uint32_t loopEnd = loop.LoopStart + loop.LoopLength;
813    
814                  case loop_type_bidirectional: { //TODO: not tested yet!              if (GetPos() <= loopEnd) {
815                      do {                  switch (loop.LoopType) {
                         // if not endless loop check if max. number of loop cycles have been passed  
                         if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;  
   
                         if (!pPlaybackState->reverse) { // forward playback  
                             do {  
                                 samplestoloopend  = this->LoopEnd - GetPos();  
                                 readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend));  
                                 samplestoread    -= readsamples;  
                                 totalreadsamples += readsamples;  
                                 if (readsamples == samplestoloopend) {  
                                     pPlaybackState->reverse = true;  
                                     break;  
                                 }  
                             } while (samplestoread && readsamples);  
                         }  
                         else { // backward playback  
816    
817                              // as we can only read forward from disk, we have to                      case loop_type_bidirectional: { //TODO: not tested yet!
818                              // determine the end position within the loop first,                          do {
819                              // read forward from that 'end' and finally after                              // if not endless loop check if max. number of loop cycles have been passed
820                              // reading, swap all sample frames so it reflects                              if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
821                              // backward playback  
822                                if (!pPlaybackState->reverse) { // forward playback
823                              unsigned long swapareastart       = totalreadsamples;                                  do {
824                              unsigned long loopoffset          = GetPos() - this->LoopStart;                                      samplestoloopend  = loopEnd - GetPos();
825                              unsigned long samplestoreadinloop = Min(samplestoread, loopoffset);                                      readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
826                              unsigned long reverseplaybackend  = GetPos() - samplestoreadinloop;                                      samplestoread    -= readsamples;
827                                        totalreadsamples += readsamples;
828                              SetPos(reverseplaybackend);                                      if (readsamples == samplestoloopend) {
829                                            pPlaybackState->reverse = true;
830                              // read samples for backward playback                                          break;
831                              do {                                      }
832                                  readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], samplestoreadinloop);                                  } while (samplestoread && readsamples);
833                                  samplestoreadinloop -= readsamples;                              }
834                                  samplestoread       -= readsamples;                              else { // backward playback
                                 totalreadsamples    += readsamples;  
                             } while (samplestoreadinloop && readsamples);  
835    
836                              SetPos(reverseplaybackend); // pretend we really read backwards                                  // as we can only read forward from disk, we have to
837                                    // determine the end position within the loop first,
838                                    // read forward from that 'end' and finally after
839                                    // reading, swap all sample frames so it reflects
840                                    // backward playback
841    
842                                    unsigned long swapareastart       = totalreadsamples;
843                                    unsigned long loopoffset          = GetPos() - loop.LoopStart;
844                                    unsigned long samplestoreadinloop = Min(samplestoread, loopoffset);
845                                    unsigned long reverseplaybackend  = GetPos() - samplestoreadinloop;
846    
847                                    SetPos(reverseplaybackend);
848    
849                                    // read samples for backward playback
850                                    do {
851                                        readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], samplestoreadinloop, pExternalDecompressionBuffer);
852                                        samplestoreadinloop -= readsamples;
853                                        samplestoread       -= readsamples;
854                                        totalreadsamples    += readsamples;
855                                    } while (samplestoreadinloop && readsamples);
856    
857                                    SetPos(reverseplaybackend); // pretend we really read backwards
858    
859                                    if (reverseplaybackend == loop.LoopStart) {
860                                        pPlaybackState->loop_cycles_left--;
861                                        pPlaybackState->reverse = false;
862                                    }
863    
864                              if (reverseplaybackend == this->LoopStart) {                                  // reverse the sample frames for backward playback
865                                  pPlaybackState->loop_cycles_left--;                                  SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
                                 pPlaybackState->reverse = false;  
866                              }                              }
867                            } while (samplestoread && readsamples);
868                            break;
869                        }
870    
871                              // reverse the sample frames for backward playback                      case loop_type_backward: { // TODO: not tested yet!
872                              SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);                          // forward playback (not entered the loop yet)
873                          }                          if (!pPlaybackState->reverse) do {
874                      } while (samplestoread && readsamples);                              samplestoloopend  = loopEnd - GetPos();
875                      break;                              readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
876                  }                              samplestoread    -= readsamples;
877                                totalreadsamples += readsamples;
878                  case loop_type_backward: { // TODO: not tested yet!                              if (readsamples == samplestoloopend) {
879                      // forward playback (not entered the loop yet)                                  pPlaybackState->reverse = true;
880                      if (!pPlaybackState->reverse) do {                                  break;
881                          samplestoloopend  = this->LoopEnd - GetPos();                              }
882                          readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend));                          } while (samplestoread && readsamples);
                         samplestoread    -= readsamples;  
                         totalreadsamples += readsamples;  
                         if (readsamples == samplestoloopend) {  
                             pPlaybackState->reverse = true;  
                             break;  
                         }  
                     } while (samplestoread && readsamples);  
883    
884                      if (!samplestoread) break;                          if (!samplestoread) break;
885    
886                      // as we can only read forward from disk, we have to                          // as we can only read forward from disk, we have to
887                      // determine the end position within the loop first,                          // determine the end position within the loop first,
888                      // read forward from that 'end' and finally after                          // read forward from that 'end' and finally after
889                      // reading, swap all sample frames so it reflects                          // reading, swap all sample frames so it reflects
890                      // backward playback                          // backward playback
891    
892                      unsigned long swapareastart       = totalreadsamples;                          unsigned long swapareastart       = totalreadsamples;
893                      unsigned long loopoffset          = GetPos() - this->LoopStart;                          unsigned long loopoffset          = GetPos() - loop.LoopStart;
894                      unsigned long samplestoreadinloop = (this->LoopPlayCount) ? Min(samplestoread, pPlaybackState->loop_cycles_left * LoopSize - loopoffset)                          unsigned long samplestoreadinloop = (this->LoopPlayCount) ? Min(samplestoread, pPlaybackState->loop_cycles_left * loop.LoopLength - loopoffset)
895                                                                                : samplestoread;                                                                                    : samplestoread;
896                      unsigned long reverseplaybackend  = this->LoopStart + Abs((loopoffset - samplestoreadinloop) % this->LoopSize);                          unsigned long reverseplaybackend  = loop.LoopStart + Abs((loopoffset - samplestoreadinloop) % loop.LoopLength);
897    
898                      SetPos(reverseplaybackend);                          SetPos(reverseplaybackend);
899    
900                      // read samples for backward playback                          // read samples for backward playback
901                      do {                          do {
902                          // if not endless loop check if max. number of loop cycles have been passed                              // if not endless loop check if max. number of loop cycles have been passed
903                          if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;                              if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
904                          samplestoloopend     = this->LoopEnd - GetPos();                              samplestoloopend     = loopEnd - GetPos();
905                          readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoreadinloop, samplestoloopend));                              readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoreadinloop, samplestoloopend), pExternalDecompressionBuffer);
906                          samplestoreadinloop -= readsamples;                              samplestoreadinloop -= readsamples;
907                          samplestoread       -= readsamples;                              samplestoread       -= readsamples;
908                          totalreadsamples    += readsamples;                              totalreadsamples    += readsamples;
909                          if (readsamples == samplestoloopend) {                              if (readsamples == samplestoloopend) {
910                              pPlaybackState->loop_cycles_left--;                                  pPlaybackState->loop_cycles_left--;
911                              SetPos(this->LoopStart);                                  SetPos(loop.LoopStart);
912                          }                              }
913                      } while (samplestoreadinloop && readsamples);                          } while (samplestoreadinloop && readsamples);
914    
915                      SetPos(reverseplaybackend); // pretend we really read backwards                          SetPos(reverseplaybackend); // pretend we really read backwards
916    
917                      // reverse the sample frames for backward playback                          // reverse the sample frames for backward playback
918                      SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);                          SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
919                      break;                          break;
920                  }                      }
921    
922                  default: case loop_type_normal: {                      default: case loop_type_normal: {
923                      do {                          do {
924                          // if not endless loop check if max. number of loop cycles have been passed                              // if not endless loop check if max. number of loop cycles have been passed
925                          if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;                              if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
926                          samplestoloopend  = this->LoopEnd - GetPos();                              samplestoloopend  = loopEnd - GetPos();
927                          readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend));                              readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
928                          samplestoread    -= readsamples;                              samplestoread    -= readsamples;
929                          totalreadsamples += readsamples;                              totalreadsamples += readsamples;
930                          if (readsamples == samplestoloopend) {                              if (readsamples == samplestoloopend) {
931                              pPlaybackState->loop_cycles_left--;                                  pPlaybackState->loop_cycles_left--;
932                              SetPos(this->LoopStart);                                  SetPos(loop.LoopStart);
933                          }                              }
934                      } while (samplestoread && readsamples);                          } while (samplestoread && readsamples);
935                      break;                          break;
936                        }
937                  }                  }
938              }              }
939          }          }
940    
941          // read on without looping          // read on without looping
942          if (samplestoread) do {          if (samplestoread) do {
943              readsamples = Read(&pDst[totalreadsamples * this->FrameSize], samplestoread);              readsamples = Read(&pDst[totalreadsamples * this->FrameSize], samplestoread, pExternalDecompressionBuffer);
944              samplestoread    -= readsamples;              samplestoread    -= readsamples;
945              totalreadsamples += readsamples;              totalreadsamples += readsamples;
946          } while (readsamples && samplestoread);          } while (readsamples && samplestoread);
# Line 501  namespace gig { Line 959  namespace gig {
959       * and <i>SetPos()</i> if you don't want to load the sample into RAM,       * and <i>SetPos()</i> if you don't want to load the sample into RAM,
960       * thus for disk streaming.       * thus for disk streaming.
961       *       *
962         * <b>Caution:</b> If you are using more than one streaming thread, you
963         * have to use an external decompression buffer for <b>EACH</b>
964         * streaming thread to avoid race conditions and crashes!
965         *
966         * For 16 bit samples, the data in the buffer will be int16_t
967         * (using native endianness). For 24 bit, the buffer will
968         * contain three bytes per sample, little-endian.
969         *
970       * @param pBuffer      destination buffer       * @param pBuffer      destination buffer
971       * @param SampleCount  number of sample points to read       * @param SampleCount  number of sample points to read
972         * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression
973       * @returns            number of successfully read sample points       * @returns            number of successfully read sample points
974       * @see                SetPos()       * @see                SetPos(), CreateDecompressionBuffer()
975       */       */
976      unsigned long Sample::Read(void* pBuffer, unsigned long SampleCount) {      unsigned long Sample::Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer) {
977          if (SampleCount == 0) return 0;          if (SampleCount == 0) return 0;
978          if (!Compressed) {          if (!Compressed) {
979              if (BitDepth == 24) {              if (BitDepth == 24) {
980                  // 24 bit sample. For now just truncate to 16 bit.                  return pCkData->Read(pBuffer, SampleCount * FrameSize, 1) / FrameSize;
981                  int8_t* pSrc = (int8_t*)this->pDecompressionBuffer;              }
982                  int8_t* pDst = (int8_t*)pBuffer;              else { // 16 bit
983                  unsigned long n = pCkData->Read(pSrc, SampleCount, FrameSize);                  // (pCkData->Read does endian correction)
984                  for (int i = SampleCount * (FrameSize / 3) ; i > 0 ; i--) {                  return Channels == 2 ? pCkData->Read(pBuffer, SampleCount << 1, 2) >> 1
985                      pSrc++;                                       : pCkData->Read(pBuffer, SampleCount, 2);
                     *pDst++ = *pSrc++;  
                     *pDst++ = *pSrc++;  
                 }  
                 return SampleCount;  
             } else {  
                 return pCkData->Read(pBuffer, SampleCount, FrameSize); //FIXME: channel inversion due to endian correction?  
986              }              }
987          }          }
988          else { //FIXME: no support for mono compressed samples yet, are there any?          else {
989              if (this->SamplePos >= this->SamplesTotal) return 0;              if (this->SamplePos >= this->SamplesTotal) return 0;
990              //TODO: efficiency: we simply assume here that all frames are compressed, maybe we should test for an average compression rate              //TODO: efficiency: maybe we should test for an average compression rate
991              // best case needed buffer size (all frames compressed)              unsigned long assumedsize      = GuessSize(SampleCount),
             unsigned long assumedsize      = (SampleCount << 1)  + // *2 (16 Bit, stereo, but assume all frames compressed)  
                                              (SampleCount >> 10) + // 10 bytes header per 2048 sample points  
                                              8194,                 // at least one worst case sample frame  
992                            remainingbytes   = 0,           // remaining bytes in the local buffer                            remainingbytes   = 0,           // remaining bytes in the local buffer
993                            remainingsamples = SampleCount,                            remainingsamples = SampleCount,
994                            copysamples;                            copysamples, skipsamples,
995              int currentframeoffset = this->FrameOffset;   // offset in current sample frame since last Read()                            currentframeoffset = this->FrameOffset;  // offset in current sample frame since last Read()
996              this->FrameOffset = 0;              this->FrameOffset = 0;
997    
998              if (assumedsize > this->DecompressionBufferSize) {              buffer_t* pDecompressionBuffer = (pExternalDecompressionBuffer) ? pExternalDecompressionBuffer : &InternalDecompressionBuffer;
999                  // local buffer reallocation - hope this won't happen  
1000                  if (this->pDecompressionBuffer) delete[] (int8_t*) this->pDecompressionBuffer;              // if decompression buffer too small, then reduce amount of samples to read
1001                  this->pDecompressionBuffer    = new int8_t[assumedsize << 1]; // double of current needed size              if (pDecompressionBuffer->Size < assumedsize) {
1002                  this->DecompressionBufferSize = assumedsize;                  std::cerr << "gig::Read(): WARNING - decompression buffer size too small!" << std::endl;
1003                    SampleCount      = WorstCaseMaxSamples(pDecompressionBuffer);
1004                    remainingsamples = SampleCount;
1005                    assumedsize      = GuessSize(SampleCount);
1006              }              }
1007    
1008              int16_t  compressionmode, left, dleft, right, dright;              unsigned char* pSrc = (unsigned char*) pDecompressionBuffer->pStart;
1009              int8_t*  pSrc = (int8_t*)  this->pDecompressionBuffer;              int16_t* pDst = static_cast<int16_t*>(pBuffer);
1010              int16_t* pDst = (int16_t*) pBuffer;              uint8_t* pDst24 = static_cast<uint8_t*>(pBuffer);
1011              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);
1012    
1013              while (remainingsamples) {              while (remainingsamples && remainingbytes) {
1014                    unsigned long framesamples = SamplesPerFrame;
1015                  // reload from disk to local buffer if needed                  unsigned long framebytes, rightChannelOffset = 0, nextFrameOffset;
1016                  if (remainingbytes < 8194) {  
1017                      if (pCkData->GetState() != RIFF::stream_ready) {                  int mode_l = *pSrc++, mode_r = 0;
1018                          this->SamplePos = this->SamplesTotal;  
1019                          return (SampleCount - remainingsamples);                  if (Channels == 2) {
1020                        mode_r = *pSrc++;
1021                        framebytes = bytesPerFrame[mode_l] + bytesPerFrame[mode_r] + 2;
1022                        rightChannelOffset = bytesPerFrameNoHdr[mode_l];
1023                        nextFrameOffset = rightChannelOffset + bytesPerFrameNoHdr[mode_r];
1024                        if (remainingbytes < framebytes) { // last frame in sample
1025                            framesamples = SamplesInLastFrame;
1026                            if (mode_l == 4 && (framesamples & 1)) {
1027                                rightChannelOffset = ((framesamples + 1) * bitsPerSample[mode_l]) >> 3;
1028                            }
1029                            else {
1030                                rightChannelOffset = (framesamples * bitsPerSample[mode_l]) >> 3;
1031                            }
1032                        }
1033                    }
1034                    else {
1035                        framebytes = bytesPerFrame[mode_l] + 1;
1036                        nextFrameOffset = bytesPerFrameNoHdr[mode_l];
1037                        if (remainingbytes < framebytes) {
1038                            framesamples = SamplesInLastFrame;
1039                      }                      }
                     assumedsize    = remainingsamples;  
                     assumedsize    = (assumedsize << 1)  + // *2 (16 Bit, stereo, but assume all frames compressed)  
                                      (assumedsize >> 10) + // 10 bytes header per 2048 sample points  
                                      8194;                 // at least one worst case sample frame  
                     pCkData->SetPos(remainingbytes, RIFF::stream_backward);  
                     if (pCkData->RemainingBytes() < assumedsize) assumedsize = pCkData->RemainingBytes();  
                     remainingbytes = pCkData->Read(this->pDecompressionBuffer, assumedsize, 1);  
                     pSrc = (int8_t*) this->pDecompressionBuffer;  
1040                  }                  }
1041    
1042                  // determine how many samples in this frame to skip and read                  // determine how many samples in this frame to skip and read
1043                  if (remainingsamples >= 2048) {                  if (currentframeoffset + remainingsamples >= framesamples) {
1044                      copysamples       = 2048 - currentframeoffset;                      if (currentframeoffset <= framesamples) {
1045                      remainingsamples -= copysamples;                          copysamples = framesamples - currentframeoffset;
1046                            skipsamples = currentframeoffset;
1047                        }
1048                        else {
1049                            copysamples = 0;
1050                            skipsamples = framesamples;
1051                        }
1052                  }                  }
1053                  else {                  else {
1054                        // This frame has enough data for pBuffer, but not
1055                        // all of the frame is needed. Set file position
1056                        // to start of this frame for next call to Read.
1057                      copysamples = remainingsamples;                      copysamples = remainingsamples;
1058                      if (currentframeoffset + copysamples > 2048) {                      skipsamples = currentframeoffset;
1059                          copysamples = 2048 - currentframeoffset;                      pCkData->SetPos(remainingbytes, RIFF::stream_backward);
1060                          remainingsamples -= copysamples;                      this->FrameOffset = currentframeoffset + copysamples;
1061                      }                  }
1062                      else {                  remainingsamples -= copysamples;
1063    
1064                    if (remainingbytes > framebytes) {
1065                        remainingbytes -= framebytes;
1066                        if (remainingsamples == 0 &&
1067                            currentframeoffset + copysamples == framesamples) {
1068                            // This frame has enough data for pBuffer, and
1069                            // all of the frame is needed. Set file
1070                            // position to start of next frame for next
1071                            // call to Read. FrameOffset is 0.
1072                          pCkData->SetPos(remainingbytes, RIFF::stream_backward);                          pCkData->SetPos(remainingbytes, RIFF::stream_backward);
                         remainingsamples = 0;  
                         this->FrameOffset = currentframeoffset + copysamples;  
1073                      }                      }
1074                  }                  }
1075                    else remainingbytes = 0;
1076    
1077                  // decompress and copy current frame from local buffer to destination buffer                  currentframeoffset -= skipsamples;
1078                  compressionmode = *(int16_t*)pSrc; pSrc+=2;  
1079                  switch (compressionmode) {                  if (copysamples == 0) {
1080                      case 1: // left channel compressed                      // skip this frame
1081                          remainingbytes -= 6150; // (left 8 bit, right 16 bit, +6 byte header)                      pSrc += framebytes - Channels;
1082                          if (!remainingsamples && copysamples == 2048)                  }
1083                              pCkData->SetPos(remainingbytes, RIFF::stream_backward);                  else {
1084                        const unsigned char* const param_l = pSrc;
1085                          left  = *(int16_t*)pSrc; pSrc+=2;                      if (BitDepth == 24) {
1086                          dleft = *(int16_t*)pSrc; pSrc+=2;                          if (mode_l != 2) pSrc += 12;
1087                          while (currentframeoffset) {  
1088                              dleft -= *pSrc;                          if (Channels == 2) { // Stereo
1089                              left  -= dleft;                              const unsigned char* const param_r = pSrc;
1090                              pSrc+=3; // 8 bit left channel, skip uncompressed right channel (16 bit)                              if (mode_r != 2) pSrc += 12;
1091                              currentframeoffset--;  
1092                          }                              Decompress24(mode_l, param_l, 6, pSrc, pDst24,
1093                          while (copysamples) {                                           skipsamples, copysamples, TruncatedBits);
1094                              dleft -= *pSrc; pSrc++;                              Decompress24(mode_r, param_r, 6, pSrc + rightChannelOffset, pDst24 + 3,
1095                              left  -= dleft;                                           skipsamples, copysamples, TruncatedBits);
1096                              *pDst = left; pDst++;                              pDst24 += copysamples * 6;
                             *pDst = *(int16_t*)pSrc; pDst++; pSrc+=2;  
                             copysamples--;  
                         }  
                         break;  
                     case 256: // right channel compressed  
                         remainingbytes -= 6150; // (left 16 bit, right 8 bit, +6 byte header)  
                         if (!remainingsamples && copysamples == 2048)  
                             pCkData->SetPos(remainingbytes, RIFF::stream_backward);  
   
                         right  = *(int16_t*)pSrc; pSrc+=2;  
                         dright = *(int16_t*)pSrc; pSrc+=2;  
                         if (currentframeoffset) {  
                             pSrc+=2; // skip uncompressed left channel, now we can increment by 3  
                             while (currentframeoffset) {  
                                 dright -= *pSrc;  
                                 right  -= dright;  
                                 pSrc+=3; // 8 bit right channel, skip uncompressed left channel (16 bit)  
                                 currentframeoffset--;  
                             }  
                             pSrc-=2; // back aligned to left channel  
1097                          }                          }
1098                          while (copysamples) {                          else { // Mono
1099                              *pDst = *(int16_t*)pSrc; pDst++; pSrc+=2;                              Decompress24(mode_l, param_l, 3, pSrc, pDst24,
1100                              dright -= *pSrc; pSrc++;                                           skipsamples, copysamples, TruncatedBits);
1101                              right  -= dright;                              pDst24 += copysamples * 3;
                             *pDst = right; pDst++;  
                             copysamples--;  
1102                          }                          }
1103                          break;                      }
1104                      case 257: // both channels compressed                      else { // 16 bit
1105                          remainingbytes -= 4106; // (left 8 bit, right 8 bit, +10 byte header)                          if (mode_l) pSrc += 4;
1106                          if (!remainingsamples && copysamples == 2048)  
1107                              pCkData->SetPos(remainingbytes, RIFF::stream_backward);                          int step;
1108                            if (Channels == 2) { // Stereo
1109                          left   = *(int16_t*)pSrc; pSrc+=2;                              const unsigned char* const param_r = pSrc;
1110                          dleft  = *(int16_t*)pSrc; pSrc+=2;                              if (mode_r) pSrc += 4;
1111                          right  = *(int16_t*)pSrc; pSrc+=2;  
1112                          dright = *(int16_t*)pSrc; pSrc+=2;                              step = (2 - mode_l) + (2 - mode_r);
1113                          while (currentframeoffset) {                              Decompress16(mode_l, param_l, step, 2, pSrc, pDst, skipsamples, copysamples);
1114                              dleft  -= *pSrc; pSrc++;                              Decompress16(mode_r, param_r, step, 2, pSrc + (2 - mode_l), pDst + 1,
1115                              left   -= dleft;                                           skipsamples, copysamples);
1116                              dright -= *pSrc; pSrc++;                              pDst += copysamples << 1;
                             right  -= dright;  
                             currentframeoffset--;  
1117                          }                          }
1118                          while (copysamples) {                          else { // Mono
1119                              dleft  -= *pSrc; pSrc++;                              step = 2 - mode_l;
1120                              left   -= dleft;                              Decompress16(mode_l, param_l, step, 1, pSrc, pDst, skipsamples, copysamples);
1121                              dright -= *pSrc; pSrc++;                              pDst += copysamples;
                             right  -= dright;  
                             *pDst = left;  pDst++;  
                             *pDst = right; pDst++;  
                             copysamples--;  
1122                          }                          }
1123                          break;                      }
1124                      default: // both channels uncompressed                      pSrc += nextFrameOffset;
                         remainingbytes -= 8194; // (left 16 bit, right 16 bit, +2 byte header)  
                         if (!remainingsamples && copysamples == 2048)  
                             pCkData->SetPos(remainingbytes, RIFF::stream_backward);  
   
                         pSrc += currentframeoffset << 2;  
                         currentframeoffset = 0;  
                         memcpy(pDst, pSrc, copysamples << 2);  
                         pDst += copysamples << 1;  
                         pSrc += copysamples << 2;  
                         break;  
1125                  }                  }
1126              }  
1127                    // reload from disk to local buffer if needed
1128                    if (remainingsamples && remainingbytes < WorstCaseFrameSize && pCkData->GetState() == RIFF::stream_ready) {
1129                        assumedsize    = GuessSize(remainingsamples);
1130                        pCkData->SetPos(remainingbytes, RIFF::stream_backward);
1131                        if (pCkData->RemainingBytes() < assumedsize) assumedsize = pCkData->RemainingBytes();
1132                        remainingbytes = pCkData->Read(pDecompressionBuffer->pStart, assumedsize, 1);
1133                        pSrc = (unsigned char*) pDecompressionBuffer->pStart;
1134                    }
1135                } // while
1136    
1137              this->SamplePos += (SampleCount - remainingsamples);              this->SamplePos += (SampleCount - remainingsamples);
1138              if (this->SamplePos > this->SamplesTotal) this->SamplePos = this->SamplesTotal;              if (this->SamplePos > this->SamplesTotal) this->SamplePos = this->SamplesTotal;
1139              return (SampleCount - remainingsamples);              return (SampleCount - remainingsamples);
1140          }          }
1141      }      }
1142    
1143        /** @brief Write sample wave data.
1144         *
1145         * Writes \a SampleCount number of sample points from the buffer pointed
1146         * by \a pBuffer and increments the position within the sample. Use this
1147         * method to directly write the sample data to disk, i.e. if you don't
1148         * want or cannot load the whole sample data into RAM.
1149         *
1150         * You have to Resize() the sample to the desired size and call
1151         * File::Save() <b>before</b> using Write().
1152         *
1153         * Note: there is currently no support for writing compressed samples.
1154         *
1155         * For 16 bit samples, the data in the source buffer should be
1156         * int16_t (using native endianness). For 24 bit, the buffer
1157         * should contain three bytes per sample, little-endian.
1158         *
1159         * @param pBuffer     - source buffer
1160         * @param SampleCount - number of sample points to write
1161         * @throws DLS::Exception if current sample size is too small
1162         * @throws gig::Exception if sample is compressed
1163         * @see DLS::LoadSampleData()
1164         */
1165        unsigned long Sample::Write(void* pBuffer, unsigned long SampleCount) {
1166            if (Compressed) throw gig::Exception("There is no support for writing compressed gig samples (yet)");
1167    
1168            // if this is the first write in this sample, reset the
1169            // checksum calculator
1170            if (pCkData->GetPos() == 0) {
1171                crc.reset();
1172            }
1173            if (GetSize() < SampleCount) throw Exception("Could not write sample data, current sample size to small");
1174            unsigned long res;
1175            if (BitDepth == 24) {
1176                res = pCkData->Write(pBuffer, SampleCount * FrameSize, 1) / FrameSize;
1177            } else { // 16 bit
1178                res = Channels == 2 ? pCkData->Write(pBuffer, SampleCount << 1, 2) >> 1
1179                                    : pCkData->Write(pBuffer, SampleCount, 2);
1180            }
1181            crc.update((unsigned char *)pBuffer, SampleCount * FrameSize);
1182    
1183            // if this is the last write, update the checksum chunk in the
1184            // file
1185            if (pCkData->GetPos() == pCkData->GetSize()) {
1186                File* pFile = static_cast<File*>(GetParent());
1187                pFile->SetSampleChecksum(this, crc.getValue());
1188            }
1189            return res;
1190        }
1191    
1192        /**
1193         * Allocates a decompression buffer for streaming (compressed) samples
1194         * with Sample::Read(). If you are using more than one streaming thread
1195         * in your application you <b>HAVE</b> to create a decompression buffer
1196         * for <b>EACH</b> of your streaming threads and provide it with the
1197         * Sample::Read() call in order to avoid race conditions and crashes.
1198         *
1199         * You should free the memory occupied by the allocated buffer(s) once
1200         * you don't need one of your streaming threads anymore by calling
1201         * DestroyDecompressionBuffer().
1202         *
1203         * @param MaxReadSize - the maximum size (in sample points) you ever
1204         *                      expect to read with one Read() call
1205         * @returns allocated decompression buffer
1206         * @see DestroyDecompressionBuffer()
1207         */
1208        buffer_t Sample::CreateDecompressionBuffer(unsigned long MaxReadSize) {
1209            buffer_t result;
1210            const double worstCaseHeaderOverhead =
1211                    (256.0 /*frame size*/ + 12.0 /*header*/ + 2.0 /*compression type flag (stereo)*/) / 256.0;
1212            result.Size              = (unsigned long) (double(MaxReadSize) * 3.0 /*(24 Bit)*/ * 2.0 /*stereo*/ * worstCaseHeaderOverhead);
1213            result.pStart            = new int8_t[result.Size];
1214            result.NullExtensionSize = 0;
1215            return result;
1216        }
1217    
1218        /**
1219         * Free decompression buffer, previously created with
1220         * CreateDecompressionBuffer().
1221         *
1222         * @param DecompressionBuffer - previously allocated decompression
1223         *                              buffer to free
1224         */
1225        void Sample::DestroyDecompressionBuffer(buffer_t& DecompressionBuffer) {
1226            if (DecompressionBuffer.Size && DecompressionBuffer.pStart) {
1227                delete[] (int8_t*) DecompressionBuffer.pStart;
1228                DecompressionBuffer.pStart = NULL;
1229                DecompressionBuffer.Size   = 0;
1230                DecompressionBuffer.NullExtensionSize = 0;
1231            }
1232        }
1233    
1234        /**
1235         * Returns pointer to the Group this Sample belongs to. In the .gig
1236         * format a sample always belongs to one group. If it wasn't explicitly
1237         * assigned to a certain group, it will be automatically assigned to a
1238         * default group.
1239         *
1240         * @returns Sample's Group (never NULL)
1241         */
1242        Group* Sample::GetGroup() const {
1243            return pGroup;
1244        }
1245    
1246      Sample::~Sample() {      Sample::~Sample() {
1247          Instances--;          Instances--;
1248          if (!Instances && pDecompressionBuffer) delete[] (int8_t*) pDecompressionBuffer;          if (!Instances && InternalDecompressionBuffer.Size) {
1249                delete[] (unsigned char*) InternalDecompressionBuffer.pStart;
1250                InternalDecompressionBuffer.pStart = NULL;
1251                InternalDecompressionBuffer.Size   = 0;
1252            }
1253          if (FrameTable) delete[] FrameTable;          if (FrameTable) delete[] FrameTable;
1254          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
1255      }      }
# Line 697  namespace gig { Line 1265  namespace gig {
1265      DimensionRegion::DimensionRegion(RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {      DimensionRegion::DimensionRegion(RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {
1266          Instances++;          Instances++;
1267    
1268          memcpy(&Crossfade, &SamplerOptions, 4);          pSample = NULL;
1269    
1270            if (_3ewl->GetSubChunk(CHUNK_ID_WSMP)) memcpy(&Crossfade, &SamplerOptions, 4);
1271            else memset(&Crossfade, 0, 4);
1272    
1273          if (!pVelocityTables) pVelocityTables = new VelocityTableMap;          if (!pVelocityTables) pVelocityTables = new VelocityTableMap;
1274    
1275          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);
1276          _3ewa->ReadInt32(); // unknown, always 0x0000008C ?          if (_3ewa) { // if '3ewa' chunk exists
1277          LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              _3ewa->ReadInt32(); // unknown, always == chunk size ?
1278          EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1279          _3ewa->ReadInt16(); // unknown              EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1280          LFO1InternalDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1281          _3ewa->ReadInt16(); // unknown              LFO1InternalDepth = _3ewa->ReadUint16();
1282          LFO3InternalDepth = _3ewa->ReadInt16();              _3ewa->ReadInt16(); // unknown
1283          _3ewa->ReadInt16(); // unknown              LFO3InternalDepth = _3ewa->ReadInt16();
1284          LFO1ControlDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1285          _3ewa->ReadInt16(); // unknown              LFO1ControlDepth = _3ewa->ReadUint16();
1286          LFO3ControlDepth = _3ewa->ReadInt16();              _3ewa->ReadInt16(); // unknown
1287          EG1Attack           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO3ControlDepth = _3ewa->ReadInt16();
1288          EG1Decay1           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG1Attack           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1289          _3ewa->ReadInt16(); // unknown              EG1Decay1           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1290          EG1Sustain          = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1291          EG1Release          = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG1Sustain          = _3ewa->ReadUint16();
1292          EG1Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));              EG1Release          = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1293          uint8_t eg1ctrloptions        = _3ewa->ReadUint8();              EG1Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1294          EG1ControllerInvert           = eg1ctrloptions & 0x01;              uint8_t eg1ctrloptions        = _3ewa->ReadUint8();
1295          EG1ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg1ctrloptions);              EG1ControllerInvert           = eg1ctrloptions & 0x01;
1296          EG1ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg1ctrloptions);              EG1ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg1ctrloptions);
1297          EG1ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg1ctrloptions);              EG1ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg1ctrloptions);
1298          EG2Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));              EG1ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg1ctrloptions);
1299          uint8_t eg2ctrloptions        = _3ewa->ReadUint8();              EG2Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1300          EG2ControllerInvert           = eg2ctrloptions & 0x01;              uint8_t eg2ctrloptions        = _3ewa->ReadUint8();
1301          EG2ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg2ctrloptions);              EG2ControllerInvert           = eg2ctrloptions & 0x01;
1302          EG2ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg2ctrloptions);              EG2ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg2ctrloptions);
1303          EG2ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg2ctrloptions);              EG2ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg2ctrloptions);
1304          LFO1Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG2ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg2ctrloptions);
1305          EG2Attack        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO1Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1306          EG2Decay1        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG2Attack        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1307          _3ewa->ReadInt16(); // unknown              EG2Decay1        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1308          EG2Sustain       = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1309          EG2Release       = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG2Sustain       = _3ewa->ReadUint16();
1310          _3ewa->ReadInt16(); // unknown              EG2Release       = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1311          LFO2ControlDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1312          LFO2Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO2ControlDepth = _3ewa->ReadUint16();
1313          _3ewa->ReadInt16(); // unknown              LFO2Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1314          LFO2InternalDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1315          int32_t eg1decay2 = _3ewa->ReadInt32();              LFO2InternalDepth = _3ewa->ReadUint16();
1316          EG1Decay2          = (double) GIG_EXP_DECODE(eg1decay2);              int32_t eg1decay2 = _3ewa->ReadInt32();
1317          EG1InfiniteSustain = (eg1decay2 == 0x7fffffff);              EG1Decay2          = (double) GIG_EXP_DECODE(eg1decay2);
1318          _3ewa->ReadInt16(); // unknown              EG1InfiniteSustain = (eg1decay2 == 0x7fffffff);
1319          EG1PreAttack      = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1320          int32_t eg2decay2 = _3ewa->ReadInt32();              EG1PreAttack      = _3ewa->ReadUint16();
1321          EG2Decay2         = (double) GIG_EXP_DECODE(eg2decay2);              int32_t eg2decay2 = _3ewa->ReadInt32();
1322          EG2InfiniteSustain = (eg2decay2 == 0x7fffffff);              EG2Decay2         = (double) GIG_EXP_DECODE(eg2decay2);
1323          _3ewa->ReadInt16(); // unknown              EG2InfiniteSustain = (eg2decay2 == 0x7fffffff);
1324          EG2PreAttack      = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1325          uint8_t velocityresponse = _3ewa->ReadUint8();              EG2PreAttack      = _3ewa->ReadUint16();
1326          if (velocityresponse < 5) {              uint8_t velocityresponse = _3ewa->ReadUint8();
1327              VelocityResponseCurve = curve_type_nonlinear;              if (velocityresponse < 5) {
1328              VelocityResponseDepth = velocityresponse;                  VelocityResponseCurve = curve_type_nonlinear;
1329          }                  VelocityResponseDepth = velocityresponse;
1330          else if (velocityresponse < 10) {              } else if (velocityresponse < 10) {
1331              VelocityResponseCurve = curve_type_linear;                  VelocityResponseCurve = curve_type_linear;
1332              VelocityResponseDepth = velocityresponse - 5;                  VelocityResponseDepth = velocityresponse - 5;
1333          }              } else if (velocityresponse < 15) {
1334          else if (velocityresponse < 15) {                  VelocityResponseCurve = curve_type_special;
1335              VelocityResponseCurve = curve_type_special;                  VelocityResponseDepth = velocityresponse - 10;
1336              VelocityResponseDepth = velocityresponse - 10;              } else {
1337                    VelocityResponseCurve = curve_type_unknown;
1338                    VelocityResponseDepth = 0;
1339                }
1340                uint8_t releasevelocityresponse = _3ewa->ReadUint8();
1341                if (releasevelocityresponse < 5) {
1342                    ReleaseVelocityResponseCurve = curve_type_nonlinear;
1343                    ReleaseVelocityResponseDepth = releasevelocityresponse;
1344                } else if (releasevelocityresponse < 10) {
1345                    ReleaseVelocityResponseCurve = curve_type_linear;
1346                    ReleaseVelocityResponseDepth = releasevelocityresponse - 5;
1347                } else if (releasevelocityresponse < 15) {
1348                    ReleaseVelocityResponseCurve = curve_type_special;
1349                    ReleaseVelocityResponseDepth = releasevelocityresponse - 10;
1350                } else {
1351                    ReleaseVelocityResponseCurve = curve_type_unknown;
1352                    ReleaseVelocityResponseDepth = 0;
1353                }
1354                VelocityResponseCurveScaling = _3ewa->ReadUint8();
1355                AttenuationControllerThreshold = _3ewa->ReadInt8();
1356                _3ewa->ReadInt32(); // unknown
1357                SampleStartOffset = (uint16_t) _3ewa->ReadInt16();
1358                _3ewa->ReadInt16(); // unknown
1359                uint8_t pitchTrackDimensionBypass = _3ewa->ReadInt8();
1360                PitchTrack = GIG_PITCH_TRACK_EXTRACT(pitchTrackDimensionBypass);
1361                if      (pitchTrackDimensionBypass & 0x10) DimensionBypass = dim_bypass_ctrl_94;
1362                else if (pitchTrackDimensionBypass & 0x20) DimensionBypass = dim_bypass_ctrl_95;
1363                else                                       DimensionBypass = dim_bypass_ctrl_none;
1364                uint8_t pan = _3ewa->ReadUint8();
1365                Pan         = (pan < 64) ? pan : -((int)pan - 63); // signed 7 bit -> signed 8 bit
1366                SelfMask = _3ewa->ReadInt8() & 0x01;
1367                _3ewa->ReadInt8(); // unknown
1368                uint8_t lfo3ctrl = _3ewa->ReadUint8();
1369                LFO3Controller           = static_cast<lfo3_ctrl_t>(lfo3ctrl & 0x07); // lower 3 bits
1370                LFO3Sync                 = lfo3ctrl & 0x20; // bit 5
1371                InvertAttenuationController = lfo3ctrl & 0x80; // bit 7
1372                AttenuationController  = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1373                uint8_t lfo2ctrl       = _3ewa->ReadUint8();
1374                LFO2Controller         = static_cast<lfo2_ctrl_t>(lfo2ctrl & 0x07); // lower 3 bits
1375                LFO2FlipPhase          = lfo2ctrl & 0x80; // bit 7
1376                LFO2Sync               = lfo2ctrl & 0x20; // bit 5
1377                bool extResonanceCtrl  = lfo2ctrl & 0x40; // bit 6
1378                uint8_t lfo1ctrl       = _3ewa->ReadUint8();
1379                LFO1Controller         = static_cast<lfo1_ctrl_t>(lfo1ctrl & 0x07); // lower 3 bits
1380                LFO1FlipPhase          = lfo1ctrl & 0x80; // bit 7
1381                LFO1Sync               = lfo1ctrl & 0x40; // bit 6
1382                VCFResonanceController = (extResonanceCtrl) ? static_cast<vcf_res_ctrl_t>(GIG_VCF_RESONANCE_CTRL_EXTRACT(lfo1ctrl))
1383                                                            : vcf_res_ctrl_none;
1384                uint16_t eg3depth = _3ewa->ReadUint16();
1385                EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */
1386                                            : (-1) * (int16_t) ((eg3depth ^ 0xffff) + 1); /* binary complementary for negatives */
1387                _3ewa->ReadInt16(); // unknown
1388                ChannelOffset = _3ewa->ReadUint8() / 4;
1389                uint8_t regoptions = _3ewa->ReadUint8();
1390                MSDecode           = regoptions & 0x01; // bit 0
1391                SustainDefeat      = regoptions & 0x02; // bit 1
1392                _3ewa->ReadInt16(); // unknown
1393                VelocityUpperLimit = _3ewa->ReadInt8();
1394                _3ewa->ReadInt8(); // unknown
1395                _3ewa->ReadInt16(); // unknown
1396                ReleaseTriggerDecay = _3ewa->ReadUint8(); // release trigger decay
1397                _3ewa->ReadInt8(); // unknown
1398                _3ewa->ReadInt8(); // unknown
1399                EG1Hold = _3ewa->ReadUint8() & 0x80; // bit 7
1400                uint8_t vcfcutoff = _3ewa->ReadUint8();
1401                VCFEnabled = vcfcutoff & 0x80; // bit 7
1402                VCFCutoff  = vcfcutoff & 0x7f; // lower 7 bits
1403                VCFCutoffController = static_cast<vcf_cutoff_ctrl_t>(_3ewa->ReadUint8());
1404                uint8_t vcfvelscale = _3ewa->ReadUint8();
1405                VCFCutoffControllerInvert = vcfvelscale & 0x80; // bit 7
1406                VCFVelocityScale = vcfvelscale & 0x7f; // lower 7 bits
1407                _3ewa->ReadInt8(); // unknown
1408                uint8_t vcfresonance = _3ewa->ReadUint8();
1409                VCFResonance = vcfresonance & 0x7f; // lower 7 bits
1410                VCFResonanceDynamic = !(vcfresonance & 0x80); // bit 7
1411                uint8_t vcfbreakpoint         = _3ewa->ReadUint8();
1412                VCFKeyboardTracking           = vcfbreakpoint & 0x80; // bit 7
1413                VCFKeyboardTrackingBreakpoint = vcfbreakpoint & 0x7f; // lower 7 bits
1414                uint8_t vcfvelocity = _3ewa->ReadUint8();
1415                VCFVelocityDynamicRange = vcfvelocity % 5;
1416                VCFVelocityCurve        = static_cast<curve_type_t>(vcfvelocity / 5);
1417                VCFType = static_cast<vcf_type_t>(_3ewa->ReadUint8());
1418                if (VCFType == vcf_type_lowpass) {
1419                    if (lfo3ctrl & 0x40) // bit 6
1420                        VCFType = vcf_type_lowpassturbo;
1421                }
1422                if (_3ewa->RemainingBytes() >= 8) {
1423                    _3ewa->Read(DimensionUpperLimits, 1, 8);
1424                } else {
1425                    memset(DimensionUpperLimits, 0, 8);
1426                }
1427            } else { // '3ewa' chunk does not exist yet
1428                // use default values
1429                LFO3Frequency                   = 1.0;
1430                EG3Attack                       = 0.0;
1431                LFO1InternalDepth               = 0;
1432                LFO3InternalDepth               = 0;
1433                LFO1ControlDepth                = 0;
1434                LFO3ControlDepth                = 0;
1435                EG1Attack                       = 0.0;
1436                EG1Decay1                       = 0.005;
1437                EG1Sustain                      = 1000;
1438                EG1Release                      = 0.3;
1439                EG1Controller.type              = eg1_ctrl_t::type_none;
1440                EG1Controller.controller_number = 0;
1441                EG1ControllerInvert             = false;
1442                EG1ControllerAttackInfluence    = 0;
1443                EG1ControllerDecayInfluence     = 0;
1444                EG1ControllerReleaseInfluence   = 0;
1445                EG2Controller.type              = eg2_ctrl_t::type_none;
1446                EG2Controller.controller_number = 0;
1447                EG2ControllerInvert             = false;
1448                EG2ControllerAttackInfluence    = 0;
1449                EG2ControllerDecayInfluence     = 0;
1450                EG2ControllerReleaseInfluence   = 0;
1451                LFO1Frequency                   = 1.0;
1452                EG2Attack                       = 0.0;
1453                EG2Decay1                       = 0.005;
1454                EG2Sustain                      = 1000;
1455                EG2Release                      = 0.3;
1456                LFO2ControlDepth                = 0;
1457                LFO2Frequency                   = 1.0;
1458                LFO2InternalDepth               = 0;
1459                EG1Decay2                       = 0.0;
1460                EG1InfiniteSustain              = true;
1461                EG1PreAttack                    = 0;
1462                EG2Decay2                       = 0.0;
1463                EG2InfiniteSustain              = true;
1464                EG2PreAttack                    = 0;
1465                VelocityResponseCurve           = curve_type_nonlinear;
1466                VelocityResponseDepth           = 3;
1467                ReleaseVelocityResponseCurve    = curve_type_nonlinear;
1468                ReleaseVelocityResponseDepth    = 3;
1469                VelocityResponseCurveScaling    = 32;
1470                AttenuationControllerThreshold  = 0;
1471                SampleStartOffset               = 0;
1472                PitchTrack                      = true;
1473                DimensionBypass                 = dim_bypass_ctrl_none;
1474                Pan                             = 0;
1475                SelfMask                        = true;
1476                LFO3Controller                  = lfo3_ctrl_modwheel;
1477                LFO3Sync                        = false;
1478                InvertAttenuationController     = false;
1479                AttenuationController.type      = attenuation_ctrl_t::type_none;
1480                AttenuationController.controller_number = 0;
1481                LFO2Controller                  = lfo2_ctrl_internal;
1482                LFO2FlipPhase                   = false;
1483                LFO2Sync                        = false;
1484                LFO1Controller                  = lfo1_ctrl_internal;
1485                LFO1FlipPhase                   = false;
1486                LFO1Sync                        = false;
1487                VCFResonanceController          = vcf_res_ctrl_none;
1488                EG3Depth                        = 0;
1489                ChannelOffset                   = 0;
1490                MSDecode                        = false;
1491                SustainDefeat                   = false;
1492                VelocityUpperLimit              = 0;
1493                ReleaseTriggerDecay             = 0;
1494                EG1Hold                         = false;
1495                VCFEnabled                      = false;
1496                VCFCutoff                       = 0;
1497                VCFCutoffController             = vcf_cutoff_ctrl_none;
1498                VCFCutoffControllerInvert       = false;
1499                VCFVelocityScale                = 0;
1500                VCFResonance                    = 0;
1501                VCFResonanceDynamic             = false;
1502                VCFKeyboardTracking             = false;
1503                VCFKeyboardTrackingBreakpoint   = 0;
1504                VCFVelocityDynamicRange         = 0x04;
1505                VCFVelocityCurve                = curve_type_linear;
1506                VCFType                         = vcf_type_lowpass;
1507                memset(DimensionUpperLimits, 127, 8);
1508            }
1509    
1510            pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,
1511                                                         VelocityResponseDepth,
1512                                                         VelocityResponseCurveScaling);
1513    
1514            curve_type_t curveType = ReleaseVelocityResponseCurve;
1515            uint8_t depth = ReleaseVelocityResponseDepth;
1516    
1517            // this models a strange behaviour or bug in GSt: two of the
1518            // velocity response curves for release time are not used even
1519            // if specified, instead another curve is chosen.
1520            if ((curveType == curve_type_nonlinear && depth == 0) ||
1521                (curveType == curve_type_special   && depth == 4)) {
1522                curveType = curve_type_nonlinear;
1523                depth = 3;
1524            }
1525            pVelocityReleaseTable = GetVelocityTable(curveType, depth, 0);
1526    
1527            curveType = VCFVelocityCurve;
1528            depth = VCFVelocityDynamicRange;
1529    
1530            // even stranger GSt: two of the velocity response curves for
1531            // filter cutoff are not used, instead another special curve
1532            // is chosen. This curve is not used anywhere else.
1533            if ((curveType == curve_type_nonlinear && depth == 0) ||
1534                (curveType == curve_type_special   && depth == 4)) {
1535                curveType = curve_type_special;
1536                depth = 5;
1537          }          }
1538          else {          pVelocityCutoffTable = GetVelocityTable(curveType, depth,
1539              VelocityResponseCurve = curve_type_unknown;                                                  VCFCutoffController <= vcf_cutoff_ctrl_none2 ? VCFVelocityScale : 0);
1540              VelocityResponseDepth = 0;  
1541            SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));
1542            VelocityTable = 0;
1543        }
1544    
1545        /**
1546         * Apply dimension region settings to the respective RIFF chunks. You
1547         * have to call File::Save() to make changes persistent.
1548         *
1549         * Usually there is absolutely no need to call this method explicitly.
1550         * It will be called automatically when File::Save() was called.
1551         */
1552        void DimensionRegion::UpdateChunks() {
1553            // check if wsmp is going to be created by
1554            // DLS::Sampler::UpdateChunks
1555            bool wsmp_created = !pParentList->GetSubChunk(CHUNK_ID_WSMP);
1556    
1557            // first update base class's chunk
1558            DLS::Sampler::UpdateChunks();
1559    
1560            RIFF::Chunk* wsmp = pParentList->GetSubChunk(CHUNK_ID_WSMP);
1561            uint8_t* pData = (uint8_t*) wsmp->LoadChunkData();
1562            pData[12] = Crossfade.in_start;
1563            pData[13] = Crossfade.in_end;
1564            pData[14] = Crossfade.out_start;
1565            pData[15] = Crossfade.out_end;
1566    
1567            // make sure '3ewa' chunk exists
1568            RIFF::Chunk* _3ewa = pParentList->GetSubChunk(CHUNK_ID_3EWA);
1569            if (!_3ewa)  _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, 140);
1570            else if (wsmp_created) {
1571                // make sure the chunk order is: wsmp, 3ewa
1572                pParentList->MoveSubChunk(_3ewa, 0);
1573          }          }
1574          uint8_t releasevelocityresponse = _3ewa->ReadUint8();          pData = (uint8_t*) _3ewa->LoadChunkData();
1575          if (releasevelocityresponse < 5) {  
1576              ReleaseVelocityResponseCurve = curve_type_nonlinear;          // update '3ewa' chunk with DimensionRegion's current settings
1577              ReleaseVelocityResponseDepth = releasevelocityresponse;  
1578          }          const uint32_t chunksize = _3ewa->GetNewSize();
1579          else if (releasevelocityresponse < 10) {          store32(&pData[0], chunksize); // unknown, always chunk size?
1580              ReleaseVelocityResponseCurve = curve_type_linear;  
1581              ReleaseVelocityResponseDepth = releasevelocityresponse - 5;          const int32_t lfo3freq = (int32_t) GIG_EXP_ENCODE(LFO3Frequency);
1582          }          store32(&pData[4], lfo3freq);
1583          else if (releasevelocityresponse < 15) {  
1584              ReleaseVelocityResponseCurve = curve_type_special;          const int32_t eg3attack = (int32_t) GIG_EXP_ENCODE(EG3Attack);
1585              ReleaseVelocityResponseDepth = releasevelocityresponse - 10;          store32(&pData[8], eg3attack);
1586    
1587            // next 2 bytes unknown
1588    
1589            store16(&pData[14], LFO1InternalDepth);
1590    
1591            // next 2 bytes unknown
1592    
1593            store16(&pData[18], LFO3InternalDepth);
1594    
1595            // next 2 bytes unknown
1596    
1597            store16(&pData[22], LFO1ControlDepth);
1598    
1599            // next 2 bytes unknown
1600    
1601            store16(&pData[26], LFO3ControlDepth);
1602    
1603            const int32_t eg1attack = (int32_t) GIG_EXP_ENCODE(EG1Attack);
1604            store32(&pData[28], eg1attack);
1605    
1606            const int32_t eg1decay1 = (int32_t) GIG_EXP_ENCODE(EG1Decay1);
1607            store32(&pData[32], eg1decay1);
1608    
1609            // next 2 bytes unknown
1610    
1611            store16(&pData[38], EG1Sustain);
1612    
1613            const int32_t eg1release = (int32_t) GIG_EXP_ENCODE(EG1Release);
1614            store32(&pData[40], eg1release);
1615    
1616            const uint8_t eg1ctl = (uint8_t) EncodeLeverageController(EG1Controller);
1617            pData[44] = eg1ctl;
1618    
1619            const uint8_t eg1ctrloptions =
1620                (EG1ControllerInvert ? 0x01 : 0x00) |
1621                GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG1ControllerAttackInfluence) |
1622                GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG1ControllerDecayInfluence) |
1623                GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG1ControllerReleaseInfluence);
1624            pData[45] = eg1ctrloptions;
1625    
1626            const uint8_t eg2ctl = (uint8_t) EncodeLeverageController(EG2Controller);
1627            pData[46] = eg2ctl;
1628    
1629            const uint8_t eg2ctrloptions =
1630                (EG2ControllerInvert ? 0x01 : 0x00) |
1631                GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG2ControllerAttackInfluence) |
1632                GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG2ControllerDecayInfluence) |
1633                GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG2ControllerReleaseInfluence);
1634            pData[47] = eg2ctrloptions;
1635    
1636            const int32_t lfo1freq = (int32_t) GIG_EXP_ENCODE(LFO1Frequency);
1637            store32(&pData[48], lfo1freq);
1638    
1639            const int32_t eg2attack = (int32_t) GIG_EXP_ENCODE(EG2Attack);
1640            store32(&pData[52], eg2attack);
1641    
1642            const int32_t eg2decay1 = (int32_t) GIG_EXP_ENCODE(EG2Decay1);
1643            store32(&pData[56], eg2decay1);
1644    
1645            // next 2 bytes unknown
1646    
1647            store16(&pData[62], EG2Sustain);
1648    
1649            const int32_t eg2release = (int32_t) GIG_EXP_ENCODE(EG2Release);
1650            store32(&pData[64], eg2release);
1651    
1652            // next 2 bytes unknown
1653    
1654            store16(&pData[70], LFO2ControlDepth);
1655    
1656            const int32_t lfo2freq = (int32_t) GIG_EXP_ENCODE(LFO2Frequency);
1657            store32(&pData[72], lfo2freq);
1658    
1659            // next 2 bytes unknown
1660    
1661            store16(&pData[78], LFO2InternalDepth);
1662    
1663            const int32_t eg1decay2 = (int32_t) (EG1InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG1Decay2);
1664            store32(&pData[80], eg1decay2);
1665    
1666            // next 2 bytes unknown
1667    
1668            store16(&pData[86], EG1PreAttack);
1669    
1670            const int32_t eg2decay2 = (int32_t) (EG2InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG2Decay2);
1671            store32(&pData[88], eg2decay2);
1672    
1673            // next 2 bytes unknown
1674    
1675            store16(&pData[94], EG2PreAttack);
1676    
1677            {
1678                if (VelocityResponseDepth > 4) throw Exception("VelocityResponseDepth must be between 0 and 4");
1679                uint8_t velocityresponse = VelocityResponseDepth;
1680                switch (VelocityResponseCurve) {
1681                    case curve_type_nonlinear:
1682                        break;
1683                    case curve_type_linear:
1684                        velocityresponse += 5;
1685                        break;
1686                    case curve_type_special:
1687                        velocityresponse += 10;
1688                        break;
1689                    case curve_type_unknown:
1690                    default:
1691                        throw Exception("Could not update DimensionRegion's chunk, unknown VelocityResponseCurve selected");
1692                }
1693                pData[96] = velocityresponse;
1694          }          }
1695          else {  
1696              ReleaseVelocityResponseCurve = curve_type_unknown;          {
1697              ReleaseVelocityResponseDepth = 0;              if (ReleaseVelocityResponseDepth > 4) throw Exception("ReleaseVelocityResponseDepth must be between 0 and 4");
1698                uint8_t releasevelocityresponse = ReleaseVelocityResponseDepth;
1699                switch (ReleaseVelocityResponseCurve) {
1700                    case curve_type_nonlinear:
1701                        break;
1702                    case curve_type_linear:
1703                        releasevelocityresponse += 5;
1704                        break;
1705                    case curve_type_special:
1706                        releasevelocityresponse += 10;
1707                        break;
1708                    case curve_type_unknown:
1709                    default:
1710                        throw Exception("Could not update DimensionRegion's chunk, unknown ReleaseVelocityResponseCurve selected");
1711                }
1712                pData[97] = releasevelocityresponse;
1713            }
1714    
1715            pData[98] = VelocityResponseCurveScaling;
1716    
1717            pData[99] = AttenuationControllerThreshold;
1718    
1719            // next 4 bytes unknown
1720    
1721            store16(&pData[104], SampleStartOffset);
1722    
1723            // next 2 bytes unknown
1724    
1725            {
1726                uint8_t pitchTrackDimensionBypass = GIG_PITCH_TRACK_ENCODE(PitchTrack);
1727                switch (DimensionBypass) {
1728                    case dim_bypass_ctrl_94:
1729                        pitchTrackDimensionBypass |= 0x10;
1730                        break;
1731                    case dim_bypass_ctrl_95:
1732                        pitchTrackDimensionBypass |= 0x20;
1733                        break;
1734                    case dim_bypass_ctrl_none:
1735                        //FIXME: should we set anything here?
1736                        break;
1737                    default:
1738                        throw Exception("Could not update DimensionRegion's chunk, unknown DimensionBypass selected");
1739                }
1740                pData[108] = pitchTrackDimensionBypass;
1741            }
1742    
1743            const uint8_t pan = (Pan >= 0) ? Pan : ((-Pan) + 63); // signed 8 bit -> signed 7 bit
1744            pData[109] = pan;
1745    
1746            const uint8_t selfmask = (SelfMask) ? 0x01 : 0x00;
1747            pData[110] = selfmask;
1748    
1749            // next byte unknown
1750    
1751            {
1752                uint8_t lfo3ctrl = LFO3Controller & 0x07; // lower 3 bits
1753                if (LFO3Sync) lfo3ctrl |= 0x20; // bit 5
1754                if (InvertAttenuationController) lfo3ctrl |= 0x80; // bit 7
1755                if (VCFType == vcf_type_lowpassturbo) lfo3ctrl |= 0x40; // bit 6
1756                pData[112] = lfo3ctrl;
1757            }
1758    
1759            const uint8_t attenctl = EncodeLeverageController(AttenuationController);
1760            pData[113] = attenctl;
1761    
1762            {
1763                uint8_t lfo2ctrl = LFO2Controller & 0x07; // lower 3 bits
1764                if (LFO2FlipPhase) lfo2ctrl |= 0x80; // bit 7
1765                if (LFO2Sync)      lfo2ctrl |= 0x20; // bit 5
1766                if (VCFResonanceController != vcf_res_ctrl_none) lfo2ctrl |= 0x40; // bit 6
1767                pData[114] = lfo2ctrl;
1768          }          }
1769          VelocityResponseCurveScaling = _3ewa->ReadUint8();  
1770          AttenuationControllerThreshold = _3ewa->ReadInt8();          {
1771          _3ewa->ReadInt32(); // unknown              uint8_t lfo1ctrl = LFO1Controller & 0x07; // lower 3 bits
1772          SampleStartOffset = (uint16_t) _3ewa->ReadInt16();              if (LFO1FlipPhase) lfo1ctrl |= 0x80; // bit 7
1773          _3ewa->ReadInt16(); // unknown              if (LFO1Sync)      lfo1ctrl |= 0x40; // bit 6
1774          uint8_t pitchTrackDimensionBypass = _3ewa->ReadInt8();              if (VCFResonanceController != vcf_res_ctrl_none)
1775          PitchTrack = GIG_PITCH_TRACK_EXTRACT(pitchTrackDimensionBypass);                  lfo1ctrl |= GIG_VCF_RESONANCE_CTRL_ENCODE(VCFResonanceController);
1776          if      (pitchTrackDimensionBypass & 0x10) DimensionBypass = dim_bypass_ctrl_94;              pData[115] = lfo1ctrl;
1777          else if (pitchTrackDimensionBypass & 0x20) DimensionBypass = dim_bypass_ctrl_95;          }
1778          else                                       DimensionBypass = dim_bypass_ctrl_none;  
1779          uint8_t pan = _3ewa->ReadUint8();          const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth
1780          Pan         = (pan < 64) ? pan : -((int)pan - 63); // signed 7 bit -> signed 8 bit                                                    : uint16_t(((-EG3Depth) - 1) ^ 0xffff); /* binary complementary for negatives */
1781          SelfMask = _3ewa->ReadInt8() & 0x01;          pData[116] = eg3depth;
1782          _3ewa->ReadInt8(); // unknown  
1783          uint8_t lfo3ctrl = _3ewa->ReadUint8();          // next 2 bytes unknown
1784          LFO3Controller           = static_cast<lfo3_ctrl_t>(lfo3ctrl & 0x07); // lower 3 bits  
1785          LFO3Sync                 = lfo3ctrl & 0x20; // bit 5          const uint8_t channeloffset = ChannelOffset * 4;
1786          InvertAttenuationController = lfo3ctrl & 0x80; // bit 7          pData[120] = channeloffset;
1787          AttenuationController  = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));  
1788          uint8_t lfo2ctrl       = _3ewa->ReadUint8();          {
1789          LFO2Controller         = static_cast<lfo2_ctrl_t>(lfo2ctrl & 0x07); // lower 3 bits              uint8_t regoptions = 0;
1790          LFO2FlipPhase          = lfo2ctrl & 0x80; // bit 7              if (MSDecode)      regoptions |= 0x01; // bit 0
1791          LFO2Sync               = lfo2ctrl & 0x20; // bit 5              if (SustainDefeat) regoptions |= 0x02; // bit 1
1792          bool extResonanceCtrl  = lfo2ctrl & 0x40; // bit 6              pData[121] = regoptions;
1793          uint8_t lfo1ctrl       = _3ewa->ReadUint8();          }
1794          LFO1Controller         = static_cast<lfo1_ctrl_t>(lfo1ctrl & 0x07); // lower 3 bits  
1795          LFO1FlipPhase          = lfo1ctrl & 0x80; // bit 7          // next 2 bytes unknown
1796          LFO1Sync               = lfo1ctrl & 0x40; // bit 6  
1797          VCFResonanceController = (extResonanceCtrl) ? static_cast<vcf_res_ctrl_t>(GIG_VCF_RESONANCE_CTRL_EXTRACT(lfo1ctrl))          pData[124] = VelocityUpperLimit;
1798                                                      : vcf_res_ctrl_none;  
1799          uint16_t eg3depth = _3ewa->ReadUint16();          // next 3 bytes unknown
1800          EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */  
1801                                        : (-1) * (int16_t) ((eg3depth ^ 0xffff) + 1); /* binary complementary for negatives */          pData[128] = ReleaseTriggerDecay;
1802          _3ewa->ReadInt16(); // unknown  
1803          ChannelOffset = _3ewa->ReadUint8() / 4;          // next 2 bytes unknown
1804          uint8_t regoptions = _3ewa->ReadUint8();  
1805          MSDecode           = regoptions & 0x01; // bit 0          const uint8_t eg1hold = (EG1Hold) ? 0x80 : 0x00; // bit 7
1806          SustainDefeat      = regoptions & 0x02; // bit 1          pData[131] = eg1hold;
1807          _3ewa->ReadInt16(); // unknown  
1808          VelocityUpperLimit = _3ewa->ReadInt8();          const uint8_t vcfcutoff = (VCFEnabled ? 0x80 : 0x00) |  /* bit 7 */
1809          _3ewa->ReadInt8(); // unknown                                    (VCFCutoff & 0x7f);   /* lower 7 bits */
1810          _3ewa->ReadInt16(); // unknown          pData[132] = vcfcutoff;
1811          ReleaseTriggerDecay = _3ewa->ReadUint8(); // release trigger decay  
1812          _3ewa->ReadInt8(); // unknown          pData[133] = VCFCutoffController;
1813          _3ewa->ReadInt8(); // unknown  
1814          EG1Hold = _3ewa->ReadUint8() & 0x80; // bit 7          const uint8_t vcfvelscale = (VCFCutoffControllerInvert ? 0x80 : 0x00) | /* bit 7 */
1815          uint8_t vcfcutoff = _3ewa->ReadUint8();                                      (VCFVelocityScale & 0x7f); /* lower 7 bits */
1816          VCFEnabled = vcfcutoff & 0x80; // bit 7          pData[134] = vcfvelscale;
1817          VCFCutoff  = vcfcutoff & 0x7f; // lower 7 bits  
1818          VCFCutoffController = static_cast<vcf_cutoff_ctrl_t>(_3ewa->ReadUint8());          // next byte unknown
1819          VCFVelocityScale = _3ewa->ReadUint8();  
1820          _3ewa->ReadInt8(); // unknown          const uint8_t vcfresonance = (VCFResonanceDynamic ? 0x00 : 0x80) | /* bit 7 */
1821          uint8_t vcfresonance = _3ewa->ReadUint8();                                       (VCFResonance & 0x7f); /* lower 7 bits */
1822          VCFResonance = vcfresonance & 0x7f; // lower 7 bits          pData[136] = vcfresonance;
1823          VCFResonanceDynamic = !(vcfresonance & 0x80); // bit 7  
1824          uint8_t vcfbreakpoint         = _3ewa->ReadUint8();          const uint8_t vcfbreakpoint = (VCFKeyboardTracking ? 0x80 : 0x00) | /* bit 7 */
1825          VCFKeyboardTracking           = vcfbreakpoint & 0x80; // bit 7                                        (VCFKeyboardTrackingBreakpoint & 0x7f); /* lower 7 bits */
1826          VCFKeyboardTrackingBreakpoint = vcfbreakpoint & 0x7f; // lower 7 bits          pData[137] = vcfbreakpoint;
1827          uint8_t vcfvelocity = _3ewa->ReadUint8();  
1828          VCFVelocityDynamicRange = vcfvelocity % 5;          const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 |
1829          VCFVelocityCurve        = static_cast<curve_type_t>(vcfvelocity / 5);                                      VCFVelocityCurve * 5;
1830          VCFType = static_cast<vcf_type_t>(_3ewa->ReadUint8());          pData[138] = vcfvelocity;
1831          if (VCFType == vcf_type_lowpass) {  
1832              if (lfo3ctrl & 0x40) // bit 6          const uint8_t vcftype = (VCFType == vcf_type_lowpassturbo) ? vcf_type_lowpass : VCFType;
1833                  VCFType = vcf_type_lowpassturbo;          pData[139] = vcftype;
1834    
1835            if (chunksize >= 148) {
1836                memcpy(&pData[140], DimensionUpperLimits, 8);
1837          }          }
1838        }
1839    
1840          // get the corresponding velocity->volume table from the table map or create & calculate that table if it doesn't exist yet      // get the corresponding velocity table from the table map or create & calculate that table if it doesn't exist yet
1841          uint32_t tableKey = (VelocityResponseCurve<<16) | (VelocityResponseDepth<<8) | VelocityResponseCurveScaling;      double* DimensionRegion::GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling)
1842        {
1843            double* table;
1844            uint32_t tableKey = (curveType<<16) | (depth<<8) | scaling;
1845          if (pVelocityTables->count(tableKey)) { // if key exists          if (pVelocityTables->count(tableKey)) { // if key exists
1846              pVelocityAttenuationTable = (*pVelocityTables)[tableKey];              table = (*pVelocityTables)[tableKey];
1847          }          }
1848          else {          else {
1849              pVelocityAttenuationTable =              table = CreateVelocityTable(curveType, depth, scaling);
1850                  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  
1851          }          }
1852            return table;
1853      }      }
1854    
1855      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {
# Line 983  namespace gig { Line 1970  namespace gig {
1970          return decodedcontroller;          return decodedcontroller;
1971      }      }
1972    
1973        DimensionRegion::_lev_ctrl_t DimensionRegion::EncodeLeverageController(leverage_ctrl_t DecodedController) {
1974            _lev_ctrl_t encodedcontroller;
1975            switch (DecodedController.type) {
1976                // special controller
1977                case leverage_ctrl_t::type_none:
1978                    encodedcontroller = _lev_ctrl_none;
1979                    break;
1980                case leverage_ctrl_t::type_velocity:
1981                    encodedcontroller = _lev_ctrl_velocity;
1982                    break;
1983                case leverage_ctrl_t::type_channelaftertouch:
1984                    encodedcontroller = _lev_ctrl_channelaftertouch;
1985                    break;
1986    
1987                // ordinary MIDI control change controller
1988                case leverage_ctrl_t::type_controlchange:
1989                    switch (DecodedController.controller_number) {
1990                        case 1:
1991                            encodedcontroller = _lev_ctrl_modwheel;
1992                            break;
1993                        case 2:
1994                            encodedcontroller = _lev_ctrl_breath;
1995                            break;
1996                        case 4:
1997                            encodedcontroller = _lev_ctrl_foot;
1998                            break;
1999                        case 12:
2000                            encodedcontroller = _lev_ctrl_effect1;
2001                            break;
2002                        case 13:
2003                            encodedcontroller = _lev_ctrl_effect2;
2004                            break;
2005                        case 16:
2006                            encodedcontroller = _lev_ctrl_genpurpose1;
2007                            break;
2008                        case 17:
2009                            encodedcontroller = _lev_ctrl_genpurpose2;
2010                            break;
2011                        case 18:
2012                            encodedcontroller = _lev_ctrl_genpurpose3;
2013                            break;
2014                        case 19:
2015                            encodedcontroller = _lev_ctrl_genpurpose4;
2016                            break;
2017                        case 5:
2018                            encodedcontroller = _lev_ctrl_portamentotime;
2019                            break;
2020                        case 64:
2021                            encodedcontroller = _lev_ctrl_sustainpedal;
2022                            break;
2023                        case 65:
2024                            encodedcontroller = _lev_ctrl_portamento;
2025                            break;
2026                        case 66:
2027                            encodedcontroller = _lev_ctrl_sostenutopedal;
2028                            break;
2029                        case 67:
2030                            encodedcontroller = _lev_ctrl_softpedal;
2031                            break;
2032                        case 80:
2033                            encodedcontroller = _lev_ctrl_genpurpose5;
2034                            break;
2035                        case 81:
2036                            encodedcontroller = _lev_ctrl_genpurpose6;
2037                            break;
2038                        case 82:
2039                            encodedcontroller = _lev_ctrl_genpurpose7;
2040                            break;
2041                        case 83:
2042                            encodedcontroller = _lev_ctrl_genpurpose8;
2043                            break;
2044                        case 91:
2045                            encodedcontroller = _lev_ctrl_effect1depth;
2046                            break;
2047                        case 92:
2048                            encodedcontroller = _lev_ctrl_effect2depth;
2049                            break;
2050                        case 93:
2051                            encodedcontroller = _lev_ctrl_effect3depth;
2052                            break;
2053                        case 94:
2054                            encodedcontroller = _lev_ctrl_effect4depth;
2055                            break;
2056                        case 95:
2057                            encodedcontroller = _lev_ctrl_effect5depth;
2058                            break;
2059                        default:
2060                            throw gig::Exception("leverage controller number is not supported by the gig format");
2061                    }
2062                    break;
2063                default:
2064                    throw gig::Exception("Unknown leverage controller type.");
2065            }
2066            return encodedcontroller;
2067        }
2068    
2069      DimensionRegion::~DimensionRegion() {      DimensionRegion::~DimensionRegion() {
2070          Instances--;          Instances--;
2071          if (!Instances) {          if (!Instances) {
# Line 996  namespace gig { Line 2079  namespace gig {
2079              delete pVelocityTables;              delete pVelocityTables;
2080              pVelocityTables = NULL;              pVelocityTables = NULL;
2081          }          }
2082            if (VelocityTable) delete[] VelocityTable;
2083      }      }
2084    
2085      /**      /**
# Line 1013  namespace gig { Line 2097  namespace gig {
2097          return pVelocityAttenuationTable[MIDIKeyVelocity];          return pVelocityAttenuationTable[MIDIKeyVelocity];
2098      }      }
2099    
2100        double DimensionRegion::GetVelocityRelease(uint8_t MIDIKeyVelocity) {
2101            return pVelocityReleaseTable[MIDIKeyVelocity];
2102        }
2103    
2104        double DimensionRegion::GetVelocityCutoff(uint8_t MIDIKeyVelocity) {
2105            return pVelocityCutoffTable[MIDIKeyVelocity];
2106        }
2107    
2108      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) {
2109    
2110          // line-segment approximations of the 15 velocity curves          // line-segment approximations of the 15 velocity curves
# Line 1046  namespace gig { Line 2138  namespace gig {
2138          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,
2139                               127, 127 };                               127, 127 };
2140    
2141            // this is only used by the VCF velocity curve
2142            const int spe5[] = { 1, 2, 30, 5, 60, 19, 77, 70, 83, 85, 88, 106,
2143                                 91, 127, 127, 127 };
2144    
2145          const int* const curves[] = { non0, non1, non2, non3, non4,          const int* const curves[] = { non0, non1, non2, non3, non4,
2146                                        lin0, lin1, lin2, lin3, lin4,                                        lin0, lin1, lin2, lin3, lin4,
2147                                        spe0, spe1, spe2, spe3, spe4 };                                        spe0, spe1, spe2, spe3, spe4, spe5 };
2148    
2149          double* const table = new double[128];          double* const table = new double[128];
2150    
# Line 1100  namespace gig { Line 2196  namespace gig {
2196              for (int i = 0; i < dimensionBits; i++) {              for (int i = 0; i < dimensionBits; i++) {
2197                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());
2198                  uint8_t     bits      = _3lnk->ReadUint8();                  uint8_t     bits      = _3lnk->ReadUint8();
2199                    _3lnk->ReadUint8(); // bit position of the dimension (bits[0] + bits[1] + ... + bits[i-1])
2200                    _3lnk->ReadUint8(); // (1 << bit position of next dimension) - (1 << bit position of this dimension)
2201                    uint8_t     zones     = _3lnk->ReadUint8(); // new for v3: number of zones doesn't have to be == pow(2,bits)
2202                  if (dimension == dimension_none) { // inactive dimension                  if (dimension == dimension_none) { // inactive dimension
2203                      pDimensionDefinitions[i].dimension  = dimension_none;                      pDimensionDefinitions[i].dimension  = dimension_none;
2204                      pDimensionDefinitions[i].bits       = 0;                      pDimensionDefinitions[i].bits       = 0;
2205                      pDimensionDefinitions[i].zones      = 0;                      pDimensionDefinitions[i].zones      = 0;
2206                      pDimensionDefinitions[i].split_type = split_type_bit;                      pDimensionDefinitions[i].split_type = split_type_bit;
                     pDimensionDefinitions[i].ranges     = NULL;  
2207                      pDimensionDefinitions[i].zone_size  = 0;                      pDimensionDefinitions[i].zone_size  = 0;
2208                  }                  }
2209                  else { // active dimension                  else { // active dimension
2210                      pDimensionDefinitions[i].dimension = dimension;                      pDimensionDefinitions[i].dimension = dimension;
2211                      pDimensionDefinitions[i].bits      = bits;                      pDimensionDefinitions[i].bits      = bits;
2212                      pDimensionDefinitions[i].zones     = 0x01 << bits; // = pow(2,bits)                      pDimensionDefinitions[i].zones     = zones ? zones : 0x01 << bits; // = pow(2,bits)
2213                      pDimensionDefinitions[i].split_type = (dimension == dimension_layer ||                      pDimensionDefinitions[i].split_type = __resolveSplitType(dimension);
2214                                                             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;  
2215                      Dimensions++;                      Dimensions++;
2216    
2217                      // if this is a layer dimension, remember the amount of layers                      // if this is a layer dimension, remember the amount of layers
2218                      if (dimension == dimension_layer) Layers = pDimensionDefinitions[i].zones;                      if (dimension == dimension_layer) Layers = pDimensionDefinitions[i].zones;
2219                  }                  }
2220                  _3lnk->SetPos(6, RIFF::stream_curpos); // jump forward to next dimension definition                  _3lnk->SetPos(3, RIFF::stream_curpos); // jump forward to next dimension definition
2221              }              }
2222                for (int i = dimensionBits ; i < 8 ; i++) pDimensionDefinitions[i].bits = 0;
2223    
2224              // 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,
2225              for (uint i = 0; i < Dimensions; i++) {              // update the VelocityTables in the dimension regions
2226                  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;  
                             }  
                         }  
                     }  
                 }  
             }  
2227    
2228              // 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();  
2229              if (file->pVersion && file->pVersion->major == 3)              if (file->pVersion && file->pVersion->major == 3)
2230                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure
2231              else              else
# Line 1168  namespace gig { Line 2234  namespace gig {
2234              // load sample references              // load sample references
2235              for (uint i = 0; i < DimensionRegions; i++) {              for (uint i = 0; i < DimensionRegions; i++) {
2236                  uint32_t wavepoolindex = _3lnk->ReadUint32();                  uint32_t wavepoolindex = _3lnk->ReadUint32();
2237                  pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);                  if (file->pWavePoolTable) pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);
2238                }
2239                GetSample(); // load global region sample reference
2240            } else {
2241                DimensionRegions = 0;
2242                for (int i = 0 ; i < 8 ; i++) {
2243                    pDimensionDefinitions[i].dimension  = dimension_none;
2244                    pDimensionDefinitions[i].bits       = 0;
2245                    pDimensionDefinitions[i].zones      = 0;
2246              }              }
2247          }          }
2248          else throw gig::Exception("Mandatory <3lnk> chunk not found.");  
2249            // make sure there is at least one dimension region
2250            if (!DimensionRegions) {
2251                RIFF::List* _3prg = rgnList->GetSubList(LIST_TYPE_3PRG);
2252                if (!_3prg) _3prg = rgnList->AddSubList(LIST_TYPE_3PRG);
2253                RIFF::List* _3ewl = _3prg->AddSubList(LIST_TYPE_3EWL);
2254                pDimensionRegions[0] = new DimensionRegion(_3ewl);
2255                DimensionRegions = 1;
2256            }
2257        }
2258    
2259        /**
2260         * Apply Region settings and all its DimensionRegions to the respective
2261         * RIFF chunks. You have to call File::Save() to make changes persistent.
2262         *
2263         * Usually there is absolutely no need to call this method explicitly.
2264         * It will be called automatically when File::Save() was called.
2265         *
2266         * @throws gig::Exception if samples cannot be dereferenced
2267         */
2268        void Region::UpdateChunks() {
2269            // in the gig format we don't care about the Region's sample reference
2270            // but we still have to provide some existing one to not corrupt the
2271            // file, so to avoid the latter we simply always assign the sample of
2272            // the first dimension region of this region
2273            pSample = pDimensionRegions[0]->pSample;
2274    
2275            // first update base class's chunks
2276            DLS::Region::UpdateChunks();
2277    
2278            File* pFile = (File*) GetParent()->GetParent();
2279            bool version3 = pFile->pVersion && pFile->pVersion->major == 3;
2280    
2281            // update dimension region's chunks
2282            for (int i = 0; i < DimensionRegions; i++) {
2283                DimensionRegion* d = pDimensionRegions[i];
2284    
2285                // make sure '3ewa' chunk exists (we need to this before
2286                // calling DimensionRegion::UpdateChunks, as
2287                // DimensionRegion doesn't know which file version it is)
2288                RIFF::Chunk* _3ewa = d->pParentList->GetSubChunk(CHUNK_ID_3EWA);
2289                if (!_3ewa) d->pParentList->AddSubChunk(CHUNK_ID_3EWA, version3 ? 148 : 140);
2290    
2291                d->UpdateChunks();
2292            }
2293    
2294            const int iMaxDimensions =  version3 ? 8 : 5;
2295            const int iMaxDimensionRegions = version3 ? 256 : 32;
2296    
2297            // make sure '3lnk' chunk exists
2298            RIFF::Chunk* _3lnk = pCkRegion->GetSubChunk(CHUNK_ID_3LNK);
2299            if (!_3lnk) {
2300                const int _3lnkChunkSize = version3 ? 1092 : 172;
2301                _3lnk = pCkRegion->AddSubChunk(CHUNK_ID_3LNK, _3lnkChunkSize);
2302                memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);
2303    
2304                // move 3prg to last position
2305                pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3PRG), 0);
2306            }
2307    
2308            // update dimension definitions in '3lnk' chunk
2309            uint8_t* pData = (uint8_t*) _3lnk->LoadChunkData();
2310            store32(&pData[0], DimensionRegions);
2311            int shift = 0;
2312            for (int i = 0; i < iMaxDimensions; i++) {
2313                pData[4 + i * 8] = (uint8_t) pDimensionDefinitions[i].dimension;
2314                pData[5 + i * 8] = pDimensionDefinitions[i].bits;
2315                pData[6 + i * 8] = pDimensionDefinitions[i].dimension == dimension_none ? 0 : shift;
2316                pData[7 + i * 8] = (1 << (shift + pDimensionDefinitions[i].bits)) - (1 << shift);
2317                pData[8 + i * 8] = pDimensionDefinitions[i].zones;
2318                // next 3 bytes unknown, always zero?
2319    
2320                shift += pDimensionDefinitions[i].bits;
2321            }
2322    
2323            // update wave pool table in '3lnk' chunk
2324            const int iWavePoolOffset = version3 ? 68 : 44;
2325            for (uint i = 0; i < iMaxDimensionRegions; i++) {
2326                int iWaveIndex = -1;
2327                if (i < DimensionRegions) {
2328                    if (!pFile->pSamples || !pFile->pSamples->size()) throw gig::Exception("Could not update gig::Region, there are no samples");
2329                    File::SampleList::iterator iter = pFile->pSamples->begin();
2330                    File::SampleList::iterator end  = pFile->pSamples->end();
2331                    for (int index = 0; iter != end; ++iter, ++index) {
2332                        if (*iter == pDimensionRegions[i]->pSample) {
2333                            iWaveIndex = index;
2334                            break;
2335                        }
2336                    }
2337                }
2338                store32(&pData[iWavePoolOffset + i * 4], iWaveIndex);
2339            }
2340      }      }
2341    
2342      void Region::LoadDimensionRegions(RIFF::List* rgn) {      void Region::LoadDimensionRegions(RIFF::List* rgn) {
# Line 1190  namespace gig { Line 2355  namespace gig {
2355          }          }
2356      }      }
2357    
2358      Region::~Region() {      void Region::UpdateVelocityTable() {
2359          for (uint i = 0; i < Dimensions; i++) {          // get velocity dimension's index
2360              if (pDimensionDefinitions[i].ranges) delete[] pDimensionDefinitions[i].ranges;          int veldim = -1;
2361            for (int i = 0 ; i < Dimensions ; i++) {
2362                if (pDimensionDefinitions[i].dimension == gig::dimension_velocity) {
2363                    veldim = i;
2364                    break;
2365                }
2366          }          }
2367            if (veldim == -1) return;
2368    
2369            int step = 1;
2370            for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;
2371            int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;
2372            int end = step * pDimensionDefinitions[veldim].zones;
2373    
2374            // loop through all dimension regions for all dimensions except the velocity dimension
2375            int dim[8] = { 0 };
2376            for (int i = 0 ; i < DimensionRegions ; i++) {
2377    
2378                if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||
2379                    pDimensionRegions[i]->VelocityUpperLimit) {
2380                    // create the velocity table
2381                    uint8_t* table = pDimensionRegions[i]->VelocityTable;
2382                    if (!table) {
2383                        table = new uint8_t[128];
2384                        pDimensionRegions[i]->VelocityTable = table;
2385                    }
2386                    int tableidx = 0;
2387                    int velocityZone = 0;
2388                    if (pDimensionRegions[i]->DimensionUpperLimits[veldim]) { // gig3
2389                        for (int k = i ; k < end ; k += step) {
2390                            DimensionRegion *d = pDimensionRegions[k];
2391                            for (; tableidx <= d->DimensionUpperLimits[veldim] ; tableidx++) table[tableidx] = velocityZone;
2392                            velocityZone++;
2393                        }
2394                    } else { // gig2
2395                        for (int k = i ; k < end ; k += step) {
2396                            DimensionRegion *d = pDimensionRegions[k];
2397                            for (; tableidx <= d->VelocityUpperLimit ; tableidx++) table[tableidx] = velocityZone;
2398                            velocityZone++;
2399                        }
2400                    }
2401                } else {
2402                    if (pDimensionRegions[i]->VelocityTable) {
2403                        delete[] pDimensionRegions[i]->VelocityTable;
2404                        pDimensionRegions[i]->VelocityTable = 0;
2405                    }
2406                }
2407    
2408                int j;
2409                int shift = 0;
2410                for (j = 0 ; j < Dimensions ; j++) {
2411                    if (j == veldim) i += skipveldim; // skip velocity dimension
2412                    else {
2413                        dim[j]++;
2414                        if (dim[j] < pDimensionDefinitions[j].zones) break;
2415                        else {
2416                            // skip unused dimension regions
2417                            dim[j] = 0;
2418                            i += ((1 << pDimensionDefinitions[j].bits) -
2419                                  pDimensionDefinitions[j].zones) << shift;
2420                        }
2421                    }
2422                    shift += pDimensionDefinitions[j].bits;
2423                }
2424                if (j == Dimensions) break;
2425            }
2426        }
2427    
2428        /** @brief Einstein would have dreamed of it - create a new dimension.
2429         *
2430         * Creates a new dimension with the dimension definition given by
2431         * \a pDimDef. The appropriate amount of DimensionRegions will be created.
2432         * There is a hard limit of dimensions and total amount of "bits" all
2433         * dimensions can have. This limit is dependant to what gig file format
2434         * version this file refers to. The gig v2 (and lower) format has a
2435         * dimension limit and total amount of bits limit of 5, whereas the gig v3
2436         * format has a limit of 8.
2437         *
2438         * @param pDimDef - defintion of the new dimension
2439         * @throws gig::Exception if dimension of the same type exists already
2440         * @throws gig::Exception if amount of dimensions or total amount of
2441         *                        dimension bits limit is violated
2442         */
2443        void Region::AddDimension(dimension_def_t* pDimDef) {
2444            // check if max. amount of dimensions reached
2445            File* file = (File*) GetParent()->GetParent();
2446            const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;
2447            if (Dimensions >= iMaxDimensions)
2448                throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimensions already reached");
2449            // check if max. amount of dimension bits reached
2450            int iCurrentBits = 0;
2451            for (int i = 0; i < Dimensions; i++)
2452                iCurrentBits += pDimensionDefinitions[i].bits;
2453            if (iCurrentBits >= iMaxDimensions)
2454                throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimension bits already reached");
2455            const int iNewBits = iCurrentBits + pDimDef->bits;
2456            if (iNewBits > iMaxDimensions)
2457                throw gig::Exception("Could not add new dimension, new dimension would exceed max. amount of " + ToString(iMaxDimensions) + " dimension bits");
2458            // check if there's already a dimensions of the same type
2459            for (int i = 0; i < Dimensions; i++)
2460                if (pDimensionDefinitions[i].dimension == pDimDef->dimension)
2461                    throw gig::Exception("Could not add new dimension, there is already a dimension of the same type");
2462    
2463            // assign definition of new dimension
2464            pDimensionDefinitions[Dimensions] = *pDimDef;
2465    
2466            // auto correct certain dimension definition fields (where possible)
2467            pDimensionDefinitions[Dimensions].split_type  =
2468                __resolveSplitType(pDimensionDefinitions[Dimensions].dimension);
2469            pDimensionDefinitions[Dimensions].zone_size =
2470                __resolveZoneSize(pDimensionDefinitions[Dimensions]);
2471    
2472            // create new dimension region(s) for this new dimension
2473            for (int i = 1 << iCurrentBits; i < 1 << iNewBits; i++) {
2474                //TODO: maybe we should copy existing dimension regions if possible instead of simply creating new ones with default values
2475                RIFF::List* _3prg = pCkRegion->GetSubList(LIST_TYPE_3PRG);
2476                RIFF::List* pNewDimRgnListChunk = _3prg->AddSubList(LIST_TYPE_3EWL);
2477                pDimensionRegions[i] = new DimensionRegion(pNewDimRgnListChunk);
2478    
2479                // copy the upper limits for the other dimensions
2480                memcpy(pDimensionRegions[i]->DimensionUpperLimits,
2481                       pDimensionRegions[i & ((1 << iCurrentBits) - 1)]->DimensionUpperLimits, 8);
2482    
2483                DimensionRegions++;
2484            }
2485    
2486            // initialize the upper limits for this dimension
2487            for (int z = 0, j = 0 ; z < pDimDef->zones ; z++, j += 1 << iCurrentBits) {
2488                uint8_t upperLimit = uint8_t((z + 1) * 128.0 / pDimDef->zones - 1);
2489                for (int i = 0 ; i < 1 << iCurrentBits ; i++) {
2490                    pDimensionRegions[j + i]->DimensionUpperLimits[Dimensions] = upperLimit;
2491                }
2492            }
2493    
2494            Dimensions++;
2495    
2496            // if this is a layer dimension, update 'Layers' attribute
2497            if (pDimDef->dimension == dimension_layer) Layers = pDimDef->zones;
2498    
2499            UpdateVelocityTable();
2500        }
2501    
2502        /** @brief Delete an existing dimension.
2503         *
2504         * Deletes the dimension given by \a pDimDef and deletes all respective
2505         * dimension regions, that is all dimension regions where the dimension's
2506         * bit(s) part is greater than 0. In case of a 'sustain pedal' dimension
2507         * for example this would delete all dimension regions for the case(s)
2508         * where the sustain pedal is pressed down.
2509         *
2510         * @param pDimDef - dimension to delete
2511         * @throws gig::Exception if given dimension cannot be found
2512         */
2513        void Region::DeleteDimension(dimension_def_t* pDimDef) {
2514            // get dimension's index
2515            int iDimensionNr = -1;
2516            for (int i = 0; i < Dimensions; i++) {
2517                if (&pDimensionDefinitions[i] == pDimDef) {
2518                    iDimensionNr = i;
2519                    break;
2520                }
2521            }
2522            if (iDimensionNr < 0) throw gig::Exception("Invalid dimension_def_t pointer");
2523    
2524            // get amount of bits below the dimension to delete
2525            int iLowerBits = 0;
2526            for (int i = 0; i < iDimensionNr; i++)
2527                iLowerBits += pDimensionDefinitions[i].bits;
2528    
2529            // get amount ot bits above the dimension to delete
2530            int iUpperBits = 0;
2531            for (int i = iDimensionNr + 1; i < Dimensions; i++)
2532                iUpperBits += pDimensionDefinitions[i].bits;
2533    
2534            RIFF::List* _3prg = pCkRegion->GetSubList(LIST_TYPE_3PRG);
2535    
2536            // delete dimension regions which belong to the given dimension
2537            // (that is where the dimension's bit > 0)
2538            for (int iUpperBit = 0; iUpperBit < 1 << iUpperBits; iUpperBit++) {
2539                for (int iObsoleteBit = 1; iObsoleteBit < 1 << pDimensionDefinitions[iDimensionNr].bits; iObsoleteBit++) {
2540                    for (int iLowerBit = 0; iLowerBit < 1 << iLowerBits; iLowerBit++) {
2541                        int iToDelete = iUpperBit    << (pDimensionDefinitions[iDimensionNr].bits + iLowerBits) |
2542                                        iObsoleteBit << iLowerBits |
2543                                        iLowerBit;
2544    
2545                        _3prg->DeleteSubChunk(pDimensionRegions[iToDelete]->pParentList);
2546                        delete pDimensionRegions[iToDelete];
2547                        pDimensionRegions[iToDelete] = NULL;
2548                        DimensionRegions--;
2549                    }
2550                }
2551            }
2552    
2553            // defrag pDimensionRegions array
2554            // (that is remove the NULL spaces within the pDimensionRegions array)
2555            for (int iFrom = 2, iTo = 1; iFrom < 256 && iTo < 256 - 1; iTo++) {
2556                if (!pDimensionRegions[iTo]) {
2557                    if (iFrom <= iTo) iFrom = iTo + 1;
2558                    while (!pDimensionRegions[iFrom] && iFrom < 256) iFrom++;
2559                    if (iFrom < 256 && pDimensionRegions[iFrom]) {
2560                        pDimensionRegions[iTo]   = pDimensionRegions[iFrom];
2561                        pDimensionRegions[iFrom] = NULL;
2562                    }
2563                }
2564            }
2565    
2566            // remove the this dimension from the upper limits arrays
2567            for (int j = 0 ; j < 256 && pDimensionRegions[j] ; j++) {
2568                DimensionRegion* d = pDimensionRegions[j];
2569                for (int i = iDimensionNr + 1; i < Dimensions; i++) {
2570                    d->DimensionUpperLimits[i - 1] = d->DimensionUpperLimits[i];
2571                }
2572                d->DimensionUpperLimits[Dimensions - 1] = 127;
2573            }
2574    
2575            // 'remove' dimension definition
2576            for (int i = iDimensionNr + 1; i < Dimensions; i++) {
2577                pDimensionDefinitions[i - 1] = pDimensionDefinitions[i];
2578            }
2579            pDimensionDefinitions[Dimensions - 1].dimension = dimension_none;
2580            pDimensionDefinitions[Dimensions - 1].bits      = 0;
2581            pDimensionDefinitions[Dimensions - 1].zones     = 0;
2582    
2583            Dimensions--;
2584    
2585            // if this was a layer dimension, update 'Layers' attribute
2586            if (pDimDef->dimension == dimension_layer) Layers = 1;
2587        }
2588    
2589        Region::~Region() {
2590          for (int i = 0; i < 256; i++) {          for (int i = 0; i < 256; i++) {
2591              if (pDimensionRegions[i]) delete pDimensionRegions[i];              if (pDimensionRegions[i]) delete pDimensionRegions[i];
2592          }          }
# Line 1218  namespace gig { Line 2611  namespace gig {
2611       * @see             Dimensions       * @see             Dimensions
2612       */       */
2613      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {
2614          uint8_t bits[8] = { 0 };          uint8_t bits;
2615            int veldim = -1;
2616            int velbitpos;
2617            int bitpos = 0;
2618            int dimregidx = 0;
2619          for (uint i = 0; i < Dimensions; i++) {          for (uint i = 0; i < Dimensions; i++) {
2620              bits[i] = DimValues[i];              if (pDimensionDefinitions[i].dimension == dimension_velocity) {
2621              switch (pDimensionDefinitions[i].split_type) {                  // the velocity dimension must be handled after the other dimensions
2622                  case split_type_normal:                  veldim = i;
2623                      bits[i] /= pDimensionDefinitions[i].zone_size;                  velbitpos = bitpos;
2624                      break;              } else {
2625                  case split_type_customvelocity:                  switch (pDimensionDefinitions[i].split_type) {
2626                      bits[i] = VelocityTable[bits[i]];                      case split_type_normal:
2627                      break;                          if (pDimensionRegions[0]->DimensionUpperLimits[i]) {
2628                  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
2629                      const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;                              for (bits = 0 ; bits < pDimensionDefinitions[i].zones ; bits++) {
2630                      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;
2631                      break;                              }
2632                            } else {
2633                                // gig2: evenly sized zones
2634                                bits = uint8_t(DimValues[i] / pDimensionDefinitions[i].zone_size);
2635                            }
2636                            break;
2637                        case split_type_bit: // the value is already the sought dimension bit number
2638                            const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;
2639                            bits = DimValues[i] & limiter_mask; // just make sure the value doesn't use more bits than allowed
2640                            break;
2641                    }
2642                    dimregidx |= bits << bitpos;
2643              }              }
2644                bitpos += pDimensionDefinitions[i].bits;
2645          }          }
2646          return GetDimensionRegionByBit(bits);          DimensionRegion* dimreg = pDimensionRegions[dimregidx];
2647            if (veldim != -1) {
2648                // (dimreg is now the dimension region for the lowest velocity)
2649                if (dimreg->VelocityTable) // custom defined zone ranges
2650                    bits = dimreg->VelocityTable[DimValues[veldim]];
2651                else // normal split type
2652                    bits = uint8_t(DimValues[veldim] / pDimensionDefinitions[veldim].zone_size);
2653    
2654                dimregidx |= bits << velbitpos;
2655                dimreg = pDimensionRegions[dimregidx];
2656            }
2657            return dimreg;
2658      }      }
2659    
2660      /**      /**
# Line 1271  namespace gig { Line 2691  namespace gig {
2691          else         return static_cast<gig::Sample*>(pSample = GetSampleFromWavePool(WavePoolTableIndex));          else         return static_cast<gig::Sample*>(pSample = GetSampleFromWavePool(WavePoolTableIndex));
2692      }      }
2693    
2694      Sample* Region::GetSampleFromWavePool(unsigned int WavePoolTableIndex) {      Sample* Region::GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress) {
2695          if ((int32_t)WavePoolTableIndex == -1) return NULL;          if ((int32_t)WavePoolTableIndex == -1) return NULL;
2696          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
2697            if (!file->pWavePoolTable) return NULL;
2698          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
2699          Sample* sample = file->GetFirstSample();          unsigned long soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];
2700            Sample* sample = file->GetFirstSample(pProgress);
2701          while (sample) {          while (sample) {
2702              if (sample->ulWavePoolOffset == soughtoffset) return static_cast<gig::Sample*>(pSample = sample);              if (sample->ulWavePoolOffset == soughtoffset &&
2703                    sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);
2704              sample = file->GetNextSample();              sample = file->GetNextSample();
2705          }          }
2706          return NULL;          return NULL;
# Line 1288  namespace gig { Line 2711  namespace gig {
2711  // *************** Instrument ***************  // *************** Instrument ***************
2712  // *  // *
2713    
2714      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) {
2715            static const DLS::Info::FixedStringLength fixedStringLengths[] = {
2716                { CHUNK_ID_INAM, 64 },
2717                { CHUNK_ID_ISFT, 12 },
2718                { 0, 0 }
2719            };
2720            pInfo->FixedStringLengths = fixedStringLengths;
2721    
2722          // Initialization          // Initialization
2723          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;
2724          RegionIndex = -1;          EffectSend = 0;
2725            Attenuation = 0;
2726            FineTune = 0;
2727            PitchbendRange = 0;
2728            PianoReleaseMode = false;
2729            DimensionKeyRange.low = 0;
2730            DimensionKeyRange.high = 0;
2731    
2732          // Loading          // Loading
2733          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);
# Line 1307  namespace gig { Line 2743  namespace gig {
2743                  DimensionKeyRange.low  = dimkeystart >> 1;                  DimensionKeyRange.low  = dimkeystart >> 1;
2744                  DimensionKeyRange.high = _3ewg->ReadUint8();                  DimensionKeyRange.high = _3ewg->ReadUint8();
2745              }              }
             else throw gig::Exception("Mandatory <3ewg> chunk not found.");  
2746          }          }
         else throw gig::Exception("Mandatory <lart> list chunk not found.");  
2747    
2748            if (!pRegions) pRegions = new RegionList;
2749          RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);          RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);
2750          if (!lrgn) throw gig::Exception("Mandatory chunks in <ins > chunk not found.");          if (lrgn) {
2751          pRegions = new Region*[Regions];              RIFF::List* rgn = lrgn->GetFirstSubList();
2752          for (uint i = 0; i < Regions; i++) pRegions[i] = NULL;              while (rgn) {
2753          RIFF::List* rgn = lrgn->GetFirstSubList();                  if (rgn->GetListType() == LIST_TYPE_RGN) {
2754          unsigned int iRegion = 0;                      __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
2755          while (rgn) {                      pRegions->push_back(new Region(this, rgn));
2756              if (rgn->GetListType() == LIST_TYPE_RGN) {                  }
2757                  pRegions[iRegion] = new Region(this, rgn);                  rgn = lrgn->GetNextSubList();
                 iRegion++;  
             }  
             rgn = lrgn->GetNextSubList();  
         }  
   
         // Creating Region Key Table for fast lookup  
         for (uint iReg = 0; iReg < Regions; iReg++) {  
             for (int iKey = pRegions[iReg]->KeyRange.low; iKey <= pRegions[iReg]->KeyRange.high; iKey++) {  
                 RegionKeyTable[iKey] = pRegions[iReg];  
2758              }              }
2759                // Creating Region Key Table for fast lookup
2760                UpdateRegionKeyTable();
2761          }          }
2762    
2763            __notify_progress(pProgress, 1.0f); // notify done
2764      }      }
2765    
2766      Instrument::~Instrument() {      void Instrument::UpdateRegionKeyTable() {
2767          for (uint i = 0; i < Regions; i++) {          RegionList::iterator iter = pRegions->begin();
2768              if (pRegions) {          RegionList::iterator end  = pRegions->end();
2769                  if (pRegions[i]) delete (pRegions[i]);          for (; iter != end; ++iter) {
2770                gig::Region* pRegion = static_cast<gig::Region*>(*iter);
2771                for (int iKey = pRegion->KeyRange.low; iKey <= pRegion->KeyRange.high; iKey++) {
2772                    RegionKeyTable[iKey] = pRegion;
2773              }              }
2774          }          }
2775          if (pRegions) delete[] pRegions;      }
2776    
2777        Instrument::~Instrument() {
2778        }
2779    
2780        /**
2781         * Apply Instrument with all its Regions to the respective RIFF chunks.
2782         * You have to call File::Save() to make changes persistent.
2783         *
2784         * Usually there is absolutely no need to call this method explicitly.
2785         * It will be called automatically when File::Save() was called.
2786         *
2787         * @throws gig::Exception if samples cannot be dereferenced
2788         */
2789        void Instrument::UpdateChunks() {
2790            // first update base classes' chunks
2791            DLS::Instrument::UpdateChunks();
2792    
2793            // update Regions' chunks
2794            {
2795                RegionList::iterator iter = pRegions->begin();
2796                RegionList::iterator end  = pRegions->end();
2797                for (; iter != end; ++iter)
2798                    (*iter)->UpdateChunks();
2799            }
2800    
2801            // make sure 'lart' RIFF list chunk exists
2802            RIFF::List* lart = pCkInstrument->GetSubList(LIST_TYPE_LART);
2803            if (!lart)  lart = pCkInstrument->AddSubList(LIST_TYPE_LART);
2804            // make sure '3ewg' RIFF chunk exists
2805            RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);
2806            if (!_3ewg)  {
2807                File* pFile = (File*) GetParent();
2808    
2809                // 3ewg is bigger in gig3, as it includes the iMIDI rules
2810                int size = (pFile->pVersion && pFile->pVersion->major == 3) ? 16416 : 12;
2811                _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, size);
2812                memset(_3ewg->LoadChunkData(), 0, size);
2813            }
2814            // update '3ewg' RIFF chunk
2815            uint8_t* pData = (uint8_t*) _3ewg->LoadChunkData();
2816            store16(&pData[0], EffectSend);
2817            store32(&pData[2], Attenuation);
2818            store16(&pData[6], FineTune);
2819            store16(&pData[8], PitchbendRange);
2820            const uint8_t dimkeystart = (PianoReleaseMode ? 0x01 : 0x00) |
2821                                        DimensionKeyRange.low << 1;
2822            pData[10] = dimkeystart;
2823            pData[11] = DimensionKeyRange.high;
2824      }      }
2825    
2826      /**      /**
# Line 1350  namespace gig { Line 2831  namespace gig {
2831       *             there is no Region defined for the given \a Key       *             there is no Region defined for the given \a Key
2832       */       */
2833      Region* Instrument::GetRegion(unsigned int Key) {      Region* Instrument::GetRegion(unsigned int Key) {
2834          if (!pRegions || Key > 127) return NULL;          if (!pRegions || !pRegions->size() || Key > 127) return NULL;
2835          return RegionKeyTable[Key];          return RegionKeyTable[Key];
2836    
2837          /*for (int i = 0; i < Regions; i++) {          /*for (int i = 0; i < Regions; i++) {
2838              if (Key <= pRegions[i]->KeyRange.high &&              if (Key <= pRegions[i]->KeyRange.high &&
2839                  Key >= pRegions[i]->KeyRange.low) return pRegions[i];                  Key >= pRegions[i]->KeyRange.low) return pRegions[i];
# Line 1367  namespace gig { Line 2849  namespace gig {
2849       * @see      GetNextRegion()       * @see      GetNextRegion()
2850       */       */
2851      Region* Instrument::GetFirstRegion() {      Region* Instrument::GetFirstRegion() {
2852          if (!Regions) return NULL;          if (!pRegions) return NULL;
2853          RegionIndex = 1;          RegionsIterator = pRegions->begin();
2854          return pRegions[0];          return static_cast<gig::Region*>( (RegionsIterator != pRegions->end()) ? *RegionsIterator : NULL );
2855      }      }
2856    
2857      /**      /**
# Line 1381  namespace gig { Line 2863  namespace gig {
2863       * @see      GetFirstRegion()       * @see      GetFirstRegion()
2864       */       */
2865      Region* Instrument::GetNextRegion() {      Region* Instrument::GetNextRegion() {
2866          if (RegionIndex < 0 || RegionIndex >= Regions) return NULL;          if (!pRegions) return NULL;
2867          return pRegions[RegionIndex++];          RegionsIterator++;
2868            return static_cast<gig::Region*>( (RegionsIterator != pRegions->end()) ? *RegionsIterator : NULL );
2869        }
2870    
2871        Region* Instrument::AddRegion() {
2872            // create new Region object (and its RIFF chunks)
2873            RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
2874            if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
2875            RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
2876            Region* pNewRegion = new Region(this, rgn);
2877            pRegions->push_back(pNewRegion);
2878            Regions = pRegions->size();
2879            // update Region key table for fast lookup
2880            UpdateRegionKeyTable();
2881            // done
2882            return pNewRegion;
2883      }      }
2884    
2885        void Instrument::DeleteRegion(Region* pRegion) {
2886            if (!pRegions) return;
2887            DLS::Instrument::DeleteRegion((DLS::Region*) pRegion);
2888            // update Region key table for fast lookup
2889            UpdateRegionKeyTable();
2890        }
2891    
2892    
2893  // *************** File ***************  
2894    // *************** Group ***************
2895  // *  // *
2896    
2897      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {      /** @brief Constructor.
2898          pSamples     = NULL;       *
2899          pInstruments = NULL;       * @param file   - pointer to the gig::File object
2900         * @param ck3gnm - pointer to 3gnm chunk associated with this group or
2901         *                 NULL if this is a new Group
2902         */
2903        Group::Group(File* file, RIFF::Chunk* ck3gnm) {
2904            pFile      = file;
2905            pNameChunk = ck3gnm;
2906            ::LoadString(pNameChunk, Name);
2907      }      }
2908    
2909      File::~File() {      Group::~Group() {
2910          // free samples          // remove the chunk associated with this group (if any)
2911          if (pSamples) {          if (pNameChunk) pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);
2912              SamplesIterator = pSamples->begin();      }
2913              while (SamplesIterator != pSamples->end() ) {  
2914                  delete (*SamplesIterator);      /** @brief Update chunks with current group settings.
2915                  SamplesIterator++;       *
2916         * Apply current Group field values to the respective chunks. You have
2917         * to call File::Save() to make changes persistent.
2918         *
2919         * Usually there is absolutely no need to call this method explicitly.
2920         * It will be called automatically when File::Save() was called.
2921         */
2922        void Group::UpdateChunks() {
2923            // make sure <3gri> and <3gnl> list chunks exist
2924            RIFF::List* _3gri = pFile->pRIFF->GetSubList(LIST_TYPE_3GRI);
2925            if (!_3gri) {
2926                _3gri = pFile->pRIFF->AddSubList(LIST_TYPE_3GRI);
2927                pFile->pRIFF->MoveSubChunk(_3gri, pFile->pRIFF->GetSubChunk(CHUNK_ID_PTBL));
2928            }
2929            RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
2930            if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
2931    
2932            if (!pNameChunk && pFile->pVersion && pFile->pVersion->major == 3) {
2933                // v3 has a fixed list of 128 strings, find a free one
2934                for (RIFF::Chunk* ck = _3gnl->GetFirstSubChunk() ; ck ; ck = _3gnl->GetNextSubChunk()) {
2935                    if (strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) {
2936                        pNameChunk = ck;
2937                        break;
2938                    }
2939              }              }
2940              pSamples->clear();          }
2941    
2942            // now store the name of this group as <3gnm> chunk as subchunk of the <3gnl> list chunk
2943            ::SaveString(CHUNK_ID_3GNM, pNameChunk, _3gnl, Name, String("Unnamed Group"), true, 64);
2944        }
2945    
2946        /**
2947         * Returns the first Sample of this Group. You have to call this method
2948         * once before you use GetNextSample().
2949         *
2950         * <b>Notice:</b> this method might block for a long time, in case the
2951         * samples of this .gig file were not scanned yet
2952         *
2953         * @returns  pointer address to first Sample or NULL if there is none
2954         *           applied to this Group
2955         * @see      GetNextSample()
2956         */
2957        Sample* Group::GetFirstSample() {
2958            // FIXME: lazy und unsafe implementation, should be an autonomous iterator
2959            for (Sample* pSample = pFile->GetFirstSample(); pSample; pSample = pFile->GetNextSample()) {
2960                if (pSample->GetGroup() == this) return pSample;
2961            }
2962            return NULL;
2963        }
2964    
2965        /**
2966         * Returns the next Sample of the Group. You have to call
2967         * GetFirstSample() once before you can use this method. By calling this
2968         * method multiple times it iterates through the Samples assigned to
2969         * this Group.
2970         *
2971         * @returns  pointer address to the next Sample of this Group or NULL if
2972         *           end reached
2973         * @see      GetFirstSample()
2974         */
2975        Sample* Group::GetNextSample() {
2976            // FIXME: lazy und unsafe implementation, should be an autonomous iterator
2977            for (Sample* pSample = pFile->GetNextSample(); pSample; pSample = pFile->GetNextSample()) {
2978                if (pSample->GetGroup() == this) return pSample;
2979          }          }
2980          // free instruments          return NULL;
2981          if (pInstruments) {      }
2982              InstrumentsIterator = pInstruments->begin();  
2983              while (InstrumentsIterator != pInstruments->end() ) {      /**
2984                  delete (*InstrumentsIterator);       * Move Sample given by \a pSample from another Group to this Group.
2985                  InstrumentsIterator++;       */
2986        void Group::AddSample(Sample* pSample) {
2987            pSample->pGroup = this;
2988        }
2989    
2990        /**
2991         * Move all members of this group to another group (preferably the 1st
2992         * one except this). This method is called explicitly by
2993         * File::DeleteGroup() thus when a Group was deleted. This code was
2994         * intentionally not placed in the destructor!
2995         */
2996        void Group::MoveAll() {
2997            // get "that" other group first
2998            Group* pOtherGroup = NULL;
2999            for (pOtherGroup = pFile->GetFirstGroup(); pOtherGroup; pOtherGroup = pFile->GetNextGroup()) {
3000                if (pOtherGroup != this) break;
3001            }
3002            if (!pOtherGroup) throw Exception(
3003                "Could not move samples to another group, since there is no "
3004                "other Group. This is a bug, report it!"
3005            );
3006            // now move all samples of this group to the other group
3007            for (Sample* pSample = GetFirstSample(); pSample; pSample = GetNextSample()) {
3008                pOtherGroup->AddSample(pSample);
3009            }
3010        }
3011    
3012    
3013    
3014    // *************** File ***************
3015    // *
3016    
3017        // File version 2.0, 1998-06-28
3018        const DLS::version_t File::VERSION_2 = {
3019            0, 2, 19980628 & 0xffff, 19980628 >> 16
3020        };
3021    
3022        // File version 3.0, 2003-03-31
3023        const DLS::version_t File::VERSION_3 = {
3024            0, 3, 20030331 & 0xffff, 20030331 >> 16
3025        };
3026    
3027        const DLS::Info::FixedStringLength File::FixedStringLengths[] = {
3028            { CHUNK_ID_IARL, 256 },
3029            { CHUNK_ID_IART, 128 },
3030            { CHUNK_ID_ICMS, 128 },
3031            { CHUNK_ID_ICMT, 1024 },
3032            { CHUNK_ID_ICOP, 128 },
3033            { CHUNK_ID_ICRD, 128 },
3034            { CHUNK_ID_IENG, 128 },
3035            { CHUNK_ID_IGNR, 128 },
3036            { CHUNK_ID_IKEY, 128 },
3037            { CHUNK_ID_IMED, 128 },
3038            { CHUNK_ID_INAM, 128 },
3039            { CHUNK_ID_IPRD, 128 },
3040            { CHUNK_ID_ISBJ, 128 },
3041            { CHUNK_ID_ISFT, 128 },
3042            { CHUNK_ID_ISRC, 128 },
3043            { CHUNK_ID_ISRF, 128 },
3044            { CHUNK_ID_ITCH, 128 },
3045            { 0, 0 }
3046        };
3047    
3048        File::File() : DLS::File() {
3049            *pVersion = VERSION_3;
3050            pGroups = NULL;
3051            pInfo->FixedStringLengths = FixedStringLengths;
3052            pInfo->ArchivalLocation = String(256, ' ');
3053    
3054            // add some mandatory chunks to get the file chunks in right
3055            // order (INFO chunk will be moved to first position later)
3056            pRIFF->AddSubChunk(CHUNK_ID_VERS, 8);
3057            pRIFF->AddSubChunk(CHUNK_ID_COLH, 4);
3058            pRIFF->AddSubChunk(CHUNK_ID_DLID, 16);
3059    
3060            GenerateDLSID();
3061        }
3062    
3063        File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {
3064            pGroups = NULL;
3065            pInfo->FixedStringLengths = FixedStringLengths;
3066        }
3067    
3068        File::~File() {
3069            if (pGroups) {
3070                std::list<Group*>::iterator iter = pGroups->begin();
3071                std::list<Group*>::iterator end  = pGroups->end();
3072                while (iter != end) {
3073                    delete *iter;
3074                    ++iter;
3075              }              }
3076              pInstruments->clear();              delete pGroups;
3077          }          }
3078      }      }
3079    
3080      Sample* File::GetFirstSample() {      Sample* File::GetFirstSample(progress_t* pProgress) {
3081          if (!pSamples) LoadSamples();          if (!pSamples) LoadSamples(pProgress);
3082          if (!pSamples) return NULL;          if (!pSamples) return NULL;
3083          SamplesIterator = pSamples->begin();          SamplesIterator = pSamples->begin();
3084          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
# Line 1430  namespace gig { Line 3090  namespace gig {
3090          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
3091      }      }
3092    
3093      void File::LoadSamples() {      /** @brief Add a new sample.
3094          RIFF::List* wvpl = pRIFF->GetSubList(LIST_TYPE_WVPL);       *
3095          if (wvpl) {       * This will create a new Sample object for the gig file. You have to
3096              unsigned long wvplFileOffset = wvpl->GetFilePos();       * call Save() to make this persistent to the file.
3097              RIFF::List* wave = wvpl->GetFirstSubList();       *
3098              while (wave) {       * @returns pointer to new Sample object
3099                  if (wave->GetListType() == LIST_TYPE_WAVE) {       */
3100                      if (!pSamples) pSamples = new SampleList;      Sample* File::AddSample() {
3101                      unsigned long waveFileOffset = wave->GetFilePos();         if (!pSamples) LoadSamples();
3102                      pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset));         __ensureMandatoryChunksExist();
3103           RIFF::List* wvpl = pRIFF->GetSubList(LIST_TYPE_WVPL);
3104           // create new Sample object and its respective 'wave' list chunk
3105           RIFF::List* wave = wvpl->AddSubList(LIST_TYPE_WAVE);
3106           Sample* pSample = new Sample(this, wave, 0 /*arbitrary value, we update offsets when we save*/);
3107    
3108           // add mandatory chunks to get the chunks in right order
3109           wave->AddSubChunk(CHUNK_ID_FMT, 16);
3110           wave->AddSubList(LIST_TYPE_INFO);
3111    
3112           pSamples->push_back(pSample);
3113           return pSample;
3114        }
3115    
3116        /** @brief Delete a sample.
3117         *
3118         * This will delete the given Sample object from the gig file. You have
3119         * to call Save() to make this persistent to the file.
3120         *
3121         * @param pSample - sample to delete
3122         * @throws gig::Exception if given sample could not be found
3123         */
3124        void File::DeleteSample(Sample* pSample) {
3125            if (!pSamples || !pSamples->size()) throw gig::Exception("Could not delete sample as there are no samples");
3126            SampleList::iterator iter = find(pSamples->begin(), pSamples->end(), (DLS::Sample*) pSample);
3127            if (iter == pSamples->end()) throw gig::Exception("Could not delete sample, could not find given sample");
3128            if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation
3129            pSamples->erase(iter);
3130            delete pSample;
3131    
3132            // remove all references to the sample
3133            for (Instrument* instrument = GetFirstInstrument() ; instrument ;
3134                 instrument = GetNextInstrument()) {
3135                for (Region* region = instrument->GetFirstRegion() ; region ;
3136                     region = instrument->GetNextRegion()) {
3137    
3138                    if (region->GetSample() == pSample) region->SetSample(NULL);
3139    
3140                    for (int i = 0 ; i < region->DimensionRegions ; i++) {
3141                        gig::DimensionRegion *d = region->pDimensionRegions[i];
3142                        if (d->pSample == pSample) d->pSample = NULL;
3143                  }                  }
                 wave = wvpl->GetNextSubList();  
3144              }              }
3145          }          }
3146          else throw gig::Exception("Mandatory <wvpl> chunk not found.");      }
3147    
3148        void File::LoadSamples() {
3149            LoadSamples(NULL);
3150        }
3151    
3152        void File::LoadSamples(progress_t* pProgress) {
3153            // Groups must be loaded before samples, because samples will try
3154            // to resolve the group they belong to
3155            if (!pGroups) LoadGroups();
3156    
3157            if (!pSamples) pSamples = new SampleList;
3158    
3159            RIFF::File* file = pRIFF;
3160    
3161            // just for progress calculation
3162            int iSampleIndex  = 0;
3163            int iTotalSamples = WavePoolCount;
3164    
3165            // check if samples should be loaded from extension files
3166            int lastFileNo = 0;
3167            for (int i = 0 ; i < WavePoolCount ; i++) {
3168                if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];
3169            }
3170            String name(pRIFF->GetFileName());
3171            int nameLen = name.length();
3172            char suffix[6];
3173            if (nameLen > 4 && name.substr(nameLen - 4) == ".gig") nameLen -= 4;
3174    
3175            for (int fileNo = 0 ; ; ) {
3176                RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);
3177                if (wvpl) {
3178                    unsigned long wvplFileOffset = wvpl->GetFilePos();
3179                    RIFF::List* wave = wvpl->GetFirstSubList();
3180                    while (wave) {
3181                        if (wave->GetListType() == LIST_TYPE_WAVE) {
3182                            // notify current progress
3183                            const float subprogress = (float) iSampleIndex / (float) iTotalSamples;
3184                            __notify_progress(pProgress, subprogress);
3185    
3186                            unsigned long waveFileOffset = wave->GetFilePos();
3187                            pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));
3188    
3189                            iSampleIndex++;
3190                        }
3191                        wave = wvpl->GetNextSubList();
3192                    }
3193    
3194                    if (fileNo == lastFileNo) break;
3195    
3196                    // open extension file (*.gx01, *.gx02, ...)
3197                    fileNo++;
3198                    sprintf(suffix, ".gx%02d", fileNo);
3199                    name.replace(nameLen, 5, suffix);
3200                    file = new RIFF::File(name);
3201                    ExtensionFiles.push_back(file);
3202                } else break;
3203            }
3204    
3205            __notify_progress(pProgress, 1.0); // notify done
3206      }      }
3207    
3208      Instrument* File::GetFirstInstrument() {      Instrument* File::GetFirstInstrument() {
3209          if (!pInstruments) LoadInstruments();          if (!pInstruments) LoadInstruments();
3210          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
3211          InstrumentsIterator = pInstruments->begin();          InstrumentsIterator = pInstruments->begin();
3212          return (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL;          return static_cast<gig::Instrument*>( (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL );
3213      }      }
3214    
3215      Instrument* File::GetNextInstrument() {      Instrument* File::GetNextInstrument() {
3216          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
3217          InstrumentsIterator++;          InstrumentsIterator++;
3218          return (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL;          return static_cast<gig::Instrument*>( (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL );
3219      }      }
3220    
3221      /**      /**
3222       * Returns the instrument with the given index.       * Returns the instrument with the given index.
3223       *       *
3224         * @param index     - number of the sought instrument (0..n)
3225         * @param pProgress - optional: callback function for progress notification
3226       * @returns  sought instrument or NULL if there's no such instrument       * @returns  sought instrument or NULL if there's no such instrument
3227       */       */
3228      Instrument* File::GetInstrument(uint index) {      Instrument* File::GetInstrument(uint index, progress_t* pProgress) {
3229          if (!pInstruments) LoadInstruments();          if (!pInstruments) {
3230                // TODO: hack - we simply load ALL samples here, it would have been done in the Region constructor anyway (ATM)
3231    
3232                // sample loading subtask
3233                progress_t subprogress;
3234                __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask
3235                __notify_progress(&subprogress, 0.0f);
3236                GetFirstSample(&subprogress); // now force all samples to be loaded
3237                __notify_progress(&subprogress, 1.0f);
3238    
3239                // instrument loading subtask
3240                if (pProgress && pProgress->callback) {
3241                    subprogress.__range_min = subprogress.__range_max;
3242                    subprogress.__range_max = pProgress->__range_max; // schedule remaining percentage for this subtask
3243                }
3244                __notify_progress(&subprogress, 0.0f);
3245                LoadInstruments(&subprogress);
3246                __notify_progress(&subprogress, 1.0f);
3247            }
3248          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
3249          InstrumentsIterator = pInstruments->begin();          InstrumentsIterator = pInstruments->begin();
3250          for (uint i = 0; InstrumentsIterator != pInstruments->end(); i++) {          for (uint i = 0; InstrumentsIterator != pInstruments->end(); i++) {
3251              if (i == index) return *InstrumentsIterator;              if (i == index) return static_cast<gig::Instrument*>( *InstrumentsIterator );
3252              InstrumentsIterator++;              InstrumentsIterator++;
3253          }          }
3254          return NULL;          return NULL;
3255      }      }
3256    
3257        /** @brief Add a new instrument definition.
3258         *
3259         * This will create a new Instrument object for the gig file. You have
3260         * to call Save() to make this persistent to the file.
3261         *
3262         * @returns pointer to new Instrument object
3263         */
3264        Instrument* File::AddInstrument() {
3265           if (!pInstruments) LoadInstruments();
3266           __ensureMandatoryChunksExist();
3267           RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
3268           RIFF::List* lstInstr = lstInstruments->AddSubList(LIST_TYPE_INS);
3269    
3270           // add mandatory chunks to get the chunks in right order
3271           lstInstr->AddSubList(LIST_TYPE_INFO);
3272           lstInstr->AddSubChunk(CHUNK_ID_DLID, 16);
3273    
3274           Instrument* pInstrument = new Instrument(this, lstInstr);
3275           pInstrument->GenerateDLSID();
3276    
3277           lstInstr->AddSubChunk(CHUNK_ID_INSH, 12);
3278    
3279           // this string is needed for the gig to be loadable in GSt:
3280           pInstrument->pInfo->Software = "Endless Wave";
3281    
3282           pInstruments->push_back(pInstrument);
3283           return pInstrument;
3284        }
3285    
3286        /** @brief Delete an instrument.
3287         *
3288         * This will delete the given Instrument object from the gig file. You
3289         * have to call Save() to make this persistent to the file.
3290         *
3291         * @param pInstrument - instrument to delete
3292         * @throws gig::Exception if given instrument could not be found
3293         */
3294        void File::DeleteInstrument(Instrument* pInstrument) {
3295            if (!pInstruments) throw gig::Exception("Could not delete instrument as there are no instruments");
3296            InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), (DLS::Instrument*) pInstrument);
3297            if (iter == pInstruments->end()) throw gig::Exception("Could not delete instrument, could not find given instrument");
3298            pInstruments->erase(iter);
3299            delete pInstrument;
3300        }
3301    
3302      void File::LoadInstruments() {      void File::LoadInstruments() {
3303            LoadInstruments(NULL);
3304        }
3305    
3306        void File::LoadInstruments(progress_t* pProgress) {
3307            if (!pInstruments) pInstruments = new InstrumentList;
3308          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
3309          if (lstInstruments) {          if (lstInstruments) {
3310                int iInstrumentIndex = 0;
3311              RIFF::List* lstInstr = lstInstruments->GetFirstSubList();              RIFF::List* lstInstr = lstInstruments->GetFirstSubList();
3312              while (lstInstr) {              while (lstInstr) {
3313                  if (lstInstr->GetListType() == LIST_TYPE_INS) {                  if (lstInstr->GetListType() == LIST_TYPE_INS) {
3314                      if (!pInstruments) pInstruments = new InstrumentList;                      // notify current progress
3315                      pInstruments->push_back(new Instrument(this, lstInstr));                      const float localProgress = (float) iInstrumentIndex / (float) Instruments;
3316                        __notify_progress(pProgress, localProgress);
3317    
3318                        // divide local progress into subprogress for loading current Instrument
3319                        progress_t subprogress;
3320                        __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);
3321    
3322                        pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));
3323    
3324                        iInstrumentIndex++;
3325                  }                  }
3326                  lstInstr = lstInstruments->GetNextSubList();                  lstInstr = lstInstruments->GetNextSubList();
3327              }              }
3328                __notify_progress(pProgress, 1.0); // notify done
3329            }
3330        }
3331    
3332        /// Updates the 3crc chunk with the checksum of a sample. The
3333        /// update is done directly to disk, as this method is called
3334        /// after File::Save()
3335        void File::SetSampleChecksum(Sample* pSample, uint32_t crc) {
3336            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
3337            if (!_3crc) return;
3338    
3339            // get the index of the sample
3340            int iWaveIndex = -1;
3341            File::SampleList::iterator iter = pSamples->begin();
3342            File::SampleList::iterator end  = pSamples->end();
3343            for (int index = 0; iter != end; ++iter, ++index) {
3344                if (*iter == pSample) {
3345                    iWaveIndex = index;
3346                    break;
3347                }
3348            }
3349            if (iWaveIndex < 0) throw gig::Exception("Could not update crc, could not find sample");
3350    
3351            // write the CRC-32 checksum to disk
3352            _3crc->SetPos(iWaveIndex * 8);
3353            uint32_t tmp = 1;
3354            _3crc->WriteUint32(&tmp); // unknown, always 1?
3355            _3crc->WriteUint32(&crc);
3356        }
3357    
3358        Group* File::GetFirstGroup() {
3359            if (!pGroups) LoadGroups();
3360            // there must always be at least one group
3361            GroupsIterator = pGroups->begin();
3362            return *GroupsIterator;
3363        }
3364    
3365        Group* File::GetNextGroup() {
3366            if (!pGroups) return NULL;
3367            ++GroupsIterator;
3368            return (GroupsIterator == pGroups->end()) ? NULL : *GroupsIterator;
3369        }
3370    
3371        /**
3372         * Returns the group with the given index.
3373         *
3374         * @param index - number of the sought group (0..n)
3375         * @returns sought group or NULL if there's no such group
3376         */
3377        Group* File::GetGroup(uint index) {
3378            if (!pGroups) LoadGroups();
3379            GroupsIterator = pGroups->begin();
3380            for (uint i = 0; GroupsIterator != pGroups->end(); i++) {
3381                if (i == index) return *GroupsIterator;
3382                ++GroupsIterator;
3383            }
3384            return NULL;
3385        }
3386    
3387        Group* File::AddGroup() {
3388            if (!pGroups) LoadGroups();
3389            // there must always be at least one group
3390            __ensureMandatoryChunksExist();
3391            Group* pGroup = new Group(this, NULL);
3392            pGroups->push_back(pGroup);
3393            return pGroup;
3394        }
3395    
3396        /** @brief Delete a group and its samples.
3397         *
3398         * This will delete the given Group object and all the samples that
3399         * belong to this group from the gig file. You have to call Save() to
3400         * make this persistent to the file.
3401         *
3402         * @param pGroup - group to delete
3403         * @throws gig::Exception if given group could not be found
3404         */
3405        void File::DeleteGroup(Group* pGroup) {
3406            if (!pGroups) LoadGroups();
3407            std::list<Group*>::iterator iter = find(pGroups->begin(), pGroups->end(), pGroup);
3408            if (iter == pGroups->end()) throw gig::Exception("Could not delete group, could not find given group");
3409            if (pGroups->size() == 1) throw gig::Exception("Cannot delete group, there must be at least one default group!");
3410            // delete all members of this group
3411            for (Sample* pSample = pGroup->GetFirstSample(); pSample; pSample = pGroup->GetNextSample()) {
3412                DeleteSample(pSample);
3413            }
3414            // now delete this group object
3415            pGroups->erase(iter);
3416            delete pGroup;
3417        }
3418    
3419        /** @brief Delete a group.
3420         *
3421         * This will delete the given Group object from the gig file. All the
3422         * samples that belong to this group will not be deleted, but instead
3423         * be moved to another group. You have to call Save() to make this
3424         * persistent to the file.
3425         *
3426         * @param pGroup - group to delete
3427         * @throws gig::Exception if given group could not be found
3428         */
3429        void File::DeleteGroupOnly(Group* pGroup) {
3430            if (!pGroups) LoadGroups();
3431            std::list<Group*>::iterator iter = find(pGroups->begin(), pGroups->end(), pGroup);
3432            if (iter == pGroups->end()) throw gig::Exception("Could not delete group, could not find given group");
3433            if (pGroups->size() == 1) throw gig::Exception("Cannot delete group, there must be at least one default group!");
3434            // move all members of this group to another group
3435            pGroup->MoveAll();
3436            pGroups->erase(iter);
3437            delete pGroup;
3438        }
3439    
3440        void File::LoadGroups() {
3441            if (!pGroups) pGroups = new std::list<Group*>;
3442            // try to read defined groups from file
3443            RIFF::List* lst3gri = pRIFF->GetSubList(LIST_TYPE_3GRI);
3444            if (lst3gri) {
3445                RIFF::List* lst3gnl = lst3gri->GetSubList(LIST_TYPE_3GNL);
3446                if (lst3gnl) {
3447                    RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();
3448                    while (ck) {
3449                        if (ck->GetChunkID() == CHUNK_ID_3GNM) {
3450                            if (pVersion && pVersion->major == 3 &&
3451                                strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) break;
3452    
3453                            pGroups->push_back(new Group(this, ck));
3454                        }
3455                        ck = lst3gnl->GetNextSubChunk();
3456                    }
3457                }
3458            }
3459            // if there were no group(s), create at least the mandatory default group
3460            if (!pGroups->size()) {
3461                Group* pGroup = new Group(this, NULL);
3462                pGroup->Name = "Default Group";
3463                pGroups->push_back(pGroup);
3464            }
3465        }
3466    
3467        /**
3468         * Apply all the gig file's current instruments, samples, groups and settings
3469         * to the respective RIFF chunks. You have to call Save() to make changes
3470         * persistent.
3471         *
3472         * Usually there is absolutely no need to call this method explicitly.
3473         * It will be called automatically when File::Save() was called.
3474         *
3475         * @throws Exception - on errors
3476         */
3477        void File::UpdateChunks() {
3478            bool newFile = pRIFF->GetSubList(LIST_TYPE_INFO) == NULL;
3479    
3480            b64BitWavePoolOffsets = pVersion && pVersion->major == 3;
3481    
3482            // first update base class's chunks
3483            DLS::File::UpdateChunks();
3484    
3485            if (newFile) {
3486                // INFO was added by Resource::UpdateChunks - make sure it
3487                // is placed first in file
3488                RIFF::Chunk* info = pRIFF->GetSubList(LIST_TYPE_INFO);
3489                RIFF::Chunk* first = pRIFF->GetFirstSubChunk();
3490                if (first != info) {
3491                    pRIFF->MoveSubChunk(info, first);
3492                }
3493            }
3494    
3495            // update group's chunks
3496            if (pGroups) {
3497                std::list<Group*>::iterator iter = pGroups->begin();
3498                std::list<Group*>::iterator end  = pGroups->end();
3499                for (; iter != end; ++iter) {
3500                    (*iter)->UpdateChunks();
3501                }
3502    
3503                // v3: make sure the file has 128 3gnm chunks
3504                if (pVersion && pVersion->major == 3) {
3505                    RIFF::List* _3gnl = pRIFF->GetSubList(LIST_TYPE_3GRI)->GetSubList(LIST_TYPE_3GNL);
3506                    RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();
3507                    for (int i = 0 ; i < 128 ; i++) {
3508                        if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);
3509                        if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();
3510                    }
3511                }
3512            }
3513    
3514            // update einf chunk
3515    
3516            // The einf chunk contains statistics about the gig file, such
3517            // as the number of regions and samples used by each
3518            // instrument. It is divided in equally sized parts, where the
3519            // first part contains information about the whole gig file,
3520            // and the rest of the parts map to each instrument in the
3521            // file.
3522            //
3523            // At the end of each part there is a bit map of each sample
3524            // in the file, where a set bit means that the sample is used
3525            // by the file/instrument.
3526            //
3527            // Note that there are several fields with unknown use. These
3528            // are set to zero.
3529    
3530            int sublen = pSamples->size() / 8 + 49;
3531            int einfSize = (Instruments + 1) * sublen;
3532    
3533            RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
3534            if (einf) {
3535                if (einf->GetSize() != einfSize) {
3536                    einf->Resize(einfSize);
3537                    memset(einf->LoadChunkData(), 0, einfSize);
3538                }
3539            } else if (newFile) {
3540                einf = pRIFF->AddSubChunk(CHUNK_ID_EINF, einfSize);
3541            }
3542            if (einf) {
3543                uint8_t* pData = (uint8_t*) einf->LoadChunkData();
3544    
3545                std::map<gig::Sample*,int> sampleMap;
3546                int sampleIdx = 0;
3547                for (Sample* pSample = GetFirstSample(); pSample; pSample = GetNextSample()) {
3548                    sampleMap[pSample] = sampleIdx++;
3549                }
3550    
3551                int totnbusedsamples = 0;
3552                int totnbusedchannels = 0;
3553                int totnbregions = 0;
3554                int totnbdimregions = 0;
3555                int totnbloops = 0;
3556                int instrumentIdx = 0;
3557    
3558                memset(&pData[48], 0, sublen - 48);
3559    
3560                for (Instrument* instrument = GetFirstInstrument() ; instrument ;
3561                     instrument = GetNextInstrument()) {
3562                    int nbusedsamples = 0;
3563                    int nbusedchannels = 0;
3564                    int nbdimregions = 0;
3565                    int nbloops = 0;
3566    
3567                    memset(&pData[(instrumentIdx + 1) * sublen + 48], 0, sublen - 48);
3568    
3569                    for (Region* region = instrument->GetFirstRegion() ; region ;
3570                         region = instrument->GetNextRegion()) {
3571                        for (int i = 0 ; i < region->DimensionRegions ; i++) {
3572                            gig::DimensionRegion *d = region->pDimensionRegions[i];
3573                            if (d->pSample) {
3574                                int sampleIdx = sampleMap[d->pSample];
3575                                int byte = 48 + sampleIdx / 8;
3576                                int bit = 1 << (sampleIdx & 7);
3577                                if ((pData[(instrumentIdx + 1) * sublen + byte] & bit) == 0) {
3578                                    pData[(instrumentIdx + 1) * sublen + byte] |= bit;
3579                                    nbusedsamples++;
3580                                    nbusedchannels += d->pSample->Channels;
3581    
3582                                    if ((pData[byte] & bit) == 0) {
3583                                        pData[byte] |= bit;
3584                                        totnbusedsamples++;
3585                                        totnbusedchannels += d->pSample->Channels;
3586                                    }
3587                                }
3588                            }
3589                            if (d->SampleLoops) nbloops++;
3590                        }
3591                        nbdimregions += region->DimensionRegions;
3592                    }
3593                    // first 4 bytes unknown - sometimes 0, sometimes length of einf part
3594                    // store32(&pData[(instrumentIdx + 1) * sublen], sublen);
3595                    store32(&pData[(instrumentIdx + 1) * sublen + 4], nbusedchannels);
3596                    store32(&pData[(instrumentIdx + 1) * sublen + 8], nbusedsamples);
3597                    store32(&pData[(instrumentIdx + 1) * sublen + 12], 1);
3598                    store32(&pData[(instrumentIdx + 1) * sublen + 16], instrument->Regions);
3599                    store32(&pData[(instrumentIdx + 1) * sublen + 20], nbdimregions);
3600                    store32(&pData[(instrumentIdx + 1) * sublen + 24], nbloops);
3601                    // next 8 bytes unknown
3602                    store32(&pData[(instrumentIdx + 1) * sublen + 36], instrumentIdx);
3603                    store32(&pData[(instrumentIdx + 1) * sublen + 40], pSamples->size());
3604                    // next 4 bytes unknown
3605    
3606                    totnbregions += instrument->Regions;
3607                    totnbdimregions += nbdimregions;
3608                    totnbloops += nbloops;
3609                    instrumentIdx++;
3610                }
3611                // first 4 bytes unknown - sometimes 0, sometimes length of einf part
3612                // store32(&pData[0], sublen);
3613                store32(&pData[4], totnbusedchannels);
3614                store32(&pData[8], totnbusedsamples);
3615                store32(&pData[12], Instruments);
3616                store32(&pData[16], totnbregions);
3617                store32(&pData[20], totnbdimregions);
3618                store32(&pData[24], totnbloops);
3619                // next 8 bytes unknown
3620                // next 4 bytes unknown, not always 0
3621                store32(&pData[40], pSamples->size());
3622                // next 4 bytes unknown
3623            }
3624    
3625            // update 3crc chunk
3626    
3627            // The 3crc chunk contains CRC-32 checksums for the
3628            // samples. The actual checksum values will be filled in
3629            // later, by Sample::Write.
3630    
3631            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
3632            if (_3crc) {
3633                _3crc->Resize(pSamples->size() * 8);
3634            } else if (newFile) {
3635                _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
3636                _3crc->LoadChunkData();
3637    
3638                // the order of einf and 3crc is not the same in v2 and v3
3639                if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);
3640          }          }
         else throw gig::Exception("Mandatory <lins> list chunk not found.");  
3641      }      }
3642    
3643    
# Line 1503  namespace gig { Line 3652  namespace gig {
3652          std::cout << "gig::Exception: " << Message << std::endl;          std::cout << "gig::Exception: " << Message << std::endl;
3653      }      }
3654    
3655    
3656    // *************** functions ***************
3657    // *
3658    
3659        /**
3660         * Returns the name of this C++ library. This is usually "libgig" of
3661         * course. This call is equivalent to RIFF::libraryName() and
3662         * DLS::libraryName().
3663         */
3664        String libraryName() {
3665            return PACKAGE;
3666        }
3667    
3668        /**
3669         * Returns version of this C++ library. This call is equivalent to
3670         * RIFF::libraryVersion() and DLS::libraryVersion().
3671         */
3672        String libraryVersion() {
3673            return VERSION;
3674        }
3675    
3676  } // namespace gig  } // namespace gig

Legend:
Removed from v.352  
changed lines
  Added in v.1266

  ViewVC Help
Powered by ViewVC