libgig  3.3.0.svn4
DLS.h
Go to the documentation of this file.
1 /***************************************************************************
2  * *
3  * libgig - C++ cross-platform Gigasampler format file access library *
4  * *
5  * Copyright (C) 2003-2013 by Christian Schoenebeck *
6  * <cuse@users.sourceforge.net> *
7  * *
8  * This library is free software; you can redistribute it and/or modify *
9  * it under the terms of the GNU General Public License as published by *
10  * the Free Software Foundation; either version 2 of the License, or *
11  * (at your option) any later version. *
12  * *
13  * This library is distributed in the hope that it will be useful, *
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16  * GNU General Public License for more details. *
17  * *
18  * You should have received a copy of the GNU General Public License *
19  * along with this library; if not, write to the Free Software *
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
21  * MA 02111-1307 USA *
22  ***************************************************************************/
23 
24 #ifndef __DLS_H__
25 #define __DLS_H__
26 
27 #include "RIFF.h"
28 
29 #if WORDS_BIGENDIAN
30 # define RIFF_TYPE_DLS 0x444C5320
31 # define LIST_TYPE_WVPL 0x7776706C
32 # define LIST_TYPE_DWPL 0x6477706C
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 # define CHUNK_ID_ARTL 0x6172746C
62 # define CHUNK_ID_ART2 0x61727432
63 #else // little endian
64 # define RIFF_TYPE_DLS 0x20534C44
65 # define LIST_TYPE_WVPL 0x6C707677
66 # define LIST_TYPE_DWPL 0x6C707764
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 # define CHUNK_ID_IMED 0x44454D49
81 # 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 # define CHUNK_ID_ARTL 0x6C747261
96 # define CHUNK_ID_ART2 0x32747261
97 #endif // WORDS_BIGENDIAN
98 
99 #define DLS_WAVE_FORMAT_PCM 0x0001
100 
101 //TODO: no support for conditional chunks <cdl> yet
102 
104 namespace DLS {
105 
106  typedef std::string String;
107 
109  struct version_t {
110  uint16_t minor;
111  uint16_t major;
112  uint16_t build;
113  uint16_t release;
114  };
115 
117  struct dlsid_t {
118  uint32_t ulData1;
119  uint16_t usData2;
120  uint16_t usData3;
121  uint8_t abData[8];
122  };
123 
125  typedef enum {
126  // Modulator Sources
127  conn_src_none = 0x0000,
128  conn_src_lfo = 0x0001,
131  conn_src_eg1 = 0x0004,
132  conn_src_eg2 = 0x0005,
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 
151  typedef enum {
152  // Generic Destinations
153  conn_dst_none = 0x0000,
154  conn_dst_gain = 0x0001,
156  conn_dst_pitch = 0x0003,
157  conn_dst_pan = 0x0004,
159  // Channel Output Destinations
160  conn_dst_left = 0x0010,
161  conn_dst_right = 0x0011,
162  conn_dst_center = 0x0012,
166  conn_dst_chorus = 0x0080,
167  conn_dst_reverb = 0x0081,
168  // Modulator LFO Destinations
171  // Vibrato LFO Destinations
174  // EG Destinations
190  // Filter Destinations
193  } conn_dst_t;
194 
196  typedef enum {
197  conn_trn_none = 0x0000,
199  conn_trn_convex = 0x0002,
201  } conn_trn_t;
202 
204  struct range_t {
205  uint16_t low;
206  uint16_t high;
207  };
208 
210  struct sample_loop_t {
211  uint32_t Size;
212  uint32_t LoopType;
213  uint32_t LoopStart;
214  uint32_t LoopLength;
215  };
216 
217  // just symbol prototyping
218  class File;
219  class Instrument;
220  class Region;
221  class Sample;
222 
224  class Connection {
225  public:
236  uint32_t Scale;
237  protected:
238  struct conn_block_t {
239  uint16_t source;
240  uint16_t control;
241  uint16_t destination;
242  uint16_t transform;
243  uint32_t scale;
244  };
246  void Init(conn_block_t* Header);
247  conn_block_t ToConnBlock();
248  virtual ~Connection() {}
249  friend class Articulation;
250  };
251 
253  class Articulation {
254  public:
256  uint32_t Connections;
257 
258  Articulation(RIFF::Chunk* artl);
259  virtual ~Articulation();
260  virtual void UpdateChunks();
261  protected:
263  uint32_t HeaderSize;
264  };
265 
267  class Articulator {
268  public:
269  Articulator(RIFF::List* ParentList);
272  virtual void UpdateChunks();
273  virtual void CopyAssign(const Articulator* orig);
274  protected:
275  typedef std::list<Articulation*> ArticulationList;
278  ArticulationList::iterator ArticulationsIterator;
279 
280  void LoadArticulations();
281  virtual ~Articulator();
282  };
283 
285  class Info {
286  public:
305 
307  uint32_t chunkId;
308  int length;
309  };
310 
311  Info(RIFF::List* list);
312  void SetFixedStringLengths(const string_length_t* lengths);
313  virtual ~Info();
314  virtual void UpdateChunks();
315  virtual void CopyAssign(const Info* orig);
316  private:
317  RIFF::List* pResourceListChunk;
318  const string_length_t* pFixedStringLengths;
319 
320  static void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s);
321  void SaveString(uint32_t ChunkID, RIFF::List* lstINFO, const String& s, const String& sDefault);
322  };
323 
325  class Resource {
326  public:
329 
330  Resource* GetParent() { return pParent; }
331  virtual void UpdateChunks();
332  void GenerateDLSID();
333  virtual void CopyAssign(const Resource* orig);
334  protected:
337 
338  Resource(Resource* Parent, RIFF::List* lstResource);
339  virtual ~Resource();
340  };
341 
343  class Sampler {
344  public:
345  uint8_t UnityNote;
346  int16_t FineTune;
347  int32_t Gain;
350  uint32_t SampleLoops;
352 
353  void AddSampleLoop(sample_loop_t* pLoopDef);
354  void DeleteSampleLoop(sample_loop_t* pLoopDef);
355  virtual void SetGain(int32_t gain);
356  virtual void UpdateChunks();
357  virtual void CopyAssign(const Sampler* orig);
358  protected:
360  uint32_t uiHeaderSize;
361  uint32_t SamplerOptions;
362  Sampler(RIFF::List* ParentList);
363  virtual ~Sampler();
364  };
365 
374  class Sample : public Resource {
375  public:
376  uint16_t FormatTag;
377  uint16_t Channels;
378  uint32_t SamplesPerSecond;
380  uint16_t BlockAlign;
381  uint16_t BitDepth;
382  unsigned long SamplesTotal;
383  uint FrameSize;
384 
385  void* LoadSampleData();
386  void ReleaseSampleData();
387  unsigned long GetSize();
388  void Resize(int iNewSize);
389  unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
390  unsigned long Read(void* pBuffer, unsigned long SampleCount);
391  unsigned long Write(void* pBuffer, unsigned long SampleCount);
392  virtual void UpdateChunks();
393  protected:
397  unsigned long ulWavePoolOffset; // needed for comparison with the wave pool link table, thus the link to instruments
398 
399  Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);
400  virtual ~Sample();
401  friend class File;
402  friend class Region; // Region has to compare the wave pool offset to get its sample
403  };
404 
406  class Region : public Resource, public Articulator, public Sampler {
407  public:
410  uint16_t KeyGroup;
411  uint16_t Layer;
414  uint16_t PhaseGroup;
416  uint32_t Channel;
417 
418  Sample* GetSample();
419  void SetSample(Sample* pSample);
420  virtual void SetKeyRange(uint16_t Low, uint16_t High);
421  virtual void UpdateChunks();
422  virtual void CopyAssign(const Region* orig);
423  protected:
425  uint32_t WavePoolTableIndex; // index in the wave pool table to the sample wave this region is linked to
426  Sample* pSample; // every region refers to exactly one sample
429 
430  Region(Instrument* pInstrument, RIFF::List* rgnList);
431  virtual ~Region();
432  friend class Instrument;
433  };
434 
436  class Instrument : public Resource, public Articulator {
437  public:
438  bool IsDrum;
439  uint16_t MIDIBank;
440  uint8_t MIDIBankCoarse;
441  uint8_t MIDIBankFine;
442  uint32_t MIDIProgram;
443  uint32_t Regions;
444 
447  Region* AddRegion();
448  void DeleteRegion(Region* pRegion);
449  virtual void UpdateChunks();
450  virtual void CopyAssign(const Instrument* orig);
451  protected:
452  typedef std::list<Region*> RegionList;
453  struct midi_locale_t {
454  uint32_t bank;
455  uint32_t instrument;
456  };
457 
460  RegionList::iterator RegionsIterator;
461 
462  Instrument(File* pFile, RIFF::List* insList);
463  void CopyAssignCore(const Instrument* orig);
464  virtual void LoadRegions();
465  virtual ~Instrument();
466  friend class File;
467  friend class Region;
468  private:
469  void MoveRegion(Region* pSrc, Region* pDst);
470  };
471 
473  class File : public Resource {
474  public:
476  uint32_t Instruments;
477 
478  File();
482  Sample* GetNextSample();
483  Sample* AddSample();
484  void DeleteSample(Sample* pSample);
488  void DeleteInstrument(Instrument* pInstrument);
489  RIFF::File* GetExtensionFile(int index);
490  virtual void UpdateChunks();
491  virtual void Save(const String& Path);
492  virtual void Save();
493  virtual ~File();
494  protected:
495  typedef std::list<Sample*> SampleList;
496  typedef std::list<Instrument*> InstrumentList;
497 
499  std::list<RIFF::File*> ExtensionFiles;
501  SampleList::iterator SamplesIterator;
503  InstrumentList::iterator InstrumentsIterator;
505  uint32_t WavePoolCount;
506  uint32_t* pWavePoolTable;
507  uint32_t* pWavePoolTableHi;
509 
510  virtual void LoadSamples();
511  virtual void LoadInstruments();
513  friend class Region; // Region has to look in the wave pool table to get its sample
514  private:
515  void __UpdateWavePoolTableChunk();
516  void __UpdateWavePoolTable();
517  };
518 
526  class Exception : public RIFF::Exception {
527  public:
529  void PrintMessage();
530  };
531 
534 
535 } // namespace DLS
536 
537 #endif // __DLS_H__