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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1264 - (show annotations) (download)
Sun Jul 29 10:51:09 2007 UTC (11 years, 10 months ago) by persson
File size: 160803 byte(s)
* added write support for 24 bit samples
* set default version to 3 when creating a new file
* more chunk order fixes
* 3ewg is now bigger in v3
* one more einf field figured out
* added some dimension strings to gigdump

1 /***************************************************************************
2 * *
3 * libgig - C++ cross-platform Gigasampler format file access library *
4 * *
5 * Copyright (C) 2003-2007 by Christian Schoenebeck *
6 * <cuse@users.sourceforge.net> *
7 * *
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 #include "helper.h"
27
28 #include <math.h>
29 #include <iostream>
30
31 /// Initial size of the sample buffer which is used for decompression of
32 /// compressed sample wave streams - this value should always be bigger than
33 /// the biggest sample piece expected to be read by the sampler engine,
34 /// otherwise the buffer size will be raised at runtime and thus the buffer
35 /// reallocated which is time consuming and unefficient.
36 #define INITIAL_SAMPLE_BUFFER_SIZE 512000 // 512 kB
37
38 /** (so far) every exponential paramater in the gig format has a basis of 1.000000008813822 */
39 #define GIG_EXP_DECODE(x) (pow(1.000000008813822, x))
40 #define GIG_EXP_ENCODE(x) (log(x) / log(1.000000008813822))
41 #define GIG_PITCH_TRACK_EXTRACT(x) (!(x & 0x01))
42 #define GIG_PITCH_TRACK_ENCODE(x) ((x) ? 0x00 : 0x01)
43 #define GIG_VCF_RESONANCE_CTRL_EXTRACT(x) ((x >> 4) & 0x03)
44 #define GIG_VCF_RESONANCE_CTRL_ENCODE(x) ((x & 0x03) << 4)
45 #define GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(x) ((x >> 1) & 0x03)
46 #define GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(x) ((x >> 3) & 0x03)
47 #define GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(x) ((x >> 5) & 0x03)
48 #define GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(x) ((x & 0x03) << 1)
49 #define GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(x) ((x & 0x03) << 3)
50 #define GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(x) ((x & 0x03) << 5)
51
52 namespace gig {
53
54 // *************** progress_t ***************
55 // *
56
57 progress_t::progress_t() {
58 callback = NULL;
59 custom = NULL;
60 __range_min = 0.0f;
61 __range_max = 1.0f;
62 }
63
64 // private helper function to convert progress of a subprocess into the global progress
65 static void __notify_progress(progress_t* pProgress, float subprogress) {
66 if (pProgress && pProgress->callback) {
67 const float totalrange = pProgress->__range_max - pProgress->__range_min;
68 const float totalprogress = pProgress->__range_min + subprogress * totalrange;
69 pProgress->factor = totalprogress;
70 pProgress->callback(pProgress); // now actually notify about the progress
71 }
72 }
73
74 // private helper function to divide a progress into subprogresses
75 static void __divide_progress(progress_t* pParentProgress, progress_t* pSubProgress, float totalTasks, float currentTask) {
76 if (pParentProgress && pParentProgress->callback) {
77 const float totalrange = pParentProgress->__range_max - pParentProgress->__range_min;
78 pSubProgress->callback = pParentProgress->callback;
79 pSubProgress->custom = pParentProgress->custom;
80 pSubProgress->__range_min = pParentProgress->__range_min + totalrange * currentTask / totalTasks;
81 pSubProgress->__range_max = pSubProgress->__range_min + totalrange / totalTasks;
82 }
83 }
84
85
86 // *************** Internal functions for sample decompression ***************
87 // *
88
89 namespace {
90
91 inline int get12lo(const unsigned char* pSrc)
92 {
93 const int x = pSrc[0] | (pSrc[1] & 0x0f) << 8;
94 return x & 0x800 ? x - 0x1000 : x;
95 }
96
97 inline int get12hi(const unsigned char* pSrc)
98 {
99 const int x = pSrc[1] >> 4 | pSrc[2] << 4;
100 return x & 0x800 ? x - 0x1000 : x;
101 }
102
103 inline int16_t get16(const unsigned char* pSrc)
104 {
105 return int16_t(pSrc[0] | pSrc[1] << 8);
106 }
107
108 inline int get24(const unsigned char* pSrc)
109 {
110 const int x = pSrc[0] | pSrc[1] << 8 | pSrc[2] << 16;
111 return x & 0x800000 ? x - 0x1000000 : x;
112 }
113
114 inline void store24(unsigned char* pDst, int x)
115 {
116 pDst[0] = x;
117 pDst[1] = x >> 8;
118 pDst[2] = x >> 16;
119 }
120
121 void Decompress16(int compressionmode, const unsigned char* params,
122 int srcStep, int dstStep,
123 const unsigned char* pSrc, int16_t* pDst,
124 unsigned long currentframeoffset,
125 unsigned long copysamples)
126 {
127 switch (compressionmode) {
128 case 0: // 16 bit uncompressed
129 pSrc += currentframeoffset * srcStep;
130 while (copysamples) {
131 *pDst = get16(pSrc);
132 pDst += dstStep;
133 pSrc += srcStep;
134 copysamples--;
135 }
136 break;
137
138 case 1: // 16 bit compressed to 8 bit
139 int y = get16(params);
140 int dy = get16(params + 2);
141 while (currentframeoffset) {
142 dy -= int8_t(*pSrc);
143 y -= dy;
144 pSrc += srcStep;
145 currentframeoffset--;
146 }
147 while (copysamples) {
148 dy -= int8_t(*pSrc);
149 y -= dy;
150 *pDst = y;
151 pDst += dstStep;
152 pSrc += srcStep;
153 copysamples--;
154 }
155 break;
156 }
157 }
158
159 void Decompress24(int compressionmode, const unsigned char* params,
160 int dstStep, const unsigned char* pSrc, uint8_t* pDst,
161 unsigned long currentframeoffset,
162 unsigned long copysamples, int truncatedBits)
163 {
164 int y, dy, ddy, dddy;
165
166 #define GET_PARAMS(params) \
167 y = get24(params); \
168 dy = y - get24((params) + 3); \
169 ddy = get24((params) + 6); \
170 dddy = get24((params) + 9)
171
172 #define SKIP_ONE(x) \
173 dddy -= (x); \
174 ddy -= dddy; \
175 dy = -dy - ddy; \
176 y += dy
177
178 #define COPY_ONE(x) \
179 SKIP_ONE(x); \
180 store24(pDst, y << truncatedBits); \
181 pDst += dstStep
182
183 switch (compressionmode) {
184 case 2: // 24 bit uncompressed
185 pSrc += currentframeoffset * 3;
186 while (copysamples) {
187 store24(pDst, get24(pSrc) << truncatedBits);
188 pDst += dstStep;
189 pSrc += 3;
190 copysamples--;
191 }
192 break;
193
194 case 3: // 24 bit compressed to 16 bit
195 GET_PARAMS(params);
196 while (currentframeoffset) {
197 SKIP_ONE(get16(pSrc));
198 pSrc += 2;
199 currentframeoffset--;
200 }
201 while (copysamples) {
202 COPY_ONE(get16(pSrc));
203 pSrc += 2;
204 copysamples--;
205 }
206 break;
207
208 case 4: // 24 bit compressed to 12 bit
209 GET_PARAMS(params);
210 while (currentframeoffset > 1) {
211 SKIP_ONE(get12lo(pSrc));
212 SKIP_ONE(get12hi(pSrc));
213 pSrc += 3;
214 currentframeoffset -= 2;
215 }
216 if (currentframeoffset) {
217 SKIP_ONE(get12lo(pSrc));
218 currentframeoffset--;
219 if (copysamples) {
220 COPY_ONE(get12hi(pSrc));
221 pSrc += 3;
222 copysamples--;
223 }
224 }
225 while (copysamples > 1) {
226 COPY_ONE(get12lo(pSrc));
227 COPY_ONE(get12hi(pSrc));
228 pSrc += 3;
229 copysamples -= 2;
230 }
231 if (copysamples) {
232 COPY_ONE(get12lo(pSrc));
233 }
234 break;
235
236 case 5: // 24 bit compressed to 8 bit
237 GET_PARAMS(params);
238 while (currentframeoffset) {
239 SKIP_ONE(int8_t(*pSrc++));
240 currentframeoffset--;
241 }
242 while (copysamples) {
243 COPY_ONE(int8_t(*pSrc++));
244 copysamples--;
245 }
246 break;
247 }
248 }
249
250 const int bytesPerFrame[] = { 4096, 2052, 768, 524, 396, 268 };
251 const int bytesPerFrameNoHdr[] = { 4096, 2048, 768, 512, 384, 256 };
252 const int headerSize[] = { 0, 4, 0, 12, 12, 12 };
253 const int bitsPerSample[] = { 16, 8, 24, 16, 12, 8 };
254 }
255
256
257
258 // *************** Other Internal functions ***************
259 // *
260
261 static split_type_t __resolveSplitType(dimension_t dimension) {
262 return (
263 dimension == dimension_layer ||
264 dimension == dimension_samplechannel ||
265 dimension == dimension_releasetrigger ||
266 dimension == dimension_keyboard ||
267 dimension == dimension_roundrobin ||
268 dimension == dimension_random ||
269 dimension == dimension_smartmidi ||
270 dimension == dimension_roundrobinkeyboard
271 ) ? split_type_bit : split_type_normal;
272 }
273
274 static int __resolveZoneSize(dimension_def_t& dimension_definition) {
275 return (dimension_definition.split_type == split_type_normal)
276 ? int(128.0 / dimension_definition.zones) : 0;
277 }
278
279
280
281 // *************** CRC ***************
282 // *
283
284 const uint32_t* CRC::table(initTable());
285
286 uint32_t* CRC::initTable() {
287 uint32_t* res = new uint32_t[256];
288
289 for (int i = 0 ; i < 256 ; i++) {
290 uint32_t c = i;
291 for (int j = 0 ; j < 8 ; j++) {
292 c = (c & 1) ? 0xedb88320 ^ (c >> 1) : c >> 1;
293 }
294 res[i] = c;
295 }
296 return res;
297 }
298
299
300
301 // *************** Sample ***************
302 // *
303
304 unsigned int Sample::Instances = 0;
305 buffer_t Sample::InternalDecompressionBuffer;
306
307 /** @brief Constructor.
308 *
309 * Load an existing sample or create a new one. A 'wave' list chunk must
310 * be given to this constructor. In case the given 'wave' list chunk
311 * contains a 'fmt', 'data' (and optionally a '3gix', 'smpl') chunk, the
312 * format and sample data will be loaded from there, otherwise default
313 * values will be used and those chunks will be created when
314 * File::Save() will be called later on.
315 *
316 * @param pFile - pointer to gig::File where this sample is
317 * located (or will be located)
318 * @param waveList - pointer to 'wave' list chunk which is (or
319 * will be) associated with this sample
320 * @param WavePoolOffset - offset of this sample data from wave pool
321 * ('wvpl') list chunk
322 * @param fileNo - number of an extension file where this sample
323 * is located, 0 otherwise
324 */
325 Sample::Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo) : DLS::Sample((DLS::File*) pFile, waveList, WavePoolOffset) {
326 static const DLS::Info::FixedStringLength fixedStringLengths[] = {
327 { CHUNK_ID_INAM, 64 },
328 { 0, 0 }
329 };
330 pInfo->FixedStringLengths = fixedStringLengths;
331 Instances++;
332 FileNo = fileNo;
333
334 pCk3gix = waveList->GetSubChunk(CHUNK_ID_3GIX);
335 if (pCk3gix) {
336 uint16_t iSampleGroup = pCk3gix->ReadInt16();
337 pGroup = pFile->GetGroup(iSampleGroup);
338 } else { // '3gix' chunk missing
339 // by default assigned to that mandatory "Default Group"
340 pGroup = pFile->GetGroup(0);
341 }
342
343 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 SamplePeriod = uint32_t(1000000000.0 / SamplesPerSecond + 0.5);
365 MIDIUnityNote = 60;
366 FineTune = 0;
367 SMPTEFormat = smpte_format_no_offset;
368 SMPTEOffset = 0;
369 Loops = 0;
370 LoopID = 0;
371 LoopType = loop_type_normal;
372 LoopStart = 0;
373 LoopEnd = 0;
374 LoopFraction = 0;
375 LoopPlayCount = 0;
376 }
377
378 FrameTable = NULL;
379 SamplePos = 0;
380 RAMCache.Size = 0;
381 RAMCache.pStart = NULL;
382 RAMCache.NullExtensionSize = 0;
383
384 if (BitDepth > 24) throw gig::Exception("Only samples up to 24 bit supported");
385
386 RIFF::Chunk* ewav = waveList->GetSubChunk(CHUNK_ID_EWAV);
387 Compressed = ewav;
388 Dithered = false;
389 TruncatedBits = 0;
390 if (Compressed) {
391 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 ScanCompressedSample();
398 }
399
400 // we use a buffer for decompression and for truncating 24 bit samples to 16 bit
401 if ((Compressed || BitDepth == 24) && !InternalDecompressionBuffer.Size) {
402 InternalDecompressionBuffer.pStart = new unsigned char[INITIAL_SAMPLE_BUFFER_SIZE];
403 InternalDecompressionBuffer.Size = INITIAL_SAMPLE_BUFFER_SIZE;
404 }
405 FrameOffset = 0; // just for streaming compressed samples
406
407 LoopSize = LoopEnd - LoopStart + 1;
408 }
409
410 /**
411 * Apply sample and its settings to the respective RIFF chunks. You have
412 * to call File::Save() to make changes persistent.
413 *
414 * Usually there is absolutely no need to call this method explicitly.
415 * It will be called automatically when File::Save() was called.
416 *
417 * @throws DLS::Exception if FormatTag != DLS_WAVE_FORMAT_PCM or no sample data
418 * was provided yet
419 * @throws gig::Exception if there is any invalid sample setting
420 */
421 void Sample::UpdateChunks() {
422 // first update base class's chunks
423 DLS::Sample::UpdateChunks();
424
425 // make sure 'smpl' chunk exists
426 pCkSmpl = pWaveList->GetSubChunk(CHUNK_ID_SMPL);
427 if (!pCkSmpl) {
428 pCkSmpl = pWaveList->AddSubChunk(CHUNK_ID_SMPL, 60);
429 memset(pCkSmpl->LoadChunkData(), 0, 60);
430 }
431 // update 'smpl' chunk
432 uint8_t* pData = (uint8_t*) pCkSmpl->LoadChunkData();
433 SamplePeriod = uint32_t(1000000000.0 / SamplesPerSecond + 0.5);
434 store32(&pData[0], Manufacturer);
435 store32(&pData[4], Product);
436 store32(&pData[8], SamplePeriod);
437 store32(&pData[12], MIDIUnityNote);
438 store32(&pData[16], FineTune);
439 store32(&pData[20], SMPTEFormat);
440 store32(&pData[24], SMPTEOffset);
441 store32(&pData[28], Loops);
442
443 // we skip 'manufByt' for now (4 bytes)
444
445 store32(&pData[36], LoopID);
446 store32(&pData[40], LoopType);
447 store32(&pData[44], LoopStart);
448 store32(&pData[48], LoopEnd);
449 store32(&pData[52], LoopFraction);
450 store32(&pData[56], LoopPlayCount);
451
452 // make sure '3gix' chunk exists
453 pCk3gix = pWaveList->GetSubChunk(CHUNK_ID_3GIX);
454 if (!pCk3gix) pCk3gix = pWaveList->AddSubChunk(CHUNK_ID_3GIX, 4);
455 // determine appropriate sample group index (to be stored in chunk)
456 uint16_t iSampleGroup = 0; // 0 refers to default sample group
457 File* pFile = static_cast<File*>(pParent);
458 if (pFile->pGroups) {
459 std::list<Group*>::iterator iter = pFile->pGroups->begin();
460 std::list<Group*>::iterator end = pFile->pGroups->end();
461 for (int i = 0; iter != end; i++, iter++) {
462 if (*iter == pGroup) {
463 iSampleGroup = i;
464 break; // found
465 }
466 }
467 }
468 // update '3gix' chunk
469 pData = (uint8_t*) pCk3gix->LoadChunkData();
470 store16(&pData[0], iSampleGroup);
471 }
472
473 /// Scans compressed samples for mandatory informations (e.g. actual number of total sample points).
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 SamplesPerFrame = BitDepth == 24 ? 256 : 2048;
480 WorstCaseFrameSize = SamplesPerFrame * FrameSize + Channels; // +Channels for compression flag
481
482 // Scanning
483 pCkData->SetPos(0);
484 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 break;
501 }
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 break;
519 }
520 SamplesTotal += SamplesPerFrame;
521 pCkData->SetPos(frameSize, RIFF::stream_curpos);
522 }
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 * @code
562 * buffer_t buf = pSample->LoadSampleData(acquired_samples);
563 * long cachedsamples = buf.Size / pSample->FrameSize;
564 * @endcode
565 *
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 * @code
611 * buffer_t buf = pSample->LoadSampleDataWithNullSamplesExtension(acquired_samples, null_samples);
612 * long cachedsamples = buf.Size / pSample->FrameSize;
613 * @endcode
614 * 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 /** @brief Resize sample.
674 *
675 * Resizes the sample's wave form data, that is the actual size of
676 * sample wave data possible to be written for this sample. This call
677 * will return immediately and just schedule the resize operation. You
678 * should call File::Save() to actually perform the resize operation(s)
679 * "physically" to the file. As this can take a while on large files, it
680 * is recommended to call Resize() first on all samples which have to be
681 * resized and finally to call File::Save() to perform all those resize
682 * operations in one rush.
683 *
684 * The actual size (in bytes) is dependant to the current FrameSize
685 * value. You may want to set FrameSize before calling Resize().
686 *
687 * <b>Caution:</b> You cannot directly write (i.e. with Write()) to
688 * enlarged samples before calling File::Save() as this might exceed the
689 * current sample's boundary!
690 *
691 * Also note: only DLS_WAVE_FORMAT_PCM is currently supported, that is
692 * FormatTag must be DLS_WAVE_FORMAT_PCM. Trying to resize samples with
693 * other formats will fail!
694 *
695 * @param iNewSize - new sample wave data size in sample points (must be
696 * greater than zero)
697 * @throws DLS::Excecption if FormatTag != DLS_WAVE_FORMAT_PCM
698 * or if \a iNewSize is less than 1
699 * @throws gig::Exception if existing sample is compressed
700 * @see DLS::Sample::GetSize(), DLS::Sample::FrameSize,
701 * DLS::Sample::FormatTag, File::Save()
702 */
703 void Sample::Resize(int iNewSize) {
704 if (Compressed) throw gig::Exception("There is no support for modifying compressed samples (yet)");
705 DLS::Sample::Resize(iNewSize);
706 }
707
708 /**
709 * Sets the position within the sample (in sample points, not in
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 * 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 * @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 * 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 * <b>Caution:</b> If you are using more than one streaming thread, you
790 * have to use an external decompression buffer for <b>EACH</b>
791 * streaming thread to avoid race conditions and crashes!
792 *
793 * @param pBuffer destination buffer
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 * @param pDimRgn dimension region with looping information
798 * @param pExternalDecompressionBuffer (optional) external buffer to use for decompression
799 * @returns number of successfully read sample points
800 * @see CreateDecompressionBuffer()
801 */
802 unsigned long Sample::ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState,
803 DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer) {
804 unsigned long samplestoread = SampleCount, totalreadsamples = 0, readsamples, samplestoloopend;
805 uint8_t* pDst = (uint8_t*) pBuffer;
806
807 SetPos(pPlaybackState->position); // recover position from the last time
808
809 if (pDimRgn->SampleLoops) { // honor looping if there are loop points defined
810
811 const DLS::sample_loop_t& loop = pDimRgn->pSampleLoops[0];
812 const uint32_t loopEnd = loop.LoopStart + loop.LoopLength;
813
814 if (GetPos() <= loopEnd) {
815 switch (loop.LoopType) {
816
817 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
822 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
836 // as we can only read forward from disk, we have to
837 // determine the end position within the loop first,
838 // read forward from that 'end' and finally after
839 // reading, swap all sample frames so it reflects
840 // backward playback
841
842 unsigned long swapareastart = totalreadsamples;
843 unsigned long loopoffset = GetPos() - loop.LoopStart;
844 unsigned long samplestoreadinloop = Min(samplestoread, loopoffset);
845 unsigned long reverseplaybackend = GetPos() - samplestoreadinloop;
846
847 SetPos(reverseplaybackend);
848
849 // read samples for backward playback
850 do {
851 readsamples = Read(&pDst[totalreadsamples * this->FrameSize], samplestoreadinloop, pExternalDecompressionBuffer);
852 samplestoreadinloop -= readsamples;
853 samplestoread -= readsamples;
854 totalreadsamples += readsamples;
855 } while (samplestoreadinloop && readsamples);
856
857 SetPos(reverseplaybackend); // pretend we really read backwards
858
859 if (reverseplaybackend == loop.LoopStart) {
860 pPlaybackState->loop_cycles_left--;
861 pPlaybackState->reverse = false;
862 }
863
864 // reverse the sample frames for backward playback
865 SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
866 }
867 } while (samplestoread && readsamples);
868 break;
869 }
870
871 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
884 if (!samplestoread) break;
885
886 // 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
892 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
898 SetPos(reverseplaybackend);
899
900 // 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
915 SetPos(reverseplaybackend); // pretend we really read backwards
916
917 // reverse the sample frames for backward playback
918 SwapMemoryArea(&pDst[swapareastart * this->FrameSize], (totalreadsamples - swapareastart) * this->FrameSize, this->FrameSize);
919 break;
920 }
921
922 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 }
938 }
939 }
940
941 // read on without looping
942 if (samplestoread) do {
943 readsamples = Read(&pDst[totalreadsamples * this->FrameSize], samplestoread, pExternalDecompressionBuffer);
944 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 * 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 * <b>Caution:</b> If you are using more than one streaming thread, you
963 * have to use an external decompression buffer for <b>EACH</b>
964 * streaming thread to avoid race conditions and crashes!
965 *
966 * For 16 bit samples, the data in the buffer will be int16_t
967 * (using native endianness). For 24 bit, the buffer will
968 * contain three bytes per sample, little-endian.
969 *
970 * @param pBuffer destination buffer
971 * @param SampleCount number of sample points to read
972 * @param pExternalDecompressionBuffer (optional) external buffer to use for decompression
973 * @returns number of successfully read sample points
974 * @see SetPos(), CreateDecompressionBuffer()
975 */
976 unsigned long Sample::Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer) {
977 if (SampleCount == 0) return 0;
978 if (!Compressed) {
979 if (BitDepth == 24) {
980 return pCkData->Read(pBuffer, SampleCount * FrameSize, 1) / FrameSize;
981 }
982 else { // 16 bit
983 // (pCkData->Read does endian correction)
984 return Channels == 2 ? pCkData->Read(pBuffer, SampleCount << 1, 2) >> 1
985 : pCkData->Read(pBuffer, SampleCount, 2);
986 }
987 }
988 else {
989 if (this->SamplePos >= this->SamplesTotal) return 0;
990 //TODO: efficiency: maybe we should test for an average compression rate
991 unsigned long assumedsize = GuessSize(SampleCount),
992 remainingbytes = 0, // remaining bytes in the local buffer
993 remainingsamples = SampleCount,
994 copysamples, skipsamples,
995 currentframeoffset = this->FrameOffset; // offset in current sample frame since last Read()
996 this->FrameOffset = 0;
997
998 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 }
1007
1008 unsigned char* pSrc = (unsigned char*) pDecompressionBuffer->pStart;
1009 int16_t* pDst = static_cast<int16_t*>(pBuffer);
1010 uint8_t* pDst24 = static_cast<uint8_t*>(pBuffer);
1011 remainingbytes = pCkData->Read(pSrc, assumedsize, 1);
1012
1013 while (remainingsamples && remainingbytes) {
1014 unsigned long framesamples = SamplesPerFrame;
1015 unsigned long framebytes, rightChannelOffset = 0, nextFrameOffset;
1016
1017 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 }
1033 }
1034 else {
1035 framebytes = bytesPerFrame[mode_l] + 1;
1036 nextFrameOffset = bytesPerFrameNoHdr[mode_l];
1037 if (remainingbytes < framebytes) {
1038 framesamples = SamplesInLastFrame;
1039 }
1040 }
1041
1042 // determine how many samples in this frame to skip and read
1043 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 }
1053 else {
1054 // This frame has enough data for pBuffer, but not
1055 // all of the frame is needed. Set file position
1056 // to start of this frame for next call to Read.
1057 copysamples = remainingsamples;
1058 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 pCkData->SetPos(remainingbytes, RIFF::stream_backward);
1073 }
1074 }
1075 else remainingbytes = 0;
1076
1077 currentframeoffset -= skipsamples;
1078
1079 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
1088 if (Channels == 2) { // Stereo
1089 const unsigned char* const param_r = pSrc;
1090 if (mode_r != 2) pSrc += 12;
1091
1092 Decompress24(mode_l, param_l, 6, pSrc, pDst24,
1093 skipsamples, copysamples, TruncatedBits);
1094 Decompress24(mode_r, param_r, 6, pSrc + rightChannelOffset, pDst24 + 3,
1095 skipsamples, copysamples, TruncatedBits);
1096 pDst24 += copysamples * 6;
1097 }
1098 else { // Mono
1099 Decompress24(mode_l, param_l, 3, pSrc, pDst24,
1100 skipsamples, copysamples, TruncatedBits);
1101 pDst24 += copysamples * 3;
1102 }
1103 }
1104 else { // 16 bit
1105 if (mode_l) pSrc += 4;
1106
1107 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 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 skipsamples, copysamples);
1116 pDst += copysamples << 1;
1117 }
1118 else { // Mono
1119 step = 2 - mode_l;
1120 Decompress16(mode_l, param_l, step, 1, pSrc, pDst, skipsamples, copysamples);
1121 pDst += copysamples;
1122 }
1123 }
1124 pSrc += nextFrameOffset;
1125 }
1126
1127 // reload from disk to local buffer if needed
1128 if (remainingsamples && remainingbytes < WorstCaseFrameSize && pCkData->GetState() == RIFF::stream_ready) {
1129 assumedsize = GuessSize(remainingsamples);
1130 pCkData->SetPos(remainingbytes, RIFF::stream_backward);
1131 if (pCkData->RemainingBytes() < assumedsize) assumedsize = pCkData->RemainingBytes();
1132 remainingbytes = pCkData->Read(pDecompressionBuffer->pStart, assumedsize, 1);
1133 pSrc = (unsigned char*) pDecompressionBuffer->pStart;
1134 }
1135 } // while
1136
1137 this->SamplePos += (SampleCount - remainingsamples);
1138 if (this->SamplePos > this->SamplesTotal) this->SamplePos = this->SamplesTotal;
1139 return (SampleCount - remainingsamples);
1140 }
1141 }
1142
1143 /** @brief Write sample wave data.
1144 *
1145 * Writes \a SampleCount number of sample points from the buffer pointed
1146 * by \a pBuffer and increments the position within the sample. Use this
1147 * method to directly write the sample data to disk, i.e. if you don't
1148 * want or cannot load the whole sample data into RAM.
1149 *
1150 * You have to Resize() the sample to the desired size and call
1151 * File::Save() <b>before</b> using Write().
1152 *
1153 * Note: there is currently no support for writing compressed samples.
1154 *
1155 * For 16 bit samples, the data in the source buffer should be
1156 * int16_t (using native endianness). For 24 bit, the buffer
1157 * should contain three bytes per sample, little-endian.
1158 *
1159 * @param pBuffer - source buffer
1160 * @param SampleCount - number of sample points to write
1161 * @throws DLS::Exception if current sample size is too small
1162 * @throws gig::Exception if sample is compressed
1163 * @see DLS::LoadSampleData()
1164 */
1165 unsigned long Sample::Write(void* pBuffer, unsigned long SampleCount) {
1166 if (Compressed) throw gig::Exception("There is no support for writing compressed gig samples (yet)");
1167
1168 // if this is the first write in this sample, reset the
1169 // checksum calculator
1170 if (pCkData->GetPos() == 0) {
1171 crc.reset();
1172 }
1173 if (GetSize() < SampleCount) throw Exception("Could not write sample data, current sample size to small");
1174 unsigned long res;
1175 if (BitDepth == 24) {
1176 res = pCkData->Write(pBuffer, SampleCount * FrameSize, 1) / FrameSize;
1177 } else { // 16 bit
1178 res = Channels == 2 ? pCkData->Write(pBuffer, SampleCount << 1, 2) >> 1
1179 : pCkData->Write(pBuffer, SampleCount, 2);
1180 }
1181 crc.update((unsigned char *)pBuffer, SampleCount * FrameSize);
1182
1183 // if this is the last write, update the checksum chunk in the
1184 // file
1185 if (pCkData->GetPos() == pCkData->GetSize()) {
1186 File* pFile = static_cast<File*>(GetParent());
1187 pFile->SetSampleChecksum(this, crc.getValue());
1188 }
1189 return res;
1190 }
1191
1192 /**
1193 * Allocates a decompression buffer for streaming (compressed) samples
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 /**
1235 * Returns pointer to the Group this Sample belongs to. In the .gig
1236 * format a sample always belongs to one group. If it wasn't explicitly
1237 * assigned to a certain group, it will be automatically assigned to a
1238 * default group.
1239 *
1240 * @returns Sample's Group (never NULL)
1241 */
1242 Group* Sample::GetGroup() const {
1243 return pGroup;
1244 }
1245
1246 Sample::~Sample() {
1247 Instances--;
1248 if (!Instances && InternalDecompressionBuffer.Size) {
1249 delete[] (unsigned char*) InternalDecompressionBuffer.pStart;
1250 InternalDecompressionBuffer.pStart = NULL;
1251 InternalDecompressionBuffer.Size = 0;
1252 }
1253 if (FrameTable) delete[] FrameTable;
1254 if (RAMCache.pStart) delete[] (int8_t*) RAMCache.pStart;
1255 }
1256
1257
1258
1259 // *************** DimensionRegion ***************
1260 // *
1261
1262 uint DimensionRegion::Instances = 0;
1263 DimensionRegion::VelocityTableMap* DimensionRegion::pVelocityTables = NULL;
1264
1265 DimensionRegion::DimensionRegion(RIFF::List* _3ewl) : DLS::Sampler(_3ewl) {
1266 Instances++;
1267
1268 pSample = NULL;
1269
1270 if (_3ewl->GetSubChunk(CHUNK_ID_WSMP)) memcpy(&Crossfade, &SamplerOptions, 4);
1271 else memset(&Crossfade, 0, 4);
1272
1273 if (!pVelocityTables) pVelocityTables = new VelocityTableMap;
1274
1275 RIFF::Chunk* _3ewa = _3ewl->GetSubChunk(CHUNK_ID_3EWA);
1276 if (_3ewa) { // if '3ewa' chunk exists
1277 _3ewa->ReadInt32(); // unknown, always == chunk size ?
1278 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 if (_3ewa->RemainingBytes() >= 8) {
1423 _3ewa->Read(DimensionUpperLimits, 1, 8);
1424 } else {
1425 memset(DimensionUpperLimits, 0, 8);
1426 }
1427 } 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 EG1Decay1 = 0.005;
1437 EG1Sustain = 1000;
1438 EG1Release = 0.3;
1439 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 EG2Decay1 = 0.005;
1454 EG2Sustain = 1000;
1455 EG2Release = 0.3;
1456 LFO2ControlDepth = 0;
1457 LFO2Frequency = 1.0;
1458 LFO2InternalDepth = 0;
1459 EG1Decay2 = 0.0;
1460 EG1InfiniteSustain = true;
1461 EG1PreAttack = 0;
1462 EG2Decay2 = 0.0;
1463 EG2InfiniteSustain = true;
1464 EG2PreAttack = 0;
1465 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 memset(DimensionUpperLimits, 127, 8);
1508 }
1509
1510 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 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 VCFCutoffController <= vcf_cutoff_ctrl_none2 ? VCFVelocityScale : 0);
1540
1541 SampleAttenuation = pow(10.0, -Gain / (20.0 * 655360));
1542 VelocityTable = 0;
1543 }
1544
1545 /**
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 // check if wsmp is going to be created by
1554 // DLS::Sampler::UpdateChunks
1555 bool wsmp_created = !pParentList->GetSubChunk(CHUNK_ID_WSMP);
1556
1557 // first update base class's chunk
1558 DLS::Sampler::UpdateChunks();
1559
1560 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 // 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 else if (wsmp_created) {
1571 // make sure the chunk order is: wsmp, 3ewa
1572 pParentList->MoveSubChunk(_3ewa, 0);
1573 }
1574 pData = (uint8_t*) _3ewa->LoadChunkData();
1575
1576 // update '3ewa' chunk with DimensionRegion's current settings
1577
1578 const uint32_t chunksize = _3ewa->GetNewSize();
1579 store32(&pData[0], chunksize); // unknown, always chunk size?
1580
1581 const int32_t lfo3freq = (int32_t) GIG_EXP_ENCODE(LFO3Frequency);
1582 store32(&pData[4], lfo3freq);
1583
1584 const int32_t eg3attack = (int32_t) GIG_EXP_ENCODE(EG3Attack);
1585 store32(&pData[8], eg3attack);
1586
1587 // next 2 bytes unknown
1588
1589 store16(&pData[14], LFO1InternalDepth);
1590
1591 // next 2 bytes unknown
1592
1593 store16(&pData[18], LFO3InternalDepth);
1594
1595 // next 2 bytes unknown
1596
1597 store16(&pData[22], LFO1ControlDepth);
1598
1599 // next 2 bytes unknown
1600
1601 store16(&pData[26], LFO3ControlDepth);
1602
1603 const int32_t eg1attack = (int32_t) GIG_EXP_ENCODE(EG1Attack);
1604 store32(&pData[28], eg1attack);
1605
1606 const int32_t eg1decay1 = (int32_t) GIG_EXP_ENCODE(EG1Decay1);
1607 store32(&pData[32], eg1decay1);
1608
1609 // next 2 bytes unknown
1610
1611 store16(&pData[38], EG1Sustain);
1612
1613 const int32_t eg1release = (int32_t) GIG_EXP_ENCODE(EG1Release);
1614 store32(&pData[40], eg1release);
1615
1616 const uint8_t eg1ctl = (uint8_t) EncodeLeverageController(EG1Controller);
1617 pData[44] = eg1ctl;
1618
1619 const uint8_t eg1ctrloptions =
1620 (EG1ControllerInvert) ? 0x01 : 0x00 |
1621 GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG1ControllerAttackInfluence) |
1622 GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG1ControllerDecayInfluence) |
1623 GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG1ControllerReleaseInfluence);
1624 pData[45] = eg1ctrloptions;
1625
1626 const uint8_t eg2ctl = (uint8_t) EncodeLeverageController(EG2Controller);
1627 pData[46] = eg2ctl;
1628
1629 const uint8_t eg2ctrloptions =
1630 (EG2ControllerInvert) ? 0x01 : 0x00 |
1631 GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE(EG2ControllerAttackInfluence) |
1632 GIG_EG_CTR_DECAY_INFLUENCE_ENCODE(EG2ControllerDecayInfluence) |
1633 GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE(EG2ControllerReleaseInfluence);
1634 pData[47] = eg2ctrloptions;
1635
1636 const int32_t lfo1freq = (int32_t) GIG_EXP_ENCODE(LFO1Frequency);
1637 store32(&pData[48], lfo1freq);
1638
1639 const int32_t eg2attack = (int32_t) GIG_EXP_ENCODE(EG2Attack);
1640 store32(&pData[52], eg2attack);
1641
1642 const int32_t eg2decay1 = (int32_t) GIG_EXP_ENCODE(EG2Decay1);
1643 store32(&pData[56], eg2decay1);
1644
1645 // next 2 bytes unknown
1646
1647 store16(&pData[62], EG2Sustain);
1648
1649 const int32_t eg2release = (int32_t) GIG_EXP_ENCODE(EG2Release);
1650 store32(&pData[64], eg2release);
1651
1652 // next 2 bytes unknown
1653
1654 store16(&pData[70], LFO2ControlDepth);
1655
1656 const int32_t lfo2freq = (int32_t) GIG_EXP_ENCODE(LFO2Frequency);
1657 store32(&pData[72], lfo2freq);
1658
1659 // next 2 bytes unknown
1660
1661 store16(&pData[78], LFO2InternalDepth);
1662
1663 const int32_t eg1decay2 = (int32_t) (EG1InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG1Decay2);
1664 store32(&pData[80], eg1decay2);
1665
1666 // next 2 bytes unknown
1667
1668 store16(&pData[86], EG1PreAttack);
1669
1670 const int32_t eg2decay2 = (int32_t) (EG2InfiniteSustain) ? 0x7fffffff : (int32_t) GIG_EXP_ENCODE(EG2Decay2);
1671 store32(&pData[88], eg2decay2);
1672
1673 // next 2 bytes unknown
1674
1675 store16(&pData[94], EG2PreAttack);
1676
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 pData[96] = velocityresponse;
1694 }
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 pData[97] = releasevelocityresponse;
1713 }
1714
1715 pData[98] = VelocityResponseCurveScaling;
1716
1717 pData[99] = AttenuationControllerThreshold;
1718
1719 // next 4 bytes unknown
1720
1721 store16(&pData[104], SampleStartOffset);
1722
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 pData[108] = pitchTrackDimensionBypass;
1741 }
1742
1743 const uint8_t pan = (Pan >= 0) ? Pan : ((-Pan) + 63); // signed 8 bit -> signed 7 bit
1744 pData[109] = pan;
1745
1746 const uint8_t selfmask = (SelfMask) ? 0x01 : 0x00;
1747 pData[110] = selfmask;
1748
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 pData[112] = lfo3ctrl;
1757 }
1758
1759 const uint8_t attenctl = EncodeLeverageController(AttenuationController);
1760 pData[113] = attenctl;
1761
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 pData[114] = lfo2ctrl;
1768 }
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 pData[115] = lfo1ctrl;
1777 }
1778
1779 const uint16_t eg3depth = (EG3Depth >= 0) ? EG3Depth
1780 : uint16_t(((-EG3Depth) - 1) ^ 0xffff); /* binary complementary for negatives */
1781 pData[116] = eg3depth;
1782
1783 // next 2 bytes unknown
1784
1785 const uint8_t channeloffset = ChannelOffset * 4;
1786 pData[120] = channeloffset;
1787
1788 {
1789 uint8_t regoptions = 0;
1790 if (MSDecode) regoptions |= 0x01; // bit 0
1791 if (SustainDefeat) regoptions |= 0x02; // bit 1
1792 pData[121] = regoptions;
1793 }
1794
1795 // next 2 bytes unknown
1796
1797 pData[124] = VelocityUpperLimit;
1798
1799 // next 3 bytes unknown
1800
1801 pData[128] = ReleaseTriggerDecay;
1802
1803 // next 2 bytes unknown
1804
1805 const uint8_t eg1hold = (EG1Hold) ? 0x80 : 0x00; // bit 7
1806 pData[131] = eg1hold;
1807
1808 const uint8_t vcfcutoff = (VCFEnabled) ? 0x80 : 0x00 | /* bit 7 */
1809 (VCFCutoff & 0x7f); /* lower 7 bits */
1810 pData[132] = vcfcutoff;
1811
1812 pData[133] = VCFCutoffController;
1813
1814 const uint8_t vcfvelscale = (VCFCutoffControllerInvert) ? 0x80 : 0x00 | /* bit 7 */
1815 (VCFVelocityScale & 0x7f); /* lower 7 bits */
1816 pData[134] = vcfvelscale;
1817
1818 // next byte unknown
1819
1820 const uint8_t vcfresonance = (VCFResonanceDynamic) ? 0x00 : 0x80 | /* bit 7 */
1821 (VCFResonance & 0x7f); /* lower 7 bits */
1822 pData[136] = vcfresonance;
1823
1824 const uint8_t vcfbreakpoint = (VCFKeyboardTracking) ? 0x80 : 0x00 | /* bit 7 */
1825 (VCFKeyboardTrackingBreakpoint & 0x7f); /* lower 7 bits */
1826 pData[137] = vcfbreakpoint;
1827
1828 const uint8_t vcfvelocity = VCFVelocityDynamicRange % 5 |
1829 VCFVelocityCurve * 5;
1830 pData[138] = vcfvelocity;
1831
1832 const uint8_t vcftype = (VCFType == vcf_type_lowpassturbo) ? vcf_type_lowpass : VCFType;
1833 pData[139] = vcftype;
1834
1835 if (chunksize >= 148) {
1836 memcpy(&pData[140], DimensionUpperLimits, 8);
1837 }
1838 }
1839
1840 // 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 if (pVelocityTables->count(tableKey)) { // if key exists
1846 table = (*pVelocityTables)[tableKey];
1847 }
1848 else {
1849 table = CreateVelocityTable(curveType, depth, scaling);
1850 (*pVelocityTables)[tableKey] = table; // put the new table into the tables map
1851 }
1852 return table;
1853 }
1854
1855 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
1872 // 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
1966 // unknown controller type
1967 default:
1968 throw gig::Exception("Unknown leverage controller type.");
1969 }
1970 return decodedcontroller;
1971 }
1972
1973 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 break;
2063 default:
2064 throw gig::Exception("Unknown leverage controller type.");
2065 }
2066 return encodedcontroller;
2067 }
2068
2069 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 if (VelocityTable) delete[] VelocityTable;
2083 }
2084
2085 /**
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 * @param MIDIKeyVelocity MIDI velocity value of the triggered key (between 0 and 127)
2094 * @returns amplitude factor (between 0.0 and 1.0)
2095 */
2096 double DimensionRegion::GetVelocityAttenuation(uint8_t MIDIKeyVelocity) {
2097 return pVelocityAttenuationTable[MIDIKeyVelocity];
2098 }
2099
2100 double DimensionRegion::GetVelocityRelease(uint8_t MIDIKeyVelocity) {
2101 return pVelocityReleaseTable[MIDIKeyVelocity];
2102 }
2103
2104 double DimensionRegion::GetVelocityCutoff(uint8_t MIDIKeyVelocity) {
2105 return pVelocityCutoffTable[MIDIKeyVelocity];
2106 }
2107
2108 double* DimensionRegion::CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling) {
2109
2110 // line-segment approximations of the 15 velocity curves
2111
2112 // 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
2119 // non-linear
2120 const int non0[] = { 1, 4, 24, 5, 57, 17, 92, 57, 122, 127, 127, 127 };
2121 const int non1[] = { 1, 4, 46, 9, 93, 56, 118, 106, 123, 127,
2122 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
2129 // special
2130 const int spe0[] = { 1, 2, 76, 10, 90, 15, 95, 20, 99, 28, 103, 44,
2131 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 const int spe2[] = { 1, 1, 33, 1, 53, 5, 61, 13, 69, 32, 79, 74,
2135 85, 90, 91, 127, 127, 127 };
2136 const int spe3[] = { 1, 32, 28, 35, 66, 48, 89, 59, 95, 65, 99, 73,
2137 117, 127, 127, 127 };
2138 const int spe4[] = { 1, 4, 23, 5, 49, 13, 57, 17, 92, 57, 122, 127,
2139 127, 127 };
2140
2141 // 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 const int* const curves[] = { non0, non1, non2, non3, non4,
2146 lin0, lin1, lin2, lin3, lin4,
2147 spe0, spe1, spe2, spe3, spe4, spe5 };
2148
2149 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
2154 table[0] = 0;
2155 for (int x = 1 ; x < 128 ; x++) {
2156
2157 if (x > curve[2]) curve += 2;
2158 double y = curve[1] + (x - curve[0]) *
2159 (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 // *************** Region ***************
2177 // *
2178
2179 Region::Region(Instrument* pInstrument, RIFF::List* rgnList) : DLS::Region((DLS::Instrument*) pInstrument, rgnList) {
2180 // Initialization
2181 Dimensions = 0;
2182 for (int i = 0; i < 256; i++) {
2183 pDimensionRegions[i] = NULL;
2184 }
2185 Layers = 1;
2186 File* file = (File*) GetParent()->GetParent();
2187 int dimensionBits = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;
2188
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 for (int i = 0; i < dimensionBits; i++) {
2197 dimension_t dimension = static_cast<dimension_t>(_3lnk->ReadUint8());
2198 uint8_t bits = _3lnk->ReadUint8();
2199 _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 uint8_t zones = _3lnk->ReadUint8(); // new for v3: number of zones doesn't have to be == pow(2,bits)
2202 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 pDimensionDefinitions[i].zones = zones ? zones : 0x01 << bits; // = pow(2,bits)
2213 pDimensionDefinitions[i].split_type = __resolveSplitType(dimension);
2214 pDimensionDefinitions[i].zone_size = __resolveZoneSize(pDimensionDefinitions[i]);
2215 Dimensions++;
2216
2217 // if this is a layer dimension, remember the amount of layers
2218 if (dimension == dimension_layer) Layers = pDimensionDefinitions[i].zones;
2219 }
2220 _3lnk->SetPos(3, RIFF::stream_curpos); // jump forward to next dimension definition
2221 }
2222 for (int i = dimensionBits ; i < 8 ; i++) pDimensionDefinitions[i].bits = 0;
2223
2224 // if there's a velocity dimension and custom velocity zone splits are used,
2225 // update the VelocityTables in the dimension regions
2226 UpdateVelocityTable();
2227
2228 // 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 // load sample references
2235 for (uint i = 0; i < DimensionRegions; i++) {
2236 uint32_t wavepoolindex = _3lnk->ReadUint32();
2237 if (file->pWavePoolTable) pDimensionRegions[i]->pSample = GetSampleFromWavePool(wavepoolindex);
2238 }
2239 GetSample(); // load global region sample reference
2240 } else {
2241 DimensionRegions = 0;
2242 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 }
2248
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 }
2258
2259 /**
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 // 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 // first update base class's chunks
2276 DLS::Region::UpdateChunks();
2277
2278 File* pFile = (File*) GetParent()->GetParent();
2279 bool version3 = pFile->pVersion && pFile->pVersion->major == 3;
2280
2281 // update dimension region's chunks
2282 for (int i = 0; i < DimensionRegions; i++) {
2283 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 }
2293
2294 const int iMaxDimensions = version3 ? 8 : 5;
2295 const int iMaxDimensionRegions = version3 ? 256 : 32;
2296
2297 // make sure '3lnk' chunk exists
2298 RIFF::Chunk* _3lnk = pCkRegion->GetSubChunk(CHUNK_ID_3LNK);
2299 if (!_3lnk) {
2300 const int _3lnkChunkSize = version3 ? 1092 : 172;
2301 _3lnk = pCkRegion->AddSubChunk(CHUNK_ID_3LNK, _3lnkChunkSize);
2302 memset(_3lnk->LoadChunkData(), 0, _3lnkChunkSize);
2303
2304 // move 3prg to last position
2305 pCkRegion->MoveSubChunk(pCkRegion->GetSubList(LIST_TYPE_3PRG), 0);
2306 }
2307
2308 // update dimension definitions in '3lnk' chunk
2309 uint8_t* pData = (uint8_t*) _3lnk->LoadChunkData();
2310 store32(&pData[0], DimensionRegions);
2311 int shift = 0;
2312 for (int i = 0; i < iMaxDimensions; i++) {
2313 pData[4 + i * 8] = (uint8_t) pDimensionDefinitions[i].dimension;
2314 pData[5 + i * 8] = pDimensionDefinitions[i].bits;
2315 pData[6 + i * 8] = shift;
2316 pData[7 + i * 8] = (1 << (shift + pDimensionDefinitions[i].bits)) - (1 << shift);
2317 pData[8 + i * 8] = pDimensionDefinitions[i].zones;
2318 // next 3 bytes unknown, always zero?
2319
2320 shift += pDimensionDefinitions[i].bits;
2321 }
2322
2323 // update wave pool table in '3lnk' chunk
2324 const int iWavePoolOffset = version3 ? 68 : 44;
2325 for (uint i = 0; i < iMaxDimensionRegions; i++) {
2326 int iWaveIndex = -1;
2327 if (i < DimensionRegions) {
2328 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 for (int index = 0; iter != end; ++iter, ++index) {
2332 if (*iter == pDimensionRegions[i]->pSample) {
2333 iWaveIndex = index;
2334 break;
2335 }
2336 }
2337 if (iWaveIndex < 0) throw gig::Exception("Could not update gig::Region, could not find DimensionRegion's sample");
2338 }
2339 store32(&pData[iWavePoolOffset + i * 4], iWaveIndex);
2340 }
2341 }
2342
2343 void Region::LoadDimensionRegions(RIFF::List* rgn) {
2344 RIFF::List* _3prg = rgn->GetSubList(LIST_TYPE_3PRG);
2345 if (_3prg) {
2346 int dimensionRegionNr = 0;
2347 RIFF::List* _3ewl = _3prg->GetFirstSubList();
2348 while (_3ewl) {
2349 if (_3ewl->GetListType() == LIST_TYPE_3EWL) {
2350 pDimensionRegions[dimensionRegionNr] = new DimensionRegion(_3ewl);
2351 dimensionRegionNr++;
2352 }
2353 _3ewl = _3prg->GetNextSubList();
2354 }
2355 if (dimensionRegionNr == 0) throw gig::Exception("No dimension region found.");
2356 }
2357 }
2358
2359 void Region::UpdateVelocityTable() {
2360 // get velocity dimension's index
2361 int veldim = -1;
2362 for (int i = 0 ; i < Dimensions ; i++) {
2363 if (pDimensionDefinitions[i].dimension == gig::dimension_velocity) {
2364 veldim = i;
2365 break;
2366 }
2367 }
2368 if (veldim == -1) return;
2369
2370 int step = 1;
2371 for (int i = 0 ; i < veldim ; i++) step <<= pDimensionDefinitions[i].bits;
2372 int skipveldim = (step << pDimensionDefinitions[veldim].bits) - step;
2373 int end = step * pDimensionDefinitions[veldim].zones;
2374
2375 // loop through all dimension regions for all dimensions except the velocity dimension
2376 int dim[8] = { 0 };
2377 for (int i = 0 ; i < DimensionRegions ; i++) {
2378
2379 if (pDimensionRegions[i]->DimensionUpperLimits[veldim] ||
2380 pDimensionRegions[i]->VelocityUpperLimit) {
2381 // create the velocity table
2382 uint8_t* table = pDimensionRegions[i]->VelocityTable;
2383 if (!table) {
2384 table = new uint8_t[128];
2385 pDimensionRegions[i]->VelocityTable = table;
2386 }
2387 int tableidx = 0;
2388 int velocityZone = 0;
2389 if (pDimensionRegions[i]->DimensionUpperLimits[veldim]) { // gig3
2390 for (int k = i ; k < end ; k += step) {
2391 DimensionRegion *d = pDimensionRegions[k];
2392 for (; tableidx <= d->DimensionUpperLimits[veldim] ; tableidx++) table[tableidx] = velocityZone;
2393 velocityZone++;
2394 }
2395 } else { // gig2
2396 for (int k = i ; k < end ; k += step) {
2397 DimensionRegion *d = pDimensionRegions[k];
2398 for (; tableidx <= d->VelocityUpperLimit ; tableidx++) table[tableidx] = velocityZone;
2399 velocityZone++;
2400 }
2401 }
2402 } else {
2403 if (pDimensionRegions[i]->VelocityTable) {
2404 delete[] pDimensionRegions[i]->VelocityTable;
2405 pDimensionRegions[i]->VelocityTable = 0;
2406 }
2407 }
2408
2409 int j;
2410 int shift = 0;
2411 for (j = 0 ; j < Dimensions ; j++) {
2412 if (j == veldim) i += skipveldim; // skip velocity dimension
2413 else {
2414 dim[j]++;
2415 if (dim[j] < pDimensionDefinitions[j].zones) break;
2416 else {
2417 // skip unused dimension regions
2418 dim[j] = 0;
2419 i += ((1 << pDimensionDefinitions[j].bits) -
2420 pDimensionDefinitions[j].zones) << shift;
2421 }
2422 }
2423 shift += pDimensionDefinitions[j].bits;
2424 }
2425 if (j == Dimensions) break;
2426 }
2427 }
2428
2429 /** @brief Einstein would have dreamed of it - create a new dimension.
2430 *
2431 * Creates a new dimension with the dimension definition given by
2432 * \a pDimDef. The appropriate amount of DimensionRegions will be created.
2433 * There is a hard limit of dimensions and total amount of "bits" all
2434 * dimensions can have. This limit is dependant to what gig file format
2435 * version this file refers to. The gig v2 (and lower) format has a
2436 * dimension limit and total amount of bits limit of 5, whereas the gig v3
2437 * format has a limit of 8.
2438 *
2439 * @param pDimDef - defintion of the new dimension
2440 * @throws gig::Exception if dimension of the same type exists already
2441 * @throws gig::Exception if amount of dimensions or total amount of
2442 * dimension bits limit is violated
2443 */
2444 void Region::AddDimension(dimension_def_t* pDimDef) {
2445 // check if max. amount of dimensions reached
2446 File* file = (File*) GetParent()->GetParent();
2447 const int iMaxDimensions = (file->pVersion && file->pVersion->major == 3) ? 8 : 5;
2448 if (Dimensions >= iMaxDimensions)
2449 throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimensions already reached");
2450 // check if max. amount of dimension bits reached
2451 int iCurrentBits = 0;
2452 for (int i = 0; i < Dimensions; i++)
2453 iCurrentBits += pDimensionDefinitions[i].bits;
2454 if (iCurrentBits >= iMaxDimensions)
2455 throw gig::Exception("Could not add new dimension, max. amount of " + ToString(iMaxDimensions) + " dimension bits already reached");
2456 const int iNewBits = iCurrentBits + pDimDef->bits;
2457 if (iNewBits > iMaxDimensions)
2458 throw gig::Exception("Could not add new dimension, new dimension would exceed max. amount of " + ToString(iMaxDimensions) + " dimension bits");
2459 // check if there's already a dimensions of the same type
2460 for (int i = 0; i < Dimensions; i++)
2461 if (pDimensionDefinitions[i].dimension == pDimDef->dimension)
2462 throw gig::Exception("Could not add new dimension, there is already a dimension of the same type");
2463
2464 // assign definition of new dimension
2465 pDimensionDefinitions[Dimensions] = *pDimDef;
2466
2467 // auto correct certain dimension definition fields (where possible)
2468 pDimensionDefinitions[Dimensions].split_type =
2469 __resolveSplitType(pDimensionDefinitions[Dimensions].dimension);
2470 pDimensionDefinitions[Dimensions].zone_size =
2471 __resolveZoneSize(pDimensionDefinitions[Dimensions]);
2472
2473 // create new dimension region(s) for this new dimension
2474 for (int i = 1 << iCurrentBits; i < 1 << iNewBits; i++) {
2475 //TODO: maybe we should copy existing dimension regions if possible instead of simply creating new ones with default values
2476 RIFF::List* _3prg = pCkRegion->GetSubList(LIST_TYPE_3PRG);
2477 RIFF::List* pNewDimRgnListChunk = _3prg->AddSubList(LIST_TYPE_3EWL);
2478 pDimensionRegions[i] = new DimensionRegion(pNewDimRgnListChunk);
2479
2480 // copy the upper limits for the other dimensions
2481 memcpy(pDimensionRegions[i]->DimensionUpperLimits,
2482 pDimensionRegions[i & ((1 << iCurrentBits) - 1)]->DimensionUpperLimits, 8);
2483
2484 DimensionRegions++;
2485 }
2486
2487 // initialize the upper limits for this dimension
2488 for (int z = 0, j = 0 ; z < pDimDef->zones ; z++, j += 1 << iCurrentBits) {
2489 uint8_t upperLimit = uint8_t((z + 1) * 128.0 / pDimDef->zones - 1);
2490 for (int i = 0 ; i < 1 << iCurrentBits ; i++) {
2491 pDimensionRegions[j + i]->DimensionUpperLimits[Dimensions] = upperLimit;
2492 }
2493 }
2494
2495 Dimensions++;
2496
2497 // if this is a layer dimension, update 'Layers' attribute
2498 if (pDimDef->dimension == dimension_layer) Layers = pDimDef->zones;
2499
2500 UpdateVelocityTable();
2501 }
2502
2503 /** @brief Delete an existing dimension.
2504 *
2505 * Deletes the dimension given by \a pDimDef and deletes all respective
2506 * dimension regions, that is all dimension regions where the dimension's
2507 * bit(s) part is greater than 0. In case of a 'sustain pedal' dimension
2508 * for example this would delete all dimension regions for the case(s)
2509 * where the sustain pedal is pressed down.
2510 *
2511 * @param pDimDef - dimension to delete
2512 * @throws gig::Exception if given dimension cannot be found
2513 */
2514 void Region::DeleteDimension(dimension_def_t* pDimDef) {
2515 // get dimension's index
2516 int iDimensionNr = -1;
2517 for (int i = 0; i < Dimensions; i++) {
2518 if (&pDimensionDefinitions[i] == pDimDef) {
2519 iDimensionNr = i;
2520 break;
2521 }
2522 }
2523 if (iDimensionNr < 0) throw gig::Exception("Invalid dimension_def_t pointer");
2524
2525 // get amount of bits below the dimension to delete
2526 int iLowerBits = 0;
2527 for (int i = 0; i < iDimensionNr; i++)
2528 iLowerBits += pDimensionDefinitions[i].bits;
2529
2530 // get amount ot bits above the dimension to delete
2531 int iUpperBits = 0;
2532 for (int i = iDimensionNr + 1; i < Dimensions; i++)
2533 iUpperBits += pDimensionDefinitions[i].bits;
2534
2535 RIFF::List* _3prg = pCkRegion->GetSubList(LIST_TYPE_3PRG);
2536
2537 // delete dimension regions which belong to the given dimension
2538 // (that is where the dimension's bit > 0)
2539 for (int iUpperBit = 0; iUpperBit < 1 << iUpperBits; iUpperBit++) {
2540 for (int iObsoleteBit = 1; iObsoleteBit < 1 << pDimensionDefinitions[iDimensionNr].bits; iObsoleteBit++) {
2541 for (int iLowerBit = 0; iLowerBit < 1 << iLowerBits; iLowerBit++) {
2542 int iToDelete = iUpperBit << (pDimensionDefinitions[iDimensionNr].bits + iLowerBits) |
2543 iObsoleteBit << iLowerBits |
2544 iLowerBit;
2545
2546 _3prg->DeleteSubChunk(pDimensionRegions[iToDelete]->pParentList);
2547 delete pDimensionRegions[iToDelete];
2548 pDimensionRegions[iToDelete] = NULL;
2549 DimensionRegions--;
2550 }
2551 }
2552 }
2553
2554 // defrag pDimensionRegions array
2555 // (that is remove the NULL spaces within the pDimensionRegions array)
2556 for (int iFrom = 2, iTo = 1; iFrom < 256 && iTo < 256 - 1; iTo++) {
2557 if (!pDimensionRegions[iTo]) {
2558 if (iFrom <= iTo) iFrom = iTo + 1;
2559 while (!pDimensionRegions[iFrom] && iFrom < 256) iFrom++;
2560 if (iFrom < 256 && pDimensionRegions[iFrom]) {
2561 pDimensionRegions[iTo] = pDimensionRegions[iFrom];
2562 pDimensionRegions[iFrom] = NULL;
2563 }
2564 }
2565 }
2566
2567 // remove the this dimension from the upper limits arrays
2568 for (int j = 0 ; j < 256 && pDimensionRegions[j] ; j++) {
2569 DimensionRegion* d = pDimensionRegions[j];
2570 for (int i = iDimensionNr + 1; i < Dimensions; i++) {
2571 d->DimensionUpperLimits[i - 1] = d->DimensionUpperLimits[i];
2572 }
2573 d->DimensionUpperLimits[Dimensions - 1] = 127;
2574 }
2575
2576 // 'remove' dimension definition
2577 for (int i = iDimensionNr + 1; i < Dimensions; i++) {
2578 pDimensionDefinitions[i - 1] = pDimensionDefinitions[i];
2579 }
2580 pDimensionDefinitions[Dimensions - 1].dimension = dimension_none;
2581 pDimensionDefinitions[Dimensions - 1].bits = 0;
2582 pDimensionDefinitions[Dimensions - 1].zones = 0;
2583
2584 Dimensions--;
2585
2586 // if this was a layer dimension, update 'Layers' attribute
2587 if (pDimDef->dimension == dimension_layer) Layers = 1;
2588 }
2589
2590 Region::~Region() {
2591 for (int i = 0; i < 256; i++) {
2592 if (pDimensionRegions[i]) delete pDimensionRegions[i];
2593 }
2594 }
2595
2596 /**
2597 * Use this method in your audio engine to get the appropriate dimension
2598 * region with it's articulation data for the current situation. Just
2599 * call the method with the current MIDI controller values and you'll get
2600 * the DimensionRegion with the appropriate articulation data for the
2601 * current situation (for this Region of course only). To do that you'll
2602 * first have to look which dimensions with which controllers and in
2603 * which order are defined for this Region when you load the .gig file.
2604 * Special cases are e.g. layer or channel dimensions where you just put
2605 * in the index numbers instead of a MIDI controller value (means 0 for
2606 * left channel, 1 for right channel or 0 for layer 0, 1 for layer 1,
2607 * etc.).
2608 *
2609 * @param DimValues MIDI controller values (0-127) for dimension 0 to 7
2610 * @returns adress to the DimensionRegion for the given situation
2611 * @see pDimensionDefinitions
2612 * @see Dimensions
2613 */
2614 DimensionRegion* Region::GetDimensionRegionByValue(const uint DimValues[8]) {
2615 uint8_t bits;
2616 int veldim = -1;
2617 int velbitpos;
2618 int bitpos = 0;
2619 int dimregidx = 0;
2620 for (uint i = 0; i < Dimensions; i++) {
2621 if (pDimensionDefinitions[i].dimension == dimension_velocity) {
2622 // the velocity dimension must be handled after the other dimensions
2623 veldim = i;
2624 velbitpos = bitpos;
2625 } else {
2626 switch (pDimensionDefinitions[i].split_type) {
2627 case split_type_normal:
2628 if (pDimensionRegions[0]->DimensionUpperLimits[i]) {
2629 // gig3: all normal dimensions (not just the velocity dimension) have custom zone ranges
2630 for (bits = 0 ; bits < pDimensionDefinitions[i].zones ; bits++) {
2631 if (DimValues[i] <= pDimensionRegions[bits << bitpos]->DimensionUpperLimits[i]) break;
2632 }
2633 } else {
2634 // gig2: evenly sized zones
2635 bits = uint8_t(DimValues[i] / pDimensionDefinitions[i].zone_size);
2636 }
2637 break;
2638 case split_type_bit: // the value is already the sought dimension bit number
2639 const uint8_t limiter_mask = (0xff << pDimensionDefinitions[i].bits) ^ 0xff;
2640 bits = DimValues[i] & limiter_mask; // just make sure the value doesn't use more bits than allowed
2641 break;
2642 }
2643 dimregidx |= bits << bitpos;
2644 }
2645 bitpos += pDimensionDefinitions[i].bits;
2646 }
2647 DimensionRegion* dimreg = pDimensionRegions[dimregidx];
2648 if (veldim != -1) {
2649 // (dimreg is now the dimension region for the lowest velocity)
2650 if (dimreg->VelocityTable) // custom defined zone ranges
2651 bits = dimreg->VelocityTable[DimValues[veldim]];
2652 else // normal split type
2653 bits = uint8_t(DimValues[veldim] / pDimensionDefinitions[veldim].zone_size);
2654
2655 dimregidx |= bits << velbitpos;
2656 dimreg = pDimensionRegions[dimregidx];
2657 }
2658 return dimreg;
2659 }
2660
2661 /**
2662 * Returns the appropriate DimensionRegion for the given dimension bit
2663 * numbers (zone index). You usually use <i>GetDimensionRegionByValue</i>
2664 * instead of calling this method directly!
2665 *
2666 * @param DimBits Bit numbers for dimension 0 to 7
2667 * @returns adress to the DimensionRegion for the given dimension
2668 * bit numbers
2669 * @see GetDimensionRegionByValue()
2670 */
2671 DimensionRegion* Region::GetDimensionRegionByBit(const uint8_t DimBits[8]) {
2672 return pDimensionRegions[((((((DimBits[7] << pDimensionDefinitions[6].bits | DimBits[6])
2673 << pDimensionDefinitions[5].bits | DimBits[5])
2674 << pDimensionDefinitions[4].bits | DimBits[4])
2675 << pDimensionDefinitions[3].bits | DimBits[3])
2676 << pDimensionDefinitions[2].bits | DimBits[2])
2677 << pDimensionDefinitions[1].bits | DimBits[1])
2678 << pDimensionDefinitions[0].bits | DimBits[0]];
2679 }
2680
2681 /**
2682 * Returns pointer address to the Sample referenced with this region.
2683 * This is the global Sample for the entire Region (not sure if this is
2684 * actually used by the Gigasampler engine - I would only use the Sample
2685 * referenced by the appropriate DimensionRegion instead of this sample).
2686 *
2687 * @returns address to Sample or NULL if there is no reference to a
2688 * sample saved in the .gig file
2689 */
2690 Sample* Region::GetSample() {
2691 if (pSample) return static_cast<gig::Sample*>(pSample);
2692 else return static_cast<gig::Sample*>(pSample = GetSampleFromWavePool(WavePoolTableIndex));
2693 }
2694
2695 Sample* Region::GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress) {
2696 if ((int32_t)WavePoolTableIndex == -1) return NULL;
2697 File* file = (File*) GetParent()->GetParent();
2698 if (!file->pWavePoolTable) return NULL;
2699 unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
2700 unsigned long soughtfileno = file->pWavePoolTableHi[WavePoolTableIndex];
2701 Sample* sample = file->GetFirstSample(pProgress);
2702 while (sample) {
2703 if (sample->ulWavePoolOffset == soughtoffset &&
2704 sample->FileNo == soughtfileno) return static_cast<gig::Sample*>(sample);
2705 sample = file->GetNextSample();
2706 }
2707 return NULL;
2708 }
2709
2710
2711
2712 // *************** Instrument ***************
2713 // *
2714
2715 Instrument::Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress) : DLS::Instrument((DLS::File*)pFile, insList) {
2716 static const DLS::Info::FixedStringLength fixedStringLengths[] = {
2717 { CHUNK_ID_INAM, 64 },
2718 { CHUNK_ID_ISFT, 12 },
2719 { 0, 0 }
2720 };
2721 pInfo->FixedStringLengths = fixedStringLengths;
2722
2723 // Initialization
2724 for (int i = 0; i < 128; i++) RegionKeyTable[i] = NULL;
2725 EffectSend = 0;
2726 Attenuation = 0;
2727 FineTune = 0;
2728 PitchbendRange = 0;
2729 PianoReleaseMode = false;
2730 DimensionKeyRange.low = 0;
2731 DimensionKeyRange.high = 0;
2732
2733 // Loading
2734 RIFF::List* lart = insList->GetSubList(LIST_TYPE_LART);
2735 if (lart) {
2736 RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);
2737 if (_3ewg) {
2738 EffectSend = _3ewg->ReadUint16();
2739 Attenuation = _3ewg->ReadInt32();
2740 FineTune = _3ewg->ReadInt16();
2741 PitchbendRange = _3ewg->ReadInt16();
2742 uint8_t dimkeystart = _3ewg->ReadUint8();
2743 PianoReleaseMode = dimkeystart & 0x01;
2744 DimensionKeyRange.low = dimkeystart >> 1;
2745 DimensionKeyRange.high = _3ewg->ReadUint8();
2746 }
2747 }
2748
2749 if (!pRegions) pRegions = new RegionList;
2750 RIFF::List* lrgn = insList->GetSubList(LIST_TYPE_LRGN);
2751 if (lrgn) {
2752 RIFF::List* rgn = lrgn->GetFirstSubList();
2753 while (rgn) {
2754 if (rgn->GetListType() == LIST_TYPE_RGN) {
2755 __notify_progress(pProgress, (float) pRegions->size() / (float) Regions);
2756 pRegions->push_back(new Region(this, rgn));
2757 }
2758 rgn = lrgn->GetNextSubList();
2759 }
2760 // Creating Region Key Table for fast lookup
2761 UpdateRegionKeyTable();
2762 }
2763
2764 __notify_progress(pProgress, 1.0f); // notify done
2765 }
2766
2767 void Instrument::UpdateRegionKeyTable() {
2768 RegionList::iterator iter = pRegions->begin();
2769 RegionList::iterator end = pRegions->end();
2770 for (; iter != end; ++iter) {
2771 gig::Region* pRegion = static_cast<gig::Region*>(*iter);
2772 for (int iKey = pRegion->KeyRange.low; iKey <= pRegion->KeyRange.high; iKey++) {
2773 RegionKeyTable[iKey] = pRegion;
2774 }
2775 }
2776 }
2777
2778 Instrument::~Instrument() {
2779 }
2780
2781 /**
2782 * Apply Instrument with all its Regions to the respective RIFF chunks.
2783 * You have to call File::Save() to make changes persistent.
2784 *
2785 * Usually there is absolutely no need to call this method explicitly.
2786 * It will be called automatically when File::Save() was called.
2787 *
2788 * @throws gig::Exception if samples cannot be dereferenced
2789 */
2790 void Instrument::UpdateChunks() {
2791 // first update base classes' chunks
2792 DLS::Instrument::UpdateChunks();
2793
2794 // update Regions' chunks
2795 {
2796 RegionList::iterator iter = pRegions->begin();
2797 RegionList::iterator end = pRegions->end();
2798 for (; iter != end; ++iter)
2799 (*iter)->UpdateChunks();
2800 }
2801
2802 // make sure 'lart' RIFF list chunk exists
2803 RIFF::List* lart = pCkInstrument->GetSubList(LIST_TYPE_LART);
2804 if (!lart) lart = pCkInstrument->AddSubList(LIST_TYPE_LART);
2805 // make sure '3ewg' RIFF chunk exists
2806 RIFF::Chunk* _3ewg = lart->GetSubChunk(CHUNK_ID_3EWG);
2807 if (!_3ewg) {
2808 File* pFile = (File*) GetParent();
2809
2810 // 3ewg is bigger in gig3, as it includes the iMIDI rules
2811 int size = (pFile->pVersion && pFile->pVersion->major == 3) ? 16416 : 12;
2812 _3ewg = lart->AddSubChunk(CHUNK_ID_3EWG, size);
2813 memset(_3ewg->LoadChunkData(), 0, size);
2814 }
2815 // update '3ewg' RIFF chunk
2816 uint8_t* pData = (uint8_t*) _3ewg->LoadChunkData();
2817 store16(&pData[0], EffectSend);
2818 store32(&pData[2], Attenuation);
2819 store16(&pData[6], FineTune);
2820 store16(&pData[8], PitchbendRange);
2821 const uint8_t dimkeystart = (PianoReleaseMode) ? 0x01 : 0x00 |
2822 DimensionKeyRange.low << 1;
2823 pData[10] = dimkeystart;
2824 pData[11] = DimensionKeyRange.high;
2825 }
2826
2827 /**
2828 * Returns the appropriate Region for a triggered note.
2829 *
2830 * @param Key MIDI Key number of triggered note / key (0 - 127)
2831 * @returns pointer adress to the appropriate Region or NULL if there
2832 * there is no Region defined for the given \a Key
2833 */
2834 Region* Instrument::GetRegion(unsigned int Key) {
2835 if (!pRegions || !pRegions->size() || Key > 127) return NULL;
2836 return RegionKeyTable[Key];
2837
2838 /*for (int i = 0; i < Regions; i++) {
2839 if (Key <= pRegions[i]->KeyRange.high &&
2840 Key >= pRegions[i]->KeyRange.low) return pRegions[i];
2841 }
2842 return NULL;*/
2843 }
2844
2845 /**
2846 * Returns the first Region of the instrument. You have to call this
2847 * method once before you use GetNextRegion().
2848 *
2849 * @returns pointer address to first region or NULL if there is none
2850 * @see GetNextRegion()
2851 */
2852 Region* Instrument::GetFirstRegion() {
2853 if (!pRegions) return NULL;
2854 RegionsIterator = pRegions->begin();
2855 return static_cast<gig::Region*>( (RegionsIterator != pRegions->end()) ? *RegionsIterator : NULL );
2856 }
2857
2858 /**
2859 * Returns the next Region of the instrument. You have to call
2860 * GetFirstRegion() once before you can use this method. By calling this
2861 * method multiple times it iterates through the available Regions.
2862 *
2863 * @returns pointer address to the next region or NULL if end reached
2864 * @see GetFirstRegion()
2865 */
2866 Region* Instrument::GetNextRegion() {
2867 if (!pRegions) return NULL;
2868 RegionsIterator++;
2869 return static_cast<gig::Region*>( (RegionsIterator != pRegions->end()) ? *RegionsIterator : NULL );
2870 }
2871
2872 Region* Instrument::AddRegion() {
2873 // create new Region object (and its RIFF chunks)
2874 RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
2875 if (!lrgn) lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
2876 RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
2877 Region* pNewRegion = new Region(this, rgn);
2878 pRegions->push_back(pNewRegion);
2879 Regions = pRegions->size();
2880 // update Region key table for fast lookup
2881 UpdateRegionKeyTable();
2882 // done
2883 return pNewRegion;
2884 }
2885
2886 void Instrument::DeleteRegion(Region* pRegion) {
2887 if (!pRegions) return;
2888 DLS::Instrument::DeleteRegion((DLS::Region*) pRegion);
2889 // update Region key table for fast lookup
2890 UpdateRegionKeyTable();
2891 }
2892
2893
2894
2895 // *************** Group ***************
2896 // *
2897
2898 /** @brief Constructor.
2899 *
2900 * @param file - pointer to the gig::File object
2901 * @param ck3gnm - pointer to 3gnm chunk associated with this group or
2902 * NULL if this is a new Group
2903 */
2904 Group::Group(File* file, RIFF::Chunk* ck3gnm) {
2905 pFile = file;
2906 pNameChunk = ck3gnm;
2907 ::LoadString(pNameChunk, Name);
2908 }
2909
2910 Group::~Group() {
2911 // remove the chunk associated with this group (if any)
2912 if (pNameChunk) pNameChunk->GetParent()->DeleteSubChunk(pNameChunk);
2913 }
2914
2915 /** @brief Update chunks with current group settings.
2916 *
2917 * Apply current Group field values to the respective chunks. You have
2918 * to call File::Save() to make changes persistent.
2919 *
2920 * Usually there is absolutely no need to call this method explicitly.
2921 * It will be called automatically when File::Save() was called.
2922 */
2923 void Group::UpdateChunks() {
2924 // make sure <3gri> and <3gnl> list chunks exist
2925 RIFF::List* _3gri = pFile->pRIFF->GetSubList(LIST_TYPE_3GRI);
2926 if (!_3gri) {
2927 _3gri = pFile->pRIFF->AddSubList(LIST_TYPE_3GRI);
2928 pFile->pRIFF->MoveSubChunk(_3gri, pFile->pRIFF->GetSubChunk(CHUNK_ID_PTBL));
2929 }
2930 RIFF::List* _3gnl = _3gri->GetSubList(LIST_TYPE_3GNL);
2931 if (!_3gnl) _3gnl = _3gri->AddSubList(LIST_TYPE_3GNL);
2932 // now store the name of this group as <3gnm> chunk as subchunk of the <3gnl> list chunk
2933 ::SaveString(CHUNK_ID_3GNM, pNameChunk, _3gnl, Name, String("Unnamed Group"), true, 64);
2934 }
2935
2936 /**
2937 * Returns the first Sample of this Group. You have to call this method
2938 * once before you use GetNextSample().
2939 *
2940 * <b>Notice:</b> this method might block for a long time, in case the
2941 * samples of this .gig file were not scanned yet
2942 *
2943 * @returns pointer address to first Sample or NULL if there is none
2944 * applied to this Group
2945 * @see GetNextSample()
2946 */
2947 Sample* Group::GetFirstSample() {
2948 // FIXME: lazy und unsafe implementation, should be an autonomous iterator
2949 for (Sample* pSample = pFile->GetFirstSample(); pSample; pSample = pFile->GetNextSample()) {
2950 if (pSample->GetGroup() == this) return pSample;
2951 }
2952 return NULL;
2953 }
2954
2955 /**
2956 * Returns the next Sample of the Group. You have to call
2957 * GetFirstSample() once before you can use this method. By calling this
2958 * method multiple times it iterates through the Samples assigned to
2959 * this Group.
2960 *
2961 * @returns pointer address to the next Sample of this Group or NULL if
2962 * end reached
2963 * @see GetFirstSample()
2964 */
2965 Sample* Group::GetNextSample() {
2966 // FIXME: lazy und unsafe implementation, should be an autonomous iterator
2967 for (Sample* pSample = pFile->GetNextSample(); pSample; pSample = pFile->GetNextSample()) {
2968 if (pSample->GetGroup() == this) return pSample;
2969 }
2970 return NULL;
2971 }
2972
2973 /**
2974 * Move Sample given by \a pSample from another Group to this Group.
2975 */
2976 void Group::AddSample(Sample* pSample) {
2977 pSample->pGroup = this;
2978 }
2979
2980 /**
2981 * Move all members of this group to another group (preferably the 1st
2982 * one except this). This method is called explicitly by
2983 * File::DeleteGroup() thus when a Group was deleted. This code was
2984 * intentionally not placed in the destructor!
2985 */
2986 void Group::MoveAll() {
2987 // get "that" other group first
2988 Group* pOtherGroup = NULL;
2989 for (pOtherGroup = pFile->GetFirstGroup(); pOtherGroup; pOtherGroup = pFile->GetNextGroup()) {
2990 if (pOtherGroup != this) break;
2991 }
2992 if (!pOtherGroup) throw Exception(
2993 "Could not move samples to another group, since there is no "
2994 "other Group. This is a bug, report it!"
2995 );
2996 // now move all samples of this group to the other group
2997 for (Sample* pSample = GetFirstSample(); pSample; pSample = GetNextSample()) {
2998 pOtherGroup->AddSample(pSample);
2999 }
3000 }
3001
3002
3003
3004 // *************** File ***************
3005 // *
3006
3007 // File version 2.0, 1998-06-28
3008 const DLS::version_t File::VERSION_2 = {
3009 0, 2, 19980628 & 0xffff, 19980628 >> 16
3010 };
3011
3012 // File version 3.0, 2003-03-31
3013 const DLS::version_t File::VERSION_3 = {
3014 0, 3, 20030331 & 0xffff, 20030331 >> 16
3015 };
3016
3017 const DLS::Info::FixedStringLength File::FixedStringLengths[] = {
3018 { CHUNK_ID_IARL, 256 },
3019 { CHUNK_ID_IART, 128 },
3020 { CHUNK_ID_ICMS, 128 },
3021 { CHUNK_ID_ICMT, 1024 },
3022 { CHUNK_ID_ICOP, 128 },
3023 { CHUNK_ID_ICRD, 128 },
3024 { CHUNK_ID_IENG, 128 },
3025 { CHUNK_ID_IGNR, 128 },
3026 { CHUNK_ID_IKEY, 128 },
3027 { CHUNK_ID_IMED, 128 },
3028 { CHUNK_ID_INAM, 128 },
3029 { CHUNK_ID_IPRD, 128 },
3030 { CHUNK_ID_ISBJ, 128 },
3031 { CHUNK_ID_ISFT, 128 },
3032 { CHUNK_ID_ISRC, 128 },
3033 { CHUNK_ID_ISRF, 128 },
3034 { CHUNK_ID_ITCH, 128 },
3035 { 0, 0 }
3036 };
3037
3038 File::File() : DLS::File() {
3039 *pVersion = VERSION_3;
3040 pGroups = NULL;
3041 pInfo->FixedStringLengths = FixedStringLengths;
3042 pInfo->ArchivalLocation = String(256, ' ');
3043
3044 // add some mandatory chunks to get the file chunks in right
3045 // order (INFO chunk will be moved to first position later)
3046 pRIFF->AddSubChunk(CHUNK_ID_VERS, 8);
3047 pRIFF->AddSubChunk(CHUNK_ID_COLH, 4);
3048 pRIFF->AddSubChunk(CHUNK_ID_DLID, 16);
3049
3050 GenerateDLSID();
3051 }
3052
3053 File::File(RIFF::File* pRIFF) : DLS::File(pRIFF) {
3054 pGroups = NULL;
3055 pInfo->FixedStringLengths = FixedStringLengths;
3056 }
3057
3058 File::~File() {
3059 if (pGroups) {
3060 std::list<Group*>::iterator iter = pGroups->