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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1292 - (hide annotations) (download)
Sat Aug 11 14:38:51 2007 UTC (16 years, 7 months ago) by schoenebeck
File size: 162574 byte(s)
just minor API doc update

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

  ViewVC Help
Powered by ViewVC