/[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 728 by persson, Tue Jul 26 11:13:53 2005 UTC revision 1317 by persson, Sat Sep 1 07:15:53 2007 UTC
# Line 1  Line 1 
1  /***************************************************************************  /***************************************************************************
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file loader library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003-2005 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2007 by Christian Schoenebeck                      *
6   *                              <cuse@users.sourceforge.net>               *   *                              <cuse@users.sourceforge.net>               *
7   *                                                                         *   *                                                                         *
8   *   This library is free software; you can redistribute it and/or modify  *   *   This library is free software; you can redistribute it and/or modify  *
# Line 23  Line 23 
23    
24  #include "gig.h"  #include "gig.h"
25    
26    #include "helper.h"
27    
28    #include <math.h>
29  #include <iostream>  #include <iostream>
30    
31    /// Initial size of the sample buffer which is used for decompression of
32    /// compressed sample wave streams - this value should always be bigger than
33    /// the biggest sample piece expected to be read by the sampler engine,
34    /// otherwise the buffer size will be raised at runtime and thus the buffer
35    /// reallocated which is time consuming and unefficient.
36    #define INITIAL_SAMPLE_BUFFER_SIZE              512000 // 512 kB
37    
38    /** (so far) every exponential paramater in the gig format has a basis of 1.000000008813822 */
39    #define GIG_EXP_DECODE(x)                       (pow(1.000000008813822, x))
40    #define GIG_EXP_ENCODE(x)                       (log(x) / log(1.000000008813822))
41    #define GIG_PITCH_TRACK_EXTRACT(x)              (!(x & 0x01))
42    #define GIG_PITCH_TRACK_ENCODE(x)               ((x) ? 0x00 : 0x01)
43    #define GIG_VCF_RESONANCE_CTRL_EXTRACT(x)       ((x >> 4) & 0x03)
44    #define GIG_VCF_RESONANCE_CTRL_ENCODE(x)        ((x & 0x03) << 4)
45    #define GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(x)  ((x >> 1) & 0x03)
46    #define GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(x)   ((x >> 3) & 0x03)
47    #define GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(x) ((x >> 5) & 0x03)
48    #define GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(x)   ((x & 0x03) << 1)
49    #define GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(x)    ((x & 0x03) << 3)
50    #define GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(x)  ((x & 0x03) << 5)
51    
52  namespace gig {  namespace gig {
53    
54  // *************** progress_t ***************  // *************** progress_t ***************
# Line 59  namespace gig { Line 83  namespace gig {
83      }      }
84    
85    
86  // *************** Internal functions for sample decopmression ***************  // *************** Internal functions for sample decompression ***************
87  // *  // *
88    
89  namespace {  namespace {
# Line 87  namespace { Line 111  namespace {
111          return x & 0x800000 ? x - 0x1000000 : x;          return x & 0x800000 ? x - 0x1000000 : x;
112      }      }
113    
114        inline void store24(unsigned char* pDst, int x)
115        {
116            pDst[0] = x;
117            pDst[1] = x >> 8;
118            pDst[2] = x >> 16;
119        }
120    
121      void Decompress16(int compressionmode, const unsigned char* params,      void Decompress16(int compressionmode, const unsigned char* params,
122                        int srcStep, int dstStep,                        int srcStep, int dstStep,
123                        const unsigned char* pSrc, int16_t* pDst,                        const unsigned char* pSrc, int16_t* pDst,
# Line 126  namespace { Line 157  namespace {
157      }      }
158    
159      void Decompress24(int compressionmode, const unsigned char* params,      void Decompress24(int compressionmode, const unsigned char* params,
160                        int dstStep, const unsigned char* pSrc, int16_t* pDst,                        int dstStep, const unsigned char* pSrc, uint8_t* pDst,
161                        unsigned long currentframeoffset,                        unsigned long currentframeoffset,
162                        unsigned long copysamples, int truncatedBits)                        unsigned long copysamples, int truncatedBits)
163      {      {
         // Note: The 24 bits are truncated to 16 bits for now.  
   
164          int y, dy, ddy, dddy;          int y, dy, ddy, dddy;
         const int shift = 8 - truncatedBits;  
165    
166  #define GET_PARAMS(params)                      \  #define GET_PARAMS(params)                      \
167          y    = get24(params);                   \          y    = get24(params);                   \
# Line 149  namespace { Line 177  namespace {
177    
178  #define COPY_ONE(x)                             \  #define COPY_ONE(x)                             \
179          SKIP_ONE(x);                            \          SKIP_ONE(x);                            \
180          *pDst = y >> shift;                     \          store24(pDst, y << truncatedBits);      \
181          pDst += dstStep          pDst += dstStep
182    
183          switch (compressionmode) {          switch (compressionmode) {
184              case 2: // 24 bit uncompressed              case 2: // 24 bit uncompressed
185                  pSrc += currentframeoffset * 3;                  pSrc += currentframeoffset * 3;
186                  while (copysamples) {                  while (copysamples) {
187                      *pDst = get24(pSrc) >> shift;                      store24(pDst, get24(pSrc) << truncatedBits);
188                      pDst += dstStep;                      pDst += dstStep;
189                      pSrc += 3;                      pSrc += 3;
190                      copysamples--;                      copysamples--;
# Line 226  namespace { Line 254  namespace {
254  }  }
255    
256    
257    
258    // *************** Other Internal functions  ***************
259    // *
260    
261        static split_type_t __resolveSplitType(dimension_t dimension) {
262            return (
263                dimension == dimension_layer ||
264                dimension == dimension_samplechannel ||
265                dimension == dimension_releasetrigger ||
266                dimension == dimension_keyboard ||
267                dimension == dimension_roundrobin ||
268                dimension == dimension_random ||
269                dimension == dimension_smartmidi ||
270                dimension == dimension_roundrobinkeyboard
271            ) ? split_type_bit : split_type_normal;
272        }
273    
274        static int __resolveZoneSize(dimension_def_t& dimension_definition) {
275            return (dimension_definition.split_type == split_type_normal)
276            ? int(128.0 / dimension_definition.zones) : 0;
277        }
278    
279    
280    
281    // *************** CRC ***************
282    // *
283    
284        const uint32_t* CRC::table(initTable());
285    
286        uint32_t* CRC::initTable() {
287            uint32_t* res = new uint32_t[256];
288    
289            for (int i = 0 ; i < 256 ; i++) {
290                uint32_t c = i;
291                for (int j = 0 ; j < 8 ; j++) {
292                    c = (c & 1) ? 0xedb88320 ^ (c >> 1) : c >> 1;
293                }
294                res[i] = c;
295            }
296            return res;
297        }
298    
299    
300    
301  // *************** Sample ***************  // *************** Sample ***************
302  // *  // *
303    
304      unsigned int Sample::Instances = 0;      unsigned int Sample::Instances = 0;
305      buffer_t     Sample::InternalDecompressionBuffer;      buffer_t     Sample::InternalDecompressionBuffer;
306    
307        /** @brief Constructor.
308         *
309         * Load an existing sample or create a new one. A 'wave' list chunk must
310         * be given to this constructor. In case the given 'wave' list chunk
311         * contains a 'fmt', 'data' (and optionally a '3gix', 'smpl') chunk, the
312         * format and sample data will be loaded from there, otherwise default
313         * values will be used and those chunks will be created when
314         * File::Save() will be called later on.
315         *
316         * @param pFile          - pointer to gig::File where this sample is
317         *                         located (or will be located)
318         * @param waveList       - pointer to 'wave' list chunk which is (or
319         *                         will be) associated with this sample
320         * @param WavePoolOffset - offset of this sample data from wave pool
321         *                         ('wvpl') list chunk
322         * @param fileNo         - number of an extension file where this sample
323         *                         is located, 0 otherwise
324         */
325      Sample::Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {      Sample::Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {
326            static const DLS::Info::FixedStringLength fixedStringLengths[] = {
327                { CHUNK_ID_INAM, 64 },
328                { 0, 0 }
329            };
330            pInfo->FixedStringLengths = fixedStringLengths;
331          Instances++;          Instances++;
332          FileNo = fileNo;          FileNo = fileNo;
333    
334          RIFF::Chunk* _3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);          pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);
335          if (!_3gix) throw gig::Exception("Mandatory chunks in <wave> list chunk not found.");          if (pCk3gix) {
336          SampleGroup = _3gix->ReadInt16();              uint16_t iSampleGroup = pCk3gix->ReadInt16();
337                pGroup = pFile->GetGroup(iSampleGroup);
338          RIFF::Chunk* smpl = waveList->GetSubChunk(CHUNK_ID_SMPL);          } else { // '3gix' chunk missing
339          if (!smpl) throw gig::Exception("Mandatory chunks in <wave> list chunk not found.");              // by default assigned to that mandatory "Default Group"
340          Manufacturer      = smpl->ReadInt32();              pGroup = pFile->GetGroup(0);
341          Product           = smpl->ReadInt32();          }
342          SamplePeriod      = smpl->ReadInt32();  
343          MIDIUnityNote     = smpl->ReadInt32();          pCkSmpl = waveList->GetSubChunk(CHUNK_ID_SMPL);
344          FineTune          = smpl->ReadInt32();          if (pCkSmpl) {
345          smpl->Read(&SMPTEFormat, 1, 4);              Manufacturer  = pCkSmpl->ReadInt32();
346          SMPTEOffset       = smpl->ReadInt32();              Product       = pCkSmpl->ReadInt32();
347          Loops             = smpl->ReadInt32();              SamplePeriod  = pCkSmpl->ReadInt32();
348          smpl->ReadInt32(); // manufByt              MIDIUnityNote = pCkSmpl->ReadInt32();
349          LoopID            = smpl->ReadInt32();              FineTune      = pCkSmpl->ReadInt32();
350          smpl->Read(&LoopType, 1, 4);              pCkSmpl->Read(&SMPTEFormat, 1, 4);
351          LoopStart         = smpl->ReadInt32();              SMPTEOffset   = pCkSmpl->ReadInt32();
352          LoopEnd           = smpl->ReadInt32();              Loops         = pCkSmpl->ReadInt32();
353          LoopFraction      = smpl->ReadInt32();              pCkSmpl->ReadInt32(); // manufByt
354          LoopPlayCount     = smpl->ReadInt32();              LoopID        = pCkSmpl->ReadInt32();
355                pCkSmpl->Read(&LoopType, 1, 4);
356                LoopStart     = pCkSmpl->ReadInt32();
357                LoopEnd       = pCkSmpl->ReadInt32();
358                LoopFraction  = pCkSmpl->ReadInt32();
359                LoopPlayCount = pCkSmpl->ReadInt32();
360            } else { // 'smpl' chunk missing
361                // use default values
362                Manufacturer  = 0;
363                Product       = 0;
364                SamplePeriod  = uint32_t(1000000000.0 / SamplesPerSecond + 0.5);
365                MIDIUnityNote = 60;
366                FineTune      = 0;
367                SMPTEFormat   = smpte_format_no_offset;
368                SMPTEOffset   = 0;
369                Loops         = 0;
370                LoopID        = 0;
371                LoopType      = loop_type_normal;
372                LoopStart     = 0;
373                LoopEnd       = 0;
374                LoopFraction  = 0;
375                LoopPlayCount = 0;
376            }
377    
378          FrameTable                 = NULL;          FrameTable                 = NULL;
379          SamplePos                  = 0;          SamplePos                  = 0;
# Line 287  namespace { Line 404  namespace {
404          }          }
405          FrameOffset = 0; // just for streaming compressed samples          FrameOffset = 0; // just for streaming compressed samples
406    
407          LoopSize = LoopEnd - LoopStart;          LoopSize = LoopEnd - LoopStart + 1;
408        }
409    
410        /**
411         * Apply sample and its settings to the respective RIFF chunks. You have
412         * to call File::Save() to make changes persistent.
413         *
414         * Usually there is absolutely no need to call this method explicitly.
415         * It will be called automatically when File::Save() was called.
416         *
417         * @throws DLS::Exception if FormatTag != DLS_WAVE_FORMAT_PCM or no sample data
418         *                        was provided yet
419         * @throws gig::Exception if there is any invalid sample setting
420         */
421        void Sample::UpdateChunks() {
422            // first update base class's chunks
423            DLS::Sample::UpdateChunks();
424    
425            // make sure 'smpl' chunk exists
426            pCkSmpl = pWaveList->GetSubChunk(CHUNK_ID_SMPL);
427            if (!pCkSmpl) {
428                pCkSmpl = pWaveList->AddSubChunk(CHUNK_ID_SMPL, 60);
429                memset(pCkSmpl->LoadChunkData(), 0, 60);
430            }
431            // update 'smpl' chunk
432            uint8_t* pData = (uint8_t*) pCkSmpl->LoadChunkData();
433            SamplePeriod = uint32_t(1000000000.0 / SamplesPerSecond + 0.5);
434            store32(&pData[0], Manufacturer);
435            store32(&pData[4], Product);
436            store32(&pData[8], SamplePeriod);
437            store32(&pData[12], MIDIUnityNote);
438            store32(&pData[16], FineTune);
439            store32(&pData[20], SMPTEFormat);
440            store32(&pData[24], SMPTEOffset);
441            store32(&pData[28], Loops);
442    
443            // we skip 'manufByt' for now (4 bytes)
444    
445            store32(&pData[36], LoopID);
446            store32(&pData[40], LoopType);
447            store32(&pData[44], LoopStart);
448            store32(&pData[48], LoopEnd);
449            store32(&pData[52], LoopFraction);
450            store32(&pData[56], LoopPlayCount);
451    
452            // make sure '3gix' chunk exists
453            pCk3gix = pWaveList->GetSubChunk(CHUNK_ID_3GIX);
454            if (!pCk3gix) pCk3gix = pWaveList->AddSubChunk(CHUNK_ID_3GIX, 4);
455            // determine appropriate sample group index (to be stored in chunk)
456            uint16_t iSampleGroup = 0; // 0 refers to default sample group
457            File* pFile = static_cast<File*>(pParent);
458            if (pFile->pGroups) {
459                std::list<Group*>::iterator iter = pFile->pGroups->begin();
460                std::list<Group*>::iterator end  = pFile->pGroups->end();
461                for (int i = 0; iter != end; i++, iter++) {
462                    if (*iter == pGroup) {
463                        iSampleGroup = i;
464                        break; // found
465                    }
466                }
467            }
468            // update '3gix' chunk
469            pData = (uint8_t*) pCk3gix->LoadChunkData();
470            store16(&pData[0], iSampleGroup);
471      }      }
472    
473      /// Scans compressed samples for mandatory informations (e.g. actual number of total sample points).      /// Scans compressed samples for mandatory informations (e.g. actual number of total sample points).
# Line 490  namespace { Line 670  namespace {
670          RAMCache.Size   = 0;          RAMCache.Size   = 0;
671      }      }
672    
673        /** @brief Resize sample.
674         *
675         * Resizes the sample's wave form data, that is the actual size of
676         * sample wave data possible to be written for this sample. This call
677         * will return immediately and just schedule the resize operation. You
678         * should call File::Save() to actually perform the resize operation(s)
679         * "physically" to the file. As this can take a while on large files, it
680         * is recommended to call Resize() first on all samples which have to be
681         * resized and finally to call File::Save() to perform all those resize
682         * operations in one rush.
683         *
684         * The actual size (in bytes) is dependant to the current FrameSize
685         * value. You may want to set FrameSize before calling Resize().
686         *
687         * <b>Caution:</b> You cannot directly write (i.e. with Write()) to
688         * enlarged samples before calling File::Save() as this might exceed the
689         * current sample's boundary!
690         *
691         * Also note: only DLS_WAVE_FORMAT_PCM is currently supported, that is
692         * FormatTag must be DLS_WAVE_FORMAT_PCM. Trying to resize samples with
693         * other formats will fail!
694         *
695         * @param iNewSize - new sample wave data size in sample points (must be
696         *                   greater than zero)
697         * @throws DLS::Excecption if FormatTag != DLS_WAVE_FORMAT_PCM
698         *                         or if \a iNewSize is less than 1
699         * @throws gig::Exception if existing sample is compressed
700         * @see DLS::Sample::GetSize(), DLS::Sample::FrameSize,
701         *      DLS::Sample::FormatTag, File::Save()
702         */
703        void Sample::Resize(int iNewSize) {
704            if (Compressed) throw gig::Exception("There is no support for modifying compressed samples (yet)");
705            DLS::Sample::Resize(iNewSize);
706        }
707    
708      /**      /**
709       * Sets the position within the sample (in sample points, not in       * Sets the position within the sample (in sample points, not in
710       * bytes). Use this method and <i>Read()</i> if you don't want to load       * bytes). Use this method and <i>Read()</i> if you don't want to load
# Line 579  namespace { Line 794  namespace {
794       * @param SampleCount      number of sample points to read       * @param SampleCount      number of sample points to read
795       * @param pPlaybackState   will be used to store and reload the playback       * @param pPlaybackState   will be used to store and reload the playback
796       *                         state for the next ReadAndLoop() call       *                         state for the next ReadAndLoop() call
797         * @param pDimRgn          dimension region with looping information
798       * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression       * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression
799       * @returns                number of successfully read sample points       * @returns                number of successfully read sample points
800       * @see                    CreateDecompressionBuffer()       * @see                    CreateDecompressionBuffer()
801       */       */
802      unsigned long Sample::ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState, buffer_t* pExternalDecompressionBuffer) {      unsigned long Sample::ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState,
803                                          DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer) {
804          unsigned long samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;          unsigned long samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;
805          uint8_t* pDst = (uint8_t*) pBuffer;          uint8_t* pDst = (uint8_t*) pBuffer;
806    
807          SetPos(pPlaybackState->position); // recover position from the last time          SetPos(pPlaybackState->position); // recover position from the last time
808    
809          if (this->Loops && GetPos() <= this->LoopEnd) { // honor looping if there are loop points defined          if (pDimRgn->SampleLoops) { // honor looping if there are loop points defined
810    
811              switch (this->LoopType) {              const DLS::sample_loop_t& loop = pDimRgn->pSampleLoops[0];
812                const uint32_t loopEnd = loop.LoopStart + loop.LoopLength;
813    
814                  case loop_type_bidirectional: { //TODO: not tested yet!              if (GetPos() <= loopEnd) {
815                      do {                  switch (loop.LoopType) {
                         // if not endless loop check if max. number of loop cycles have been passed  
                         if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;  
   
                         if (!pPlaybackState->reverse) { // forward playback  
                             do {  
                                 samplestoloopend  = this->LoopEnd - GetPos();  
                                 readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);  
                                 samplestoread    -= readsamples;  
                                 totalreadsamples += readsamples;  
                                 if (readsamples == samplestoloopend) {  
                                     pPlaybackState->reverse = true;  
                                     break;  
                                 }  
                             } while (samplestoread && readsamples);  
                         }  
                         else { // backward playback  
816    
817                              // as we can only read forward from disk, we have to                      case loop_type_bidirectional: { //TODO: not tested yet!
818                              // determine the end position within the loop first,                          do {
819                              // read forward from that 'end' and finally after                              // if not endless loop check if max. number of loop cycles have been passed
820                              // reading, swap all sample frames so it reflects                              if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
821                              // backward playback  
822                                if (!pPlaybackState->reverse) { // forward playback
823                              unsigned long swapareastart       = totalreadsamples;                                  do {
824                              unsigned long loopoffset          = GetPos() - this->LoopStart;                                      samplestoloopend  = loopEnd - GetPos();
825                              unsigned long samplestoreadinloop = Min(samplestoread, loopoffset);                                      readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
826                              unsigned long reverseplaybackend  = GetPos() - samplestoreadinloop;                                      samplestoread    -= readsamples;
827                                        totalreadsamples += readsamples;
828                              SetPos(reverseplaybackend);                                      if (readsamples == samplestoloopend) {
829                                            pPlaybackState->reverse = true;
830                              // read samples for backward playback                                          break;
831                              do {                                      }
832                                  readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], samplestoreadinloop, pExternalDecompressionBuffer);                                  } while (samplestoread && readsamples);
833                                  samplestoreadinloop -= readsamples;                              }
834                                  samplestoread       -= readsamples;                              else { // backward playback
                                 totalreadsamples    += readsamples;  
                             } while (samplestoreadinloop && readsamples);  
835    
836                              SetPos(reverseplaybackend); // pretend we really read backwards                                  // as we can only read forward from disk, we have to
837                                    // determine the end position within the loop first,
838                                    // read forward from that 'end' and finally after
839                                    // reading, swap all sample frames so it reflects
840                                    // backward playback
841    
842                                    unsigned long swapareastart       = totalreadsamples;
843                                    unsigned long loopoffset          = GetPos() - loop.LoopStart;
844                                    unsigned long samplestoreadinloop = Min(samplestoread, loopoffset);
845                                    unsigned long reverseplaybackend  = GetPos() - samplestoreadinloop;
846    
847                                    SetPos(reverseplaybackend);
848    
849                                    // read samples for backward playback
850                                    do {
851                                        readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], samplestoreadinloop, pExternalDecompressionBuffer);
852                                        samplestoreadinloop -= readsamples;
853                                        samplestoread       -= readsamples;
854                                        totalreadsamples    += readsamples;
855                                    } while (samplestoreadinloop && readsamples);
856    
857                                    SetPos(reverseplaybackend); // pretend we really read backwards
858    
859                                    if (reverseplaybackend == loop.LoopStart) {
860                                        pPlaybackState->loop_cycles_left--;
861                                        pPlaybackState->reverse = false;
862                                    }
863    
864                              if (reverseplaybackend == this->LoopStart) {                                  // reverse the sample frames for backward playback
865                                  pPlaybackState->loop_cycles_left--;                                  SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
                                 pPlaybackState->reverse = false;  
866                              }                              }
867                            } while (samplestoread && readsamples);
868                            break;
869                        }
870    
871                              // reverse the sample frames for backward playback                      case loop_type_backward: { // TODO: not tested yet!
872                              SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);                          // forward playback (not entered the loop yet)
873                          }                          if (!pPlaybackState->reverse) do {
874                      } while (samplestoread && readsamples);                              samplestoloopend  = loopEnd - GetPos();
875                      break;                              readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
876                  }                              samplestoread    -= readsamples;
877                                totalreadsamples += readsamples;
878                  case loop_type_backward: { // TODO: not tested yet!                              if (readsamples == samplestoloopend) {
879                      // forward playback (not entered the loop yet)                                  pPlaybackState->reverse = true;
880                      if (!pPlaybackState->reverse) do {                                  break;
881                          samplestoloopend  = this->LoopEnd - GetPos();                              }
882                          readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);                          } while (samplestoread && readsamples);
                         samplestoread    -= readsamples;  
                         totalreadsamples += readsamples;  
                         if (readsamples == samplestoloopend) {  
                             pPlaybackState->reverse = true;  
                             break;  
                         }  
                     } while (samplestoread && readsamples);  
