/[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 2 by schoenebeck, Sat Oct 25 20:15:04 2003 UTC revision 666 by persson, Sun Jun 19 15:18:59 2005 UTC
# Line 2  Line 2 
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file loader library    *   *   libgig - C++ cross-platform Gigasampler format file loader library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003 by Christian Schoenebeck                           *   *   Copyright (C) 2003-2005 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 <iostream>
27    
28  namespace gig {  namespace gig {
29    
30    // *************** progress_t ***************
31    // *
32    
33        progress_t::progress_t() {
34            callback    = NULL;
35            custom      = NULL;
36            __range_min = 0.0f;
37            __range_max = 1.0f;
38        }
39    
40        // private helper function to convert progress of a subprocess into the global progress
41        static void __notify_progress(progress_t* pProgress, float subprogress) {
42            if (pProgress && pProgress->callback) {
43                const float totalrange    = pProgress->__range_max - pProgress->__range_min;
44                const float totalprogress = pProgress->__range_min + subprogress * totalrange;
45                pProgress->factor         = totalprogress;
46                pProgress->callback(pProgress); // now actually notify about the progress
47            }
48        }
49    
50        // private helper function to divide a progress into subprogresses
51        static void __divide_progress(progress_t* pParentProgress, progress_t* pSubProgress, float totalTasks, float currentTask) {
52            if (pParentProgress && pParentProgress->callback) {
53                const float totalrange    = pParentProgress->__range_max - pParentProgress->__range_min;
54                pSubProgress->callback    = pParentProgress->callback;
55                pSubProgress->custom      = pParentProgress->custom;
56                pSubProgress->__range_min = pParentProgress->__range_min + totalrange * currentTask / totalTasks;
57                pSubProgress->__range_max = pSubProgress->__range_min + totalrange / totalTasks;
58            }
59        }
60    
61    
62    // *************** Internal functions for sample decopmression ***************
63    // *
64    
65    namespace {
66    
67        inline int get12lo(const unsigned char* pSrc)
68        {
69            const int x = pSrc[0] | (pSrc[1] & 0x0f) << 8;
70            return x & 0x800 ? x - 0x1000 : x;
71        }
72    
73        inline int get12hi(const unsigned char* pSrc)
74        {
75            const int x = pSrc[1] >> 4 | pSrc[2] << 4;
76            return x & 0x800 ? x - 0x1000 : x;
77        }
78    
79        inline int16_t get16(const unsigned char* pSrc)
80        {
81            return int16_t(pSrc[0] | pSrc[1] << 8);
82        }
83    
84        inline int get24(const unsigned char* pSrc)
85        {
86            const int x = pSrc[0] | pSrc[1] << 8 | pSrc[2] << 16;
87            return x & 0x800000 ? x - 0x1000000 : x;
88        }
89    
90        void Decompress16(int compressionmode, const unsigned char* params,
91                          int srcStep, int dstStep,
92                          const unsigned char* pSrc, int16_t* pDst,
93                          unsigned long currentframeoffset,
94                          unsigned long copysamples)
95        {
96            switch (compressionmode) {
97                case 0: // 16 bit uncompressed
98                    pSrc += currentframeoffset * srcStep;
99                    while (copysamples) {
100                        *pDst = get16(pSrc);
101                        pDst += dstStep;
102                        pSrc += srcStep;
103                        copysamples--;
104                    }
105                    break;
106    
107                case 1: // 16 bit compressed to 8 bit
108                    int y  = get16(params);
109                    int dy = get16(params + 2);
110                    while (currentframeoffset) {
111                        dy -= int8_t(*pSrc);
112                        y  -= dy;
113                        pSrc += srcStep;
114                        currentframeoffset--;
115                    }
116                    while (copysamples) {
117                        dy -= int8_t(*pSrc);
118                        y  -= dy;
119                        *pDst = y;
120                        pDst += dstStep;
121                        pSrc += srcStep;
122                        copysamples--;
123                    }
124                    break;
125            }
126        }
127    
128        void Decompress24(int compressionmode, const unsigned char* params,
129                          int dstStep, const unsigned char* pSrc, int16_t* pDst,
130                          unsigned long currentframeoffset,
131                          unsigned long copysamples, int truncatedBits)
132        {
133            // Note: The 24 bits are truncated to 16 bits for now.
134    
135            // Note: The calculation of the initial value of y is strange
136            // and not 100% correct. What should the first two parameters
137            // really be used for? Why are they two? The correct value for
138            // y seems to lie somewhere between the values of the first
139            // two parameters.
140            //
141            // Strange thing #2: The formula in SKIP_ONE gives values for
142            // y that are twice as high as they should be. That's why
143            // COPY_ONE shifts an extra step, and also why y is
144            // initialized with a sum instead of a mean value.
145    
146            int y, dy, ddy;
147    
148            const int shift = 8 - truncatedBits;
149            const int shift1 = shift + 1;
150    
151    #define GET_PARAMS(params)                              \
152            y = (get24(params) + get24((params) + 3));      \
153            dy  = get24((params) + 6);                      \
154            ddy = get24((params) + 9)
155    
156    #define SKIP_ONE(x)                             \
157            ddy -= (x);                             \
158            dy -= ddy;                              \
159            y -= dy
160    
161    #define COPY_ONE(x)                             \
162            SKIP_ONE(x);                            \
163            *pDst = y >> shift1;                    \
164            pDst += dstStep
165    
166            switch (compressionmode) {
167                case 2: // 24 bit uncompressed
168                    pSrc += currentframeoffset * 3;
169                    while (copysamples) {
170                        *pDst = get24(pSrc) >> shift;
171                        pDst += dstStep;
172                        pSrc += 3;
173                        copysamples--;
174                    }
175                    break;
176    
177                case 3: // 24 bit compressed to 16 bit
178                    GET_PARAMS(params);
179                    while (currentframeoffset) {
180                        SKIP_ONE(get16(pSrc));
181                        pSrc += 2;
182                        currentframeoffset--;
183                    }
184                    while (copysamples) {
185                        COPY_ONE(get16(pSrc));
186                        pSrc += 2;
187                        copysamples--;
188                    }
189                    break;
190    
191                case 4: // 24 bit compressed to 12 bit
192                    GET_PARAMS(params);
193                    while (currentframeoffset > 1) {
194                        SKIP_ONE(get12lo(pSrc));
195                        SKIP_ONE(get12hi(pSrc));
196                        pSrc += 3;
197                        currentframeoffset -= 2;
198                    }
199                    if (currentframeoffset) {
200                        SKIP_ONE(get12lo(pSrc));
201                        currentframeoffset--;
202                        if (copysamples) {
203                            COPY_ONE(get12hi(pSrc));
204                            pSrc += 3;
205                            copysamples--;
206                        }
207                    }
208                    while (copysamples > 1) {
209                        COPY_ONE(get12lo(pSrc));
210                        COPY_ONE(get12hi(pSrc));
211                        pSrc += 3;
212                        copysamples -= 2;
213                    }
214                    if (copysamples) {
215                        COPY_ONE(get12lo(pSrc));
216                    }
217                    break;
218    
219                case 5: // 24 bit compressed to 8 bit
220                    GET_PARAMS(params);
221                    while (currentframeoffset) {
222                        SKIP_ONE(int8_t(*pSrc++));
223                        currentframeoffset--;
224                    }
225                    while (copysamples) {
226                        COPY_ONE(int8_t(*pSrc++));
227                        copysamples--;
228                    }
229                    break;
230            }
231        }
232    
233        const int bytesPerFrame[] =      { 4096, 2052, 768, 524, 396, 268 };
234        const int bytesPerFrameNoHdr[] = { 4096, 2048, 768, 512, 384, 256 };
235        const int headerSize[] =         { 0, 4, 0, 12, 12, 12 };
236        const int bitsPerSample[] =      { 16, 8, 24, 16, 12, 8 };
237    }
238    
239    
240  // *************** Sample ***************  // *************** Sample ***************
241  // *  // *
242    
243      unsigned int  Sample::Instances               = 0;      unsigned int Sample::Instances = 0;
244      void*         Sample::pDecompressionBuffer    = NULL;      buffer_t     Sample::InternalDecompressionBuffer;
     unsigned long Sample::DecompressionBufferSize = 0;  
245    
246      Sample::Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {      Sample::Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {
247          Instances++;          Instances++;
248            FileNo = fileNo;
249    
250          RIFF::Chunk* _3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);          RIFF::Chunk* _3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);
251          if (!_3gix) throw gig::Exception("Mandatory chunks in <wave> list chunk not found.");          if (!_3gix) throw gig::Exception("Mandatory chunks in <wave> list chunk not found.");
# Line 45  namespace gig { Line 257  namespace gig {
257          Product           = smpl->ReadInt32();          Product           = smpl->ReadInt32();
258          SamplePeriod      = smpl->ReadInt32();          SamplePeriod      = smpl->ReadInt32();
259          MIDIUnityNote     = smpl->ReadInt32();          MIDIUnityNote     = smpl->ReadInt32();
260          MIDIPitchFraction = smpl->ReadInt32();          FineTune          = smpl->ReadInt32();
261          smpl->Read(&SMPTEFormat, 1, 4);          smpl->Read(&SMPTEFormat, 1, 4);
262          SMPTEOffset       = smpl->ReadInt32();          SMPTEOffset       = smpl->ReadInt32();
263          Loops             = smpl->ReadInt32();          Loops             = smpl->ReadInt32();
264            smpl->ReadInt32(); // manufByt
265          LoopID            = smpl->ReadInt32();          LoopID            = smpl->ReadInt32();
266          smpl->Read(&LoopType, 1, 4);          smpl->Read(&LoopType, 1, 4);
267          LoopStart         = smpl->ReadInt32();          LoopStart         = smpl->ReadInt32();
# Line 62  namespace gig { Line 275  namespace gig {
275          RAMCache.pStart            = NULL;          RAMCache.pStart            = NULL;
276          RAMCache.NullExtensionSize = 0;          RAMCache.NullExtensionSize = 0;
277    
278          Compressed = (waveList->GetSubChunk(CHUNK_ID_EWAV));          if (BitDepth > 24) throw gig::Exception("Only samples up to 24 bit supported");
279    
280            RIFF::Chunk* ewav = waveList->GetSubChunk(CHUNK_ID_EWAV);
281            Compressed        = ewav;
282            Dithered          = false;
283            TruncatedBits     = 0;
284          if (Compressed) {          if (Compressed) {
285              ScanCompressedSample();              uint32_t version = ewav->ReadInt32();
286              if (!pDecompressionBuffer) {              if (version == 3 && BitDepth == 24) {
287                  pDecompressionBuffer    = new int8_t[INITIAL_SAMPLE_BUFFER_SIZE];                  Dithered = ewav->ReadInt32();
288                  DecompressionBufferSize = INITIAL_SAMPLE_BUFFER_SIZE;                  ewav->SetPos(Channels == 2 ? 84 : 64);
289                    TruncatedBits = ewav->ReadInt32();
290              }              }
291                ScanCompressedSample();
292            }
293    
294            // we use a buffer for decompression and for truncating 24 bit samples to 16 bit
295            if ((Compressed || BitDepth == 24) && !InternalDecompressionBuffer.Size) {
296                InternalDecompressionBuffer.pStart = new unsigned char[INITIAL_SAMPLE_BUFFER_SIZE];
297                InternalDecompressionBuffer.Size   = INITIAL_SAMPLE_BUFFER_SIZE;
298          }          }
299          FrameOffset = 0; // just for streaming compressed samples          FrameOffset = 0; // just for streaming compressed samples
300    
301            LoopSize = LoopEnd - LoopStart;
302      }      }
303    
304      /// 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 79  namespace gig { Line 307  namespace gig {
307          this->SamplesTotal = 0;          this->SamplesTotal = 0;
308          std::list<unsigned long> frameOffsets;          std::list<unsigned long> frameOffsets;
309    
310            SamplesPerFrame = BitDepth == 24 ? 256 : 2048;
311            WorstCaseFrameSize = SamplesPerFrame * FrameSize + Channels; // +Channels for compression flag
312    
313          // Scanning          // Scanning
314          pCkData->SetPos(0);          pCkData->SetPos(0);
315          while (pCkData->GetState() == RIFF::stream_ready) {          if (Channels == 2) { // Stereo
316              frameOffsets.push_back(pCkData->GetPos());              for (int i = 0 ; ; i++) {
317              int16_t compressionmode = pCkData->ReadInt16();                  // for 24 bit samples every 8:th frame offset is
318              this->SamplesTotal += 2048;                  // stored, to save some memory
319              switch (compressionmode) {                  if (BitDepth != 24 || (i & 7) == 0) frameOffsets.push_back(pCkData->GetPos());
320                  case 1:   // left channel compressed  
321                  case 256: // right channel compressed                  const int mode_l = pCkData->ReadUint8();
322                      pCkData->SetPos(6148, RIFF::stream_curpos);                  const int mode_r = pCkData->ReadUint8();
323                    if (mode_l > 5 || mode_r > 5) throw gig::Exception("Unknown compression mode");
324                    const unsigned long frameSize = bytesPerFrame[mode_l] + bytesPerFrame[mode_r];
325    
326                    if (pCkData->RemainingBytes() <= frameSize) {
327                        SamplesInLastFrame =
328                            ((pCkData->RemainingBytes() - headerSize[mode_l] - headerSize[mode_r]) << 3) /
329                            (bitsPerSample[mode_l] + bitsPerSample[mode_r]);
330                        SamplesTotal += SamplesInLastFrame;
331                      break;                      break;
332                  case 257: // both channels compressed                  }
333                      pCkData->SetPos(4104, RIFF::stream_curpos);                  SamplesTotal += SamplesPerFrame;
334                    pCkData->SetPos(frameSize, RIFF::stream_curpos);
335                }
336            }
337            else { // Mono
338                for (int i = 0 ; ; i++) {
339                    if (BitDepth != 24 || (i & 7) == 0) frameOffsets.push_back(pCkData->GetPos());
340    
341                    const int mode = pCkData->ReadUint8();
342                    if (mode > 5) throw gig::Exception("Unknown compression mode");
343                    const unsigned long frameSize = bytesPerFrame[mode];
344    
345                    if (pCkData->RemainingBytes() <= frameSize) {
346                        SamplesInLastFrame =
347                            ((pCkData->RemainingBytes() - headerSize[mode]) << 3) / bitsPerSample[mode];
348                        SamplesTotal += SamplesInLastFrame;
349                      break;                      break;
350                  default: // both channels uncompressed                  }
351                      pCkData->SetPos(8192, RIFF::stream_curpos);                  SamplesTotal += SamplesPerFrame;
352                    pCkData->SetPos(frameSize, RIFF::stream_curpos);
353              }              }
354          }          }
355          pCkData->SetPos(0);          pCkData->SetPos(0);
356    
         //FIXME: only seen compressed samples with 16 bit stereo so far  
         this->FrameSize = 4;  
         this->BitDepth  = 16;  
   
357          // 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)
358          if (FrameTable) delete[] FrameTable;          if (FrameTable) delete[] FrameTable;
359          FrameTable = new unsigned long[frameOffsets.size()];          FrameTable = new unsigned long[frameOffsets.size()];
# Line 138  namespace gig { Line 389  namespace gig {
389       * that will be returned to determine the actual cached samples, but note       * that will be returned to determine the actual cached samples, but note
390       * 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
391       * samples by dividing it by the frame size of the sample:       * samples by dividing it by the frame size of the sample:
392       *       * @code
393       *  buffer_t buf       = pSample->LoadSampleData(acquired_samples);       *  buffer_t buf       = pSample->LoadSampleData(acquired_samples);
394       *  long cachedsamples = buf.Size / pSample->FrameSize;       *  long cachedsamples = buf.Size / pSample->FrameSize;
395         * @endcode
396       *       *
397       * @param SampleCount - number of sample points to load into RAM       * @param SampleCount - number of sample points to load into RAM
398       * @returns             buffer_t structure with start address and size of       * @returns             buffer_t structure with start address and size of
# Line 186  namespace gig { Line 438  namespace gig {
438       * that will be returned to determine the actual cached samples, but note       * that will be returned to determine the actual cached samples, but note
439       * 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
440       * samples by dividing it by the frame size of the sample:       * samples by dividing it by the frame size of the sample:
441       *       * @code
442       *  buffer_t buf       = pSample->LoadSampleDataWithNullSamplesExtension(acquired_samples, null_samples);       *  buffer_t buf       = pSample->LoadSampleDataWithNullSamplesExtension(acquired_samples, null_samples);
443       *  long cachedsamples = buf.Size / pSample->FrameSize;       *  long cachedsamples = buf.Size / pSample->FrameSize;
444       *       * @endcode
445       * The method will add \a NullSamplesCount silence samples past the       * The method will add \a NullSamplesCount silence samples past the
446       * official buffer end (this won't affect the 'Size' member of the       * official buffer end (this won't affect the 'Size' member of the
447       * 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 310  namespace gig { Line 562  namespace gig {
562      }      }
563    
564      /**      /**
565         * Reads \a SampleCount number of sample points from the position stored
566         * in \a pPlaybackState into the buffer pointed by \a pBuffer and moves
567         * the position within the sample respectively, this method honors the
568         * looping informations of the sample (if any). The sample wave stream
569         * will be decompressed on the fly if using a compressed sample. Use this
570         * method if you don't want to load the sample into RAM, thus for disk
571         * streaming. All this methods needs to know to proceed with streaming
572         * for the next time you call this method is stored in \a pPlaybackState.
573         * You have to allocate and initialize the playback_state_t structure by
574         * yourself before you use it to stream a sample:
575         * @code
576         * gig::playback_state_t playbackstate;
577         * playbackstate.position         = 0;
578         * playbackstate.reverse          = false;
579         * playbackstate.loop_cycles_left = pSample->LoopPlayCount;
580         * @endcode
581         * You don't have to take care of things like if there is actually a loop
582         * defined or if the current read position is located within a loop area.
583         * The method already handles such cases by itself.
584         *
585         * <b>Caution:</b> If you are using more than one streaming thread, you
586         * have to use an external decompression buffer for <b>EACH</b>
587         * streaming thread to avoid race conditions and crashes!
588         *
589         * @param pBuffer          destination buffer
590         * @param SampleCount      number of sample points to read
591         * @param pPlaybackState   will be used to store and reload the playback
592         *                         state for the next ReadAndLoop() call
593         * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression
594         * @returns                number of successfully read sample points
595         * @see                    CreateDecompressionBuffer()
596         */
597        unsigned long Sample::ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState, buffer_t* pExternalDecompressionBuffer) {
598            unsigned long samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;
599            uint8_t* pDst = (uint8_t*) pBuffer;
600    
601            SetPos(pPlaybackState->position); // recover position from the last time
602    
603            if (this->Loops && GetPos() <= this->LoopEnd) { // honor looping if there are loop points defined
604    
605                switch (this->LoopType) {
606    
607                    case loop_type_bidirectional: { //TODO: not tested yet!
608                        do {
609                            // if not endless loop check if max. number of loop cycles have been passed
610                            if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
611    
612                            if (!pPlaybackState->reverse) { // forward playback
613                                do {
614                                    samplestoloopend  = this->LoopEnd - GetPos();
615                                    readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
616                                    samplestoread    -= readsamples;
617                                    totalreadsamples += readsamples;
618                                    if (readsamples == samplestoloopend) {
619                                        pPlaybackState->reverse = true;
620                                        break;
621                                    }
622                                } while (samplestoread && readsamples);
623                            }
624                            else { // backward playback
625    
626                                // as we can only read forward from disk, we have to
627                                // determine the end position within the loop first,
628                                // read forward from that 'end' and finally after
629                                // reading, swap all sample frames so it reflects
630                                // backward playback
631    
632                                unsigned long swapareastart       = totalreadsamples;
633                                unsigned long loopoffset          = GetPos() - this->LoopStart;
634                                unsigned long samplestoreadinloop = Min(samplestoread, loopoffset);
635                                unsigned long reverseplaybackend  = GetPos() - samplestoreadinloop;
636    
637                                SetPos(reverseplaybackend);
638    
639                                // read samples for backward playback
640                                do {
641                                    readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], samplestoreadinloop, pExternalDecompressionBuffer);
642                                    samplestoreadinloop -= readsamples;
643                                    samplestoread       -= readsamples;
644                                    totalreadsamples    += readsamples;
645                                } while (samplestoreadinloop && readsamples);
646    
647                                SetPos(reverseplaybackend); // pretend we really read backwards
648    
649                                if (reverseplaybackend == this->LoopStart) {
650                                    pPlaybackState->loop_cycles_left--;
651                                    pPlaybackState->reverse = false;
652                                }
653    
654                                // reverse the sample frames for backward playback
655                                SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
656                            }
657                        } while (samplestoread && readsamples);
658                        break;
659                    }
660    
661                    case loop_type_backward: { // TODO: not tested yet!
662                        // forward playback (not entered the loop yet)
663                        if (!pPlaybackState->reverse) do {
664                            samplestoloopend  = this->LoopEnd - GetPos();
665                            readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
666                            samplestoread    -= readsamples;
667                            totalreadsamples += readsamples;
668                            if (readsamples == samplestoloopend) {
669                                pPlaybackState->reverse = true;
670                                break;
671                            }
672                        } while (samplestoread && readsamples);
673    
674                        if (!samplestoread) break;
675    
676                        // as we can only read forward from disk, we have to
677                        // determine the end position within the loop first,
678                        // read forward from that 'end' and finally after
679                        // reading, swap all sample frames so it reflects
680                        // backward playback
681    
682                        unsigned long swapareastart       = totalreadsamples;
683                        unsigned long loopoffset          = GetPos() - this->LoopStart;
684                        unsigned long samplestoreadinloop = (this->LoopPlayCount) ? Min(samplestoread, pPlaybackState->loop_cycles_left * LoopSize - loopoffset)
685                                                                                  : samplestoread;
686                        unsigned long reverseplaybackend  = this->LoopStart + Abs((loopoffset - samplestoreadinloop) % this->LoopSize);
687    
688                        SetPos(reverseplaybackend);
689    
690                        // read samples for backward playback
691                        do {
692                            // if not endless loop check if max. number of loop cycles have been passed
693                            if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
694                            samplestoloopend     = this->LoopEnd - GetPos();
695                            readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoreadinloop, samplestoloopend), pExternalDecompressionBuffer);
696                            samplestoreadinloop -= readsamples;
697                            samplestoread       -= readsamples;
698                            totalreadsamples    += readsamples;
699                            if (readsamples == samplestoloopend) {
700                                pPlaybackState->loop_cycles_left--;
701                                SetPos(this->LoopStart);
702                            }
703                        } while (samplestoreadinloop && readsamples);
704    
705                        SetPos(reverseplaybackend); // pretend we really read backwards
706    
707                        // reverse the sample frames for backward playback
708                        SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
709                        break;
710                    }
711    
712                    default: case loop_type_normal: {
713                        do {
714                            // if not endless loop check if max. number of loop cycles have been passed
715                            if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
716                            samplestoloopend  = this->LoopEnd - GetPos();
717                            readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
718                            samplestoread    -= readsamples;
719                            totalreadsamples += readsamples;
720                            if (readsamples == samplestoloopend) {
721                                pPlaybackState->loop_cycles_left--;
722                                SetPos(this->LoopStart);
723                            }
724                        } while (samplestoread && readsamples);
725                        break;
726                    }
727                }
728            }
729    
730            // read on without looping
731            if (samplestoread) do {
732                readsamples = Read(&pDst[totalreadsamples * this->FrameSize], samplestoread, pExternalDecompressionBuffer);
733                samplestoread    -= readsamples;
734                totalreadsamples += readsamples;
735            } while (readsamples && samplestoread);
736    
737            // store current position
738            pPlaybackState->position = GetPos();
739    
740            return totalreadsamples;
741        }
742    
743        /**
744       * Reads \a SampleCount number of sample points from the current       * Reads \a SampleCount number of sample points from the current
745       * position into the buffer pointed by \a pBuffer and increments the       * position into the buffer pointed by \a pBuffer and increments the
746       * position within the sample. The sample wave stream will be       * position within the sample. The sample wave stream will be
# Line 317  namespace gig { Line 748  namespace gig {
748       * 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,
749       * thus for disk streaming.       * thus for disk streaming.
750       *       *
751         * <b>Caution:</b> If you are using more than one streaming thread, you
752         * have to use an external decompression buffer for <b>EACH</b>
753         * streaming thread to avoid race conditions and crashes!
754         *
755       * @param pBuffer      destination buffer       * @param pBuffer      destination buffer
756       * @param SampleCount  number of sample points to read       * @param SampleCount  number of sample points to read
757         * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression
758       * @returns            number of successfully read sample points       * @returns            number of successfully read sample points
759       * @see                SetPos()       * @see                SetPos(), CreateDecompressionBuffer()
760       */       */
761      unsigned long Sample::Read(void* pBuffer, unsigned long SampleCount) {      unsigned long Sample::Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer) {
762          if (!Compressed) return pCkData->Read(pBuffer, SampleCount, FrameSize);          if (SampleCount == 0) return 0;
763          else { //FIXME: no support for mono compressed samples yet, are there any?          if (!Compressed) {
764              //TODO: efficiency: we simply assume here that all frames are compressed, maybe we should test for an average compression rate              if (BitDepth == 24) {
765              // best case needed buffer size (all frames compressed)                  // 24 bit sample. For now just truncate to 16 bit.
766              unsigned long assumedsize      = (SampleCount << 1)  + // *2 (16 Bit, stereo, but assume all frames compressed)                  unsigned char* pSrc = (unsigned char*) ((pExternalDecompressionBuffer) ? pExternalDecompressionBuffer->pStart : this->InternalDecompressionBuffer.pStart);
767                                               (SampleCount >> 10) + // 10 bytes header per 2048 sample points                  int16_t* pDst = static_cast<int16_t*>(pBuffer);
768                                               8194,                 // at least one worst case sample frame                  if (Channels == 2) { // Stereo
769                        unsigned long readBytes = pCkData->Read(pSrc, SampleCount * 6, 1);
770                        pSrc++;
771                        for (unsigned long i = readBytes ; i > 0 ; i -= 3) {
772                            *pDst++ = get16(pSrc);
773                            pSrc += 3;
774                        }
775                        return (pDst - static_cast<int16_t*>(pBuffer)) >> 1;
776                    }
777                    else { // Mono
778                        unsigned long readBytes = pCkData->Read(pSrc, SampleCount * 3, 1);
779                        pSrc++;
780                        for (unsigned long i = readBytes ; i > 0 ; i -= 3) {
781                            *pDst++ = get16(pSrc);
782                            pSrc += 3;
783                        }
784                        return pDst - static_cast<int16_t*>(pBuffer);
785                    }
786                }
787                else { // 16 bit
788                    // (pCkData->Read does endian correction)
789                    return Channels == 2 ? pCkData->Read(pBuffer, SampleCount << 1, 2) >> 1
790                                         : pCkData->Read(pBuffer, SampleCount, 2);
791                }
792            }
793            else {
794                if (this->SamplePos >= this->SamplesTotal) return 0;
795                //TODO: efficiency: maybe we should test for an average compression rate
796                unsigned long assumedsize      = GuessSize(SampleCount),
797                            remainingbytes   = 0,           // remaining bytes in the local buffer                            remainingbytes   = 0,           // remaining bytes in the local buffer
798                            remainingsamples = SampleCount,                            remainingsamples = SampleCount,
799                            copysamples;                            copysamples, skipsamples,
800              int currentframeoffset = this->FrameOffset;   // offset in current sample frame since last Read()                            currentframeoffset = this->FrameOffset;  // offset in current sample frame since last Read()
801              this->FrameOffset = 0;              this->FrameOffset = 0;
802    
803              if (assumedsize > this->DecompressionBufferSize) {              buffer_t* pDecompressionBuffer = (pExternalDecompressionBuffer) ? pExternalDecompressionBuffer : &InternalDecompressionBuffer;
804                  // local buffer reallocation - hope this won't happen  
805                  if (this->pDecompressionBuffer) delete[] (int8_t*) this->pDecompressionBuffer;              // if decompression buffer too small, then reduce amount of samples to read
806                  this->pDecompressionBuffer    = new int8_t[assumedsize << 1]; // double of current needed size              if (pDecompressionBuffer->Size < assumedsize) {
807                  this->DecompressionBufferSize = assumedsize;                  std::cerr << "gig::Read(): WARNING - decompression buffer size too small!" << std::endl;
808                    SampleCount      = WorstCaseMaxSamples(pDecompressionBuffer);
809                    remainingsamples = SampleCount;
810                    assumedsize      = GuessSize(SampleCount);
811              }              }
812    
813              int16_t  compressionmode, left, dleft, right, dright;              unsigned char* pSrc = (unsigned char*) pDecompressionBuffer->pStart;
814              int8_t*  pSrc = (int8_t*)  this->pDecompressionBuffer;              int16_t* pDst = static_cast<int16_t*>(pBuffer);
             int16_t* pDst = (int16_t*) pBuffer;  
