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

Legend:
Removed from v.241  
changed lines
  Added in v.1247

  ViewVC Help
Powered by ViewVC