883    
884                      if (!samplestoread) break;                          if (!samplestoread) break;
885    
886                      // as we can only read forward from disk, we have to                          // as we can only read forward from disk, we have to
887                      // determine the end position within the loop first,                          // determine the end position within the loop first,
888                      // read forward from that 'end' and finally after                          // read forward from that 'end' and finally after
889                      // reading, swap all sample frames so it reflects                          // reading, swap all sample frames so it reflects
890                      // backward playback                          // backward playback
891    
892                      unsigned long swapareastart       = totalreadsamples;                          unsigned long swapareastart       = totalreadsamples;
893                      unsigned long loopoffset          = GetPos() - this->LoopStart;                          unsigned long loopoffset          = GetPos() - loop.LoopStart;
894                      unsigned long samplestoreadinloop = (this->LoopPlayCount) ? Min(samplestoread, pPlaybackState->loop_cycles_left * LoopSize - loopoffset)                          unsigned long samplestoreadinloop = (this->LoopPlayCount) ? Min(samplestoread, pPlaybackState->loop_cycles_left * loop.LoopLength - loopoffset)
895                                                                                : samplestoread;                                                                                    : samplestoread;
896                      unsigned long reverseplaybackend  = this->LoopStart + Abs((loopoffset - samplestoreadinloop) % this->LoopSize);                          unsigned long reverseplaybackend  = loop.LoopStart + Abs((loopoffset - samplestoreadinloop) % loop.LoopLength);
897    
898                      SetPos(reverseplaybackend);                          SetPos(reverseplaybackend);
899    
900                      // read samples for backward playback                          // read samples for backward playback
901                      do {                          do {
902                          // if not endless loop check if max. number of loop cycles have been passed                              // if not endless loop check if max. number of loop cycles have been passed
903                          if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;                              if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
904                          samplestoloopend     = this->LoopEnd - GetPos();                              samplestoloopend     = loopEnd - GetPos();
905                          readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoreadinloop, samplestoloopend), pExternalDecompressionBuffer);                              readsamples          = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoreadinloop, samplestoloopend), pExternalDecompressionBuffer);
906                          samplestoreadinloop -= readsamples;                              samplestoreadinloop -= readsamples;
907                          samplestoread       -= readsamples;                              samplestoread       -= readsamples;
908                          totalreadsamples    += readsamples;                              totalreadsamples    += readsamples;
909                          if (readsamples == samplestoloopend) {                              if (readsamples == samplestoloopend) {
910                              pPlaybackState->loop_cycles_left--;                                  pPlaybackState->loop_cycles_left--;
911                              SetPos(this->LoopStart);                                  SetPos(loop.LoopStart);
912                          }                              }
913                      } while (samplestoreadinloop && readsamples);                          } while (samplestoreadinloop && readsamples);
914    
915                      SetPos(reverseplaybackend); // pretend we really read backwards                          SetPos(reverseplaybackend); // pretend we really read backwards
916    
917                      // reverse the sample frames for backward playback                          // reverse the sample frames for backward playback
918                      SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);                          SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
919                      break;                          break;
920                  }                      }
921    
922                  default: case loop_type_normal: {                      default: case loop_type_normal: {
923                      do {                          do {
924                          // if not endless loop check if max. number of loop cycles have been passed                              // if not endless loop check if max. number of loop cycles have been passed
925                          if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;                              if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
926                          samplestoloopend  = this->LoopEnd - GetPos();                              samplestoloopend  = loopEnd - GetPos();
927                          readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);                              readsamples       = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
928                          samplestoread    -= readsamples;                              samplestoread    -= readsamples;
929                          totalreadsamples += readsamples;                              totalreadsamples += readsamples;
930                          if (readsamples == samplestoloopend) {                              if (readsamples == samplestoloopend) {
931                              pPlaybackState->loop_cycles_left--;                                  pPlaybackState->loop_cycles_left--;
932                              SetPos(this->LoopStart);                                  SetPos(loop.LoopStart);
933                          }                              }
934                      } while (samplestoread && readsamples);                          } while (samplestoread && readsamples);
935                      break;                          break;
936                        }
937                  }                  }
938              }              }
939          }          }
# Line 741  namespace { Line 963  namespace {
963       * have to use an external decompression buffer for <b>EACH</b>       * have to use an external decompression buffer for <b>EACH</b>
964       * streaming thread to avoid race conditions and crashes!       * streaming thread to avoid race conditions and crashes!
965       *       *
966         * For 16 bit samples, the data in the buffer will be int16_t
967         * (using native endianness). For 24 bit, the buffer will
968         * contain three bytes per sample, little-endian.
969         *
970       * @param pBuffer      destination buffer       * @param pBuffer      destination buffer
971       * @param SampleCount  number of sample points to read       * @param SampleCount  number of sample points to read
972       * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression       * @param pExternalDecompressionBuffer  (optional) external buffer to use for decompression
# Line 751  namespace { Line 977  namespace {
977          if (SampleCount == 0) return 0;          if (SampleCount == 0) return 0;
978          if (!Compressed) {          if (!Compressed) {
979              if (BitDepth == 24) {              if (BitDepth == 24) {
980                  // 24 bit sample. For now just truncate to 16 bit.                  return pCkData->Read(pBuffer, SampleCount * FrameSize, 1) / FrameSize;
                 unsigned char* pSrc = (unsigned char*) ((pExternalDecompressionBuffer) ? pExternalDecompressionBuffer->pStart : this->InternalDecompressionBuffer.pStart);  
                 int16_t* pDst = static_cast<int16_t*>(pBuffer);  
                 if (Channels == 2) { // Stereo  
                     unsigned long readBytes = pCkData->Read(pSrc, SampleCount * 6, 1);  
                     pSrc++;  
                     for (unsigned long i = readBytes ; i > 0 ; i -= 3) {  
                         *pDst++ = get16(pSrc);  
                         pSrc += 3;  
                     }  
                     return (pDst - static_cast<int16_t*>(pBuffer)) >> 1;  
                 }  
                 else { // Mono  
                     unsigned long readBytes = pCkData->Read(pSrc, SampleCount * 3, 1);  
                     pSrc++;  
                     for (unsigned long i = readBytes ; i > 0 ; i -= 3) {  
                         *pDst++ = get16(pSrc);  
                         pSrc += 3;  
                     }  
                     return pDst - static_cast<int16_t*>(pBuffer);  
                 }  
981              }              }
982              else { // 16 bit              else { // 16 bit
983                  // (pCkData->Read does endian correction)                  // (pCkData->Read does endian correction)
# Line 801  namespace { Line 1007  namespace {
1007    
1008              unsigned char* pSrc = (unsigned char*) pDecompressionBuffer->pStart;              unsigned char* pSrc = (unsigned char*) pDecompressionBuffer->pStart;
1009              int16_t* pDst = static_cast<int16_t*>(pBuffer);              int16_t* pDst = static_cast<int16_t*>(pBuffer);
1010                uint8_t* pDst24 = static_cast<uint8_t*>(pBuffer);
1011              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);              remainingbytes = pCkData->Read(pSrc, assumedsize, 1);
1012    
1013              while (remainingsamples && remainingbytes) {              while (remainingsamples && remainingbytes) {
# Line 882  namespace { Line 1089  namespace {
1089                              const unsigned char* const param_r = pSrc;                              const unsigned char* const param_r = pSrc;
1090                              if (mode_r != 2) pSrc += 12;                              if (mode_r != 2) pSrc += 12;
1091    
1092                              Decompress24(mode_l, param_l, 2, pSrc, pDst,                              Decompress24(mode_l, param_l, 6, pSrc, pDst24,
1093                                           skipsamples, copysamples, TruncatedBits);                                           skipsamples, copysamples, TruncatedBits);
1094                              Decompress24(mode_r, param_r, 2, pSrc + rightChannelOffset, pDst + 1,                              Decompress24(mode_r, param_r, 6, pSrc + rightChannelOffset, pDst24 + 3,
1095                                           skipsamples, copysamples, TruncatedBits);                                           skipsamples, copysamples, TruncatedBits);
1096                              pDst += copysamples << 1;                              pDst24 += copysamples * 6;
1097                          }                          }
1098                          else { // Mono                          else { // Mono
1099                              Decompress24(mode_l, param_l, 1, pSrc, pDst,                              Decompress24(mode_l, param_l, 3, pSrc, pDst24,
1100                                           skipsamples, copysamples, TruncatedBits);                                           skipsamples, copysamples, TruncatedBits);
1101                              pDst += copysamples;                              pDst24 += copysamples * 3;
1102                          }                          }
1103                      }                      }
1104                      else { // 16 bit                      else { // 16 bit
# Line 933  namespace { Line 1140  namespace {
1140          }          }
1141      }      }
1142    
1143        /** @brief Write sample wave data.
1144         *
1145         * Writes \a SampleCount number of sample points from the buffer pointed
1146         * by \a pBuffer and increments the position within the sample. Use this
1147         * method to directly write the sample data to disk, i.e. if you don't
1148         * want or cannot load the whole sample data into RAM.
1149         *
1150         * You have to Resize() the sample to the desired size and call
1151         * File::Save() <b>before</b> using Write().
1152         *
1153         * Note: there is currently no support for writing compressed samples.
1154         *
1155         * For 16 bit samples, the data in the source buffer should be
1156         * int16_t (using native endianness). For 24 bit, the buffer
1157         * should contain three bytes per sample, little-endian.
1158         *
1159         * @param pBuffer     - source buffer
1160         * @param SampleCount - number of sample points to write
1161         * @throws DLS::Exception if current sample size is too small
1162         * @throws gig::Exception if sample is compressed
1163         * @see DLS::LoadSampleData()
1164         */
1165        unsigned long Sample::Write(void* pBuffer, unsigned long SampleCount) {
1166            if (Compressed) throw gig::Exception("There is no support for writing compressed gig samples (yet)");
1167    
1168            // if this is the first write in this sample, reset the
1169            // checksum calculator
1170            if (pCkData->GetPos() == 0) {
1171                crc.reset();
1172            }
1173            if (GetSize() < SampleCount) throw Exception("Could not write sample data, current sample size to small");
1174            unsigned long res;
1175            if (BitDepth == 24) {
1176                res = pCkData->Write(pBuffer, SampleCount * FrameSize, 1) / FrameSize;
1177            } else { // 16 bit
1178                res = Channels == 2 ? pCkData->Write(pBuffer, SampleCount << 1, 2) >> 1
1179                                    : pCkData->Write(pBuffer, SampleCount, 2);
1180            }
1181            crc.update((unsigned char *)pBuffer, SampleCount * FrameSize);
1182    
1183            // if this is the last write, update the checksum chunk in the
1184            // file
1185            if (pCkData->GetPos() == pCkData->GetSize()) {
1186                File* pFile = static_cast<File*>(GetParent());
1187                pFile->SetSampleChecksum(this, crc.getValue());
1188            }
1189            return res;
1190        }
1191    
1192      /**      /**
1193       * Allocates a decompression buffer for streaming (compressed) samples       * Allocates a decompression buffer for streaming (compressed) samples
1194       * with Sample::Read(). If you are using more than one streaming thread       * with Sample::Read(). If you are using more than one streaming thread
# Line 975  namespace { Line 1231  namespace {
1231          }          }
1232      }      }
1233    
1234        /**
1235         * Returns pointer to the Group this Sample belongs to. In the .gig
1236         * format a sample always belongs to one group. If it wasn't explicitly
1237         * assigned to a certain group, it will be automatically assigned to a
1238         * default group.
1239         *
1240         * @returns Sample's Group (never NULL)
1241         */
1242        Group* Sample::GetGroup() const {
1243            return pGroup;
1244        }
1245    
1246      Sample::~Sample() {      Sample::~Sample() {
1247          Instances--;          Instances--;
1248          if (!Instances && InternalDecompressionBuffer.Size) {          if (!Instances && InternalDecompressionBuffer.Size) {
# Line 994  namespace { Line 1262  namespace {
1262      uint                               DimensionRegion::Instances       = 0;      uint                               DimensionRegion::Instances       = 0;
1263      DimensionRegion::VelocityTableMap* DimensionRegion::pVelocityTables = NULL;      DimensionRegion::VelocityTableMap* DimensionRegion::pVelocityTables = NULL;
1264    
1265      DimensionRegion::DimensionRegion(RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {      DimensionRegion::DimensionRegion(Region* pParent, RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {
1266          Instances++;          Instances++;
1267    
1268          memcpy(&Crossfade, &SamplerOptions, 4);          pSample = NULL;
1269            pRegion = pParent;
1270    
1271            if (_3ewl->GetSubChunk(CHUNK_ID_WSMP)) memcpy(&Crossfade, &SamplerOptions, 4);
1272            else memset(&Crossfade, 0, 4);
1273    
1274          if (!pVelocityTables) pVelocityTables = new VelocityTableMap;          if (!pVelocityTables) pVelocityTables = new VelocityTableMap;
1275    
1276          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);          RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);
1277          _3ewa->ReadInt32(); // unknown, always 0x0000008C ?          if (_3ewa) { // if '3ewa' chunk exists
1278          LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              _3ewa->ReadInt32(); // unknown, always == chunk size ?
1279          EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1280          _3ewa->ReadInt16(); // unknown              EG3Attack     = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1281          LFO1InternalDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1282          _3ewa->ReadInt16(); // unknown              LFO1InternalDepth = _3ewa->ReadUint16();
1283          LFO3InternalDepth = _3ewa->ReadInt16();              _3ewa->ReadInt16(); // unknown
1284          _3ewa->ReadInt16(); // unknown              LFO3InternalDepth = _3ewa->ReadInt16();
1285          LFO1ControlDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1286          _3ewa->ReadInt16(); // unknown              LFO1ControlDepth = _3ewa->ReadUint16();
1287          LFO3ControlDepth = _3ewa->ReadInt16();              _3ewa->ReadInt16(); // unknown
1288          EG1Attack           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO3ControlDepth = _3ewa->ReadInt16();
1289          EG1Decay1           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG1Attack           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1290          _3ewa->ReadInt16(); // unknown              EG1Decay1           = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1291          EG1Sustain          = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1292          EG1Release          = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG1Sustain          = _3ewa->ReadUint16();
1293          EG1Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));              EG1Release          = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1294          uint8_t eg1ctrloptions        = _3ewa->ReadUint8();              EG1Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1295          EG1ControllerInvert           = eg1ctrloptions & 0x01;              uint8_t eg1ctrloptions        = _3ewa->ReadUint8();
1296          EG1ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg1ctrloptions);              EG1ControllerInvert           = eg1ctrloptions & 0x01;
1297          EG1ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg1ctrloptions);              EG1ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg1ctrloptions);
1298          EG1ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg1ctrloptions);              EG1ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg1ctrloptions);
1299          EG2Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));              EG1ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg1ctrloptions);
1300          uint8_t eg2ctrloptions        = _3ewa->ReadUint8();              EG2Controller       = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1301          EG2ControllerInvert           = eg2ctrloptions & 0x01;              uint8_t eg2ctrloptions        = _3ewa->ReadUint8();
1302          EG2ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg2ctrloptions);              EG2ControllerInvert           = eg2ctrloptions & 0x01;
1303          EG2ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg2ctrloptions);              EG2ControllerAttackInfluence  = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg2ctrloptions);
1304          EG2ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg2ctrloptions);              EG2ControllerDecayInfluence   = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg2ctrloptions);
1305          LFO1Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG2ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg2ctrloptions);
1306          EG2Attack        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO1Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1307          EG2Decay1        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG2Attack        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1308          _3ewa->ReadInt16(); // unknown              EG2Decay1        = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1309          EG2Sustain       = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1310          EG2Release       = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              EG2Sustain       = _3ewa->ReadUint16();
1311          _3ewa->ReadInt16(); // unknown              EG2Release       = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1312          LFO2ControlDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1313          LFO2Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());              LFO2ControlDepth = _3ewa->ReadUint16();
1314          _3ewa->ReadInt16(); // unknown              LFO2Frequency    = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1315          LFO2InternalDepth = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1316          int32_t eg1decay2 = _3ewa->ReadInt32();              LFO2InternalDepth = _3ewa->ReadUint16();
1317          EG1Decay2          = (double) GIG_EXP_DECODE(eg1decay2);              int32_t eg1decay2 = _3ewa->ReadInt32();
1318          EG1InfiniteSustain = (eg1decay2 == 0x7fffffff);              EG1Decay2          = (double) GIG_EXP_DECODE(eg1decay2);
1319          _3ewa->ReadInt16(); // unknown              EG1InfiniteSustain = (eg1decay2 == 0x7fffffff);
1320          EG1PreAttack      = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1321          int32_t eg2decay2 = _3ewa->ReadInt32();              EG1PreAttack      = _3ewa->ReadUint16();
1322          EG2Decay2         = (double) GIG_EXP_DECODE(eg2decay2);              int32_t eg2decay2 = _3ewa->ReadInt32();
1323          EG2InfiniteSustain = (eg2decay2 == 0x7fffffff);              EG2Decay2         = (double) GIG_EXP_DECODE(eg2decay2);
1324          _3ewa->ReadInt16(); // unknown              EG2InfiniteSustain = (eg2decay2 == 0x7fffffff);
1325          EG2PreAttack      = _3ewa->ReadUint16();              _3ewa->ReadInt16(); // unknown
1326          uint8_t velocityresponse = _3ewa->ReadUint8();              EG2PreAttack      = _3ewa->ReadUint16();
1327          if (velocityresponse < 5) {              uint8_t velocityresponse = _3ewa->ReadUint8();
1328              VelocityResponseCurve = curve_type_nonlinear;              if (velocityresponse < 5) {
1329              VelocityResponseDepth = velocityresponse;                  VelocityResponseCurve = curve_type_nonlinear;
1330          }                  VelocityResponseDepth = velocityresponse;
1331          else if (velocityresponse < 10) {              } else if (velocityresponse < 10) {
1332              VelocityResponseCurve = curve_type_linear;                  VelocityResponseCurve = curve_type_linear;
1333              VelocityResponseDepth = velocityresponse - 5;                  VelocityResponseDepth = velocityresponse - 5;
1334          }              } else if (velocityresponse < 15) {
1335          else if (velocityresponse < 15) {                  VelocityResponseCurve = curve_type_special;
1336              VelocityResponseCurve = curve_type_special;                  VelocityResponseDepth = velocityresponse - 10;
1337              VelocityResponseDepth = velocityresponse - 10;              } else {
1338          }                  VelocityResponseCurve = curve_type_unknown;
1339          else {                  VelocityResponseDepth = 0;
1340              VelocityResponseCurve = curve_type_unknown;              }
1341              VelocityResponseDepth = 0;              uint8_t releasevelocityresponse = _3ewa->ReadUint8();
1342          }              if (releasevelocityresponse < 5) {
1343          uint8_t releasevelocityresponse = _3ewa->ReadUint8();                  ReleaseVelocityResponseCurve = curve_type_nonlinear;
1344          if (releasevelocityresponse < 5) {                  ReleaseVelocityResponseDepth = releasevelocityresponse;
1345              ReleaseVelocityResponseCurve = curve_type_nonlinear;              } else if (releasevelocityresponse < 10) {
1346              ReleaseVelocityResponseDepth = releasevelocityresponse;                  ReleaseVelocityResponseCurve = curve_type_linear;
1347          }                  ReleaseVelocityResponseDepth = releasevelocityresponse - 5;
1348          else if (releasevelocityresponse < 10) {              } else if (releasevelocityresponse < 15) {
1349              ReleaseVelocityResponseCurve = curve_type_linear;                  ReleaseVelocityResponseCurve = curve_type_special;
1350              ReleaseVelocityResponseDepth = releasevelocityresponse - 5;                  ReleaseVelocityResponseDepth = releasevelocityresponse - 10;
1351          }              } else {
1352          else if (releasevelocityresponse < 15) {                  ReleaseVelocityResponseCurve = curve_type_unknown;
1353              ReleaseVelocityResponseCurve = curve_type_special;                  ReleaseVelocityResponseDepth = 0;
1354              ReleaseVelocityResponseDepth = releasevelocityresponse - 10;              }
1355          }              VelocityResponseCurveScaling = _3ewa->ReadUint8();
1356          else {              AttenuationControllerThreshold = _3ewa->ReadInt8();
1357              ReleaseVelocityResponseCurve = curve_type_unknown;              _3ewa->ReadInt32(); // unknown
1358              ReleaseVelocityResponseDepth = 0;              SampleStartOffset = (uint16_t) _3ewa->ReadInt16();
1359          }              _3ewa->ReadInt16(); // unknown
1360          VelocityResponseCurveScaling = _3ewa->ReadUint8();              uint8_t pitchTrackDimensionBypass = _3ewa->ReadInt8();
1361          AttenuationControllerThreshold = _3ewa->ReadInt8();              PitchTrack = GIG_PITCH_TRACK_EXTRACT(pitchTrackDimensionBypass);
1362          _3ewa->ReadInt32(); // unknown              if      (pitchTrackDimensionBypass & 0x10) DimensionBypass = dim_bypass_ctrl_94;
1363          SampleStartOffset = (uint16_t) _3ewa->ReadInt16();              else if (pitchTrackDimensionBypass & 0x20) DimensionBypass = dim_bypass_ctrl_95;
1364          _3ewa->ReadInt16(); // unknown              else                                       DimensionBypass = dim_bypass_ctrl_none;
1365          uint8_t pitchTrackDimensionBypass = _3ewa->ReadInt8();              uint8_t pan = _3ewa->ReadUint8();
1366          PitchTrack = GIG_PITCH_TRACK_EXTRACT(pitchTrackDimensionBypass);              Pan         = (pan < 64) ? pan : -((int)pan - 63); // signed 7 bit -> signed 8 bit
1367          if      (pitchTrackDimensionBypass & 0x10) DimensionBypass = dim_bypass_ctrl_94;              SelfMask = _3ewa->ReadInt8() & 0x01;
1368          else if (pitchTrackDimensionBypass & 0x20) DimensionBypass = dim_bypass_ctrl_95;              _3ewa->ReadInt8(); // unknown
1369          else                                       DimensionBypass = dim_bypass_ctrl_none;              uint8_t lfo3ctrl = _3ewa->ReadUint8();
1370          uint8_t pan = _3ewa->ReadUint8();              LFO3Controller           = static_cast<lfo3_ctrl_t>(lfo3ctrl & 0x07); // lower 3 bits
1371          Pan         = (pan < 64) ? pan : -((int)pan - 63); // signed 7 bit -> signed 8 bit              LFO3Sync                 = lfo3ctrl & 0x20; // bit 5
1372          SelfMask = _3ewa->ReadInt8() & 0x01;              InvertAttenuationController = lfo3ctrl & 0x80; // bit 7
1373          _3ewa->ReadInt8(); // unknown              AttenuationController  = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1374          uint8_t lfo3ctrl = _3ewa->ReadUint8();              uint8_t lfo2ctrl       = _3ewa->ReadUint8();
1375          LFO3Controller           = static_cast<lfo3_ctrl_t>(lfo3ctrl & 0x07); // lower 3 bits              LFO2Controller         = static_cast<lfo2_ctrl_t>(lfo2ctrl & 0x07); // lower 3 bits
1376          LFO3Sync                 = lfo3ctrl & 0x20; // bit 5              LFO2FlipPhase          = lfo2ctrl & 0x80; // bit 7
1377          InvertAttenuationController = lfo3ctrl & 0x80; // bit 7              LFO2Sync               = lfo2ctrl & 0x20; // bit 5
1378          AttenuationController  = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));              bool extResonanceCtrl  = lfo2ctrl & 0x40; // bit 6
1379          uint8_t lfo2ctrl       = _3ewa->ReadUint8();              uint8_t lfo1ctrl       = _3ewa->ReadUint8();
1380          LFO2Controller         = static_cast<lfo2_ctrl_t>(lfo2ctrl & 0x07); // lower 3 bits              LFO1Controller         = static_cast<lfo1_ctrl_t>(lfo1ctrl & 0x07); // lower 3 bits
1381          LFO2FlipPhase          = lfo2ctrl & 0x80; // bit 7              LFO1FlipPhase          = lfo1ctrl & 0x80; // bit 7
1382          LFO2Sync               = lfo2ctrl & 0x20; // bit 5              LFO1Sync               = lfo1ctrl & 0x40; // bit 6
1383          bool extResonanceCtrl  = lfo2ctrl & 0x40; // bit 6              VCFResonanceController = (extResonanceCtrl) ? static_cast<vcf_res_ctrl_t>(GIG_VCF_RESONANCE_CTRL_EXTRACT(lfo1ctrl))
1384          uint8_t lfo1ctrl       = _3ewa->ReadUint8();                                                          : vcf_res_ctrl_none;
1385          LFO1Controller         = static_cast<lfo1_ctrl_t>(lfo1ctrl & 0x07); // lower 3 bits              uint16_t eg3depth = _3ewa->ReadUint16();
1386          LFO1FlipPhase          = lfo1ctrl & 0x80; // bit 7              EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */
1387          LFO1Sync               = lfo1ctrl & 0x40; // bit 6                                          : (-1) * (int16_t) ((eg3depth ^ 0xffff) + 1); /* binary complementary for negatives */
1388          VCFResonanceController = (extResonanceCtrl) ? static_cast<vcf_res_ctrl_t>(GIG_VCF_RESONANCE_CTRL_EXTRACT(lfo1ctrl))              _3ewa->ReadInt16(); // unknown
1389                                                      : vcf_res_ctrl_none;              ChannelOffset = _3ewa->ReadUint8() / 4;
1390          uint16_t eg3depth = _3ewa->ReadUint16();              uint8_t regoptions = _3ewa->ReadUint8();
1391          EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */              MSDecode           = regoptions & 0x01; // bit 0
1392                                        : (-1) * (int16_t) ((eg3depth ^ 0xffff) + 1); /* binary complementary for negatives */              SustainDefeat      = regoptions & 0x02; // bit 1
1393          _3ewa->ReadInt16(); // unknown              _3ewa->ReadInt16(); // unknown
1394          ChannelOffset = _3ewa->ReadUint8() / 4;              VelocityUpperLimit = _3ewa->ReadInt8();
1395          uint8_t regoptions = _3ewa->ReadUint8();              _3ewa->ReadInt8(); // unknown
1396          MSDecode           = regoptions & 0x01; // bit 0              _3ewa->ReadInt16(); // unknown
1397          SustainDefeat      = regoptions & 0x02; // bit 1              ReleaseTriggerDecay = _3ewa->ReadUint8(); // release trigger decay
1398          _3ewa->ReadInt16(); // unknown              _3ewa->ReadInt8(); // unknown
1399          VelocityUpperLimit = _3ewa->ReadInt8();              _3ewa->ReadInt8(); // unknown
1400          _3ewa->ReadInt8(); // unknown              EG1Hold = _3ewa->ReadUint8() & 0x80; // bit 7
1401          _3ewa->ReadInt16(); // unknown              uint8_t vcfcutoff = _3ewa->ReadUint8();
1402          ReleaseTriggerDecay = _3ewa->ReadUint8(); // release trigger decay              VCFEnabled = vcfcutoff & 0x80; // bit 7
1403          _3ewa->ReadInt8(); // unknown              VCFCutoff  = vcfcutoff & 0x7f; // lower 7 bits
1404          _3ewa->ReadInt8(); // unknown              VCFCutoffController = static_cast<vcf_cutoff_ctrl_t>(_3ewa->ReadUint8());
1405          EG1Hold = _3ewa->ReadUint8() & 0x80; // bit 7              uint8_t vcfvelscale = _3ewa->ReadUint8();
1406          uint8_t vcfcutoff = _3ewa->ReadUint8();              VCFCutoffControllerInvert = vcfvelscale & 0x80; // bit 7
1407          VCFEnabled = vcfcutoff & 0x80; // bit 7              VCFVelocityScale = vcfvelscale & 0x7f; // lower 7 bits
1408          VCFCutoff  = vcfcutoff & 0x7f; // lower 7 bits              _3ewa->ReadInt8(); // unknown
1409          VCFCutoffController = static_cast<vcf_cutoff_ctrl_t>(_3ewa->ReadUint8());              uint8_t vcfresonance = _3ewa->ReadUint8();
1410          uint8_t vcfvelscale = _3ewa->ReadUint8();              VCFResonance = vcfresonance & 0x7f; // lower 7 bits
1411          VCFCutoffControllerInvert = vcfvelscale & 0x80; // bit 7              VCFResonanceDynamic = !(vcfresonance & 0x80); // bit 7
1412          VCFVelocityScale = vcfvelscale & 0x7f; // lower 7 bits              uint8_t vcfbreakpoint         = _3ewa->ReadUint8();
1413          _3ewa->ReadInt8(); // unknown              VCFKeyboardTracking           = vcfbreakpoint & 0x80; // bit 7
1414          uint8_t vcfresonance = _3ewa->ReadUint8();              VCFKeyboardTrackingBreakpoint = vcfbreakpoint & 0x7f; // lower 7 bits
1415          VCFResonance = vcfresonance & 0x7f; // lower 7 bits              uint8_t vcfvelocity = _3ewa->ReadUint8();
1416          VCFResonanceDynamic = !(vcfresonance & 0x80); // bit 7              VCFVelocityDynamicRange = vcfvelocity % 5;
1417          uint8_t vcfbreakpoint         = _3ewa->ReadUint8();              VCFVelocityCurve        = static_cast<curve_type_t>(vcfvelocity / 5);
1418          VCFKeyboardTracking           = vcfbreakpoint & 0x80; // bit 7              VCFType = static_cast<vcf_type_t>(_3ewa->ReadUint8());
1419          VCFKeyboardTrackingBreakpoint = vcfbreakpoint & 0x7f; // lower 7 bits              if (VCFType == vcf_type_lowpass) {
1420          uint8_t vcfvelocity = _3ewa->ReadUint8();                  if (lfo3ctrl & 0x40) // bit 6
1421          VCFVelocityDynamicRange = vcfvelocity % 5;                      VCFType = vcf_type_lowpassturbo;
1422          VCFVelocityCurve        = static_cast<curve_type_t>(vcfvelocity / 5);              }
1423          VCFType = static_cast<vcf_type_t>(_3ewa->ReadUint8());              if (_3ewa->RemainingBytes() >= 8) {
1424          if (VCFType == vcf_type_lowpass) {                  _3ewa->Read(DimensionUpperLimits, 1, 8);
1425              if (lfo3ctrl & 0x40) // bit 6              } else {
1426                  VCFType = vcf_type_lowpassturbo;                  memset(DimensionUpperLimits, 0, 8);
1427                }
1428            } else { // '3ewa' chunk does not exist yet
1429                // use default values
1430                LFO3Frequency                   = 1.0;
1431                EG3Attack                       = 0.0;
1432                LFO1InternalDepth               = 0;
1433                LFO3InternalDepth               = 0;
1434                LFO1ControlDepth                = 0;
1435                LFO3ControlDepth                = 0;
1436                EG1Attack                       = 0.0;
1437                EG1Decay1                       = 0.005;
1438                EG1Sustain                      = 1000;
1439                EG1Release                      = 0.3;
1440                EG1Controller.type              = eg1_ctrl_t::type_none;
1441                EG1Controller.controller_number = 0;
1442                EG1ControllerInvert             = false;
1443                EG1ControllerAttackInfluence    = 0;
1444                EG1ControllerDecayInfluence     = 0;
1445                EG1ControllerReleaseInfluence   = 0;
1446                EG2Controller.type              = eg2_ctrl_t::type_none;
1447                EG2Controller.controller_number = 0;
1448                EG2ControllerInvert             = false;
1449                EG2ControllerAttackInfluence    = 0;
1450                EG2ControllerDecayInfluence     = 0;
1451                EG2ControllerReleaseInfluence   = 0;
1452                LFO1Frequency                   = 1.0;
1453                EG2Attack                       = 0.0;
1454                EG2Decay1                       = 0.005;
1455                EG2Sustain                      = 1000;
1456                EG2Release                      = 0.3;
1457                LFO2ControlDepth                = 0;
1458                LFO2Frequency                   = 1.0;
1459                LFO2InternalDepth               = 0;
1460                EG1Decay2                       = 0.0;
1461                EG1InfiniteSustain              = true;
1462                EG1PreAttack                    = 0;
1463                EG2Decay2                       = 0.0;
1464                EG2InfiniteSustain              = true;
1465                EG2PreAttack                    = 0;
1466                VelocityResponseCurve           = curve_type_nonlinear;
1467                VelocityResponseDepth           = 3;
1468                ReleaseVelocityResponseCurve    = curve_type_nonlinear;
1469                ReleaseVelocityResponseDepth    = 3;
1470                VelocityResponseCurveScaling    = 32;
1471                AttenuationControllerThreshold  = 0;
1472                SampleStartOffset               = 0;
1473                PitchTrack                      = true;
1474                DimensionBypass                 = dim_bypass_ctrl_none;
1475                Pan                             = 0;
1476                SelfMask                        = true;
1477                LFO3Controller                  = lfo3_ctrl_modwheel;
1478                LFO3Sync                        = false;
1479                InvertAttenuationController     = false;
1480                AttenuationController.type      = attenuation_ctrl_t::type_none;
1481                AttenuationController.controller_number = 0;
1482                LFO2Controller                  = lfo2_ctrl_internal;
1483                LFO2FlipPhase                   = false;
1484                LFO2Sync                        = false;
1485                LFO1Controller                  = lfo1_ctrl_internal;
1486                LFO1FlipPhase                   = false;
1487                LFO1Sync                        = false;
1488                VCFResonanceController          = vcf_res_ctrl_none;
1489                EG3Depth                        = 0;
1490                ChannelOffset                   = 0;
1491                MSDecode                        = false;
1492                SustainDefeat                   = false;
1493                VelocityUpperLimit              = 0;
1494                ReleaseTriggerDecay             = 0;
1495                EG1Hold                         = false;
1496                VCFEnabled                      = false;
1497                VCFCutoff                       = 0;
1498                VCFCutoffController             = vcf_cutoff_ctrl_none;
1499                VCFCutoffControllerInvert       = false;
1500                VCFVelocityScale                = 0;
1501                VCFResonance                    = 0;
1502                VCFResonanceDynamic             = false;
1503                VCFKeyboardTracking             = false;
1504                VCFKeyboardTrackingBreakpoint   = 0;
1505                VCFVelocityDynamicRange         = 0x04;
1506                VCFVelocityCurve                = curve_type_linear;
1507                VCFType                         = vcf_type_lowpass;
1508                memset(DimensionUpperLimits, 127, 8);
1509          }          }
1510    
1511          pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,          pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,
# Line 1182  namespace { Line 1537  namespace {
1537              depth = 5;              depth = 5;
1538          }          }
1539          pVelocityCutoffTable = GetVelocityTable(curveType, depth,          pVelocityCutoffTable = GetVelocityTable(curveType, depth,
1540                                                  VCFCutoffController == vcf_cutoff_ctrl_none ? VCFVelocityScale : 0);                                                  VCFCutoffController <= vcf_cutoff_ctrl_none2 ? VCFVelocityScale : 0);
1541    
1542          SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));          SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));
1543            VelocityTable = 0;
1544        }
1545    
1546        /*
1547         * Constructs a DimensionRegion by copying all parameters from
1548         * another DimensionRegion
1549         */
1550        DimensionRegion::DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src) : DLS::Sampler(_3ewl) {
1551            Instances++;
1552            *this = src; // default memberwise shallow copy of all parameters
1553            pParentList = _3ewl; // restore the chunk pointer
1554    
1555            // deep copy of owned structures
1556            if (src.VelocityTable) {
1557                VelocityTable = new uint8_t[128];
1558                for (int k = 0 ; k < 128 ; k++)
1559                    VelocityTable[k] = src.VelocityTable[k];
1560            }
1561            if (src.pSampleLoops) {
1562                pSampleLoops = new DLS::sample_loop_t[src.SampleLoops];
1563                for (int k = 0 ; k < src.SampleLoops ; k++)
1564                    pSampleLoops[k] = src.pSampleLoops[k];
1565            }
1566        }
1567    
1568        /**
1569         * Apply dimension region settings to the respective RIFF chunks. You
1570         * have to call File::Save() to make changes persistent.
1571         *
1572         * Usually there is absolutely no need to call this method explicitly.
1573         * It will be called automatically when File::Save() was called.
1574         */
1575        void DimensionRegion::UpdateChunks() {
1576            // first update base class's chunk
1577            DLS::Sampler::UpdateChunks();
1578    
1579            RIFF::Chunk* wsmp = pParentList->GetSubChunk(CHUNK_ID_WSMP);
1580            uint8_t* pData = (uint8_t*) wsmp->LoadChunkData();
1581            pData[12] = Crossfade.in_start;
1582            pData[13] = Crossfade.in_end;
1583            pData[14] = Crossfade.out_start;
1584            pData[15] = Crossfade.out_end;
1585    
1586            // make sure '3ewa' chunk exists
1587            RIFF::Chunk* _3ewa = pParentList->GetSubChunk(CHUNK_ID_3EWA);
1588            if (!_3ewa) {
1589                File* pFile = (File*) GetParent()->GetParent()->GetParent();
1590                bool version3 = pFile->pVersion && pFile->pVersion->major == 3;
1591                _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, version3 ? 148 : 140);
1592            }
1593            pData = (uint8_t*) _3ewa->LoadChunkData();
1594    
1595            // update '3ewa' chunk with DimensionRegion's current settings
1596    
1597            const uint32_t chunksize = _3ewa->GetNewSize();
1598            store32(&pData[0], chunksize); // unknown, always chunk size?
1599    
1600            const int32_t lfo3freq = (int32_t) GIG_EXP_ENCODE(LFO3Frequency);
1601            store32(&pData[4], lfo3freq);
1602    
1603            const int32_t eg3attack = (int32_t) GIG_EXP_ENCODE(EG3Attack);
1604            store32(&pData[8], eg3attack);
1605    
1606            // next 2 bytes unknown
1607    
1608            store16(&pData[14], LFO1InternalDepth);
1609    
1610            // next 2 bytes unknown
1611    
1612            store16(&pData[18], LFO3InternalDepth);
1613    
1614            // next 2 bytes unknown
1615    
1616            store16(&pData[22], LFO1ControlDepth);
1617    
1618            // next 2 bytes unknown
1619    
1620            store16(&pData[26], LFO3ControlDepth);
1621    
1622            const int32_t eg1attack = (int32_t) GIG_EXP_ENCODE(EG1Attack);
1623            store32(&pData[28], eg1attack);
1624    
1625            const int32_t eg1decay1 = (int32_t) GIG_EXP_ENCODE(EG1Decay1);
1626            store32(&pData[32], eg1decay1);
1627    
1628            // next 2 bytes unknown
1629    
1630            store16(&pData[38], EG1Sustain);
1631    
1632            const int32_t eg1release = (int32_t) GIG_EXP_ENCODE(EG1Release);
1633            store32(&pData[40], eg1release);
1634    
1635            const uint8_t eg1ctl = (uint8_t) EncodeLeverageController(EG1Controller);
1636            pData[44] = eg1ctl;
1637    
1638            const uint8_t eg1ctrloptions =
1639                (EG1ControllerInvert ? 0x01 : 0x00) |
1640                GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG1ControllerAttackInfluence) |
1641                GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG1ControllerDecayInfluence) |
1642                GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG1ControllerReleaseInfluence);
1643            pData[45] = eg1ctrloptions;
1644    
1645            const uint8_t eg2ctl = (uint8_t) EncodeLeverageController(EG2Controller);
1646            pData[46] = eg2ctl;
1647    
1648            const uint8_t eg2ctrloptions =
1649                (EG2ControllerInvert ? 0x01 : 0x00) |
1650                GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG2ControllerAttackInfluence) |
1651                GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG2ControllerDecayInfluence) |
1652                GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG2ControllerReleaseInfluence);
1653            pData[47] = eg2ctrloptions;
1654    
1655            const int32_t lfo1freq = (int32_t) GIG_EXP_ENCODE(LFO1Frequency);
1656            store32(&pData[48], lfo1freq);
1657    
1658            const int32_t eg2attack = (int32_t) GIG_EXP_ENCODE(EG2Attack);
1659            store32(&pData[52], eg2attack);
1660    
1661            const int32_t eg2decay1 = (int32_t) GIG_EXP_ENCODE(EG2Decay1);
1662            store32(&pData[56], eg2decay1);
1663    
1664            // next 2 bytes unknown
1665    
1666            store16(&pData[62], EG2Sustain);
1667    
1668            const int32_t eg2release = (int32_t) GIG_EXP_ENCODE(EG2Release);
1669            store32(&pData[64], eg2release);
1670    
1671            // next 2 bytes unknown
1672    
1673            store16(&pData[70], LFO2ControlDepth);
1674    
1675            const int32_t lfo2freq = (int32_t) GIG_EXP_ENCODE(LFO2Frequency);
1676            store32(&pData[72], lfo2freq);
1677    
1678            // next 2 bytes unknown
1679    
1680            store16(&pData[78], LFO2InternalDepth);
1681    
1682            const int32_t eg1decay2 = (int32_t) (EG1InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG1Decay2);
1683            store32(&pData[80], eg1decay2);
1684    
1685            // next 2 bytes unknown
1686    
1687            store16(&pData[86], EG1PreAttack);
1688    
1689            const int32_t eg2decay2 = (int32_t) (EG2InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG2Decay2);
1690            store32(&pData[88], eg2decay2);
1691    
1692            // next 2 bytes unknown
1693    
1694            store16(&pData[94], EG2PreAttack);
1695    
1696            {
1697                if (VelocityResponseDepth > 4) throw Exception("VelocityResponseDepth must be between 0 and 4");
1698                uint8_t velocityresponse = VelocityResponseDepth;
1699                switch (VelocityResponseCurve) {
1700                    case curve_type_nonlinear:
1701                        break;
1702                    case curve_type_linear:
1703                        velocityresponse += 5;
1704                        break;
1705                    case curve_type_special:
1706                        velocityresponse += 10;
1707                        break;
1708                    case curve_type_unknown:
1709                    default:
1710                        throw Exception("Could not update DimensionRegion's chunk, unknown VelocityResponseCurve selected");
1711                }
1712                pData[96] = velocityresponse;
1713            }
1714    
1715            {
1716                if (ReleaseVelocityResponseDepth > 4) throw Exception("ReleaseVelocityResponseDepth must be between 0 and 4");
1717                uint8_t releasevelocityresponse = ReleaseVelocityResponseDepth;
1718                switch (ReleaseVelocityResponseCurve) {
1719                    case curve_type_nonlinear:
1720                        break;
1721                    case curve_type_linear:
1722                        releasevelocityresponse += 5;
1723                        break;
1724                    case curve_type_special:
1725                        releasevelocityresponse += 10;
1726                        break;
1727                    case curve_type_unknown:
1728                    default:
1729                        throw Exception("Could not update DimensionRegion's chunk, unknown ReleaseVelocityResponseCurve selected");
1730                }
1731                pData[97] = releasevelocityresponse;
1732            }
1733    
1734            pData[98] = VelocityResponseCurveScaling;
1735    
1736            pData[99] = AttenuationControllerThreshold;
1737    
1738            // next 4 bytes unknown
1739    
1740            store16(&pData[104], SampleStartOffset);
1741    
1742            // next 2 bytes unknown
1743    
1744            {
1745                uint8_t pitchTrackDimensionBypass = GIG_PITCH_TRACK_ENCODE(PitchTrack);
1746                switch (DimensionBypass) {
1747                    case dim_bypass_ctrl_94:
1748                        pitchTrackDimensionBypass |= 0x10;
1749                        break;
1750                    case dim_bypass_ctrl_95:
1751                        pitchTrackDimensionBypass |= 0x20;
1752                        break;
1753                    case dim_bypass_ctrl_none:
1754                        //FIXME: should we set anything here?
1755                        break;
1756                    default:
1757                        throw Exception("Could not update DimensionRegion's chunk, unknown DimensionBypass selected");
1758                }
1759                pData[108] = pitchTrackDimensionBypass;
1760            }
1761    
1762            const uint8_t pan = (Pan >= 0) ? Pan : ((-Pan) + 63); // signed 8 bit -> signed 7 bit
1763            pData[109] = pan;
1764    
1765            const uint8_t selfmask = (SelfMask) ? 0x01 : 0x00;
1766            pData[110] = selfmask;
1767    
1768            // next byte unknown
1769    
1770            {
1771                uint8_t lfo3ctrl = LFO3Controller & 0x07; // lower 3 bits
1772                if (LFO3Sync) lfo3ctrl |= 0x20; // bit 5
1773                if (InvertAttenuationController) lfo3ctrl |= 0x80; // bit 7
1774                if (VCFType == vcf_type_lowpassturbo) lfo3ctrl |= 0x40; // bit 6
1775                pData[112] = lfo3ctrl;
1776            }
1777    
1778            const uint8_t attenctl = EncodeLeverageController(AttenuationController);
1779            pData[113] = attenctl;
1780    
1781            {
1782                uint8_t lfo2ctrl = LFO2Controller & 0x07; // lower 3 bits
1783                if (LFO2FlipPhase) lfo2ctrl |= 0x80; // bit 7
1784                if (LFO2Sync)      lfo2ctrl |= 0x20; // bit 5
1785                if (VCFResonanceController != vcf_res_ctrl_none) lfo2ctrl |= 0x40; // bit 6
1786                pData[114] = lfo2ctrl;
1787            }
1788    
1789            {
1790                uint8_t lfo1ctrl = LFO1Controller & 0x07; // lower 3 bits
1791                if (LFO1FlipPhase) lfo1ctrl |= 0x80; // bit 7
1792                if (LFO1Sync)      lfo1ctrl |= 0x40; // bit 6
1793                if (VCFResonanceController != vcf_res_ctrl_none)
1794                    lfo1ctrl |= GIG_VCF_RESONANCE_CTRL_ENCODE(VCFResonanceController);
1795                pData[115] = lfo1ctrl;
1796            }
1797    
1798            const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth
1799                                                      : uint16_t(((-EG3Depth) - 1) ^ 0xffff); /* binary complementary for negatives */
1800            pData[116] = eg3depth;
1801    
1802            // next 2 bytes unknown
1803    
1804            const uint8_t channeloffset = ChannelOffset * 4;
1805            pData[120] = channeloffset;
1806    
1807            {
1808                uint8_t regoptions = 0;
1809                if (MSDecode)      regoptions |= 0x01; // bit 0
1810                if (SustainDefeat) regoptions |= 0x02; // bit 1
1811                pData[121] = regoptions;
1812            }
1813    
1814            // next 2 bytes unknown
1815    
1816            pData[124] = VelocityUpperLimit;
1817    
1818            // next 3 bytes unknown
1819    
1820            pData[128] = ReleaseTriggerDecay;
1821    
1822            // next 2 bytes unknown
1823    
1824            const uint8_t eg1hold = (EG1Hold) ? 0x80 : 0x00; // bit 7
1825            pData[131] = eg1hold;
1826    
1827            const uint8_t vcfcutoff = (VCFEnabled ? 0x80 : 0x00) |  /* bit 7 */
1828                                      (VCFCutoff & 0x7f);   /* lower 7 bits */
1829            pData[132] = vcfcutoff;
1830    
1831            pData[133] = VCFCutoffController;
1832    
1833            const uint8_t vcfvelscale = (VCFCutoffControllerInvert ? 0x80 : 0x00) | /* bit 7 */
1834                                        (VCFVelocityScale & 0x7f); /* lower 7 bits */
1835            pData[134] = vcfvelscale;
1836    
1837            // next byte unknown
1838    
1839            const uint8_t vcfresonance = (VCFResonanceDynamic ? 0x00 : 0x80) | /* bit 7 */
1840                                         (VCFResonance & 0x7f); /* lower 7 bits */
1841            pData[136] = vcfresonance;
1842    
1843            const uint8_t vcfbreakpoint = (VCFKeyboardTracking ? 0x80 : 0x00) | /* bit 7 */
1844                                          (VCFKeyboardTrackingBreakpoint & 0x7f); /* lower 7 bits */
1845            pData[137] = vcfbreakpoint;
1846    
1847            const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 |
1848                                        VCFVelocityCurve * 5;
1849            pData[138] = vcfvelocity;
1850    
1851            const uint8_t vcftype = (VCFType == vcf_type_lowpassturbo) ? vcf_type_lowpass : VCFType;
1852            pData[139] = vcftype;
1853    
1854            if (chunksize >= 148) {
1855                memcpy(&pData[140], DimensionUpperLimits, 8);
1856            }
1857      }      }
1858    
1859      // get the corresponding velocity table from the table map or create & calculate that table if it doesn't exist yet      // get the corresponding velocity table from the table map or create & calculate that table if it doesn't exist yet
# Line 1202  namespace { Line 1871  namespace {
1871          return table;          return table;
1872      }      }
1873    
1874        Region* DimensionRegion::GetParent() const {
1875            return pRegion;
1876        }
1877    
1878      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {      leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {
1879          leverage_ctrl_t decodedcontroller;          leverage_ctrl_t decodedcontroller;
1880          switch (EncodedController) {          switch (EncodedController) {
# Line 1320  namespace { Line 1993  namespace {
1993          return decodedcontroller;          return decodedcontroller;
1994      }      }
1995    
1996        DimensionRegion::_lev_ctrl_t DimensionRegion::EncodeLeverageController(leverage_ctrl_t DecodedController) {
1997            _lev_ctrl_t encodedcontroller;
1998            switch (DecodedController.type) {
1999                // special controller
2000                case leverage_ctrl_t::type_none:
2001                    encodedcontroller = _lev_ctrl_none;
2002                    break;
2003                case leverage_ctrl_t::type_velocity:
2004                    encodedcontroller = _lev_ctrl_velocity;
2005                    break;
2006                case leverage_ctrl_t::type_channelaftertouch:
2007                    encodedcontroller = _lev_ctrl_channelaftertouch;
2008                    break;
2009    
2010                // ordinary MIDI control change controller
2011                case leverage_ctrl_t::type_controlchange:
2012                    switch (DecodedController.controller_number) {
2013                        case 1:
2014                            encodedcontroller = _lev_ctrl_modwheel;
2015                            break;
2016                        case 2:
2017                            encodedcontroller = _lev_ctrl_breath;
2018                            break;
2019                        case 4:
2020                            encodedcontroller = _lev_ctrl_foot;
2021                            break;
2022                        case 12:
2023                            encodedcontroller = _lev_ctrl_effect1;
2024                            break;
2025                        case 13:
2026                            encodedcontroller = _lev_ctrl_effect2;
2027                            break;
2028                        case 16:
2029                            encodedcontroller = _lev_ctrl_genpurpose1;
2030                            break;
2031                        case 17:
2032                            encodedcontroller = _lev_ctrl_genpurpose2;
2033                            break;
2034                        case 18:
2035                            encodedcontroller = _lev_ctrl_genpurpose3;
2036                            break;
2037                        case 19:
2038                            encodedcontroller = _lev_ctrl_genpurpose4;
2039                            break;
2040                        case 5:
2041                            encodedcontroller = _lev_ctrl_portamentotime;
2042                            break;
2043                        case 64:
2044                            encodedcontroller = _lev_ctrl_sustainpedal;
2045                            break;
2046                        case 65:
2047                            encodedcontroller = _lev_ctrl_portamento;
2048                            break;
2049                        case 66:
2050                            encodedcontroller = _lev_ctrl_sostenutopedal;
2051                            break;
2052                        case 67:
2053                            encodedcontroller = _lev_ctrl_softpedal;
2054                            break;
2055                        case 80:
2056                            encodedcontroller = _lev_ctrl_genpurpose5;
2057                            break;
2058                        case 81:
2059                            encodedcontroller = _lev_ctrl_genpurpose6;
2060                            break;
2061                        case 82:
2062                            encodedcontroller = _lev_ctrl_genpurpose7;
2063                            break;
2064                        case 83:
2065                            encodedcontroller = _lev_ctrl_genpurpose8;
2066                            break;
2067                        case 91:
2068                            encodedcontroller = _lev_ctrl_effect1depth;
2069                            break;
2070                        case 92:
2071                            encodedcontroller = _lev_ctrl_effect2depth;
2072                            break;
2073                        case 93:
2074                            encodedcontroller = _lev_ctrl_effect3depth;
2075                            break;
2076                        case 94:
2077                            encodedcontroller = _lev_ctrl_effect4depth;
2078                            break;
2079                        case 95:
2080                            encodedcontroller = _lev_ctrl_effect5depth;
2081                            break;
2082                        default:
2083                            throw gig::Exception("leverage controller number is not supported by the gig format");
2084                    }
2085                    break;
2086                default:
2087                    throw gig::Exception("Unknown leverage controller type.");
2088            }
2089            return encodedcontroller;
2090        }
2091    
2092      DimensionRegion::~DimensionRegion() {      DimensionRegion::~DimensionRegion() {
2093          Instances--;          Instances--;
2094          if (!Instances) {          if (!Instances) {
# Line 1333  namespace { Line 2102  namespace {
2102              delete pVelocityTables;              delete pVelocityTables;
2103              pVelocityTables = NULL;              pVelocityTables = NULL;
2104          }          }
2105            if (VelocityTable) delete[] VelocityTable;
2106      }      }
2107    
2108      /**      /**
# Line 1449  namespace { Line 2219  namespace {
2219              for (int i = 0; i < dimensionBits; i++) {              for (int i = 0; i < dimensionBits; i++) {
2220                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());                  dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());
2221                  uint8_t     bits      = _3lnk->ReadUint8();                  uint8_t     bits      = _3lnk->ReadUint8();
2222                    _3lnk->ReadUint8(); // bit position of the dimension (bits[0] + bits[1] + ... + bits[i-1])
2223                    _3lnk->ReadUint8(); // (1 << bit position of next dimension) - (1 << bit position of this dimension)
2224                    uint8_t     zones     = _3lnk->ReadUint8(); // new for v3: number of zones doesn't have to be == pow(2,bits)
2225                  if (dimension == dimension_none) { // inactive dimension                  if (dimension == dimension_none) { // inactive dimension
2226                      pDimensionDefinitions[i].dimension  = dimension_none;                      pDimensionDefinitions[i].dimension  = dimension_none;
2227                      pDimensionDefinitions[i].bits       = 0;                      pDimensionDefinitions[i].bits       = 0;
2228                      pDimensionDefinitions[i].zones      = 0;                      pDimensionDefinitions[i].zones      = 0;
2229                      pDimensionDefinitions[i].split_type = split_type_bit;                      pDimensionDefinitions[i].split_type = split_type_bit;
                     pDimensionDefinitions[i].ranges     = NULL;  
2230                      pDimensionDefinitions[i].zone_size  = 0;                      pDimensionDefinitions[i].zone_size  = 0;
2231                  }                  }
2232                  else { // active dimension                  else { // active dimension
2233                      pDimensionDefinitions[i].dimension = dimension;                      pDimensionDefinitions[i].dimension = dimension;
2234                      pDimensionDefinitions[i].bits      = bits;                      pDimensionDefinitions[i].bits      = bits;
2235                      pDimensionDefinitions[i].zones     = 0x01 << bits; // = pow(2,bits)                      pDimensionDefinitions[i].zones     = zones ? zones : 0x01 << bits; // = pow(2,bits)
2236                      pDimensionDefinitions[i].split_type = (dimension == dimension_layer ||                      pDimensionDefinitions[i].split_type = __resolveSplitType(dimension);
2237                                                             dimension == dimension_samplechannel ||                      pDimensionDefinitions[i].zone_size  = __resolveZoneSize(pDimensionDefinitions[i]);
                                                            dimension == dimension_releasetrigger ||  
                                                            dimension == dimension_roundrobin ||  
                                                            dimension == dimension_random) ? split_type_bit  
                                                                                           : split_type_normal;  
                     pDimensionDefinitions[i].ranges = NULL; // it's not possible to check velocity dimensions for custom defined ranges at this point  
                     pDimensionDefinitions[i].zone_size  =  
                         (pDimensionDefinitions[i].split_type == split_type_normal) ? 128 / pDimensionDefinitions[i].zones  
                                                                                    : 0;  
2238                      Dimensions++;                      Dimensions++;
2239    
2240                      // if this is a layer dimension, remember the amount of layers                      // if this is a layer dimension, remember the amount of layers
2241                      if (dimension == dimension_layer) Layers = pDimensionDefinitions[i].zones;                      if (dimension == dimension_layer) Layers = pDimensionDefinitions[i].zones;
2242                  }                  }
2243                  _3lnk->SetPos(6, RIFF::stream_curpos); // jump forward to next dimension definition                  _3lnk->SetPos(3, RIFF::stream_curpos); // jump forward to next dimension definition
2244              }              }
2245                for (int i = dimensionBits ; i < 8 ; i++) pDimensionDefinitions[i].bits = 0;
2246    
2247              // check velocity dimension (if there is one) for custom defined zone ranges              // if there's a velocity dimension and custom velocity zone splits are used,
2248              for (uint i = 0; i < Dimensions; i++) {              // update the VelocityTables in the dimension regions
2249                  dimension_def_t* pDimDef = pDimensionDefinitions + i;              UpdateVelocityTable();
                 if (pDimDef->dimension == dimension_velocity) {  
                     if (pDimensionRegions[0]->VelocityUpperLimit == 0) {  
                         // no custom defined ranges  
                         pDimDef->split_type = split_type_normal;  
                         pDimDef->ranges     = NULL;  
                     }  
                     else { // custom defined ranges  
                         pDimDef->split_type = split_type_customvelocity;  
                         pDimDef->ranges     = new range_t[pDimDef->zones];  
                         uint8_t bits[8] = { 0 };  
                         int previousUpperLimit = -1;  
                         for (int velocityZone = 0; velocityZone < pDimDef->zones; velocityZone++) {  
                             bits[i] = velocityZone;  
                             DimensionRegion* pDimRegion = GetDimensionRegionByBit(bits);  
   
                             pDimDef->ranges[velocityZone].low  = previousUpperLimit + 1;  
                             pDimDef->ranges[velocityZone].high = pDimRegion->VelocityUpperLimit;  
                             previousUpperLimit = pDimDef->ranges[velocityZone].high;  
                             // fill velocity table  
                             for (int i = pDimDef->ranges[velocityZone].low; i <= pDimDef->ranges[velocityZone].high; i++) {  
                                 VelocityTable[i] = velocityZone;  
                             }  
                         }  
                     }  
                 }  
             }  
2250    
2251              // jump to start of the wave pool indices (if not already there)              // jump to start of the wave pool indices (if not already there)
             File* file = (File*) GetParent()->GetParent();  
2252              if (file->pVersion && file->pVersion->major == 3)              if (file->pVersion && file->pVersion->major == 3)
2253                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure                  _3lnk->SetPos(68); // version 3 has a different 3lnk structure
2254              else              else
# Line 1519  namespace { Line 2257  namespace {
2257              // load sample references              // load sample references
2258              for (uint i = 0; i < DimensionRegions; i++) {              for (uint i = 0; i < DimensionRegions; i++) {
2259                  uint32_t wavepoolindex = _3lnk->ReadUint32();                  uint32_t wavepoolindex = _3lnk->ReadUint32();
2260                  pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);                  if (file->pWavePoolTable) pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);
2261              }              }
2262                GetSample(); // load global region sample reference
2263            } else {
2264                DimensionRegions = 0;
2265                for (int i = 0 ; i < 8 ; i++) {
2266                    pDimensionDefinitions[i].dimension  = dimension_none;
2267                    pDimensionDefinitions[i].bits       = 0;
2268                    pDimensionDefinitions[i].zones      = 0;
2269                }
2270            }
2271    
2272            // make sure there is at least one dimension region
2273            if (!DimensionRegions) {
2274                RIFF::List* _3prg = rgnList->GetSubList(LIST_TYPE_3PRG);
2275                if (!_3prg) _3prg = rgnList->AddSubList(LIST_TYPE_3PRG);
2276                RIFF::List* _3ewl = _3prg->AddSubList(LIST_TYPE_3EWL);
2277                pDimensionRegions[0] = new DimensionRegion(this, _3ewl);
2278                DimensionRegions = 1;
2279            }
2280        }
2281    
2282        /**
2283         * Apply Region settings and all its DimensionRegions to the respective
2284         * RIFF chunks. You have to call File::Save() to make changes persistent.
2285         *
2286         * Usually there is absolutely no need to call this method explicitly.
2287         * It will be called automatically when File::Save() was called.
2288         *
2289         * @throws gig::Exception if samples cannot be dereferenced
2290         */
2291        void Region::UpdateChunks() {
2292            // in the gig format we don't care about the Region's sample reference
2293            // but we still have to provide some existing one to not corrupt the
2294            // file, so to avoid the latter we simply always assign the sample of
2295            // the first dimension region of this region
2296            pSample = pDimensionRegions[0]->pSample;
2297    
2298            // first update base class's chunks
2299            DLS::Region::UpdateChunks();
2300    
2301            // update dimension region's chunks
2302            for (int i = 0; i < DimensionRegions; i++) {
2303                pDimensionRegions[i]->UpdateChunks();
2304            }
2305    
2306            File* pFile = (File*) GetParent()->GetParent();
2307            bool version3 = pFile->pVersion && pFile->pVersion->major == 3;
2308            const int iMaxDimensions =  version3 ? 8 : 5;
2309            const int iMaxDimensionRegions = version3 ? 256 : 32;
2310    
2311            // make sure '3lnk' chunk exists
2312            RIFF::Chunk* _3lnk = pCkRegion->GetSubChunk(CHUNK_ID_3LNK);
2313            if (!_3lnk) {
2314                const int _3lnkChunkSize = version3 ? 1092 : 172;
2315                _3lnk = pCkRegion->AddSubChunk(CHUNK_ID_3LNK, _3lnkChunkSize);
2316                memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);
2317    
2318                // move 3prg to last position
2319                pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3PRG), 0);
2320            }
2321    
2322            // update dimension definitions in '3lnk' chunk
2323            uint8_t* pData = (uint8_t*) _3lnk->LoadChunkData();
2324            store32(&pData[0], DimensionRegions);
2325            int shift = 0;
2326            for (int i = 0; i < iMaxDimensions; i++) {
2327                pData[4 + i * 8] = (uint8_t) pDimensionDefinitions[i].dimension;
2328                pData[5 + i * 8] = pDimensionDefinitions[i].bits;
2329                pData[6 + i * 8] = pDimensionDefinitions[i].dimension == dimension_none ? 0 : shift;
2330                pData[7 + i * 8] = (1 << (shift + pDimensionDefinitions[i].bits)) - (1 << shift);
2331                pData[8 + i * 8] = pDimensionDefinitions[i].zones;
2332                // next 3 bytes unknown, always zero?
2333    
2334                shift += pDimensionDefinitions[i].bits;
2335            }
2336    
2337            // update wave pool table in '3lnk' chunk
2338            const int iWavePoolOffset = version3 ? 68 : 44;
2339            for (uint i = 0; i < iMaxDimensionRegions; i++) {
2340                int iWaveIndex = -1;
2341                if (i < DimensionRegions) {
2342                    if (!pFile->pSamples || !pFile->pSamples->size()) throw gig::Exception("Could not update gig::Region, there are no samples");
2343                    File::SampleList::iterator iter = pFile->pSamples->begin();
2344                    File::SampleList::iterator end  = pFile->pSamples->end();
2345                    for (int index = 0; iter != end; ++iter, ++index) {
2346                        if (*iter == pDimensionRegions[i]->pSample) {
2347                            iWaveIndex = index;
2348                            break;
2349                        }
2350                    }
2351                }
2352                store32(&pData[iWavePoolOffset + i * 4], iWaveIndex);
2353          }          }
         else throw gig::Exception("Mandatory <3lnk> chunk not found.");  
