/[svn]/libgig/trunk/src/gig.cpp
ViewVC logotype

Annotation of /libgig/trunk/src/gig.cpp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1316 - (hide annotations) (download)
Fri Aug 31 19:09:13 2007 UTC (16 years, 7 months ago) by schoenebeck
File size: 164970 byte(s)
* src/gig.h, src/gig.cpp:
  - added method GetParent() to class 'DimensionRegion', which returns its
    parent Region

1 schoenebeck 2 /***************************************************************************
2     * *
3 schoenebeck 933 * libgig - C++ cross-platform Gigasampler format file access library *
4 schoenebeck 2 * *
5 schoenebeck 1050 * Copyright (C) 2003-2007 by Christian Schoenebeck *
6 schoenebeck 384 * <cuse@users.sourceforge.net> *
7 schoenebeck 2 * *
8     * This library is free software; you can redistribute it and/or modify *
9     * it under the terms of the GNU General Public License as published by *
10     * the Free Software Foundation; either version 2 of the License, or *
11     * (at your option) any later version. *
12     * *
13     * This library is distributed in the hope that it will be useful, *
14     * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16     * GNU General Public License for more details. *
17     * *
18     * You should have received a copy of the GNU General Public License *
19     * along with this library; if not, write to the Free Software *
20     * Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
21     * MA 02111-1307 USA *
22     ***************************************************************************/
23    
24     #include "gig.h"
25    
26 schoenebeck 809 #include "helper.h"
27    
28     #include <math.h>
29 schoenebeck 384 #include <iostream>
30    
31 schoenebeck 809 /// 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 schoenebeck 515 namespace gig {
53 schoenebeck 2
54 schoenebeck 515 // *************** progress_t ***************
55     // *
56    
57     progress_t::progress_t() {
58     callback = NULL;
59 schoenebeck 516 custom = NULL;
60 schoenebeck 515 __range_min = 0.0f;
61     __range_max = 1.0f;
62     }
63    
64     // private helper function to convert progress of a subprocess into the global progress
65     static void __notify_progress(progress_t* pProgress, float subprogress) {
66     if (pProgress && pProgress->callback) {
67     const float totalrange = pProgress->__range_max - pProgress->__range_min;
68     const float totalprogress = pProgress->__range_min + subprogress * totalrange;
69 schoenebeck 516 pProgress->factor = totalprogress;
70     pProgress->callback(pProgress); // now actually notify about the progress
71 schoenebeck 515 }
72     }
73    
74     // private helper function to divide a progress into subprogresses
75     static void __divide_progress(progress_t* pParentProgress, progress_t* pSubProgress, float totalTasks, float currentTask) {
76     if (pParentProgress && pParentProgress->callback) {
77     const float totalrange = pParentProgress->__range_max - pParentProgress->__range_min;
78     pSubProgress->callback = pParentProgress->callback;
79 schoenebeck 516 pSubProgress->custom = pParentProgress->custom;
80 schoenebeck 515 pSubProgress->__range_min = pParentProgress->__range_min + totalrange * currentTask / totalTasks;
81     pSubProgress->__range_max = pSubProgress->__range_min + totalrange / totalTasks;
82     }
83     }
84    
85    
86 schoenebeck 809 // *************** Internal functions for sample decompression ***************
87 persson 365 // *
88    
89 schoenebeck 515 namespace {
90    
91 persson 365 inline int get12lo(const unsigned char* pSrc)
92     {
93     const int x = pSrc[0] | (pSrc[1] & 0x0f) << 8;
94     return x & 0x800 ? x - 0x1000 : x;
95     }
96    
97     inline int get12hi(const unsigned char* pSrc)
98     {
99     const int x = pSrc[1] >> 4 | pSrc[2] << 4;
100     return x & 0x800 ? x - 0x1000 : x;
101     }
102    
103     inline int16_t get16(const unsigned char* pSrc)
104     {
105     return int16_t(pSrc[0] | pSrc[1] << 8);
106     }
107    
108     inline int get24(const unsigned char* pSrc)
109     {
110     const int x = pSrc[0] | pSrc[1] << 8 | pSrc[2] << 16;
111     return x & 0x800000 ? x - 0x1000000 : x;
112     }
113    
114 persson 902 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 persson 365 void Decompress16(int compressionmode, const unsigned char* params,
122 persson 372 int srcStep, int dstStep,
123     const unsigned char* pSrc, int16_t* pDst,
124 persson 365 unsigned long currentframeoffset,
125     unsigned long copysamples)
126     {
127     switch (compressionmode) {
128     case 0: // 16 bit uncompressed
129     pSrc += currentframeoffset * srcStep;
130     while (copysamples) {
131     *pDst = get16(pSrc);
132 persson 372 pDst += dstStep;
133 persson 365 pSrc += srcStep;
134     copysamples--;
135     }
136     break;
137    
138     case 1: // 16 bit compressed to 8 bit
139     int y = get16(params);
140     int dy = get16(params + 2);
141     while (currentframeoffset) {
142     dy -= int8_t(*pSrc);
143     y -= dy;
144     pSrc += srcStep;
145     currentframeoffset--;
146     }
147     while (copysamples) {
148     dy -= int8_t(*pSrc);
149     y -= dy;
150     *pDst = y;
151 persson 372 pDst += dstStep;
152 persson 365 pSrc += srcStep;
153     copysamples--;
154     }
155     break;
156     }
157     }
158    
159     void Decompress24(int compressionmode, const unsigned char* params,
160 persson 902 int dstStep, const unsigned char* pSrc, uint8_t* pDst,
161 persson 365 unsigned long currentframeoffset,
162 persson 437 unsigned long copysamples, int truncatedBits)
163 persson 365 {
164 persson 695 int y, dy, ddy, dddy;
165 persson 437
166 persson 695 #define GET_PARAMS(params) \
167     y = get24(params); \
168     dy = y - get24((params) + 3); \
169     ddy = get24((params) + 6); \
170     dddy = get24((params) + 9)
171 persson 365
172     #define SKIP_ONE(x) \
173 persson 695 dddy -= (x); \
174     ddy -= dddy; \
175     dy = -dy - ddy; \
176     y += dy
177 persson 365
178     #define COPY_ONE(x) \
179     SKIP_ONE(x); \
180 persson 902 store24(pDst, y << truncatedBits); \
181 persson 372 pDst += dstStep
182 persson 365
183     switch (compressionmode) {
184     case 2: // 24 bit uncompressed
185     pSrc += currentframeoffset * 3;
186     while (copysamples) {
187 persson 902 store24(pDst, get24(pSrc) << truncatedBits);
188 persson 372 pDst += dstStep;
189 persson 365 pSrc += 3;
190     copysamples--;
191     }
192     break;
193    
194     case 3: // 24 bit compressed to 16 bit
195     GET_PARAMS(params);
196     while (currentframeoffset) {
197     SKIP_ONE(get16(pSrc));
198     pSrc += 2;
199     currentframeoffset--;
200     }
201     while (copysamples) {
202     COPY_ONE(get16(pSrc));
203     pSrc += 2;
204     copysamples--;
205     }
206     break;
207    
208     case 4: // 24 bit compressed to 12 bit
209     GET_PARAMS(params);
210     while (currentframeoffset > 1) {
211     SKIP_ONE(get12lo(pSrc));
212     SKIP_ONE(get12hi(pSrc));
213     pSrc += 3;
214     currentframeoffset -= 2;
215     }
216     if (currentframeoffset) {
217     SKIP_ONE(get12lo(pSrc));
218     currentframeoffset--;
219     if (copysamples) {
220     COPY_ONE(get12hi(pSrc));
221     pSrc += 3;
222     copysamples--;
223     }
224     }
225     while (copysamples > 1) {
226     COPY_ONE(get12lo(pSrc));
227     COPY_ONE(get12hi(pSrc));
228     pSrc += 3;
229     copysamples -= 2;
230     }
231     if (copysamples) {
232     COPY_ONE(get12lo(pSrc));
233     }
234     break;
235    
236     case 5: // 24 bit compressed to 8 bit
237     GET_PARAMS(params);
238     while (currentframeoffset) {
239     SKIP_ONE(int8_t(*pSrc++));
240     currentframeoffset--;
241     }
242     while (copysamples) {
243     COPY_ONE(int8_t(*pSrc++));
244     copysamples--;
245     }
246     break;
247     }
248     }
249    
250     const int bytesPerFrame[] = { 4096, 2052, 768, 524, 396, 268 };
251     const int bytesPerFrameNoHdr[] = { 4096, 2048, 768, 512, 384, 256 };
252     const int headerSize[] = { 0, 4, 0, 12, 12, 12 };
253     const int bitsPerSample[] = { 16, 8, 24, 16, 12, 8 };
254     }
255    
256    
257 schoenebeck 1113
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 persson 1199 // *************** 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 schoenebeck 2 // *************** Sample ***************
302     // *
303    
304 schoenebeck 384 unsigned int Sample::Instances = 0;
305     buffer_t Sample::InternalDecompressionBuffer;
306 schoenebeck 2
307 schoenebeck 809 /** @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 persson 666 Sample::Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {
326 persson 1180 static const DLS::Info::FixedStringLength fixedStringLengths[] = {
327     { CHUNK_ID_INAM, 64 },
328     { 0, 0 }
329     };
330     pInfo->FixedStringLengths = fixedStringLengths;
331 schoenebeck 2 Instances++;
332 persson 666 FileNo = fileNo;
333 schoenebeck 2
334 schoenebeck 809 pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);
335     if (pCk3gix) {
336 schoenebeck 929 uint16_t iSampleGroup = pCk3gix->ReadInt16();
337 schoenebeck 930 pGroup = pFile->GetGroup(iSampleGroup);
338 schoenebeck 809 } else { // '3gix' chunk missing
339 schoenebeck 930 // by default assigned to that mandatory "Default Group"
340     pGroup = pFile->GetGroup(0);
341 schoenebeck 809 }
342 schoenebeck 2
343 schoenebeck 809 pCkSmpl = waveList->GetSubChunk(CHUNK_ID_SMPL);
344     if (pCkSmpl) {
345     Manufacturer = pCkSmpl->ReadInt32();
346     Product = pCkSmpl->ReadInt32();
347     SamplePeriod = pCkSmpl->ReadInt32();
348     MIDIUnityNote = pCkSmpl->ReadInt32();
349     FineTune = pCkSmpl->ReadInt32();
350     pCkSmpl->Read(&SMPTEFormat, 1, 4);
351     SMPTEOffset = pCkSmpl->ReadInt32();
352     Loops = pCkSmpl->ReadInt32();
353     pCkSmpl->ReadInt32(); // manufByt
354     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 persson 928 SamplePeriod = uint32_t(1000000000.0 / SamplesPerSecond + 0.5);
365 persson 1218 MIDIUnityNote = 60;
366 schoenebeck 809 FineTune = 0;
367 persson 1182 SMPTEFormat = smpte_format_no_offset;
368 schoenebeck 809 SMPTEOffset = 0;
369     Loops = 0;
370     LoopID = 0;
371 persson 1182 LoopType = loop_type_normal;
372 schoenebeck 809 LoopStart = 0;
373     LoopEnd = 0;
374     LoopFraction = 0;
375     LoopPlayCount = 0;
376     }
377 schoenebeck 2
378     FrameTable = NULL;
379     SamplePos = 0;
380     RAMCache.Size = 0;
381     RAMCache.pStart = NULL;
382     RAMCache.NullExtensionSize = 0;
383    
384 persson 365 if (BitDepth > 24) throw gig::Exception("Only samples up to 24 bit supported");
385    
386 persson 437 RIFF::Chunk* ewav = waveList->GetSubChunk(CHUNK_ID_EWAV);
387     Compressed = ewav;
388     Dithered = false;
389     TruncatedBits = 0;
390 schoenebeck 2 if (Compressed) {
391 persson 437 uint32_t version = ewav->ReadInt32();
392     if (version == 3 && BitDepth == 24) {
393     Dithered = ewav->ReadInt32();
394     ewav->SetPos(Channels == 2 ? 84 : 64);
395     TruncatedBits = ewav->ReadInt32();
396     }
397 schoenebeck 2 ScanCompressedSample();
398     }
399 schoenebeck 317
400     // we use a buffer for decompression and for truncating 24 bit samples to 16 bit
401 schoenebeck 384 if ((Compressed || BitDepth == 24) && !InternalDecompressionBuffer.Size) {
402     InternalDecompressionBuffer.pStart = new unsigned char[INITIAL_SAMPLE_BUFFER_SIZE];
403     InternalDecompressionBuffer.Size = INITIAL_SAMPLE_BUFFER_SIZE;
404 schoenebeck 317 }
405 persson 437 FrameOffset = 0; // just for streaming compressed samples
406 schoenebeck 21
407 persson 864 LoopSize = LoopEnd - LoopStart + 1;
408 schoenebeck 2 }
409    
410 schoenebeck 809 /**
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 schoenebeck 1050 * @throws DLS::Exception if FormatTag != DLS_WAVE_FORMAT_PCM or no sample data
418 schoenebeck 809 * 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 persson 1182 if (!pCkSmpl) {
428     pCkSmpl = pWaveList->AddSubChunk(CHUNK_ID_SMPL, 60);
429     memset(pCkSmpl->LoadChunkData(), 0, 60);
430     }
431 schoenebeck 809 // update 'smpl' chunk
432     uint8_t* pData = (uint8_t*) pCkSmpl->LoadChunkData();
433 persson 918 SamplePeriod = uint32_t(1000000000.0 / SamplesPerSecond + 0.5);
434 persson 1179 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 schoenebeck 809
443     // we skip 'manufByt' for now (4 bytes)
444    
445 persson 1179 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 schoenebeck 809
452     // make sure '3gix' chunk exists
453     pCk3gix = pWaveList->GetSubChunk(CHUNK_ID_3GIX);
454     if (!pCk3gix) pCk3gix = pWaveList->AddSubChunk(CHUNK_ID_3GIX, 4);
455 schoenebeck 929 // determine appropriate sample group index (to be stored in chunk)
456 schoenebeck 930 uint16_t iSampleGroup = 0; // 0 refers to default sample group
457 schoenebeck 929 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 schoenebeck 930 for (int i = 0; iter != end; i++, iter++) {
462 schoenebeck 929 if (*iter == pGroup) {
463     iSampleGroup = i;
464     break; // found
465     }
466     }
467     }
468 schoenebeck 809 // update '3gix' chunk
469     pData = (uint8_t*) pCk3gix->LoadChunkData();
470 persson 1179 store16(&pData[0], iSampleGroup);
471 schoenebeck 809 }
472    
473 schoenebeck 2 /// Scans compressed samples for mandatory informations (e.g. actual number of total sample points).
474     void Sample::ScanCompressedSample() {
475     //TODO: we have to add some more scans here (e.g. determine compression rate)
476     this->SamplesTotal = 0;
477     std::list<unsigned long> frameOffsets;
478    
479 persson 365 SamplesPerFrame = BitDepth == 24 ? 256 : 2048;
480 schoenebeck 384 WorstCaseFrameSize = SamplesPerFrame * FrameSize + Channels; // +Channels for compression flag
481 persson 365
482 schoenebeck 2 // Scanning
483     pCkData->SetPos(0);
484 persson 365 if (Channels == 2) { // Stereo
485     for (int i = 0 ; ; i++) {
486     // for 24 bit samples every 8:th frame offset is
487     // stored, to save some memory
488     if (BitDepth != 24 || (i & 7) == 0) frameOffsets.push_back(pCkData->GetPos());
489    
490     const int mode_l = pCkData->ReadUint8();
491     const int mode_r = pCkData->ReadUint8();
492     if (mode_l > 5 || mode_r > 5) throw gig::Exception("Unknown compression mode");
493     const unsigned long frameSize = bytesPerFrame[mode_l] + bytesPerFrame[mode_r];
494    
495     if (pCkData->RemainingBytes() <= frameSize) {
496     SamplesInLastFrame =
497     ((pCkData->RemainingBytes() - headerSize[mode_l] - headerSize[mode_r]) << 3) /
498     (bitsPerSample[mode_l] + bitsPerSample[mode_r]);
499     SamplesTotal += SamplesInLastFrame;
500 schoenebeck 2 break;
501 persson 365 }
502     SamplesTotal += SamplesPerFrame;
503     pCkData->SetPos(frameSize, RIFF::stream_curpos);
504     }
505     }
506     else { // Mono
507     for (int i = 0 ; ; i++) {
508     if (BitDepth != 24 || (i & 7) == 0) frameOffsets.push_back(pCkData->GetPos());
509    
510     const int mode = pCkData->ReadUint8();
511     if (mode > 5) throw gig::Exception("Unknown compression mode");
512     const unsigned long frameSize = bytesPerFrame[mode];
513    
514     if (pCkData->RemainingBytes() <= frameSize) {
515     SamplesInLastFrame =
516     ((pCkData->RemainingBytes() - headerSize[mode]) << 3) / bitsPerSample[mode];
517     SamplesTotal += SamplesInLastFrame;
518 schoenebeck 2 break;
519 persson 365 }
520     SamplesTotal += SamplesPerFrame;
521     pCkData->SetPos(frameSize, RIFF::stream_curpos);
522 schoenebeck 2 }
523     }
524     pCkData->SetPos(0);
525    
526     // Build the frames table (which is used for fast resolving of a frame's chunk offset)
527     if (FrameTable) delete[] FrameTable;
528     FrameTable = new unsigned long[frameOffsets.size()];
529     std::list<unsigned long>::iterator end = frameOffsets.end();
530     std::list<unsigned long>::iterator iter = frameOffsets.begin();
531     for (int i = 0; iter != end; i++, iter++) {
532     FrameTable[i] = *iter;
533     }
534     }
535    
536     /**
537     * Loads (and uncompresses if needed) the whole sample wave into RAM. Use
538     * ReleaseSampleData() to free the memory if you don't need the cached
539     * sample data anymore.
540     *
541     * @returns buffer_t structure with start address and size of the buffer
542     * in bytes
543     * @see ReleaseSampleData(), Read(), SetPos()
544     */
545     buffer_t Sample::LoadSampleData() {
546     return LoadSampleDataWithNullSamplesExtension(this->SamplesTotal, 0); // 0 amount of NullSamples
547     }
548    
549     /**
550     * Reads (uncompresses if needed) and caches the first \a SampleCount
551     * numbers of SamplePoints in RAM. Use ReleaseSampleData() to free the
552     * memory space if you don't need the cached samples anymore. There is no
553     * guarantee that exactly \a SampleCount samples will be cached; this is
554     * not an error. The size will be eventually truncated e.g. to the
555     * beginning of a frame of a compressed sample. This is done for
556     * efficiency reasons while streaming the wave by your sampler engine
557     * later. Read the <i>Size</i> member of the <i>buffer_t</i> structure
558     * that will be returned to determine the actual cached samples, but note
559     * that the size is given in bytes! You get the number of actually cached
560     * samples by dividing it by the frame size of the sample:
561 schoenebeck 384 * @code
562 schoenebeck 2 * buffer_t buf = pSample->LoadSampleData(acquired_samples);
563     * long cachedsamples = buf.Size / pSample->FrameSize;
564 schoenebeck 384 * @endcode
565 schoenebeck 2 *
566     * @param SampleCount - number of sample points to load into RAM
567     * @returns buffer_t structure with start address and size of
568     * the cached sample data in bytes
569     * @see ReleaseSampleData(), Read(), SetPos()
570     */
571     buffer_t Sample::LoadSampleData(unsigned long SampleCount) {
572     return LoadSampleDataWithNullSamplesExtension(SampleCount, 0); // 0 amount of NullSamples
573     }
574    
575     /**
576     * Loads (and uncompresses if needed) the whole sample wave into RAM. Use
577     * ReleaseSampleData() to free the memory if you don't need the cached
578     * sample data anymore.
579     * The method will add \a NullSamplesCount silence samples past the
580     * official buffer end (this won't affect the 'Size' member of the
581     * buffer_t structure, that means 'Size' always reflects the size of the
582     * actual sample data, the buffer might be bigger though). Silence
583     * samples past the official buffer are needed for differential
584     * algorithms that always have to take subsequent samples into account
585     * (resampling/interpolation would be an important example) and avoids
586     * memory access faults in such cases.
587     *
588     * @param NullSamplesCount - number of silence samples the buffer should
589     * be extended past it's data end
590     * @returns buffer_t structure with start address and
591     * size of the buffer in bytes
592     * @see ReleaseSampleData(), Read(), SetPos()
593     */
594     buffer_t Sample::LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount) {
595     return LoadSampleDataWithNullSamplesExtension(this->SamplesTotal, NullSamplesCount);
596     }
597    
598     /**
599     * Reads (uncompresses if needed) and caches the first \a SampleCount
600     * numbers of SamplePoints in RAM. Use ReleaseSampleData() to free the
601     * memory space if you don't need the cached samples anymore. There is no
602     * guarantee that exactly \a SampleCount samples will be cached; this is
603     * not an error. The size will be eventually truncated e.g. to the
604     * beginning of a frame of a compressed sample. This is done for
605     * efficiency reasons while streaming the wave by your sampler engine
606     * later. Read the <i>Size</i> member of the <i>buffer_t</i> structure
607     * that will be returned to determine the actual cached samples, but note
608     * that the size is given in bytes! You get the number of actually cached
609     * samples by dividing it by the frame size of the sample:
610 schoenebeck 384 * @code
611 schoenebeck 2 * buffer_t buf = pSample->LoadSampleDataWithNullSamplesExtension(acquired_samples, null_samples);
612     * long cachedsamples = buf.Size / pSample->FrameSize;
613 schoenebeck 384 * @endcode
614 schoenebeck 2 * The method will add \a NullSamplesCount silence samples past the
615     * official buffer end (this won't affect the 'Size' member of the
616     * buffer_t structure, that means 'Size' always reflects the size of the
617     * actual sample data, the buffer might be bigger though). Silence
618     * samples past the official buffer are needed for differential
619     * algorithms that always have to take subsequent samples into account
620     * (resampling/interpolation would be an important example) and avoids
621     * memory access faults in such cases.
622     *
623     * @param SampleCount - number of sample points to load into RAM
624     * @param NullSamplesCount - number of silence samples the buffer should
625     * be extended past it's data end
626     * @returns buffer_t structure with start address and
627     * size of the cached sample data in bytes
628     * @see ReleaseSampleData(), Read(), SetPos()
629     */
630     buffer_t Sample::LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount) {
631     if (SampleCount > this->SamplesTotal) SampleCount = this->SamplesTotal;
632     if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
633     unsigned long allocationsize = (SampleCount + NullSamplesCount) * this->FrameSize;
634     RAMCache.pStart = new int8_t[allocationsize];
635     RAMCache.Size = Read(RAMCache.pStart, SampleCount) * this->FrameSize;
636     RAMCache.NullExtensionSize = allocationsize - RAMCache.Size;
637     // fill the remaining buffer space with silence samples
638     memset((int8_t*)RAMCache.pStart + RAMCache.Size, 0, RAMCache.NullExtensionSize);
639     return GetCache();
640     }
641    
642     /**
643     * Returns current cached sample points. A buffer_t structure will be
644     * returned which contains address pointer to the begin of the cache and
645     * the size of the cached sample data in bytes. Use
646     * <i>LoadSampleData()</i> to cache a specific amount of sample points in
647     * RAM.
648     *
649     * @returns buffer_t structure with current cached sample points
650     * @see LoadSampleData();
651     */
652     buffer_t Sample::GetCache() {
653     // return a copy of the buffer_t structure
654     buffer_t result;
655     result.Size = this->RAMCache.Size;
656     result.pStart = this->RAMCache.pStart;
657     result.NullExtensionSize = this->RAMCache.NullExtensionSize;
658     return result;
659     }
660    
661     /**
662     * Frees the cached sample from RAM if loaded with
663     * <i>LoadSampleData()</i> previously.
664     *
665     * @see LoadSampleData();
666     */
667     void Sample::ReleaseSampleData() {
668     if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
669     RAMCache.pStart = NULL;
670     RAMCache.Size = 0;
671     }
672    
673 schoenebeck 809 /** @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 schoenebeck 1050 * 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 schoenebeck 809 * other formats will fail!
694     *
695     * @param iNewSize - new sample wave data size in sample points (must be
696     * greater than zero)
697 schoenebeck 1050 * @throws DLS::Excecption if FormatTag != DLS_WAVE_FORMAT_PCM
698 schoenebeck 809 * 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 schoenebeck 2 /**
709     * 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
711     * the sample into RAM, thus for disk streaming.
712     *
713     * Although the original Gigasampler engine doesn't allow positioning
714     * within compressed samples, I decided to implement it. Even though
715     * the Gigasampler format doesn't allow to define loops for compressed
716     * samples at the moment, positioning within compressed samples might be
717     * interesting for some sampler engines though. The only drawback about
718     * my decision is that it takes longer to load compressed gig Files on
719     * startup, because it's neccessary to scan the samples for some
720     * mandatory informations. But I think as it doesn't affect the runtime
721     * efficiency, nobody will have a problem with that.
722     *
723     * @param SampleCount number of sample points to jump
724     * @param Whence optional: to which relation \a SampleCount refers
725     * to, if omited <i>RIFF::stream_start</i> is assumed
726     * @returns the new sample position
727     * @see Read()
728     */
729     unsigned long Sample::SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence) {
730     if (Compressed) {
731     switch (Whence) {
732     case RIFF::stream_curpos:
733     this->SamplePos += SampleCount;
734     break;
735     case RIFF::stream_end:
736     this->SamplePos = this->SamplesTotal - 1 - SampleCount;
737     break;
738     case RIFF::stream_backward:
739     this->SamplePos -= SampleCount;
740     break;
741     case RIFF::stream_start: default:
742     this->SamplePos = SampleCount;
743     break;
744     }
745     if (this->SamplePos > this->SamplesTotal) this->SamplePos = this->SamplesTotal;
746    
747     unsigned long frame = this->SamplePos / 2048; // to which frame to jump
748     this->FrameOffset = this->SamplePos % 2048; // offset (in sample points) within that frame
749     pCkData->SetPos(FrameTable[frame]); // set chunk pointer to the start of sought frame
750     return this->SamplePos;
751     }
752     else { // not compressed
753     unsigned long orderedBytes = SampleCount * this->FrameSize;
754     unsigned long result = pCkData->SetPos(orderedBytes, Whence);
755     return (result == orderedBytes) ? SampleCount
756     : result / this->FrameSize;
757     }
758     }
759    
760     /**
761     * Returns the current position in the sample (in sample points).
762     */
763     unsigned long Sample::GetPos() {
764     if (Compressed) return SamplePos;
765     else return pCkData->GetPos() / FrameSize;
766     }
767    
768     /**
769 schoenebeck 24 * Reads \a SampleCount number of sample points from the position stored
770     * in \a pPlaybackState into the buffer pointed by \a pBuffer and moves
771     * the position within the sample respectively, this method honors the
772     * looping informations of the sample (if any). The sample wave stream
773     * will be decompressed on the fly if using a compressed sample. Use this
774     * method if you don't want to load the sample into RAM, thus for disk
775     * streaming. All this methods needs to know to proceed with streaming
776     * for the next time you call this method is stored in \a pPlaybackState.
777     * You have to allocate and initialize the playback_state_t structure by
778     * yourself before you use it to stream a sample:
779 schoenebeck 384 * @code
780     * gig::playback_state_t playbackstate;
781     * playbackstate.position = 0;
782     * playbackstate.reverse = false;
783     * playbackstate.loop_cycles_left = pSample->LoopPlayCount;
784     * @endcode
785 schoenebeck 24 * You don't have to take care of things like if there is actually a loop
786     * defined or if the current read position is located within a loop area.
787     * The method already handles such cases by itself.
788     *
789 schoenebeck 384 * <b>Caution:</b> If you are using more than one streaming thread, you
790     * have to use an external decompression buffer for <b>EACH</b>
791     * streaming thread to avoid race conditions and crashes!
792     *
793 schoenebeck 24 * @param pBuffer destination buffer
794     * @param SampleCount number of sample points to read
795     * @param pPlaybackState will be used to store and reload the playback
796     * state for the next ReadAndLoop() call
797 persson 864 * @param pDimRgn dimension region with looping information
798 schoenebeck 384 * @param pExternalDecompressionBuffer (optional) external buffer to use for decompression
799 schoenebeck 24 * @returns number of successfully read sample points
800 schoenebeck 384 * @see CreateDecompressionBuffer()
801 schoenebeck 24 */
802 persson 864 unsigned long Sample::ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState,
803     DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer) {
804 schoenebeck 24 unsigned long samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;
805     uint8_t* pDst = (uint8_t*) pBuffer;
806    
807     SetPos(pPlaybackState->position); // recover position from the last time
808    
809 persson 864 if (pDimRgn->SampleLoops) { // honor looping if there are loop points defined
810 schoenebeck 24
811 persson 864 const DLS::sample_loop_t& loop = pDimRgn->pSampleLoops[0];
812     const uint32_t loopEnd = loop.LoopStart + loop.LoopLength;
813 schoenebeck 24
814 persson 864 if (GetPos() <= loopEnd) {
815     switch (loop.LoopType) {
816 schoenebeck 24
817 persson 864 case loop_type_bidirectional: { //TODO: not tested yet!
818     do {
819     // if not endless loop check if max. number of loop cycles have been passed
820     if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
821 schoenebeck 24
822 persson 864 if (!pPlaybackState->reverse) { // forward playback
823     do {
824     samplestoloopend = loopEnd - GetPos();
825     readsamples = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
826     samplestoread -= readsamples;
827     totalreadsamples += readsamples;
828     if (readsamples == samplestoloopend) {
829     pPlaybackState->reverse = true;
830     break;
831     }
832     } while (samplestoread && readsamples);
833     }
834     else { // backward playback
835 schoenebeck 24
836 persson 864 // 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 schoenebeck 24
842 persson 864 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 schoenebeck 24
847 persson 864 SetPos(reverseplaybackend);
848 schoenebeck 24
849 persson 864 // 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 schoenebeck 24
857 persson 864 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     // reverse the sample frames for backward playback
865     SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
866 schoenebeck 24 }
867 persson 864 } while (samplestoread && readsamples);
868     break;
869     }
870 schoenebeck 24
871 persson 864 case loop_type_backward: { // TODO: not tested yet!
872     // forward playback (not entered the loop yet)
873     if (!pPlaybackState->reverse) do {
874     samplestoloopend = loopEnd - GetPos();
875     readsamples = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
876     samplestoread -= readsamples;
877     totalreadsamples += readsamples;
878     if (readsamples == samplestoloopend) {
879     pPlaybackState->reverse = true;
880     break;
881     }
882     } while (samplestoread && readsamples);
883 schoenebeck 24
884 persson 864 if (!samplestoread) break;
885 schoenebeck 24
886 persson 864 // as we can only read forward from disk, we have to
887     // determine the end position within the loop first,
888     // read forward from that 'end' and finally after
889     // reading, swap all sample frames so it reflects
890     // backward playback
891 schoenebeck 24
892 persson 864 unsigned long swapareastart = totalreadsamples;
893     unsigned long loopoffset = GetPos() - loop.LoopStart;
894     unsigned long samplestoreadinloop = (this->LoopPlayCount) ? Min(samplestoread, pPlaybackState->loop_cycles_left * loop.LoopLength - loopoffset)
895     : samplestoread;
896     unsigned long reverseplaybackend = loop.LoopStart + Abs((loopoffset - samplestoreadinloop) % loop.LoopLength);
897 schoenebeck 24
898 persson 864 SetPos(reverseplaybackend);
899 schoenebeck 24
900 persson 864 // read samples for backward playback
901     do {
902     // if not endless loop check if max. number of loop cycles have been passed
903     if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
904     samplestoloopend = loopEnd - GetPos();
905     readsamples = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoreadinloop, samplestoloopend), pExternalDecompressionBuffer);
906     samplestoreadinloop -= readsamples;
907     samplestoread -= readsamples;
908     totalreadsamples += readsamples;
909     if (readsamples == samplestoloopend) {
910     pPlaybackState->loop_cycles_left--;
911     SetPos(loop.LoopStart);
912     }
913     } while (samplestoreadinloop && readsamples);
914 schoenebeck 24
915 persson 864 SetPos(reverseplaybackend); // pretend we really read backwards
916 schoenebeck 24
917 persson 864 // reverse the sample frames for backward playback
918     SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
919     break;
920     }
921 schoenebeck 24
922 persson 864 default: case loop_type_normal: {
923     do {
924     // if not endless loop check if max. number of loop cycles have been passed
925     if (this->LoopPlayCount && !pPlaybackState->loop_cycles_left) break;
926     samplestoloopend = loopEnd - GetPos();
927     readsamples = Read(&pDst[totalreadsamples * this->FrameSize], Min(samplestoread, samplestoloopend), pExternalDecompressionBuffer);
928     samplestoread -= readsamples;
929     totalreadsamples += readsamples;
930     if (readsamples == samplestoloopend) {
931     pPlaybackState->loop_cycles_left--;
932     SetPos(loop.LoopStart);
933     }
934     } while (samplestoread && readsamples);
935     break;
936     }
937 schoenebeck 24 }
938     }
939     }
940    
941     // read on without looping
942     if (samplestoread) do {
943 schoenebeck 384 readsamples = Read(&pDst[totalreadsamples * this->FrameSize], samplestoread, pExternalDecompressionBuffer);
944 schoenebeck 24 samplestoread -= readsamples;
945     totalreadsamples += readsamples;
946     } while (readsamples && samplestoread);
947    
948     // store current position
949     pPlaybackState->position = GetPos();
950    
951     return totalreadsamples;
952     }
953    
954     /**
955 schoenebeck 2 * Reads \a SampleCount number of sample points from the current
956     * position into the buffer pointed by \a pBuffer and increments the
957     * position within the sample. The sample wave stream will be
958     * decompressed on the fly if using a compressed sample. Use this method
959     * and <i>SetPos()</i> if you don't want to load the sample into RAM,
960     * thus for disk streaming.
961     *
962 schoenebeck 384 * <b>Caution:</b> If you are using more than one streaming thread, you
963     * have to use an external decompression buffer for <b>EACH</b>
964     * streaming thread to avoid race conditions and crashes!
965     *
966 persson 902 * 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 schoenebeck 2 * @param pBuffer destination buffer
971     * @param SampleCount number of sample points to read
972 schoenebeck 384 * @param pExternalDecompressionBuffer (optional) external buffer to use for decompression
973 schoenebeck 2 * @returns number of successfully read sample points
974 schoenebeck 384 * @see SetPos(), CreateDecompressionBuffer()
975 schoenebeck 2 */
976 schoenebeck 384 unsigned long Sample::Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer) {
977 schoenebeck 21 if (SampleCount == 0) return 0;
978 schoenebeck 317 if (!Compressed) {
979     if (BitDepth == 24) {
980 persson 902 return pCkData->Read(pBuffer, SampleCount * FrameSize, 1) / FrameSize;
981 schoenebeck 317 }
982 persson 365 else { // 16 bit
983     // (pCkData->Read does endian correction)
984     return Channels == 2 ? pCkData->Read(pBuffer, SampleCount << 1, 2) >> 1
985     : pCkData->Read(pBuffer, SampleCount, 2);
986     }
987 schoenebeck 317 }
988 persson 365 else {
989 schoenebeck 11 if (this->SamplePos >= this->SamplesTotal) return 0;
990 persson 365 //TODO: efficiency: maybe we should test for an average compression rate
991     unsigned long assumedsize = GuessSize(SampleCount),
992 schoenebeck 2 remainingbytes = 0, // remaining bytes in the local buffer
993     remainingsamples = SampleCount,
994 persson 365 copysamples, skipsamples,
995     currentframeoffset = this->FrameOffset; // offset in current sample frame since last Read()
996 schoenebeck 2 this->FrameOffset = 0;
997    
998 schoenebeck 384 buffer_t* pDecompressionBuffer = (pExternalDecompressionBuffer) ? pExternalDecompressionBuffer : &InternalDecompressionBuffer;
999    
1000     // if decompression buffer too small, then reduce amount of samples to read
1001     if (pDecompressionBuffer->Size < assumedsize) {
1002     std::cerr << "gig::Read(): WARNING - decompression buffer size too small!" << std::endl;
1003     SampleCount = WorstCaseMaxSamples(pDecompressionBuffer);
1004     remainingsamples = SampleCount;
1005     assumedsize = GuessSize(SampleCount);
1006 schoenebeck 2 }
1007    
1008 schoenebeck 384 unsigned char* pSrc = (unsigned char*) pDecompressionBuffer->pStart;
1009 persson 365 int16_t* pDst = static_cast<int16_t*>(pBuffer);
1010 persson 902 uint8_t* pDst24 = static_cast<uint8_t*>(pBuffer);
1011 schoenebeck 2 remainingbytes = pCkData->Read(pSrc, assumedsize, 1);
1012    
1013 persson 365 while (remainingsamples && remainingbytes) {
1014     unsigned long framesamples = SamplesPerFrame;
1015     unsigned long framebytes, rightChannelOffset = 0, nextFrameOffset;
1016 schoenebeck 2
1017 persson 365 int mode_l = *pSrc++, mode_r = 0;
1018    
1019     if (Channels == 2) {
1020     mode_r = *pSrc++;
1021     framebytes = bytesPerFrame[mode_l] + bytesPerFrame[mode_r] + 2;
1022     rightChannelOffset = bytesPerFrameNoHdr[mode_l];
1023     nextFrameOffset = rightChannelOffset + bytesPerFrameNoHdr[mode_r];
1024     if (remainingbytes < framebytes) { // last frame in sample
1025     framesamples = SamplesInLastFrame;
1026     if (mode_l == 4 && (framesamples & 1)) {
1027     rightChannelOffset = ((framesamples + 1) * bitsPerSample[mode_l]) >> 3;
1028     }
1029     else {
1030     rightChannelOffset = (framesamples * bitsPerSample[mode_l]) >> 3;
1031     }
1032 schoenebeck 2 }
1033     }
1034 persson 365 else {
1035     framebytes = bytesPerFrame[mode_l] + 1;
1036     nextFrameOffset = bytesPerFrameNoHdr[mode_l];
1037     if (remainingbytes < framebytes) {
1038     framesamples = SamplesInLastFrame;
1039     }
1040     }
1041 schoenebeck 2
1042     // determine how many samples in this frame to skip and read
1043 persson 365 if (currentframeoffset + remainingsamples >= framesamples) {
1044     if (currentframeoffset <= framesamples) {
1045     copysamples = framesamples - currentframeoffset;
1046     skipsamples = currentframeoffset;
1047     }
1048     else {
1049     copysamples = 0;
1050     skipsamples = framesamples;
1051     }
1052 schoenebeck 2 }
1053     else {
1054 persson 365 // This frame has enough data for pBuffer, but not
1055     // all of the frame is needed. Set file position
1056     // to start of this frame for next call to Read.
1057 schoenebeck 2 copysamples = remainingsamples;
1058 persson 365 skipsamples = currentframeoffset;
1059     pCkData->SetPos(remainingbytes, RIFF::stream_backward);
1060     this->FrameOffset = currentframeoffset + copysamples;
1061     }
1062     remainingsamples -= copysamples;
1063    
1064     if (remainingbytes > framebytes) {
1065     remainingbytes -= framebytes;
1066     if (remainingsamples == 0 &&
1067     currentframeoffset + copysamples == framesamples) {
1068     // This frame has enough data for pBuffer, and
1069     // all of the frame is needed. Set file
1070     // position to start of next frame for next
1071     // call to Read. FrameOffset is 0.
1072 schoenebeck 2 pCkData->SetPos(remainingbytes, RIFF::stream_backward);
1073     }
1074     }
1075 persson 365 else remainingbytes = 0;
1076 schoenebeck 2
1077 persson 365 currentframeoffset -= skipsamples;
1078 schoenebeck 2
1079 persson 365 if (copysamples == 0) {
1080     // skip this frame
1081     pSrc += framebytes - Channels;
1082     }
1083     else {
1084     const unsigned char* const param_l = pSrc;
1085     if (BitDepth == 24) {
1086     if (mode_l != 2) pSrc += 12;
1087 schoenebeck 2
1088 persson 365 if (Channels == 2) { // Stereo
1089     const unsigned char* const param_r = pSrc;
1090     if (mode_r != 2) pSrc += 12;
1091    
1092 persson 902 Decompress24(mode_l, param_l, 6, pSrc, pDst24,
1093 persson 437 skipsamples, copysamples, TruncatedBits);
1094 persson 902 Decompress24(mode_r, param_r, 6, pSrc + rightChannelOffset, pDst24 + 3,
1095 persson 437 skipsamples, copysamples, TruncatedBits);
1096 persson 902 pDst24 += copysamples * 6;
1097 schoenebeck 2 }
1098 persson 365 else { // Mono
1099 persson 902 Decompress24(mode_l, param_l, 3, pSrc, pDst24,
1100 persson 437 skipsamples, copysamples, TruncatedBits);
1101 persson 902 pDst24 += copysamples * 3;
1102 schoenebeck 2 }
1103 persson 365 }
1104     else { // 16 bit
1105     if (mode_l) pSrc += 4;
1106 schoenebeck 2
1107 persson 365 int step;
1108     if (Channels == 2) { // Stereo
1109     const unsigned char* const param_r = pSrc;
1110     if (mode_r) pSrc += 4;
1111    
1112     step = (2 - mode_l) + (2 - mode_r);
1113 persson 372 Decompress16(mode_l, param_l, step, 2, pSrc, pDst, skipsamples, copysamples);
1114     Decompress16(mode_r, param_r, step, 2, pSrc + (2 - mode_l), pDst + 1,
1115 persson 365 skipsamples, copysamples);
1116     pDst += copysamples << 1;
1117 schoenebeck 2 }
1118 persson 365 else { // Mono
1119     step = 2 - mode_l;
1120 persson 372 Decompress16(mode_l, param_l, step, 1, pSrc, pDst, skipsamples, copysamples);
1121 persson 365 pDst += copysamples;
1122 schoenebeck 2 }
1123 persson 365 }
1124     pSrc += nextFrameOffset;
1125     }
1126 schoenebeck 2
1127 persson 365 // reload from disk to local buffer if needed
1128     if (remainingsamples && remainingbytes < WorstCaseFrameSize && pCkData->GetState() == RIFF::stream_ready) {
1129     assumedsize = GuessSize(remainingsamples);
1130     pCkData->SetPos(remainingbytes, RIFF::stream_backward);
1131     if (pCkData->RemainingBytes() < assumedsize) assumedsize = pCkData->RemainingBytes();
1132 schoenebeck 384 remainingbytes = pCkData->Read(pDecompressionBuffer->pStart, assumedsize, 1);
1133     pSrc = (unsigned char*) pDecompressionBuffer->pStart;
1134 schoenebeck 2 }
1135 persson 365 } // while
1136    
1137 schoenebeck 2 this->SamplePos += (SampleCount - remainingsamples);
1138 schoenebeck 11 if (this->SamplePos > this->SamplesTotal) this->SamplePos = this->SamplesTotal;
1139 schoenebeck 2 return (SampleCount - remainingsamples);
1140     }
1141     }
1142    
1143 schoenebeck 809 /** @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 persson 1264 * 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 schoenebeck 809 * @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 persson 1207
1168     // if this is the first write in this sample, reset the
1169     // checksum calculator
1170 persson 1199 if (pCkData->GetPos() == 0) {
1171     crc.reset();
1172     }
1173 persson 1264 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 persson 1199 crc.update((unsigned char *)pBuffer, SampleCount * FrameSize);
1182    
1183 persson 1207 // if this is the last write, update the checksum chunk in the
1184     // file
1185 persson 1199 if (pCkData->GetPos() == pCkData->GetSize()) {
1186     File* pFile = static_cast<File*>(GetParent());
1187     pFile->SetSampleChecksum(this, crc.getValue());
1188     }
1189     return res;
1190 schoenebeck 809 }
1191    
1192 schoenebeck 384 /**
1193     * Allocates a decompression buffer for streaming (compressed) samples
1194     * with Sample::Read(). If you are using more than one streaming thread
1195     * in your application you <b>HAVE</b> to create a decompression buffer
1196     * for <b>EACH</b> of your streaming threads and provide it with the
1197     * Sample::Read() call in order to avoid race conditions and crashes.
1198     *
1199     * You should free the memory occupied by the allocated buffer(s) once
1200     * you don't need one of your streaming threads anymore by calling
1201     * DestroyDecompressionBuffer().
1202     *
1203     * @param MaxReadSize - the maximum size (in sample points) you ever
1204     * expect to read with one Read() call
1205     * @returns allocated decompression buffer
1206     * @see DestroyDecompressionBuffer()
1207     */
1208     buffer_t Sample::CreateDecompressionBuffer(unsigned long MaxReadSize) {
1209     buffer_t result;
1210     const double worstCaseHeaderOverhead =
1211     (256.0 /*frame size*/ + 12.0 /*header*/ + 2.0 /*compression type flag (stereo)*/) / 256.0;
1212     result.Size = (unsigned long) (double(MaxReadSize) * 3.0 /*(24 Bit)*/ * 2.0 /*stereo*/ * worstCaseHeaderOverhead);
1213     result.pStart = new int8_t[result.Size];
1214     result.NullExtensionSize = 0;
1215     return result;
1216     }
1217    
1218     /**
1219     * Free decompression buffer, previously created with
1220     * CreateDecompressionBuffer().
1221     *
1222     * @param DecompressionBuffer - previously allocated decompression
1223     * buffer to free
1224     */
1225     void Sample::DestroyDecompressionBuffer(buffer_t& DecompressionBuffer) {
1226     if (DecompressionBuffer.Size && DecompressionBuffer.pStart) {
1227     delete[] (int8_t*) DecompressionBuffer.pStart;
1228     DecompressionBuffer.pStart = NULL;
1229     DecompressionBuffer.Size = 0;
1230     DecompressionBuffer.NullExtensionSize = 0;
1231     }
1232     }
1233    
1234 schoenebeck 930 /**
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 schoenebeck 2 Sample::~Sample() {
1247     Instances--;
1248 schoenebeck 384 if (!Instances && InternalDecompressionBuffer.Size) {
1249     delete[] (unsigned char*) InternalDecompressionBuffer.pStart;
1250     InternalDecompressionBuffer.pStart = NULL;
1251     InternalDecompressionBuffer.Size = 0;
1252 schoenebeck 355 }
1253 schoenebeck 2 if (FrameTable) delete[] FrameTable;
1254     if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
1255     }
1256    
1257    
1258    
1259     // *************** DimensionRegion ***************
1260     // *
1261    
1262 schoenebeck 16 uint DimensionRegion::Instances = 0;
1263     DimensionRegion::VelocityTableMap* DimensionRegion::pVelocityTables = NULL;
1264    
1265 schoenebeck 1316 DimensionRegion::DimensionRegion(Region* pParent, RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {
1266 schoenebeck 16 Instances++;
1267    
1268 schoenebeck 823 pSample = NULL;
1269 schoenebeck 1316 pRegion = pParent;
1270 schoenebeck 823
1271 persson 1247 if (_3ewl->GetSubChunk(CHUNK_ID_WSMP)) memcpy(&Crossfade, &SamplerOptions, 4);
1272     else memset(&Crossfade, 0, 4);
1273    
1274 schoenebeck 16 if (!pVelocityTables) pVelocityTables = new VelocityTableMap;
1275 schoenebeck 2
1276     RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);
1277 schoenebeck 809 if (_3ewa) { // if '3ewa' chunk exists
1278 persson 918 _3ewa->ReadInt32(); // unknown, always == chunk size ?
1279 schoenebeck 809 LFO3Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1280     EG3Attack = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1281     _3ewa->ReadInt16(); // unknown
1282     LFO1InternalDepth = _3ewa->ReadUint16();
1283     _3ewa->ReadInt16(); // unknown
1284     LFO3InternalDepth = _3ewa->ReadInt16();
1285     _3ewa->ReadInt16(); // unknown
1286     LFO1ControlDepth = _3ewa->ReadUint16();
1287     _3ewa->ReadInt16(); // unknown
1288     LFO3ControlDepth = _3ewa->ReadInt16();
1289     EG1Attack = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1290     EG1Decay1 = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1291     _3ewa->ReadInt16(); // unknown
1292     EG1Sustain = _3ewa->ReadUint16();
1293     EG1Release = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1294     EG1Controller = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1295     uint8_t eg1ctrloptions = _3ewa->ReadUint8();
1296     EG1ControllerInvert = eg1ctrloptions & 0x01;
1297     EG1ControllerAttackInfluence = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg1ctrloptions);
1298     EG1ControllerDecayInfluence = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg1ctrloptions);
1299     EG1ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg1ctrloptions);
1300     EG2Controller = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1301     uint8_t eg2ctrloptions = _3ewa->ReadUint8();
1302     EG2ControllerInvert = eg2ctrloptions & 0x01;
1303     EG2ControllerAttackInfluence = GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(eg2ctrloptions);
1304     EG2ControllerDecayInfluence = GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(eg2ctrloptions);
1305     EG2ControllerReleaseInfluence = GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(eg2ctrloptions);
1306     LFO1Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1307     EG2Attack = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1308     EG2Decay1 = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1309     _3ewa->ReadInt16(); // unknown
1310     EG2Sustain = _3ewa->ReadUint16();
1311     EG2Release = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1312     _3ewa->ReadInt16(); // unknown
1313     LFO2ControlDepth = _3ewa->ReadUint16();
1314     LFO2Frequency = (double) GIG_EXP_DECODE(_3ewa->ReadInt32());
1315     _3ewa->ReadInt16(); // unknown
1316     LFO2InternalDepth = _3ewa->ReadUint16();
1317     int32_t eg1decay2 = _3ewa->ReadInt32();
1318     EG1Decay2 = (double) GIG_EXP_DECODE(eg1decay2);
1319     EG1InfiniteSustain = (eg1decay2 == 0x7fffffff);
1320     _3ewa->ReadInt16(); // unknown
1321     EG1PreAttack = _3ewa->ReadUint16();
1322     int32_t eg2decay2 = _3ewa->ReadInt32();
1323     EG2Decay2 = (double) GIG_EXP_DECODE(eg2decay2);
1324     EG2InfiniteSustain = (eg2decay2 == 0x7fffffff);
1325     _3ewa->ReadInt16(); // unknown
1326     EG2PreAttack = _3ewa->ReadUint16();
1327     uint8_t velocityresponse = _3ewa->ReadUint8();
1328     if (velocityresponse < 5) {
1329     VelocityResponseCurve = curve_type_nonlinear;
1330     VelocityResponseDepth = velocityresponse;
1331     } else if (velocityresponse < 10) {
1332     VelocityResponseCurve = curve_type_linear;
1333     VelocityResponseDepth = velocityresponse - 5;
1334     } else if (velocityresponse < 15) {
1335     VelocityResponseCurve = curve_type_special;
1336     VelocityResponseDepth = velocityresponse - 10;
1337     } else {
1338     VelocityResponseCurve = curve_type_unknown;
1339     VelocityResponseDepth = 0;
1340     }
1341     uint8_t releasevelocityresponse = _3ewa->ReadUint8();
1342     if (releasevelocityresponse < 5) {
1343     ReleaseVelocityResponseCurve = curve_type_nonlinear;
1344     ReleaseVelocityResponseDepth = releasevelocityresponse;
1345     } else if (releasevelocityresponse < 10) {
1346     ReleaseVelocityResponseCurve = curve_type_linear;
1347     ReleaseVelocityResponseDepth = releasevelocityresponse - 5;
1348     } else if (releasevelocityresponse < 15) {
1349     ReleaseVelocityResponseCurve = curve_type_special;
1350     ReleaseVelocityResponseDepth = releasevelocityresponse - 10;
1351     } else {
1352     ReleaseVelocityResponseCurve = curve_type_unknown;
1353     ReleaseVelocityResponseDepth = 0;
1354     }
1355     VelocityResponseCurveScaling = _3ewa->ReadUint8();
1356     AttenuationControllerThreshold = _3ewa->ReadInt8();
1357     _3ewa->ReadInt32(); // unknown
1358     SampleStartOffset = (uint16_t) _3ewa->ReadInt16();
1359     _3ewa->ReadInt16(); // unknown
1360     uint8_t pitchTrackDimensionBypass = _3ewa->ReadInt8();
1361     PitchTrack = GIG_PITCH_TRACK_EXTRACT(pitchTrackDimensionBypass);
1362     if (pitchTrackDimensionBypass & 0x10) DimensionBypass = dim_bypass_ctrl_94;
1363     else if (pitchTrackDimensionBypass & 0x20) DimensionBypass = dim_bypass_ctrl_95;
1364     else DimensionBypass = dim_bypass_ctrl_none;
1365     uint8_t pan = _3ewa->ReadUint8();
1366     Pan = (pan < 64) ? pan : -((int)pan - 63); // signed 7 bit -> signed 8 bit
1367     SelfMask = _3ewa->ReadInt8() & 0x01;
1368     _3ewa->ReadInt8(); // unknown
1369     uint8_t lfo3ctrl = _3ewa->ReadUint8();
1370     LFO3Controller = static_cast<lfo3_ctrl_t>(lfo3ctrl & 0x07); // lower 3 bits
1371     LFO3Sync = lfo3ctrl & 0x20; // bit 5
1372     InvertAttenuationController = lfo3ctrl & 0x80; // bit 7
1373     AttenuationController = DecodeLeverageController(static_cast<_lev_ctrl_t>(_3ewa->ReadUint8()));
1374     uint8_t lfo2ctrl = _3ewa->ReadUint8();
1375     LFO2Controller = static_cast<lfo2_ctrl_t>(lfo2ctrl & 0x07); // lower 3 bits
1376     LFO2FlipPhase = lfo2ctrl & 0x80; // bit 7
1377     LFO2Sync = lfo2ctrl & 0x20; // bit 5
1378     bool extResonanceCtrl = lfo2ctrl & 0x40; // bit 6
1379     uint8_t lfo1ctrl = _3ewa->ReadUint8();
1380     LFO1Controller = static_cast<lfo1_ctrl_t>(lfo1ctrl & 0x07); // lower 3 bits
1381     LFO1FlipPhase = lfo1ctrl & 0x80; // bit 7
1382     LFO1Sync = lfo1ctrl & 0x40; // bit 6
1383     VCFResonanceController = (extResonanceCtrl) ? static_cast<vcf_res_ctrl_t>(GIG_VCF_RESONANCE_CTRL_EXTRACT(lfo1ctrl))
1384     : vcf_res_ctrl_none;
1385     uint16_t eg3depth = _3ewa->ReadUint16();
1386     EG3Depth = (eg3depth <= 1200) ? eg3depth /* positives */
1387     : (-1) * (int16_t) ((eg3depth ^ 0xffff) + 1); /* binary complementary for negatives */
1388     _3ewa->ReadInt16(); // unknown
1389     ChannelOffset = _3ewa->ReadUint8() / 4;
1390     uint8_t regoptions = _3ewa->ReadUint8();
1391     MSDecode = regoptions & 0x01; // bit 0
1392     SustainDefeat = regoptions & 0x02; // bit 1
1393     _3ewa->ReadInt16(); // unknown
1394     VelocityUpperLimit = _3ewa->ReadInt8();
1395     _3ewa->ReadInt8(); // unknown
1396     _3ewa->ReadInt16(); // unknown
1397     ReleaseTriggerDecay = _3ewa->ReadUint8(); // release trigger decay
1398     _3ewa->ReadInt8(); // unknown
1399     _3ewa->ReadInt8(); // unknown
1400     EG1Hold = _3ewa->ReadUint8() & 0x80; // bit 7
1401     uint8_t vcfcutoff = _3ewa->ReadUint8();
1402     VCFEnabled = vcfcutoff & 0x80; // bit 7
1403     VCFCutoff = vcfcutoff & 0x7f; // lower 7 bits
1404     VCFCutoffController = static_cast<vcf_cutoff_ctrl_t>(_3ewa->ReadUint8());
1405     uint8_t vcfvelscale = _3ewa->ReadUint8();
1406     VCFCutoffControllerInvert = vcfvelscale & 0x80; // bit 7
1407     VCFVelocityScale = vcfvelscale & 0x7f; // lower 7 bits
1408     _3ewa->ReadInt8(); // unknown
1409     uint8_t vcfresonance = _3ewa->ReadUint8();
1410     VCFResonance = vcfresonance & 0x7f; // lower 7 bits
1411     VCFResonanceDynamic = !(vcfresonance & 0x80); // bit 7
1412     uint8_t vcfbreakpoint = _3ewa->ReadUint8();
1413     VCFKeyboardTracking = vcfbreakpoint & 0x80; // bit 7
1414     VCFKeyboardTrackingBreakpoint = vcfbreakpoint & 0x7f; // lower 7 bits
1415     uint8_t vcfvelocity = _3ewa->ReadUint8();
1416     VCFVelocityDynamicRange = vcfvelocity % 5;
1417     VCFVelocityCurve = static_cast<curve_type_t>(vcfvelocity / 5);
1418     VCFType = static_cast<vcf_type_t>(_3ewa->ReadUint8());
1419     if (VCFType == vcf_type_lowpass) {
1420     if (lfo3ctrl & 0x40) // bit 6
1421     VCFType = vcf_type_lowpassturbo;
1422     }
1423 persson 1070 if (_3ewa->RemainingBytes() >= 8) {
1424     _3ewa->Read(DimensionUpperLimits, 1, 8);
1425     } else {
1426     memset(DimensionUpperLimits, 0, 8);
1427     }
1428 schoenebeck 809 } 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 persson 1218 EG1Decay1 = 0.005;
1438     EG1Sustain = 1000;
1439     EG1Release = 0.3;
1440 schoenebeck 809 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 persson 1218 EG2Decay1 = 0.005;
1455     EG2Sustain = 1000;
1456     EG2Release = 0.3;
1457 schoenebeck 809 LFO2ControlDepth = 0;
1458     LFO2Frequency = 1.0;
1459     LFO2InternalDepth = 0;
1460     EG1Decay2 = 0.0;
1461 persson 1218 EG1InfiniteSustain = true;
1462     EG1PreAttack = 0;
1463 schoenebeck 809 EG2Decay2 = 0.0;
1464 persson 1218 EG2InfiniteSustain = true;
1465     EG2PreAttack = 0;
1466 schoenebeck 809 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 persson 1247 memset(DimensionUpperLimits, 127, 8);
1509 schoenebeck 2 }
1510 schoenebeck 16
1511 persson 613 pVelocityAttenuationTable = GetVelocityTable(VelocityResponseCurve,
1512     VelocityResponseDepth,
1513     VelocityResponseCurveScaling);
1514    
1515     curve_type_t curveType = ReleaseVelocityResponseCurve;
1516     uint8_t depth = ReleaseVelocityResponseDepth;
1517    
1518     // this models a strange behaviour or bug in GSt: two of the
1519     // velocity response curves for release time are not used even
1520     // if specified, instead another curve is chosen.
1521     if ((curveType == curve_type_nonlinear && depth == 0) ||
1522     (curveType == curve_type_special && depth == 4)) {
1523     curveType = curve_type_nonlinear;
1524     depth = 3;
1525     }
1526     pVelocityReleaseTable = GetVelocityTable(curveType, depth, 0);
1527    
1528 persson 728 curveType = VCFVelocityCurve;
1529     depth = VCFVelocityDynamicRange;
1530    
1531     // even stranger GSt: two of the velocity response curves for
1532     // filter cutoff are not used, instead another special curve
1533     // is chosen. This curve is not used anywhere else.
1534     if ((curveType == curve_type_nonlinear && depth == 0) ||
1535     (curveType == curve_type_special && depth == 4)) {
1536     curveType = curve_type_special;
1537     depth = 5;
1538     }
1539     pVelocityCutoffTable = GetVelocityTable(curveType, depth,
1540 persson 773 VCFCutoffController <= vcf_cutoff_ctrl_none2 ? VCFVelocityScale : 0);
1541 persson 728
1542 persson 613 SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));
1543 persson 858 VelocityTable = 0;
1544 persson 613 }
1545    
1546 persson 1301 /*
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 schoenebeck 809 /**
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 persson 1264 // check if wsmp is going to be created by
1577     // DLS::Sampler::UpdateChunks
1578     bool wsmp_created = !pParentList->GetSubChunk(CHUNK_ID_WSMP);
1579    
1580 schoenebeck 809 // first update base class's chunk
1581     DLS::Sampler::UpdateChunks();
1582    
1583 persson 1247 RIFF::Chunk* wsmp = pParentList->GetSubChunk(CHUNK_ID_WSMP);
1584     uint8_t* pData = (uint8_t*) wsmp->LoadChunkData();
1585     pData[12] = Crossfade.in_start;
1586     pData[13] = Crossfade.in_end;
1587     pData[14] = Crossfade.out_start;
1588     pData[15] = Crossfade.out_end;
1589    
1590 schoenebeck 809 // make sure '3ewa' chunk exists
1591     RIFF::Chunk* _3ewa = pParentList->GetSubChunk(CHUNK_ID_3EWA);
1592     if (!_3ewa) _3ewa = pParentList->AddSubChunk(CHUNK_ID_3EWA, 140);
1593 persson 1264 else if (wsmp_created) {
1594     // make sure the chunk order is: wsmp, 3ewa
1595     pParentList->MoveSubChunk(_3ewa, 0);
1596     }
1597 persson 1247 pData = (uint8_t*) _3ewa->LoadChunkData();
1598 schoenebeck 809
1599     // update '3ewa' chunk with DimensionRegion's current settings
1600    
1601 persson 1182 const uint32_t chunksize = _3ewa->GetNewSize();
1602 persson 1179 store32(&pData[0], chunksize); // unknown, always chunk size?
1603 schoenebeck 809
1604     const int32_t lfo3freq = (int32_t) GIG_EXP_ENCODE(LFO3Frequency);
1605 persson 1179 store32(&pData[4], lfo3freq);
1606 schoenebeck 809
1607     const int32_t eg3attack = (int32_t) GIG_EXP_ENCODE(EG3Attack);
1608 persson 1179 store32(&pData[8], eg3attack);
1609 schoenebeck 809
1610     // next 2 bytes unknown
1611    
1612 persson 1179 store16(&pData[14], LFO1InternalDepth);
1613 schoenebeck 809
1614     // next 2 bytes unknown
1615    
1616 persson 1179 store16(&pData[18], LFO3InternalDepth);
1617 schoenebeck 809
1618     // next 2 bytes unknown
1619    
1620 persson 1179 store16(&pData[22], LFO1ControlDepth);
1621 schoenebeck 809
1622     // next 2 bytes unknown
1623    
1624 persson 1179 store16(&pData[26], LFO3ControlDepth);
1625 schoenebeck 809
1626     const int32_t eg1attack = (int32_t) GIG_EXP_ENCODE(EG1Attack);
1627 persson 1179 store32(&pData[28], eg1attack);
1628 schoenebeck 809
1629     const int32_t eg1decay1 = (int32_t) GIG_EXP_ENCODE(EG1Decay1);
1630 persson 1179 store32(&pData[32], eg1decay1);
1631 schoenebeck 809
1632     // next 2 bytes unknown
1633    
1634 persson 1179 store16(&pData[38], EG1Sustain);
1635 schoenebeck 809
1636     const int32_t eg1release = (int32_t) GIG_EXP_ENCODE(EG1Release);
1637 persson 1179 store32(&pData[40], eg1release);
1638 schoenebeck 809
1639     const uint8_t eg1ctl = (uint8_t) EncodeLeverageController(EG1Controller);
1640 persson 1179 pData[44] = eg1ctl;
1641 schoenebeck 809
1642     const uint8_t eg1ctrloptions =
1643 persson 1266 (EG1ControllerInvert ? 0x01 : 0x00) |
1644 schoenebeck 809 GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG1ControllerAttackInfluence) |
1645     GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG1ControllerDecayInfluence) |
1646     GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG1ControllerReleaseInfluence);
1647 persson 1179 pData[45] = eg1ctrloptions;
1648 schoenebeck 809
1649     const uint8_t eg2ctl = (uint8_t) EncodeLeverageController(EG2Controller);
1650 persson 1179 pData[46] = eg2ctl;
1651 schoenebeck 809
1652     const uint8_t eg2ctrloptions =
1653 persson 1266 (EG2ControllerInvert ? 0x01 : 0x00) |
1654 schoenebeck 809 GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG2ControllerAttackInfluence) |
1655     GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG2ControllerDecayInfluence) |
1656     GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG2ControllerReleaseInfluence);
1657 persson 1179 pData[47] = eg2ctrloptions;
1658 schoenebeck 809
1659     const int32_t lfo1freq = (int32_t) GIG_EXP_ENCODE(LFO1Frequency);
1660 persson 1179 store32(&pData[48], lfo1freq);
1661 schoenebeck 809
1662     const int32_t eg2attack = (int32_t) GIG_EXP_ENCODE(EG2Attack);
1663 persson 1179 store32(&pData[52], eg2attack);
1664 schoenebeck 809
1665     const int32_t eg2decay1 = (int32_t) GIG_EXP_ENCODE(EG2Decay1);
1666 persson 1179 store32(&pData[56], eg2decay1);
1667 schoenebeck 809
1668     // next 2 bytes unknown
1669    
1670 persson 1179 store16(&pData[62], EG2Sustain);
1671 schoenebeck 809
1672     const int32_t eg2release = (int32_t) GIG_EXP_ENCODE(EG2Release);
1673 persson 1179 store32(&pData[64], eg2release);
1674 schoenebeck 809
1675     // next 2 bytes unknown
1676    
1677 persson 1179 store16(&pData[70], LFO2ControlDepth);
1678 schoenebeck 809
1679     const int32_t lfo2freq = (int32_t) GIG_EXP_ENCODE(LFO2Frequency);
1680 persson 1179 store32(&pData[72], lfo2freq);
1681 schoenebeck 809
1682     // next 2 bytes unknown
1683    
1684 persson 1179 store16(&pData[78], LFO2InternalDepth);
1685 schoenebeck 809
1686     const int32_t eg1decay2 = (int32_t) (EG1InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG1Decay2);
1687 persson 1179 store32(&pData[80], eg1decay2);
1688 schoenebeck 809
1689     // next 2 bytes unknown
1690    
1691 persson 1179 store16(&pData[86], EG1PreAttack);
1692 schoenebeck 809
1693     const int32_t eg2decay2 = (int32_t) (EG2InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG2Decay2);
1694 persson 1179 store32(&pData[88], eg2decay2);
1695 schoenebeck 809
1696     // next 2 bytes unknown
1697    
1698 persson 1179 store16(&pData[94], EG2PreAttack);
1699 schoenebeck 809
1700     {
1701     if (VelocityResponseDepth > 4) throw Exception("VelocityResponseDepth must be between 0 and 4");
1702     uint8_t velocityresponse = VelocityResponseDepth;
1703     switch (VelocityResponseCurve) {
1704     case curve_type_nonlinear:
1705     break;
1706     case curve_type_linear:
1707     velocityresponse += 5;
1708     break;
1709     case curve_type_special:
1710     velocityresponse += 10;
1711     break;
1712     case curve_type_unknown:
1713     default:
1714     throw Exception("Could not update DimensionRegion's chunk, unknown VelocityResponseCurve selected");
1715     }
1716 persson 1179 pData[96] = velocityresponse;
1717 schoenebeck 809 }
1718    
1719     {
1720     if (ReleaseVelocityResponseDepth > 4) throw Exception("ReleaseVelocityResponseDepth must be between 0 and 4");
1721     uint8_t releasevelocityresponse = ReleaseVelocityResponseDepth;
1722     switch (ReleaseVelocityResponseCurve) {
1723     case curve_type_nonlinear:
1724     break;
1725     case curve_type_linear:
1726     releasevelocityresponse += 5;
1727     break;
1728     case curve_type_special:
1729     releasevelocityresponse += 10;
1730     break;
1731     case curve_type_unknown:
1732     default:
1733     throw Exception("Could not update DimensionRegion's chunk, unknown ReleaseVelocityResponseCurve selected");
1734     }
1735 persson 1179 pData[97] = releasevelocityresponse;
1736 schoenebeck 809 }
1737    
1738 persson 1179 pData[98] = VelocityResponseCurveScaling;
1739 schoenebeck 809
1740 persson 1179 pData[99] = AttenuationControllerThreshold;
1741 schoenebeck 809
1742     // next 4 bytes unknown
1743    
1744 persson 1179 store16(&pData[104], SampleStartOffset);
1745 schoenebeck 809
1746     // next 2 bytes unknown
1747    
1748     {
1749     uint8_t pitchTrackDimensionBypass = GIG_PITCH_TRACK_ENCODE(PitchTrack);
1750     switch (DimensionBypass) {
1751     case dim_bypass_ctrl_94:
1752     pitchTrackDimensionBypass |= 0x10;
1753     break;
1754     case dim_bypass_ctrl_95:
1755     pitchTrackDimensionBypass |= 0x20;
1756     break;
1757     case dim_bypass_ctrl_none:
1758     //FIXME: should we set anything here?
1759     break;
1760     default:
1761     throw Exception("Could not update DimensionRegion's chunk, unknown DimensionBypass selected");
1762     }
1763 persson 1179 pData[108] = pitchTrackDimensionBypass;
1764 schoenebeck 809 }
1765    
1766     const uint8_t pan = (Pan >= 0) ? Pan : ((-Pan) + 63); // signed 8 bit -> signed 7 bit
1767 persson 1179 pData[109] = pan;
1768 schoenebeck 809
1769     const uint8_t selfmask = (SelfMask) ? 0x01 : 0x00;
1770 persson 1179 pData[110] = selfmask;
1771 schoenebeck 809
1772     // next byte unknown
1773    
1774     {
1775     uint8_t lfo3ctrl = LFO3Controller & 0x07; // lower 3 bits
1776     if (LFO3Sync) lfo3ctrl |= 0x20; // bit 5
1777     if (InvertAttenuationController) lfo3ctrl |= 0x80; // bit 7
1778     if (VCFType == vcf_type_lowpassturbo) lfo3ctrl |= 0x40; // bit 6
1779 persson 1179 pData[112] = lfo3ctrl;
1780 schoenebeck 809 }
1781    
1782     const uint8_t attenctl = EncodeLeverageController(AttenuationController);
1783 persson 1179 pData[113] = attenctl;
1784 schoenebeck 809
1785     {
1786     uint8_t lfo2ctrl = LFO2Controller & 0x07; // lower 3 bits
1787     if (LFO2FlipPhase) lfo2ctrl |= 0x80; // bit 7
1788     if (LFO2Sync) lfo2ctrl |= 0x20; // bit 5
1789     if (VCFResonanceController != vcf_res_ctrl_none) lfo2ctrl |= 0x40; // bit 6
1790 persson 1179 pData[114] = lfo2ctrl;
1791 schoenebeck 809 }
1792    
1793     {
1794     uint8_t lfo1ctrl = LFO1Controller & 0x07; // lower 3 bits
1795     if (LFO1FlipPhase) lfo1ctrl |= 0x80; // bit 7
1796     if (LFO1Sync) lfo1ctrl |= 0x40; // bit 6
1797     if (VCFResonanceController != vcf_res_ctrl_none)
1798     lfo1ctrl |= GIG_VCF_RESONANCE_CTRL_ENCODE(VCFResonanceController);
1799 persson 1179 pData[115] = lfo1ctrl;
1800 schoenebeck 809 }
1801    
1802     const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth
1803     : uint16_t(((-EG3Depth) - 1) ^ 0xffff); /* binary complementary for negatives */
1804 persson 1179 pData[116] = eg3depth;
1805 schoenebeck 809
1806     // next 2 bytes unknown
1807    
1808     const uint8_t channeloffset = ChannelOffset * 4;
1809 persson 1179 pData[120] = channeloffset;
1810 schoenebeck 809
1811     {
1812     uint8_t regoptions = 0;
1813     if (MSDecode) regoptions |= 0x01; // bit 0
1814     if (SustainDefeat) regoptions |= 0x02; // bit 1
1815 persson 1179 pData[121] = regoptions;
1816 schoenebeck 809 }
1817    
1818     // next 2 bytes unknown
1819    
1820 persson 1179 pData[124] = VelocityUpperLimit;
1821 schoenebeck 809
1822     // next 3 bytes unknown
1823    
1824 persson 1179 pData[128] = ReleaseTriggerDecay;
1825 schoenebeck 809
1826     // next 2 bytes unknown
1827    
1828     const uint8_t eg1hold = (EG1Hold) ? 0x80 : 0x00; // bit 7
1829 persson 1179 pData[131] = eg1hold;
1830 schoenebeck 809
1831 persson 1266 const uint8_t vcfcutoff = (VCFEnabled ? 0x80 : 0x00) | /* bit 7 */
1832 persson 918 (VCFCutoff & 0x7f); /* lower 7 bits */
1833 persson 1179 pData[132] = vcfcutoff;
1834 schoenebeck 809
1835 persson 1179 pData[133] = VCFCutoffController;
1836 schoenebeck 809
1837 persson 1266 const uint8_t vcfvelscale = (VCFCutoffControllerInvert ? 0x80 : 0x00) | /* bit 7 */
1838 persson 918 (VCFVelocityScale & 0x7f); /* lower 7 bits */
1839 persson 1179 pData[134] = vcfvelscale;
1840 schoenebeck 809
1841     // next byte unknown
1842    
1843 persson 1266 const uint8_t vcfresonance = (VCFResonanceDynamic ? 0x00 : 0x80) | /* bit 7 */
1844 persson 918 (VCFResonance & 0x7f); /* lower 7 bits */
1845 persson 1179 pData[136] = vcfresonance;
1846 schoenebeck 809
1847 persson 1266 const uint8_t vcfbreakpoint = (VCFKeyboardTracking ? 0x80 : 0x00) | /* bit 7 */
1848 persson 918 (VCFKeyboardTrackingBreakpoint & 0x7f); /* lower 7 bits */
1849 persson 1179 pData[137] = vcfbreakpoint;
1850 schoenebeck 809
1851     const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 |
1852     VCFVelocityCurve * 5;
1853 persson 1179 pData[138] = vcfvelocity;
1854 schoenebeck 809
1855     const uint8_t vcftype = (VCFType == vcf_type_lowpassturbo) ? vcf_type_lowpass : VCFType;
1856 persson 1179 pData[139] = vcftype;
1857 persson 1070
1858     if (chunksize >= 148) {
1859     memcpy(&pData[140], DimensionUpperLimits, 8);
1860     }
1861 schoenebeck 809 }
1862    
1863 persson 613 // get the corresponding velocity table from the table map or create & calculate that table if it doesn't exist yet
1864     double* DimensionRegion::GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling)
1865     {
1866     double* table;
1867     uint32_t tableKey = (curveType<<16) | (depth<<8) | scaling;
1868 schoenebeck 16 if (pVelocityTables->count(tableKey)) { // if key exists
1869 persson 613 table = (*pVelocityTables)[tableKey];
1870 schoenebeck 16 }
1871     else {
1872 persson 613 table = CreateVelocityTable(curveType, depth, scaling);
1873     (*pVelocityTables)[tableKey] = table; // put the new table into the tables map
1874 schoenebeck 16 }
1875 persson 613 return table;
1876 schoenebeck 2 }
1877 schoenebeck 55
1878 schoenebeck 1316 Region* DimensionRegion::GetParent() const {
1879     return pRegion;
1880     }
1881    
1882 schoenebeck 36 leverage_ctrl_t DimensionRegion::DecodeLeverageController(_lev_ctrl_t EncodedController) {
1883     leverage_ctrl_t decodedcontroller;
1884     switch (EncodedController) {
1885     // special controller
1886     case _lev_ctrl_none:
1887     decodedcontroller.type = leverage_ctrl_t::type_none;
1888     decodedcontroller.controller_number = 0;
1889     break;
1890     case _lev_ctrl_velocity:
1891     decodedcontroller.type = leverage_ctrl_t::type_velocity;
1892     decodedcontroller.controller_number = 0;
1893     break;
1894     case _lev_ctrl_channelaftertouch:
1895     decodedcontroller.type = leverage_ctrl_t::type_channelaftertouch;
1896     decodedcontroller.controller_number = 0;
1897     break;
1898 schoenebeck 55
1899 schoenebeck 36 // ordinary MIDI control change controller
1900     case _lev_ctrl_modwheel:
1901     decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1902     decodedcontroller.controller_number = 1;
1903     break;
1904     case _lev_ctrl_breath:
1905     decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1906     decodedcontroller.controller_number = 2;
1907     break;
1908     case _lev_ctrl_foot:
1909     decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1910     decodedcontroller.controller_number = 4;
1911     break;
1912     case _lev_ctrl_effect1:
1913     decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1914     decodedcontroller.controller_number = 12;
1915     break;
1916     case _lev_ctrl_effect2:
1917     decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1918     decodedcontroller.controller_number = 13;
1919     break;
1920     case _lev_ctrl_genpurpose1:
1921     decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1922     decodedcontroller.controller_number = 16;
1923     break;
1924     case _lev_ctrl_genpurpose2:
1925     decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1926     decodedcontroller.controller_number = 17;
1927     break;
1928     case _lev_ctrl_genpurpose3:
1929     decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1930     decodedcontroller.controller_number = 18;
1931     break;
1932     case _lev_ctrl_genpurpose4:
1933     decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1934     decodedcontroller.controller_number = 19;
1935     break;
1936     case _lev_ctrl_portamentotime:
1937     decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1938     decodedcontroller.controller_number = 5;
1939     break;
1940     case _lev_ctrl_sustainpedal:
1941     decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1942     decodedcontroller.controller_number = 64;
1943     break;
1944     case _lev_ctrl_portamento:
1945     decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1946     decodedcontroller.controller_number = 65;
1947     break;
1948     case _lev_ctrl_sostenutopedal:
1949     decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1950     decodedcontroller.controller_number = 66;
1951     break;
1952     case _lev_ctrl_softpedal:
1953     decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1954     decodedcontroller.controller_number = 67;
1955     break;
1956     case _lev_ctrl_genpurpose5:
1957     decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1958     decodedcontroller.controller_number = 80;
1959     break;
1960     case _lev_ctrl_genpurpose6:
1961     decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1962     decodedcontroller.controller_number = 81;
1963     break;
1964     case _lev_ctrl_genpurpose7:
1965     decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1966     decodedcontroller.controller_number = 82;
1967     break;
1968     case _lev_ctrl_genpurpose8:
1969     decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1970     decodedcontroller.controller_number = 83;
1971     break;
1972     case _lev_ctrl_effect1depth:
1973     decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1974     decodedcontroller.controller_number = 91;
1975     break;
1976     case _lev_ctrl_effect2depth:
1977     decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1978     decodedcontroller.controller_number = 92;
1979     break;
1980     case _lev_ctrl_effect3depth:
1981     decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1982     decodedcontroller.controller_number = 93;
1983     break;
1984     case _lev_ctrl_effect4depth:
1985     decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1986     decodedcontroller.controller_number = 94;
1987     break;
1988     case _lev_ctrl_effect5depth:
1989     decodedcontroller.type = leverage_ctrl_t::type_controlchange;
1990     decodedcontroller.controller_number = 95;
1991     break;
1992 schoenebeck 55
1993 schoenebeck 36 // unknown controller type
1994     default:
1995     throw gig::Exception("Unknown leverage controller type.");
1996     }
1997     return decodedcontroller;
1998     }
1999 schoenebeck 2
2000 schoenebeck 809 DimensionRegion::_lev_ctrl_t DimensionRegion::EncodeLeverageController(leverage_ctrl_t DecodedController) {
2001     _lev_ctrl_t encodedcontroller;
2002     switch (DecodedController.type) {
2003     // special controller
2004     case leverage_ctrl_t::type_none:
2005     encodedcontroller = _lev_ctrl_none;
2006     break;
2007     case leverage_ctrl_t::type_velocity:
2008     encodedcontroller = _lev_ctrl_velocity;
2009     break;
2010     case leverage_ctrl_t::type_channelaftertouch:
2011     encodedcontroller = _lev_ctrl_channelaftertouch;
2012     break;
2013    
2014     // ordinary MIDI control change controller
2015     case leverage_ctrl_t::type_controlchange:
2016     switch (DecodedController.controller_number) {
2017     case 1:
2018     encodedcontroller = _lev_ctrl_modwheel;
2019     break;
2020     case 2:
2021     encodedcontroller = _lev_ctrl_breath;
2022     break;
2023     case 4:
2024     encodedcontroller = _lev_ctrl_foot;
2025     break;
2026     case 12:
2027     encodedcontroller = _lev_ctrl_effect1;
2028     break;
2029     case 13:
2030     encodedcontroller = _lev_ctrl_effect2;
2031     break;
2032     case 16:
2033     encodedcontroller = _lev_ctrl_genpurpose1;
2034     break;
2035     case 17:
2036     encodedcontroller = _lev_ctrl_genpurpose2;
2037     break;
2038     case 18:
2039     encodedcontroller = _lev_ctrl_genpurpose3;
2040     break;
2041     case 19:
2042     encodedcontroller = _lev_ctrl_genpurpose4;
2043     break;
2044     case 5:
2045     encodedcontroller = _lev_ctrl_portamentotime;
2046     break;
2047     case 64:
2048     encodedcontroller = _lev_ctrl_sustainpedal;
2049     break;
2050     case 65:
2051     encodedcontroller = _lev_ctrl_portamento;
2052     break;
2053     case 66:
2054     encodedcontroller = _lev_ctrl_sostenutopedal;
2055     break;
2056     case 67:
2057     encodedcontroller = _lev_ctrl_softpedal;
2058     break;
2059     case 80:
2060     encodedcontroller = _lev_ctrl_genpurpose5;
2061     break;
2062     case 81:
2063     encodedcontroller = _lev_ctrl_genpurpose6;
2064     break;
2065     case 82:
2066     encodedcontroller = _lev_ctrl_genpurpose7;
2067     break;
2068     case 83:
2069     encodedcontroller = _lev_ctrl_genpurpose8;
2070     break;
2071     case 91:
2072     encodedcontroller = _lev_ctrl_effect1depth;
2073     break;
2074     case 92:
2075     encodedcontroller = _lev_ctrl_effect2depth;
2076     break;
2077     case 93:
2078     encodedcontroller = _lev_ctrl_effect3depth;
2079     break;
2080     case 94:
2081     encodedcontroller = _lev_ctrl_effect4depth;
2082     break;
2083     case 95:
2084     encodedcontroller = _lev_ctrl_effect5depth;
2085     break;
2086     default:
2087     throw gig::Exception("leverage controller number is not supported by the gig format");
2088     }
2089 persson 1182 break;
2090 schoenebeck 809 default:
2091     throw gig::Exception("Unknown leverage controller type.");
2092     }
2093     return encodedcontroller;
2094     }
2095    
2096 schoenebeck 16 DimensionRegion::~DimensionRegion() {
2097     Instances--;
2098     if (!Instances) {
2099     // delete the velocity->volume tables
2100     VelocityTableMap::iterator iter;
2101     for (iter = pVelocityTables->begin(); iter != pVelocityTables->end(); iter++) {
2102     double* pTable = iter->second;
2103     if (pTable) delete[] pTable;
2104     }
2105     pVelocityTables->clear();
2106     delete pVelocityTables;
2107     pVelocityTables = NULL;
2108     }
2109 persson 858 if (VelocityTable) delete[] VelocityTable;
2110 schoenebeck 16 }
2111 schoenebeck 2
2112 schoenebeck 16 /**
2113     * Returns the correct amplitude factor for the given \a MIDIKeyVelocity.
2114     * All involved parameters (VelocityResponseCurve, VelocityResponseDepth
2115     * and VelocityResponseCurveScaling) involved are taken into account to
2116     * calculate the amplitude factor. Use this method when a key was
2117     * triggered to get the volume with which the sample should be played
2118     * back.
2119     *
2120 schoenebeck 36 * @param MIDIKeyVelocity MIDI velocity value of the triggered key (between 0 and 127)
2121     * @returns amplitude factor (between 0.0 and 1.0)
2122 schoenebeck 16 */
2123     double DimensionRegion::GetVelocityAttenuation(uint8_t MIDIKeyVelocity) {
2124     return pVelocityAttenuationTable[MIDIKeyVelocity];
2125     }
2126 schoenebeck 2
2127 persson 613 double DimensionRegion::GetVelocityRelease(uint8_t MIDIKeyVelocity) {
2128     return pVelocityReleaseTable[MIDIKeyVelocity];
2129     }
2130    
2131 persson 728 double DimensionRegion::GetVelocityCutoff(uint8_t MIDIKeyVelocity) {
2132     return pVelocityCutoffTable[MIDIKeyVelocity];
2133     }
2134    
2135 schoenebeck 308 double* DimensionRegion::CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling) {
2136 schoenebeck 317
2137 schoenebeck 308 // line-segment approximations of the 15 velocity curves
2138 schoenebeck 16
2139 schoenebeck 308 // linear
2140     const int lin0[] = { 1, 1, 127, 127 };
2141     const int lin1[] = { 1, 21, 127, 127 };
2142     const int lin2[] = { 1, 45, 127, 127 };
2143     const int lin3[] = { 1, 74, 127, 127 };
2144     const int lin4[] = { 1, 127, 127, 127 };
2145 schoenebeck 16
2146 schoenebeck 308 // non-linear
2147     const int non0[] = { 1, 4, 24, 5, 57, 17, 92, 57, 122, 127, 127, 127 };
2148 schoenebeck 317 const int non1[] = { 1, 4, 46, 9, 93, 56, 118, 106, 123, 127,
2149 schoenebeck 308 127, 127 };
2150     const int non2[] = { 1, 4, 46, 9, 57, 20, 102, 107, 107, 127,
2151     127, 127 };
2152     const int non3[] = { 1, 15, 10, 19, 67, 73, 80, 80, 90, 98, 98, 127,
2153     127, 127 };
2154     const int non4[] = { 1, 25, 33, 57, 82, 81, 92, 127, 127, 127 };
2155 schoenebeck 317
2156 schoenebeck 308 // special
2157 schoenebeck 317 const int spe0[] = { 1, 2, 76, 10, 90, 15, 95, 20, 99, 28, 103, 44,
2158 schoenebeck 308 113, 127, 127, 127 };
2159     const int spe1[] = { 1, 2, 27, 5, 67, 18, 89, 29, 95, 35, 107, 67,
2160     118, 127, 127, 127 };
2161 schoenebeck 317 const int spe2[] = { 1, 1, 33, 1, 53, 5, 61, 13, 69, 32, 79, 74,
2162 schoenebeck 308 85, 90, 91, 127, 127, 127 };
2163 schoenebeck 317 const int spe3[] = { 1, 32, 28, 35, 66, 48, 89, 59, 95, 65, 99, 73,
2164 schoenebeck 308 117, 127, 127, 127 };
2165 schoenebeck 317 const int spe4[] = { 1, 4, 23, 5, 49, 13, 57, 17, 92, 57, 122, 127,
2166 schoenebeck 308 127, 127 };
2167 schoenebeck 317
2168 persson 728 // this is only used by the VCF velocity curve
2169     const int spe5[] = { 1, 2, 30, 5, 60, 19, 77, 70, 83, 85, 88, 106,
2170     91, 127, 127, 127 };
2171    
2172 schoenebeck 308 const int* const curves[] = { non0, non1, non2, non3, non4,
2173 schoenebeck 317 lin0, lin1, lin2, lin3, lin4,
2174 persson 728 spe0, spe1, spe2, spe3, spe4, spe5 };
2175 schoenebeck 317
2176 schoenebeck 308 double* const table = new double[128];
2177    
2178     const int* curve = curves[curveType * 5 + depth];
2179     const int s = scaling == 0 ? 20 : scaling; // 0 or 20 means no scaling
2180 schoenebeck 317
2181 schoenebeck 308 table[0] = 0;
2182     for (int x = 1 ; x < 128 ; x++) {
2183    
2184     if (x > curve[2]) curve += 2;
2185 schoenebeck 317 double y = curve[1] + (x - curve[0]) *
2186 schoenebeck 308 (double(curve[3] - curve[1]) / (curve[2] - curve[0]));
2187     y = y / 127;
2188    
2189     // Scale up for s > 20, down for s < 20. When
2190     // down-scaling, the curve still ends at 1.0.
2191     if (s < 20 && y >= 0.5)
2192     y = y / ((2 - 40.0 / s) * y + 40.0 / s - 1);
2193     else
2194     y = y * (s / 20.0);
2195     if (y > 1) y = 1;
2196    
2197     table[x] = y;
2198     }
2199     return table;
2200     }
2201    
2202    
2203 schoenebeck 2 // *************** Region ***************
2204     // *
2205    
2206     Region::Region(Instrument* pInstrument, RIFF::List* rgnList) : DLS::Region((DLS::Instrument*) pInstrument, rgnList) {
2207     // Initialization
2208     Dimensions = 0;
2209 schoenebeck 347 for (int i = 0; i < 256; i++) {
2210 schoenebeck 2 pDimensionRegions[i] = NULL;
2211     }
2212 schoenebeck 282 Layers = 1;
2213 schoenebeck 347 File* file = (File*) GetParent()->GetParent();
2214     int dimensionBits = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;
2215 schoenebeck 2
2216     // Actual Loading
2217    
2218     LoadDimensionRegions(rgnList);
2219    
2220     RIFF::Chunk* _3lnk = rgnList->GetSubChunk(CHUNK_ID_3LNK);
2221     if (_3lnk) {
2222     DimensionRegions = _3lnk->ReadUint32();
2223 schoenebeck 347 for (int i = 0; i < dimensionBits; i++) {
2224 schoenebeck 2 dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());
2225     uint8_t bits = _3lnk->ReadUint8();
2226 persson 1199 _3lnk->ReadUint8(); // bit position of the dimension (bits[0] + bits[1] + ... + bits[i-1])
2227     _3lnk->ReadUint8(); // (1 << bit position of next dimension) - (1 << bit position of this dimension)
2228 persson 774 uint8_t zones = _3lnk->ReadUint8(); // new for v3: number of zones doesn't have to be == pow(2,bits)
2229 schoenebeck 2 if (dimension == dimension_none) { // inactive dimension
2230     pDimensionDefinitions[i].dimension = dimension_none;
2231     pDimensionDefinitions[i].bits = 0;
2232     pDimensionDefinitions[i].zones = 0;
2233     pDimensionDefinitions[i].split_type = split_type_bit;
2234     pDimensionDefinitions[i].zone_size = 0;
2235     }
2236     else { // active dimension
2237     pDimensionDefinitions[i].dimension = dimension;
2238     pDimensionDefinitions[i].bits = bits;
2239 persson 774 pDimensionDefinitions[i].zones = zones ? zones : 0x01 << bits; // = pow(2,bits)
2240 schoenebeck 1113 pDimensionDefinitions[i].split_type = __resolveSplitType(dimension);
2241     pDimensionDefinitions[i].zone_size = __resolveZoneSize(pDimensionDefinitions[i]);
2242 schoenebeck 2 Dimensions++;
2243 schoenebeck 282
2244     // if this is a layer dimension, remember the amount of layers
2245     if (dimension == dimension_layer) Layers = pDimensionDefinitions[i].zones;
2246 schoenebeck 2 }
2247 persson 774 _3lnk->SetPos(3, RIFF::stream_curpos); // jump forward to next dimension definition
2248 schoenebeck 2 }
2249 persson 834 for (int i = dimensionBits ; i < 8 ; i++) pDimensionDefinitions[i].bits = 0;
2250 schoenebeck 2
2251 persson 858 // if there's a velocity dimension and custom velocity zone splits are used,
2252     // update the VelocityTables in the dimension regions
2253     UpdateVelocityTable();
2254 schoenebeck 2
2255 schoenebeck 317 // jump to start of the wave pool indices (if not already there)
2256     if (file->pVersion && file->pVersion->major == 3)
2257     _3lnk->SetPos(68); // version 3 has a different 3lnk structure
2258     else
2259     _3lnk->SetPos(44);
2260    
2261 schoenebeck 2 // load sample references
2262     for (uint i = 0; i < DimensionRegions; i++) {
2263     uint32_t wavepoolindex = _3lnk->ReadUint32();
2264 persson 902 if (file->pWavePoolTable) pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);
2265 schoenebeck 2 }
2266 persson 918 GetSample(); // load global region sample reference
2267 persson 1102 } else {
2268     DimensionRegions = 0;
2269 persson 1182 for (int i = 0 ; i < 8 ; i++) {
2270     pDimensionDefinitions[i].dimension = dimension_none;
2271     pDimensionDefinitions[i].bits = 0;
2272     pDimensionDefinitions[i].zones = 0;
2273     }
2274 schoenebeck 2 }
2275 schoenebeck 823
2276     // make sure there is at least one dimension region
2277     if (!DimensionRegions) {
2278     RIFF::List* _3prg = rgnList->GetSubList(LIST_TYPE_3PRG);
2279     if (!_3prg) _3prg = rgnList->AddSubList(LIST_TYPE_3PRG);
2280     RIFF::List* _3ewl = _3prg->AddSubList(LIST_TYPE_3EWL);
2281 schoenebeck 1316 pDimensionRegions[0] = new DimensionRegion(this, _3ewl);
2282 schoenebeck 823 DimensionRegions = 1;
2283     }
2284 schoenebeck 2 }
2285    
2286 schoenebeck 809 /**
2287     * Apply Region settings and all its DimensionRegions to the respective
2288     * RIFF chunks. You have to call File::Save() to make changes persistent.
2289     *
2290     * Usually there is absolutely no need to call this method explicitly.
2291     * It will be called automatically when File::Save() was called.
2292     *
2293     * @throws gig::Exception if samples cannot be dereferenced
2294     */
2295     void Region::UpdateChunks() {
2296 schoenebeck 1106 // in the gig format we don't care about the Region's sample reference
2297     // but we still have to provide some existing one to not corrupt the
2298     // file, so to avoid the latter we simply always assign the sample of
2299     // the first dimension region of this region
2300     pSample = pDimensionRegions[0]->pSample;
2301    
2302 schoenebeck 809 // first update base class's chunks
2303     DLS::Region::UpdateChunks();
2304    
2305 persson 1247 File* pFile = (File*) GetParent()->GetParent();
2306     bool version3 = pFile->pVersion && pFile->pVersion->major == 3;
2307    
2308 schoenebeck 809 // update dimension region's chunks
2309 schoenebeck 823 for (int i = 0; i < DimensionRegions; i++) {
2310 persson 1247 DimensionRegion* d = pDimensionRegions[i];
2311    
2312     // make sure '3ewa' chunk exists (we need to this before
2313     // calling DimensionRegion::UpdateChunks, as
2314     // DimensionRegion doesn't know which file version it is)
2315     RIFF::Chunk* _3ewa = d->pParentList->GetSubChunk(CHUNK_ID_3EWA);
2316     if (!_3ewa) d->pParentList->AddSubChunk(CHUNK_ID_3EWA, version3 ? 148 : 140);
2317    
2318     d->UpdateChunks();
2319 schoenebeck 823 }
2320 schoenebeck 809
2321 persson 1247 const int iMaxDimensions = version3 ? 8 : 5;
2322     const int iMaxDimensionRegions = version3 ? 256 : 32;
2323 schoenebeck 809
2324     // make sure '3lnk' chunk exists
2325     RIFF::Chunk* _3lnk = pCkRegion->GetSubChunk(CHUNK_ID_3LNK);
2326     if (!_3lnk) {
2327 persson 1247 const int _3lnkChunkSize = version3 ? 1092 : 172;
2328 schoenebeck 809 _3lnk = pCkRegion->AddSubChunk(CHUNK_ID_3LNK, _3lnkChunkSize);
2329 persson 1182 memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);
2330 persson 1192
2331     // move 3prg to last position
2332     pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3PRG), 0);
2333 schoenebeck 809 }
2334    
2335     // update dimension definitions in '3lnk' chunk
2336     uint8_t* pData = (uint8_t*) _3lnk->LoadChunkData();
2337 persson 1179 store32(&pData[0], DimensionRegions);
2338 persson 1199 int shift = 0;
2339 schoenebeck 809 for (int i = 0; i < iMaxDimensions; i++) {
2340 persson 918 pData[4 + i * 8] = (uint8_t) pDimensionDefinitions[i].dimension;
2341     pData[5 + i * 8] = pDimensionDefinitions[i].bits;
2342 persson 1266 pData[6 + i * 8] = pDimensionDefinitions[i].dimension == dimension_none ? 0 : shift;
2343 persson 1199 pData[7 + i * 8] = (1 << (shift + pDimensionDefinitions[i].bits)) - (1 << shift);
2344 persson 918 pData[8 + i * 8] = pDimensionDefinitions[i].zones;
2345 persson 1199 // next 3 bytes unknown, always zero?
2346    
2347     shift += pDimensionDefinitions[i].bits;
2348 schoenebeck 809 }
2349    
2350     // update wave pool table in '3lnk' chunk
2351 persson 1247 const int iWavePoolOffset = version3 ? 68 : 44;
2352 schoenebeck 809 for (uint i = 0; i < iMaxDimensionRegions; i++) {
2353     int iWaveIndex = -1;
2354     if (i < DimensionRegions) {
2355 schoenebeck 823 if (!pFile->pSamples || !pFile->pSamples->size()) throw gig::Exception("Could not update gig::Region, there are no samples");
2356     File::SampleList::iterator iter = pFile->pSamples->begin();
2357     File::SampleList::iterator end = pFile->pSamples->end();
2358 schoenebeck 809 for (int index = 0; iter != end; ++iter, ++index) {
2359 schoenebeck 823 if (*iter == pDimensionRegions[i]->pSample) {
2360     iWaveIndex = index;
2361     break;
2362     }
2363 schoenebeck 809 }
2364     }
2365 persson 1179 store32(&pData[iWavePoolOffset + i * 4], iWaveIndex);
2366 schoenebeck 809 }
2367     }
2368    
2369 schoenebeck 2 void Region::LoadDimensionRegions(RIFF::List* rgn) {
2370     RIFF::List* _3prg = rgn->GetSubList(LIST_TYPE_3PRG);
2371     if (_3prg) {
2372     int dimensionRegionNr = 0;
2373     RIFF::List* _3ewl = _3prg->GetFirstSubList();
2374     while (_3ewl) {
2375     if (_3ewl->GetListType() == LIST_TYPE_3EWL) {
2376 schoenebeck 1316 pDimensionRegions[dimensionRegionNr] = new DimensionRegion(this, _3ewl);
2377 schoenebeck 2 dimensionRegionNr++;
2378     }
2379     _3ewl = _3prg->GetNextSubList();
2380     }
2381     if (dimensionRegionNr == 0) throw gig::Exception("No dimension region found.");
2382     }
2383     }
2384    
2385 persson 858 void Region::UpdateVelocityTable() {
2386     // get velocity dimension's index
2387     int veldim = -1;
2388     for (int i = 0 ; i < Dimensions ; i++) {
2389     if (pDimensionDefinitions[i].dimension == gig::dimension_velocity) {
2390     veldim = i;
2391 schoenebeck 809 break;
2392     }
2393     }
2394 persson 858 if (veldim == -1) return;
2395 schoenebeck 809
2396 persson 858 int step = 1;
2397     for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;
2398     int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;
2399     int end = step * pDimensionDefinitions[veldim].zones;
2400 schoenebeck 809
2401 persson 858 // loop through all dimension regions for all dimensions except the velocity dimension
2402     int dim[8] = { 0 };
2403     for (int i = 0 ; i < DimensionRegions ; i++) {
2404    
2405 persson 1070 if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||
2406     pDimensionRegions[i]->VelocityUpperLimit) {
2407 persson 858 // create the velocity table
2408     uint8_t* table = pDimensionRegions[i]->VelocityTable;
2409     if (!table) {
2410     table = new uint8_t[128];
2411     pDimensionRegions[i]->VelocityTable = table;
2412     }
2413     int tableidx = 0;
2414     int velocityZone = 0;
2415 persson 1070 if (pDimensionRegions[i]->DimensionUpperLimits[veldim]) { // gig3
2416     for (int k = i ; k < end ; k += step) {
2417     DimensionRegion *d = pDimensionRegions[k];
2418     for (; tableidx <= d->DimensionUpperLimits[veldim] ; tableidx++) table[tableidx] = velocityZone;
2419     velocityZone++;
2420     }
2421     } else { // gig2
2422     for (int k = i ; k < end ; k += step) {
2423     DimensionRegion *d = pDimensionRegions[k];
2424     for (; tableidx <= d->VelocityUpperLimit ; tableidx++) table[tableidx] = velocityZone;
2425     velocityZone++;
2426     }
2427 persson 858 }
2428     } else {
2429     if (pDimensionRegions[i]->VelocityTable) {
2430     delete[] pDimensionRegions[i]->VelocityTable;
2431     pDimensionRegions[i]->VelocityTable = 0;
2432     }
2433 schoenebeck 809 }
2434 persson 858
2435     int j;
2436     int shift = 0;
2437     for (j = 0 ; j < Dimensions ; j++) {
2438     if (j == veldim) i += skipveldim; // skip velocity dimension
2439     else {
2440     dim[j]++;
2441     if (dim[j] < pDimensionDefinitions[j].zones) break;
2442     else {
2443     // skip unused dimension regions
2444     dim[j] = 0;
2445     i += ((1 << pDimensionDefinitions[j].bits) -
2446     pDimensionDefinitions[j].zones) << shift;
2447     }
2448     }
2449     shift += pDimensionDefinitions[j].bits;
2450     }
2451     if (j == Dimensions) break;
2452 schoenebeck 809 }
2453     }
2454    
2455     /** @brief Einstein would have dreamed of it - create a new dimension.
2456     *
2457     * Creates a new dimension with the dimension definition given by
2458     * \a pDimDef. The appropriate amount of DimensionRegions will be created.
2459     * There is a hard limit of dimensions and total amount of "bits" all
2460     * dimensions can have. This limit is dependant to what gig file format
2461     * version this file refers to. The gig v2 (and lower) format has a
2462     * dimension limit and total amount of bits limit of 5, whereas the gig v3
2463     * format has a limit of 8.
2464     *
2465     * @param pDimDef - defintion of the new dimension
2466     * @throws gig::Exception if dimension of the same type exists already
2467     * @throws gig::Exception if amount of dimensions or total amount of
2468     * dimension bits limit is violated
2469     */
2470     void Region::AddDimension(dimension_def_t* pDimDef) {
2471     // check if max. amount of dimensions reached
2472     File* file = (File*) GetParent()->GetParent();
2473     const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;
2474     if (Dimensions >= iMaxDimensions)
2475     throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimensions already reached");
2476     // check if max. amount of dimension bits reached
2477     int iCurrentBits = 0;
2478     for (int i = 0; i < Dimensions; i++)
2479     iCurrentBits += pDimensionDefinitions[i].bits;
2480     if (iCurrentBits >= iMaxDimensions)
2481     throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimension bits already reached");
2482     const int iNewBits = iCurrentBits + pDimDef->bits;
2483     if (iNewBits > iMaxDimensions)
2484     throw gig::Exception("Could not add new dimension, new dimension would exceed max. amount of " + ToString(iMaxDimensions) + " dimension bits");
2485     // check if there's already a dimensions of the same type
2486     for (int i = 0; i < Dimensions; i++)
2487     if (pDimensionDefinitions[i].dimension == pDimDef->dimension)
2488     throw gig::Exception("Could not add new dimension, there is already a dimension of the same type");
2489    
2490 persson 1301 // pos is where the new dimension should be placed, normally
2491     // last in list, except for the samplechannel dimension which
2492     // has to be first in list
2493     int pos = pDimDef->dimension == dimension_samplechannel ? 0 : Dimensions;
2494     int bitpos = 0;
2495     for (int i = 0 ; i < pos ; i++)
2496     bitpos += pDimensionDefinitions[i].bits;
2497    
2498     // make room for the new dimension
2499     for (int i = Dimensions ; i > pos ; i--) pDimensionDefinitions[i] = pDimensionDefinitions[i - 1];
2500     for (int i = 0 ; i < (1 << iCurrentBits) ; i++) {
2501     for (int j = Dimensions ; j > pos ; j--) {
2502     pDimensionRegions[i]->DimensionUpperLimits[j] =
2503     pDimensionRegions[i]->DimensionUpperLimits[j - 1];
2504     }
2505     }
2506    
2507 schoenebeck 809 // assign definition of new dimension
2508 persson 1301 pDimensionDefinitions[pos] = *pDimDef;
2509 schoenebeck 809
2510 schoenebeck 1113 // auto correct certain dimension definition fields (where possible)
2511 persson 1301 pDimensionDefinitions[pos].split_type =
2512     __resolveSplitType(pDimensionDefinitions[pos].dimension);
2513     pDimensionDefinitions[pos].zone_size =
2514     __resolveZoneSize(pDimensionDefinitions[pos]);
2515 schoenebeck 1113
2516 persson 1301 // create new dimension region(s) for this new dimension, and make
2517     // sure that the dimension regions are placed correctly in both the
2518     // RIFF list and the pDimensionRegions array
2519     RIFF::Chunk* moveTo = NULL;
2520     RIFF::List* _3prg = pCkRegion->GetSubList(LIST_TYPE_3PRG);
2521     for (int i = (1 << iCurrentBits) - (1 << bitpos) ; i >= 0 ; i -= (1 << bitpos)) {
2522     for (int k = 0 ; k < (1 << bitpos) ; k++) {
2523     pDimensionRegions[(i << pDimDef->bits) + k] = pDimensionRegions[i + k];
2524     }
2525     for (int j = 1 ; j < (1 << pDimDef->bits) ; j++) {
2526     for (int k = 0 ; k < (1 << bitpos) ; k++) {
2527     RIFF::List* pNewDimRgnListChunk = _3prg->AddSubList(LIST_TYPE_3EWL);
2528     if (moveTo) _3prg->MoveSubChunk(pNewDimRgnListChunk, moveTo);
2529     // create a new dimension region and copy all parameter values from
2530     // an existing dimension region
2531     pDimensionRegions[(i << pDimDef->bits) + (j << bitpos) + k] =
2532     new DimensionRegion(pNewDimRgnListChunk, *pDimensionRegions[i + k]);
2533 persson 1247
2534 persson 1301 DimensionRegions++;
2535     }
2536     }
2537     moveTo = pDimensionRegions[i]->pParentList;
2538 schoenebeck 809 }
2539    
2540 persson 1247 // initialize the upper limits for this dimension
2541 persson 1301 int mask = (1 << bitpos) - 1;
2542     for (int z = 0 ; z < pDimDef->zones ; z++) {
2543 persson 1264 uint8_t upperLimit = uint8_t((z + 1) * 128.0 / pDimDef->zones - 1);
2544 persson 1247 for (int i = 0 ; i < 1 << iCurrentBits ; i++) {
2545 persson 1301 pDimensionRegions[((i & ~mask) << pDimDef->bits) |
2546     (z << bitpos) |
2547     (i & mask)]->DimensionUpperLimits[pos] = upperLimit;
2548 persson 1247 }
2549     }
2550    
2551 schoenebeck 809 Dimensions++;
2552    
2553     // if this is a layer dimension, update 'Layers' attribute
2554     if (pDimDef->dimension == dimension_layer) Layers = pDimDef->zones;
2555    
2556 persson 858 UpdateVelocityTable();
2557 schoenebeck 809 }
2558    
2559     /** @brief Delete an existing dimension.
2560     *
2561     * Deletes the dimension given by \a pDimDef and deletes all respective
2562     * dimension regions, that is all dimension regions where the dimension's
2563     * bit(s) part is greater than 0. In case of a 'sustain pedal' dimension
2564     * for example this would delete all dimension regions for the case(s)
2565     * where the sustain pedal is pressed down.
2566     *
2567     * @param pDimDef - dimension to delete
2568     * @throws gig::Exception if given dimension cannot be found
2569     */
2570     void Region::DeleteDimension(dimension_def_t* pDimDef) {
2571     // get dimension's index
2572     int iDimensionNr = -1;
2573     for (int i = 0; i < Dimensions; i++) {
2574     if (&pDimensionDefinitions[i] == pDimDef) {
2575     iDimensionNr = i;
2576     break;
2577     }
2578     }
2579     if (iDimensionNr < 0) throw gig::Exception("Invalid dimension_def_t pointer");
2580    
2581     // get amount of bits below the dimension to delete
2582     int iLowerBits = 0;
2583     for (int i = 0; i < iDimensionNr; i++)
2584     iLowerBits += pDimensionDefinitions[i].bits;
2585    
2586     // get amount ot bits above the dimension to delete
2587     int iUpperBits = 0;
2588     for (int i = iDimensionNr + 1; i < Dimensions; i++)
2589     iUpperBits += pDimensionDefinitions[i].bits;
2590    
2591 persson 1247 RIFF::List* _3prg = pCkRegion->GetSubList(LIST_TYPE_3PRG);
2592    
2593 schoenebeck 809 // delete dimension regions which belong to the given dimension
2594     // (that is where the dimension's bit > 0)
2595     for (int iUpperBit = 0; iUpperBit < 1 << iUpperBits; iUpperBit++) {
2596     for (int iObsoleteBit = 1; iObsoleteBit < 1 << pDimensionDefinitions[iDimensionNr].bits; iObsoleteBit++) {
2597     for (int iLowerBit = 0; iLowerBit < 1 << iLowerBits; iLowerBit++) {
2598     int iToDelete = iUpperBit << (pDimensionDefinitions[iDimensionNr].bits + iLowerBits) |
2599     iObsoleteBit << iLowerBits |
2600     iLowerBit;
2601 persson 1247
2602     _3prg->DeleteSubChunk(pDimensionRegions[iToDelete]->pParentList);
2603 schoenebeck 809 delete pDimensionRegions[iToDelete];
2604     pDimensionRegions[iToDelete] = NULL;
2605     DimensionRegions--;
2606     }
2607     }
2608     }
2609    
2610     // defrag pDimensionRegions array
2611     // (that is remove the NULL spaces within the pDimensionRegions array)
2612     for (int iFrom = 2, iTo = 1; iFrom < 256 && iTo < 256 - 1; iTo++) {
2613     if (!pDimensionRegions[iTo]) {
2614     if (iFrom <= iTo) iFrom = iTo + 1;
2615     while (!pDimensionRegions[iFrom] && iFrom < 256) iFrom++;
2616     if (iFrom < 256 && pDimensionRegions[iFrom]) {
2617     pDimensionRegions[iTo] = pDimensionRegions[iFrom];
2618     pDimensionRegions[iFrom] = NULL;
2619     }
2620     }
2621     }
2622    
2623 persson 1247 // remove the this dimension from the upper limits arrays
2624     for (int j = 0 ; j < 256 && pDimensionRegions[j] ; j++) {
2625     DimensionRegion* d = pDimensionRegions[j];
2626     for (int i = iDimensionNr + 1; i < Dimensions; i++) {
2627     d->DimensionUpperLimits[i - 1] = d->DimensionUpperLimits[i];
2628     }
2629     d->DimensionUpperLimits[Dimensions - 1] = 127;
2630     }
2631    
2632 schoenebeck 809 // 'remove' dimension definition
2633     for (int i = iDimensionNr + 1; i < Dimensions; i++) {
2634     pDimensionDefinitions[i - 1] = pDimensionDefinitions[i];
2635     }
2636     pDimensionDefinitions[Dimensions - 1].dimension = dimension_none;
2637     pDimensionDefinitions[Dimensions - 1].bits = 0;
2638     pDimensionDefinitions[Dimensions - 1].zones = 0;
2639    
2640     Dimensions--;
2641    
2642     // if this was a layer dimension, update 'Layers' attribute
2643     if (pDimDef->dimension == dimension_layer) Layers = 1;
2644     }
2645    
2646 schoenebeck 2 Region::~Region() {
2647 schoenebeck 350 for (int i = 0; i < 256; i++) {
2648 schoenebeck 2 if (pDimensionRegions[i]) delete pDimensionRegions[i];
2649     }
2650     }
2651    
2652     /**
2653     * Use this method in your audio engine to get the appropriate dimension
2654     * region with it's articulation data for the current situation. Just
2655     * call the method with the current MIDI controller values and you'll get
2656     * the DimensionRegion with the appropriate articulation data for the
2657     * current situation (for this Region of course only). To do that you'll
2658     * first have to look which dimensions with which controllers and in
2659     * which order are defined for this Region when you load the .gig file.
2660     * Special cases are e.g. layer or channel dimensions where you just put
2661     * in the index numbers instead of a MIDI controller value (means 0 for
2662     * left channel, 1 for right channel or 0 for layer 0, 1 for layer 1,
2663     * etc.).
2664     *
2665 schoenebeck 347 * @param DimValues MIDI controller values (0-127) for dimension 0 to 7
2666 schoenebeck 2 * @returns adress to the DimensionRegion for the given situation
2667     * @see pDimensionDefinitions
2668     * @see Dimensions
2669     */
2670 schoenebeck 347 DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {
2671 persson 858 uint8_t bits;
2672     int veldim = -1;
2673     int velbitpos;
2674     int bitpos = 0;
2675     int dimregidx = 0;
2676 schoenebeck 2 for (uint i = 0; i < Dimensions; i++) {
2677 persson 858 if (pDimensionDefinitions[i].dimension == dimension_velocity) {
2678     // the velocity dimension must be handled after the other dimensions
2679     veldim = i;
2680     velbitpos = bitpos;
2681     } else {
2682     switch (pDimensionDefinitions[i].split_type) {
2683     case split_type_normal:
2684 persson 1070 if (pDimensionRegions[0]->DimensionUpperLimits[i]) {
2685     // gig3: all normal dimensions (not just the velocity dimension) have custom zone ranges
2686     for (bits = 0 ; bits < pDimensionDefinitions[i].zones ; bits++) {
2687     if (DimValues[i] <= pDimensionRegions[bits << bitpos]->DimensionUpperLimits[i]) break;
2688     }
2689     } else {
2690     // gig2: evenly sized zones
2691     bits = uint8_t(DimValues[i] / pDimensionDefinitions[i].zone_size);
2692     }
2693 persson 858 break;
2694     case split_type_bit: // the value is already the sought dimension bit number
2695     const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;
2696     bits = DimValues[i] & limiter_mask; // just make sure the value doesn't use more bits than allowed
2697     break;
2698     }
2699     dimregidx |= bits << bitpos;
2700 schoenebeck 2 }
2701 persson 858 bitpos += pDimensionDefinitions[i].bits;
2702 schoenebeck 2 }
2703 persson 858 DimensionRegion* dimreg = pDimensionRegions[dimregidx];
2704     if (veldim != -1) {
2705     // (dimreg is now the dimension region for the lowest velocity)
2706 persson 1070 if (dimreg->VelocityTable) // custom defined zone ranges
2707 persson 858 bits = dimreg->VelocityTable[DimValues[veldim]];
2708     else // normal split type
2709     bits = uint8_t(DimValues[veldim] / pDimensionDefinitions[veldim].zone_size);
2710    
2711     dimregidx |= bits << velbitpos;
2712     dimreg = pDimensionRegions[dimregidx];
2713     }
2714     return dimreg;
2715 schoenebeck 2 }
2716    
2717     /**
2718     * Returns the appropriate DimensionRegion for the given dimension bit
2719     * numbers (zone index). You usually use <i>GetDimensionRegionByValue</i>
2720     * instead of calling this method directly!
2721     *
2722 schoenebeck 347 * @param DimBits Bit numbers for dimension 0 to 7
2723 schoenebeck 2 * @returns adress to the DimensionRegion for the given dimension
2724     * bit numbers
2725     * @see GetDimensionRegionByValue()
2726     */
2727 schoenebeck 347 DimensionRegion* Region::GetDimensionRegionByBit(const uint8_t DimBits[8]) {
2728     return pDimensionRegions[((((((DimBits[7] << pDimensionDefinitions[6].bits | DimBits[6])
2729     << pDimensionDefinitions[5].bits | DimBits[5])
2730     << pDimensionDefinitions[4].bits | DimBits[4])
2731     << pDimensionDefinitions[3].bits | DimBits[3])
2732     << pDimensionDefinitions[2].bits | DimBits[2])
2733     << pDimensionDefinitions[1].bits | DimBits[1])
2734     << pDimensionDefinitions[0].bits | DimBits[0]];
2735 schoenebeck 2 }
2736    
2737     /**
2738     * Returns pointer address to the Sample referenced with this region.
2739     * This is the global Sample for the entire Region (not sure if this is
2740     * actually used by the Gigasampler engine - I would only use the Sample
2741     * referenced by the appropriate DimensionRegion instead of this sample).
2742     *
2743     * @returns address to Sample or NULL if there is no reference to a
2744     * sample saved in the .gig file
2745     */
2746     Sample* Region::GetSample() {
2747     if (pSample) return static_cast<gig::Sample*>(pSample);
2748     else return static_cast<gig::Sample*>(pSample = GetSampleFromWavePool(WavePoolTableIndex));
2749     }
2750    
2751 schoenebeck 515 Sample* Region::GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress) {
2752 schoenebeck 352 if ((int32_t)WavePoolTableIndex == -1) return NULL;
2753 schoenebeck 2 File* file = (File*) GetParent()->GetParent();
2754 persson 902 if (!file->pWavePoolTable) return NULL;
2755 schoenebeck 2 unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
2756 persson 666 unsigned long soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];
2757 schoenebeck 515 Sample* sample = file->GetFirstSample(pProgress);
2758 schoenebeck 2 while (sample) {
2759 persson 666 if (sample->ulWavePoolOffset == soughtoffset &&
2760 persson 918 sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);
2761 schoenebeck 2 sample = file->GetNextSample();
2762     }
2763     return NULL;
2764     }
2765    
2766    
2767    
2768     // *************** Instrument ***************
2769     // *
2770    
2771 schoenebeck 515 Instrument::Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress) : DLS::Instrument((DLS::File*)pFile, insList) {
2772 persson 1180 static const DLS::Info::FixedStringLength fixedStringLengths[] = {
2773     { CHUNK_ID_INAM, 64 },
2774     { CHUNK_ID_ISFT, 12 },
2775     { 0, 0 }
2776     };
2777     pInfo->FixedStringLengths = fixedStringLengths;
2778 persson 918
2779 schoenebeck 2 // Initialization
2780     for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;
2781 persson 1182 EffectSend = 0;
2782     Attenuation = 0;
2783     FineTune = 0;
2784     PitchbendRange = 0;
2785     PianoReleaseMode = false;
2786     DimensionKeyRange.low = 0;
2787     DimensionKeyRange.high = 0;
2788 schoenebeck 2
2789     // Loading
2790     RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);
2791     if (lart) {
2792     RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);
2793     if (_3ewg) {
2794     EffectSend = _3ewg->ReadUint16();
2795     Attenuation = _3ewg->ReadInt32();
2796     FineTune = _3ewg->ReadInt16();
2797     PitchbendRange = _3ewg->ReadInt16();
2798     uint8_t dimkeystart = _3ewg->ReadUint8();
2799     PianoReleaseMode = dimkeystart & 0x01;
2800     DimensionKeyRange.low = dimkeystart >> 1;
2801     DimensionKeyRange.high = _3ewg->ReadUint8();
2802     }
2803     }
2804    
2805 schoenebeck 823 if (!pRegions) pRegions = new RegionList;
2806 schoenebeck 2 RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);
2807 schoenebeck 809 if (lrgn) {
2808     RIFF::List* rgn = lrgn->GetFirstSubList();
2809     while (rgn) {
2810     if (rgn->GetListType() == LIST_TYPE_RGN) {
2811 schoenebeck 823 __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
2812     pRegions->push_back(new Region(this, rgn));
2813 schoenebeck 809 }
2814     rgn = lrgn->GetNextSubList();
2815 schoenebeck 2 }
2816 schoenebeck 809 // Creating Region Key Table for fast lookup
2817     UpdateRegionKeyTable();
2818 schoenebeck 2 }
2819    
2820 schoenebeck 809 __notify_progress(pProgress, 1.0f); // notify done
2821     }
2822    
2823     void Instrument::UpdateRegionKeyTable() {
2824 schoenebeck 823 RegionList::iterator iter = pRegions->begin();
2825     RegionList::iterator end = pRegions->end();
2826     for (; iter != end; ++iter) {
2827     gig::Region* pRegion = static_cast<gig::Region*>(*iter);
2828     for (int iKey = pRegion->KeyRange.low; iKey <= pRegion->KeyRange.high; iKey++) {
2829     RegionKeyTable[iKey] = pRegion;
2830 schoenebeck 2 }
2831     }
2832     }
2833    
2834     Instrument::~Instrument() {
2835     }
2836    
2837     /**
2838 schoenebeck 809 * Apply Instrument with all its Regions to the respective RIFF chunks.
2839     * You have to call File::Save() to make changes persistent.
2840     *
2841     * Usually there is absolutely no need to call this method explicitly.
2842     * It will be called automatically when File::Save() was called.
2843     *
2844     * @throws gig::Exception if samples cannot be dereferenced
2845     */
2846     void Instrument::UpdateChunks() {
2847     // first update base classes' chunks
2848     DLS::Instrument::UpdateChunks();
2849    
2850     // update Regions' chunks
2851 schoenebeck 823 {
2852     RegionList::iterator iter = pRegions->begin();
2853     RegionList::iterator end = pRegions->end();
2854     for (; iter != end; ++iter)
2855     (*iter)->UpdateChunks();
2856     }
2857 schoenebeck 809
2858     // make sure 'lart' RIFF list chunk exists
2859     RIFF::List* lart = pCkInstrument->GetSubList(LIST_TYPE_LART);
2860     if (!lart) lart = pCkInstrument->AddSubList(LIST_TYPE_LART);
2861     // make sure '3ewg' RIFF chunk exists
2862     RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);
2863 persson 1264 if (!_3ewg) {
2864     File* pFile = (File*) GetParent();
2865    
2866     // 3ewg is bigger in gig3, as it includes the iMIDI rules
2867     int size = (pFile->pVersion && pFile->pVersion->major == 3) ? 16416 : 12;
2868     _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, size);
2869     memset(_3ewg->LoadChunkData(), 0, size);
2870     }
2871 schoenebeck 809 // update '3ewg' RIFF chunk
2872     uint8_t* pData = (uint8_t*) _3ewg->LoadChunkData();
2873 persson 1179 store16(&pData[0], EffectSend);
2874     store32(&pData[2], Attenuation);
2875     store16(&pData[6], FineTune);
2876     store16(&pData[8], PitchbendRange);
2877 persson 1266 const uint8_t dimkeystart = (PianoReleaseMode ? 0x01 : 0x00) |
2878 schoenebeck 809 DimensionKeyRange.low << 1;
2879 persson 1179 pData[10] = dimkeystart;
2880     pData[11] = DimensionKeyRange.high;
2881 schoenebeck 809 }
2882    
2883     /**
2884 schoenebeck 2 * Returns the appropriate Region for a triggered note.
2885     *
2886     * @param Key MIDI Key number of triggered note / key (0 - 127)
2887     * @returns pointer adress to the appropriate Region or NULL if there
2888     * there is no Region defined for the given \a Key
2889     */
2890     Region* Instrument::GetRegion(unsigned int Key) {
2891 schoenebeck 823 if (!pRegions || !pRegions->size() || Key > 127) return NULL;
2892 schoenebeck 2 return RegionKeyTable[Key];
2893 schoenebeck 823
2894 schoenebeck 2 /*for (int i = 0; i < Regions; i++) {
2895     if (Key <= pRegions[i]->KeyRange.high &&
2896     Key >= pRegions[i]->KeyRange.low) return pRegions[i];
2897     }
2898     return NULL;*/
2899     }
2900    
2901     /**
2902     * Returns the first Region of the instrument. You have to call this
2903     * method once before you use GetNextRegion().
2904     *
2905     * @returns pointer address to first region or NULL if there is none
2906     * @see GetNextRegion()
2907     */
2908     Region* Instrument::GetFirstRegion() {
2909 schoenebeck 823 if (!pRegions) return NULL;
2910     RegionsIterator = pRegions->begin();
2911     return static_cast<gig::Region*>( (RegionsIterator != pRegions->end()) ? *RegionsIterator : NULL );
2912 schoenebeck 2 }
2913    
2914     /**
2915     * Returns the next Region of the instrument. You have to call
2916     * GetFirstRegion() once before you can use this method. By calling this
2917     * method multiple times it iterates through the available Regions.
2918     *
2919     * @returns pointer address to the next region or NULL if end reached
2920     * @see GetFirstRegion()
2921     */
2922     Region* Instrument::GetNextRegion() {
2923 schoenebeck 823 if (!pRegions) return NULL;
2924     RegionsIterator++;
2925     return static_cast<gig::Region*>( (RegionsIterator != pRegions->end()) ? *RegionsIterator : NULL );
2926 schoenebeck 2 }
2927    
2928 schoenebeck 809 Region* Instrument::AddRegion() {
2929     // create new Region object (and its RIFF chunks)
2930     RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
2931     if (!lrgn) lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
2932     RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
2933     Region* pNewRegion = new Region(this, rgn);
2934 schoenebeck 823 pRegions->push_back(pNewRegion);
2935     Regions = pRegions->size();
2936 schoenebeck 809 // update Region key table for fast lookup
2937     UpdateRegionKeyTable();
2938     // done
2939     return pNewRegion;
2940     }
2941 schoenebeck 2
2942 schoenebeck 809 void Instrument::DeleteRegion(Region* pRegion) {
2943     if (!pRegions) return;
2944 schoenebeck 823 DLS::Instrument::DeleteRegion((DLS::Region*) pRegion);
2945 schoenebeck 809 // update Region key table for fast lookup
2946     UpdateRegionKeyTable();
2947     }
2948 schoenebeck 2
2949 schoenebeck 809
2950    
2951 schoenebeck 929 // *************** Group ***************
2952     // *
2953    
2954     /** @brief Constructor.
2955     *
2956 schoenebeck 930 * @param file - pointer to the gig::File object
2957     * @param ck3gnm - pointer to 3gnm chunk associated with this group or
2958     * NULL if this is a new Group
2959 schoenebeck 929 */
2960 schoenebeck 930 Group::Group(File* file, RIFF::Chunk* ck3gnm) {
2961 schoenebeck 929 pFile = file;
2962     pNameChunk = ck3gnm;
2963     ::LoadString(pNameChunk, Name);
2964     }
2965    
2966     Group::~Group() {
2967 schoenebeck 1099 // remove the chunk associated with this group (if any)
2968     if (pNameChunk) pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);
2969 schoenebeck 929 }
2970    
2971     /** @brief Update chunks with current group settings.
2972     *
2973 schoenebeck 1098 * Apply current Group field values to the respective chunks. You have
2974     * to call File::Save() to make changes persistent.
2975     *
2976     * Usually there is absolutely no need to call this method explicitly.
2977     * It will be called automatically when File::Save() was called.
2978 schoenebeck 929 */
2979     void Group::UpdateChunks() {
2980     // make sure <3gri> and <3gnl> list chunks exist
2981 schoenebeck 930 RIFF::List* _3gri = pFile->pRIFF->GetSubList(LIST_TYPE_3GRI);
2982 persson 1192 if (!_3gri) {
2983     _3gri = pFile->pRIFF->AddSubList(LIST_TYPE_3GRI);
2984     pFile->pRIFF->MoveSubChunk(_3gri, pFile->pRIFF->GetSubChunk(CHUNK_ID_PTBL));
2985     }
2986 schoenebeck 929 RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
2987 persson 1182 if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
2988 persson 1266
2989     if (!pNameChunk && pFile->pVersion && pFile->pVersion->major == 3) {
2990     // v3 has a fixed list of 128 strings, find a free one
2991     for (RIFF::Chunk* ck = _3gnl->GetFirstSubChunk() ; ck ; ck = _3gnl->GetNextSubChunk()) {
2992     if (strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) {
2993     pNameChunk = ck;
2994     break;
2995     }
2996     }
2997     }
2998    
2999 schoenebeck 929 // now store the name of this group as <3gnm> chunk as subchunk of the <3gnl> list chunk
3000     ::SaveString(CHUNK_ID_3GNM, pNameChunk, _3gnl, Name, String("Unnamed Group"), true, 64);
3001     }
3002    
3003 schoenebeck 930 /**
3004     * Returns the first Sample of this Group. You have to call this method
3005     * once before you use GetNextSample().
3006     *
3007     * <b>Notice:</b> this method might block for a long time, in case the
3008     * samples of this .gig file were not scanned yet
3009     *
3010     * @returns pointer address to first Sample or NULL if there is none
3011     * applied to this Group
3012     * @see GetNextSample()
3013     */
3014     Sample* Group::GetFirstSample() {
3015     // FIXME: lazy und unsafe implementation, should be an autonomous iterator
3016     for (Sample* pSample = pFile->GetFirstSample(); pSample; pSample = pFile->GetNextSample()) {
3017     if (pSample->GetGroup() == this) return pSample;
3018     }
3019     return NULL;
3020     }
3021 schoenebeck 929
3022 schoenebeck 930 /**
3023     * Returns the next Sample of the Group. You have to call
3024     * GetFirstSample() once before you can use this method. By calling this
3025     * method multiple times it iterates through the Samples assigned to
3026     * this Group.
3027     *
3028     * @returns pointer address to the next Sample of this Group or NULL if
3029     * end reached
3030     * @see GetFirstSample()
3031     */
3032     Sample* Group::GetNextSample() {
3033     // FIXME: lazy und unsafe implementation, should be an autonomous iterator
3034     for (Sample* pSample = pFile->GetNextSample(); pSample; pSample = pFile->GetNextSample()) {
3035     if (pSample->GetGroup() == this) return pSample;
3036     }
3037     return NULL;
3038     }
3039 schoenebeck 929
3040 schoenebeck 930 /**
3041     * Move Sample given by \a pSample from another Group to this Group.
3042     */
3043     void Group::AddSample(Sample* pSample) {
3044     pSample->pGroup = this;
3045     }
3046    
3047     /**
3048     * Move all members of this group to another group (preferably the 1st
3049     * one except this). This method is called explicitly by
3050     * File::DeleteGroup() thus when a Group was deleted. This code was
3051     * intentionally not placed in the destructor!
3052     */
3053     void Group::MoveAll() {
3054     // get "that" other group first
3055     Group* pOtherGroup = NULL;
3056     for (pOtherGroup = pFile->GetFirstGroup(); pOtherGroup; pOtherGroup = pFile->GetNextGroup()) {
3057     if (pOtherGroup != this) break;
3058     }
3059     if (!pOtherGroup) throw Exception(
3060     "Could not move samples to another group, since there is no "
3061     "other Group. This is a bug, report it!"
3062     );
3063     // now move all samples of this group to the other group
3064     for (Sample* pSample = GetFirstSample(); pSample; pSample = GetNextSample()) {
3065     pOtherGroup->AddSample(pSample);
3066     }
3067     }
3068    
3069    
3070    
3071 schoenebeck 2 // *************** File ***************
3072     // *
3073    
3074 persson 1199 // File version 2.0, 1998-06-28
3075     const DLS::version_t File::VERSION_2 = {
3076     0, 2, 19980628 & 0xffff, 19980628 >> 16
3077     };
3078    
3079     // File version 3.0, 2003-03-31
3080     const DLS::version_t File::VERSION_3 = {
3081     0, 3, 20030331 & 0xffff, 20030331 >> 16
3082     };
3083    
3084 persson 1180 const DLS::Info::FixedStringLength File::FixedStringLengths[] = {
3085     { CHUNK_ID_IARL, 256 },
3086     { CHUNK_ID_IART, 128 },
3087     { CHUNK_ID_ICMS, 128 },
3088     { CHUNK_ID_ICMT, 1024 },
3089     { CHUNK_ID_ICOP, 128 },
3090     { CHUNK_ID_ICRD, 128 },
3091     { CHUNK_ID_IENG, 128 },
3092     { CHUNK_ID_IGNR, 128 },
3093     { CHUNK_ID_IKEY, 128 },
3094     { CHUNK_ID_IMED, 128 },
3095     { CHUNK_ID_INAM, 128 },
3096     { CHUNK_ID_IPRD, 128 },
3097     { CHUNK_ID_ISBJ, 128 },
3098     { CHUNK_ID_ISFT, 128 },
3099     { CHUNK_ID_ISRC, 128 },
3100     { CHUNK_ID_ISRF, 128 },
3101     { CHUNK_ID_ITCH, 128 },
3102     { 0, 0 }
3103     };
3104    
3105 schoenebeck 809 File::File() : DLS::File() {
3106 persson 1264 *pVersion = VERSION_3;
3107 schoenebeck 929 pGroups = NULL;
3108 persson 1180 pInfo->FixedStringLengths = FixedStringLengths;
3109 persson 1182 pInfo->ArchivalLocation = String(256, ' ');
3110 persson 1192
3111     // add some mandatory chunks to get the file chunks in right
3112     // order (INFO chunk will be moved to first position later)
3113     pRIFF->AddSubChunk(CHUNK_ID_VERS, 8);
3114     pRIFF->AddSubChunk(CHUNK_ID_COLH, 4);
3115 persson 1209 pRIFF->AddSubChunk(CHUNK_ID_DLID, 16);
3116    
3117     GenerateDLSID();
3118 schoenebeck 809 }
3119    
3120 schoenebeck 2 File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {
3121 schoenebeck 929 pGroups = NULL;
3122 persson 1180 pInfo->FixedStringLengths = FixedStringLengths;
3123 schoenebeck 2 }
3124    
3125 schoenebeck 929 File::~File() {
3126     if (pGroups) {
3127     std::list<Group*>::iterator iter = pGroups->begin();
3128     std::list<Group*>::iterator end = pGroups->end();
3129     while (iter != end) {
3130     delete *iter;
3131     ++iter;
3132     }
3133     delete pGroups;
3134     }
3135     }
3136    
3137 schoenebeck 515 Sample* File::GetFirstSample(progress_t* pProgress) {
3138     if (!pSamples) LoadSamples(pProgress);
3139 schoenebeck 2 if (!pSamples) return NULL;
3140     SamplesIterator = pSamples->begin();
3141     return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
3142     }
3143    
3144     Sample* File::GetNextSample() {
3145     if (!pSamples) return NULL;
3146     SamplesIterator++;
3147     return static_cast<gig::Sample*>( (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL );
3148     }
3149    
3150 schoenebeck 809 /** @brief Add a new sample.
3151     *
3152     * This will create a new Sample object for the gig file. You have to
3153     * call Save() to make this persistent to the file.
3154     *
3155     * @returns pointer to new Sample object
3156     */
3157     Sample* File::AddSample() {
3158     if (!pSamples) LoadSamples();
3159     __ensureMandatoryChunksExist();
3160     RIFF::List* wvpl = pRIFF->GetSubList(LIST_TYPE_WVPL);
3161     // create new Sample object and its respective 'wave' list chunk
3162     RIFF::List* wave = wvpl->AddSubList(LIST_TYPE_WAVE);
3163     Sample* pSample = new Sample(this, wave, 0 /*arbitrary value, we update offsets when we save*/);
3164 persson 1192
3165     // add mandatory chunks to get the chunks in right order
3166     wave->AddSubChunk(CHUNK_ID_FMT, 16);
3167     wave->AddSubList(LIST_TYPE_INFO);
3168    
3169 schoenebeck 809 pSamples->push_back(pSample);
3170     return pSample;
3171     }
3172    
3173     /** @brief Delete a sample.
3174     *
3175 schoenebeck 1292 * This will delete the given Sample object from the gig file. Any
3176     * references to this sample from Regions and DimensionRegions will be
3177     * removed. You have to call Save() to make this persistent to the file.
3178 schoenebeck 809 *
3179     * @param pSample - sample to delete
3180     * @throws gig::Exception if given sample could not be found
3181     */
3182     void File::DeleteSample(Sample* pSample) {
3183 schoenebeck 823 if (!pSamples || !pSamples->size()) throw gig::Exception("Could not delete sample as there are no samples");
3184     SampleList::iterator iter = find(pSamples->begin(), pSamples->end(), (DLS::Sample*) pSample);
3185 schoenebeck 809 if (iter == pSamples->end()) throw gig::Exception("Could not delete sample, could not find given sample");
3186 schoenebeck 1083 if (SamplesIterator != pSamples->end() && *SamplesIterator == pSample) ++SamplesIterator; // avoid iterator invalidation
3187 schoenebeck 809 pSamples->erase(iter);
3188     delete pSample;
3189 persson 1266
3190     // remove all references to the sample
3191     for (Instrument* instrument = GetFirstInstrument() ; instrument ;
3192     instrument = GetNextInstrument()) {
3193     for (Region* region = instrument->GetFirstRegion() ; region ;
3194     region = instrument->GetNextRegion()) {
3195    
3196     if (region->GetSample() == pSample) region->SetSample(NULL);
3197    
3198     for (int i = 0 ; i < region->DimensionRegions ; i++) {
3199     gig::DimensionRegion *d = region->pDimensionRegions[i];
3200     if (d->pSample == pSample) d->pSample = NULL;
3201     }
3202     }
3203     }
3204 schoenebeck 809 }
3205    
3206 schoenebeck 823 void File::LoadSamples() {
3207     LoadSamples(NULL);
3208     }
3209    
3210 schoenebeck 515 void File::LoadSamples(progress_t* pProgress) {
3211 schoenebeck 930 // Groups must be loaded before samples, because samples will try
3212     // to resolve the group they belong to
3213 schoenebeck 1158 if (!pGroups) LoadGroups();
3214 schoenebeck 930
3215 schoenebeck 823 if (!pSamples) pSamples = new SampleList;
3216    
3217 persson 666 RIFF::File* file = pRIFF;
3218 schoenebeck 515
3219 persson 666 // just for progress calculation
3220     int iSampleIndex = 0;
3221     int iTotalSamples = WavePoolCount;
3222 schoenebeck 515
3223 persson 666 // check if samples should be loaded from extension files
3224     int lastFileNo = 0;
3225     for (int i = 0 ; i < WavePoolCount ; i++) {
3226     if (pWavePoolTableHi[i] > lastFileNo) lastFileNo = pWavePoolTableHi[i];
3227     }
3228 schoenebeck 780 String name(pRIFF->GetFileName());
3229     int nameLen = name.length();
3230 persson 666 char suffix[6];
3231 schoenebeck 780 if (nameLen > 4 && name.substr(nameLen - 4) == ".gig") nameLen -= 4;
3232 schoenebeck 515
3233 persson 666 for (int fileNo = 0 ; ; ) {
3234     RIFF::List* wvpl = file->GetSubList(LIST_TYPE_WVPL);
3235     if (wvpl) {
3236     unsigned long wvplFileOffset = wvpl->GetFilePos();
3237     RIFF::List* wave = wvpl->GetFirstSubList();
3238     while (wave) {
3239     if (wave->GetListType() == LIST_TYPE_WAVE) {
3240     // notify current progress
3241     const float subprogress = (float) iSampleIndex / (float) iTotalSamples;
3242     __notify_progress(pProgress, subprogress);
3243    
3244     unsigned long waveFileOffset = wave->GetFilePos();
3245     pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset, fileNo));
3246    
3247     iSampleIndex++;
3248     }
3249     wave = wvpl->GetNextSubList();
3250 schoenebeck 2 }
3251 persson 666
3252     if (fileNo == lastFileNo) break;
3253    
3254     // open extension file (*.gx01, *.gx02, ...)
3255     fileNo++;
3256     sprintf(suffix, ".gx%02d", fileNo);
3257     name.replace(nameLen, 5, suffix);
3258     file = new RIFF::File(name);
3259     ExtensionFiles.push_back(file);
3260 schoenebeck 823 } else break;
3261 schoenebeck 2 }
3262 persson 666
3263     __notify_progress(pProgress, 1.0); // notify done
3264 schoenebeck 2 }
3265    
3266     Instrument* File::GetFirstInstrument() {
3267     if (!pInstruments) LoadInstruments();
3268     if (!pInstruments) return NULL;
3269     InstrumentsIterator = pInstruments->begin();
3270 schoenebeck 823 return static_cast<gig::Instrument*>( (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL );
3271 schoenebeck 2 }
3272    
3273     Instrument* File::GetNextInstrument() {
3274     if (!pInstruments) return NULL;
3275     InstrumentsIterator++;
3276 schoenebeck 823 return static_cast<gig::Instrument*>( (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL );
3277 schoenebeck 2 }
3278    
3279 schoenebeck 21 /**
3280     * Returns the instrument with the given index.
3281     *
3282 schoenebeck 515 * @param index - number of the sought instrument (0..n)
3283     * @param pProgress - optional: callback function for progress notification
3284 schoenebeck 21 * @returns sought instrument or NULL if there's no such instrument
3285     */
3286 schoenebeck 515 Instrument* File::GetInstrument(uint index, progress_t* pProgress) {
3287     if (!pInstruments) {
3288     // TODO: hack - we simply load ALL samples here, it would have been done in the Region constructor anyway (ATM)
3289    
3290     // sample loading subtask
3291     progress_t subprogress;
3292     __divide_progress(pProgress, &subprogress, 3.0f, 0.0f); // randomly schedule 33% for this subtask
3293     __notify_progress(&subprogress, 0.0f);
3294     GetFirstSample(&subprogress); // now force all samples to be loaded
3295     __notify_progress(&subprogress, 1.0f);
3296    
3297     // instrument loading subtask
3298     if (pProgress && pProgress->callback) {
3299     subprogress.__range_min = subprogress.__range_max;
3300     subprogress.__range_max = pProgress->__range_max; // schedule remaining percentage for this subtask
3301     }
3302     __notify_progress(&subprogress, 0.0f);
3303     LoadInstruments(&subprogress);
3304     __notify_progress(&subprogress, 1.0f);
3305     }
3306 schoenebeck 21 if (!pInstruments) return NULL;
3307     InstrumentsIterator = pInstruments->begin();
3308     for (uint i = 0; InstrumentsIterator != pInstruments->end(); i++) {
3309 schoenebeck 823 if (i == index) return static_cast<gig::Instrument*>( *InstrumentsIterator );
3310 schoenebeck 21 InstrumentsIterator++;
3311     }
3312     return NULL;
3313     }
3314    
3315 schoenebeck 809 /** @brief Add a new instrument definition.
3316     *
3317     * This will create a new Instrument object for the gig file. You have
3318     * to call Save() to make this persistent to the file.
3319     *
3320     * @returns pointer to new Instrument object
3321     */
3322     Instrument* File::AddInstrument() {
3323     if (!pInstruments) LoadInstruments();
3324     __ensureMandatoryChunksExist();
3325     RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
3326     RIFF::List* lstInstr = lstInstruments->AddSubList(LIST_TYPE_INS);
3327 persson 1192
3328     // add mandatory chunks to get the chunks in right order
3329     lstInstr->AddSubList(LIST_TYPE_INFO);
3330 persson 1209 lstInstr->AddSubChunk(CHUNK_ID_DLID, 16);
3331 persson 1192
3332 schoenebeck 809 Instrument* pInstrument = new Instrument(this, lstInstr);
3333 persson 1209 pInstrument->GenerateDLSID();
3334 persson 1182
3335 persson 1192 lstInstr->AddSubChunk(CHUNK_ID_INSH, 12);
3336    
3337 persson 1182 // this string is needed for the gig to be loadable in GSt:
3338     pInstrument->pInfo->Software = "Endless Wave";
3339    
3340 schoenebeck 809 pInstruments->push_back(pInstrument);
3341     return pInstrument;
3342     }
3343    
3344     /** @brief Delete an instrument.
3345     *
3346     * This will delete the given Instrument object from the gig file. You
3347     * have to call Save() to make this persistent to the file.
3348     *
3349     * @param pInstrument - instrument to delete
3350 schoenebeck 1081 * @throws gig::Exception if given instrument could not be found
3351 schoenebeck 809 */
3352     void File::DeleteInstrument(Instrument* pInstrument) {
3353     if (!pInstruments) throw gig::Exception("Could not delete instrument as there are no instruments");
3354 schoenebeck 823 InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), (DLS::Instrument*) pInstrument);
3355 schoenebeck 809 if (iter == pInstruments->end()) throw gig::Exception("Could not delete instrument, could not find given instrument");
3356     pInstruments->erase(iter);
3357     delete pInstrument;
3358     }
3359    
3360 schoenebeck 823 void File::LoadInstruments() {
3361     LoadInstruments(NULL);
3362     }
3363    
3364 schoenebeck 515 void File::LoadInstruments(progress_t* pProgress) {
3365 schoenebeck 823 if (!pInstruments) pInstruments = new InstrumentList;
3366 schoenebeck 2 RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
3367     if (lstInstruments) {
3368 schoenebeck 515 int iInstrumentIndex = 0;
3369 schoenebeck 2 RIFF::List* lstInstr = lstInstruments->GetFirstSubList();
3370     while (lstInstr) {
3371     if (lstInstr->GetListType() == LIST_TYPE_INS) {
3372 schoenebeck 515 // notify current progress
3373     const float localProgress = (float) iInstrumentIndex / (float) Instruments;
3374     __notify_progress(pProgress, localProgress);
3375    
3376     // divide local progress into subprogress for loading current Instrument
3377     progress_t subprogress;
3378     __divide_progress(pProgress, &subprogress, Instruments, iInstrumentIndex);
3379    
3380     pInstruments->push_back(new Instrument(this, lstInstr, &subprogress));
3381    
3382     iInstrumentIndex++;
3383 schoenebeck 2 }
3384     lstInstr = lstInstruments->GetNextSubList();
3385     }
3386 schoenebeck 515 __notify_progress(pProgress, 1.0); // notify done
3387 schoenebeck 2 }
3388     }
3389    
3390 persson 1207 /// Updates the 3crc chunk with the checksum of a sample. The
3391     /// update is done directly to disk, as this method is called
3392     /// after File::Save()
3393 persson 1199 void File::SetSampleChecksum(Sample* pSample, uint32_t crc) {
3394     RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
3395     if (!_3crc) return;
3396 persson 1207
3397     // get the index of the sample
3398 persson 1199 int iWaveIndex = -1;
3399     File::SampleList::iterator iter = pSamples->begin();
3400     File::SampleList::iterator end = pSamples->end();
3401     for (int index = 0; iter != end; ++iter, ++index) {
3402     if (*iter == pSample) {
3403     iWaveIndex = index;
3404     break;
3405     }
3406     }
3407     if (iWaveIndex < 0) throw gig::Exception("Could not update crc, could not find sample");
3408    
3409 persson 1207 // write the CRC-32 checksum to disk
3410 persson 1199 _3crc->SetPos(iWaveIndex * 8);
3411     uint32_t tmp = 1;
3412     _3crc->WriteUint32(&tmp); // unknown, always 1?
3413     _3crc->WriteUint32(&crc);
3414     }
3415    
3416 schoenebeck 929 Group* File::GetFirstGroup() {
3417     if (!pGroups) LoadGroups();
3418 schoenebeck 930 // there must always be at least one group
3419 schoenebeck 929 GroupsIterator = pGroups->begin();
3420 schoenebeck 930 return *GroupsIterator;
3421 schoenebeck 929 }
3422 schoenebeck 2
3423 schoenebeck 929 Group* File::GetNextGroup() {
3424     if (!pGroups) return NULL;
3425     ++GroupsIterator;
3426     return (GroupsIterator == pGroups->end()) ? NULL : *GroupsIterator;
3427     }
3428 schoenebeck 2
3429 schoenebeck 929 /**
3430     * Returns the group with the given index.
3431     *
3432     * @param index - number of the sought group (0..n)
3433     * @returns sought group or NULL if there's no such group
3434     */
3435     Group* File::GetGroup(uint index) {
3436     if (!pGroups) LoadGroups();
3437     GroupsIterator = pGroups->begin();
3438     for (uint i = 0; GroupsIterator != pGroups->end(); i++) {
3439     if (i == index) return *GroupsIterator;
3440     ++GroupsIterator;
3441     }
3442     return NULL;
3443     }
3444    
3445     Group* File::AddGroup() {
3446     if (!pGroups) LoadGroups();
3447 schoenebeck 930 // there must always be at least one group
3448 schoenebeck 929 __ensureMandatoryChunksExist();
3449 schoenebeck 930 Group* pGroup = new Group(this, NULL);
3450 schoenebeck 929 pGroups->push_back(pGroup);
3451     return pGroup;
3452     }
3453    
3454 schoenebeck 1081 /** @brief Delete a group and its samples.
3455     *
3456     * This will delete the given Group object and all the samples that
3457     * belong to this group from the gig file. You have to call Save() to
3458     * make this persistent to the file.
3459     *
3460     * @param pGroup - group to delete
3461     * @throws gig::Exception if given group could not be found
3462     */
3463 schoenebeck 929 void File::DeleteGroup(Group* pGroup) {
3464 schoenebeck 930 if (!pGroups) LoadGroups();
3465 schoenebeck 929 std::list<Group*>::iterator iter = find(pGroups->begin(), pGroups->end(), pGroup);
3466     if (iter == pGroups->end()) throw gig::Exception("Could not delete group, could not find given group");
3467 schoenebeck 930 if (pGroups->size() == 1) throw gig::Exception("Cannot delete group, there must be at least one default group!");
3468 schoenebeck 1081 // delete all members of this group
3469     for (Sample* pSample = pGroup->GetFirstSample(); pSample; pSample = pGroup->GetNextSample()) {
3470     DeleteSample(pSample);
3471     }
3472     // now delete this group object
3473     pGroups->erase(iter);
3474     delete pGroup;
3475     }
3476    
3477     /** @brief Delete a group.
3478     *
3479     * This will delete the given Group object from the gig file. All the
3480     * samples that belong to this group will not be deleted, but instead
3481     * be moved to another group. You have to call Save() to make this
3482     * persistent to the file.
3483     *
3484     * @param pGroup - group to delete
3485     * @throws gig::Exception if given group could not be found
3486     */
3487     void File::DeleteGroupOnly(Group* pGroup) {
3488     if (!pGroups) LoadGroups();
3489     std::list<Group*>::iterator iter = find(pGroups->begin(), pGroups->end(), pGroup);
3490     if (iter == pGroups->end()) throw gig::Exception("Could not delete group, could not find given group");
3491     if (pGroups->size() == 1) throw gig::Exception("Cannot delete group, there must be at least one default group!");
3492 schoenebeck 930 // move all members of this group to another group
3493     pGroup->MoveAll();
3494 schoenebeck 929 pGroups->erase(iter);
3495     delete pGroup;
3496     }
3497    
3498     void File::LoadGroups() {
3499     if (!pGroups) pGroups = new std::list<Group*>;
3500 schoenebeck 930 // try to read defined groups from file
3501 schoenebeck 929 RIFF::List* lst3gri = pRIFF->GetSubList(LIST_TYPE_3GRI);
3502 schoenebeck 930 if (lst3gri) {
3503     RIFF::List* lst3gnl = lst3gri->GetSubList(LIST_TYPE_3GNL);
3504     if (lst3gnl) {
3505     RIFF::Chunk* ck = lst3gnl->GetFirstSubChunk();
3506     while (ck) {
3507     if (ck->GetChunkID() == CHUNK_ID_3GNM) {
3508 persson 1266 if (pVersion && pVersion->major == 3 &&
3509     strcmp(static_cast<char*>(ck->LoadChunkData()), "") == 0) break;
3510    
3511 schoenebeck 930 pGroups->push_back(new Group(this, ck));
3512     }
3513     ck = lst3gnl->GetNextSubChunk();
3514 schoenebeck 929 }
3515     }
3516     }
3517 schoenebeck 930 // if there were no group(s), create at least the mandatory default group
3518     if (!pGroups->size()) {
3519     Group* pGroup = new Group(this, NULL);
3520     pGroup->Name = "Default Group";
3521     pGroups->push_back(pGroup);
3522     }
3523 schoenebeck 929 }
3524    
3525 schoenebeck 1098 /**
3526     * Apply all the gig file's current instruments, samples, groups and settings
3527     * to the respective RIFF chunks. You have to call Save() to make changes
3528     * persistent.
3529     *
3530     * Usually there is absolutely no need to call this method explicitly.
3531     * It will be called automatically when File::Save() was called.
3532     *
3533     * @throws Exception - on errors
3534     */
3535     void File::UpdateChunks() {
3536 persson 1199 bool newFile = pRIFF->GetSubList(LIST_TYPE_INFO) == NULL;
3537 persson 1192
3538 persson 1247 b64BitWavePoolOffsets = pVersion && pVersion->major == 3;
3539    
3540 schoenebeck 1098 // first update base class's chunks
3541     DLS::File::UpdateChunks();
3542 schoenebeck 929
3543 persson 1199 if (newFile) {
3544 persson 1192 // INFO was added by Resource::UpdateChunks - make sure it
3545     // is placed first in file
3546 persson 1199 RIFF::Chunk* info = pRIFF->GetSubList(LIST_TYPE_INFO);
3547 persson 1192 RIFF::Chunk* first = pRIFF->GetFirstSubChunk();
3548     if (first != info) {
3549     pRIFF->MoveSubChunk(info, first);
3550     }
3551     }
3552    
3553 schoenebeck 1098 // update group's chunks
3554     if (pGroups) {
3555     std::list<Group*>::iterator iter = pGroups->begin();
3556     std::list<Group*>::iterator end = pGroups->end();
3557     for (; iter != end; ++iter) {
3558     (*iter)->UpdateChunks();
3559     }
3560 persson 1266
3561     // v3: make sure the file has 128 3gnm chunks
3562     if (pVersion && pVersion->major == 3) {
3563     RIFF::List* _3gnl = pRIFF->GetSubList(LIST_TYPE_3GRI)->GetSubList(LIST_TYPE_3GNL);
3564     RIFF::Chunk* _3gnm = _3gnl->GetFirstSubChunk();
3565     for (int i = 0 ; i < 128 ; i++) {
3566     if (i >= pGroups->size()) ::SaveString(CHUNK_ID_3GNM, _3gnm, _3gnl, "", "", true, 64);
3567     if (_3gnm) _3gnm = _3gnl->GetNextSubChunk();
3568     }
3569     }
3570 schoenebeck 1098 }
3571 persson 1199
3572     // update einf chunk
3573    
3574     // The einf chunk contains statistics about the gig file, such
3575     // as the number of regions and samples used by each
3576     // instrument. It is divided in equally sized parts, where the
3577     // first part contains information about the whole gig file,
3578     // and the rest of the parts map to each instrument in the
3579     // file.
3580     //
3581     // At the end of each part there is a bit map of each sample
3582     // in the file, where a set bit means that the sample is used
3583     // by the file/instrument.
3584     //
3585     // Note that there are several fields with unknown use. These
3586     // are set to zero.
3587    
3588     int sublen = pSamples->size() / 8 + 49;
3589     int einfSize = (Instruments + 1) * sublen;
3590    
3591     RIFF::Chunk* einf = pRIFF->GetSubChunk(CHUNK_ID_EINF);
3592     if (einf) {
3593     if (einf->GetSize() != einfSize) {
3594     einf->Resize(einfSize);
3595     memset(einf->LoadChunkData(), 0, einfSize);
3596     }
3597     } else if (newFile) {
3598     einf = pRIFF->AddSubChunk(CHUNK_ID_EINF, einfSize);
3599     }
3600     if (einf) {
3601     uint8_t* pData = (uint8_t*) einf->LoadChunkData();
3602    
3603     std::map<gig::Sample*,int> sampleMap;
3604     int sampleIdx = 0;
3605     for (Sample* pSample = GetFirstSample(); pSample; pSample = GetNextSample()) {
3606     sampleMap[pSample] = sampleIdx++;
3607     }
3608    
3609     int totnbusedsamples = 0;
3610     int totnbusedchannels = 0;
3611     int totnbregions = 0;
3612     int totnbdimregions = 0;
3613 persson 1264 int totnbloops = 0;
3614 persson 1199 int instrumentIdx = 0;
3615    
3616     memset(&pData[48], 0, sublen - 48);
3617    
3618     for (Instrument* instrument = GetFirstInstrument() ; instrument ;
3619     instrument = GetNextInstrument()) {
3620     int nbusedsamples = 0;
3621     int nbusedchannels = 0;
3622     int nbdimregions = 0;
3623 persson 1264 int nbloops = 0;
3624 persson 1199
3625     memset(&pData[(instrumentIdx + 1) * sublen + 48], 0, sublen - 48);
3626    
3627     for (Region* region = instrument->GetFirstRegion() ; region ;
3628     region = instrument->GetNextRegion()) {
3629     for (int i = 0 ; i < region->DimensionRegions ; i++) {
3630     gig::DimensionRegion *d = region->pDimensionRegions[i];
3631     if (d->pSample) {
3632     int sampleIdx = sampleMap[d->pSample];
3633     int byte = 48 + sampleIdx / 8;
3634     int bit = 1 << (sampleIdx & 7);
3635     if ((pData[(instrumentIdx + 1) * sublen + byte] & bit) == 0) {
3636     pData[(instrumentIdx + 1) * sublen + byte] |= bit;
3637     nbusedsamples++;
3638     nbusedchannels += d->pSample->Channels;
3639    
3640     if ((pData[byte] & bit) == 0) {
3641     pData[byte] |= bit;
3642     totnbusedsamples++;
3643     totnbusedchannels += d->pSample->Channels;
3644     }
3645     }
3646     }
3647 persson 1264 if (d->SampleLoops) nbloops++;
3648 persson 1199 }
3649     nbdimregions += region->DimensionRegions;
3650     }
3651     // first 4 bytes unknown - sometimes 0, sometimes length of einf part
3652     // store32(&pData[(instrumentIdx + 1) * sublen], sublen);
3653     store32(&pData[(instrumentIdx + 1) * sublen + 4], nbusedchannels);
3654     store32(&pData[(instrumentIdx + 1) * sublen + 8], nbusedsamples);
3655     store32(&pData[(instrumentIdx + 1) * sublen + 12], 1);
3656     store32(&pData[(instrumentIdx + 1) * sublen + 16], instrument->Regions);
3657     store32(&pData[(instrumentIdx + 1) * sublen + 20], nbdimregions);
3658 persson 1264 store32(&pData[(instrumentIdx + 1) * sublen + 24], nbloops);
3659     // next 8 bytes unknown
3660 persson 1199 store32(&pData[(instrumentIdx + 1) * sublen + 36], instrumentIdx);
3661     store32(&pData[(instrumentIdx + 1) * sublen + 40], pSamples->size());
3662     // next 4 bytes unknown
3663    
3664     totnbregions += instrument->Regions;
3665     totnbdimregions += nbdimregions;
3666 persson 1264 totnbloops += nbloops;
3667 persson 1199 instrumentIdx++;
3668     }
3669     // first 4 bytes unknown - sometimes 0, sometimes length of einf part
3670     // store32(&pData[0], sublen);
3671     store32(&pData[4], totnbusedchannels);
3672     store32(&pData[8], totnbusedsamples);
3673     store32(&pData[12], Instruments);
3674     store32(&pData[16], totnbregions);
3675     store32(&pData[20], totnbdimregions);
3676 persson 1264 store32(&pData[24], totnbloops);
3677     // next 8 bytes unknown
3678     // next 4 bytes unknown, not always 0
3679 persson 1199 store32(&pData[40], pSamples->size());
3680     // next 4 bytes unknown
3681     }
3682    
3683     // update 3crc chunk
3684    
3685     // The 3crc chunk contains CRC-32 checksums for the
3686     // samples. The actual checksum values will be filled in
3687     // later, by Sample::Write.
3688    
3689     RIFF::Chunk* _3crc = pRIFF->GetSubChunk(CHUNK_ID_3CRC);
3690     if (_3crc) {
3691     _3crc->Resize(pSamples->size() * 8);
3692     } else if (newFile) {
3693     _3crc = pRIFF->AddSubChunk(CHUNK_ID_3CRC, pSamples->size() * 8);
3694     _3crc->LoadChunkData();
3695 persson 1264
3696     // the order of einf and 3crc is not the same in v2 and v3
3697     if (einf && pVersion && pVersion->major == 3) pRIFF->MoveSubChunk(_3crc, einf);
3698 persson 1199 }
3699 schoenebeck 1098 }
3700 schoenebeck 929
3701 schoenebeck 1098
3702    
3703 schoenebeck 2 // *************** Exception ***************
3704     // *
3705    
3706     Exception::Exception(String Message) : DLS::Exception(Message) {
3707     }
3708    
3709     void Exception::PrintMessage() {
3710     std::cout << "gig::Exception: " << Message << std::endl;
3711     }
3712    
3713 schoenebeck 518
3714     // *************** functions ***************
3715     // *
3716    
3717     /**
3718     * Returns the name of this C++ library. This is usually "libgig" of
3719     * course. This call is equivalent to RIFF::libraryName() and
3720     * DLS::libraryName().
3721     */
3722     String libraryName() {
3723     return PACKAGE;
3724     }
3725    
3726     /**
3727     * Returns version of this C++ library. This call is equivalent to
3728     * RIFF::libraryVersion() and DLS::libraryVersion().
3729     */
3730     String libraryVersion() {
3731     return VERSION;
3732     }
3733    
3734 schoenebeck 2 } // namespace gig

  ViewVC Help
Powered by ViewVC