815              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);
816    
817              while (remainingsamples) {              while (remainingsamples && remainingbytes) {
818                    unsigned long framesamples = SamplesPerFrame;
819                  // reload from disk to local buffer if needed                  unsigned long framebytes, rightChannelOffset = 0, nextFrameOffset;
820                  if (remainingbytes < 8194) {  
821                      if (pCkData->GetState() != RIFF::stream_ready) {                  int mode_l = *pSrc++, mode_r = 0;
822                          this->SamplePos += (SampleCount - remainingsamples);  
823                          //if (this->SamplePos > this->SamplesTotal) this->SamplePos = this->SamplesTotal;                  if (Channels == 2) {
824                          return (SampleCount - remainingsamples);                      mode_r = *pSrc++;
825                        framebytes = bytesPerFrame[mode_l] + bytesPerFrame[mode_r] + 2;
826                        rightChannelOffset = bytesPerFrameNoHdr[mode_l];
827                        nextFrameOffset = rightChannelOffset + bytesPerFrameNoHdr[mode_r];
828                        if (remainingbytes < framebytes) { // last frame in sample
829                            framesamples = SamplesInLastFrame;
830                            if (mode_l == 4 && (framesamples & 1)) {
831                                rightChannelOffset = ((framesamples + 1) * bitsPerSample[mode_l]) >> 3;
832                            }
833                            else {
834                                rightChannelOffset = (framesamples * bitsPerSample[mode_l]) >> 3;
835                            }
836                        }
837                    }
838                    else {
839                        framebytes = bytesPerFrame[mode_l] + 1;
840                        nextFrameOffset = bytesPerFrameNoHdr[mode_l];
841                        if (remainingbytes < framebytes) {
842                            framesamples = SamplesInLastFrame;
843                      }                      }
                     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;  
844                  }                  }
845    
846                  // determine how many samples in this frame to skip and read                  // determine how many samples in this frame to skip and read
847                  if (remainingsamples >= 2048) {                  if (currentframeoffset + remainingsamples >= framesamples) {
848                      copysamples       = 2048 - currentframeoffset;                      if (currentframeoffset <= framesamples) {
849                      remainingsamples -= copysamples;                          copysamples = framesamples - currentframeoffset;
850                            skipsamples = currentframeoffset;
851                        }
852                        else {
853                            copysamples = 0;
854                            skipsamples = framesamples;
855                        }
856                  }                  }
857                  else {                  else {
858                        // This frame has enough data for pBuffer, but not
859                        // all of the frame is needed. Set file position
860                        // to start of this frame for next call to Read.
861                      copysamples = remainingsamples;                      copysamples = remainingsamples;
862                      if (currentframeoffset + copysamples > 2048) {                      skipsamples = currentframeoffset;
863                          copysamples = 2048 - currentframeoffset;                      pCkData->SetPos(remainingbytes, RIFF::stream_backward);
864                          remainingsamples -= copysamples;                      this->FrameOffset = currentframeoffset + copysamples;
865                      }                  }
866                      else {                  remainingsamples -= copysamples;
867    
868                    if (remainingbytes > framebytes) {
869                        remainingbytes -= framebytes;
870                        if (remainingsamples == 0 &&
871                            currentframeoffset + copysamples == framesamples) {
872                            // This frame has enough data for pBuffer, and
873                            // all of the frame is needed. Set file
874                            // position to start of next frame for next
875                            // call to Read. FrameOffset is 0.
876                          pCkData->SetPos(remainingbytes, RIFF::stream_backward);                          pCkData->SetPos(remainingbytes, RIFF::stream_backward);
                         remainingsamples = 0;  
                         this->FrameOffset = currentframeoffset + copysamples;  
877                      }                      }
878                  }                  }
879                    else remainingbytes = 0;
880    
881                  // decompress and copy current frame from local buffer to destination buffer                  currentframeoffset -= skipsamples;
882                  compressionmode = *(int16_t*)pSrc; pSrc+=2;  
883                  switch (compressionmode) {                  if (copysamples == 0) {
884                      case 1: // left channel compressed                      // skip this frame
885                          remainingbytes -= 6150; // (left 8 bit, right 16 bit, +6 byte header)                      pSrc += framebytes - Channels;
886                          if (!remainingsamples && copysamples == 2048)                  }
887                              pCkData->SetPos(remainingbytes, RIFF::stream_backward);                  else {
888                        const unsigned char* const param_l = pSrc;
889                          left  = *(int16_t*)pSrc; pSrc+=2;                      if (BitDepth == 24) {
890                          dleft = *(int16_t*)pSrc; pSrc+=2;                          if (mode_l != 2) pSrc += 12;
891                          while (currentframeoffset) {  
892                              dleft -= *pSrc;                          if (Channels == 2) { // Stereo
893                              left  -= dleft;                              const unsigned char* const param_r = pSrc;
894                              pSrc+=3; // 8 bit left channel, skip uncompressed right channel (16 bit)                              if (mode_r != 2) pSrc += 12;
895                              currentframeoffset--;  
896                          }                              Decompress24(mode_l, param_l, 2, pSrc, pDst,
897                          while (copysamples) {                                           skipsamples, copysamples, TruncatedBits);
898                              dleft -= *pSrc; pSrc++;                              Decompress24(mode_r, param_r, 2, pSrc + rightChannelOffset, pDst + 1,
899                              left  -= dleft;                                           skipsamples, copysamples, TruncatedBits);
900                              *pDst = left; pDst++;                              pDst += copysamples << 1;
                             *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  
901                          }                          }
902                          while (copysamples) {                          else { // Mono
903                              *pDst = *(int16_t*)pSrc; pDst++; pSrc+=2;                              Decompress24(mode_l, param_l, 1, pSrc, pDst,
904                              dright -= *pSrc; pSrc++;                                           skipsamples, copysamples, TruncatedBits);
905                              right  -= dright;                              pDst += copysamples;
                             *pDst = right; pDst++;  
                             copysamples--;  
906                          }                          }
907                          break;                      }
908                      case 257: // both channels compressed                      else { // 16 bit
909                          remainingbytes -= 4106; // (left 8 bit, right 8 bit, +10 byte header)                          if (mode_l) pSrc += 4;
910                          if (!remainingsamples && copysamples == 2048)  
911                              pCkData->SetPos(remainingbytes, RIFF::stream_backward);                          int step;
912                            if (Channels == 2) { // Stereo
913                          left   = *(int16_t*)pSrc; pSrc+=2;                              const unsigned char* const param_r = pSrc;
914                          dleft  = *(int16_t*)pSrc; pSrc+=2;                              if (mode_r) pSrc += 4;
915                          right  = *(int16_t*)pSrc; pSrc+=2;  
916                          dright = *(int16_t*)pSrc; pSrc+=2;                              step = (2 - mode_l) + (2 - mode_r);
917                          while (currentframeoffset) {                              Decompress16(mode_l, param_l, step, 2, pSrc, pDst, skipsamples, copysamples);
918                              dleft  -= *pSrc; pSrc++;                              Decompress16(mode_r, param_r, step, 2, pSrc + (2 - mode_l), pDst + 1,
919                              left   -= dleft;                                           skipsamples, copysamples);
920                              dright -= *pSrc; pSrc++;                              pDst += copysamples << 1;
                             right  -= dright;  
                             currentframeoffset--;  
921                          }                          }
922                          while (copysamples) {                          else { // Mono
923                              dleft  -= *pSrc; pSrc++;                              step = 2 - mode_l;
924                              left   -= dleft;                              Decompress16(mode_l, param_l, step, 1, pSrc, pDst, skipsamples, copysamples);
925                              dright -= *pSrc; pSrc++;                              pDst += copysamples;
                             right  -= dright;  
                             *pDst = left;  pDst++;  
                             *pDst = right; pDst++;  
                             copysamples--;  
926                          }                          }
927                          break;                      }
928                      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;  
929                  }                  }
930              }  
931                    // reload from disk to local buffer if needed
932                    if (remainingsamples && remainingbytes < WorstCaseFrameSize && pCkData->GetState() == RIFF::stream_ready) {
933                        assumedsize    = GuessSize(remainingsamples);
934                        pCkData->SetPos(remainingbytes, RIFF::stream_backward);
935                        if (pCkData->RemainingBytes() < assumedsize) assumedsize = pCkData->RemainingBytes();
936                        remainingbytes = pCkData->Read(pDecompressionBuffer->pStart, assumedsize, 1);
937                        pSrc = (unsigned char*) pDecompressionBuffer->pStart;
938                    }
939                } // while
940    
941              this->SamplePos += (SampleCount - remainingsamples);              this->SamplePos += (SampleCount - remainingsamples);
942              //if (this->SamplePos > this->SamplesTotal) this->SamplePos = this->SamplesTotal;              if (this->SamplePos > this->SamplesTotal) this->SamplePos = this->SamplesTotal;
943              return (SampleCount - remainingsamples);              return (SampleCount - remainingsamples);
944          }          }
945      }      }
946    
947        /**
948         * Allocates a decompression buffer for streaming (compressed) samples
949         * with Sample::Read(). If you are using more than one streaming thread
950         * in your application you <b>HAVE</b> to create a decompression buffer
951         * for <b>EACH</b> of your streaming threads and provide it with the
952         * Sample::Read() call in order to avoid race conditions and crashes.
953         *
954         * You should free the memory occupied by the allocated buffer(s) once
955         * you don't need one of your streaming threads anymore by calling
956         * DestroyDecompressionBuffer().
957         *
958         * @param MaxReadSize - the maximum size (in sample points) you ever
959         *                      expect to read with one Read() call
960         * @returns allocated decompression buffer
961         * @see DestroyDecompressionBuffer()
962         */
963        buffer_t Sample::CreateDecompressionBuffer(unsigned long MaxReadSize) {
964            buffer_t result;
965            const double worstCaseHeaderOverhead =
966                    (256.0 /*frame size*/ + 12.0 /*header*/ + 2.0 /*compression type flag (stereo)*/) / 256.0;
967            result.Size              = (unsigned long) (double(MaxReadSize) * 3.0 /*(24 Bit)*/ * 2.0 /*stereo*/ * worstCaseHeaderOverhead);
968            result.pStart            = new int8_t[result.Size];
969            result.NullExtensionSize = 0;
970            return result;
971        }
972    
973        /**
974         * Free decompression buffer, previously created with
975         * CreateDecompressionBuffer().
976         *
977         * @param DecompressionBuffer - previously allocated decompression
978         *                              buffer to free
979         */
980        void Sample::DestroyDecompressionBuffer(buffer_t& DecompressionBuffer) {
981            if (DecompressionBuffer.Size && DecompressionBuffer.pStart) {
982                delete[] (int8_t*) DecompressionBuffer.pStart;
983                DecompressionBuffer.pStart = NULL;
984                DecompressionBuffer.Size   = 0;
985                DecompressionBuffer.NullExtensionSize = 0;
986            }
987        }
988    
989      Sample::~Sample() {      Sample::~Sample() {
990          Instances--;          Instances--;
991          if (!Instances && pDecompressionBuffer) delete[] (int8_t*) pDecompressionBuffer;          if (!Instances && InternalDecompressionBuffer.Size) {
992                delete[] (unsigned char*) InternalDecompressionBuffer.pStart;
993                InternalDecompressionBuffer.pStart = NULL;
994                InternalDecompressionBuffer.Size   = 0;
995            }
996          if (FrameTable) delete[] FrameTable;          if (FrameTable) delete[] FrameTable;
997          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;          if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
998      }      }
# Line 491  namespace gig { Line 1002  namespace gig {
1002  // *************** DimensionRegion ***************  // *************** DimensionRegion ***************
1003  // *  // *
1004    
1005        uint                               DimensionRegion::Instances       = 0;
1006        DimensionRegion::VelocityTableMap* DimensionRegion::pVelocityTables = NULL;
1007    
1008      DimensionRegion::DimensionRegion(RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {      DimensionRegion::DimensionRegion(RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {
1009            Instances++;
1010    
1011          memcpy(&Crossfade, &SamplerOptions, 4);          memcpy(&Crossfade, &SamplerOptions, 4);
1012            if (!pVelocityTables) pVelocityTables = new VelocityTableMap;
1013    
1014          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);
1015          _3ewa->ReadInt32(); // unknown, allways 0x0000008C ?          _3ewa->ReadInt32(); // unknown, always 0x0000008C ?
1016          LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());          LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1017          EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());          EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1018          _3ewa->ReadInt16(); // unknown          _3ewa->ReadInt16(); // unknown
# Line 511  namespace gig { Line 1028  namespace gig {
1028          _3ewa->ReadInt16(); // unknown          _3ewa->ReadInt16(); // unknown
1029          EG1Sustain          = _3ewa->ReadUint16();          EG1Sustain          = _3ewa->ReadUint16();
1030          EG1Release          = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());          EG1Release          = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1031          EG1Controller       = static_cast<eg1_ctrl_t>(_3ewa->ReadUint8());          EG1Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1032          uint8_t eg1ctrloptions        = _3ewa->ReadUint8();          uint8_t eg1ctrloptions        = _3ewa->ReadUint8();
1033          EG1ControllerInvert           = eg1ctrloptions & 0x01;          EG1ControllerInvert           = eg1ctrloptions & 0x01;
1034          EG1ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg1ctrloptions);          EG1ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg1ctrloptions);
1035          EG1ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg1ctrloptions);          EG1ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg1ctrloptions);
1036          EG1ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg1ctrloptions);          EG1ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg1ctrloptions);
1037          EG2Controller       = static_cast<eg2_ctrl_t>(_3ewa->ReadUint8());          EG2Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1038          uint8_t eg2ctrloptions        = _3ewa->ReadUint8();          uint8_t eg2ctrloptions        = _3ewa->ReadUint8();
1039          EG2ControllerInvert           = eg2ctrloptions & 0x01;          EG2ControllerInvert           = eg2ctrloptions & 0x01;
1040          EG2ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg2ctrloptions);          EG2ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg2ctrloptions);
# Line 579  namespace gig { Line 1096  namespace gig {
1096              ReleaseVelocityResponseDepth = 0;              ReleaseVelocityResponseDepth = 0;
1097          }          }
1098          VelocityResponseCurveScaling = _3ewa->ReadUint8();          VelocityResponseCurveScaling = _3ewa->ReadUint8();
1099          AttenuationControlTreshold   = _3ewa->ReadInt8();          AttenuationControllerThreshold = _3ewa->ReadInt8();
1100          _3ewa->ReadInt32(); // unknown          _3ewa->ReadInt32(); // unknown
1101          SampleStartOffset = (uint16_t) _3ewa->ReadInt16();          SampleStartOffset = (uint16_t) _3ewa->ReadInt16();
1102          _3ewa->ReadInt16(); // unknown          _3ewa->ReadInt16(); // unknown
# Line 589  namespace gig { Line 1106  namespace gig {
1106          else if (pitchTrackDimensionBypass & 0x20) DimensionBypass = dim_bypass_ctrl_95;          else if (pitchTrackDimensionBypass & 0x20) DimensionBypass = dim_bypass_ctrl_95;
1107          else                                       DimensionBypass = dim_bypass_ctrl_none;          else                                       DimensionBypass = dim_bypass_ctrl_none;
1108          uint8_t pan = _3ewa->ReadUint8();          uint8_t pan = _3ewa->ReadUint8();
1109          Pan         = (pan < 64) ? pan : (-1) * (int8_t)pan - 63;          Pan         = (pan < 64) ? pan : -((int)pan - 63); // signed 7 bit -> signed 8 bit
1110          SelfMask = _3ewa->ReadInt8() & 0x01;          SelfMask = _3ewa->ReadInt8() & 0x01;
1111          _3ewa->ReadInt8(); // unknown          _3ewa->ReadInt8(); // unknown
1112          uint8_t lfo3ctrl = _3ewa->ReadUint8();          uint8_t lfo3ctrl = _3ewa->ReadUint8();
1113          LFO3Controller           = static_cast<lfo3_ctrl_t>(lfo3ctrl & 0x07); // lower 3 bits          LFO3Controller           = static_cast<lfo3_ctrl_t>(lfo3ctrl & 0x07); // lower 3 bits
1114          LFO3Sync                 = lfo3ctrl & 0x20; // bit 5          LFO3Sync                 = lfo3ctrl & 0x20; // bit 5
1115          InvertAttenuationControl = lfo3ctrl & 0x80; // bit 7          InvertAttenuationController = lfo3ctrl & 0x80; // bit 7
1116          if (VCFType == vcf_type_lowpass) {          AttenuationController  = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
             if (lfo3ctrl & 0x40) // bit 6  
                 VCFType = vcf_type_lowpassturbo;  
         }  
         AttenuationControl = static_cast<attenuation_ctrl_t>(_3ewa->ReadUint8());  