2354      }      }
2355    
2356      void Region::LoadDimensionRegions(RIFF::List* rgn) {      void Region::LoadDimensionRegions(RIFF::List* rgn) {
# Line 1532  namespace { Line 2360  namespace {
2360              RIFF::List* _3ewl = _3prg->GetFirstSubList();              RIFF::List* _3ewl = _3prg->GetFirstSubList();
2361              while (_3ewl) {              while (_3ewl) {
2362                  if (_3ewl->GetListType() == LIST_TYPE_3EWL) {                  if (_3ewl->GetListType() == LIST_TYPE_3EWL) {
2363                      pDimensionRegions[dimensionRegionNr] = new DimensionRegion(_3ewl);                      pDimensionRegions[dimensionRegionNr] = new DimensionRegion(this, _3ewl);
2364                      dimensionRegionNr++;                      dimensionRegionNr++;
2365                  }                  }
2366                  _3ewl = _3prg->GetNextSubList();                  _3ewl = _3prg->GetNextSubList();
# Line 1541  namespace { Line 2369  namespace {
2369          }          }
2370      }      }
2371    
2372      Region::~Region() {      void Region::UpdateVelocityTable() {
2373          for (uint i = 0; i < Dimensions; i++) {          // get velocity dimension's index
2374              if (pDimensionDefinitions[i].ranges) delete[] pDimensionDefinitions[i].ranges;          int veldim = -1;
2375            for (int i = 0 ; i < Dimensions ; i++) {
2376                if (pDimensionDefinitions[i].dimension == gig::dimension_velocity) {
2377                    veldim = i;
2378                    break;
2379                }
2380            }
2381            if (veldim == -1) return;
2382    
2383            int step = 1;
2384            for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;
2385            int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;
2386            int end = step * pDimensionDefinitions[veldim].zones;
2387    
2388            // loop through all dimension regions for all dimensions except the velocity dimension
2389            int dim[8] = { 0 };
2390            for (int i = 0 ; i < DimensionRegions ; i++) {
2391    
2392                if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||
2393                    pDimensionRegions[i]->VelocityUpperLimit) {
2394                    // create the velocity table
2395                    uint8_t* table = pDimensionRegions[i]->VelocityTable;
2396                    if (!table) {
2397                        table = new uint8_t[128];
2398                        pDimensionRegions[i]->VelocityTable = table;
2399                    }
2400                    int tableidx = 0;
2401                    int velocityZone = 0;
2402                    if (pDimensionRegions[i]->DimensionUpperLimits[veldim]) { // gig3
2403                        for (int k = i ; k < end ; k += step) {
2404                            DimensionRegion *d = pDimensionRegions[k];
2405                            for (; tableidx <= d->DimensionUpperLimits[veldim] ; tableidx++) table[tableidx] = velocityZone;
2406                            velocityZone++;
2407                        }
2408                    } else { // gig2
2409                        for (int k = i ; k < end ; k += step) {
2410                            DimensionRegion *d = pDimensionRegions[k];
2411                            for (; tableidx <= d->VelocityUpperLimit ; tableidx++) table[tableidx] = velocityZone;
2412                            velocityZone++;
2413                        }
2414                    }
2415                } else {
2416                    if (pDimensionRegions[i]->VelocityTable) {
2417                        delete[] pDimensionRegions[i]->VelocityTable;
2418                        pDimensionRegions[i]->VelocityTable = 0;
2419                    }
2420                }
2421    
2422                int j;
2423                int shift = 0;
2424                for (j = 0 ; j < Dimensions ; j++) {
2425                    if (j == veldim) i += skipveldim; // skip velocity dimension
2426                    else {
2427                        dim[j]++;
2428                        if (dim[j] < pDimensionDefinitions[j].zones) break;
2429                        else {
2430                            // skip unused dimension regions
2431                            dim[j] = 0;
2432                            i += ((1 << pDimensionDefinitions[j].bits) -
2433                                  pDimensionDefinitions[j].zones) << shift;
2434                        }
2435                    }
2436                    shift += pDimensionDefinitions[j].bits;
2437                }
2438                if (j == Dimensions) break;
2439          }          }
2440        }
2441    
2442        /** @brief Einstein would have dreamed of it - create a new dimension.
2443         *
2444         * Creates a new dimension with the dimension definition given by
2445         * \a pDimDef. The appropriate amount of DimensionRegions will be created.
2446         * There is a hard limit of dimensions and total amount of "bits" all
2447         * dimensions can have. This limit is dependant to what gig file format
2448         * version this file refers to. The gig v2 (and lower) format has a
2449         * dimension limit and total amount of bits limit of 5, whereas the gig v3
2450         * format has a limit of 8.
2451         *
2452         * @param pDimDef - defintion of the new dimension
2453         * @throws gig::Exception if dimension of the same type exists already
2454         * @throws gig::Exception if amount of dimensions or total amount of
2455         *                        dimension bits limit is violated
2456         */
2457        void Region::AddDimension(dimension_def_t* pDimDef) {
2458            // check if max. amount of dimensions reached
2459            File* file = (File*) GetParent()->GetParent();
2460            const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;
2461            if (Dimensions >= iMaxDimensions)
2462                throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimensions already reached");
2463            // check if max. amount of dimension bits reached
2464            int iCurrentBits = 0;
2465            for (int i = 0; i < Dimensions; i++)
2466                iCurrentBits += pDimensionDefinitions[i].bits;
2467            if (iCurrentBits >= iMaxDimensions)
2468                throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimension bits already reached");
2469            const int iNewBits = iCurrentBits + pDimDef->bits;
2470            if (iNewBits > iMaxDimensions)
2471                throw gig::Exception("Could not add new dimension, new dimension would exceed max. amount of " + ToString(iMaxDimensions) + " dimension bits");
2472            // check if there's already a dimensions of the same type
2473            for (int i = 0; i < Dimensions; i++)
2474                if (pDimensionDefinitions[i].dimension == pDimDef->dimension)
2475                    throw gig::Exception("Could not add new dimension, there is already a dimension of the same type");
2476    
2477            // pos is where the new dimension should be placed, normally
2478            // last in list, except for the samplechannel dimension which
2479            // has to be first in list
2480            int pos = pDimDef->dimension == dimension_samplechannel ? 0 : Dimensions;
2481            int bitpos = 0;
2482            for (int i = 0 ; i < pos ; i++)
2483                bitpos += pDimensionDefinitions[i].bits;
2484    
2485            // make room for the new dimension
2486            for (int i = Dimensions ; i > pos ; i--) pDimensionDefinitions[i] = pDimensionDefinitions[i - 1];
2487            for (int i = 0 ; i < (1 << iCurrentBits) ; i++) {
2488                for (int j = Dimensions ; j > pos ; j--) {
2489                    pDimensionRegions[i]->DimensionUpperLimits[j] =
2490                        pDimensionRegions[i]->DimensionUpperLimits[j - 1];
2491                }
2492            }
2493    
2494            // assign definition of new dimension
2495            pDimensionDefinitions[pos] = *pDimDef;
2496    
2497            // auto correct certain dimension definition fields (where possible)
2498            pDimensionDefinitions[pos].split_type  =
2499                __resolveSplitType(pDimensionDefinitions[pos].dimension);
2500            pDimensionDefinitions[pos].zone_size =
2501                __resolveZoneSize(pDimensionDefinitions[pos]);
2502    
2503            // create new dimension region(s) for this new dimension, and make
2504            // sure that the dimension regions are placed correctly in both the
2505            // RIFF list and the pDimensionRegions array
2506            RIFF::Chunk* moveTo = NULL;
2507            RIFF::List* _3prg = pCkRegion->GetSubList(LIST_TYPE_3PRG);
2508            for (int i = (1 << iCurrentBits) - (1 << bitpos) ; i >= 0 ; i -= (1 << bitpos)) {
2509                for (int k = 0 ; k < (1 << bitpos) ; k++) {
2510                    pDimensionRegions[(i << pDimDef->bits) + k] = pDimensionRegions[i + k];
2511                }
2512                for (int j = 1 ; j < (1 << pDimDef->bits) ; j++) {
2513                    for (int k = 0 ; k < (1 << bitpos) ; k++) {
2514                        RIFF::List* pNewDimRgnListChunk = _3prg->AddSubList(LIST_TYPE_3EWL);
2515                        if (moveTo) _3prg->MoveSubChunk(pNewDimRgnListChunk, moveTo);
2516                        // create a new dimension region and copy all parameter values from
2517                        // an existing dimension region
2518                        pDimensionRegions[(i << pDimDef->bits) + (j << bitpos) + k] =
2519                            new DimensionRegion(pNewDimRgnListChunk, *pDimensionRegions[i + k]);
2520    
2521                        DimensionRegions++;
2522                    }
2523                }
2524                moveTo = pDimensionRegions[i]->pParentList;
2525            }
2526    
2527            // initialize the upper limits for this dimension
2528            int mask = (1 << bitpos) - 1;
2529            for (int z = 0 ; z < pDimDef->zones ; z++) {
2530                uint8_t upperLimit = uint8_t((z + 1) * 128.0 / pDimDef->zones - 1);
2531                for (int i = 0 ; i < 1 << iCurrentBits ; i++) {
2532                    pDimensionRegions[((i & ~mask) << pDimDef->bits) |
2533                                      (z << bitpos) |
2534                                      (i & mask)]->DimensionUpperLimits[pos] = upperLimit;
2535                }
2536            }
2537    
2538            Dimensions++;
2539    
2540            // if this is a layer dimension, update 'Layers' attribute
2541            if (pDimDef->dimension == dimension_layer) Layers = pDimDef->zones;
2542    
2543            UpdateVelocityTable();
2544        }
2545    
2546        /** @brief Delete an existing dimension.
2547         *
2548         * Deletes the dimension given by \a pDimDef and deletes all respective
2549         * dimension regions, that is all dimension regions where the dimension's
2550         * bit(s) part is greater than 0. In case of a 'sustain pedal' dimension
2551         * for example this would delete all dimension regions for the case(s)
2552         * where the sustain pedal is pressed down.
2553         *
2554         * @param pDimDef - dimension to delete
2555         * @throws gig::Exception if given dimension cannot be found
2556         */
2557        void Region::DeleteDimension(dimension_def_t* pDimDef) {
2558            // get dimension's index
2559            int iDimensionNr = -1;
2560            for (int i = 0; i < Dimensions; i++) {
2561                if (&pDimensionDefinitions[i] == pDimDef) {
2562                    iDimensionNr = i;
2563                    break;
2564                }
2565            }
2566            if (iDimensionNr < 0) throw gig::Exception("Invalid dimension_def_t pointer");
2567    
2568            // get amount of bits below the dimension to delete
2569            int iLowerBits = 0;
2570            for (int i = 0; i < iDimensionNr; i++)
2571                iLowerBits += pDimensionDefinitions[i].bits;
2572    
2573            // get amount ot bits above the dimension to delete
2574            int iUpperBits = 0;
2575            for (int i = iDimensionNr + 1; i < Dimensions; i++)
2576                iUpperBits += pDimensionDefinitions[i].bits;
2577    
2578            RIFF::List* _3prg = pCkRegion->GetSubList(LIST_TYPE_3PRG);
2579    
2580            // delete dimension regions which belong to the given dimension
2581            // (that is where the dimension's bit > 0)
2582            for (int iUpperBit = 0; iUpperBit < 1 << iUpperBits; iUpperBit++) {
2583                for (int iObsoleteBit = 1; iObsoleteBit < 1 << pDimensionDefinitions[iDimensionNr].bits; iObsoleteBit++) {
2584                    for (int iLowerBit = 0; iLowerBit < 1 << iLowerBits; iLowerBit++) {
2585                        int iToDelete = iUpperBit    << (pDimensionDefinitions[iDimensionNr].bits + iLowerBits) |
2586                                        iObsoleteBit << iLowerBits |
2587                                        iLowerBit;
2588    
2589                        _3prg->DeleteSubChunk(pDimensionRegions[iToDelete]->pParentList);
2590                        delete pDimensionRegions[iToDelete];
2591                        pDimensionRegions[iToDelete] = NULL;
2592                        DimensionRegions--;
2593                    }
2594                }
2595            }
2596    
2597            // defrag pDimensionRegions array
2598            // (that is remove the NULL spaces within the pDimensionRegions array)
2599            for (int iFrom = 2, iTo = 1; iFrom < 256 && iTo < 256 - 1; iTo++) {
2600                if (!pDimensionRegions[iTo]) {
2601                    if (iFrom <= iTo) iFrom = iTo + 1;
2602                    while (!pDimensionRegions[iFrom] && iFrom < 256) iFrom++;
2603                    if (iFrom < 256 && pDimensionRegions[iFrom]) {
2604                        pDimensionRegions[iTo]   = pDimensionRegions[iFrom];
2605                        pDimensionRegions[iFrom] = NULL;
2606                    }
2607                }
2608            }
2609    
2610            // remove the this dimension from the upper limits arrays
2611            for (int j = 0 ; j < 256 && pDimensionRegions[j] ; j++) {
2612                DimensionRegion* d = pDimensionRegions[j];
2613                for (int i = iDimensionNr + 1; i < Dimensions; i++) {
2614                    d->DimensionUpperLimits[i - 1] = d->DimensionUpperLimits[i];
2615                }
2616                d->DimensionUpperLimits[Dimensions - 1] = 127;
2617            }
2618    
2619            // 'remove' dimension definition
2620            for (int i = iDimensionNr + 1; i < Dimensions; i++) {
2621                pDimensionDefinitions[i - 1] = pDimensionDefinitions[i];
2622            }
2623            pDimensionDefinitions[Dimensions - 1].dimension = dimension_none;
2624            pDimensionDefinitions[Dimensions - 1].bits      = 0;
2625            pDimensionDefinitions[Dimensions - 1].zones     = 0;
2626    
2627            Dimensions--;
2628    
2629            // if this was a layer dimension, update 'Layers' attribute
2630            if (pDimDef->dimension == dimension_layer) Layers = 1;
2631        }
2632    
2633        Region::~Region() {
2634          for (int i = 0; i < 256; i++) {          for (int i = 0; i < 256; i++) {
2635              if (pDimensionRegions[i]) delete pDimensionRegions[i];              if (pDimensionRegions[i]) delete pDimensionRegions[i];
2636          }          }
# Line 1569  namespace { Line 2655  namespace {
2655       * @see             Dimensions       * @see             Dimensions
2656       */       */
2657      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {      DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {
2658          uint8_t bits[8] = { 0 };          uint8_t bits;
2659            int veldim = -1;
2660            int velbitpos;
2661            int bitpos = 0;
2662            int dimregidx = 0;
2663          for (uint i = 0; i < Dimensions; i++) {          for (uint i = 0; i < Dimensions; i++) {
2664              bits[i] = DimValues[i];              if (pDimensionDefinitions[i].dimension == dimension_velocity) {
2665              switch (pDimensionDefinitions[i].split_type) {                  // the velocity dimension must be handled after the other dimensions
2666                  case split_type_normal:                  veldim = i;
2667                      bits[i] /= pDimensionDefinitions[i].zone_size;                  velbitpos = bitpos;
2668                      break;              } else {
2669                  case split_type_customvelocity:                  switch (pDimensionDefinitions[i].split_type) {
2670                      bits[i] = VelocityTable[bits[i]];                      case split_type_normal:
2671                      break;                          if (pDimensionRegions[0]->DimensionUpperLimits[i]) {
2672                  case split_type_bit: // the value is already the sought dimension bit number                              // gig3: all normal dimensions (not just the velocity dimension) have custom zone ranges
2673                      const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;                              for (bits = 0 ; bits < pDimensionDefinitions[i].zones ; bits++) {
2674                      bits[i] = bits[i] & limiter_mask; // just make sure the value don't uses more bits than allowed                                  if (DimValues[i] <= pDimensionRegions[bits << bitpos]->DimensionUpperLimits[i]) break;
2675                      break;                              }
2676              }                          } else {
2677                                // gig2: evenly sized zones
2678                                bits = uint8_t(DimValues[i] / pDimensionDefinitions[i].zone_size);
2679                            }
2680                            break;
2681                        case split_type_bit: // the value is already the sought dimension bit number
2682                            const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;
2683                            bits = DimValues[i] & limiter_mask; // just make sure the value doesn't use more bits than allowed
2684                            break;
2685                    }
2686                    dimregidx |= bits << bitpos;
2687                }
2688                bitpos += pDimensionDefinitions[i].bits;
2689            }
2690            DimensionRegion* dimreg = pDimensionRegions[dimregidx];
2691            if (veldim != -1) {
2692                // (dimreg is now the dimension region for the lowest velocity)
2693                if (dimreg->VelocityTable) // custom defined zone ranges
2694                    bits = dimreg->VelocityTable[DimValues[veldim]];
2695                else // normal split type
2696                    bits = uint8_t(DimValues[veldim] / pDimensionDefinitions[veldim].zone_size);
2697    
2698                dimregidx |= bits << velbitpos;
2699                dimreg = pDimensionRegions[dimregidx];
2700          }          }
2701          return GetDimensionRegionByBit(bits);          return dimreg;
2702      }      }
2703    
2704      /**      /**
# Line 1625  namespace { Line 2738  namespace {
2738      Sample* Region::GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress) {      Sample* Region::GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress) {
2739          if ((int32_t)WavePoolTableIndex == -1) return NULL;          if ((int32_t)WavePoolTableIndex == -1) return NULL;
2740          File* file = (File*) GetParent()->GetParent();          File* file = (File*) GetParent()->GetParent();
2741            if (!file->pWavePoolTable) return NULL;
2742          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];          unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
2743          unsigned long soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];          unsigned long soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];
2744          Sample* sample = file->GetFirstSample(pProgress);          Sample* sample = file->GetFirstSample(pProgress);
2745          while (sample) {          while (sample) {
2746              if (sample->ulWavePoolOffset == soughtoffset &&              if (sample->ulWavePoolOffset == soughtoffset &&
2747                  sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(pSample = sample);                  sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);
2748              sample = file->GetNextSample();              sample = file->GetNextSample();
2749          }          }
2750          return NULL;          return NULL;
# Line 1642  namespace { Line 2756  namespace {
2756  // *  // *
2757    
2758      Instrument::Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress) : DLS::Instrument((DLS::File*)pFile, insList) {      Instrument::Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress) : DLS::Instrument((DLS::File*)pFile, insList) {
2759            static const DLS::Info::FixedStringLength fixedStringLengths[] = {
2760                { CHUNK_ID_INAM, 64 },
2761                { CHUNK_ID_ISFT, 12 },
2762                { 0, 0 }
2763            };
2764            pInfo->FixedStringLengths = fixedStringLengths;
2765    
2766          // Initialization          // Initialization
2767          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;          for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;
2768          RegionIndex = -1;          EffectSend = 0;
2769            Attenuation = 0;
2770            FineTune = 0;
2771            PitchbendRange = 0;
2772            PianoReleaseMode = false;
2773            DimensionKeyRange.low = 0;
2774            DimensionKeyRange.high = 0;
2775    
2776          // Loading          // Loading
2777          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);          RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);
# Line 1660  namespace { Line 2787  namespace {
2787                  DimensionKeyRange.low  = dimkeystart >> 1;                  DimensionKeyRange.low  = dimkeystart >> 1;
2788                  DimensionKeyRange.high = _3ewg->ReadUint8();                  DimensionKeyRange.high = _3ewg->ReadUint8();
2789              }              }
             else throw gig::Exception("Mandatory <3ewg> chunk not found.");  
2790          }          }
         else throw gig::Exception("Mandatory <lart> list chunk not found.");  
2791    
2792            if (!pRegions) pRegions = new RegionList;
2793          RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);          RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);
2794          if (!lrgn) throw gig::Exception("Mandatory chunks in <ins > chunk not found.");          if (lrgn) {
2795          pRegions = new Region*[Regions];              RIFF::List* rgn = lrgn->GetFirstSubList();
2796          for (uint i = 0; i < Regions; i++) pRegions[i] = NULL;              while (rgn) {
2797          RIFF::List* rgn = lrgn->GetFirstSubList();                  if (rgn->GetListType() == LIST_TYPE_RGN) {
2798          unsigned int iRegion = 0;                      __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
2799          while (rgn) {                      pRegions->push_back(new Region(this, rgn));
2800              if (rgn->GetListType() == LIST_TYPE_RGN) {                  }
2801                  __notify_progress(pProgress, (float) iRegion / (float) Regions);                  rgn = lrgn->GetNextSubList();
                 pRegions[iRegion] = new Region(this, rgn);  
                 iRegion++;  
             }  
             rgn = lrgn->GetNextSubList();  
         }  
   
         // Creating Region Key Table for fast lookup  
         for (uint iReg = 0; iReg < Regions; iReg++) {  
             for (int iKey = pRegions[iReg]->KeyRange.low; iKey <= pRegions[iReg]->KeyRange.high; iKey++) {  
                 RegionKeyTable[iKey] = pRegions[iReg];  
2802              }              }
2803                // Creating Region Key Table for fast lookup
2804                UpdateRegionKeyTable();
2805          }          }
2806    
2807          __notify_progress(pProgress, 1.0f); // notify done          __notify_progress(pProgress, 1.0f); // notify done
2808      }      }
2809    
2810      Instrument::~Instrument() {      void Instrument::UpdateRegionKeyTable() {
2811          for (uint i = 0; i < Regions; i++) {          RegionList::iterator iter = pRegions->begin();
2812              if (pRegions) {          RegionList::iterator end  = pRegions->end();
2813                  if (pRegions[i]) delete (pRegions[i]);          for (; iter != end; ++iter) {
2814                gig::Region* pRegion = static_cast<gig::Region*>(*iter);
2815                for (int iKey = pRegion->KeyRange.low; iKey <= pRegion->KeyRange.high; iKey++) {
2816                    RegionKeyTable[iKey] = pRegion;
2817              }              }
2818          }          }
2819          if (pRegions) delete[] pRegions;      }
2820    
2821        Instrument::~Instrument() {
2822        }
2823    
2824        /**
2825         * Apply Instrument with all its Regions to the respective RIFF chunks.
2826         * You have to call File::Save() to make changes persistent.
2827         *
2828         * Usually there is absolutely no need to call this method explicitly.
2829         * It will be called automatically when File::Save() was called.
2830         *
2831         * @throws gig::Exception if samples cannot be dereferenced
2832         */
2833        void Instrument::UpdateChunks() {
2834            // first update base classes' chunks
2835            DLS::Instrument::UpdateChunks();
2836    
2837            // update Regions' chunks
2838            {
2839                RegionList::iterator iter = pRegions->begin();
2840                RegionList::iterator end  = pRegions->end();
2841                for (; iter != end; ++iter)
2842                    (*iter)->UpdateChunks();
2843            }
2844    
2845            // make sure 'lart' RIFF list chunk exists
2846            RIFF::List* lart = pCkInstrument->GetSubList(LIST_TYPE_LART);
2847            if (!lart)  lart = pCkInstrument->AddSubList(LIST_TYPE_LART);
2848            // make sure '3ewg' RIFF chunk exists
2849            RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);
2850            if (!_3ewg)  {
2851                File* pFile = (File*) GetParent();
2852    
2853                // 3ewg is bigger in gig3, as it includes the iMIDI rules
2854                int size = (pFile->pVersion && pFile->pVersion->major == 3) ? 16416 : 12;
2855                _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, size);
2856                memset(_3ewg->LoadChunkData(), 0, size);
2857            }
2858            // update '3ewg' RIFF chunk
2859            uint8_t* pData = (uint8_t*) _3ewg->LoadChunkData();
2860            store16(&pData[0], EffectSend);
2861            store32(&pData[2], Attenuation);
2862            store16(&pData[6], FineTune);
2863            store16(&pData[8], PitchbendRange);
2864            const uint8_t dimkeystart = (PianoReleaseMode ? 0x01 : 0x00) |
2865                                        DimensionKeyRange.low << 1;
2866            pData[10] = dimkeystart;
2867            pData[11] = DimensionKeyRange.high;
2868      }      }
2869    
2870      /**      /**
# Line 1706  namespace { Line 2875  namespace {
2875       *             there is no Region defined for the given \a Key       *             there is no Region defined for the given \a Key
2876       */       */
2877      Region* Instrument::GetRegion(unsigned int Key) {      Region* Instrument::GetRegion(unsigned int Key) {
2878          if (!pRegions || Key > 127) return NULL;          if (!pRegions || !pRegions->size() || Key > 127) return NULL;
2879          return RegionKeyTable[Key];          return RegionKeyTable[Key];
2880    
2881          /*for (int i = 0; i < Regions; i++) {          /*for (int i = 0; i < Regions; i++) {
2882              if (Key <= pRegions[i]->KeyRange.high &&              if (Key <= pRegions[i]->KeyRange.high &&
2883                  Key >= pRegions[i]->KeyRange.low) return pRegions[i];                  Key >= pRegions[i]->KeyRange.low) return pRegions[i];
# Line 1723  namespace { Line 2893  namespace {
2893       * @see      GetNextRegion()       * @see      GetNextRegion()
2894       */       */
2895      Region* Instrument::GetFirstRegion() {      Region* Instrument::GetFirstRegion() {
2896          if (!Regions) return NULL;          if (!pRegions) return NULL;
2897          RegionIndex = 1;          RegionsIterator = pRegions->begin();
2898          return pRegions[0];          return static_cast<gig::Region*>( (RegionsIterator != pRegions->end()) ? *RegionsIterator : NULL );
2899      }      }
2900    
2901      /**      /**
# Line 1737  namespace { Line 2907  namespace {
2907       * @see      GetFirstRegion()       * @see      GetFirstRegion()
2908       */       */
2909      Region* Instrument::GetNextRegion() {      Region* Instrument::GetNextRegion() {
2910          if (RegionIndex < 0 || uint32_t(RegionIndex) >= Regions) return NULL;          if (!pRegions) return NULL;
2911          return pRegions[RegionIndex++];          RegionsIterator++;
2912            return static_cast<gig::Region*>( (RegionsIterator != pRegions->end()) ? *RegionsIterator : NULL );
2913        }
2914    
2915        Region* Instrument::AddRegion() {
2916            // create new Region object (and its RIFF chunks)
2917            RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
2918            if (!lrgn)  lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
2919            RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
2920            Region* pNewRegion = new Region(this, rgn);
2921            pRegions->push_back(pNewRegion);
2922            Regions = pRegions->size();
2923            // update Region key table for fast lookup
2924            UpdateRegionKeyTable();
2925            // done
2926            return pNewRegion;
2927        }
2928    
2929        void Instrument::DeleteRegion(Region* pRegion) {
2930            if (!pRegions) return;
2931            DLS::Instrument::DeleteRegion((DLS::Region*) pRegion);
2932            // update Region key table for fast lookup
2933            UpdateRegionKeyTable();
2934        }
2935    
2936    
2937    
2938    // *************** Group ***************
2939    // *
2940    
2941        /** @brief Constructor.
2942         *
2943         * @param file   - pointer to the gig::File object
2944         * @param ck3gnm - pointer to 3gnm chunk associated with this group or
2945         *                 NULL if this is a new Group
2946         */
2947        Group::Group(File* file, RIFF::Chunk* ck3gnm) {
2948            pFile      = file;
2949            pNameChunk = ck3gnm;
2950            ::LoadString(pNameChunk, Name);
2951        }
2952    
2953        Group::~Group() {
2954            // remove the chunk associated with this group (if any)
2955            if (pNameChunk) pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);
2956        }
2957    
2958        /** @brief Update chunks with current group settings.
2959         *
2960         * Apply current Group field values to the respective chunks. You have
2961         * to call File::Save() to make changes persistent.
2962         *
2963         * Usually there is absolutely no need to call this method explicitly.
2964         * It will be called automatically when File::Save() was called.
2965         */
2966        void Group::UpdateChunks() {
2967            // make sure <3gri> and <3gnl> list chunks exist
2968            RIFF::List* _3gri = pFile->pRIFF->GetSubList(LIST_TYPE_3GRI);
2969            if (!_3gri) {
2970                _3gri = pFile->pRIFF->AddSubList(LIST_TYPE_3GRI);
2971                pFile->pRIFF->MoveSubChunk(_3gri, pFile->pRIFF->GetSubChunk(CHUNK_ID_PTBL));
2972            }
2973            RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
2974            if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
2975    
2976            if (!pNameChunk && pFile->pVersion && pFile->pVersion->major == 3) {
2977                // v3 has a fixed list of 128 strings, find a free one
2978                for (RIFF::Chunk* ck = _3gnl->GetFirstSubChunk() ; ck ; ck = _3gnl->GetNextSubChunk()) {
2979                    if (strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) {
2980                        pNameChunk = ck;
2981                        break;
2982                    }
2983                }
2984            }
2985    
2986            // now store the name of this group as <3gnm> chunk as subchunk of the <3gnl> list chunk
2987            ::SaveString(CHUNK_ID_3GNM, pNameChunk, _3gnl, Name, String("Unnamed Group"), true, 64);
2988        }
2989    
2990        /**
2991         * Returns the first Sample of this Group. You have to call this method
2992         * once before you use GetNextSample().
2993         *
2994         * <b>Notice:</b> this method might block for a long time, in case the
2995         * samples of this .gig file were not scanned yet
2996         *
2997         * @returns  pointer address to first Sample or NULL if there is none
2998         *           applied to this Group
2999         * @see      GetNextSample()
3000         */
3001        Sample* Group::GetFirstSample() {
3002            // FIXME: lazy und unsafe implementation, should be an autonomous iterator
3003            for (Sample* pSample = pFile->GetFirstSample(); pSample; pSample = pFile->GetNextSample()) {
3004                if (pSample->GetGroup() == this) return pSample;
3005            }
3006            return NULL;
3007        }
3008    
3009        /**
3010         * Returns the next Sample of the Group. You have to call
3011         * GetFirstSample() once before you can use this method. By calling this
3012         * method multiple times it iterates through the Samples assigned to
3013         * this Group.
3014         *
3015         * @returns  pointer address to the next Sample of this Group or NULL if
3016         *           end reached
3017         * @see      GetFirstSample()
3018         */
3019        Sample* Group::GetNextSample() {
3020            // FIXME: lazy und unsafe implementation, should be an autonomous iterator
3021            for (Sample* pSample = pFile->GetNextSample(); pSample; pSample = pFile->GetNextSample()) {
3022                if (pSample->GetGroup() == this) return pSample;
3023            }
3024            return NULL;
3025        }
3026    
3027        /**
3028         * Move Sample given by \a pSample from another Group to this Group.
3029         */
3030        void Group::AddSample(Sample* pSample) {
3031            pSample->pGroup = this;
3032        }
3033    
3034        /**
3035         * Move all members of this group to another group (preferably the 1st
3036         * one except this). This method is called explicitly by
3037         * File::DeleteGroup() thus when a Group was deleted. This code was
3038         * intentionally not placed in the destructor!
3039         */
3040        void Group::MoveAll() {
3041            // get "that" other group first
3042            Group* pOtherGroup = NULL;
3043            for (pOtherGroup = pFile->GetFirstGroup(); pOtherGroup; pOtherGroup = pFile->GetNextGroup()) {
3044                if (pOtherGroup != this) break;
3045            }
3046            if (!pOtherGroup) throw Exception(
3047                "Could not move samples to another group, since there is no "
3048                "other Group. This is a bug, report it!"
3049            );
3050            // now move all samples of this group to the other group
3051            for (Sample* pSample = GetFirstSample(); pSample; pSample = GetNextSample()) {
3052                pOtherGroup->AddSample(pSample);
3053            }
3054      }      }
3055    
3056    
# Line 1746  namespace { Line 3058  namespace {
3058  // *************** File ***************  // *************** File ***************
3059  // *  // *
3060    
3061        // File version 2.0, 1998-06-28
3062        const DLS::version_t File::VERSION_2 = {
3063            0, 2, 19980628 & 0xffff, 19980628 >> 16
3064        };
3065    
3066        // File version 3.0, 2003-03-31
3067        const DLS::version_t File::VERSION_3 = {
3068            0, 3, 20030331 & 0xffff, 20030331 >> 16
3069        };
3070    
3071        const DLS::Info::FixedStringLength File::FixedStringLengths[] = {
3072            { CHUNK_ID_IARL, 256 },
3073            { CHUNK_ID_IART, 128 },
3074            { CHUNK_ID_ICMS, 128 },
3075            { CHUNK_ID_ICMT, 1024 },
3076            { CHUNK_ID_ICOP, 128 },
3077            { CHUNK_ID_ICRD, 128 },
3078            { CHUNK_ID_IENG, 128 },
3079            { CHUNK_ID_IGNR, 128 },
3080            { CHUNK_ID_IKEY, 128 },
3081            { CHUNK_ID_IMED, 128 },
3082            { CHUNK_ID_INAM, 128 },
3083            { CHUNK_ID_IPRD, 128 },
3084            { CHUNK_ID_ISBJ, 128 },
3085            { CHUNK_ID_ISFT, 128 },
3086            { CHUNK_ID_ISRC, 128 },
3087            { CHUNK_ID_ISRF, 128 },
3088            { CHUNK_ID_ITCH, 128 },
3089            { 0, 0 }
3090        };
3091    
3092        File::File() : DLS::File() {
3093            *pVersion = VERSION_3;
3094            pGroups = NULL;
3095            pInfo->FixedStringLengths = FixedStringLengths;
3096            pInfo->ArchivalLocation = String(256, ' ');
3097    
3098            // add some mandatory chunks to get the file chunks in right
3099            // order (INFO chunk will be moved to first position later)
3100            pRIFF->AddSubChunk(CHUNK_ID_VERS, 8);
3101            pRIFF->AddSubChunk(CHUNK_ID_COLH, 4);
3102            pRIFF->AddSubChunk(CHUNK_ID_DLID, 16);
3103    
3104            GenerateDLSID();
3105        }
3106    
3107      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {      File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {
3108          pSamples     = NULL;          pGroups = NULL;
3109          pInstruments = NULL;          pInfo->FixedStringLengths = FixedStringLengths;
3110      }      }
3111    
3112      File::~File() {      File::~File() {
3113          // free samples          if (pGroups) {
3114          if (pSamples) {              std::list<Group*>::iterator iter = pGroups->begin();
3115              SamplesIterator = pSamples->begin();              std::list<Group*>::iterator end  = pGroups->end();
3116              while (SamplesIterator != pSamples->end() ) {              while (iter != end) {
3117                  delete (*SamplesIterator);                  delete *iter;
3118                  SamplesIterator++;                  ++iter;
3119              }              }
3120              pSamples->clear();              delete pGroups;
3121              delete pSamples;          }
   
         }  
         // free instruments  
         if (pInstruments) {  
             InstrumentsIterator = pInstruments->begin();  
             while (InstrumentsIterator != pInstruments->end() ) {  
                 delete (*InstrumentsIterator);  
                 InstrumentsIterator++;  
             }  
             pInstruments->clear();  
             delete pInstruments;  
         }  
         // free extension files  
         for (std::list<RIFF::File*>::iterator i = ExtensionFiles.begin() ; i != ExtensionFiles.end() ; i++)  
             delete *i;  
3122      }      }
3123    
3124      Sample* File::GetFirstSample(progress_t* pProgress) {      Sample* File::GetFirstSample(progress_t* pProgress) {
# Line 1791  namespace { Line 3134  namespace {
3134          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );          return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
3135      }      }
3136    
3137        /** @brief Add a new sample.
3138         *
3139         * This will create a new Sample object for the gig file. You have to
3140         * call Save() to make this persistent to the file.
3141         *
3142         * @returns pointer to new Sample object
3143         */
3144        Sample* File::AddSample() {
3145           if (!pSamples) LoadSamples();
3146           __ensureMandatoryChunksExist();
3147           RIFF::List* wvpl = pRIFF->GetSubList(LIST_TYPE_WVPL);
3148           // create new Sample object and its respective 'wave' list chunk
3149           RIFF::List* wave = wvpl->AddSubList(LIST_TYPE_WAVE);
3150           Sample* pSample = new Sample(this, wave, 0 /*arbitrary value, we update offsets when we save*/);
3151    
3152           // add mandatory chunks to get the chunks in right order
3153           wave->AddSubChunk(CHUNK_ID_FMT, 16);
3154           wave->AddSubList(LIST_TYPE_INFO);
3155    
3156           pSamples->push_back(pSample);
3157           return pSample;
3158        }
3159    
3160        /** @brief Delete a sample.
3161         *
3162         * This will delete the given Sample object from the gig file. Any
3163         * references to this sample from Regions and DimensionRegions will be
3164         * removed. You have to call Save() to make this persistent to the file.
3165         *
3166         * @param pSample - sample to delete
3167         * @throws gig::Exception if given sample could not be found
3168         */
3169        void File::DeleteSample(Sample* pSample) {
3170            if (!pSamples || !pSamples->size()) throw gig::Exception("Could not delete sample as there are no samples");
3171            SampleList::iterator iter = find(pSamples->begin(), pSamples->end(), (DLS::Sample*) pSample);
3172            if (iter == pSamples->end()) throw gig::Exception("Could not delete sample, could not find given sample");
3173            if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation
3174            pSamples->erase(iter);
3175            delete pSample;
3176    
3177            // remove all references to the sample
3178            for (Instrument* instrument = GetFirstInstrument() ; instrument ;
3179                 instrument = GetNextInstrument()) {
3180                for (Region* region = instrument->GetFirstRegion() ; region ;
3181                     region = instrument->GetNextRegion()) {
3182    
3183                    if (region->GetSample() == pSample) region->SetSample(NULL);
3184    
3185                    for (int i = 0 ; i < region->DimensionRegions ; i++) {
3186                        gig::DimensionRegion *d = region->pDimensionRegions[i];
3187                        if (d->pSample == pSample) d->pSample = NULL;
3188                    }
3189                }
3190            }
3191        }
3192    
3193        void File::LoadSamples() {
3194            LoadSamples(NULL);
3195        }
3196    
3197      void File::LoadSamples(progress_t* pProgress) {      void File::LoadSamples(progress_t* pProgress) {
3198            // Groups must be loaded before samples, because samples will try
3199            // to resolve the group they belong to
3200            if (!pGroups) LoadGroups();
3201    
3202            if (!pSamples) pSamples = new SampleList;
3203    
3204          RIFF::File* file = pRIFF;          RIFF::File* file = pRIFF;
3205    
3206          // just for progress calculation          // just for progress calculation
# Line 1803  namespace { Line 3212  namespace {
3212          for (int i = 0 ; i < WavePoolCount ; i++) {          for (int i = 0 ; i < WavePoolCount ; i++) {
3213              if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];              if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];
3214          }          }
3215          String name(pRIFF->Filename);          String name(pRIFF->GetFileName());
3216          int nameLen = pRIFF->Filename.length();          int nameLen = name.length();
3217          char suffix[6];          char suffix[6];
3218          if (nameLen > 4 && pRIFF->Filename.substr(nameLen - 4) == ".gig") nameLen -= 4;          if (nameLen > 4 && name.substr(nameLen - 4) == ".gig") nameLen -= 4;
3219    
3220          for (int fileNo = 0 ; ; ) {          for (int fileNo = 0 ; ; ) {
3221              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);              RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);
# Line 1819  namespace { Line 3228  namespace {
3228                          const float subprogress = (float) iSampleIndex / (float) iTotalSamples;                          const float subprogress = (float) iSampleIndex / (float) iTotalSamples;
3229                          __notify_progress(pProgress, subprogress);                          __notify_progress(pProgress, subprogress);
3230    
                         if (!pSamples) pSamples = new SampleList;  
