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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2547 - (hide annotations) (download) (as text)
Tue May 13 11:17:24 2014 UTC (6 years, 6 months ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 27063 byte(s)
* Fix: don't alter region pointer in gig::DimensionRegion::CopyAssign()
  (caused crash with the new "combine instruments" feature in gigedit).
* Added new method gig::Region::GetDimensionDefinition(dimension_t type).
* Added some more sanity checks in gig::Region::AddDimension().
* Added inline helper methods overlaps() for struct DLS::range_t.
* Added more API doc comments.
* Bumped version (3.3.0.svn10).


1 schoenebeck 2 /***************************************************************************
2     * *
3 schoenebeck 933 * libgig - C++ cross-platform Gigasampler format file access library *
4 schoenebeck 2 * *
5 schoenebeck 2543 * Copyright (C) 2003-2014 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     #ifndef __DLS_H__
25     #define __DLS_H__
26    
27     #include "RIFF.h"
28    
29 schoenebeck 11 #if WORDS_BIGENDIAN
30 schoenebeck 802 # define RIFF_TYPE_DLS 0x444C5320
31 schoenebeck 2 # define LIST_TYPE_WVPL 0x7776706C
32     # define LIST_TYPE_DWPL 0x6477706C ///< Seen on some files instead of a wvpl list chunk.
33     # define LIST_TYPE_WAVE 0x77617665
34     # define LIST_TYPE_LINS 0X6C696E73
35     # define LIST_TYPE_INS 0X696E7320
36     # define LIST_TYPE_LRGN 0x6C72676E
37     # define LIST_TYPE_LART 0x6C617274
38     # define LIST_TYPE_LAR2 0x6C617232
39     # define LIST_TYPE_RGN 0x72676E20
40     # define LIST_TYPE_RGN2 0x72676E32
41     # define CHUNK_ID_IARL 0x4941524C
42     # define CHUNK_ID_IART 0x49415254
43     # define CHUNK_ID_ICMS 0x49434D53
44     # define CHUNK_ID_IGNR 0x49474E52
45     # define CHUNK_ID_IKEY 0x494B4559
46     # define CHUNK_ID_IMED 0x494D4544
47     # define CHUNK_ID_ISBJ 0x4953424A
48     # define CHUNK_ID_ISRC 0x49535243
49     # define CHUNK_ID_ISRF 0x49535246
50     # define CHUNK_ID_ITCH 0x49544348
51     # define CHUNK_ID_VERS 0x76657273
52     # define CHUNK_ID_DLID 0x646C6964
53     # define CHUNK_ID_FMT 0x666D7420
54     # define CHUNK_ID_DATA 0x64617461
55     # define CHUNK_ID_INSH 0x696E7368
56     # define CHUNK_ID_RGNH 0x72676E68
57     # define CHUNK_ID_WLNK 0x776C6E6B
58     # define CHUNK_ID_PTBL 0x7074626C
59     # define CHUNK_ID_WSMP 0x77736D70
60     # define CHUNK_ID_COLH 0x636F6C68
61 schoenebeck 800 # define CHUNK_ID_ARTL 0x6172746C
62     # define CHUNK_ID_ART2 0x61727432
63 schoenebeck 2 #else // little endian
64 schoenebeck 802 # define RIFF_TYPE_DLS 0x20534C44
65 schoenebeck 2 # define LIST_TYPE_WVPL 0x6C707677
66     # define LIST_TYPE_DWPL 0x6C707764 ///< Seen on some files instead of a wvpl list chunk.
67     # define LIST_TYPE_WAVE 0x65766177
68     # define LIST_TYPE_LINS 0X736E696C
69     # define LIST_TYPE_INS 0X20736E69
70     # define LIST_TYPE_LRGN 0x6E67726C
71     # define LIST_TYPE_LART 0x7472616C
72     # define LIST_TYPE_LAR2 0x3272616C
73     # define LIST_TYPE_RGN 0x206E6772
74     # define LIST_TYPE_RGN2 0x326E6772
75     # define CHUNK_ID_IARL 0x4C524149
76     # define CHUNK_ID_IART 0x54524149
77     # define CHUNK_ID_ICMS 0x534D4349
78     # define CHUNK_ID_IGNR 0x524E4749
79     # define CHUNK_ID_IKEY 0x59454B49
80 persson 928 # define CHUNK_ID_IMED 0x44454D49
81 schoenebeck 2 # define CHUNK_ID_ISBJ 0x4A425349
82     # define CHUNK_ID_ISRC 0x43525349
83     # define CHUNK_ID_ISRF 0x46525349
84     # define CHUNK_ID_ITCH 0x48435449
85     # define CHUNK_ID_VERS 0x73726576
86     # define CHUNK_ID_DLID 0x64696C64
87     # define CHUNK_ID_FMT 0x20746D66
88     # define CHUNK_ID_DATA 0x61746164
89     # define CHUNK_ID_INSH 0x68736E69
90     # define CHUNK_ID_RGNH 0x686E6772
91     # define CHUNK_ID_WLNK 0x6B6E6C77
92     # define CHUNK_ID_PTBL 0x6C627470
93     # define CHUNK_ID_WSMP 0x706D7377
94     # define CHUNK_ID_COLH 0x686C6F63
95 schoenebeck 800 # define CHUNK_ID_ARTL 0x6C747261
96     # define CHUNK_ID_ART2 0x32747261
97 schoenebeck 2 #endif // WORDS_BIGENDIAN
98    
99 schoenebeck 1050 #define DLS_WAVE_FORMAT_PCM 0x0001
100 schoenebeck 2
101     //TODO: no support for conditional chunks <cdl> yet
102    
103     /** DLS specific classes and definitions */
104     namespace DLS {
105    
106     typedef std::string String;
107    
108     /** Quadtuple version number ("major.minor.release.build"). */
109     struct version_t {
110     uint16_t minor;
111     uint16_t major;
112     uint16_t build;
113     uint16_t release;
114     };
115    
116     /** Every subject of an DLS file and the file itself can have an unique, computer generated ID. */
117     struct dlsid_t {
118     uint32_t ulData1;
119     uint16_t usData2;
120     uint16_t usData3;
121     uint8_t abData[8];
122     };
123    
124     /** Connection Sources */
125     typedef enum {
126     // Modulator Sources
127     conn_src_none = 0x0000,
128     conn_src_lfo = 0x0001,
129     conn_src_keyonvelocity = 0x0002,
130     conn_src_keynumber = 0x0003,
131     conn_src_eg1 = 0x0004,
132     conn_src_eg2 = 0x0005,
133     conn_src_pitchwheel = 0x0006,
134     conn_src_polypressure = 0x0007,
135     conn_src_channelpressure = 0x0008,
136     conn_src_vibrato = 0x0009,
137     // MIDI Controller Sources
138     conn_src_cc1 = 0x0081,
139     conn_src_cc7 = 0x0087,
140     conn_src_cc10 = 0x008A,
141     conn_src_cc11 = 0x008B,
142     conn_src_cc91 = 0x00DB,
143     conn_src_cc93 = 0x00DD,
144     // Registered Parameter Numbers
145     conn_src_rpn0 = 0x0100,
146     conn_src_rpn1 = 0x0101,
147     conn_src_rpn2 = 0x0102
148     } conn_src_t;
149    
150     /** Connection Destinations */
151     typedef enum {
152     // Generic Destinations
153     conn_dst_none = 0x0000,
154     conn_dst_gain = 0x0001,
155     conn_dst_reserved = 0x0002,
156     conn_dst_pitch = 0x0003,
157     conn_dst_pan = 0x0004,
158     conn_dst_keynumber = 0x0005,
159     // Channel Output Destinations
160     conn_dst_left = 0x0010,
161     conn_dst_right = 0x0011,
162     conn_dst_center = 0x0012,
163     conn_dst_lfe_channel = 0x0013,
164     conn_dst_leftrear = 0x0014,
165     conn_dst_rightrear = 0x0015,
166     conn_dst_chorus = 0x0080,
167     conn_dst_reverb = 0x0081,
168     // Modulator LFO Destinations
169     conn_dst_lfo_frequency = 0x0104,
170     conn_dst_lfo_startdelay = 0x0105,
171     // Vibrato LFO Destinations
172     conn_dst_vib_frequency = 0x0114,
173     conn_dst_vib_startdelay = 0x0115,
174     // EG Destinations
175     conn_dst_eg1_attacktime = 0x0206,
176     conn_dst_eg1_decaytime = 0x0207,
177     conn_dst_eg1_reserved = 0x0208,
178     conn_dst_eg1_releasetime = 0x0209,
179     conn_dst_eg1_sustainlevel = 0x020A,
180     conn_dst_eg1_delaytime = 0x020B,
181     conn_dst_eg1_holdtime = 0x020C,
182     conn_dst_eg1_shutdowntime = 0x020D,
183     conn_dst_eg2_attacktime = 0x030A,
184     conn_dst_eg2_decaytime = 0x030B,
185     conn_dst_eg2_reserved = 0x030C,
186     conn_dst_eg2_releasetime = 0x030D,
187     conn_dst_eg2_sustainlevel = 0x030E,
188     conn_dst_eg2_delaytime = 0x030F,
189     conn_dst_eg2_holdtime = 0x0310,
190     // Filter Destinations
191     conn_dst_filter_cutoff = 0x0500,
192     conn_dst_filter_q = 0x0501
193     } conn_dst_t;
194    
195     /** Connection Transforms */
196     typedef enum {
197     conn_trn_none = 0x0000,
198     conn_trn_concave = 0x0001,
199     conn_trn_convex = 0x0002,
200     conn_trn_switch = 0x0003
201     } conn_trn_t;
202    
203     /** Lower and upper limit of a range. */
204     struct range_t {
205     uint16_t low; ///< Low value of range.
206     uint16_t high; ///< High value of range.
207 schoenebeck 2543
208     inline bool operator< (const range_t& other) const {
209     if (low < other.low) return true;
210     if (low > other.low) return false;
211     return high < other.high;
212     }
213    
214     inline bool operator== (const range_t& other) const {
215     return low == other.low && high == other.high;
216     }
217 schoenebeck 2547
218     inline bool overlaps(uint16_t scalar) const {
219     return low <= scalar && scalar <= high;
220     }
221    
222     inline bool overlaps(const range_t& other) const {
223     return overlaps(other.low) || overlaps(other.high) ||
224     other.overlaps(low) || other.overlaps(high);
225     }
226 schoenebeck 2 };
227    
228     /** Defines Sample Loop Points. */
229     struct sample_loop_t {
230 schoenebeck 1154 uint32_t Size; ///< For internal usage only: usually reflects exactly @c sizeof(sample_loop_t), otherwise if the value is larger then the DLS format was extended!
231     uint32_t LoopType; ///< Defines how the waveform samples will be looped (appropriate loop types for the gig format are defined by gig::loop_type_t).
232     uint32_t LoopStart; ///< The start value specifies the offset (in sample points) in the waveform data of the first sample point to be played in the loop.
233     uint32_t LoopLength; ///< Length of the looping area (in sample points).
234 schoenebeck 2 };
235    
236     // just symbol prototyping
237     class File;
238     class Instrument;
239     class Region;
240     class Sample;
241    
242     /** Defines a connection within the synthesis model. */
243     class Connection {
244     public:
245     conn_src_t Source;
246     conn_trn_t SourceTransform;
247     bool SourceInvert;
248     bool SourceBipolar;
249     conn_src_t Control;
250     conn_trn_t ControlTransform;
251     bool ControlInvert;
252     bool ControlBipolar;
253     conn_dst_t Destination;
254     conn_trn_t DestinationTransform;
255     uint32_t Scale;
256     protected:
257     struct conn_block_t {
258     uint16_t source;
259     uint16_t control;
260     uint16_t destination;
261     uint16_t transform;
262     uint32_t scale;
263     };
264 persson 1713 Connection() {}
265 schoenebeck 2 void Init(conn_block_t* Header);
266 schoenebeck 800 conn_block_t ToConnBlock();
267 persson 1713 virtual ~Connection() {}
268 schoenebeck 2 friend class Articulation;
269     };
270    
271     /** Provides access to the defined connections used for the synthesis model. */
272     class Articulation {
273     public:
274     Connection* pConnections; ///< Points to the beginning of a <i>Connection</i> array.
275     uint32_t Connections; ///< Reflects the number of Connections.
276 schoenebeck 800
277     Articulation(RIFF::Chunk* artl);
278 schoenebeck 384 virtual ~Articulation();
279 schoenebeck 800 virtual void UpdateChunks();
280     protected:
281     RIFF::Chunk* pArticulationCk;
282     uint32_t HeaderSize;
283 schoenebeck 2 };
284    
285     /** Abstract base class for classes that provide articulation information (thus for <i>Instrument</i> and <i>Region</i> class). */
286     class Articulator {
287     public:
288     Articulator(RIFF::List* ParentList);
289     Articulation* GetFirstArticulation();
290     Articulation* GetNextArticulation();
291 schoenebeck 800 virtual void UpdateChunks();
292 schoenebeck 2394 virtual void CopyAssign(const Articulator* orig);
293 schoenebeck 2 protected:
294     typedef std::list<Articulation*> ArticulationList;
295     RIFF::List* pParentList;
296     ArticulationList* pArticulations;
297     ArticulationList::iterator ArticulationsIterator;
298    
299     void LoadArticulations();
300 schoenebeck 384 virtual ~Articulator();
301 schoenebeck 2 };
302    
303     /** Optional information for DLS files, instruments, samples, etc. */
304     class Info {
305     public:
306     String Name; ///< <INAM-ck>. Stores the title of the subject of the file, such as, Seattle From Above.
307     String ArchivalLocation; ///< <IARL-ck>. Indicates where the subject of the file is stored.
308     String CreationDate; ///< <ICRD-ck>. Specifies the date the subject of the file was created. List dates in yyyy-mm-dd format.
309     String Comments; ///< <ICMT-ck>. Provides general comments about the file or the subject of the file. Sentences might end with semicolon.
310     String Product; ///< <IPRD-ck>. Specifies the name of the title the file was originally intended for, such as World Ruler V.
311     String Copyright; ///< <ICOP-ck>. Records the copyright information for the file.
312     String Artists; ///< <IART-ck>. Lists the artist of the original subject of the file.
313     String Genre; ///< <IGNR-ck>. Descirbes the original work, such as, Jazz, Classic, Rock, Techno, Rave, etc.
314     String Keywords; ///< <IKEY-ck>. Provides a list of keywords that refer to the file or subject of the file. Keywords are separated with semicolon and blank, e.g., FX; death; murder.
315     String Engineer; ///< <IENG-ck>. Stores the name of the engineer who worked on the file. Multiple engineer names are separated by semicolon and blank, e.g, Smith, John; Adams, Joe.
316     String Technician; ///< <ITCH-ck>. Identifies the technician who sampled the subject file.
317     String Software; ///< <ISFT-ck>. Identifies the name of the sofware package used to create the file.
318     String Medium; ///< <IMED-ck>. Describes the original subject of the file, such as, record, CD, and so forth.
319     String Source; ///< <ISRC-ck>. Identifies the name of the person or organization who supplied the original subject of the file.
320     String SourceForm; ///< <ISRF-ck>. Identifies the original form of the material that was digitized, such as record, sampling CD, TV sound track. This is not neccessarily the same as <i>Medium</i>.
321     String Commissioned; ///< <ICMS-ck>. Lists the name of the person or organization that commissioned the subject of the file, e.g., Pope Julian II.
322 persson 928 String Subject; ///< <ISBJ-ck>. Describes the contents of the file.
323 schoenebeck 1416 bool UseFixedLengthStrings; ///< @deprecated Not used anymore, use SetFixedStringLengths() instead.
324 schoenebeck 2
325 schoenebeck 1416 struct string_length_t {
326 persson 1180 uint32_t chunkId;
327 schoenebeck 1416 int length;
328 persson 1180 };
329 schoenebeck 1416
330 schoenebeck 2 Info(RIFF::List* list);
331 schoenebeck 1416 void SetFixedStringLengths(const string_length_t* lengths);
332 schoenebeck 823 virtual ~Info();
333 schoenebeck 800 virtual void UpdateChunks();
334 schoenebeck 2394 virtual void CopyAssign(const Info* orig);
335 schoenebeck 2 private:
336 schoenebeck 1416 RIFF::List* pResourceListChunk;
337     const string_length_t* pFixedStringLengths; ///< List of IDs and string lengths for strings that should be stored in a fixed length format. This is used for gig files, not for ordinary DLS files.
338 schoenebeck 800
339 schoenebeck 929 static void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s);
340 persson 1180 void SaveString(uint32_t ChunkID, RIFF::List* lstINFO, const String& s, const String& sDefault);
341 schoenebeck 2 };
342    
343     /** Abstract base class which encapsulates data structures which all DLS resources are able to provide. */
344     class Resource {
345     public:
346 schoenebeck 800 Info* pInfo; ///< Points (in any case) to an <i>Info</i> object, providing additional, optional infos and comments.
347     dlsid_t* pDLSID; ///< Points to a <i>dlsid_t</i> structure if the file provided a DLS ID else is <i>NULL</i>.
348 schoenebeck 2
349 persson 1713 Resource* GetParent() { return pParent; }
350 schoenebeck 2482 const Resource* GetParent() const { return pParent; }
351 schoenebeck 800 virtual void UpdateChunks();
352 persson 1209 void GenerateDLSID();
353 schoenebeck 2394 virtual void CopyAssign(const Resource* orig);
354 schoenebeck 2 protected:
355     Resource* pParent;
356 schoenebeck 800 RIFF::List* pResourceList;
357 schoenebeck 2
358     Resource(Resource* Parent, RIFF::List* lstResource);
359 schoenebeck 384 virtual ~Resource();
360 schoenebeck 2 };
361    
362     /** Abstract base class which provides mandatory informations about sample players in general. */
363     class Sampler {
364     public:
365     uint8_t UnityNote;
366     int16_t FineTune;
367 schoenebeck 1358 int32_t Gain; ///< @deprecated Don't alter directly, use SetGain() instead!
368 schoenebeck 2 bool NoSampleDepthTruncation;
369     bool NoSampleCompression;
370 schoenebeck 800 uint32_t SampleLoops; ///< Reflects the number of sample loops.
371     sample_loop_t* pSampleLoops; ///< Points to the beginning of a sample loop array, or is NULL if there are no loops defined.
372    
373 schoenebeck 1154 void AddSampleLoop(sample_loop_t* pLoopDef);
374     void DeleteSampleLoop(sample_loop_t* pLoopDef);
375 schoenebeck 1358 virtual void SetGain(int32_t gain);
376 schoenebeck 800 virtual void UpdateChunks();
377 schoenebeck 2394 virtual void CopyAssign(const Sampler* orig);
378 schoenebeck 2 protected:
379 schoenebeck 800 RIFF::List* pParentList;
380     uint32_t uiHeaderSize;
381 schoenebeck 2 uint32_t SamplerOptions;
382     Sampler(RIFF::List* ParentList);
383 schoenebeck 384 virtual ~Sampler();
384 schoenebeck 2 };
385    
386 schoenebeck 800 /** @brief Encapsulates sample waves used for playback.
387     *
388     * In case you created a new sample with File::AddSample(), you should
389 schoenebeck 806 * first update all attributes with the desired meta informations
390     * (amount of channels, bit depth, sample rate, etc.), then call
391     * Resize() with the desired sample size. The latter will create
392 schoenebeck 800 * the mandatory RIFF chunk which will hold the sample wave data.
393     */
394 schoenebeck 2 class Sample : public Resource {
395     public:
396 schoenebeck 1050 uint16_t FormatTag; ///< Format ID of the waveform data (should be DLS_WAVE_FORMAT_PCM for DLS1 compliant files, this is also the default value if Sample was created with Instrument::AddSample()).
397 schoenebeck 806 uint16_t Channels; ///< Number of channels represented in the waveform data, e.g. 1 for mono, 2 for stereo (defaults to 1=mono if Sample was created with Instrument::AddSample() previously).
398     uint32_t SamplesPerSecond; ///< Sampling rate at which each channel should be played (defaults to 44100 if Sample was created with Instrument::AddSample() previously).
399 schoenebeck 2 uint32_t AverageBytesPerSecond; ///< The average number of bytes per second at which the waveform data should be transferred (Playback software can estimate the buffer size using this value).
400     uint16_t BlockAlign; ///< The block alignment (in bytes) of the waveform data. Playback software needs to process a multiple of <i>BlockAlign</i> bytes of data at a time, so the value of <i>BlockAlign</i> can be used for buffer alignment.
401     uint16_t BitDepth; ///< Size of each sample per channel (only if known sample data format is used, 0 otherwise).
402 schoenebeck 800 unsigned long SamplesTotal; ///< Reflects total number of sample points (only if known sample data format is used, 0 otherwise), do not bother to change this value, it will not be saved.
403 schoenebeck 806 uint FrameSize; ///< Reflects the size (in bytes) of one single sample point (only if known sample data format is used, 0 otherwise). <b>Caution:</b> with the current version of libgig you have to upate this field by yourself whenever you change one of the following fields: Channels, BitDepth ! Ignoring this might lead to undesired behavior when i.e. calling Resize(), SetPos(), Write() or Read().
404 schoenebeck 2
405 schoenebeck 800 void* LoadSampleData();
406     void ReleaseSampleData();
407 schoenebeck 2482 unsigned long GetSize() const;
408 schoenebeck 800 void Resize(int iNewSize);
409 schoenebeck 2 unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
410     unsigned long Read(void* pBuffer, unsigned long SampleCount);
411 schoenebeck 800 unsigned long Write(void* pBuffer, unsigned long SampleCount);
412     virtual void UpdateChunks();
413 schoenebeck 2482 virtual void CopyAssign(const Sample* orig);
414 schoenebeck 2 protected:
415 schoenebeck 800 RIFF::List* pWaveList;
416 schoenebeck 2 RIFF::Chunk* pCkData;
417     RIFF::Chunk* pCkFormat;
418     unsigned long ulWavePoolOffset; // needed for comparison with the wave pool link table, thus the link to instruments
419    
420     Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);
421 schoenebeck 800 virtual ~Sample();
422 schoenebeck 2482 void CopyAssignCore(const Sample* orig);
423 schoenebeck 2 friend class File;
424     friend class Region; // Region has to compare the wave pool offset to get its sample
425     };
426    
427     /** Defines <i>Region</i> information of an <i>Instrument</i>. */
428     class Region : public Resource, public Articulator, public Sampler {
429     public:
430 schoenebeck 1335 range_t KeyRange; ///< @deprecated Only read, don't write! Use SetKeyRange() instead.
431 schoenebeck 2 range_t VelocityRange;
432     uint16_t KeyGroup;
433     uint16_t Layer;
434     bool SelfNonExclusive;
435     bool PhaseMaster;
436     uint16_t PhaseGroup;
437     bool MultiChannel;
438     uint32_t Channel;
439    
440     Sample* GetSample();
441 schoenebeck 800 void SetSample(Sample* pSample);
442 schoenebeck 1335 virtual void SetKeyRange(uint16_t Low, uint16_t High);
443 schoenebeck 800 virtual void UpdateChunks();
444 schoenebeck 2394 virtual void CopyAssign(const Region* orig);
445 schoenebeck 2 protected:
446     RIFF::List* pCkRegion;
447     uint32_t WavePoolTableIndex; // index in the wave pool table to the sample wave this region is linked to
448     Sample* pSample; // every region refers to exactly one sample
449 schoenebeck 800 uint16_t FormatOptionFlags;
450     uint16_t WaveLinkOptionFlags;
451 schoenebeck 2
452     Region(Instrument* pInstrument, RIFF::List* rgnList);
453 schoenebeck 384 virtual ~Region();
454 schoenebeck 2 friend class Instrument;
455     };
456    
457     /** Provides all neccessary information for the synthesis of a DLS <i>Instrument</i>. */
458     class Instrument : public Resource, public Articulator {
459     public:
460     bool IsDrum; ///< Indicates if the <i>Instrument</i> is a drum type, as they differ in the synthesis model of DLS from melodic instruments.
461 schoenebeck 800 uint16_t MIDIBank; ///< Reflects combination of <i>MIDIBankCoarse</i> and <i>MIDIBankFine</i> (bank 1 - bank 16384). Do not change this value, it will not be saved! Change MIDIBankCoarse and MIDIBankFine instead (we might change that in future).
462 schoenebeck 2 uint8_t MIDIBankCoarse; ///< Reflects the MIDI Bank number for MIDI Control Change 0 (bank 1 - 128).
463     uint8_t MIDIBankFine; ///< Reflects the MIDI Bank number for MIDI Control Change 32 (bank 1 - 128).
464     uint32_t MIDIProgram; ///< Specifies the MIDI Program Change Number this Instrument should be assigned to.
465     uint32_t Regions; ///< Reflects the number of <i>Region</i> defintions this Instrument has.
466    
467     Region* GetFirstRegion();
468     Region* GetNextRegion();
469 schoenebeck 800 Region* AddRegion();
470     void DeleteRegion(Region* pRegion);
471     virtual void UpdateChunks();
472 schoenebeck 2394 virtual void CopyAssign(const Instrument* orig);
473 schoenebeck 2 protected:
474     typedef std::list<Region*> RegionList;
475     struct midi_locale_t {
476     uint32_t bank;
477     uint32_t instrument;
478     };
479    
480     RIFF::List* pCkInstrument;
481     RegionList* pRegions;
482     RegionList::iterator RegionsIterator;
483    
484     Instrument(File* pFile, RIFF::List* insList);
485 schoenebeck 2394 void CopyAssignCore(const Instrument* orig);
486 schoenebeck 823 virtual void LoadRegions();
487 schoenebeck 384 virtual ~Instrument();
488 schoenebeck 2 friend class File;
489 schoenebeck 1335 friend class Region;
490     private:
491     void MoveRegion(Region* pSrc, Region* pDst);
492 schoenebeck 2 };
493    
494     /** Parses DLS Level 1 and 2 compliant files and provides abstract access to the data. */
495     class File : public Resource {
496     public:
497     version_t* pVersion; ///< Points to a <i>version_t</i> structure if the file provided a version number else is set to <i>NULL</i>.
498     uint32_t Instruments; ///< Reflects the number of available <i>Instrument</i> objects.
499    
500 schoenebeck 800 File();
501 schoenebeck 2 File(RIFF::File* pRIFF);
502 schoenebeck 2274 String GetFileName();
503 schoenebeck 2482 void SetFileName(const String& name);
504 schoenebeck 2 Sample* GetFirstSample(); ///< Returns a pointer to the first <i>Sample</i> object of the file, <i>NULL</i> otherwise.
505     Sample* GetNextSample(); ///< Returns a pointer to the next <i>Sample</i> object of the file, <i>NULL</i> otherwise.
506 schoenebeck 800 Sample* AddSample();
507     void DeleteSample(Sample* pSample);
508 schoenebeck 2 Instrument* GetFirstInstrument(); ///< Returns a pointer to the first <i>Instrument</i> object of the file, <i>NULL</i> otherwise.
509     Instrument* GetNextInstrument(); ///< Returns a pointer to the next <i>Instrument</i> object of the file, <i>NULL</i> otherwise.
510 schoenebeck 800 Instrument* AddInstrument();
511     void DeleteInstrument(Instrument* pInstrument);
512 schoenebeck 2329 RIFF::File* GetExtensionFile(int index);
513 schoenebeck 800 virtual void UpdateChunks();
514     virtual void Save(const String& Path);
515     virtual void Save();
516 schoenebeck 384 virtual ~File();
517 schoenebeck 2 protected:
518     typedef std::list<Sample*> SampleList;
519     typedef std::list<Instrument*> InstrumentList;
520    
521     RIFF::File* pRIFF;
522 persson 834 std::list<RIFF::File*> ExtensionFiles;
523 schoenebeck 2 SampleList* pSamples;
524     SampleList::iterator SamplesIterator;
525     InstrumentList* pInstruments;
526     InstrumentList::iterator InstrumentsIterator;
527 schoenebeck 800 uint32_t WavePoolHeaderSize;
528 schoenebeck 2 uint32_t WavePoolCount;
529     uint32_t* pWavePoolTable;
530 persson 666 uint32_t* pWavePoolTableHi;
531 schoenebeck 800 bool b64BitWavePoolOffsets;
532 schoenebeck 2
533 schoenebeck 823 virtual void LoadSamples();
534     virtual void LoadInstruments();
535 schoenebeck 800 void __ensureMandatoryChunksExist();
536 schoenebeck 2 friend class Region; // Region has to look in the wave pool table to get its sample
537 schoenebeck 800 private:
538     void __UpdateWavePoolTableChunk();
539     void __UpdateWavePoolTable();
540 schoenebeck 2 };
541    
542 schoenebeck 1093 /**
543     * Will be thrown whenever a DLS specific error occurs while trying to
544     * access a DLS File. Note: In your application you should better catch
545     * for RIFF::Exception rather than this one, except you explicitly want
546     * to catch and handle DLS::Exception and RIFF::Exception independently,
547     * which usually shouldn't be necessary though.
548     */
549 schoenebeck 2 class Exception : public RIFF::Exception {
550     public:
551     Exception(String Message);
552     void PrintMessage();
553     };
554    
555 schoenebeck 518 String libraryName();
556     String libraryVersion();
557    
558 schoenebeck 2 } // namespace DLS
559    
560     #endif // __DLS_H__

  ViewVC Help
Powered by ViewVC