1117          uint8_t lfo2ctrl       = _3ewa->ReadUint8();          uint8_t lfo2ctrl       = _3ewa->ReadUint8();
1118          LFO2Controller         = static_cast<lfo2_ctrl_t>(lfo2ctrl & 0x07); // lower 3 bits          LFO2Controller         = static_cast<lfo2_ctrl_t>(lfo2ctrl & 0x07); // lower 3 bits
1119          LFO2FlipPhase          = lfo2ctrl & 0x80; // bit 7          LFO2FlipPhase          = lfo2ctrl & 0x80; // bit 7
# Line 644  namespace gig { Line 1157  namespace gig {
1157          VCFVelocityDynamicRange = vcfvelocity % 5;          VCFVelocityDynamicRange = vcfvelocity % 5;
1158          VCFVelocityCurve        = static_cast<curve_type_t>(vcfvelocity / 5);          VCFVelocityCurve        = static_cast<curve_type_t>(vcfvelocity / 5);
1159          VCFType = static_cast<vcf_type_t>(_3ewa->ReadUint8());          VCFType = static_cast<vcf_type_t>(_3ewa->ReadUint8());
1160            if (VCFType == vcf_type_lowpass) {
1161                if (lfo3ctrl & 0x40) // bit 6
1162                    VCFType = vcf_type_lowpassturbo;
1163            }
1164    
1165            pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,
1166                                                         VelocityResponseDepth,
1167                                                         VelocityResponseCurveScaling);
1168    
1169            curve_type_t curveType = ReleaseVelocityResponseCurve;
1170            uint8_t depth = ReleaseVelocityResponseDepth;
1171    
1172            // this models a strange behaviour or bug in GSt: two of the
1173            // velocity response curves for release time are not used even
1174            // if specified, instead another curve is chosen.
1175    
1176            if ((curveType == curve_type_nonlinear && depth == 0) ||
1177                (curveType == curve_type_special   && depth == 4)) {
1178                curveType = curve_type_nonlinear;
1179                depth = 3;
1180            }
1181            pVelocityReleaseTable = GetVelocityTable(curveType, depth, 0);
1182    
1183            SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));
1184        }
1185    
1186        // get the corresponding velocity table from the table map or create & calculate that table if it doesn't exist yet
1187        double* DimensionRegion::GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling)
1188        {
1189            double* table;
1190            uint32_t tableKey = (curveType<<16) | (depth<<8) | scaling;
1191            if (pVelocityTables->count(tableKey)) { // if key exists
1192                table = (*pVelocityTables)[tableKey];
1193            }
1194            else {
1195                table = CreateVelocityTable(curveType, depth, scaling);
1196                (*pVelocityTables)[tableKey] = table; // put the new table into the tables map
1197            }
1198            return table;
1199        }
1200    
1201        leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {
1202            leverage_ctrl_t decodedcontroller;
1203            switch (EncodedController) {
1204                // special controller
1205                case _lev_ctrl_none:
1206                    decodedcontroller.type = leverage_ctrl_t::type_none;
1207                    decodedcontroller.controller_number = 0;
1208                    break;
1209                case _lev_ctrl_velocity:
1210                    decodedcontroller.type = leverage_ctrl_t::type_velocity;
1211                    decodedcontroller.controller_number = 0;
1212                    break;
1213                case _lev_ctrl_channelaftertouch:
1214                    decodedcontroller.type = leverage_ctrl_t::type_channelaftertouch;
1215                    decodedcontroller.controller_number = 0;
1216                    break;
1217    
1218                // ordinary MIDI control change controller
1219                case _lev_ctrl_modwheel:
1220                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1221                    decodedcontroller.controller_number = 1;
1222                    break;
1223                case _lev_ctrl_breath:
1224                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1225                    decodedcontroller.controller_number = 2;
1226                    break;
1227                case _lev_ctrl_foot:
1228                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1229                    decodedcontroller.controller_number = 4;
1230                    break;
1231                case _lev_ctrl_effect1:
1232                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1233                    decodedcontroller.controller_number = 12;
1234                    break;
1235                case _lev_ctrl_effect2:
1236                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1237                    decodedcontroller.controller_number = 13;
1238                    break;
1239                case _lev_ctrl_genpurpose1:
1240                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1241                    decodedcontroller.controller_number = 16;
1242                    break;
1243                case _lev_ctrl_genpurpose2:
1244                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1245                    decodedcontroller.controller_number = 17;
1246                    break;
1247                case _lev_ctrl_genpurpose3:
1248                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1249                    decodedcontroller.controller_number = 18;
1250                    break;
1251                case _lev_ctrl_genpurpose4:
1252                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1253                    decodedcontroller.controller_number = 19;
1254                    break;
1255                case _lev_ctrl_portamentotime:
1256                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1257                    decodedcontroller.controller_number = 5;
1258                    break;
1259                case _lev_ctrl_sustainpedal:
1260                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1261                    decodedcontroller.controller_number = 64;
1262                    break;
1263                case _lev_ctrl_portamento:
1264                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1265                    decodedcontroller.controller_number = 65;
1266                    break;
1267                case _lev_ctrl_sostenutopedal:
1268                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1269                    decodedcontroller.controller_number = 66;
1270                    break;
1271                case _lev_ctrl_softpedal:
1272                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1273                    decodedcontroller.controller_number = 67;
1274                    break;
1275                case _lev_ctrl_genpurpose5:
1276                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1277                    decodedcontroller.controller_number = 80;
1278                    break;
1279                case _lev_ctrl_genpurpose6:
1280                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1281                    decodedcontroller.controller_number = 81;
1282                    break;
1283                case _lev_ctrl_genpurpose7:
1284                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1285                    decodedcontroller.controller_number = 82;
1286                    break;
1287                case _lev_ctrl_genpurpose8:
1288                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1289                    decodedcontroller.controller_number = 83;
1290                    break;
1291                case _lev_ctrl_effect1depth:
1292                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1293                    decodedcontroller.controller_number = 91;
1294                    break;
1295                case _lev_ctrl_effect2depth:
1296                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1297                    decodedcontroller.controller_number = 92;
1298                    break;
1299                case _lev_ctrl_effect3depth:
1300                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1301                    decodedcontroller.controller_number = 93;
1302                    break;
1303                case _lev_ctrl_effect4depth:
1304                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1305                    decodedcontroller.controller_number = 94;
1306                    break;
1307                case _lev_ctrl_effect5depth:
1308                    decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1309                    decodedcontroller.controller_number = 95;
1310                    break;
1311    
1312                // unknown controller type
1313                default:
1314                    throw gig::Exception("Unknown leverage controller type.");
1315            }
1316            return decodedcontroller;
1317        }
1318    
1319        DimensionRegion::~DimensionRegion() {
1320            Instances--;
1321            if (!Instances) {
1322                // delete the velocity->volume tables
1323                VelocityTableMap::iterator iter;
1324                for (iter = pVelocityTables->begin(); iter != pVelocityTables->end(); iter++) {
1325                    double* pTable = iter->second;
1326                    if (pTable) delete[] pTable;
1327                }
1328                pVelocityTables->clear();
1329                delete pVelocityTables;
1330                pVelocityTables = NULL;
1331            }
1332        }
1333    
1334        /**
1335         * Returns the correct amplitude factor for the given \a MIDIKeyVelocity.
1336         * All involved parameters (VelocityResponseCurve, VelocityResponseDepth
1337         * and VelocityResponseCurveScaling) involved are taken into account to
1338         * calculate the amplitude factor. Use this method when a key was
1339         * triggered to get the volume with which the sample should be played
1340         * back.
1341         *
1342         * @param MIDIKeyVelocity  MIDI velocity value of the triggered key (between 0 and 127)
1343         * @returns                amplitude factor (between 0.0 and 1.0)
1344         */
1345        double DimensionRegion::GetVelocityAttenuation(uint8_t MIDIKeyVelocity) {
1346            return pVelocityAttenuationTable[MIDIKeyVelocity];
1347      }      }
1348    
1349        double DimensionRegion::GetVelocityRelease(uint8_t MIDIKeyVelocity) {
1350            return pVelocityReleaseTable[MIDIKeyVelocity];
1351        }
1352    
1353        double* DimensionRegion::CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling) {
1354    
1355            // line-segment approximations of the 15 velocity curves
1356    
1357            // linear
1358            const int lin0[] = { 1, 1, 127, 127 };
1359            const int lin1[] = { 1, 21, 127, 127 };
1360            const int lin2[] = { 1, 45, 127, 127 };
1361            const int lin3[] = { 1, 74, 127, 127 };
1362            const int lin4[] = { 1, 127, 127, 127 };
1363    
1364            // non-linear
1365            const int non0[] = { 1, 4, 24, 5, 57, 17, 92, 57, 122, 127, 127, 127 };
1366            const int non1[] = { 1, 4, 46, 9, 93, 56, 118, 106, 123, 127,
1367                                 127, 127 };
1368            const int non2[] = { 1, 4, 46, 9, 57, 20, 102, 107, 107, 127,
1369                                 127, 127 };
1370            const int non3[] = { 1, 15, 10, 19, 67, 73, 80, 80, 90, 98, 98, 127,
1371                                 127, 127 };
1372            const int non4[] = { 1, 25, 33, 57, 82, 81, 92, 127, 127, 127 };
1373    
1374            // special
1375            const int spe0[] = { 1, 2, 76, 10, 90, 15, 95, 20, 99, 28, 103, 44,
1376                                 113, 127, 127, 127 };
1377            const int spe1[] = { 1, 2, 27, 5, 67, 18, 89, 29, 95, 35, 107, 67,
1378                                 118, 127, 127, 127 };
1379            const int spe2[] = { 1, 1, 33, 1, 53, 5, 61, 13, 69, 32, 79, 74,
1380                                 85, 90, 91, 127, 127, 127 };
1381            const int spe3[] = { 1, 32, 28, 35, 66, 48, 89, 59, 95, 65, 99, 73,
1382                                 117, 127, 127, 127 };
1383            const int spe4[] = { 1, 4, 23, 5, 49, 13, 57, 17, 92, 57, 122, 127,
1384                                 127, 127 };
1385    
1386            const int* const curves[] = { non0, non1, non2, non3, non4,
1387                                          lin0, lin1, lin2, lin3, lin4,
1388                                          spe0, spe1, spe2, spe3, spe4 };
1389    
1390            double* const table = new double[128];
1391    
1392            const int* curve = curves[curveType * 5 + depth];
1393            const int s = scaling == 0 ? 20 : scaling; // 0 or 20 means no scaling
1394    
1395            table[0] = 0;
1396            for (int x = 1 ; x < 128 ; x++) {
1397    
1398                if (x > curve[2]) curve += 2;
1399                double y = curve[1] + (x - curve[0]) *
1400                    (double(curve[3] - curve[1]) / (curve[2] - curve[0]));
1401                y = y / 127;
1402    
1403                // Scale up for s > 20, down for s < 20. When
1404                // down-scaling, the curve still ends at 1.0.
1405                if (s < 20 && y >= 0.5)
1406                    y = y / ((2 - 40.0 / s) * y + 40.0 / s - 1);
1407                else
1408                    y = y * (s / 20.0);
1409                if (y > 1) y = 1;
1410    
1411                table[x] = y;
1412            }
1413            return table;
1414        }
1415    
1416    
1417  // *************** Region ***************  // *************** Region ***************
# Line 654  namespace gig { Line 1420  namespace gig {
1420      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) {
1421          // Initialization          // Initialization
1422          Dimensions = 0;          Dimensions = 0;
1423          for (int i = 0; i < 32; i++) {          for (int i = 0; i < 256; i++) {
1424              pDimensionRegions[i] = NULL;              pDimensionRegions[i] = NULL;
1425          }          }
1426            Layers = 1;
1427            File* file = (File*) GetParent()->GetParent();
1428            int dimensionBits = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;
1429    
1430          // Actual Loading          // Actual Loading
1431    
# Line 665  namespace gig { Line 1434  namespace gig {
1434          RIFF::Chunk* _3lnk = rgnList->GetSubChunk(CHUNK_ID_3LNK);          RIFF::Chunk* _3lnk = rgnList->GetSubChunk(CHUNK_ID_3LNK);
1435          if (_3lnk) {          if (_3lnk) {
1436              DimensionRegions = _3lnk->ReadUint32();              DimensionRegions = _3lnk->ReadUint32();
1437              for (int i = 0; i < 5; i++) {              for (int i = 0; i < dimensionBits; i++) {
1438                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());
1439                  uint8_t     bits      = _3lnk->ReadUint8();                  uint8_t     bits      = _3lnk->ReadUint8();
1440                  if (dimension == dimension_none) { // inactive dimension                  if (dimension == dimension_none) { // inactive dimension
# Line 681  namespace gig { Line 1450  namespace gig {
1450                      pDimensionDefinitions[i].bits      = bits;                      pDimensionDefinitions[i].bits      = bits;
1451                      pDimensionDefinitions[i].zones     = 0x01 << bits; // = pow(2,bits)                      pDimensionDefinitions[i].zones     = 0x01 << bits; // = pow(2,bits)
1452                      pDimensionDefinitions[i].split_type = (dimension == dimension_layer ||                      pDimensionDefinitions[i].split_type = (dimension == dimension_layer ||
1453                                                             dimension == dimension_samplechannel) ? split_type_bit                                                             dimension == dimension_samplechannel ||
1454                                                                                                   : split_type_normal;                                                             dimension == dimension_releasetrigger ||
1455                                                               dimension == dimension_roundrobin ||
1456                                                               dimension == dimension_random) ? split_type_bit
1457                                                                                              : split_type_normal;
1458                      pDimensionDefinitions[i].ranges = NULL; // it's not possible to check velocity dimensions for custom defined ranges at this point                      pDimensionDefinitions[i].ranges = NULL; // it's not possible to check velocity dimensions for custom defined ranges at this point
1459                      pDimensionDefinitions[i].zone_size  =                      pDimensionDefinitions[i].zone_size  =
1460                          (pDimensionDefinitions[i].split_type == split_type_normal) ? 128 / pDimensionDefinitions[i].zones                          (pDimensionDefinitions[i].split_type == split_type_normal) ? 128 / pDimensionDefinitions[i].zones
1461                                                                                     : 0;                                                                                     : 0;
1462                      Dimensions++;                      Dimensions++;
1463    
1464                        // if this is a layer dimension, remember the amount of layers
1465                        if (dimension == dimension_layer) Layers = pDimensionDefinitions[i].zones;
1466                  }                  }
1467                  _3lnk->SetPos(6, RIFF::stream_curpos); // jump forward to next dimension definition                  _3lnk->SetPos(6, RIFF::stream_curpos); // jump forward to next dimension definition
1468              }              }
# Line 704  namespace gig { Line 1479  namespace gig {
1479                      else { // custom defined ranges                      else { // custom defined ranges
1480                          pDimDef->split_type = split_type_customvelocity;                          pDimDef->split_type = split_type_customvelocity;
1481                          pDimDef->ranges     = new range_t[pDimDef->zones];                          pDimDef->ranges     = new range_t[pDimDef->zones];
1482                          unsigned int bits[5] = {0,0,0,0,0};                          uint8_t bits[8] = { 0 };
1483                          int previousUpperLimit = -1;                          int previousUpperLimit = -1;
1484                          for (int velocityZone = 0; velocityZone < pDimDef->zones; velocityZone++) {                          for (int velocityZone = 0; velocityZone < pDimDef->zones; velocityZone++) {
1485                              bits[i] = velocityZone;                              bits[i] = velocityZone;
1486                              DimensionRegion* pDimRegion = GetDimensionRegionByBit(bits[4],bits[3],bits[2],bits[1],bits[0]);                              DimensionRegion* pDimRegion = GetDimensionRegionByBit(bits);
1487    
1488                              pDimDef->ranges[velocityZone].low  = previousUpperLimit + 1;                              pDimDef->ranges[velocityZone].low  = previousUpperLimit + 1;
1489                              pDimDef->ranges[velocityZone].high = pDimRegion->VelocityUpperLimit;                              pDimDef->ranges[velocityZone].high = pDimRegion->VelocityUpperLimit;
# Line 722  namespace gig { Line 1497  namespace gig {
1497                  }                  }
1498              }              }
1499    
1500                // jump to start of the wave pool indices (if not already there)
1501                File* file = (File*) GetParent()->GetParent();
1502                if (file->pVersion && file->pVersion->major == 3)
1503                    _3lnk->SetPos(68); // version 3 has a different 3lnk structure
1504                else
1505                    _3lnk->SetPos(44);
1506    
1507              // load sample references              // load sample references
             _3lnk->SetPos(44); // jump to start of the wave pool indices (if not already there)  
