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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1106 - (show annotations) (download)
Sun Mar 18 19:38:47 2007 UTC (17 years ago) by schoenebeck
File size: 61496 byte(s)
* fixed exceptions which occured when trying to save a new instrument:
    - override the gig::Regions sample reference simply by the region's
      first dimension region's sample
    - fixed software info field which was wrongly stored on instruments

1 /***************************************************************************
2 * *
3 * libgig - C++ cross-platform Gigasampler format file access library *
4 * *
5 * Copyright (C) 2003-2007 by Christian Schoenebeck *
6 * <cuse@users.sourceforge.net> *
7 * *
8 * This library is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
12 * *
13 * This library is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
17 * *
18 * You should have received a copy of the GNU General Public License *
19 * along with this library; if not, write to the Free Software *
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
21 * MA 02111-1307 USA *
22 ***************************************************************************/
23
24 #include "DLS.h"
25
26 #include <time.h>
27
28 #include "helper.h"
29
30 // macros to decode connection transforms
31 #define CONN_TRANSFORM_SRC(x) ((x >> 10) & 0x000F)
32 #define CONN_TRANSFORM_CTL(x) ((x >> 4) & 0x000F)
33 #define CONN_TRANSFORM_DST(x) (x & 0x000F)
34 #define CONN_TRANSFORM_BIPOLAR_SRC(x) (x & 0x4000)
35 #define CONN_TRANSFORM_BIPOLAR_CTL(x) (x & 0x0100)
36 #define CONN_TRANSFORM_INVERT_SRC(x) (x & 0x8000)
37 #define CONN_TRANSFORM_INVERT_CTL(x) (x & 0x0200)
38
39 // macros to encode connection transforms
40 #define CONN_TRANSFORM_SRC_ENCODE(x) ((x & 0x000F) << 10)
41 #define CONN_TRANSFORM_CTL_ENCODE(x) ((x & 0x000F) << 4)
42 #define CONN_TRANSFORM_DST_ENCODE(x) (x & 0x000F)
43 #define CONN_TRANSFORM_BIPOLAR_SRC_ENCODE(x) ((x) ? 0x4000 : 0)
44 #define CONN_TRANSFORM_BIPOLAR_CTL_ENCODE(x) ((x) ? 0x0100 : 0)
45 #define CONN_TRANSFORM_INVERT_SRC_ENCODE(x) ((x) ? 0x8000 : 0)
46 #define CONN_TRANSFORM_INVERT_CTL_ENCODE(x) ((x) ? 0x0200 : 0)
47
48 #define DRUM_TYPE_MASK 0x80000000
49
50 #define F_RGN_OPTION_SELFNONEXCLUSIVE 0x0001
51
52 #define F_WAVELINK_PHASE_MASTER 0x0001
53 #define F_WAVELINK_MULTICHANNEL 0x0002
54
55 #define F_WSMP_NO_TRUNCATION 0x0001
56 #define F_WSMP_NO_COMPRESSION 0x0002
57
58 #define MIDI_BANK_COARSE(x) ((x & 0x00007F00) >> 8) // CC0
59 #define MIDI_BANK_FINE(x) (x & 0x0000007F) // CC32
60 #define MIDI_BANK_MERGE(coarse, fine) ((((uint16_t) coarse) << 7) | fine) // CC0 + CC32
61 #define MIDI_BANK_ENCODE(coarse, fine) (((coarse & 0x0000007F) << 8) | (fine & 0x0000007F))
62
63 namespace DLS {
64
65 // *************** Connection ***************
66 // *
67
68 void Connection::Init(conn_block_t* Header) {
69 Source = (conn_src_t) Header->source;
70 Control = (conn_src_t) Header->control;
71 Destination = (conn_dst_t) Header->destination;
72 Scale = Header->scale;
73 SourceTransform = (conn_trn_t) CONN_TRANSFORM_SRC(Header->transform);
74 ControlTransform = (conn_trn_t) CONN_TRANSFORM_CTL(Header->transform);
75 DestinationTransform = (conn_trn_t) CONN_TRANSFORM_DST(Header->transform);
76 SourceInvert = CONN_TRANSFORM_INVERT_SRC(Header->transform);
77 SourceBipolar = CONN_TRANSFORM_BIPOLAR_SRC(Header->transform);
78 ControlInvert = CONN_TRANSFORM_INVERT_CTL(Header->transform);
79 ControlBipolar = CONN_TRANSFORM_BIPOLAR_CTL(Header->transform);
80 }
81
82 Connection::conn_block_t Connection::ToConnBlock() {
83 conn_block_t c;
84 c.source = Source;
85 c.control = Control;
86 c.destination = Destination;
87 c.scale = Scale;
88 c.transform = CONN_TRANSFORM_SRC_ENCODE(SourceTransform) |
89 CONN_TRANSFORM_CTL_ENCODE(ControlTransform) |
90 CONN_TRANSFORM_DST_ENCODE(DestinationTransform) |
91 CONN_TRANSFORM_INVERT_SRC_ENCODE(SourceInvert) |
92 CONN_TRANSFORM_BIPOLAR_SRC_ENCODE(SourceBipolar) |
93 CONN_TRANSFORM_INVERT_CTL_ENCODE(ControlInvert) |
94 CONN_TRANSFORM_BIPOLAR_CTL_ENCODE(ControlBipolar);
95 return c;
96 }
97
98
99
100 // *************** Articulation ***************
101 // *
102
103 /** @brief Constructor.
104 *
105 * Expects an 'artl' or 'art2' chunk to be given where the articulation
106 * connections will be read from.
107 *
108 * @param artl - pointer to an 'artl' or 'art2' chunk
109 * @throws Exception if no 'artl' or 'art2' chunk was given
110 */
111 Articulation::Articulation(RIFF::Chunk* artl) {
112 pArticulationCk = artl;
113 if (artl->GetChunkID() != CHUNK_ID_ART2 &&
114 artl->GetChunkID() != CHUNK_ID_ARTL) {
115 throw DLS::Exception("<artl-ck> or <art2-ck> chunk expected");
116 }
117 HeaderSize = artl->ReadUint32();
118 Connections = artl->ReadUint32();
119 artl->SetPos(HeaderSize);
120
121 pConnections = new Connection[Connections];
122 Connection::conn_block_t connblock;
123 for (uint32_t i = 0; i < Connections; i++) {
124 artl->Read(&connblock.source, 1, 2);
125 artl->Read(&connblock.control, 1, 2);
126 artl->Read(&connblock.destination, 1, 2);
127 artl->Read(&connblock.transform, 1, 2);
128 artl->Read(&connblock.scale, 1, 4);
129 pConnections[i].Init(&connblock);
130 }
131 }
132
133 Articulation::~Articulation() {
134 if (pConnections) delete[] pConnections;
135 }
136
137 /**
138 * Apply articulation connections to the respective RIFF chunks. You
139 * have to call File::Save() to make changes persistent.
140 */
141 void Articulation::UpdateChunks() {
142 const int iEntrySize = 12; // 12 bytes per connection block
143 pArticulationCk->Resize(HeaderSize + Connections * iEntrySize);
144 uint8_t* pData = (uint8_t*) pArticulationCk->LoadChunkData();
145 memcpy(&pData[0], &HeaderSize, 2);
146 memcpy(&pData[2], &Connections, 2);
147 for (uint32_t i = 0; i < Connections; i++) {
148 Connection::conn_block_t c = pConnections[i].ToConnBlock();
149 memcpy(&pData[HeaderSize + i * iEntrySize], &c.source, 2);
150 memcpy(&pData[HeaderSize + i * iEntrySize + 2], &c.control, 2);
151 memcpy(&pData[HeaderSize + i * iEntrySize + 4], &c.destination, 2);
152 memcpy(&pData[HeaderSize + i * iEntrySize + 6], &c.transform, 2);
153 memcpy(&pData[HeaderSize + i * iEntrySize + 8], &c.scale, 4);
154 }
155 }
156
157
158
159 // *************** Articulator ***************
160 // *
161
162 Articulator::Articulator(RIFF::List* ParentList) {
163 pParentList = ParentList;
164 pArticulations = NULL;
165 }
166
167 Articulation* Articulator::GetFirstArticulation() {
168 if (!pArticulations) LoadArticulations();
169 if (!pArticulations) return NULL;
170 ArticulationsIterator = pArticulations->begin();
171 return (ArticulationsIterator != pArticulations->end()) ? *ArticulationsIterator : NULL;
172 }
173
174 Articulation* Articulator::GetNextArticulation() {
175 if (!pArticulations) return NULL;
176 ArticulationsIterator++;
177 return (ArticulationsIterator != pArticulations->end()) ? *ArticulationsIterator : NULL;
178 }
179
180 void Articulator::LoadArticulations() {
181 // prefer articulation level 2
182 RIFF::List* lart = pParentList->GetSubList(LIST_TYPE_LAR2);
183 if (!lart) lart = pParentList->GetSubList(LIST_TYPE_LART);
184 if (lart) {
185 uint32_t artCkType = (lart->GetListType() == LIST_TYPE_LAR2) ? CHUNK_ID_ART2
186 : CHUNK_ID_ARTL;
187 RIFF::Chunk* art = lart->GetFirstSubChunk();
188 while (art) {
189 if (art->GetChunkID() == artCkType) {
190 if (!pArticulations) pArticulations = new ArticulationList;
191 pArticulations->push_back(new Articulation(art));
192 }
193 art = lart->GetNextSubChunk();
194 }
195 }
196 }
197
198 Articulator::~Articulator() {
199 if (pArticulations) {
200 ArticulationList::iterator iter = pArticulations->begin();
201 ArticulationList::iterator end = pArticulations->end();
202 while (iter != end) {
203 delete *iter;
204 iter++;
205 }
206 delete pArticulations;
207 }
208 }
209
210 /**
211 * Apply all articulations to the respective RIFF chunks. You have to
212 * call File::Save() to make changes persistent.
213 */
214 void Articulator::UpdateChunks() {
215 if (pArticulations) {
216 ArticulationList::iterator iter = pArticulations->begin();
217 ArticulationList::iterator end = pArticulations->end();
218 for (; iter != end; ++iter) {
219 (*iter)->UpdateChunks();
220 }
221 }
222 }
223
224
225
226 // *************** Info ***************
227 // *
228
229 /** @brief Constructor.
230 *
231 * Initializes the info strings with values provided by an INFO list chunk.
232 *
233 * @param list - pointer to a list chunk which contains an INFO list chunk
234 */
235 Info::Info(RIFF::List* list) {
236 UseFixedLengthStrings = false;
237 pResourceListChunk = list;
238 if (list) {
239 RIFF::List* lstINFO = list->GetSubList(LIST_TYPE_INFO);
240 if (lstINFO) {
241 LoadString(CHUNK_ID_INAM, lstINFO, Name);
242 LoadString(CHUNK_ID_IARL, lstINFO, ArchivalLocation);
243 LoadString(CHUNK_ID_ICRD, lstINFO, CreationDate);
244 LoadString(CHUNK_ID_ICMT, lstINFO, Comments);
245 LoadString(CHUNK_ID_IPRD, lstINFO, Product);
246 LoadString(CHUNK_ID_ICOP, lstINFO, Copyright);
247 LoadString(CHUNK_ID_IART, lstINFO, Artists);
248 LoadString(CHUNK_ID_IGNR, lstINFO, Genre);
249 LoadString(CHUNK_ID_IKEY, lstINFO, Keywords);
250 LoadString(CHUNK_ID_IENG, lstINFO, Engineer);
251 LoadString(CHUNK_ID_ITCH, lstINFO, Technician);
252 LoadString(CHUNK_ID_ISFT, lstINFO, Software);
253 LoadString(CHUNK_ID_IMED, lstINFO, Medium);
254 LoadString(CHUNK_ID_ISRC, lstINFO, Source);
255 LoadString(CHUNK_ID_ISRF, lstINFO, SourceForm);
256 LoadString(CHUNK_ID_ICMS, lstINFO, Commissioned);
257 LoadString(CHUNK_ID_ISBJ, lstINFO, Subject);
258 }
259 }
260 }
261
262 Info::~Info() {
263 }
264
265 /** @brief Load given INFO field.
266 *
267 * Load INFO field from INFO chunk with chunk ID \a ChunkID from INFO
268 * list chunk \a lstINFO and save value to \a s.
269 */
270 void Info::LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s) {
271 RIFF::Chunk* ck = lstINFO->GetSubChunk(ChunkID);
272 ::LoadString(ck, s); // function from helper.h
273 }
274
275 /** @brief Apply given INFO field to the respective chunk.
276 *
277 * Apply given info value to info chunk with ID \a ChunkID, which is a
278 * subchunk of INFO list chunk \a lstINFO. If the given chunk already
279 * exists, value \a s will be applied. Otherwise if it doesn't exist yet
280 * and either \a s or \a sDefault is not an empty string, such a chunk
281 * will be created and either \a s or \a sDefault will be applied
282 * (depending on which one is not an empty string, if both are not an
283 * empty string \a s will be preferred).
284 *
285 * @param ChunkID - 32 bit RIFF chunk ID of INFO subchunk
286 * @param lstINFO - parent (INFO) RIFF list chunk
287 * @param s - current value of info field
288 * @param sDefault - default value
289 * @param bUseFixedLengthStrings - should a specific string size be forced in the chunk?
290 * @param size - wanted size of the INFO chunk. This is ignored if bUseFixedLengthStrings is false.
291 */
292 void Info::SaveString(uint32_t ChunkID, RIFF::List* lstINFO, const String& s, const String& sDefault, bool bUseFixedLengthStrings, int size) {
293 RIFF::Chunk* ck = lstINFO->GetSubChunk(ChunkID);
294 ::SaveString(ChunkID, ck, lstINFO, s, sDefault, bUseFixedLengthStrings, size); // function from helper.h
295 }
296
297 /** @brief Update chunks with current info values.
298 *
299 * Apply current INFO field values to the respective INFO chunks. You
300 * have to call File::Save() to make changes persistent.
301 */
302 void Info::UpdateChunks() {
303 if (!pResourceListChunk) return;
304
305 // make sure INFO list chunk exists
306 RIFF::List* lstINFO = pResourceListChunk->GetSubList(LIST_TYPE_INFO);
307
308 String defaultName = "";
309 String defaultCreationDate = "";
310 String defaultSoftware = "";
311 String defaultComments = "";
312
313 uint32_t resourceType = pResourceListChunk->GetListType();
314
315 if (!lstINFO) {
316 lstINFO = pResourceListChunk->AddSubList(LIST_TYPE_INFO);
317
318 // assemble default values
319 defaultName = "NONAME";
320
321 if (resourceType == RIFF_TYPE_DLS) {
322 // get current date
323 time_t now = time(NULL);
324 tm* pNowBroken = localtime(&now);
325 char buf[11];
326 strftime(buf, 11, "%F", pNowBroken);
327 defaultCreationDate = buf;
328
329 defaultComments = "Created with " + libraryName() + " " + libraryVersion();
330 }
331 if (resourceType == RIFF_TYPE_DLS || resourceType == LIST_TYPE_INS)
332 {
333 defaultSoftware = libraryName() + " " + libraryVersion();
334 }
335 }
336
337 // save values
338
339 // (the string size values are for gig files; they are only
340 // used if UseFixedLengthStrings is set to true)
341 SaveString(CHUNK_ID_INAM, lstINFO, Name, defaultName, UseFixedLengthStrings,
342 resourceType == RIFF_TYPE_DLS ? 128 : 64);
343 SaveString(CHUNK_ID_IARL, lstINFO, ArchivalLocation, String(""), UseFixedLengthStrings, 256);
344 SaveString(CHUNK_ID_ICRD, lstINFO, CreationDate, defaultCreationDate, UseFixedLengthStrings, 128);
345 SaveString(CHUNK_ID_ICMT, lstINFO, Comments, defaultComments, UseFixedLengthStrings, 1024);
346 SaveString(CHUNK_ID_IPRD, lstINFO, Product, String(""), UseFixedLengthStrings, 128);
347 SaveString(CHUNK_ID_ICOP, lstINFO, Copyright, String(""), UseFixedLengthStrings, 128);
348 SaveString(CHUNK_ID_IART, lstINFO, Artists, String(""), UseFixedLengthStrings, 128);
349 SaveString(CHUNK_ID_IGNR, lstINFO, Genre, String(""), UseFixedLengthStrings, 128);
350 SaveString(CHUNK_ID_IKEY, lstINFO, Keywords, String(""), UseFixedLengthStrings, 128);
351 SaveString(CHUNK_ID_IENG, lstINFO, Engineer, String(""), UseFixedLengthStrings, 128);
352 SaveString(CHUNK_ID_ITCH, lstINFO, Technician, String(""), UseFixedLengthStrings, 128);
353 SaveString(CHUNK_ID_ISFT, lstINFO, Software, defaultSoftware, UseFixedLengthStrings,
354 resourceType == LIST_TYPE_INS ?
355 (Software == "" ? defaultSoftware.length()+1 : Software.length()+1) : 128);
356 SaveString(CHUNK_ID_IMED, lstINFO, Medium, String(""), UseFixedLengthStrings, 128);
357 SaveString(CHUNK_ID_ISRC, lstINFO, Source, String(""), UseFixedLengthStrings, 128);
358 SaveString(CHUNK_ID_ISRF, lstINFO, SourceForm, String(""), UseFixedLengthStrings, 128);
359 SaveString(CHUNK_ID_ICMS, lstINFO, Commissioned, String(""), UseFixedLengthStrings, 128);
360 SaveString(CHUNK_ID_ISBJ, lstINFO, Subject, String(""), UseFixedLengthStrings, 128);
361 }
362
363
364
365 // *************** Resource ***************
366 // *
367
368 /** @brief Constructor.
369 *
370 * Initializes the 'Resource' object with values provided by a given
371 * INFO list chunk and a DLID chunk (the latter optional).
372 *
373 * @param Parent - pointer to parent 'Resource', NULL if this is
374 * the toplevel 'Resource' object
375 * @param lstResource - pointer to an INFO list chunk
376 */
377 Resource::Resource(Resource* Parent, RIFF::List* lstResource) {
378 pParent = Parent;
379 pResourceList = lstResource;
380
381 pInfo = new Info(lstResource);
382
383 RIFF::Chunk* ckDLSID = lstResource->GetSubChunk(CHUNK_ID_DLID);
384 if (ckDLSID) {
385 pDLSID = new dlsid_t;
386 ckDLSID->Read(&pDLSID->ulData1, 1, 4);
387 ckDLSID->Read(&pDLSID->usData2, 1, 2);
388 ckDLSID->Read(&pDLSID->usData3, 1, 2);
389 ckDLSID->Read(pDLSID->abData, 8, 1);
390 }
391 else pDLSID = NULL;
392 }
393
394 Resource::~Resource() {
395 if (pDLSID) delete pDLSID;
396 if (pInfo) delete pInfo;
397 }
398
399 /** @brief Update chunks with current Resource data.
400 *
401 * Apply Resource data persistently below the previously given resource
402 * list chunk. This will currently only include the INFO data. The DLSID
403 * will not be applied at the moment (yet).
404 *
405 * You have to call File::Save() to make changes persistent.
406 */
407 void Resource::UpdateChunks() {
408 pInfo->UpdateChunks();
409 //TODO: save DLSID
410 }
411
412
413
414 // *************** Sampler ***************
415 // *
416
417 Sampler::Sampler(RIFF::List* ParentList) {
418 pParentList = ParentList;
419 RIFF::Chunk* wsmp = ParentList->GetSubChunk(CHUNK_ID_WSMP);
420 if (wsmp) {
421 uiHeaderSize = wsmp->ReadUint32();
422 UnityNote = wsmp->ReadUint16();
423 FineTune = wsmp->ReadInt16();
424 Gain = wsmp->ReadInt32();
425 SamplerOptions = wsmp->ReadUint32();
426 SampleLoops = wsmp->ReadUint32();
427 } else { // 'wsmp' chunk missing
428 uiHeaderSize = 0;
429 UnityNote = 64;
430 FineTune = 0; // +- 0 cents
431 Gain = 0; // 0 dB
432 SamplerOptions = F_WSMP_NO_COMPRESSION;
433 SampleLoops = 0;
434 }
435 NoSampleDepthTruncation = SamplerOptions & F_WSMP_NO_TRUNCATION;
436 NoSampleCompression = SamplerOptions & F_WSMP_NO_COMPRESSION;
437 pSampleLoops = (SampleLoops) ? new sample_loop_t[SampleLoops] : NULL;
438 if (SampleLoops) {
439 wsmp->SetPos(uiHeaderSize);
440 for (uint32_t i = 0; i < SampleLoops; i++) {
441 wsmp->Read(pSampleLoops + i, 4, 4);
442 if (pSampleLoops[i].Size > sizeof(sample_loop_t)) { // if loop struct was extended
443 wsmp->SetPos(pSampleLoops[i].Size - sizeof(sample_loop_t), RIFF::stream_curpos);
444 }
445 }
446 }
447 }
448
449 Sampler::~Sampler() {
450 if (pSampleLoops) delete[] pSampleLoops;
451 }
452
453 /**
454 * Apply all sample player options to the respective RIFF chunk. You
455 * have to call File::Save() to make changes persistent.
456 */
457 void Sampler::UpdateChunks() {
458 // make sure 'wsmp' chunk exists
459 RIFF::Chunk* wsmp = pParentList->GetSubChunk(CHUNK_ID_WSMP);
460 if (!wsmp) {
461 uiHeaderSize = 20;
462 wsmp = pParentList->AddSubChunk(CHUNK_ID_WSMP, uiHeaderSize + SampleLoops * 16);
463 }
464 uint8_t* pData = (uint8_t*) wsmp->LoadChunkData();
465 // update headers size
466 memcpy(&pData[0], &uiHeaderSize, 4);
467 // update respective sampler options bits
468 SamplerOptions = (NoSampleDepthTruncation) ? SamplerOptions | F_WSMP_NO_TRUNCATION
469 : SamplerOptions & (~F_WSMP_NO_TRUNCATION);
470 SamplerOptions = (NoSampleCompression) ? SamplerOptions | F_WSMP_NO_COMPRESSION
471 : SamplerOptions & (~F_WSMP_NO_COMPRESSION);
472 memcpy(&pData[4], &UnityNote, 2);
473 memcpy(&pData[6], &FineTune, 2);
474 memcpy(&pData[8], &Gain, 4);
475 memcpy(&pData[12], &SamplerOptions, 4);
476 memcpy(&pData[16], &SampleLoops, 4);
477 // update loop definitions
478 for (uint32_t i = 0; i < SampleLoops; i++) {
479 //FIXME: this does not handle extended loop structs correctly
480 memcpy(&pData[uiHeaderSize + i * 16], pSampleLoops + i, 4 * 4);
481 }
482 }
483
484
485
486 // *************** Sample ***************
487 // *
488
489 /** @brief Constructor.
490 *
491 * Load an existing sample or create a new one. A 'wave' list chunk must
492 * be given to this constructor. In case the given 'wave' list chunk
493 * contains a 'fmt' and 'data' chunk, the format and sample data will be
494 * loaded from there, otherwise default values will be used and those
495 * chunks will be created when File::Save() will be called later on.
496 *
497 * @param pFile - pointer to DLS::File where this sample is
498 * located (or will be located)
499 * @param waveList - pointer to 'wave' list chunk which is (or
500 * will be) associated with this sample
501 * @param WavePoolOffset - offset of this sample data from wave pool
502 * ('wvpl') list chunk
503 */
504 Sample::Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset) : Resource(pFile, waveList) {
505 pWaveList = waveList;
506 ulWavePoolOffset = WavePoolOffset - LIST_HEADER_SIZE;
507 pCkFormat = waveList->GetSubChunk(CHUNK_ID_FMT);
508 pCkData = waveList->GetSubChunk(CHUNK_ID_DATA);
509 if (pCkFormat) {
510 // common fields
511 FormatTag = pCkFormat->ReadUint16();
512 Channels = pCkFormat->ReadUint16();
513 SamplesPerSecond = pCkFormat->ReadUint32();
514 AverageBytesPerSecond = pCkFormat->ReadUint32();
515 BlockAlign = pCkFormat->ReadUint16();
516 // PCM format specific
517 if (FormatTag == DLS_WAVE_FORMAT_PCM) {
518 BitDepth = pCkFormat->ReadUint16();
519 FrameSize = (BitDepth / 8) * Channels;
520 } else { // unsupported sample data format
521 BitDepth = 0;
522 FrameSize = 0;
523 }
524 } else { // 'fmt' chunk missing
525 FormatTag = DLS_WAVE_FORMAT_PCM;
526 BitDepth = 16;
527 Channels = 1;
528 SamplesPerSecond = 44100;
529 AverageBytesPerSecond = (BitDepth / 8) * SamplesPerSecond * Channels;
530 FrameSize = (BitDepth / 8) * Channels;
531 BlockAlign = FrameSize;
532 }
533 SamplesTotal = (pCkData) ? (FormatTag == DLS_WAVE_FORMAT_PCM) ? pCkData->GetSize() / FrameSize
534 : 0
535 : 0;
536 }
537
538 /** @brief Destructor.
539 *
540 * Removes RIFF chunks associated with this Sample and frees all
541 * memory occupied by this sample.
542 */
543 Sample::~Sample() {
544 RIFF::List* pParent = pWaveList->GetParent();
545 pParent->DeleteSubChunk(pWaveList);
546 }
547
548 /** @brief Load sample data into RAM.
549 *
550 * In case the respective 'data' chunk exists, the sample data will be
551 * loaded into RAM (if not done already) and a pointer to the data in
552 * RAM will be returned. If this is a new sample, you have to call
553 * Resize() with the desired sample size to create the mandatory RIFF
554 * chunk for the sample wave data.
555 *
556 * You can call LoadChunkData() again if you previously scheduled to
557 * enlarge the sample data RIFF chunk with a Resize() call. In that case
558 * the buffer will be enlarged to the new, scheduled size and you can
559 * already place the sample wave data to the buffer and finally call
560 * File::Save() to enlarge the sample data's chunk physically and write
561 * the new sample wave data in one rush. This approach is definitely
562 * recommended if you have to enlarge and write new sample data to a lot
563 * of samples.
564 *
565 * <b>Caution:</b> the buffer pointer will be invalidated once
566 * File::Save() was called. You have to call LoadChunkData() again to
567 * get a new, valid pointer whenever File::Save() was called.
568 *
569 * @returns pointer to sample data in RAM, NULL in case respective
570 * 'data' chunk does not exist (yet)
571 * @throws Exception if data buffer could not be enlarged
572 * @see Resize(), File::Save()
573 */
574 void* Sample::LoadSampleData() {
575 return (pCkData) ? pCkData->LoadChunkData() : NULL;
576 }
577
578 /** @brief Free sample data from RAM.
579 *
580 * In case sample data was previously successfully loaded into RAM with
581 * LoadSampleData(), this method will free the sample data from RAM.
582 */
583 void Sample::ReleaseSampleData() {
584 if (pCkData) pCkData->ReleaseChunkData();
585 }
586
587 /** @brief Returns sample size.
588 *
589 * Returns the sample wave form's data size (in sample points). This is
590 * actually the current, physical size (converted to sample points) of
591 * the RIFF chunk which encapsulates the sample's wave data. The
592 * returned value is dependant to the current FrameSize value.
593 *
594 * @returns number of sample points or 0 if FormatTag != DLS_WAVE_FORMAT_PCM
595 * @see FrameSize, FormatTag
596 */
597 unsigned long Sample::GetSize() {
598 if (FormatTag != DLS_WAVE_FORMAT_PCM) return 0;
599 return (pCkData) ? pCkData->GetSize() / FrameSize : 0;
600 }
601
602 /** @brief Resize sample.
603 *
604 * Resizes the sample's wave form data, that is the actual size of
605 * sample wave data possible to be written for this sample. This call
606 * will return immediately and just schedule the resize operation. You
607 * should call File::Save() to actually perform the resize operation(s)
608 * "physically" to the file. As this can take a while on large files, it
609 * is recommended to call Resize() first on all samples which have to be
610 * resized and finally to call File::Save() to perform all those resize
611 * operations in one rush.
612 *
613 * The actual size (in bytes) is dependant to the current FrameSize
614 * value. You may want to set FrameSize before calling Resize().
615 *
616 * <b>Caution:</b> You cannot directly write to enlarged samples before
617 * calling File::Save() as this might exceed the current sample's
618 * boundary!
619 *
620 * Also note: only DLS_WAVE_FORMAT_PCM is currently supported, that is
621 * FormatTag must be DLS_WAVE_FORMAT_PCM. Trying to resize samples with
622 * other formats will fail!
623 *
624 * @param iNewSize - new sample wave data size in sample points (must be
625 * greater than zero)
626 * @throws Excecption if FormatTag != DLS_WAVE_FORMAT_PCM
627 * @throws Exception if \a iNewSize is less than 1
628 * @see File::Save(), FrameSize, FormatTag
629 */
630 void Sample::Resize(int iNewSize) {
631 if (FormatTag != DLS_WAVE_FORMAT_PCM) throw Exception("Sample's format is not DLS_WAVE_FORMAT_PCM");
632 if (iNewSize < 1) throw Exception("Sample size must be at least one sample point");
633 const int iSizeInBytes = iNewSize * FrameSize;
634 pCkData = pWaveList->GetSubChunk(CHUNK_ID_DATA);
635 if (pCkData) pCkData->Resize(iSizeInBytes);
636 else pCkData = pWaveList->AddSubChunk(CHUNK_ID_DATA, iSizeInBytes);
637 }
638
639 /**
640 * Sets the position within the sample (in sample points, not in
641 * bytes). Use this method and <i>Read()</i> if you don't want to load
642 * the sample into RAM, thus for disk streaming.
643 *
644 * Also note: only DLS_WAVE_FORMAT_PCM is currently supported, that is
645 * FormatTag must be DLS_WAVE_FORMAT_PCM. Trying to reposition the sample
646 * with other formats will fail!
647 *
648 * @param SampleCount number of sample points
649 * @param Whence to which relation \a SampleCount refers to
650 * @returns new position within the sample, 0 if
651 * FormatTag != DLS_WAVE_FORMAT_PCM
652 * @throws Exception if no data RIFF chunk was created for the sample yet
653 * @see FrameSize, FormatTag
654 */
655 unsigned long Sample::SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence) {
656 if (FormatTag != DLS_WAVE_FORMAT_PCM) return 0; // failed: wave data not PCM format
657 if (!pCkData) throw Exception("No data chunk created for sample yet, call Sample::Resize() to create one");
658 unsigned long orderedBytes = SampleCount * FrameSize;
659 unsigned long result = pCkData->SetPos(orderedBytes, Whence);
660 return (result == orderedBytes) ? SampleCount
661 : result / FrameSize;
662 }
663
664 /**
665 * Reads \a SampleCount number of sample points from the current
666 * position into the buffer pointed by \a pBuffer and increments the
667 * position within the sample. Use this method and <i>SetPos()</i> if you
668 * don't want to load the sample into RAM, thus for disk streaming.
669 *
670 * @param pBuffer destination buffer
671 * @param SampleCount number of sample points to read
672 */
673 unsigned long Sample::Read(void* pBuffer, unsigned long SampleCount) {
674 if (FormatTag != DLS_WAVE_FORMAT_PCM) return 0; // failed: wave data not PCM format
675 return pCkData->Read(pBuffer, SampleCount, FrameSize); // FIXME: channel inversion due to endian correction?
676 }
677
678 /** @brief Write sample wave data.
679 *
680 * Writes \a SampleCount number of sample points from the buffer pointed
681 * by \a pBuffer and increments the position within the sample. Use this
682 * method to directly write the sample data to disk, i.e. if you don't
683 * want or cannot load the whole sample data into RAM.
684 *
685 * You have to Resize() the sample to the desired size and call
686 * File::Save() <b>before</b> using Write().
687 *
688 * @param pBuffer - source buffer
689 * @param SampleCount - number of sample points to write
690 * @throws Exception if current sample size is too small
691 * @see LoadSampleData()
692 */
693 unsigned long Sample::Write(void* pBuffer, unsigned long SampleCount) {
694 if (FormatTag != DLS_WAVE_FORMAT_PCM) return 0; // failed: wave data not PCM format
695 if (GetSize() < SampleCount) throw Exception("Could not write sample data, current sample size to small");
696 return pCkData->Write(pBuffer, SampleCount, FrameSize); // FIXME: channel inversion due to endian correction?
697 }
698
699 /**
700 * Apply sample and its settings to the respective RIFF chunks. You have
701 * to call File::Save() to make changes persistent.
702 *
703 * @throws Exception if FormatTag != DLS_WAVE_FORMAT_PCM or no sample data
704 * was provided yet
705 */
706 void Sample::UpdateChunks() {
707 if (FormatTag != DLS_WAVE_FORMAT_PCM)
708 throw Exception("Could not save sample, only PCM format is supported");
709 // we refuse to do anything if not sample wave form was provided yet
710 if (!pCkData)
711 throw Exception("Could not save sample, there is no sample data to save");
712 // update chunks of base class as well
713 Resource::UpdateChunks();
714 // make sure 'fmt' chunk exists
715 RIFF::Chunk* pCkFormat = pWaveList->GetSubChunk(CHUNK_ID_FMT);
716 if (!pCkFormat) pCkFormat = pWaveList->AddSubChunk(CHUNK_ID_FMT, 16); // assumes PCM format
717 uint8_t* pData = (uint8_t*) pCkFormat->LoadChunkData();
718 // update 'fmt' chunk
719 memcpy(&pData[0], &FormatTag, 2);
720 memcpy(&pData[2], &Channels, 2);
721 memcpy(&pData[4], &SamplesPerSecond, 4);
722 memcpy(&pData[8], &AverageBytesPerSecond, 4);
723 memcpy(&pData[12], &BlockAlign, 2);
724 memcpy(&pData[14], &BitDepth, 2); // assuming PCM format
725 }
726
727
728
729 // *************** Region ***************
730 // *
731
732 Region::Region(Instrument* pInstrument, RIFF::List* rgnList) : Resource(pInstrument, rgnList), Articulator(rgnList), Sampler(rgnList) {
733 pCkRegion = rgnList;
734
735 // articulation informations
736 RIFF::Chunk* rgnh = rgnList->GetSubChunk(CHUNK_ID_RGNH);
737 if (rgnh) {
738 rgnh->Read(&KeyRange, 2, 2);
739 rgnh->Read(&VelocityRange, 2, 2);
740 FormatOptionFlags = rgnh->ReadUint16();
741 KeyGroup = rgnh->ReadUint16();
742 // Layer is optional
743 if (rgnh->RemainingBytes() >= sizeof(uint16_t)) {
744 rgnh->Read(&Layer, 1, sizeof(uint16_t));
745 } else Layer = 0;
746 } else { // 'rgnh' chunk is missing
747 KeyRange.low = 0;
748 KeyRange.high = 127;
749 VelocityRange.low = 0;
750 VelocityRange.high = 127;
751 FormatOptionFlags = F_RGN_OPTION_SELFNONEXCLUSIVE;
752 KeyGroup = 0;
753 Layer = 0;
754 }
755 SelfNonExclusive = FormatOptionFlags & F_RGN_OPTION_SELFNONEXCLUSIVE;
756
757 // sample informations
758 RIFF::Chunk* wlnk = rgnList->GetSubChunk(CHUNK_ID_WLNK);
759 if (wlnk) {
760 WaveLinkOptionFlags = wlnk->ReadUint16();
761 PhaseGroup = wlnk->ReadUint16();
762 Channel = wlnk->ReadUint32();
763 WavePoolTableIndex = wlnk->ReadUint32();
764 } else { // 'wlnk' chunk is missing
765 WaveLinkOptionFlags = 0;
766 PhaseGroup = 0;
767 Channel = 0; // mono
768 WavePoolTableIndex = 0; // first entry in wave pool table
769 }
770 PhaseMaster = WaveLinkOptionFlags & F_WAVELINK_PHASE_MASTER;
771 MultiChannel = WaveLinkOptionFlags & F_WAVELINK_MULTICHANNEL;
772
773 pSample = NULL;
774 }
775
776 /** @brief Destructor.
777 *
778 * Removes RIFF chunks associated with this Region.
779 */
780 Region::~Region() {
781 RIFF::List* pParent = pCkRegion->GetParent();
782 pParent->DeleteSubChunk(pCkRegion);
783 }
784
785 Sample* Region::GetSample() {
786 if (pSample) return pSample;
787 File* file = (File*) GetParent()->GetParent();
788 unsigned long soughtoffset = file->pWavePoolTable[WavePoolTableIndex];
789 Sample* sample = file->GetFirstSample();
790 while (sample) {
791 if (sample->ulWavePoolOffset == soughtoffset) return (pSample = sample);
792 sample = file->GetNextSample();
793 }
794 return NULL;
795 }
796
797 /**
798 * Assign another sample to this Region.
799 *
800 * @param pSample - sample to be assigned
801 */
802 void Region::SetSample(Sample* pSample) {
803 this->pSample = pSample;
804 WavePoolTableIndex = 0; // we update this offset when we Save()
805 }
806
807 /**
808 * Apply Region settings to the respective RIFF chunks. You have to
809 * call File::Save() to make changes persistent.
810 *
811 * @throws Exception - if the Region's sample could not be found
812 */
813 void Region::UpdateChunks() {
814 // make sure 'rgnh' chunk exists
815 RIFF::Chunk* rgnh = pCkRegion->GetSubChunk(CHUNK_ID_RGNH);
816 if (!rgnh) rgnh = pCkRegion->AddSubChunk(CHUNK_ID_RGNH, Layer ? 14 : 12);
817 uint8_t* pData = (uint8_t*) rgnh->LoadChunkData();
818 FormatOptionFlags = (SelfNonExclusive)
819 ? FormatOptionFlags | F_RGN_OPTION_SELFNONEXCLUSIVE
820 : FormatOptionFlags & (~F_RGN_OPTION_SELFNONEXCLUSIVE);
821 // update 'rgnh' chunk
822 memcpy(&pData[0], &KeyRange, 2 * 2);
823 memcpy(&pData[4], &VelocityRange, 2 * 2);
824 memcpy(&pData[8], &FormatOptionFlags, 2);
825 memcpy(&pData[10], &KeyGroup, 2);
826 if (rgnh->GetSize() >= 14) memcpy(&pData[12], &Layer, 2);
827
828 // update chunks of base classes as well (but skip Resource,
829 // as a rgn doesn't seem to have dlid and INFO chunks)
830 Articulator::UpdateChunks();
831 Sampler::UpdateChunks();
832
833 // make sure 'wlnk' chunk exists
834 RIFF::Chunk* wlnk = pCkRegion->GetSubChunk(CHUNK_ID_WLNK);
835 if (!wlnk) wlnk = pCkRegion->AddSubChunk(CHUNK_ID_WLNK, 12);
836 pData = (uint8_t*) wlnk->LoadChunkData();
837 WaveLinkOptionFlags = (PhaseMaster)
838 ? WaveLinkOptionFlags | F_WAVELINK_PHASE_MASTER
839 : WaveLinkOptionFlags & (~F_WAVELINK_PHASE_MASTER);
840 WaveLinkOptionFlags = (MultiChannel)
841 ? WaveLinkOptionFlags | F_WAVELINK_MULTICHANNEL
842 : WaveLinkOptionFlags & (~F_WAVELINK_MULTICHANNEL);
843 // get sample's wave pool table index
844 int index = -1;
845 File* pFile = (File*) GetParent()->GetParent();
846 if (pFile->pSamples) {
847 File::SampleList::iterator iter = pFile->pSamples->begin();
848 File::SampleList::iterator end = pFile->pSamples->end();
849 for (int i = 0; iter != end; ++iter, i++) {
850 if (*iter == pSample) {
851 index = i;
852 break;
853 }
854 }
855 }
856 if (index < 0) throw Exception("Could not save Region, could not find Region's sample");
857 WavePoolTableIndex = index;
858 // update 'wlnk' chunk
859 memcpy(&pData[0], &WaveLinkOptionFlags, 2);
860 memcpy(&pData[2], &PhaseGroup, 2);
861 memcpy(&pData[4], &Channel, 4);
862 memcpy(&pData[8], &WavePoolTableIndex, 4);
863 }
864
865
866
867 // *************** Instrument ***************
868 // *
869
870 /** @brief Constructor.
871 *
872 * Load an existing instrument definition or create a new one. An 'ins'
873 * list chunk must be given to this constructor. In case this 'ins' list
874 * chunk contains a 'insh' chunk, the instrument data fields will be
875 * loaded from there, otherwise default values will be used and the
876 * 'insh' chunk will be created once File::Save() was called.
877 *
878 * @param pFile - pointer to DLS::File where this instrument is
879 * located (or will be located)
880 * @param insList - pointer to 'ins' list chunk which is (or will be)
881 * associated with this instrument
882 */
883 Instrument::Instrument(File* pFile, RIFF::List* insList) : Resource(pFile, insList), Articulator(insList) {
884 pCkInstrument = insList;
885
886 midi_locale_t locale;
887 RIFF::Chunk* insh = pCkInstrument->GetSubChunk(CHUNK_ID_INSH);
888 if (insh) {
889 Regions = insh->ReadUint32();
890 insh->Read(&locale, 2, 4);
891 } else { // 'insh' chunk missing
892 Regions = 0;
893 locale.bank = 0;
894 locale.instrument = 0;
895 }
896
897 MIDIProgram = locale.instrument;
898 IsDrum = locale.bank & DRUM_TYPE_MASK;
899 MIDIBankCoarse = (uint8_t) MIDI_BANK_COARSE(locale.bank);
900 MIDIBankFine = (uint8_t) MIDI_BANK_FINE(locale.bank);
901 MIDIBank = MIDI_BANK_MERGE(MIDIBankCoarse, MIDIBankFine);
902
903 pRegions = NULL;
904 }
905
906 Region* Instrument::GetFirstRegion() {
907 if (!pRegions) LoadRegions();
908 if (!pRegions) return NULL;
909 RegionsIterator = pRegions->begin();
910 return (RegionsIterator != pRegions->end()) ? *RegionsIterator : NULL;
911 }
912
913 Region* Instrument::GetNextRegion() {
914 if (!pRegions) return NULL;
915 RegionsIterator++;
916 return (RegionsIterator != pRegions->end()) ? *RegionsIterator : NULL;
917 }
918
919 void Instrument::LoadRegions() {
920 if (!pRegions) pRegions = new RegionList;
921 RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
922 if (lrgn) {
923 uint32_t regionCkType = (lrgn->GetSubList(LIST_TYPE_RGN2)) ? LIST_TYPE_RGN2 : LIST_TYPE_RGN; // prefer regions level 2
924 RIFF::List* rgn = lrgn->GetFirstSubList();
925 while (rgn) {
926 if (rgn->GetListType() == regionCkType) {
927 pRegions->push_back(new Region(this, rgn));
928 }
929 rgn = lrgn->GetNextSubList();
930 }
931 }
932 }
933
934 Region* Instrument::AddRegion() {
935 if (!pRegions) LoadRegions();
936 RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
937 if (!lrgn) lrgn = pCkInstrument->AddSubList(LIST_TYPE_LRGN);
938 RIFF::List* rgn = lrgn->AddSubList(LIST_TYPE_RGN);
939 Region* pNewRegion = new Region(this, rgn);
940 pRegions->push_back(pNewRegion);
941 Regions = pRegions->size();
942 return pNewRegion;
943 }
944
945 void Instrument::MoveRegion(Region* pSrc, Region* pDst) {
946 RIFF::List* lrgn = pCkInstrument->GetSubList(LIST_TYPE_LRGN);
947 lrgn->MoveSubChunk(pSrc->pCkRegion, pDst ? pDst->pCkRegion : 0);
948
949 pRegions->remove(pSrc);
950 RegionList::iterator iter = find(pRegions->begin(), pRegions->end(), pDst);
951 pRegions->insert(iter, pSrc);
952 }
953
954 void Instrument::DeleteRegion(Region* pRegion) {
955 if (!pRegions) return;
956 RegionList::iterator iter = find(pRegions->begin(), pRegions->end(), pRegion);
957 if (iter == pRegions->end()) return;
958 pRegions->erase(iter);
959 Regions = pRegions->size();
960 delete pRegion;
961 }
962
963 /**
964 * Apply Instrument with all its Regions to the respective RIFF chunks.
965 * You have to call File::Save() to make changes persistent.
966 *
967 * @throws Exception - on errors
968 */
969 void Instrument::UpdateChunks() {
970 // first update base classes' chunks
971 Resource::UpdateChunks();
972 Articulator::UpdateChunks();
973 // make sure 'insh' chunk exists
974 RIFF::Chunk* insh = pCkInstrument->GetSubChunk(CHUNK_ID_INSH);
975 if (!insh) insh = pCkInstrument->AddSubChunk(CHUNK_ID_INSH, 12);
976 uint8_t* pData = (uint8_t*) insh->LoadChunkData();
977 // update 'insh' chunk
978 Regions = (pRegions) ? pRegions->size() : 0;
979 midi_locale_t locale;
980 locale.instrument = MIDIProgram;
981 locale.bank = MIDI_BANK_ENCODE(MIDIBankCoarse, MIDIBankFine);
982 locale.bank = (IsDrum) ? locale.bank | DRUM_TYPE_MASK : locale.bank & (~DRUM_TYPE_MASK);
983 MIDIBank = MIDI_BANK_MERGE(MIDIBankCoarse, MIDIBankFine); // just a sync, when we're at it
984 memcpy(&pData[0], &Regions, 4);
985 memcpy(&pData[4], &locale, 2 * 4);
986 // update Region's chunks
987 if (!pRegions) return;
988 RegionList::iterator iter = pRegions->begin();
989 RegionList::iterator end = pRegions->end();
990 for (; iter != end; ++iter) {
991 (*iter)->UpdateChunks();
992 }
993 }
994
995 /** @brief Destructor.
996 *
997 * Removes RIFF chunks associated with this Instrument and frees all
998 * memory occupied by this instrument.
999 */
1000 Instrument::~Instrument() {
1001 if (pRegions) {
1002 RegionList::iterator iter = pRegions->begin();
1003 RegionList::iterator end = pRegions->end();
1004 while (iter != end) {
1005 delete *iter;
1006 iter++;
1007 }
1008 delete pRegions;
1009 }
1010 // remove instrument's chunks
1011 RIFF::List* pParent = pCkInstrument->GetParent();
1012 pParent->DeleteSubChunk(pCkInstrument);
1013 }
1014
1015
1016
1017 // *************** File ***************
1018 // *
1019
1020 /** @brief Constructor.
1021 *
1022 * Default constructor, use this to create an empty DLS file. You have
1023 * to add samples, instruments and finally call Save() to actually write
1024 * a DLS file.
1025 */
1026 File::File() : Resource(NULL, pRIFF = new RIFF::File(RIFF_TYPE_DLS)) {
1027 pVersion = new version_t;
1028 pVersion->major = 0;
1029 pVersion->minor = 0;
1030 pVersion->release = 0;
1031 pVersion->build = 0;
1032
1033 Instruments = 0;
1034 WavePoolCount = 0;
1035 pWavePoolTable = NULL;
1036 pWavePoolTableHi = NULL;
1037 WavePoolHeaderSize = 8;
1038
1039 pSamples = NULL;
1040 pInstruments = NULL;
1041
1042 b64BitWavePoolOffsets = false;
1043 }
1044
1045 /** @brief Constructor.
1046 *
1047 * Load an existing DLS file.
1048 *
1049 * @param pRIFF - pointer to a RIFF file which is actually the DLS file
1050 * to load
1051 * @throws Exception if given file is not a DLS file, expected chunks
1052 * are missing
1053 */
1054 File::File(RIFF::File* pRIFF) : Resource(NULL, pRIFF) {
1055 if (!pRIFF) throw DLS::Exception("NULL pointer reference to RIFF::File object.");
1056 this->pRIFF = pRIFF;
1057
1058 RIFF::Chunk* ckVersion = pRIFF->GetSubChunk(CHUNK_ID_VERS);
1059 if (ckVersion) {
1060 pVersion = new version_t;
1061 ckVersion->Read(pVersion, 4, 2);
1062 }
1063 else pVersion = NULL;
1064
1065 RIFF::Chunk* colh = pRIFF->GetSubChunk(CHUNK_ID_COLH);
1066 if (!colh) throw DLS::Exception("Mandatory chunks in RIFF list chunk not found.");
1067 Instruments = colh->ReadUint32();
1068
1069 RIFF::Chunk* ptbl = pRIFF->GetSubChunk(CHUNK_ID_PTBL);
1070 if (!ptbl) { // pool table is missing - this is probably an ".art" file
1071 WavePoolCount = 0;
1072 pWavePoolTable = NULL;
1073 pWavePoolTableHi = NULL;
1074 WavePoolHeaderSize = 8;
1075 b64BitWavePoolOffsets = false;
1076 } else {
1077 WavePoolHeaderSize = ptbl->ReadUint32();
1078 WavePoolCount = ptbl->ReadUint32();
1079 pWavePoolTable = new uint32_t[WavePoolCount];
1080 pWavePoolTableHi = new uint32_t[WavePoolCount];
1081 ptbl->SetPos(WavePoolHeaderSize);
1082
1083 // Check for 64 bit offsets (used in gig v3 files)
1084 b64BitWavePoolOffsets = (ptbl->GetSize() - WavePoolHeaderSize == WavePoolCount * 8);
1085 if (b64BitWavePoolOffsets) {
1086 for (int i = 0 ; i < WavePoolCount ; i++) {
1087 pWavePoolTableHi[i] = ptbl->ReadUint32();
1088 pWavePoolTable[i] = ptbl->ReadUint32();
1089 if (pWavePoolTable[i] & 0x80000000)
1090 throw DLS::Exception("Files larger than 2 GB not yet supported");
1091 }
1092 } else { // conventional 32 bit offsets
1093 ptbl->Read(pWavePoolTable, WavePoolCount, sizeof(uint32_t));
1094 for (int i = 0 ; i < WavePoolCount ; i++) pWavePoolTableHi[i] = 0;
1095 }
1096 }
1097
1098 pSamples = NULL;
1099 pInstruments = NULL;
1100 }
1101
1102 File::~File() {
1103 if (pInstruments) {
1104 InstrumentList::iterator iter = pInstruments->begin();
1105 InstrumentList::iterator end = pInstruments->end();
1106 while (iter != end) {
1107 delete *iter;
1108 iter++;
1109 }
1110 delete pInstruments;
1111 }
1112
1113 if (pSamples) {
1114 SampleList::iterator iter = pSamples->begin();
1115 SampleList::iterator end = pSamples->end();
1116 while (iter != end) {
1117 delete *iter;
1118 iter++;
1119 }
1120 delete pSamples;
1121 }
1122
1123 if (pWavePoolTable) delete[] pWavePoolTable;
1124 if (pWavePoolTableHi) delete[] pWavePoolTableHi;
1125 if (pVersion) delete pVersion;
1126 for (std::list<RIFF::File*>::iterator i = ExtensionFiles.begin() ; i != ExtensionFiles.end() ; i++)
1127 delete *i;
1128 }
1129
1130 Sample* File::GetFirstSample() {
1131 if (!pSamples) LoadSamples();
1132 if (!pSamples) return NULL;
1133 SamplesIterator = pSamples->begin();
1134 return (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL;
1135 }
1136
1137 Sample* File::GetNextSample() {
1138 if (!pSamples) return NULL;
1139 SamplesIterator++;
1140 return (SamplesIterator != pSamples->end()) ? *SamplesIterator : NULL;
1141 }
1142
1143 void File::LoadSamples() {
1144 if (!pSamples) pSamples = new SampleList;
1145 RIFF::List* wvpl = pRIFF->GetSubList(LIST_TYPE_WVPL);
1146 if (wvpl) {
1147 unsigned long wvplFileOffset = wvpl->GetFilePos();
1148 RIFF::List* wave = wvpl->GetFirstSubList();
1149 while (wave) {
1150 if (wave->GetListType() == LIST_TYPE_WAVE) {
1151 unsigned long waveFileOffset = wave->GetFilePos();
1152 pSamples->push_back(new Sample(this, wave, waveFileOffset - wvplFileOffset));
1153 }
1154 wave = wvpl->GetNextSubList();
1155 }
1156 }
1157 else { // Seen a dwpl list chunk instead of a wvpl list chunk in some file (officially not DLS compliant)
1158 RIFF::List* dwpl = pRIFF->GetSubList(LIST_TYPE_DWPL);
1159 if (dwpl) {
1160 unsigned long dwplFileOffset = dwpl->GetFilePos();
1161 RIFF::List* wave = dwpl->GetFirstSubList();
1162 while (wave) {
1163 if (wave->GetListType() == LIST_TYPE_WAVE) {
1164 unsigned long waveFileOffset = wave->GetFilePos();
1165 pSamples->push_back(new Sample(this, wave, waveFileOffset - dwplFileOffset));
1166 }
1167 wave = dwpl->GetNextSubList();
1168 }
1169 }
1170 }
1171 }
1172
1173 /** @brief Add a new sample.
1174 *
1175 * This will create a new Sample object for the DLS file. You have to
1176 * call Save() to make this persistent to the file.
1177 *
1178 * @returns pointer to new Sample object
1179 */
1180 Sample* File::AddSample() {
1181 if (!pSamples) LoadSamples();
1182 __ensureMandatoryChunksExist();
1183 RIFF::List* wvpl = pRIFF->GetSubList(LIST_TYPE_WVPL);
1184 // create new Sample object and its respective 'wave' list chunk
1185 RIFF::List* wave = wvpl->AddSubList(LIST_TYPE_WAVE);
1186 Sample* pSample = new Sample(this, wave, 0 /*arbitrary value, we update offsets when we save*/);
1187 pSamples->push_back(pSample);
1188 return pSample;
1189 }
1190
1191 /** @brief Delete a sample.
1192 *
1193 * This will delete the given Sample object from the DLS file. You have
1194 * to call Save() to make this persistent to the file.
1195 *
1196 * @param pSample - sample to delete
1197 */
1198 void File::DeleteSample(Sample* pSample) {
1199 if (!pSamples) return;
1200 SampleList::iterator iter = find(pSamples->begin(), pSamples->end(), pSample);
1201 if (iter == pSamples->end()) return;
1202 pSamples->erase(iter);
1203 delete pSample;
1204 }
1205
1206 Instrument* File::GetFirstInstrument() {
1207 if (!pInstruments) LoadInstruments();
1208 if (!pInstruments) return NULL;
1209 InstrumentsIterator = pInstruments->begin();
1210 return (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL;
1211 }
1212
1213 Instrument* File::GetNextInstrument() {
1214 if (!pInstruments) return NULL;
1215 InstrumentsIterator++;
1216 return (InstrumentsIterator != pInstruments->end()) ? *InstrumentsIterator : NULL;
1217 }
1218
1219 void File::LoadInstruments() {
1220 if (!pInstruments) pInstruments = new InstrumentList;
1221 RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
1222 if (lstInstruments) {
1223 RIFF::List* lstInstr = lstInstruments->GetFirstSubList();
1224 while (lstInstr) {
1225 if (lstInstr->GetListType() == LIST_TYPE_INS) {
1226 pInstruments->push_back(new Instrument(this, lstInstr));
1227 }
1228 lstInstr = lstInstruments->GetNextSubList();
1229 }
1230 }
1231 }
1232
1233 /** @brief Add a new instrument definition.
1234 *
1235 * This will create a new Instrument object for the DLS file. You have
1236 * to call Save() to make this persistent to the file.
1237 *
1238 * @returns pointer to new Instrument object
1239 */
1240 Instrument* File::AddInstrument() {
1241 if (!pInstruments) LoadInstruments();
1242 __ensureMandatoryChunksExist();
1243 RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
1244 RIFF::List* lstInstr = lstInstruments->AddSubList(LIST_TYPE_INS);
1245 Instrument* pInstrument = new Instrument(this, lstInstr);
1246 pInstruments->push_back(pInstrument);
1247 return pInstrument;
1248 }
1249
1250 /** @brief Delete an instrument.
1251 *
1252 * This will delete the given Instrument object from the DLS file. You
1253 * have to call Save() to make this persistent to the file.
1254 *
1255 * @param pInstrument - instrument to delete
1256 */
1257 void File::DeleteInstrument(Instrument* pInstrument) {
1258 if (!pInstruments) return;
1259 InstrumentList::iterator iter = find(pInstruments->begin(), pInstruments->end(), pInstrument);
1260 if (iter == pInstruments->end()) return;
1261 pInstruments->erase(iter);
1262 delete pInstrument;
1263 }
1264
1265 /**
1266 * Apply all the DLS file's current instruments, samples and settings to
1267 * the respective RIFF chunks. You have to call Save() to make changes
1268 * persistent.
1269 *
1270 * @throws Exception - on errors
1271 */
1272 void File::UpdateChunks() {
1273 // first update base class's chunks
1274 Resource::UpdateChunks();
1275
1276 // if version struct exists, update 'vers' chunk
1277 if (pVersion) {
1278 RIFF::Chunk* ckVersion = pRIFF->GetSubChunk(CHUNK_ID_VERS);
1279 if (!ckVersion) ckVersion = pRIFF->AddSubChunk(CHUNK_ID_VERS, 8);
1280 uint8_t* pData = (uint8_t*) ckVersion->LoadChunkData();
1281 memcpy(pData, pVersion, 2 * 4);
1282 }
1283
1284 // update 'colh' chunk
1285 Instruments = (pInstruments) ? pInstruments->size() : 0;
1286 RIFF::Chunk* colh = pRIFF->GetSubChunk(CHUNK_ID_COLH);
1287 if (!colh) colh = pRIFF->AddSubChunk(CHUNK_ID_COLH, 4);
1288 uint8_t* pData = (uint8_t*) colh->LoadChunkData();
1289 memcpy(pData, &Instruments, 4);
1290
1291 // update instrument's chunks
1292 if (pInstruments) {
1293 InstrumentList::iterator iter = pInstruments->begin();
1294 InstrumentList::iterator end = pInstruments->end();
1295 for (; iter != end; ++iter) {
1296 (*iter)->UpdateChunks();
1297 }
1298 }
1299
1300 // update 'ptbl' chunk
1301 const int iSamples = (pSamples) ? pSamples->size() : 0;
1302 const int iPtblOffsetSize = (b64BitWavePoolOffsets) ? 8 : 4;
1303 RIFF::Chunk* ptbl = pRIFF->GetSubChunk(CHUNK_ID_PTBL);
1304 if (!ptbl) ptbl = pRIFF->AddSubChunk(CHUNK_ID_PTBL, 1 /*anything, we'll resize*/);
1305 const int iPtblSize = WavePoolHeaderSize + iPtblOffsetSize * iSamples;
1306 ptbl->Resize(iPtblSize);
1307 pData = (uint8_t*) ptbl->LoadChunkData();
1308 WavePoolCount = iSamples;
1309 memcpy(&pData[4], &WavePoolCount, 4);
1310 // we actually update the sample offsets in the pool table when we Save()
1311 memset(&pData[WavePoolHeaderSize], 0, iPtblSize - WavePoolHeaderSize);
1312
1313 // update sample's chunks
1314 if (pSamples) {
1315 SampleList::iterator iter = pSamples->begin();
1316 SampleList::iterator end = pSamples->end();
1317 for (; iter != end; ++iter) {
1318 (*iter)->UpdateChunks();
1319 }
1320 }
1321 }
1322
1323 /** @brief Save changes to another file.
1324 *
1325 * Make all changes persistent by writing them to another file.
1326 * <b>Caution:</b> this method is optimized for writing to
1327 * <b>another</b> file, do not use it to save the changes to the same
1328 * file! Use Save() (without path argument) in that case instead!
1329 * Ignoring this might result in a corrupted file!
1330 *
1331 * After calling this method, this File object will be associated with
1332 * the new file (given by \a Path) afterwards.
1333 *
1334 * @param Path - path and file name where everything should be written to
1335 */
1336 void File::Save(const String& Path) {
1337 UpdateChunks();
1338 pRIFF->Save(Path);
1339 __UpdateWavePoolTableChunk();
1340 }
1341
1342 /** @brief Save changes to same file.
1343 *
1344 * Make all changes persistent by writing them to the actual (same)
1345 * file. The file might temporarily grow to a higher size than it will
1346 * have at the end of the saving process.
1347 *
1348 * @throws RIFF::Exception if any kind of IO error occured
1349 * @throws DLS::Exception if any kind of DLS specific error occured
1350 */
1351 void File::Save() {
1352 UpdateChunks();
1353 pRIFF->Save();
1354 __UpdateWavePoolTableChunk();
1355 }
1356
1357 /**
1358 * Checks if all (for DLS) mandatory chunks exist, if not they will be
1359 * created. Note that those chunks will not be made persistent until
1360 * Save() was called.
1361 */
1362 void File::__ensureMandatoryChunksExist() {
1363 // enusre 'lins' list chunk exists (mandatory for instrument definitions)
1364 RIFF::List* lstInstruments = pRIFF->GetSubList(LIST_TYPE_LINS);
1365 if (!lstInstruments) pRIFF->AddSubList(LIST_TYPE_LINS);
1366 // ensure 'ptbl' chunk exists (mandatory for samples)
1367 RIFF::Chunk* ptbl = pRIFF->GetSubChunk(CHUNK_ID_PTBL);
1368 if (!ptbl) {
1369 const int iOffsetSize = (b64BitWavePoolOffsets) ? 8 : 4;
1370 ptbl = pRIFF->AddSubChunk(CHUNK_ID_PTBL, WavePoolHeaderSize + iOffsetSize);
1371 }
1372 // enusre 'wvpl' list chunk exists (mandatory for samples)
1373 RIFF::List* wvpl = pRIFF->GetSubList(LIST_TYPE_WVPL);
1374 if (!wvpl) pRIFF->AddSubList(LIST_TYPE_WVPL);
1375 }
1376
1377 /**
1378 * Updates (persistently) the wave pool table with offsets to all
1379 * currently available samples. <b>Caution:</b> this method assumes the
1380 * 'ptbl' chunk to be already of the correct size and the file to be
1381 * writable, so usually this method is only called after a Save() call.
1382 *
1383 * @throws Exception - if 'ptbl' chunk is too small (should only occur
1384 * if there's a bug)
1385 */
1386 void File::__UpdateWavePoolTableChunk() {
1387 __UpdateWavePoolTable();
1388 RIFF::Chunk* ptbl = pRIFF->GetSubChunk(CHUNK_ID_PTBL);
1389 const int iOffsetSize = (b64BitWavePoolOffsets) ? 8 : 4;
1390 // check if 'ptbl' chunk is large enough
1391 WavePoolCount = (pSamples) ? pSamples->size() : 0;
1392 const unsigned long ulRequiredSize = WavePoolHeaderSize + iOffsetSize * WavePoolCount;
1393 if (ptbl->GetSize() < ulRequiredSize) throw Exception("Fatal error, 'ptbl' chunk too small");
1394 // save the 'ptbl' chunk's current read/write position
1395 unsigned long ulOriginalPos = ptbl->GetPos();
1396 // update headers
1397 ptbl->SetPos(0);
1398 ptbl->WriteUint32(&WavePoolHeaderSize);
1399 ptbl->WriteUint32(&WavePoolCount);
1400 // update offsets
1401 ptbl->SetPos(WavePoolHeaderSize);
1402 if (b64BitWavePoolOffsets) {
1403 for (int i = 0 ; i < WavePoolCount ; i++) {
1404 ptbl->WriteUint32(&pWavePoolTableHi[i]);
1405 ptbl->WriteUint32(&pWavePoolTable[i]);
1406 }
1407 } else { // conventional 32 bit offsets
1408 for (int i = 0 ; i < WavePoolCount ; i++)
1409 ptbl->WriteUint32(&pWavePoolTable[i]);
1410 }
1411 // restore 'ptbl' chunk's original read/write position
1412 ptbl->SetPos(ulOriginalPos);
1413 }
1414
1415 /**
1416 * Updates the wave pool table with offsets to all currently available
1417 * samples. <b>Caution:</b> this method assumes the 'wvpl' list chunk
1418 * exists already.
1419 */
1420 void File::__UpdateWavePoolTable() {
1421 WavePoolCount = (pSamples) ? pSamples->size() : 0;
1422 // resize wave pool table arrays
1423 if (pWavePoolTable) delete[] pWavePoolTable;
1424 if (pWavePoolTableHi) delete[] pWavePoolTableHi;
1425 pWavePoolTable = new uint32_t[WavePoolCount];
1426 pWavePoolTableHi = new uint32_t[WavePoolCount];
1427 if (!pSamples) return;
1428 // update offsets int wave pool table
1429 RIFF::List* wvpl = pRIFF->GetSubList(LIST_TYPE_WVPL);
1430 uint64_t wvplFileOffset = wvpl->GetFilePos();
1431 if (b64BitWavePoolOffsets) {
1432 SampleList::iterator iter = pSamples->begin();
1433 SampleList::iterator end = pSamples->end();
1434 for (int i = 0 ; iter != end ; ++iter, i++) {
1435 uint64_t _64BitOffset = (*iter)->pWaveList->GetFilePos() - wvplFileOffset - LIST_HEADER_SIZE;
1436 (*iter)->ulWavePoolOffset = _64BitOffset;
1437 pWavePoolTableHi[i] = (uint32_t) (_64BitOffset >> 32);
1438 pWavePoolTable[i] = (uint32_t) _64BitOffset;
1439 }
1440 } else { // conventional 32 bit offsets
1441 SampleList::iterator iter = pSamples->begin();
1442 SampleList::iterator end = pSamples->end();
1443 for (int i = 0 ; iter != end ; ++iter, i++) {
1444 uint64_t _64BitOffset = (*iter)->pWaveList->GetFilePos() - wvplFileOffset - LIST_HEADER_SIZE;
1445 (*iter)->ulWavePoolOffset = _64BitOffset;
1446 pWavePoolTable[i] = (uint32_t) _64BitOffset;
1447 }
1448 }
1449 }
1450
1451
1452
1453 // *************** Exception ***************
1454 // *
1455
1456 Exception::Exception(String Message) : RIFF::Exception(Message) {
1457 }
1458
1459 void Exception::PrintMessage() {
1460 std::cout << "DLS::Exception: " << Message << std::endl;
1461 }
1462
1463
1464 // *************** functions ***************
1465 // *
1466
1467 /**
1468 * Returns the name of this C++ library. This is usually "libgig" of
1469 * course. This call is equivalent to RIFF::libraryName() and
1470 * gig::libraryName().
1471 */
1472 String libraryName() {
1473 return PACKAGE;
1474 }
1475
1476 /**
1477 * Returns version of this C++ library. This call is equivalent to
1478 * RIFF::libraryVersion() and gig::libraryVersion().
1479 */
1480 String libraryVersion() {
1481 return VERSION;
1482 }
1483
1484 } // namespace DLS

  ViewVC Help
Powered by ViewVC