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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2394 - (hide annotations) (download)
Mon Jan 7 23:23:58 2013 UTC (11 years, 2 months ago) by schoenebeck
File size: 73441 byte(s)
* implemented gig::File::AddDuplicateInstrument()
* bumped version to 3.3.0.svn4

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

  ViewVC Help
Powered by ViewVC