1508              for (uint i = 0; i < DimensionRegions; i++) {              for (uint i = 0; i < DimensionRegions; i++) {
1509                  uint32_t wavepoolindex = _3lnk->ReadUint32();                  uint32_t wavepoolindex = _3lnk->ReadUint32();
1510                  pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);                  pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);
# Line 752  namespace gig { Line 1533  namespace gig {
1533          for (uint i = 0; i < Dimensions; i++) {          for (uint i = 0; i < Dimensions; i++) {
1534              if (pDimensionDefinitions[i].ranges) delete[] pDimensionDefinitions[i].ranges;              if (pDimensionDefinitions[i].ranges) delete[] pDimensionDefinitions[i].ranges;
1535          }          }
1536          for (int i = 0; i < 32; i++) {          for (int i = 0; i < 256; i++) {
1537              if (pDimensionRegions[i]) delete pDimensionRegions[i];              if (pDimensionRegions[i]) delete pDimensionRegions[i];
1538          }          }
1539      }      }
# Line 770  namespace gig { Line 1551  namespace gig {
1551       * 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,
1552       * etc.).       * etc.).
1553       *       *
1554       * @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  
1555       * @returns         adress to the DimensionRegion for the given situation       * @returns         adress to the DimensionRegion for the given situation
1556       * @see             pDimensionDefinitions       * @see             pDimensionDefinitions
1557       * @see             Dimensions       * @see             Dimensions
1558       */       */
1559      DimensionRegion* Region::GetDimensionRegionByValue(uint Dim4Val, uint Dim3Val, uint Dim2Val, uint Dim1Val, uint Dim0Val) {      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {
1560          unsigned int bits[5] = {Dim0Val,Dim1Val,Dim2Val,Dim3Val,Dim4Val};          uint8_t bits[8] = { 0 };
1561          for (uint i = 0; i < Dimensions; i++) {          for (uint i = 0; i < Dimensions; i++) {
1562                bits[i] = DimValues[i];
1563              switch (pDimensionDefinitions[i].split_type) {              switch (pDimensionDefinitions[i].split_type) {
1564                  case split_type_normal:                  case split_type_normal:
1565                      bits[i] /= pDimensionDefinitions[i].zone_size;                      bits[i] /= pDimensionDefinitions[i].zone_size;
# Line 789  namespace gig { Line 1567  namespace gig {
1567                  case split_type_customvelocity:                  case split_type_customvelocity:
1568                      bits[i] = VelocityTable[bits[i]];                      bits[i] = VelocityTable[bits[i]];
1569                      break;                      break;
1570                  // else the value is already the sought dimension bit number                  case split_type_bit: // the value is already the sought dimension bit number
1571                        const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;
1572                        bits[i] = bits[i] & limiter_mask; // just make sure the value don't uses more bits than allowed
1573                        break;
1574              }              }
1575          }          }
1576          return GetDimensionRegionByBit(bits[4],bits[3],bits[2],bits[1],bits[0]);          return GetDimensionRegionByBit(bits);
1577      }      }
1578    
1579      /**      /**
# Line 800  namespace gig { Line 1581  namespace gig {
1581       * numbers (zone index). You usually use <i>GetDimensionRegionByValue</i>       * numbers (zone index). You usually use <i>GetDimensionRegionByValue</i>
1582       * instead of calling this method directly!       * instead of calling this method directly!
1583       *       *
1584       * @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  
1585       * @returns        adress to the DimensionRegion for the given dimension       * @returns        adress to the DimensionRegion for the given dimension
1586       *                 bit numbers       *                 bit numbers
1587       * @see            GetDimensionRegionByValue()       * @see            GetDimensionRegionByValue()
1588       */       */
1589      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]) {
1590          return *(pDimensionRegions + ((((((((Dim4Bit << pDimensionDefinitions[3].bits) | Dim3Bit)          return pDimensionRegions[((((((DimBits[7] << pDimensionDefinitions[6].bits | DimBits[6])
1591                                                       << pDimensionDefinitions[2].bits) | Dim2Bit)                                                    << pDimensionDefinitions[5].bits | DimBits[5])
1592                                                       << pDimensionDefinitions[1].bits) | Dim1Bit)                                                    << pDimensionDefinitions[4].bits | DimBits[4])
1593                                                       << pDimensionDefinitions[0].bits) | Dim0Bit) );                                                    << pDimensionDefinitions[3].bits | DimBits[3])
1594                                                      << pDimensionDefinitions[2].bits | DimBits[2])
1595                                                      << pDimensionDefinitions[1].bits | DimBits[1])
1596                                                      << pDimensionDefinitions[0].bits | DimBits[0]];
1597      }      }
1598    
1599      /**      /**
# Line 830  namespace gig { Line 1610  namespace gig {
1610          else         return static_cast<gig::Sample*>(pSample = GetSampleFromWavePool(WavePoolTableIndex));          else         return static_cast<gig::Sample*>(pSample = GetSampleFromWavePool(WavePoolTableIndex));
1611      }      }
1612    
1613      Sample* Region::GetSampleFromWavePool(unsigned int WavePoolTableIndex) {      Sample* Region::GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress) {
1614            if ((int32_t)WavePoolTableIndex == -1) return NULL;
1615          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
1616          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
1617          Sample* sample = file->GetFirstSample();          unsigned long soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];
1618            Sample* sample = file->GetFirstSample(pProgress);
1619          while (sample) {          while (sample) {
1620              if (sample->ulWavePoolOffset == soughtoffset) return static_cast<gig::Sample*>(pSample = sample);              if (sample->ulWavePoolOffset == soughtoffset &&
1621                    sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(pSample = sample);
1622              sample = file->GetNextSample();              sample = file->GetNextSample();
1623          }          }
1624          return NULL;          return NULL;
# Line 846  namespace gig { Line 1629  namespace gig {
1629  // *************** Instrument ***************  // *************** Instrument ***************
1630  // *  // *
1631    
1632      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) {
1633          // Initialization          // Initialization
1634          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;
1635          RegionIndex = -1;          RegionIndex = -1;
# Line 872  namespace gig { Line 1655  namespace gig {
1655          RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);          RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);
1656          if (!lrgn) throw gig::Exception("Mandatory chunks in <ins > chunk not found.");          if (!lrgn) throw gig::Exception("Mandatory chunks in <ins > chunk not found.");
1657          pRegions = new Region*[Regions];          pRegions = new Region*[Regions];
1658            for (uint i = 0; i < Regions; i++) pRegions[i] = NULL;
1659          RIFF::List* rgn = lrgn->GetFirstSubList();          RIFF::List* rgn = lrgn->GetFirstSubList();
1660          unsigned int iRegion = 0;          unsigned int iRegion = 0;
1661          while (rgn) {          while (rgn) {
1662              if (rgn->GetListType() == LIST_TYPE_RGN) {              if (rgn->GetListType() == LIST_TYPE_RGN) {
1663                    __notify_progress(pProgress, (float) iRegion / (float) Regions);
1664                  pRegions[iRegion] = new Region(this, rgn);                  pRegions[iRegion] = new Region(this, rgn);
1665                  iRegion++;                  iRegion++;
1666              }              }
# Line 888  namespace gig { Line 1673  namespace gig {
1673                  RegionKeyTable[iKey] = pRegions[iReg];                  RegionKeyTable[iKey] = pRegions[iReg];
1674              }              }
1675          }          }
1676    
1677            __notify_progress(pProgress, 1.0f); // notify done
1678      }      }
1679    
1680      Instrument::~Instrument() {      Instrument::~Instrument() {
# Line 895  namespace gig { Line 1682  namespace gig {
1682              if (pRegions) {              if (pRegions) {
1683                  if (pRegions[i]) delete (pRegions[i]);                  if (pRegions[i]) delete (pRegions[i]);
1684              }              }
             delete[] pRegions;  
1685          }          }
1686            if (pRegions) delete[] pRegions;
1687      }      }
1688    
1689      /**      /**
# Line 938  namespace gig { Line 1725  namespace gig {
1725       * @see      GetFirstRegion()       * @see      GetFirstRegion()
1726       */       */
1727      Region* Instrument::GetNextRegion() {      Region* Instrument::GetNextRegion() {
1728          if (RegionIndex < 0 || RegionIndex >= Regions) return NULL;          if (RegionIndex < 0 || uint32_t(RegionIndex) >= Regions) return NULL;
1729          return pRegions[RegionIndex++];          return pRegions[RegionIndex++];
1730      }      }
1731    
# Line 952  namespace gig { Line 1739  namespace gig {
1739          pInstruments = NULL;          pInstruments = NULL;
1740      }      }
1741    
1742      Sample* File::GetFirstSample() {      File::~File() {
1743          if (!pSamples) LoadSamples();          // free samples
1744            if (pSamples) {
1745                SamplesIterator = pSamples->begin();
1746                while (SamplesIterator != pSamples->end() ) {
1747                    delete (*SamplesIterator);
1748                    SamplesIterator++;
1749                }
1750                pSamples->clear();
1751                delete pSamples;
1752    
1753            }
1754            // free instruments
1755            if (pInstruments) {
1756                InstrumentsIterator = pInstruments->begin();
1757                while (InstrumentsIterator != pInstruments->end() ) {
1758                    delete (*InstrumentsIterator);
1759                    InstrumentsIterator++;
1760                }
1761                pInstruments->clear();
1762                delete pInstruments;
1763            }
1764            // free extension files
1765            for (std::list<RIFF::File*>::iterator i = ExtensionFiles.begin() ; i != ExtensionFiles.end() ; i++)
1766                delete *i;
1767        }
1768    
1769        Sample* File::GetFirstSample(progress_t* pProgress) {
1770            if (!pSamples) LoadSamples(pProgress);
1771          if (!pSamples) return NULL;          if (!pSamples) return NULL;
1772          SamplesIterator = pSamples->begin();          SamplesIterator = pSamples->begin();
1773          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
# Line 965  namespace gig { Line 1779  namespace gig {
1779          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
1780      }      }
1781    
1782      void File::LoadSamples() {      void File::LoadSamples(progress_t* pProgress) {
1783          RIFF::List* wvpl = pRIFF->GetSubList(LIST_TYPE_WVPL);          RIFF::File* file = pRIFF;
1784          if (wvpl) {  
1785              unsigned long wvplFileOffset = wvpl->GetFilePos();          // just for progress calculation
1786              RIFF::List* wave = wvpl->GetFirstSubList();          int iSampleIndex  = 0;
1787              while (wave) {          int iTotalSamples = WavePoolCount;
1788                  if (wave->GetListType() == LIST_TYPE_WAVE) {  
1789                      if (!pSamples) pSamples = new SampleList;          // check if samples should be loaded from extension files
1790                      unsigned long waveFileOffset = wave->GetFilePos();          int lastFileNo = 0;
1791                      pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset));          for (int i = 0 ; i < WavePoolCount ; i++) {
1792                if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];
1793            }
1794            String name(pRIFF->Filename);
1795            int nameLen = pRIFF->Filename.length();
1796            char suffix[6];
1797            if (nameLen > 4 && pRIFF->Filename.substr(nameLen - 4) == ".gig") nameLen -= 4;
1798    
1799            for (int fileNo = 0 ; ; ) {
1800                RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);
1801                if (wvpl) {
1802                    unsigned long wvplFileOffset = wvpl->GetFilePos();
1803                    RIFF::List* wave = wvpl->GetFirstSubList();
1804                    while (wave) {
1805                        if (wave->GetListType() == LIST_TYPE_WAVE) {
1806                            // notify current progress
1807                            const float subprogress = (float) iSampleIndex / (float) iTotalSamples;
1808                            __notify_progress(pProgress, subprogress);
1809    
1810                            if (!pSamples) pSamples = new SampleList;
1811                            unsigned long waveFileOffset = wave->GetFilePos();
1812                            pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));
1813    
1814                            iSampleIndex++;
1815                        }
1816                        wave = wvpl->GetNextSubList();
1817                  }                  }
1818                  wave = wvpl->GetNextSubList();  
1819                    if (fileNo == lastFileNo) break;
1820    
1821                    // open extension file (*.gx01, *.gx02, ...)
1822                    fileNo++;
1823                    sprintf(suffix, ".gx%02d", fileNo);
1824                    name.replace(nameLen, 5, suffix);
1825                    file = new RIFF::File(name);
1826                    ExtensionFiles.push_back(file);
1827              }              }
1828                else throw gig::Exception("Mandatory <wvpl> chunk not found.");
1829          }          }
1830          else throw gig::Exception("Mandatory <wvpl> chunk not found.");  
1831            __notify_progress(pProgress, 1.0); // notify done
1832      }      }
1833    
1834      Instrument* File::GetFirstInstrument() {      Instrument* File::GetFirstInstrument() {
# Line 995  namespace gig { Line 1844  namespace gig {
1844          return (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL;          return (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL;
1845      }      }
1846    
1847      void File::LoadInstruments() {      /**
1848         * Returns the instrument with the given index.
1849         *
1850         * @param index     - number of the sought instrument (0..n)
1851         * @param pProgress - optional: callback function for progress notification
1852         * @returns  sought instrument or NULL if there's no such instrument
1853         */
1854        Instrument* File::GetInstrument(uint index, progress_t* pProgress) {
1855            if (!pInstruments) {
1856                // TODO: hack - we simply load ALL samples here, it would have been done in the Region constructor anyway (ATM)
1857    
1858                // sample loading subtask
1859                progress_t subprogress;
1860                __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask
1861                __notify_progress(&subprogress, 0.0f);
1862                GetFirstSample(&subprogress); // now force all samples to be loaded
1863                __notify_progress(&subprogress, 1.0f);
1864    
1865                // instrument loading subtask
1866                if (pProgress && pProgress->callback) {
1867                    subprogress.__range_min = subprogress.__range_max;
1868                    subprogress.__range_max = pProgress->__range_max; // schedule remaining percentage for this subtask
1869                }
1870                __notify_progress(&subprogress, 0.0f);
1871                LoadInstruments(&subprogress);
1872                __notify_progress(&subprogress, 1.0f);
1873            }
1874            if (!pInstruments) return NULL;
1875            InstrumentsIterator = pInstruments->begin();
1876            for (uint i = 0; InstrumentsIterator != pInstruments->end(); i++) {
1877                if (i == index) return *InstrumentsIterator;
1878                InstrumentsIterator++;
1879            }
1880            return NULL;
1881        }
1882    
1883        void File::LoadInstruments(progress_t* pProgress) {
1884          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
1885          if (lstInstruments) {          if (lstInstruments) {
1886                int iInstrumentIndex = 0;
1887              RIFF::List* lstInstr = lstInstruments->GetFirstSubList();              RIFF::List* lstInstr = lstInstruments->GetFirstSubList();
1888              while (lstInstr) {              while (lstInstr) {
1889                  if (lstInstr->GetListType() == LIST_TYPE_INS) {                  if (lstInstr->GetListType() == LIST_TYPE_INS) {
1890                        // notify current progress
1891                        const float localProgress = (float) iInstrumentIndex / (float) Instruments;
1892                        __notify_progress(pProgress, localProgress);
1893    
1894                        // divide local progress into subprogress for loading current Instrument
1895                        progress_t subprogress;
1896                        __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);
1897    
1898                      if (!pInstruments) pInstruments = new InstrumentList;                      if (!pInstruments) pInstruments = new InstrumentList;
1899                      pInstruments->push_back(new Instrument(this, lstInstr));                      pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));
1900    
1901                        iInstrumentIndex++;
1902                  }                  }
1903                  lstInstr = lstInstruments->GetNextSubList();                  lstInstr = lstInstruments->GetNextSubList();
1904              }              }
1905                __notify_progress(pProgress, 1.0); // notify done
1906          }          }
1907          else throw gig::Exception("Mandatory <lins> list chunk not found.");          else throw gig::Exception("Mandatory <lins> list chunk not found.");
1908      }      }
# Line 1022  namespace gig { Line 1919  namespace gig {
1919          std::cout << "gig::Exception: " << Message << std::endl;          std::cout << "gig::Exception: " << Message << std::endl;
1920      }      }
1921    
1922    
1923    // *************** functions ***************
1924    // *
1925    
1926        /**
1927         * Returns the name of this C++ library. This is usually "libgig" of
1928         * course. This call is equivalent to RIFF::libraryName() and
1929         * DLS::libraryName().
1930         */
1931        String libraryName() {
1932            return PACKAGE;
1933        }
1934    
1935        /**
1936         * Returns version of this C++ library. This call is equivalent to
1937         * RIFF::libraryVersion() and DLS::libraryVersion().
1938         */
1939        String libraryVersion() {
1940            return VERSION;
1941        }
1942    
1943  } // namespace gig  } // namespace gig

Legend:
Removed from v.2  
changed lines
  Added in v.666

  ViewVC Help
Powered by ViewVC