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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3929 - (show annotations) (download)
Tue Jun 15 12:22:26 2021 UTC (2 years, 9 months ago) by schoenebeck
File size: 102600 byte(s)
* gig: Use File::GetSample() instead of File::GetFirstSample() /
  File::GetNextSample() in entire gig.cpp file.

- DLS: Use File::GetSample() instead of File::GetFirstSample() /
  File::GetNextSample() in entire DLS.cpp file.

* Bumped version (4.3.0.svn17).

1 /***************************************************************************
2 * *
3 * libgig - C++ cross-platform Gigasampler format file access library *
4 * *
5 * Copyright (C) 2003-2021 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 "DLS.h"
25
26 #include <algorithm>
27 #include <vector>
28 #include <time.h>
29
30 #ifdef __APPLE__
31 #include <CoreFoundation/CFUUID.h>
32 #elif defined(HAVE_UUID_UUID_H)
33 #include <uuid/uuid.h>
34 #endif
35
36 #include "helper.h"
37
38 // macros to decode connection transforms
39 #define CONN_TRANSFORM_SRC(x) ((x >> 10) & 0x000F)
40 #define CONN_TRANSFORM_CTL(x) ((x >> 4) & 0x000F)
41 #define CONN_TRANSFORM_DST(x) (x & 0x000F)
42 #define CONN_TRANSFORM_BIPOLAR_SRC(x) (x & 0x4000)
43 #define CONN_TRANSFORM_BIPOLAR_CTL(x) (x & 0x0100)
44 #define CONN_TRANSFORM_INVERT_SRC(x) (x & 0x8000)
45 #define CONN_TRANSFORM_INVERT_CTL(x) (x & 0x0200)
46
47 // macros to encode connection transforms
48 #define CONN_TRANSFORM_SRC_ENCODE(x) ((x & 0x000F) << 10)
49 #define CONN_TRANSFORM_CTL_ENCODE(x) ((x & 0x000F) << 4)
50 #define CONN_TRANSFORM_DST_ENCODE(x) (x & 0x000F)
51 #define CONN_TRANSFORM_BIPOLAR_SRC_ENCODE(x) ((x) ? 0x4000 : 0)
52 #define CONN_TRANSFORM_BIPOLAR_CTL_ENCODE(x) ((x) ? 0x0100 : 0)
53 #define CONN_TRANSFORM_INVERT_SRC_ENCODE(x) ((x) ? 0x8000 : 0)
54 #define CONN_TRANSFORM_INVERT_CTL_ENCODE(x) ((x) ? 0x0200 : 0)
55
56 #define DRUM_TYPE_MASK 0x80000000
57
58 #define F_RGN_OPTION_SELFNONEXCLUSIVE 0x0001
59
60 #define F_WAVELINK_PHASE_MASTER 0x0001
61 #define F_WAVELINK_MULTICHANNEL 0x0002
62
63 #define F_WSMP_NO_TRUNCATION 0x0001
64 #define F_WSMP_NO_COMPRESSION 0x0002
65
66 #define MIDI_BANK_COARSE(x) ((x & 0x00007F00) >> 8) // CC0
67 #define MIDI_BANK_FINE(x) (x & 0x0000007F) // CC32
68 #define MIDI_BANK_MERGE(coarse, fine) ((((uint16_t) coarse) << 7) | fine) // CC0 + CC32
69 #define MIDI_BANK_ENCODE(coarse, fine) (((coarse & 0x0000007F) << 8) | (fine & 0x0000007F))
70
71 namespace DLS {
72
73 // *************** Connection ***************
74 // *
75
76 void Connection::Init(conn_block_t* Header) {
77 Source = (conn_src_t) Header->source;
78 Control = (conn_src_t) Header->control;
79 Destination = (conn_dst_t) Header->destination;
80 Scale = Header->scale;
81 SourceTransform = (conn_trn_t) CONN_TRANSFORM_SRC(Header->transform);
82 ControlTransform = (conn_trn_t) CONN_TRANSFORM_CTL(Header->transform);
83 DestinationTransform = (conn_trn_t) CONN_TRANSFORM_DST(Header->transform);
84 SourceInvert = CONN_TRANSFORM_INVERT_SRC(Header->transform);
85 SourceBipolar = CONN_TRANSFORM_BIPOLAR_SRC(Header->transform);
86 ControlInvert = CONN_TRANSFORM_INVERT_CTL(Header->transform);
87 ControlBipolar = CONN_TRANSFORM_BIPOLAR_CTL(Header->transform);
88 }
89
90 Connection::conn_block_t Connection::ToConnBlock() {
91 conn_block_t c;
92 c.source = Source;
93 c.control = Control;
94 c.destination = Destination;
95 c.scale = Scale;
96 c.transform = CONN_TRANSFORM_SRC_ENCODE(SourceTransform) |
97 CONN_TRANSFORM_CTL_ENCODE(ControlTransform) |
98 CONN_TRANSFORM_DST_ENCODE(DestinationTransform) |
99 CONN_TRANSFORM_INVERT_SRC_ENCODE(SourceInvert) |
100 CONN_TRANSFORM_BIPOLAR_SRC_ENCODE(SourceBipolar) |
101 CONN_TRANSFORM_INVERT_CTL_ENCODE(ControlInvert) |
102 CONN_TRANSFORM_BIPOLAR_CTL_ENCODE(ControlBipolar);
103 return c;
104 }
105
106
107
108 // *************** Articulation ***************
109 // *
110
111 /** @brief Constructor.
112 *
113 * Expects an 'artl' or 'art2' chunk to be given where the articulation
114 * connections will be read from.
115 *
116 * @param artl - pointer to an 'artl' or 'art2' chunk
117 * @throws Exception if no 'artl' or 'art2' chunk was given
118 */
119 Articulation::Articulation(RIFF::Chunk* artl) {
120 pArticulationCk = artl;
121 if (artl->GetChunkID() != CHUNK_ID_ART2 &&
122 artl->GetChunkID() != CHUNK_ID_ARTL) {
123 throw DLS::Exception("<artl-ck> or <art2-ck> chunk expected");
124 }
125
126 artl->SetPos(0);
127
128 HeaderSize = artl->ReadUint32();
129 Connections = artl->ReadUint32();
130 artl->SetPos(HeaderSize);
131
132 pConnections = new Connection[Connections];
133 Connection::conn_block_t connblock;
134 for (uint32_t i = 0; i < Connections; i++) {
135 artl->Read(&connblock.source, 1, 2);
136 artl->Read(&connblock.control, 1, 2);
137 artl->Read(&connblock.destination, 1, 2);
138 artl->Read(&connblock.transform, 1, 2);
139 artl->Read(&connblock.scale, 1, 4);
140 pConnections[i].Init(&connblock);
141 }
142 }
143
144 Articulation::~Articulation() {
145 if (pConnections) delete[] pConnections;
146 }
147
148 /**
149 * Apply articulation connections to the respective RIFF chunks. You
150 * have to call File::Save() to make changes persistent.
151 *
152 * @param pProgress - callback function for progress notification
153 */
154 void Articulation::UpdateChunks(progress_t* pProgress) {
155 const int iEntrySize = 12; // 12 bytes per connection block
156 pArticulationCk->Resize(HeaderSize + Connections * iEntrySize);
157 uint8_t* pData = (uint8_t*) pArticulationCk->LoadChunkData();
158 store16(&pData[0], HeaderSize);
159 store16(&pData[2], Connections);
160 for (uint32_t i = 0; i < Connections; i++) {
161 Connection::conn_block_t c = pConnections[i].ToConnBlock();
162 store16(&pData[HeaderSize + i * iEntrySize], c.source);
163 store16(&pData[HeaderSize + i * iEntrySize + 2], c.control);
164 store16(&pData[HeaderSize + i * iEntrySize + 4], c.destination);
165 store16(&pData[HeaderSize + i * iEntrySize + 6], c.transform);
166 store32(&pData[HeaderSize + i * iEntrySize + 8], c.scale);
167 }
168 }
169
170 /** @brief Remove all RIFF chunks associated with this Articulation object.
171 *
172 * At the moment Articulation::DeleteChunks() does nothing. It is
173 * recommended to call this method explicitly though from deriving classes's
174 * own overridden implementation of this method to avoid potential future
175 * compatiblity issues.
176 *
177 * See Storage::DeleteChunks() for details.
178 */
179 void Articulation::DeleteChunks() {
180 }
181
182
183
184 // *************** Articulator ***************
185 // *
186
187 Articulator::Articulator(RIFF::List* ParentList) {
188 pParentList = ParentList;
189 pArticulations = NULL;
190 }
191
192 Articulation* Articulator::GetFirstArticulation() {
193 if (!pArticulations) LoadArticulations();
194 if (!pArticulations) return NULL;
195 ArticulationsIterator = pArticulations->begin();
196 return (ArticulationsIterator != pArticulations->end()) ? *ArticulationsIterator : NULL;
197 }
198
199 Articulation* Articulator::GetNextArticulation() {
200 if (!pArticulations) return NULL;
201 ArticulationsIterator++;
202 return (ArticulationsIterator != pArticulations->end()) ? *ArticulationsIterator : NULL;
203 }
204
205 void Articulator::LoadArticulations() {
206 // prefer articulation level 2
207 RIFF::List* lart = pParentList->GetSubList(LIST_TYPE_LAR2);
208 if (!lart) lart = pParentList->GetSubList(LIST_TYPE_LART);
209 if (lart) {
210 uint32_t artCkType = (lart->GetListType() == LIST_TYPE_LAR2) ? CHUNK_ID_ART2
211 : CHUNK_ID_ARTL;
212 size_t i = 0;
213 for (RIFF::Chunk* art = lart->GetSubChunkAt(i); art;
214 art = lart->GetSubChunkAt(++i))
215 {
216 if (art->GetChunkID() == artCkType) {
217 if (!pArticulations) pArticulations = new ArticulationList;
218 pArticulations->push_back(new Articulation(art));
219 }
220 }
221 }
222 }
223
224 Articulator::~Articulator() {
225 if (pArticulations) {
226 ArticulationList::iterator iter = pArticulations->begin();
227 ArticulationList::iterator end = pArticulations->end();
228 while (iter != end) {
229 delete *iter;
230 iter++;
231 }
232 delete pArticulations;
233 }
234 }
235
236 /**
237 * Apply all articulations to the respective RIFF chunks. You have to
238 * call File::Save() to make changes persistent.
239 *
240 * @param pProgress - callback function for progress notification
241 */
242 void Articulator::UpdateChunks(progress_t* pProgress) {
243 if (pArticulations) {
244 ArticulationList::iterator iter = pArticulations->begin();
245 ArticulationList::iterator end = pArticulations->end();
246 for (; iter != end; ++iter) {
247 (*iter)->UpdateChunks(pProgress);
248 }
249 }
250 }
251
252 /** @brief Remove all RIFF chunks associated with this Articulator object.
253 *
254 * See Storage::DeleteChunks() for details.
255 */
256 void Articulator::DeleteChunks() {
257 if (pArticulations) {
258 ArticulationList::iterator iter = pArticulations->begin();
259 ArticulationList::iterator end = pArticulations->end();
260 for (; iter != end; ++iter) {
261 (*iter)->DeleteChunks();
262 }
263 }
264 }
265
266 /**
267 * Not yet implemented in this version, since the .gig format does
268 * not need to copy DLS articulators and so far nobody used pure
269 * DLS instrument AFAIK.
270 */
271 void Articulator::CopyAssign(const Articulator* orig) {
272 //TODO: implement deep copy assignment for this class
273 }
274
275
276
277 // *************** Info ***************
278 // *
279
280 /** @brief Constructor.
281 *
282 * Initializes the info strings with values provided by an INFO list chunk.
283 *
284 * @param list - pointer to a list chunk which contains an INFO list chunk
285 */
286 Info::Info(RIFF::List* list) {
287 pFixedStringLengths = NULL;
288 pResourceListChunk = list;
289 if (list) {
290 RIFF::List* lstINFO = list->GetSubList(LIST_TYPE_INFO);
291 if (lstINFO) {
292 LoadString(CHUNK_ID_INAM, lstINFO, Name);
293 LoadString(CHUNK_ID_IARL, lstINFO, ArchivalLocation);
294 LoadString(CHUNK_ID_ICRD, lstINFO, CreationDate);
295 LoadString(CHUNK_ID_ICMT, lstINFO, Comments);
296 LoadString(CHUNK_ID_IPRD, lstINFO, Product);
297 LoadString(CHUNK_ID_ICOP, lstINFO, Copyright);
298 LoadString(CHUNK_ID_IART, lstINFO, Artists);
299 LoadString(CHUNK_ID_IGNR, lstINFO, Genre);
300 LoadString(CHUNK_ID_IKEY, lstINFO, Keywords);
301 LoadString(CHUNK_ID_IENG, lstINFO, Engineer);
302 LoadString(CHUNK_ID_ITCH, lstINFO, Technician);
303 LoadString(CHUNK_ID_ISFT, lstINFO, Software);
304 LoadString(CHUNK_ID_IMED, lstINFO, Medium);
305 LoadString(CHUNK_ID_ISRC, lstINFO, Source);
306 LoadString(CHUNK_ID_ISRF, lstINFO, SourceForm);
307 LoadString(CHUNK_ID_ICMS, lstINFO, Commissioned);
308 LoadString(CHUNK_ID_ISBJ, lstINFO, Subject);
309 }
310 }
311 }
312
313 Info::~Info() {
314 }
315
316 /**
317 * Forces specific Info fields to be of a fixed length when being saved
318 * to a file. By default the respective RIFF chunk of an Info field
319 * will have a size analogue to its actual string length. With this
320 * method however this behavior can be overridden, allowing to force an
321 * arbitrary fixed size individually for each Info field.
322 *
323 * This method is used as a workaround for the gig format, not for DLS.
324 *
325 * @param lengths - NULL terminated array of string_length_t elements
326 */
327 void Info::SetFixedStringLengths(const string_length_t* lengths) {
328 pFixedStringLengths = lengths;
329 }
330
331 /** @brief Load given INFO field.
332 *
333 * Load INFO field from INFO chunk with chunk ID \a ChunkID from INFO
334 * list chunk \a lstINFO and save value to \a s.
335 */
336 void Info::LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s) {
337 RIFF::Chunk* ck = lstINFO->GetSubChunk(ChunkID);
338 ::LoadString(ck, s); // function from helper.h
339 }
340
341 /** @brief Apply given INFO field to the respective chunk.
342 *
343 * Apply given info value to info chunk with ID \a ChunkID, which is a
344 * subchunk of INFO list chunk \a lstINFO. If the given chunk already
345 * exists, value \a s will be applied. Otherwise if it doesn't exist yet
346 * and either \a s or \a sDefault is not an empty string, such a chunk
347 * will be created and either \a s or \a sDefault will be applied
348 * (depending on which one is not an empty string, if both are not an
349 * empty string \a s will be preferred).
350 *
351 * @param ChunkID - 32 bit RIFF chunk ID of INFO subchunk
352 * @param lstINFO - parent (INFO) RIFF list chunk
353 * @param s - current value of info field
354 * @param sDefault - default value
355 */
356 void Info::SaveString(uint32_t ChunkID, RIFF::List* lstINFO, const String& s, const String& sDefault) {
357 int size = 0;
358 if (pFixedStringLengths) {
359 for (int i = 0 ; pFixedStringLengths[i].length ; i++) {
360 if (pFixedStringLengths[i].chunkId == ChunkID) {
361 size = pFixedStringLengths[i].length;
362 break;
363 }
364 }
365 }
366 RIFF::Chunk* ck = lstINFO->GetSubChunk(ChunkID);
367 ::SaveString(ChunkID, ck, lstINFO, s, sDefault, size != 0, size); // function from helper.h
368 }
369
370 /** @brief Update chunks with current info values.
371 *
372 * Apply current INFO field values to the respective INFO chunks. You
373 * have to call File::Save() to make changes persistent.
374 *
375 * @param pProgress - callback function for progress notification
376 */
377 void Info::UpdateChunks(progress_t* pProgress) {
378 if (!pResourceListChunk) return;
379
380 // make sure INFO list chunk exists
381 RIFF::List* lstINFO = pResourceListChunk->GetSubList(LIST_TYPE_INFO);
382
383 String defaultName = "";
384 String defaultCreationDate = "";
385 String defaultSoftware = "";
386 String defaultComments = "";
387
388 uint32_t resourceType = pResourceListChunk->GetListType();
389
390 if (!lstINFO) {
391 lstINFO = pResourceListChunk->AddSubList(LIST_TYPE_INFO);
392
393 // assemble default values
394 defaultName = "NONAME";
395
396 if (resourceType == RIFF_TYPE_DLS) {
397 // get current date
398 time_t now = time(NULL);
399 tm* pNowBroken = localtime(&now);
400 char buf[11];
401 strftime(buf, 11, "%F", pNowBroken);
402 defaultCreationDate = buf;
403
404 defaultComments = "Created with " + libraryName() + " " + libraryVersion();
405 }
406 if (resourceType == RIFF_TYPE_DLS || resourceType == LIST_TYPE_INS)
407 {
408 defaultSoftware = libraryName() + " " + libraryVersion();
409 }
410 }
411
412 // save values
413
414 SaveString(CHUNK_ID_IARL, lstINFO, ArchivalLocation, String(""));
415 SaveString(CHUNK_ID_IART, lstINFO, Artists, String(""));
416 SaveString(CHUNK_ID_ICMS, lstINFO, Commissioned, String(""));
417 SaveString(CHUNK_ID_ICMT, lstINFO, Comments, defaultComments);
418 SaveString(CHUNK_ID_ICOP, lstINFO, Copyright, String(""));
419 SaveString(CHUNK_ID_ICRD, lstINFO, CreationDate, defaultCreationDate);
420 SaveString(CHUNK_ID_IENG, lstINFO, Engineer, String(""));
421 SaveString(CHUNK_ID_IGNR, lstINFO, Genre, String(""));
422 SaveString(CHUNK_ID_IKEY, lstINFO, Keywords, String(""));
423 SaveString(CHUNK_ID_IMED, lstINFO, Medium, String(""));
424 SaveString(CHUNK_ID_INAM, lstINFO, Name, defaultName);
425 SaveString(CHUNK_ID_IPRD, lstINFO, Product, String(""));
426 SaveString(CHUNK_ID_ISBJ, lstINFO, Subject, String(""));
427 SaveString(CHUNK_ID_ISFT, lstINFO, Software, defaultSoftware);
428 SaveString(CHUNK_ID_ISRC, lstINFO, Source, String(""));
429 SaveString(CHUNK_ID_ISRF, lstINFO, SourceForm, String(""));
430 SaveString(CHUNK_ID_ITCH, lstINFO, Technician, String(""));
431 }
432
433 /** @brief Remove all RIFF chunks associated with this Info object.
434 *
435 * At the moment Info::DeleteChunks() does nothing. It is
436 * recommended to call this method explicitly though from deriving classes's
437 * own overridden implementation of this method to avoid potential future
438 * compatiblity issues.
439 *
440 * See Storage::DeleteChunks() for details.
441 */
442 void Info::DeleteChunks() {
443 }
444
445 /**
446 * Make a deep copy of the Info object given by @a orig and assign it to
447 * this object.
448 *
449 * @param orig - original Info object to be copied from
450 */
451 void Info::CopyAssign(const Info* orig) {
452 Name = orig->Name;
453 ArchivalLocation = orig->ArchivalLocation;
454 CreationDate = orig->CreationDate;
455 Comments = orig->Comments;
456 Product = orig->Product;
457 Copyright = orig->Copyright;
458 Artists = orig->Artists;
459 Genre = orig->Genre;
460 Keywords = orig->Keywords;
461 Engineer = orig->Engineer;
462 Technician = orig->Technician;
463 Software = orig->Software;
464 Medium = orig->Medium;
465 Source = orig->Source;
466 SourceForm = orig->SourceForm;
467 Commissioned = orig->Commissioned;
468 Subject = orig->Subject;
469 //FIXME: hmm, is copying this pointer a good idea?
470 pFixedStringLengths = orig->pFixedStringLengths;
471 }
472
473
474
475 // *************** Resource ***************
476 // *
477
478 /** @brief Constructor.
479 *
480 * Initializes the 'Resource' object with values provided by a given
481 * INFO list chunk and a DLID chunk (the latter optional).
482 *
483 * @param Parent - pointer to parent 'Resource', NULL if this is
484 * the toplevel 'Resource' object
485 * @param lstResource - pointer to an INFO list chunk
486 */
487 Resource::Resource(Resource* Parent, RIFF::List* lstResource) {
488 pParent = Parent;
489 pResourceList = lstResource;
490
491 pInfo = new Info(lstResource);
492
493 RIFF::Chunk* ckDLSID = lstResource->GetSubChunk(CHUNK_ID_DLID);
494 if (ckDLSID) {
495 ckDLSID->SetPos(0);
496
497 pDLSID = new dlsid_t;
498 ckDLSID->Read(&pDLSID->ulData1, 1, 4);
499 ckDLSID->Read(&pDLSID->usData2, 1, 2);
500 ckDLSID->Read(&pDLSID->usData3, 1, 2);
501 ckDLSID->Read(pDLSID->abData, 8, 1);
502 }
503 else pDLSID = NULL;
504 }
505
506 Resource::~Resource() {
507 if (pDLSID) delete pDLSID;
508 if (pInfo) delete pInfo;
509 }
510
511 /** @brief Remove all RIFF chunks associated with this Resource object.
512 *
513 * At the moment Resource::DeleteChunks() does nothing. It is recommended
514 * to call this method explicitly though from deriving classes's own
515 * overridden implementation of this method to avoid potential future
516 * compatiblity issues.
517 *
518 * See Storage::DeleteChunks() for details.
519 */
520 void Resource::DeleteChunks() {
521 }
522
523 /** @brief Update chunks with current Resource data.
524 *
525 * Apply Resource data persistently below the previously given resource
526 * list chunk. This will currently only include the INFO data. The DLSID
527 * will not be applied at the moment (yet).
528 *
529 * You have to call File::Save() to make changes persistent.
530 *
531 * @param pProgress - callback function for progress notification
532 */
533 void Resource::UpdateChunks(progress_t* pProgress) {
534 pInfo->UpdateChunks(pProgress);
535
536 if (pDLSID) {
537 // make sure 'dlid' chunk exists
538 RIFF::Chunk* ckDLSID = pResourceList->GetSubChunk(CHUNK_ID_DLID);
539 if (!ckDLSID) ckDLSID = pResourceList->AddSubChunk(CHUNK_ID_DLID, 16);
540 uint8_t* pData = (uint8_t*)ckDLSID->LoadChunkData();
541 // update 'dlid' chunk
542 store32(&pData[0], pDLSID->ulData1);
543 store16(&pData[4], pDLSID->usData2);
544 store16(&pData[6], pDLSID->usData3);
545 memcpy(&pData[8], pDLSID->abData, 8);
546 }
547 }
548
549 /**
550 * Generates a new DLSID for the resource.
551 */
552 void Resource::GenerateDLSID() {
553 #if defined(WIN32) || defined(__APPLE__) || defined(HAVE_UUID_GENERATE)
554 if (!pDLSID) pDLSID = new dlsid_t;
555 GenerateDLSID(pDLSID);
556 #endif
557 }
558
559 void Resource::GenerateDLSID(dlsid_t* pDLSID) {
560 #ifdef WIN32
561 UUID uuid;
562 UuidCreate(&uuid);
563 pDLSID->ulData1 = uuid.Data1;
564 pDLSID->usData2 = uuid.Data2;
565 pDLSID->usData3 = uuid.Data3;
566 memcpy(pDLSID->abData, uuid.Data4, 8);
567
568 #elif defined(__APPLE__)
569
570 CFUUIDRef uuidRef = CFUUIDCreate(NULL);
571 CFUUIDBytes uuid = CFUUIDGetUUIDBytes(uuidRef);
572 CFRelease(uuidRef);
573 pDLSID->ulData1 = uuid.byte0 | uuid.byte1 << 8 | uuid.byte2 << 16 | uuid.byte3 << 24;
574 pDLSID->usData2 = uuid.byte4 | uuid.byte5 << 8;
575 pDLSID->usData3 = uuid.byte6 | uuid.byte7 << 8;
576 pDLSID->abData[0] = uuid.byte8;
577 pDLSID->abData[1] = uuid.byte9;
578 pDLSID->abData[2] = uuid.byte10;
579 pDLSID->abData[3] = uuid.byte11;
580 pDLSID->abData[4] = uuid.byte12;
581 pDLSID->abData[5] = uuid.byte13;
582 pDLSID->abData[6] = uuid.byte14;
583 pDLSID->abData[7] = uuid.byte15;
584 #elif defined(HAVE_UUID_GENERATE)
585 uuid_t uuid;
586 uuid_generate(uuid);
587 pDLSID->ulData1 = uuid[0] | uuid[1] << 8 | uuid[2] << 16 | uuid[3] << 24;
588 pDLSID->usData2 = uuid[4] | uuid[5] << 8;
589 pDLSID->usData3 = uuid[6] | uuid[7] << 8;
590 memcpy(pDLSID->abData, &uuid[8], 8);
591 #else
592 # error "Missing support for uuid generation"
593 #endif
594 }
595
596 /**
597 * Make a deep copy of the Resource object given by @a orig and assign it
598 * to this object.
599 *
600 * @param orig - original Resource object to be copied from
601 */
602 void Resource::CopyAssign(const Resource* orig) {
603 pInfo->CopyAssign(orig->pInfo);
604 }
605
606
607 // *************** Sampler ***************
608 // *
609
610 Sampler::Sampler(RIFF::List* ParentList) {
611 pParentList = ParentList;
612 RIFF::Chunk* wsmp = ParentList->GetSubChunk(CHUNK_ID_WSMP);
613 if (wsmp) {
614 wsmp->SetPos(0);
615
616 uiHeaderSize = wsmp->ReadUint32();
617 UnityNote = wsmp->ReadUint16();
618 FineTune = wsmp->ReadInt16();
619 Gain = wsmp->ReadInt32();
620 SamplerOptions = wsmp->ReadUint32();
621 SampleLoops = wsmp->ReadUint32();
622 } else { // 'wsmp' chunk missing
623 uiHeaderSize = 20;
624 UnityNote = 60;
625 FineTune = 0; // +- 0 cents
626 Gain = 0; // 0 dB
627 SamplerOptions = F_WSMP_NO_COMPRESSION;
628 SampleLoops = 0;
629 }
630 NoSampleDepthTruncation = SamplerOptions & F_WSMP_NO_TRUNCATION;
631 NoSampleCompression = SamplerOptions & F_WSMP_NO_COMPRESSION;
632 pSampleLoops = (SampleLoops) ? new sample_loop_t[SampleLoops] : NULL;
633 if (SampleLoops) {
634 wsmp->SetPos(uiHeaderSize);
635 for (uint32_t i = 0; i < SampleLoops; i++) {
636 wsmp->Read(pSampleLoops + i, 4, 4);
637 if (pSampleLoops[i].Size > sizeof(sample_loop_t)) { // if loop struct was extended
638 wsmp->SetPos(pSampleLoops[i].Size - sizeof(sample_loop_t), RIFF::stream_curpos);
639 }
640 }
641 }
642 }
643
644 Sampler::~Sampler() {
645 if (pSampleLoops) delete[] pSampleLoops;
646 }
647
648 void Sampler::SetGain(int32_t gain) {
649 Gain = gain;
650 }
651
652 /**
653 * Apply all sample player options to the respective RIFF chunk. You
654 * have to call File::Save() to make changes persistent.
655 *
656 * @param pProgress - callback function for progress notification
657 */
658 void Sampler::UpdateChunks(progress_t* pProgress) {
659 // make sure 'wsmp' chunk exists
660 RIFF::Chunk* wsmp = pParentList->GetSubChunk(CHUNK_ID_WSMP);
661 int wsmpSize = uiHeaderSize + SampleLoops * 16;
662 if (!wsmp) {
663 wsmp = pParentList->AddSubChunk(CHUNK_ID_WSMP, wsmpSize);
664 } else if (wsmp->GetSize() != wsmpSize) {
665 wsmp->Resize(wsmpSize);
666 }
667 uint8_t* pData = (uint8_t*) wsmp->LoadChunkData();
668 // update headers size
669 store32(&pData[0], uiHeaderSize);
670 // update respective sampler options bits
671 SamplerOptions = (NoSampleDepthTruncation) ? SamplerOptions | F_WSMP_NO_TRUNCATION
672 : SamplerOptions & (~F_WSMP_NO_TRUNCATION);
673 SamplerOptions = (NoSampleCompression) ? SamplerOptions | F_WSMP_NO_COMPRESSION
674 : SamplerOptions & (~F_WSMP_NO_COMPRESSION);
675 store16(&pData[4], UnityNote);
676 store16(&pData[6], FineTune);
677 store32(&pData[8], Gain);
678 store32(&pData[12], SamplerOptions);
679 store32(&pData[16], SampleLoops);
680 // update loop definitions
681 for (uint32_t i = 0; i < SampleLoops; i++) {
682 //FIXME: this does not handle extended loop structs correctly
683 store32(&pData[uiHeaderSize + i * 16], pSampleLoops[i].Size);
684 store32(&pData[uiHeaderSize + i * 16 + 4], pSampleLoops[i].LoopType);
685 store32(&pData[uiHeaderSize + i * 16 + 8], pSampleLoops[i].LoopStart);
686 store32(&pData[uiHeaderSize + i * 16 + 12], pSampleLoops[i].LoopLength);
687 }
688 }
689
690 /** @brief Remove all RIFF chunks associated with this Sampler object.
691 *
692 * At the moment Sampler::DeleteChunks() does nothing. It is
693 * recommended to call this method explicitly though from deriving classes's
694 * own overridden implementation of this method to avoid potential future
695 * compatiblity issues.
696 *
697 * See Storage::DeleteChunks() for details.
698 */
699 void Sampler::DeleteChunks() {
700 }
701
702 /**
703 * Adds a new sample loop with the provided loop definition.
704 *
705 * @param pLoopDef - points to a loop definition that is to be copied
706 */
707 void Sampler::AddSampleLoop(sample_loop_t* pLoopDef) {
708 sample_loop_t* pNewLoops = new sample_loop_t[SampleLoops + 1];
709 // copy old loops array
710 for (int i = 0; i < SampleLoops; i++) {
711 pNewLoops[i] = pSampleLoops[i];
712 }
713 // add the new loop
714 pNewLoops[SampleLoops] = *pLoopDef;
715 // auto correct size field
716 pNewLoops[SampleLoops].Size = sizeof(DLS::sample_loop_t);
717 // free the old array and update the member variables
718 if (SampleLoops) delete[] pSampleLoops;
719 pSampleLoops = pNewLoops;
720 SampleLoops++;
721 }
722
723 /**
724 * Deletes an existing sample loop.
725 *
726 * @param pLoopDef - pointer to existing loop definition
727 * @throws Exception - if given loop definition does not exist
728 */
729 void Sampler::DeleteSampleLoop(sample_loop_t* pLoopDef) {
730 sample_loop_t* pNewLoops = new sample_loop_t[SampleLoops - 1];
731 // copy old loops array (skipping given loop)
732 for (int i = 0, o = 0; i < SampleLoops; i++) {
733 if (&pSampleLoops[i] == pLoopDef) continue;
734 if (o == SampleLoops - 1) {
735 delete[] pNewLoops;
736 throw Exception("Could not delete Sample Loop, because it does not exist");
737 }
738 pNewLoops[o] = pSampleLoops[i];
739 o++;
740 }
741 // free the old array and update the member variables
742 if (SampleLoops) delete[] pSampleLoops;
743 pSampleLoops = pNewLoops;
744 SampleLoops--;
745 }
746
747 /**
748 * Make a deep copy of the Sampler object given by @a orig and assign it
749 * to this object.
750 *
751 * @param orig - original Sampler object to be copied from
752 */
753 void Sampler::CopyAssign(const Sampler* orig) {
754 // copy trivial scalars
755 UnityNote = orig->UnityNote;
756 FineTune = orig->FineTune;
757 Gain = orig->Gain;
758 NoSampleDepthTruncation = orig->NoSampleDepthTruncation;
759 NoSampleCompression = orig->NoSampleCompression;
760 SamplerOptions = orig->SamplerOptions;
761
762 // copy sample loops
763 if (SampleLoops) delete[] pSampleLoops;
764 pSampleLoops = new sample_loop_t[orig->SampleLoops];
765 memcpy(pSampleLoops, orig->pSampleLoops, orig->SampleLoops * sizeof(sample_loop_t));
766 SampleLoops = orig->SampleLoops;
767 }
768
769
770 // *************** Sample ***************
771 // *
772
773 /** @brief Constructor.
774 *
775 * Load an existing sample or create a new one. A 'wave' list chunk must
776 * be given to this constructor. In case the given 'wave' list chunk
777 * contains a 'fmt' and 'data' chunk, the format and sample data will be
778 * loaded from there, otherwise default values will be used and those
779 * chunks will be created when File::Save() will be called later on.
780 *
781 * @param pFile - pointer to DLS::File where this sample is
782 * located (or will be located)
783 * @param waveList - pointer to 'wave' list chunk which is (or
784 * will be) associated with this sample
785 * @param WavePoolOffset - offset of this sample data from wave pool
786 * ('wvpl') list chunk
787 */
788 Sample::Sample(File* pFile, RIFF::List* waveList, file_offset_t WavePoolOffset) : Resource(pFile, waveList) {
789 pWaveList = waveList;
790 ullWavePoolOffset = WavePoolOffset - LIST_HEADER_SIZE(waveList->GetFile()->GetFileOffsetSize());
791 pCkFormat = waveList->GetSubChunk(CHUNK_ID_FMT);
792 pCkData = waveList->GetSubChunk(CHUNK_ID_DATA);
793 if (pCkFormat) {
794 pCkFormat->SetPos(0);
795
796 // common fields
797 FormatTag = pCkFormat->ReadUint16();
798 Channels = pCkFormat->ReadUint16();
799 SamplesPerSecond = pCkFormat->ReadUint32();
800 AverageBytesPerSecond = pCkFormat->ReadUint32();
801 BlockAlign = pCkFormat->ReadUint16();
802 // PCM format specific
803 if (FormatTag == DLS_WAVE_FORMAT_PCM) {
804 BitDepth = pCkFormat->ReadUint16();
805 FrameSize = (BitDepth / 8) * Channels;
806 } else { // unsupported sample data format
807 BitDepth = 0;
808 FrameSize = 0;
809 }
810 } else { // 'fmt' chunk missing
811 FormatTag = DLS_WAVE_FORMAT_PCM;
812 BitDepth = 16;
813 Channels = 1;
814 SamplesPerSecond = 44100;
815 AverageBytesPerSecond = (BitDepth / 8) * SamplesPerSecond * Channels;
816 FrameSize = (BitDepth / 8) * Channels;
817 BlockAlign = FrameSize;
818 }
819 SamplesTotal = (pCkData) ? (FormatTag == DLS_WAVE_FORMAT_PCM) ? pCkData->GetSize() / FrameSize
820 : 0
821 : 0;
822 }
823
824 /** @brief Destructor.
825 *
826 * Frees all memory occupied by this sample.
827 */
828 Sample::~Sample() {
829 if (pCkData)
830 pCkData->ReleaseChunkData();
831 if (pCkFormat)
832 pCkFormat->ReleaseChunkData();
833 }
834
835 /** @brief Remove all RIFF chunks associated with this Sample object.
836 *
837 * See Storage::DeleteChunks() for details.
838 */
839 void Sample::DeleteChunks() {
840 // handle base class
841 Resource::DeleteChunks();
842
843 // handle own RIFF chunks
844 if (pWaveList) {
845 RIFF::List* pParent = pWaveList->GetParent();
846 pParent->DeleteSubChunk(pWaveList);
847 pWaveList = NULL;
848 }
849 }
850
851 /**
852 * Make a deep copy of the Sample object given by @a orig (without the
853 * actual sample waveform data however) and assign it to this object.
854 *
855 * This is a special internal variant of CopyAssign() which only copies the
856 * most mandatory member variables. It will be called by gig::Sample
857 * descendent instead of CopyAssign() since gig::Sample has its own
858 * implementation to access and copy the actual sample waveform data.
859 *
860 * @param orig - original Sample object to be copied from
861 */
862 void Sample::CopyAssignCore(const Sample* orig) {
863 // handle base classes
864 Resource::CopyAssign(orig);
865 // handle actual own attributes of this class
866 FormatTag = orig->FormatTag;
867 Channels = orig->Channels;
868 SamplesPerSecond = orig->SamplesPerSecond;
869 AverageBytesPerSecond = orig->AverageBytesPerSecond;
870 BlockAlign = orig->BlockAlign;
871 BitDepth = orig->BitDepth;
872 SamplesTotal = orig->SamplesTotal;
873 FrameSize = orig->FrameSize;
874 }
875
876 /**
877 * Make a deep copy of the Sample object given by @a orig and assign it to
878 * this object.
879 *
880 * @param orig - original Sample object to be copied from
881 */
882 void Sample::CopyAssign(const Sample* orig) {
883 CopyAssignCore(orig);
884
885 // copy sample waveform data (reading directly from disc)
886 Resize(orig->GetSize());
887 char* buf = (char*) LoadSampleData();
888 Sample* pOrig = (Sample*) orig; //HACK: circumventing the constness here for now
889 const file_offset_t restorePos = pOrig->pCkData->GetPos();
890 pOrig->SetPos(0);
891 for (file_offset_t todo = pOrig->GetSize(), i = 0; todo; ) {
892 const int iReadAtOnce = 64*1024;
893 file_offset_t n = (iReadAtOnce < todo) ? iReadAtOnce : todo;
894 n = pOrig->Read(&buf[i], n);
895 if (!n) break;
896 todo -= n;
897 i += (n * pOrig->FrameSize);
898 }
899 pOrig->pCkData->SetPos(restorePos);
900 }
901
902 /** @brief Load sample data into RAM.
903 *
904 * In case the respective 'data' chunk exists, the sample data will be
905 * loaded into RAM (if not done already) and a pointer to the data in
906 * RAM will be returned. If this is a new sample, you have to call
907 * Resize() with the desired sample size to create the mandatory RIFF
908 * chunk for the sample wave data.
909 *
910 * You can call LoadChunkData() again if you previously scheduled to
911 * enlarge the sample data RIFF chunk with a Resize() call. In that case
912 * the buffer will be enlarged to the new, scheduled size and you can
913 * already place the sample wave data to the buffer and finally call
914 * File::Save() to enlarge the sample data's chunk physically and write
915 * the new sample wave data in one rush. This approach is definitely
916 * recommended if you have to enlarge and write new sample data to a lot
917 * of samples.
918 *
919 * <b>Caution:</b> the buffer pointer will be invalidated once
920 * File::Save() was called. You have to call LoadChunkData() again to
921 * get a new, valid pointer whenever File::Save() was called.
922 *
923 * @returns pointer to sample data in RAM, NULL in case respective
924 * 'data' chunk does not exist (yet)
925 * @throws Exception if data buffer could not be enlarged
926 * @see Resize(), File::Save()
927 */
928 void* Sample::LoadSampleData() {
929 return (pCkData) ? pCkData->LoadChunkData() : NULL;
930 }
931
932 /** @brief Free sample data from RAM.
933 *
934 * In case sample data was previously successfully loaded into RAM with
935 * LoadSampleData(), this method will free the sample data from RAM.
936 */
937 void Sample::ReleaseSampleData() {
938 if (pCkData) pCkData->ReleaseChunkData();
939 }
940
941 /** @brief Returns sample size.
942 *
943 * Returns the sample wave form's data size (in sample points). This is
944 * actually the current, physical size (converted to sample points) of
945 * the RIFF chunk which encapsulates the sample's wave data. The
946 * returned value is dependant to the current FrameSize value.
947 *
948 * @returns number of sample points or 0 if FormatTag != DLS_WAVE_FORMAT_PCM
949 * @see FrameSize, FormatTag
950 */
951 file_offset_t Sample::GetSize() const {
952 if (FormatTag != DLS_WAVE_FORMAT_PCM) return 0;
953 return (pCkData) ? pCkData->GetSize() / FrameSize : 0;
954 }
955
956 /** @brief Resize sample.
957 *
958 * Resizes the sample's wave form data, that is the actual size of
959 * sample wave data possible to be written for this sample. This call
960 * will return immediately and just schedule the resize operation. You
961 * should call File::Save() to actually perform the resize operation(s)
962 * "physically" to the file. As this can take a while on large files, it
963 * is recommended to call Resize() first on all samples which have to be
964 * resized and finally to call File::Save() to perform all those resize
965 * operations in one rush.
966 *
967 * The actual size (in bytes) is dependant to the current FrameSize
968 * value. You may want to set FrameSize before calling Resize().
969 *
970 * <b>Caution:</b> You cannot directly write to enlarged samples before
971 * calling File::Save() as this might exceed the current sample's
972 * boundary!
973 *
974 * Also note: only DLS_WAVE_FORMAT_PCM is currently supported, that is
975 * FormatTag must be DLS_WAVE_FORMAT_PCM. Trying to resize samples with
976 * other formats will fail!
977 *
978 * @param NewSize - new sample wave data size in sample points (must be
979 * greater than zero)
980 * @throws Exception if FormatTag != DLS_WAVE_FORMAT_PCM
981 * @throws Exception if \a NewSize is less than 1 or unrealistic large
982 * @see File::Save(), FrameSize, FormatTag
983 */
984 void Sample::Resize(file_offset_t NewSize) {
985 if (FormatTag != DLS_WAVE_FORMAT_PCM) throw Exception("Sample's format is not DLS_WAVE_FORMAT_PCM");
986 if (NewSize < 1) throw Exception("Sample size must be at least one sample point");
987 if ((NewSize >> 48) != 0)
988 throw Exception("Unrealistic high DLS sample size detected");
989 const file_offset_t sizeInBytes = NewSize * FrameSize;
990 pCkData = pWaveList->GetSubChunk(CHUNK_ID_DATA);
991 if (pCkData) pCkData->Resize(sizeInBytes);
992 else pCkData = pWaveList->AddSubChunk(CHUNK_ID_DATA, sizeInBytes);
993 }
994
995 /**
996 * Sets the position within the sample (in sample points, not in
997 * bytes). Use this method and <i>Read()</i> if you don't want to load
998 * the sample into RAM, thus for disk streaming.
999 *
1000 * Also note: only DLS_WAVE_FORMAT_PCM is currently supported, that is
1001 * FormatTag must be DLS_WAVE_FORMAT_PCM. Trying to reposition the sample
1002 * with other formats will fail!
1003 *
1004 * @param SampleCount number of sample points
1005 * @param Whence to which relation \a SampleCount refers to
1006 * @returns new position within the sample, 0 if
1007 * FormatTag != DLS_WAVE_FORMAT_PCM
1008 * @throws Exception if no data RIFF chunk was created for the sample yet
1009 * @see FrameSize, FormatTag
1010 */
1011 file_offset_t Sample::SetPos(file_offset_t SampleCount, RIFF::stream_whence_t Whence) {
1012 if (FormatTag != DLS_WAVE_FORMAT_PCM) return 0; // failed: wave data not PCM format
1013 if (!pCkData) throw Exception("No data chunk created for sample yet, call Sample::Resize() to create one");
1014 file_offset_t orderedBytes = SampleCount * FrameSize;
1015 file_offset_t result = pCkData->SetPos(orderedBytes, Whence);
1016 return (result == orderedBytes) ? SampleCount
1017 : result / FrameSize;
1018 }
1019
1020 /**
1021 * Reads \a SampleCount number of sample points from the current
1022 * position into the buffer pointed by \a pBuffer and increments the
1023 * position within the sample. Use this method and <i>SetPos()</i> if you
1024 * don't want to load the sample into RAM, thus for disk streaming.
1025 *
1026 * @param pBuffer destination buffer
1027 * @param SampleCount number of sample points to read
1028 */
1029 file_offset_t Sample::Read(void* pBuffer, file_offset_t SampleCount) {
1030 if (FormatTag != DLS_WAVE_FORMAT_PCM) return 0; // failed: wave data not PCM format
1031 return pCkData->Read(pBuffer, SampleCount, FrameSize); // FIXME: channel inversion due to endian correction?
1032 }
1033
1034 /** @brief Write sample wave data.
1035 *
1036 * Writes \a SampleCount number of sample points from the buffer pointed
1037 * by \a pBuffer and increments the position within the sample. Use this
1038 * method to directly write the sample data to disk, i.e. if you don't
1039 * want or cannot load the whole sample data into RAM.
1040 *
1041 * You have to Resize() the sample to the desired size and call
1042 * File::Save() <b>before</b> using Write().
1043 *
1044 * @param pBuffer - source buffer
1045 * @param SampleCount - number of sample points to write
1046 * @throws Exception if current sample size is too small
1047 * @see LoadSampleData()
1048 */
1049 file_offset_t Sample::Write(void* pBuffer, file_offset_t SampleCount) {
1050 if (FormatTag != DLS_WAVE_FORMAT_PCM) return 0; // failed: wave data not PCM format
1051 if (GetSize() < SampleCount) throw Exception("Could not write sample data, current sample size to small");
1052 return pCkData->Write(pBuffer, SampleCount, FrameSize); // FIXME: channel inversion due to endian correction?
1053 }
1054
1055 /**
1056 * Apply sample and its settings to the respective RIFF chunks. You have
1057 * to call File::Save() to make changes persistent.
1058 *
1059 * @param pProgress - callback function for progress notification
1060 * @throws Exception if FormatTag != DLS_WAVE_FORMAT_PCM or no sample data
1061 * was provided yet
1062 */
1063 void Sample::UpdateChunks(progress_t* pProgress) {
1064 if (FormatTag != DLS_WAVE_FORMAT_PCM)
1065 throw Exception("Could not save sample, only PCM format is supported");
1066 // we refuse to do anything if not sample wave form was provided yet
1067 if (!pCkData)
1068 throw Exception("Could not save sample, there is no sample data to save");
1069 // update chunks of base class as well
1070 Resource::UpdateChunks(pProgress);
1071 // make sure 'fmt' chunk exists
1072 RIFF::Chunk* pCkFormat = pWaveList->GetSubChunk(CHUNK_ID_FMT);
1073 if (!pCkFormat) pCkFormat = pWaveList->AddSubChunk(CHUNK_ID_FMT, 16); // assumes PCM format
1074 uint8_t* pData = (uint8_t*) pCkFormat->LoadChunkData();
1075 // update 'fmt' chunk
1076 store16(&pData[0], FormatTag);
1077 store16(&pData[2], Channels);
1078 store32(&pData[4], SamplesPerSecond);
1079 store32(&pData[8], AverageBytesPerSecond);
1080 store16(&pData[12], BlockAlign);
1081 store16(&pData[14], BitDepth); // assuming PCM format
1082 }
1083
1084
1085
1086 // *************** Region ***************
1087 // *
1088
1089 Region::Region(Instrument* pInstrument, RIFF::List* rgnList) : Resource(pInstrument, rgnList), Articulator(rgnList), Sampler(rgnList) {
1090 pCkRegion = rgnList;
1091
1092 // articulation information
1093 RIFF::Chunk* rgnh = rgnList->GetSubChunk(CHUNK_ID_RGNH);
1094 if (rgnh) {
1095 rgnh->SetPos(0);
1096
1097 rgnh->Read(&KeyRange, 2, 2);
1098 rgnh->Read(&VelocityRange, 2, 2);
1099 FormatOptionFlags = rgnh->ReadUint16();
1100 KeyGroup = rgnh->ReadUint16();
1101 // Layer is optional
1102 if (rgnh->RemainingBytes() >= sizeof(uint16_t)) {
1103 rgnh->Read(&Layer, 1, sizeof(uint16_t));
1104 } else Layer = 0;
1105 } else { // 'rgnh' chunk is missing
1106 KeyRange.low = 0;
1107 KeyRange.high = 127;
1108 VelocityRange.low = 0;
1109 VelocityRange.high = 127;
1110 FormatOptionFlags = F_RGN_OPTION_SELFNONEXCLUSIVE;
1111 KeyGroup = 0;
1112 Layer = 0;
1113 }
1114 SelfNonExclusive = FormatOptionFlags & F_RGN_OPTION_SELFNONEXCLUSIVE;
1115
1116 // sample information
1117 RIFF::Chunk* wlnk = rgnList->GetSubChunk(CHUNK_ID_WLNK);
1118 if (wlnk) {
1119 wlnk->SetPos(0);
1120
1121 WaveLinkOptionFlags = wlnk->ReadUint16();
1122 PhaseGroup = wlnk->ReadUint16();
1123 Channel = wlnk->ReadUint32();
1124 WavePoolTableIndex = wlnk->ReadUint32();
1125 } else { // 'wlnk' chunk is missing
1126 WaveLinkOptionFlags = 0;
1127 PhaseGroup = 0;
1128 Channel = 0; // mono
1129 WavePoolTableIndex = 0; // first entry in wave pool table
1130 }
1131 PhaseMaster = WaveLinkOptionFlags & F_WAVELINK_PHASE_MASTER;
1132 MultiChannel = WaveLinkOptionFlags & F_WAVELINK_MULTICHANNEL;
1133
1134 pSample = NULL;
1135 }
1136
1137 /** @brief Destructor.
1138 *
1139 * Intended to free up all memory occupied by this Region object. ATM this
1140 * destructor implementation does nothing though.
1141 */
1142 Region::~Region() {
1143 }
1144
1145 /** @brief Remove all RIFF chunks associated with this Region object.
1146 *
1147 * See Storage::DeleteChunks() for details.
1148 */
1149 void Region::DeleteChunks() {
1150 // handle base classes
1151 Resource::DeleteChunks();
1152 Articulator::DeleteChunks();
1153 Sampler::DeleteChunks();
1154
1155 // handle own RIFF chunks
1156 if (pCkRegion) {
1157 RIFF::List* pParent = pCkRegion->GetParent();
1158 pParent->DeleteSubChunk(pCkRegion);
1159 pCkRegion = NULL;
1160 }
1161 }
1162
1163 Sample* Region::GetSample() {
1164 if (pSample) return pSample;
1165 File* file = (File*) GetParent()->GetParent();
1166 uint64_t soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
1167 size_t i = 0;
1168 for (Sample* sample = file->GetSample(i); sample;
1169 sample = file->GetSample(++i))
1170 {
1171 if (sample->ullWavePoolOffset == soughtoffset) return (pSample = sample);
1172 }
1173 return NULL;
1174 }
1175
1176 /**
1177 * Assign another sample to this Region.
1178 *
1179 * @param pSample - sample to be assigned
1180 */
1181 void Region::SetSample(Sample* pSample) {
1182 this->pSample = pSample;
1183 WavePoolTableIndex = 0; // we update this offset when we Save()
1184 }
1185
1186 /**
1187 * Modifies the key range of this Region and makes sure the respective
1188 * chunks are in correct order.
1189 *
1190 * @param Low - lower end of key range
1191 * @param High - upper end of key range
1192 */
1193 void Region::SetKeyRange(uint16_t Low, uint16_t High) {
1194 KeyRange.low = Low;
1195 KeyRange.high = High;
1196
1197 // make sure regions are already loaded
1198 Instrument* pInstrument = (Instrument*) GetParent();
1199 if (!pInstrument->pRegions) pInstrument->LoadRegions();
1200 if (!pInstrument->pRegions) return;
1201
1202 // find the r which is the first one to the right of this region
1203 // at its new position
1204 Region* r = NULL;
1205 Region* prev_region = NULL;
1206 for (
1207 Instrument::RegionList::iterator iter = pInstrument->pRegions->begin();
1208 iter != pInstrument->pRegions->end(); iter++
1209 ) {
1210 if ((*iter)->KeyRange.low > this->KeyRange.low) {
1211 r = *iter;
1212 break;
1213 }
1214 prev_region = *iter;
1215 }
1216
1217 // place this region before r if it's not already there
1218 if (prev_region != this) pInstrument->MoveRegion(this, r);
1219 }
1220
1221 /**
1222 * Apply Region settings to the respective RIFF chunks. You have to
1223 * call File::Save() to make changes persistent.
1224 *
1225 * @param pProgress - callback function for progress notification
1226 * @throws Exception - if the Region's sample could not be found
1227 */
1228 void Region::UpdateChunks(progress_t* pProgress) {
1229 // make sure 'rgnh' chunk exists
1230 RIFF::Chunk* rgnh = pCkRegion->GetSubChunk(CHUNK_ID_RGNH);
1231 if (!rgnh) rgnh = pCkRegion->AddSubChunk(CHUNK_ID_RGNH, Layer ? 14 : 12);
1232 uint8_t* pData = (uint8_t*) rgnh->LoadChunkData();
1233 FormatOptionFlags = (SelfNonExclusive)
1234 ? FormatOptionFlags | F_RGN_OPTION_SELFNONEXCLUSIVE
1235 : FormatOptionFlags & (~F_RGN_OPTION_SELFNONEXCLUSIVE);
1236 // update 'rgnh' chunk
1237 store16(&pData[0], KeyRange.low);
1238 store16(&pData[2], KeyRange.high);
1239 store16(&pData[4], VelocityRange.low);
1240 store16(&pData[6], VelocityRange.high);
1241 store16(&pData[8], FormatOptionFlags);
1242 store16(&pData[10], KeyGroup);
1243 if (rgnh->GetSize() >= 14) store16(&pData[12], Layer);
1244
1245 // update chunks of base classes as well (but skip Resource,
1246 // as a rgn doesn't seem to have dlid and INFO chunks)
1247 Articulator::UpdateChunks(pProgress);
1248 Sampler::UpdateChunks(pProgress);
1249
1250 // make sure 'wlnk' chunk exists
1251 RIFF::Chunk* wlnk = pCkRegion->GetSubChunk(CHUNK_ID_WLNK);
1252 if (!wlnk) wlnk = pCkRegion->AddSubChunk(CHUNK_ID_WLNK, 12);
1253 pData = (uint8_t*) wlnk->LoadChunkData();
1254 WaveLinkOptionFlags = (PhaseMaster)
1255 ? WaveLinkOptionFlags | F_WAVELINK_PHASE_MASTER
1256 : WaveLinkOptionFlags & (~F_WAVELINK_PHASE_MASTER);
1257 WaveLinkOptionFlags = (MultiChannel)
1258 ? WaveLinkOptionFlags | F_WAVELINK_MULTICHANNEL
1259 : WaveLinkOptionFlags & (~F_WAVELINK_MULTICHANNEL);
1260 // get sample's wave pool table index
1261 int index = -1;
1262 File* pFile = (File*) GetParent()->GetParent();
1263 if (pFile->pSamples) {
1264 File::SampleList::iterator iter = pFile->pSamples->begin();
1265 File::SampleList::iterator end = pFile->pSamples->end();
1266 for (int i = 0; iter != end; ++iter, i++) {
1267 if (*iter == pSample) {
1268 index = i;
1269 break;
1270 }
1271 }
1272 }
1273 WavePoolTableIndex = index;
1274 // update 'wlnk' chunk
1275 store16(&pData[0], WaveLinkOptionFlags);
1276 store16(&pData[2], PhaseGroup);
1277 store32(&pData[4], Channel);
1278 store32(&pData[8], WavePoolTableIndex);
1279 }
1280
1281 /**
1282 * Make a (semi) deep copy of the Region object given by @a orig and assign
1283 * it to this object.
1284 *
1285 * Note that the sample pointer referenced by @a orig is simply copied as
1286 * memory address. Thus the respective sample is shared, not duplicated!
1287 *
1288 * @param orig - original Region object to be copied from
1289 */
1290 void Region::CopyAssign(const Region* orig) {
1291 // handle base classes
1292 Resource::CopyAssign(orig);
1293 Articulator::CopyAssign(orig);
1294 Sampler::CopyAssign(orig);
1295 // handle actual own attributes of this class
1296 // (the trivial ones)
1297 VelocityRange = orig->VelocityRange;
1298 KeyGroup = orig->KeyGroup;
1299 Layer = orig->Layer;
1300 SelfNonExclusive = orig->SelfNonExclusive;
1301 PhaseMaster = orig->PhaseMaster;
1302 PhaseGroup = orig->PhaseGroup;
1303 MultiChannel = orig->MultiChannel;
1304 Channel = orig->Channel;
1305 // only take the raw sample reference if the two Region objects are
1306 // part of the same file
1307 if (GetParent()->GetParent() == orig->GetParent()->GetParent()) {
1308 WavePoolTableIndex = orig->WavePoolTableIndex;
1309 pSample = orig->pSample;
1310 } else {
1311 WavePoolTableIndex = -1;
1312 pSample = NULL;
1313 }
1314 FormatOptionFlags = orig->FormatOptionFlags;
1315 WaveLinkOptionFlags = orig->WaveLinkOptionFlags;
1316 // handle the last, a bit sensible attribute
1317 SetKeyRange(orig->KeyRange.low, orig->KeyRange.high);
1318 }
1319
1320
1321 // *************** Instrument ***************
1322 // *
1323
1324 /** @brief Constructor.
1325 *
1326 * Load an existing instrument definition or create a new one. An 'ins'
1327 * list chunk must be given to this constructor. In case this 'ins' list
1328 * chunk contains a 'insh' chunk, the instrument data fields will be
1329 * loaded from there, otherwise default values will be used and the
1330 * 'insh' chunk will be created once File::Save() was called.
1331 *
1332 * @param pFile - pointer to DLS::File where this instrument is
1333 * located (or will be located)
1334 * @param insList - pointer to 'ins' list chunk which is (or will be)
1335 * associated with this instrument
1336 */
1337 Instrument::Instrument(File* pFile, RIFF::List* insList) : Resource(pFile, insList), Articulator(insList) {
1338 pCkInstrument = insList;
1339
1340 midi_locale_t locale;
1341 RIFF::Chunk* insh = pCkInstrument->GetSubChunk(CHUNK_ID_INSH);
1342 if (insh) {
1343 insh->SetPos(0);
1344
1345 Regions = insh->ReadUint32();
1346 insh->Read(&locale, 2, 4);
1347 } else { // 'insh' chunk missing
1348 Regions = 0;
1349 locale.bank = 0;
1350 locale.instrument = 0;
1351 }
1352
1353 MIDIProgram = locale.instrument;
1354 IsDrum = locale.bank & DRUM_TYPE_MASK;
1355 MIDIBankCoarse = (uint8_t) MIDI_BANK_COARSE(locale.bank);
1356 MIDIBankFine = (uint8_t) MIDI_BANK_FINE(locale.bank);
1357 MIDIBank = MIDI_BANK_MERGE(MIDIBankCoarse, MIDIBankFine);
1358
1359 pRegions = NULL;
1360 }
1361
1362 /**
1363 * Returns Region at supplied @a pos position within the region list of
1364 * this instrument. If supplied @a pos is out of bounds then @c NULL is
1365 * returned.
1366 *
1367 * @param pos - position of sought Region in region list
1368 * @returns pointer address to requested region or @c NULL if @a pos is
1369 * out of bounds
1370 */
1371 Region* Instrument::GetRegionAt(size_t pos) {
1372 if (!pRegions) LoadRegions();
1373 if (!pRegions) return NULL;
1374 if (pos >= pRegions->size()) return NULL;
1375 return (*pRegions)[pos];
1376 }
1377
1378 /**
1379 * Returns the first Region of the instrument. You have to call this
1380 * method once before you use GetNextRegion().
1381 *
1382 * @returns pointer address to first region or NULL if there is none
1383 * @see GetNextRegion()
1384 * @deprecated This method is not reentrant-safe, use GetRegionAt()
1385 * instead.
1386 */
1387 Region* Instrument::GetFirstRegion() {
1388 if (!pRegions) LoadRegions();
1389 if (!pRegions) return NULL;
1390 RegionsIterator = pRegions->begin();
1391 return (RegionsIterator != pRegions->end()) ? *RegionsIterator : NULL;
1392 }
1393
1394 /**
1395 * Returns the next Region of the instrument. You have to call
1396 * GetFirstRegion() once before you can use this method. By calling this
1397 * method multiple times it iterates through the available Regions.
1398 *
1399 * @returns pointer address to the next region or NULL if end reached
1400 * @see GetFirstRegion()
1401 * @deprecated This method is not reentrant-safe, use GetRegionAt()
1402 * instead.
1403 */
1404 Region* Instrument::GetNextRegion() {
1405 if (!pRegions) return NULL;
1406 RegionsIterator++;
1407 return (RegionsIterator != pRegions->end()) ? *RegionsIterator : NULL;
1408 }
1409
1410 void Instrument::LoadRegions() {
1411 if (!pRegions) pRegions = new RegionList;
1412 RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
1413 if (lrgn) {
1414 uint32_t regionCkType = (lrgn->GetSubList(LIST_TYPE_RGN2)) ? LIST_TYPE_RGN2 : LIST_TYPE_RGN; // prefer regions level 2
1415 size_t i = 0;
1416 for (RIFF::List* rgn = lrgn->GetSubListAt(i); rgn;
1417 rgn = lrgn->GetSubListAt(++i))
1418 {
1419 if (rgn->GetListType() == regionCkType) {
1420 pRegions->push_back(new Region(this, rgn));
1421 }
1422 }
1423 }
1424 }
1425
1426 Region* Instrument::AddRegion() {
1427 if (!pRegions) LoadRegions();
1428 RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
1429 if (!lrgn) lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
1430 RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
1431 Region* pNewRegion = new Region(this, rgn);
1432 pRegions->push_back(pNewRegion);
1433 Regions = (uint32_t) pRegions->size();
1434 return pNewRegion;
1435 }
1436
1437 void Instrument::MoveRegion(Region* pSrc, Region* pDst) {
1438 RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
1439 lrgn->MoveSubChunk(pSrc->pCkRegion, (RIFF::Chunk*) (pDst ? pDst->pCkRegion : 0));
1440 for (size_t i = 0; i < pRegions->size(); ++i) {
1441 if ((*pRegions)[i] == pSrc) {
1442 pRegions->erase(pRegions->begin() + i);
1443 RegionList::iterator iter = find(pRegions->begin(), pRegions->end(), pDst);
1444 pRegions->insert(iter, pSrc);
1445 }
1446 }
1447 }
1448
1449 void Instrument::DeleteRegion(Region* pRegion) {
1450 if (!pRegions) return;
1451 RegionList::iterator iter = find(pRegions->begin(), pRegions->end(), pRegion);
1452 if (iter == pRegions->end()) return;
1453 pRegions->erase(iter);
1454 Regions = (uint32_t) pRegions->size();
1455 pRegion->DeleteChunks();
1456 delete pRegion;
1457 }
1458
1459 /**
1460 * Apply Instrument with all its Regions to the respective RIFF chunks.
1461 * You have to call File::Save() to make changes persistent.
1462 *
1463 * @param pProgress - callback function for progress notification
1464 * @throws Exception - on errors
1465 */
1466 void Instrument::UpdateChunks(progress_t* pProgress) {
1467 // first update base classes' chunks
1468 Resource::UpdateChunks(pProgress);
1469 Articulator::UpdateChunks(pProgress);
1470 // make sure 'insh' chunk exists
1471 RIFF::Chunk* insh = pCkInstrument->GetSubChunk(CHUNK_ID_INSH);
1472 if (!insh) insh = pCkInstrument->AddSubChunk(CHUNK_ID_INSH, 12);
1473 uint8_t* pData = (uint8_t*) insh->LoadChunkData();
1474 // update 'insh' chunk
1475 Regions = (pRegions) ? uint32_t(pRegions->size()) : 0;
1476 midi_locale_t locale;
1477 locale.instrument = MIDIProgram;
1478 locale.bank = MIDI_BANK_ENCODE(MIDIBankCoarse, MIDIBankFine);
1479 locale.bank = (IsDrum) ? locale.bank | DRUM_TYPE_MASK : locale.bank & (~DRUM_TYPE_MASK);
1480 MIDIBank = MIDI_BANK_MERGE(MIDIBankCoarse, MIDIBankFine); // just a sync, when we're at it
1481 store32(&pData[0], Regions);
1482 store32(&pData[4], locale.bank);
1483 store32(&pData[8], locale.instrument);
1484 // update Region's chunks
1485 if (!pRegions) return;
1486 RegionList::iterator iter = pRegions->begin();
1487 RegionList::iterator end = pRegions->end();
1488 for (int i = 0; iter != end; ++iter, ++i) {
1489 if (pProgress) {
1490 // divide local progress into subprogress
1491 progress_t subprogress;
1492 __divide_progress(pProgress, &subprogress, pRegions->size(), i);
1493 // do the actual work
1494 (*iter)->UpdateChunks(&subprogress);
1495 } else
1496 (*iter)->UpdateChunks(NULL);
1497 }
1498 if (pProgress)
1499 __notify_progress(pProgress, 1.0); // notify done
1500 }
1501
1502 /** @brief Destructor.
1503 *
1504 * Frees all memory occupied by this instrument.
1505 */
1506 Instrument::~Instrument() {
1507 if (pRegions) {
1508 RegionList::iterator iter = pRegions->begin();
1509 RegionList::iterator end = pRegions->end();
1510 while (iter != end) {
1511 delete *iter;
1512 iter++;
1513 }
1514 delete pRegions;
1515 }
1516 }
1517
1518 /** @brief Remove all RIFF chunks associated with this Instrument object.
1519 *
1520 * See Storage::DeleteChunks() for details.
1521 */
1522 void Instrument::DeleteChunks() {
1523 // handle base classes
1524 Resource::DeleteChunks();
1525 Articulator::DeleteChunks();
1526
1527 // handle RIFF chunks of members
1528 if (pRegions) {
1529 RegionList::iterator it = pRegions->begin();
1530 RegionList::iterator end = pRegions->end();
1531 for (; it != end; ++it)
1532 (*it)->DeleteChunks();
1533 }
1534
1535 // handle own RIFF chunks
1536 if (pCkInstrument) {
1537 RIFF::List* pParent = pCkInstrument->GetParent();
1538 pParent->DeleteSubChunk(pCkInstrument);
1539 pCkInstrument = NULL;
1540 }
1541 }
1542
1543 void Instrument::CopyAssignCore(const Instrument* orig) {
1544 // handle base classes
1545 Resource::CopyAssign(orig);
1546 Articulator::CopyAssign(orig);
1547 // handle actual own attributes of this class
1548 // (the trivial ones)
1549 IsDrum = orig->IsDrum;
1550 MIDIBank = orig->MIDIBank;
1551 MIDIBankCoarse = orig->MIDIBankCoarse;
1552 MIDIBankFine = orig->MIDIBankFine;
1553 MIDIProgram = orig->MIDIProgram;
1554 }
1555
1556 /**
1557 * Make a (semi) deep copy of the Instrument object given by @a orig and assign
1558 * it to this object.
1559 *
1560 * Note that all sample pointers referenced by @a orig are simply copied as
1561 * memory address. Thus the respective samples are shared, not duplicated!
1562 *
1563 * @param orig - original Instrument object to be copied from
1564 */
1565 void Instrument::CopyAssign(const Instrument* orig) {
1566 CopyAssignCore(orig);
1567 // delete all regions first
1568 while (Regions) DeleteRegion(GetRegionAt(0));
1569 // now recreate and copy regions
1570 {
1571 RegionList::const_iterator it = orig->pRegions->begin();
1572 for (int i = 0; i < orig->Regions; ++i, ++it) {
1573 Region* dstRgn = AddRegion();
1574 //NOTE: Region does semi-deep copy !
1575 dstRgn->CopyAssign(*it);
1576 }
1577 }
1578 }
1579
1580
1581 // *************** File ***************
1582 // *
1583
1584 /** @brief Constructor.
1585 *
1586 * Default constructor, use this to create an empty DLS file. You have
1587 * to add samples, instruments and finally call Save() to actually write
1588 * a DLS file.
1589 */
1590 File::File() : Resource(NULL, pRIFF = new RIFF::File(RIFF_TYPE_DLS)) {
1591 pRIFF->SetByteOrder(RIFF::endian_little);
1592 bOwningRiff = true;
1593 pVersion = new version_t;
1594 pVersion->major = 0;
1595 pVersion->minor = 0;
1596 pVersion->release = 0;
1597 pVersion->build = 0;
1598
1599 Instruments = 0;
1600 WavePoolCount = 0;
1601 pWavePoolTable = NULL;
1602 pWavePoolTableHi = NULL;
1603 WavePoolHeaderSize = 8;
1604
1605 pSamples = NULL;
1606 pInstruments = NULL;
1607
1608 b64BitWavePoolOffsets = false;
1609 }
1610
1611 /** @brief Constructor.
1612 *
1613 * Load an existing DLS file.
1614 *
1615 * @param pRIFF - pointer to a RIFF file which is actually the DLS file
1616 * to load
1617 * @throws Exception if given file is not a DLS file, expected chunks
1618 * are missing
1619 */
1620 File::File(RIFF::File* pRIFF) : Resource(NULL, pRIFF) {
1621 if (!pRIFF) throw DLS::Exception("NULL pointer reference to RIFF::File object.");
1622 this->pRIFF = pRIFF;
1623 bOwningRiff = false;
1624 RIFF::Chunk* ckVersion = pRIFF->GetSubChunk(CHUNK_ID_VERS);
1625 if (ckVersion) {
1626 ckVersion->SetPos(0);
1627
1628 pVersion = new version_t;
1629 ckVersion->Read(pVersion, 4, 2);
1630 }
1631 else pVersion = NULL;
1632
1633 RIFF::Chunk* colh = pRIFF->GetSubChunk(CHUNK_ID_COLH);
1634 if (!colh) throw DLS::Exception("Mandatory chunks in RIFF list chunk not found.");
1635 colh->SetPos(0);
1636 Instruments = colh->ReadUint32();
1637
1638 RIFF::Chunk* ptbl = pRIFF->GetSubChunk(CHUNK_ID_PTBL);
1639 if (!ptbl) { // pool table is missing - this is probably an ".art" file
1640 WavePoolCount = 0;
1641 pWavePoolTable = NULL;
1642 pWavePoolTableHi = NULL;
1643 WavePoolHeaderSize = 8;
1644 b64BitWavePoolOffsets = false;
1645 } else {
1646 ptbl->SetPos(0);
1647
1648 WavePoolHeaderSize = ptbl->ReadUint32();
1649 WavePoolCount = ptbl->ReadUint32();
1650 pWavePoolTable = new uint32_t[WavePoolCount];
1651 pWavePoolTableHi = new uint32_t[WavePoolCount];
1652 ptbl->SetPos(WavePoolHeaderSize);
1653
1654 // Check for 64 bit offsets (used in gig v3 files)
1655 b64BitWavePoolOffsets = (ptbl->GetSize() - WavePoolHeaderSize == WavePoolCount * 8);
1656 if (b64BitWavePoolOffsets) {
1657 for (int i = 0 ; i < WavePoolCount ; i++) {
1658 pWavePoolTableHi[i] = ptbl->ReadUint32();
1659 pWavePoolTable[i] = ptbl->ReadUint32();
1660 //NOTE: disabled this 2GB check, not sure why this check was still left here (Christian, 2016-05-12)
1661 //if (pWavePoolTable[i] & 0x80000000)
1662 // throw DLS::Exception("Files larger than 2 GB not yet supported");
1663 }
1664 } else { // conventional 32 bit offsets
1665 ptbl->Read(pWavePoolTable, WavePoolCount, sizeof(uint32_t));
1666 for (int i = 0 ; i < WavePoolCount ; i++) pWavePoolTableHi[i] = 0;
1667 }
1668 }
1669
1670 pSamples = NULL;
1671 pInstruments = NULL;
1672 }
1673
1674 File::~File() {
1675 if (pInstruments) {
1676 InstrumentList::iterator iter = pInstruments->begin();
1677 InstrumentList::iterator end = pInstruments->end();
1678 while (iter != end) {
1679 delete *iter;
1680 iter++;
1681 }
1682 delete pInstruments;
1683 }
1684
1685 if (pSamples) {
1686 SampleList::iterator iter = pSamples->begin();
1687 SampleList::iterator end = pSamples->end();
1688 while (iter != end) {
1689 delete *iter;
1690 iter++;
1691 }
1692 delete pSamples;
1693 }
1694
1695 if (pWavePoolTable) delete[] pWavePoolTable;
1696 if (pWavePoolTableHi) delete[] pWavePoolTableHi;
1697 if (pVersion) delete pVersion;
1698 for (std::list<RIFF::File*>::iterator i = ExtensionFiles.begin() ; i != ExtensionFiles.end() ; i++)
1699 delete *i;
1700 if (bOwningRiff)
1701 delete pRIFF;
1702 }
1703
1704 /**
1705 * Returns Sample object of @a index.
1706 *
1707 * @param index - position of sample in sample list (0..n)
1708 * @returns sample object or NULL if index is out of bounds
1709 */
1710 Sample* File::GetSample(size_t index) {
1711 if (!pSamples) LoadSamples();
1712 if (!pSamples) return NULL;
1713 if (index >= pSamples->size()) return NULL;
1714 return (*pSamples)[index];
1715 }
1716
1717 /**
1718 * Returns a pointer to the first <i>Sample</i> object of the file,
1719 * <i>NULL</i> otherwise.
1720 *
1721 * @deprecated This method is not reentrant-safe, use GetSample()
1722 * instead.
1723 */
1724 Sample* File::GetFirstSample() {
1725 if (!pSamples) LoadSamples();
1726 if (!pSamples) return NULL;
1727 SamplesIterator = pSamples->begin();
1728 return (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL;
1729 }
1730
1731 /**
1732 * Returns a pointer to the next <i>Sample</i> object of the file,
1733 * <i>NULL</i> otherwise.
1734 *
1735 * @deprecated This method is not reentrant-safe, use GetSample()
1736 * instead.
1737 */
1738 Sample* File::GetNextSample() {
1739 if (!pSamples) return NULL;
1740 SamplesIterator++;
1741 return (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL;
1742 }
1743
1744 void File::LoadSamples() {
1745 if (!pSamples) pSamples = new SampleList;
1746 RIFF::List* wvpl = pRIFF->GetSubList(LIST_TYPE_WVPL);
1747 if (wvpl) {
1748 file_offset_t wvplFileOffset = wvpl->GetFilePos() -
1749 wvpl->GetPos(); // should be zero, but just to be sure
1750 size_t i = 0;
1751 for (RIFF::List* wave = wvpl->GetSubListAt(i); wave;
1752 wave = wvpl->GetSubListAt(++i))
1753 {
1754 if (wave->GetListType() == LIST_TYPE_WAVE) {
1755 file_offset_t waveFileOffset = wave->GetFilePos() -
1756 wave->GetPos(); // should be zero, but just to be sure
1757 pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset));
1758 }
1759 }
1760 }
1761 else { // Seen a dwpl list chunk instead of a wvpl list chunk in some file (officially not DLS compliant)
1762 RIFF::List* dwpl = pRIFF->GetSubList(LIST_TYPE_DWPL);
1763 if (dwpl) {
1764 file_offset_t dwplFileOffset = dwpl->GetFilePos() -
1765 dwpl->GetPos(); // should be zero, but just to be sure
1766 size_t i = 0;
1767 for (RIFF::List* wave = dwpl->GetSubListAt(i); wave;
1768 wave = dwpl->GetSubListAt(++i))
1769 {
1770 if (wave->GetListType() == LIST_TYPE_WAVE) {
1771 file_offset_t waveFileOffset = wave->GetFilePos() -
1772 wave->GetPos(); // should be zero, but just to be sure
1773 pSamples->push_back(new Sample(this, wave, waveFileOffset - dwplFileOffset));
1774 }
1775 }
1776 }
1777 }
1778 }
1779
1780 /** @brief Add a new sample.
1781 *
1782 * This will create a new Sample object for the DLS file. You have to
1783 * call Save() to make this persistent to the file.
1784 *
1785 * @returns pointer to new Sample object
1786 */
1787 Sample* File::AddSample() {
1788 if (!pSamples) LoadSamples();
1789 __ensureMandatoryChunksExist();
1790 RIFF::List* wvpl = pRIFF->GetSubList(LIST_TYPE_WVPL);
1791 // create new Sample object and its respective 'wave' list chunk
1792 RIFF::List* wave = wvpl->AddSubList(LIST_TYPE_WAVE);
1793 Sample* pSample = new Sample(this, wave, 0 /*arbitrary value, we update offsets when we save*/);
1794 pSamples->push_back(pSample);
1795 return pSample;
1796 }
1797
1798 /** @brief Delete a sample.
1799 *
1800 * This will delete the given Sample object from the DLS file. You have
1801 * to call Save() to make this persistent to the file.
1802 *
1803 * @param pSample - sample to delete
1804 */
1805 void File::DeleteSample(Sample* pSample) {
1806 if (!pSamples) return;
1807 SampleList::iterator iter = find(pSamples->begin(), pSamples->end(), pSample);
1808 if (iter == pSamples->end()) return;
1809 pSamples->erase(iter);
1810 pSample->DeleteChunks();
1811 delete pSample;
1812 }
1813
1814 Instrument* File::GetFirstInstrument() {
1815 if (!pInstruments) LoadInstruments();
1816 if (!pInstruments) return NULL;
1817 InstrumentsIterator = pInstruments->begin();
1818 return (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL;
1819 }
1820
1821 Instrument* File::GetNextInstrument() {
1822 if (!pInstruments) return NULL;
1823 InstrumentsIterator++;
1824 return (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL;
1825 }
1826
1827 void File::LoadInstruments() {
1828 if (!pInstruments) pInstruments = new InstrumentList;
1829 RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
1830 if (lstInstruments) {
1831 size_t i = 0;
1832 for (RIFF::List* lstInstr = lstInstruments->GetSubListAt(i);
1833 lstInstr; lstInstr = lstInstruments->GetSubListAt(++i))
1834 {
1835 if (lstInstr->GetListType() == LIST_TYPE_INS) {
1836 pInstruments->push_back(new Instrument(this, lstInstr));
1837 }
1838 }
1839 }
1840 }
1841
1842 /** @brief Add a new instrument definition.
1843 *
1844 * This will create a new Instrument object for the DLS file. You have
1845 * to call Save() to make this persistent to the file.
1846 *
1847 * @returns pointer to new Instrument object
1848 */
1849 Instrument* File::AddInstrument() {
1850 if (!pInstruments) LoadInstruments();
1851 __ensureMandatoryChunksExist();
1852 RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
1853 RIFF::List* lstInstr = lstInstruments->AddSubList(LIST_TYPE_INS);
1854 Instrument* pInstrument = new Instrument(this, lstInstr);
1855 pInstruments->push_back(pInstrument);
1856 return pInstrument;
1857 }
1858
1859 /** @brief Delete an instrument.
1860 *
1861 * This will delete the given Instrument object from the DLS file. You
1862 * have to call Save() to make this persistent to the file.
1863 *
1864 * @param pInstrument - instrument to delete
1865 */
1866 void File::DeleteInstrument(Instrument* pInstrument) {
1867 if (!pInstruments) return;
1868 InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), pInstrument);
1869 if (iter == pInstruments->end()) return;
1870 pInstruments->erase(iter);
1871 pInstrument->DeleteChunks();
1872 delete pInstrument;
1873 }
1874
1875 /**
1876 * Returns the underlying RIFF::File used for persistency of this DLS::File
1877 * object.
1878 */
1879 RIFF::File* File::GetRiffFile() {
1880 return pRIFF;
1881 }
1882
1883 /**
1884 * Returns extension file of given index. Extension files are used
1885 * sometimes to circumvent the 2 GB file size limit of the RIFF format and
1886 * of certain operating systems in general. In this case, instead of just
1887 * using one file, the content is spread among several files with similar
1888 * file name scheme. This is especially used by some GigaStudio sound
1889 * libraries.
1890 *
1891 * @param index - index of extension file
1892 * @returns sought extension file, NULL if index out of bounds
1893 * @see GetFileName()
1894 */
1895 RIFF::File* File::GetExtensionFile(int index) {
1896 if (index < 0 || index >= ExtensionFiles.size()) return NULL;
1897 std::list<RIFF::File*>::iterator iter = ExtensionFiles.begin();
1898 for (int i = 0; iter != ExtensionFiles.end(); ++iter, ++i)
1899 if (i == index) return *iter;
1900 return NULL;
1901 }
1902
1903 /** @brief File name of this DLS file.
1904 *
1905 * This method returns the file name as it was provided when loading
1906 * the respective DLS file. However in case the File object associates
1907 * an empty, that is new DLS file, which was not yet saved to disk,
1908 * this method will return an empty string.
1909 *
1910 * @see GetExtensionFile()
1911 */
1912 String File::GetFileName() {
1913 return pRIFF->GetFileName();
1914 }
1915
1916 /**
1917 * You may call this method store a future file name, so you don't have to
1918 * to pass it to the Save() call later on.
1919 */
1920 void File::SetFileName(const String& name) {
1921 pRIFF->SetFileName(name);
1922 }
1923
1924 /**
1925 * Apply all the DLS file's current instruments, samples and settings to
1926 * the respective RIFF chunks. You have to call Save() to make changes
1927 * persistent.
1928 *
1929 * @param pProgress - callback function for progress notification
1930 * @throws Exception - on errors
1931 */
1932 void File::UpdateChunks(progress_t* pProgress) {
1933 // first update base class's chunks
1934 Resource::UpdateChunks(pProgress);
1935
1936 // if version struct exists, update 'vers' chunk
1937 if (pVersion) {
1938 RIFF::Chunk* ckVersion = pRIFF->GetSubChunk(CHUNK_ID_VERS);
1939 if (!ckVersion) ckVersion = pRIFF->AddSubChunk(CHUNK_ID_VERS, 8);
1940 uint8_t* pData = (uint8_t*) ckVersion->LoadChunkData();
1941 store16(&pData[0], pVersion->minor);
1942 store16(&pData[2], pVersion->major);
1943 store16(&pData[4], pVersion->build);
1944 store16(&pData[6], pVersion->release);
1945 }
1946
1947 // update 'colh' chunk
1948 Instruments = (pInstruments) ? uint32_t(pInstruments->size()) : 0;
1949 RIFF::Chunk* colh = pRIFF->GetSubChunk(CHUNK_ID_COLH);
1950 if (!colh) colh = pRIFF->AddSubChunk(CHUNK_ID_COLH, 4);
1951 uint8_t* pData = (uint8_t*) colh->LoadChunkData();
1952 store32(pData, Instruments);
1953
1954 // update instrument's chunks
1955 if (pInstruments) {
1956 if (pProgress) {
1957 // divide local progress into subprogress
1958 progress_t subprogress;
1959 __divide_progress(pProgress, &subprogress, 20.f, 0.f); // arbitrarily subdivided into 5% of total progress
1960
1961 // do the actual work
1962 InstrumentList::iterator iter = pInstruments->begin();
1963 InstrumentList::iterator end = pInstruments->end();
1964 for (int i = 0; iter != end; ++iter, ++i) {
1965 // divide subprogress into sub-subprogress
1966 progress_t subsubprogress;
1967 __divide_progress(&subprogress, &subsubprogress, pInstruments->size(), i);
1968 // do the actual work
1969 (*iter)->UpdateChunks(&subsubprogress);
1970 }
1971
1972 __notify_progress(&subprogress, 1.0); // notify subprogress done
1973 } else {
1974 InstrumentList::iterator iter = pInstruments->begin();
1975 InstrumentList::iterator end = pInstruments->end();
1976 for (int i = 0; iter != end; ++iter, ++i) {
1977 (*iter)->UpdateChunks(NULL);
1978 }
1979 }
1980 }
1981
1982 // update 'ptbl' chunk
1983 const int iSamples = (pSamples) ? int(pSamples->size()) : 0;
1984 int iPtblOffsetSize = (b64BitWavePoolOffsets) ? 8 : 4;
1985 RIFF::Chunk* ptbl = pRIFF->GetSubChunk(CHUNK_ID_PTBL);
1986 if (!ptbl) ptbl = pRIFF->AddSubChunk(CHUNK_ID_PTBL, 1 /*anything, we'll resize*/);
1987 int iPtblSize = WavePoolHeaderSize + iPtblOffsetSize * iSamples;
1988 ptbl->Resize(iPtblSize);
1989 pData = (uint8_t*) ptbl->LoadChunkData();
1990 WavePoolCount = iSamples;
1991 store32(&pData[4], WavePoolCount);
1992 // we actually update the sample offsets in the pool table when we Save()
1993 memset(&pData[WavePoolHeaderSize], 0, iPtblSize - WavePoolHeaderSize);
1994
1995 // update sample's chunks
1996 if (pSamples) {
1997 if (pProgress) {
1998 // divide local progress into subprogress
1999 progress_t subprogress;
2000 __divide_progress(pProgress, &subprogress, 20.f, 1.f); // arbitrarily subdivided into 95% of total progress
2001
2002 // do the actual work
2003 SampleList::iterator iter = pSamples->begin();
2004 SampleList::iterator end = pSamples->end();
2005 for (int i = 0; iter != end; ++iter, ++i) {
2006 // divide subprogress into sub-subprogress
2007 progress_t subsubprogress;
2008 __divide_progress(&subprogress, &subsubprogress, pSamples->size(), i);
2009 // do the actual work
2010 (*iter)->UpdateChunks(&subsubprogress);
2011 }
2012
2013 __notify_progress(&subprogress, 1.0); // notify subprogress done
2014 } else {
2015 SampleList::iterator iter = pSamples->begin();
2016 SampleList::iterator end = pSamples->end();
2017 for (int i = 0; iter != end; ++iter, ++i) {
2018 (*iter)->UpdateChunks(NULL);
2019 }
2020 }
2021 }
2022
2023 // if there are any extension files, gather which ones are regular
2024 // extension files used as wave pool files (.gx00, .gx01, ... , .gx98)
2025 // and which one is probably a convolution (GigaPulse) file (always to
2026 // be saved as .gx99)
2027 std::list<RIFF::File*> poolFiles; // < for (.gx00, .gx01, ... , .gx98) files
2028 RIFF::File* pGigaPulseFile = NULL; // < for .gx99 file
2029 if (!ExtensionFiles.empty()) {
2030 std::list<RIFF::File*>::iterator it = ExtensionFiles.begin();
2031 for (; it != ExtensionFiles.end(); ++it) {
2032 //FIXME: the .gx99 file is always used by GSt for convolution
2033 // data (GigaPulse); so we should better detect by subchunk
2034 // whether the extension file is intended for convolution
2035 // instead of checkking for a file name, because the latter does
2036 // not work for saving new gigs created from scratch
2037 const std::string oldName = (*it)->GetFileName();
2038 const bool isGigaPulseFile = (extensionOfPath(oldName) == "gx99");
2039 if (isGigaPulseFile)
2040 pGigaPulseFile = *it;
2041 else
2042 poolFiles.push_back(*it);
2043 }
2044 }
2045
2046 // update the 'xfil' chunk which describes all extension files (wave
2047 // pool files) except the .gx99 file
2048 if (!poolFiles.empty()) {
2049 const int n = poolFiles.size();
2050 const int iHeaderSize = 4;
2051 const int iEntrySize = 144;
2052
2053 // make sure chunk exists, and with correct size
2054 RIFF::Chunk* ckXfil = pRIFF->GetSubChunk(CHUNK_ID_XFIL);
2055 if (ckXfil)
2056 ckXfil->Resize(iHeaderSize + n * iEntrySize);
2057 else
2058 ckXfil = pRIFF->AddSubChunk(CHUNK_ID_XFIL, iHeaderSize + n * iEntrySize);
2059
2060 uint8_t* pData = (uint8_t*) ckXfil->LoadChunkData();
2061
2062 // re-assemble the chunk's content
2063 store32(pData, n);
2064 std::list<RIFF::File*>::iterator itExtFile = poolFiles.begin();
2065 for (int i = 0, iOffset = 4; i < n;
2066 ++itExtFile, ++i, iOffset += iEntrySize)
2067 {
2068 // update the filename string and 5 byte extension of each extension file
2069 std::string file = lastPathComponent(
2070 (*itExtFile)->GetFileName()
2071 );
2072 if (file.length() + 6 > 128)
2073 throw Exception("Fatal error, extension filename length exceeds 122 byte maximum");
2074 uint8_t* pStrings = &pData[iOffset];
2075 memset(pStrings, 0, 128);
2076 memcpy(pStrings, file.c_str(), file.length());
2077 pStrings += file.length() + 1;
2078 std::string ext = file.substr(file.length()-5);
2079 memcpy(pStrings, ext.c_str(), 5);
2080 // update the dlsid of the extension file
2081 uint8_t* pId = &pData[iOffset + 128];
2082 dlsid_t id;
2083 RIFF::Chunk* ckDLSID = (*itExtFile)->GetSubChunk(CHUNK_ID_DLID);
2084 if (ckDLSID) {
2085 ckDLSID->Read(&id.ulData1, 1, 4);
2086 ckDLSID->Read(&id.usData2, 1, 2);
2087 ckDLSID->Read(&id.usData3, 1, 2);
2088 ckDLSID->Read(id.abData, 8, 1);
2089 } else {
2090 ckDLSID = (*itExtFile)->AddSubChunk(CHUNK_ID_DLID, 16);
2091 Resource::GenerateDLSID(&id);
2092 uint8_t* pData = (uint8_t*)ckDLSID->LoadChunkData();
2093 store32(&pData[0], id.ulData1);
2094 store16(&pData[4], id.usData2);
2095 store16(&pData[6], id.usData3);
2096 memcpy(&pData[8], id.abData, 8);
2097 }
2098 store32(&pId[0], id.ulData1);
2099 store16(&pId[4], id.usData2);
2100 store16(&pId[6], id.usData3);
2101 memcpy(&pId[8], id.abData, 8);
2102 }
2103 } else {
2104 // in case there was a 'xfil' chunk, remove it
2105 RIFF::Chunk* ckXfil = pRIFF->GetSubChunk(CHUNK_ID_XFIL);
2106 if (ckXfil) pRIFF->DeleteSubChunk(ckXfil);
2107 }
2108
2109 // update the 'doxf' chunk which describes a .gx99 extension file
2110 // which contains convolution data (GigaPulse)
2111 if (pGigaPulseFile) {
2112 RIFF::Chunk* ckDoxf = pRIFF->GetSubChunk(CHUNK_ID_DOXF);
2113 if (!ckDoxf) ckDoxf = pRIFF->AddSubChunk(CHUNK_ID_DOXF, 148);
2114
2115 uint8_t* pData = (uint8_t*) ckDoxf->LoadChunkData();
2116
2117 // update the dlsid from the extension file
2118 uint8_t* pId = &pData[132];
2119 RIFF::Chunk* ckDLSID = pGigaPulseFile->GetSubChunk(CHUNK_ID_DLID);
2120 if (!ckDLSID) { //TODO: auto generate DLS ID if missing
2121 throw Exception("Fatal error, GigaPulse file does not contain a DLS ID chunk");
2122 } else {
2123 dlsid_t id;
2124 // read DLS ID from extension files's DLS ID chunk
2125 uint8_t* pData = (uint8_t*) ckDLSID->LoadChunkData();
2126 id.ulData1 = load32(&pData[0]);
2127 id.usData2 = load16(&pData[4]);
2128 id.usData3 = load16(&pData[6]);
2129 memcpy(id.abData, &pData[8], 8);
2130 // store DLS ID to 'doxf' chunk
2131 store32(&pId[0], id.ulData1);
2132 store16(&pId[4], id.usData2);
2133 store16(&pId[6], id.usData3);
2134 memcpy(&pId[8], id.abData, 8);
2135 }
2136 } else {
2137 // in case there was a 'doxf' chunk, remove it
2138 RIFF::Chunk* ckDoxf = pRIFF->GetSubChunk(CHUNK_ID_DOXF);
2139 if (ckDoxf) pRIFF->DeleteSubChunk(ckDoxf);
2140 }
2141
2142 // the RIFF file to be written might now been grown >= 4GB or might
2143 // been shrunk < 4GB, so we might need to update the wave pool offset
2144 // size and thus accordingly we would need to resize the wave pool
2145 // chunk
2146 const file_offset_t finalFileSize = pRIFF->GetRequiredFileSize();
2147 const bool bRequires64Bit = (finalFileSize >> 32) != 0 || // < native 64 bit gig file
2148 poolFiles.size() > 0; // < 32 bit gig file where the hi 32 bits are used as extension file nr
2149 if (b64BitWavePoolOffsets != bRequires64Bit) {
2150 b64BitWavePoolOffsets = bRequires64Bit;
2151 iPtblOffsetSize = (b64BitWavePoolOffsets) ? 8 : 4;
2152 iPtblSize = WavePoolHeaderSize + iPtblOffsetSize * iSamples;
2153 ptbl->Resize(iPtblSize);
2154 }
2155
2156 if (pProgress)
2157 __notify_progress(pProgress, 1.0); // notify done
2158 }
2159
2160 /** @brief Save changes to another file.
2161 *
2162 * Make all changes persistent by writing them to another file.
2163 * <b>Caution:</b> this method is optimized for writing to
2164 * <b>another</b> file, do not use it to save the changes to the same
2165 * file! Use Save() (without path argument) in that case instead!
2166 * Ignoring this might result in a corrupted file!
2167 *
2168 * After calling this method, this File object will be associated with
2169 * the new file (given by \a Path) afterwards.
2170 *
2171 * @param Path - path and file name where everything should be written to
2172 * @param pProgress - optional: callback function for progress notification
2173 */
2174 void File::Save(const String& Path, progress_t* pProgress) {
2175 // calculate number of tasks to notify progress appropriately
2176 const size_t nExtFiles = ExtensionFiles.size();
2177 const float tasks = 2.f + nExtFiles;
2178
2179 // save extension files (if required)
2180 if (!ExtensionFiles.empty()) {
2181 // for assembling path of extension files to be saved to
2182 const std::string baseName = pathWithoutExtension(Path);
2183 // save the individual extension files
2184 std::list<RIFF::File*>::iterator it = ExtensionFiles.begin();
2185 for (int i = 0; it != ExtensionFiles.end(); ++i, ++it) {
2186 //FIXME: the .gx99 file is always used by GSt for convolution
2187 // data (GigaPulse); so we should better detect by subchunk
2188 // whether the extension file is intended for convolution
2189 // instead of checkking for a file name, because the latter does
2190 // not work for saving new gigs created from scratch
2191 const std::string oldName = (*it)->GetFileName();
2192 const bool isGigaPulseFile = (extensionOfPath(oldName) == "gx99");
2193 std::string ext = (isGigaPulseFile) ? ".gx99" : strPrint(".gx%02d", i+1);
2194 std::string newPath = baseName + ext;
2195 // save extension file to its new location
2196 if (pProgress) {
2197 // divide local progress into subprogress
2198 progress_t subprogress;
2199 __divide_progress(pProgress, &subprogress, tasks, 0.f + i); // subdivided into amount of extension files
2200 // do the actual work
2201 (*it)->Save(newPath, &subprogress);
2202 } else
2203 (*it)->Save(newPath);
2204 }
2205 }
2206
2207 if (pProgress) {
2208 // divide local progress into subprogress
2209 progress_t subprogress;
2210 __divide_progress(pProgress, &subprogress, tasks, 1.f + nExtFiles); // arbitrarily subdivided into 50% (minus extension files progress)
2211 // do the actual work
2212 UpdateChunks(&subprogress);
2213 } else
2214 UpdateChunks(NULL);
2215
2216 if (pProgress) {
2217 // divide local progress into subprogress
2218 progress_t subprogress;
2219 __divide_progress(pProgress, &subprogress, tasks, 2.f + nExtFiles); // arbitrarily subdivided into 50% (minus extension files progress)
2220 // do the actual work
2221 pRIFF->Save(Path, &subprogress);
2222 } else
2223 pRIFF->Save(Path);
2224
2225 UpdateFileOffsets();
2226
2227 if (pProgress)
2228 __notify_progress(pProgress, 1.0); // notify done
2229 }
2230
2231 /** @brief Save changes to same file.
2232 *
2233 * Make all changes persistent by writing them to the actual (same)
2234 * file. The file might temporarily grow to a higher size than it will
2235 * have at the end of the saving process.
2236 *
2237 * @param pProgress - optional: callback function for progress notification
2238 * @throws RIFF::Exception if any kind of IO error occurred
2239 * @throws DLS::Exception if any kind of DLS specific error occurred
2240 */
2241 void File::Save(progress_t* pProgress) {
2242 // calculate number of tasks to notify progress appropriately
2243 const size_t nExtFiles = ExtensionFiles.size();
2244 const float tasks = 2.f + nExtFiles;
2245
2246 // save extension files (if required)
2247 if (!ExtensionFiles.empty()) {
2248 std::list<RIFF::File*>::iterator it = ExtensionFiles.begin();
2249 for (int i = 0; it != ExtensionFiles.end(); ++i, ++it) {
2250 // save extension file
2251 if (pProgress) {
2252 // divide local progress into subprogress
2253 progress_t subprogress;
2254 __divide_progress(pProgress, &subprogress, tasks, 0.f + i); // subdivided into amount of extension files
2255 // do the actual work
2256 (*it)->Save(&subprogress);
2257 } else
2258 (*it)->Save();
2259 }
2260 }
2261
2262 if (pProgress) {
2263 // divide local progress into subprogress
2264 progress_t subprogress;
2265 __divide_progress(pProgress, &subprogress, tasks, 1.f + nExtFiles); // arbitrarily subdivided into 50% (minus extension files progress)
2266 // do the actual work
2267 UpdateChunks(&subprogress);
2268 } else
2269 UpdateChunks(NULL);
2270
2271 if (pProgress) {
2272 // divide local progress into subprogress
2273 progress_t subprogress;
2274 __divide_progress(pProgress, &subprogress, tasks, 2.f + nExtFiles); // arbitrarily subdivided into 50% (minus extension files progress)
2275 // do the actual work
2276 pRIFF->Save(&subprogress);
2277 } else
2278 pRIFF->Save();
2279
2280 UpdateFileOffsets();
2281
2282 if (pProgress)
2283 __notify_progress(pProgress, 1.0); // notify done
2284 }
2285
2286 /** @brief Updates all file offsets stored all over the file.
2287 *
2288 * This virtual method is called whenever the overall file layout has been
2289 * changed (i.e. file or individual RIFF chunks have been resized). It is
2290 * then the responsibility of this method to update all file offsets stored
2291 * in the file format. For example samples are referenced by instruments by
2292 * file offsets. The gig format also stores references to instrument
2293 * scripts as file offsets, and thus it overrides this method to update
2294 * those file offsets as well.
2295 */
2296 void File::UpdateFileOffsets() {
2297 __UpdateWavePoolTableChunk();
2298 }
2299
2300 /**
2301 * Checks if all (for DLS) mandatory chunks exist, if not they will be
2302 * created. Note that those chunks will not be made persistent until
2303 * Save() was called.
2304 */
2305 void File::__ensureMandatoryChunksExist() {
2306 // enusre 'lins' list chunk exists (mandatory for instrument definitions)
2307 RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
2308 if (!lstInstruments) pRIFF->AddSubList(LIST_TYPE_LINS);
2309 // ensure 'ptbl' chunk exists (mandatory for samples)
2310 RIFF::Chunk* ptbl = pRIFF->GetSubChunk(CHUNK_ID_PTBL);
2311 if (!ptbl) {
2312 const int iOffsetSize = (b64BitWavePoolOffsets) ? 8 : 4;
2313 ptbl = pRIFF->AddSubChunk(CHUNK_ID_PTBL, WavePoolHeaderSize + iOffsetSize);
2314 }
2315 // enusre 'wvpl' list chunk exists (mandatory for samples)
2316 RIFF::List* wvpl = pRIFF->GetSubList(LIST_TYPE_WVPL);
2317 if (!wvpl) pRIFF->AddSubList(LIST_TYPE_WVPL);
2318 }
2319
2320 /**
2321 * Updates (persistently) the wave pool table with offsets to all
2322 * currently available samples. <b>Caution:</b> this method assumes the
2323 * 'ptbl' chunk to be already of the correct size and the file to be
2324 * writable, so usually this method is only called after a Save() call.
2325 *
2326 * @throws Exception - if 'ptbl' chunk is too small (should only occur
2327 * if there's a bug)
2328 */
2329 void File::__UpdateWavePoolTableChunk() {
2330 __UpdateWavePoolTable();
2331 RIFF::Chunk* ptbl = pRIFF->GetSubChunk(CHUNK_ID_PTBL);
2332 const int iOffsetSize = (b64BitWavePoolOffsets) ? 8 : 4;
2333 // check if 'ptbl' chunk is large enough
2334 WavePoolCount = (pSamples) ? uint32_t(pSamples->size()) : 0;
2335 const file_offset_t ulRequiredSize = WavePoolHeaderSize + iOffsetSize * WavePoolCount;
2336 if (ptbl->GetSize() < ulRequiredSize) throw Exception("Fatal error, 'ptbl' chunk too small");
2337 // save the 'ptbl' chunk's current read/write position
2338 file_offset_t ullOriginalPos = ptbl->GetPos();
2339 // update headers
2340 ptbl->SetPos(0);
2341 uint32_t tmp = WavePoolHeaderSize;
2342 ptbl->WriteUint32(&tmp);
2343 tmp = WavePoolCount;
2344 ptbl->WriteUint32(&tmp);
2345 // update offsets
2346 ptbl->SetPos(WavePoolHeaderSize);
2347 if (b64BitWavePoolOffsets) {
2348 for (int i = 0 ; i < WavePoolCount ; i++) {
2349 tmp = pWavePoolTableHi[i];
2350 ptbl->WriteUint32(&tmp);
2351 tmp = pWavePoolTable[i];
2352 ptbl->WriteUint32(&tmp);
2353 }
2354 } else { // conventional 32 bit offsets
2355 for (int i = 0 ; i < WavePoolCount ; i++) {
2356 tmp = pWavePoolTable[i];
2357 ptbl->WriteUint32(&tmp);
2358 }
2359 }
2360 // restore 'ptbl' chunk's original read/write position
2361 ptbl->SetPos(ullOriginalPos);
2362 }
2363
2364 /**
2365 * Updates the wave pool table with offsets to all currently available
2366 * samples. <b>Caution:</b> this method assumes the 'wvpl' list chunk
2367 * exists already.
2368 */
2369 void File::__UpdateWavePoolTable() {
2370 WavePoolCount = (pSamples) ? uint32_t(pSamples->size()) : 0;
2371 // resize wave pool table arrays
2372 if (pWavePoolTable) delete[] pWavePoolTable;
2373 if (pWavePoolTableHi) delete[] pWavePoolTableHi;
2374 pWavePoolTable = new uint32_t[WavePoolCount];
2375 pWavePoolTableHi = new uint32_t[WavePoolCount];
2376 if (!pSamples) return;
2377 // update offsets in wave pool table
2378 RIFF::List* wvpl = pRIFF->GetSubList(LIST_TYPE_WVPL);
2379 uint64_t wvplFileOffset = wvpl->GetFilePos() -
2380 wvpl->GetPos(); // mandatory, since position might have changed
2381 if (!b64BitWavePoolOffsets) { // conventional 32 bit offsets (and no extension files) ...
2382 SampleList::iterator iter = pSamples->begin();
2383 SampleList::iterator end = pSamples->end();
2384 for (int i = 0 ; iter != end ; ++iter, i++) {
2385 uint64_t _64BitOffset =
2386 (*iter)->pWaveList->GetFilePos() -
2387 (*iter)->pWaveList->GetPos() - // should be zero, but just to be sure
2388 wvplFileOffset -
2389 LIST_HEADER_SIZE(pRIFF->GetFileOffsetSize());
2390 (*iter)->ullWavePoolOffset = _64BitOffset;
2391 pWavePoolTable[i] = (uint32_t) _64BitOffset;
2392 }
2393 } else { // a) native 64 bit offsets without extension files or b) 32 bit offsets with extension files ...
2394 if (ExtensionFiles.empty()) { // native 64 bit offsets (and no extension files) [not compatible with GigaStudio] ...
2395 SampleList::iterator iter = pSamples->begin();
2396 SampleList::iterator end = pSamples->end();
2397 for (int i = 0 ; iter != end ; ++iter, i++) {
2398 uint64_t _64BitOffset =
2399 (*iter)->pWaveList->GetFilePos() -
2400 (*iter)->pWaveList->GetPos() - // should be zero, but just to be sure
2401 wvplFileOffset -
2402 LIST_HEADER_SIZE(pRIFF->GetFileOffsetSize());
2403 (*iter)->ullWavePoolOffset = _64BitOffset;
2404 pWavePoolTableHi[i] = (uint32_t) (_64BitOffset >> 32);
2405 pWavePoolTable[i] = (uint32_t) _64BitOffset;
2406 }
2407 } else { // 32 bit offsets with extension files (GigaStudio legacy support) ...
2408 // the main gig and the extension files may contain wave data
2409 std::vector<RIFF::File*> poolFiles;
2410 poolFiles.push_back(pRIFF);
2411 poolFiles.insert(poolFiles.end(), ExtensionFiles.begin(), ExtensionFiles.end());
2412
2413 RIFF::File* pCurPoolFile = NULL;
2414 int fileNo = 0;
2415 int waveOffset = 0;
2416 SampleList::iterator iter = pSamples->begin();
2417 SampleList::iterator end = pSamples->end();
2418 for (int i = 0 ; iter != end ; ++iter, i++) {
2419 RIFF::File* pPoolFile = (*iter)->pWaveList->GetFile();
2420 // if this sample is located in the same pool file as the
2421 // last we reuse the previously computed fileNo and waveOffset
2422 if (pPoolFile != pCurPoolFile) { // it is a different pool file than the last sample ...
2423 pCurPoolFile = pPoolFile;
2424
2425 std::vector<RIFF::File*>::iterator sIter;
2426 sIter = std::find(poolFiles.begin(), poolFiles.end(), pPoolFile);
2427 if (sIter != poolFiles.end())
2428 fileNo = std::distance(poolFiles.begin(), sIter);
2429 else
2430 throw DLS::Exception("Fatal error, unknown pool file");
2431
2432 RIFF::List* extWvpl = pCurPoolFile->GetSubList(LIST_TYPE_WVPL);
2433 if (!extWvpl)
2434 throw DLS::Exception("Fatal error, pool file has no 'wvpl' list chunk");
2435 waveOffset =
2436 extWvpl->GetFilePos() -
2437 extWvpl->GetPos() + // mandatory, since position might have changed
2438 LIST_HEADER_SIZE(pCurPoolFile->GetFileOffsetSize());
2439 }
2440 uint64_t _64BitOffset =
2441 (*iter)->pWaveList->GetFilePos() -
2442 (*iter)->pWaveList->GetPos() - // should be zero, but just to be sure
2443 waveOffset;
2444 // pWavePoolTableHi stores file number when extension files are in use
2445 pWavePoolTableHi[i] = (uint32_t) fileNo;
2446 pWavePoolTable[i] = (uint32_t) _64BitOffset;
2447 (*iter)->ullWavePoolOffset = _64BitOffset;
2448 }
2449 }
2450 }
2451 }
2452
2453
2454 // *************** Exception ***************
2455 // *
2456
2457 Exception::Exception() : RIFF::Exception() {
2458 }
2459
2460 Exception::Exception(String format, ...) : RIFF::Exception() {
2461 va_list arg;
2462 va_start(arg, format);
2463 Message = assemble(format, arg);
2464 va_end(arg);
2465 }
2466
2467 Exception::Exception(String format, va_list arg) : RIFF::Exception() {
2468 Message = assemble(format, arg);
2469 }
2470
2471 void Exception::PrintMessage() {
2472 std::cout << "DLS::Exception: " << Message << std::endl;
2473 }
2474
2475
2476 // *************** functions ***************
2477 // *
2478
2479 /**
2480 * Returns the name of this C++ library. This is usually "libgig" of
2481 * course. This call is equivalent to RIFF::libraryName() and
2482 * gig::libraryName().
2483 */
2484 String libraryName() {
2485 return PACKAGE;
2486 }
2487
2488 /**
2489 * Returns version of this C++ library. This call is equivalent to
2490 * RIFF::libraryVersion() and gig::libraryVersion().
2491 */
2492 String libraryVersion() {
2493 return VERSION;
2494 }
2495
2496 } // namespace DLS

  ViewVC Help
Powered by ViewVC