3231                          unsigned long waveFileOffset = wave->GetFilePos();                          unsigned long waveFileOffset = wave->GetFilePos();
3232                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));                          pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));
3233    
# Line 1836  namespace { Line 3244  namespace {
3244                  name.replace(nameLen, 5, suffix);                  name.replace(nameLen, 5, suffix);
3245                  file = new RIFF::File(name);                  file = new RIFF::File(name);
3246                  ExtensionFiles.push_back(file);                  ExtensionFiles.push_back(file);
3247              }              } else break;
             else throw gig::Exception("Mandatory <wvpl> chunk not found.");  
3248          }          }
3249    
3250          __notify_progress(pProgress, 1.0); // notify done          __notify_progress(pProgress, 1.0); // notify done
# Line 1847  namespace { Line 3254  namespace {
3254          if (!pInstruments) LoadInstruments();          if (!pInstruments) LoadInstruments();
3255          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
3256          InstrumentsIterator = pInstruments->begin();          InstrumentsIterator = pInstruments->begin();
3257          return (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL;          return static_cast<gig::Instrument*>( (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL );
3258      }      }
3259    
3260      Instrument* File::GetNextInstrument() {      Instrument* File::GetNextInstrument() {
3261          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
3262          InstrumentsIterator++;          InstrumentsIterator++;
3263          return (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL;          return static_cast<gig::Instrument*>( (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL );
3264      }      }
3265    
3266      /**      /**
# Line 1886  namespace { Line 3293  namespace {
3293          if (!pInstruments) return NULL;          if (!pInstruments) return NULL;
3294          InstrumentsIterator = pInstruments->begin();          InstrumentsIterator = pInstruments->begin();
3295          for (uint i = 0; InstrumentsIterator != pInstruments->end(); i++) {          for (uint i = 0; InstrumentsIterator != pInstruments->end(); i++) {
3296              if (i == index) return *InstrumentsIterator;              if (i == index) return static_cast<gig::Instrument*>( *InstrumentsIterator );
3297              InstrumentsIterator++;              InstrumentsIterator++;
3298          }          }
3299          return NULL;          return NULL;
3300      }      }
3301    
3302        /** @brief Add a new instrument definition.
3303         *
3304         * This will create a new Instrument object for the gig file. You have
3305         * to call Save() to make this persistent to the file.
3306         *
3307         * @returns pointer to new Instrument object
3308         */
3309        Instrument* File::AddInstrument() {
3310           if (!pInstruments) LoadInstruments();
3311           __ensureMandatoryChunksExist();
3312           RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
3313           RIFF::List* lstInstr = lstInstruments->AddSubList(LIST_TYPE_INS);
3314    
3315           // add mandatory chunks to get the chunks in right order
3316           lstInstr->AddSubList(LIST_TYPE_INFO);
3317           lstInstr->AddSubChunk(CHUNK_ID_DLID, 16);
3318    
3319           Instrument* pInstrument = new Instrument(this, lstInstr);
3320           pInstrument->GenerateDLSID();
3321    
3322           lstInstr->AddSubChunk(CHUNK_ID_INSH, 12);
3323    
3324           // this string is needed for the gig to be loadable in GSt:
3325           pInstrument->pInfo->Software = "Endless Wave";
3326    
3327           pInstruments->push_back(pInstrument);
3328           return pInstrument;
3329        }
3330    
3331        /** @brief Delete an instrument.
3332         *
3333         * This will delete the given Instrument object from the gig file. You
3334         * have to call Save() to make this persistent to the file.
3335         *
3336         * @param pInstrument - instrument to delete
3337         * @throws gig::Exception if given instrument could not be found
3338         */
3339        void File::DeleteInstrument(Instrument* pInstrument) {
3340            if (!pInstruments) throw gig::Exception("Could not delete instrument as there are no instruments");
3341            InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), (DLS::Instrument*) pInstrument);
3342            if (iter == pInstruments->end()) throw gig::Exception("Could not delete instrument, could not find given instrument");
3343            pInstruments->erase(iter);
3344            delete pInstrument;
3345        }
3346    
3347        void File::LoadInstruments() {
3348            LoadInstruments(NULL);
3349        }
3350    
3351      void File::LoadInstruments(progress_t* pProgress) {      void File::LoadInstruments(progress_t* pProgress) {
3352            if (!pInstruments) pInstruments = new InstrumentList;
3353          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);          RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
3354          if (lstInstruments) {          if (lstInstruments) {
3355              int iInstrumentIndex = 0;              int iInstrumentIndex = 0;
# Line 1907  namespace { Line 3364  namespace {
3364                      progress_t subprogress;                      progress_t subprogress;
3365                      __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);                      __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);
3366    
                     if (!pInstruments) pInstruments = new InstrumentList;  
3367                      pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));                      pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));
3368    
3369                      iInstrumentIndex++;                      iInstrumentIndex++;
# Line 1916  namespace { Line 3372  namespace {
3372              }              }
3373              __notify_progress(pProgress, 1.0); // notify done              __notify_progress(pProgress, 1.0); // notify done
3374          }          }
3375          else throw gig::Exception("Mandatory <lins> list chunk not found.");      }
3376    
3377        /// Updates the 3crc chunk with the checksum of a sample. The
3378        /// update is done directly to disk, as this method is called
3379        /// after File::Save()
3380        void File::SetSampleChecksum(Sample* pSample, uint32_t crc) {
3381            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
3382            if (!_3crc) return;
3383    
3384            // get the index of the sample
3385            int iWaveIndex = -1;
3386            File::SampleList::iterator iter = pSamples->begin();
3387            File::SampleList::iterator end  = pSamples->end();
3388            for (int index = 0; iter != end; ++iter, ++index) {
3389                if (*iter == pSample) {
3390                    iWaveIndex = index;
3391                    break;
3392                }
3393            }
3394            if (iWaveIndex < 0) throw gig::Exception("Could not update crc, could not find sample");
3395    
3396            // write the CRC-32 checksum to disk
3397            _3crc->SetPos(iWaveIndex * 8);
3398            uint32_t tmp = 1;
3399            _3crc->WriteUint32(&tmp); // unknown, always 1?
3400            _3crc->WriteUint32(&crc);
3401        }
3402    
3403        Group* File::GetFirstGroup() {
3404            if (!pGroups) LoadGroups();
3405            // there must always be at least one group
3406            GroupsIterator = pGroups->begin();
3407            return *GroupsIterator;
3408        }
3409    
3410        Group* File::GetNextGroup() {
3411            if (!pGroups) return NULL;
3412            ++GroupsIterator;
3413            return (GroupsIterator == pGroups->end()) ? NULL : *GroupsIterator;
3414        }
3415    
3416        /**
3417         * Returns the group with the given index.
3418         *
3419         * @param index - number of the sought group (0..n)
3420         * @returns sought group or NULL if there's no such group
3421         */
3422        Group* File::GetGroup(uint index) {
3423            if (!pGroups) LoadGroups();
3424            GroupsIterator = pGroups->begin();
3425            for (uint i = 0; GroupsIterator != pGroups->end(); i++) {
3426                if (i == index) return *GroupsIterator;
3427                ++GroupsIterator;
3428            }
3429            return NULL;
3430        }
3431    
3432        Group* File::AddGroup() {
3433            if (!pGroups) LoadGroups();
3434            // there must always be at least one group
3435            __ensureMandatoryChunksExist();
3436            Group* pGroup = new Group(this, NULL);
3437            pGroups->push_back(pGroup);
3438            return pGroup;
3439        }
3440    
3441        /** @brief Delete a group and its samples.
3442         *
3443         * This will delete the given Group object and all the samples that
3444         * belong to this group from the gig file. You have to call Save() to
3445         * make this persistent to the file.
3446         *
3447         * @param pGroup - group to delete
3448         * @throws gig::Exception if given group could not be found
3449         */
3450        void File::DeleteGroup(Group* pGroup) {
3451            if (!pGroups) LoadGroups();
3452            std::list<Group*>::iterator iter = find(pGroups->begin(), pGroups->end(), pGroup);
3453            if (iter == pGroups->end()) throw gig::Exception("Could not delete group, could not find given group");
3454            if (pGroups->size() == 1) throw gig::Exception("Cannot delete group, there must be at least one default group!");
3455            // delete all members of this group
3456            for (Sample* pSample = pGroup->GetFirstSample(); pSample; pSample = pGroup->GetNextSample()) {
3457                DeleteSample(pSample);
3458            }
3459            // now delete this group object
3460            pGroups->erase(iter);
3461            delete pGroup;
3462        }
3463    
3464        /** @brief Delete a group.
3465         *
3466         * This will delete the given Group object from the gig file. All the
3467         * samples that belong to this group will not be deleted, but instead
3468         * be moved to another group. You have to call Save() to make this
3469         * persistent to the file.
3470         *
3471         * @param pGroup - group to delete
3472         * @throws gig::Exception if given group could not be found
3473         */
3474        void File::DeleteGroupOnly(Group* pGroup) {
3475            if (!pGroups) LoadGroups();
3476            std::list<Group*>::iterator iter = find(pGroups->begin(), pGroups->end(), pGroup);
3477            if (iter == pGroups->end()) throw gig::Exception("Could not delete group, could not find given group");
3478            if (pGroups->size() == 1) throw gig::Exception("Cannot delete group, there must be at least one default group!");
3479            // move all members of this group to another group
3480            pGroup->MoveAll();
3481            pGroups->erase(iter);
3482            delete pGroup;
3483        }
3484    
3485        void File::LoadGroups() {
3486            if (!pGroups) pGroups = new std::list<Group*>;
3487            // try to read defined groups from file
3488            RIFF::List* lst3gri = pRIFF->GetSubList(LIST_TYPE_3GRI);
3489            if (lst3gri) {
3490                RIFF::List* lst3gnl = lst3gri->GetSubList(LIST_TYPE_3GNL);
3491                if (lst3gnl) {
3492                    RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();
3493                    while (ck) {
3494                        if (ck->GetChunkID() == CHUNK_ID_3GNM) {
3495                            if (pVersion && pVersion->major == 3 &&
3496                                strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) break;
3497    
3498                            pGroups->push_back(new Group(this, ck));
3499                        }
3500                        ck = lst3gnl->GetNextSubChunk();
3501                    }
3502                }
3503            }
3504            // if there were no group(s), create at least the mandatory default group
3505            if (!pGroups->size()) {
3506                Group* pGroup = new Group(this, NULL);
3507                pGroup->Name = "Default Group";
3508                pGroups->push_back(pGroup);
3509            }
3510        }
3511    
3512        /**
3513         * Apply all the gig file's current instruments, samples, groups and settings
3514         * to the respective RIFF chunks. You have to call Save() to make changes
3515         * persistent.
3516         *
3517         * Usually there is absolutely no need to call this method explicitly.
3518         * It will be called automatically when File::Save() was called.
3519         *
3520         * @throws Exception - on errors
3521         */
3522        void File::UpdateChunks() {
3523            bool newFile = pRIFF->GetSubList(LIST_TYPE_INFO) == NULL;
3524    
3525            b64BitWavePoolOffsets = pVersion && pVersion->major == 3;
3526    
3527            // first update base class's chunks
3528            DLS::File::UpdateChunks();
3529    
3530            if (newFile) {
3531                // INFO was added by Resource::UpdateChunks - make sure it
3532                // is placed first in file
3533                RIFF::Chunk* info = pRIFF->GetSubList(LIST_TYPE_INFO);
3534                RIFF::Chunk* first = pRIFF->GetFirstSubChunk();
3535                if (first != info) {
3536                    pRIFF->MoveSubChunk(info, first);
3537                }
3538            }
3539    
3540            // update group's chunks
3541            if (pGroups) {
3542                std::list<Group*>::iterator iter = pGroups->begin();
3543                std::list<Group*>::iterator end  = pGroups->end();
3544                for (; iter != end; ++iter) {
3545                    (*iter)->UpdateChunks();
3546                }
3547    
3548                // v3: make sure the file has 128 3gnm chunks
3549                if (pVersion && pVersion->major == 3) {
3550                    RIFF::List* _3gnl = pRIFF->GetSubList(LIST_TYPE_3GRI)->GetSubList(LIST_TYPE_3GNL);
3551                    RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();
3552                    for (int i = 0 ; i < 128 ; i++) {
3553                        if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);
3554                        if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();
3555                    }
3556                }
3557            }
3558    
3559            // update einf chunk
3560    
3561            // The einf chunk contains statistics about the gig file, such
3562            // as the number of regions and samples used by each
3563            // instrument. It is divided in equally sized parts, where the
3564            // first part contains information about the whole gig file,
3565            // and the rest of the parts map to each instrument in the
3566            // file.
3567            //
3568            // At the end of each part there is a bit map of each sample
3569            // in the file, where a set bit means that the sample is used
3570            // by the file/instrument.
3571            //
3572            // Note that there are several fields with unknown use. These
3573            // are set to zero.
3574    
3575            int sublen = pSamples->size() / 8 + 49;
3576            int einfSize = (Instruments + 1) * sublen;
3577    
3578            RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
3579            if (einf) {
3580                if (einf->GetSize() != einfSize) {
3581                    einf->Resize(einfSize);
3582                    memset(einf->LoadChunkData(), 0, einfSize);
3583                }
3584            } else if (newFile) {
3585                einf = pRIFF->AddSubChunk(CHUNK_ID_EINF, einfSize);
3586            }
3587            if (einf) {
3588                uint8_t* pData = (uint8_t*) einf->LoadChunkData();
3589    
3590                std::map<gig::Sample*,int> sampleMap;
3591                int sampleIdx = 0;
3592                for (Sample* pSample = GetFirstSample(); pSample; pSample = GetNextSample()) {
3593                    sampleMap[pSample] = sampleIdx++;
3594                }
3595    
3596                int totnbusedsamples = 0;
3597                int totnbusedchannels = 0;
3598                int totnbregions = 0;
3599                int totnbdimregions = 0;
3600                int totnbloops = 0;
3601                int instrumentIdx = 0;
3602    
3603                memset(&pData[48], 0, sublen - 48);
3604    
3605                for (Instrument* instrument = GetFirstInstrument() ; instrument ;
3606                     instrument = GetNextInstrument()) {
3607                    int nbusedsamples = 0;
3608                    int nbusedchannels = 0;
3609                    int nbdimregions = 0;
3610                    int nbloops = 0;
3611    
3612                    memset(&pData[(instrumentIdx + 1) * sublen + 48], 0, sublen - 48);
3613    
3614                    for (Region* region = instrument->GetFirstRegion() ; region ;
3615                         region = instrument->GetNextRegion()) {
3616                        for (int i = 0 ; i < region->DimensionRegions ; i++) {
3617                            gig::DimensionRegion *d = region->pDimensionRegions[i];
3618                            if (d->pSample) {
3619                                int sampleIdx = sampleMap[d->pSample];
3620                                int byte = 48 + sampleIdx / 8;
3621                                int bit = 1 << (sampleIdx & 7);
3622                                if ((pData[(instrumentIdx + 1) * sublen + byte] & bit) == 0) {
3623                                    pData[(instrumentIdx + 1) * sublen + byte] |= bit;
3624                                    nbusedsamples++;
3625                                    nbusedchannels += d->pSample->Channels;
3626    
3627                                    if ((pData[byte] & bit) == 0) {
3628                                        pData[byte] |= bit;
3629                                        totnbusedsamples++;
3630                                        totnbusedchannels += d->pSample->Channels;
3631                                    }
3632                                }
3633                            }
3634                            if (d->SampleLoops) nbloops++;
3635                        }
3636                        nbdimregions += region->DimensionRegions;
3637                    }
3638                    // first 4 bytes unknown - sometimes 0, sometimes length of einf part
3639                    // store32(&pData[(instrumentIdx + 1) * sublen], sublen);
3640                    store32(&pData[(instrumentIdx + 1) * sublen + 4], nbusedchannels);
3641                    store32(&pData[(instrumentIdx + 1) * sublen + 8], nbusedsamples);
3642                    store32(&pData[(instrumentIdx + 1) * sublen + 12], 1);
3643                    store32(&pData[(instrumentIdx + 1) * sublen + 16], instrument->Regions);
3644                    store32(&pData[(instrumentIdx + 1) * sublen + 20], nbdimregions);
3645                    store32(&pData[(instrumentIdx + 1) * sublen + 24], nbloops);
3646                    // next 8 bytes unknown
3647                    store32(&pData[(instrumentIdx + 1) * sublen + 36], instrumentIdx);
3648                    store32(&pData[(instrumentIdx + 1) * sublen + 40], pSamples->size());
3649                    // next 4 bytes unknown
3650    
3651                    totnbregions += instrument->Regions;
3652                    totnbdimregions += nbdimregions;
3653                    totnbloops += nbloops;
3654                    instrumentIdx++;
3655                }
3656                // first 4 bytes unknown - sometimes 0, sometimes length of einf part
3657                // store32(&pData[0], sublen);
3658                store32(&pData[4], totnbusedchannels);
3659                store32(&pData[8], totnbusedsamples);
3660                store32(&pData[12], Instruments);
3661                store32(&pData[16], totnbregions);
3662                store32(&pData[20], totnbdimregions);
3663                store32(&pData[24], totnbloops);
3664                // next 8 bytes unknown
3665                // next 4 bytes unknown, not always 0
3666                store32(&pData[40], pSamples->size());
3667                // next 4 bytes unknown
3668            }
3669    
3670            // update 3crc chunk
3671    
3672            // The 3crc chunk contains CRC-32 checksums for the
3673            // samples. The actual checksum values will be filled in
3674            // later, by Sample::Write.
3675    
3676            RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
3677            if (_3crc) {
3678                _3crc->Resize(pSamples->size() * 8);
3679            } else if (newFile) {
3680                _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
3681                _3crc->LoadChunkData();
3682    
3683                // the order of einf and 3crc is not the same in v2 and v3
3684                if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);
3685            }
3686      }      }
3687    
3688    

Legend:
Removed from v.728  
changed lines
  Added in v.1317

  ViewVC Help
Powered by ViewVC