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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 2 by schoenebeck, Sat Oct 25 20:15:04 2003 UTC revision 2394 by schoenebeck, Mon Jan 7 23:23:58 2013 UTC
# Line 1  Line 1 
1  /***************************************************************************  /***************************************************************************
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file loader library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003 by Christian Schoenebeck                           *   *   Copyright (C) 2003-2013 by Christian Schoenebeck                      *
6   *                         <cuse@users.sourceforge.net>                    *   *                              <cuse@users.sourceforge.net>               *
7   *                                                                         *   *                                                                         *
8   *   This library is free software; you can redistribute it and/or modify  *   *   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  *   *   it under the terms of the GNU General Public License as published by  *
# Line 26  Line 26 
26    
27  #include "RIFF.h"  #include "RIFF.h"
28    
29  #if 0 // WORDS_BIGENDIAN  #if WORDS_BIGENDIAN
30  # define LIST_TYPE_INFO 0x494E464F  # define RIFF_TYPE_DLS  0x444C5320
31  # define LIST_TYPE_WVPL 0x7776706C  # define LIST_TYPE_WVPL 0x7776706C
32  # define LIST_TYPE_DWPL 0x6477706C  ///< Seen on some files instead of a wvpl list chunk.  # define LIST_TYPE_DWPL 0x6477706C  ///< Seen on some files instead of a wvpl list chunk.
33  # define LIST_TYPE_WAVE 0x77617665  # define LIST_TYPE_WAVE 0x77617665
# Line 38  Line 38 
38  # define LIST_TYPE_LAR2 0x6C617232  # define LIST_TYPE_LAR2 0x6C617232
39  # define LIST_TYPE_RGN  0x72676E20  # define LIST_TYPE_RGN  0x72676E20
40  # define LIST_TYPE_RGN2 0x72676E32  # define LIST_TYPE_RGN2 0x72676E32
 # define LIST_TYPE_ART1 0x61727431  
 # define LIST_TYPE_ART2 0x61727432  
41  # define CHUNK_ID_IARL  0x4941524C  # define CHUNK_ID_IARL  0x4941524C
42  # define CHUNK_ID_IART  0x49415254  # define CHUNK_ID_IART  0x49415254
43  # define CHUNK_ID_ICMS  0x49434D53  # define CHUNK_ID_ICMS  0x49434D53
 # define CHUNK_ID_ICMT  0x49434D54  
 # define CHUNK_ID_ICOP  0x49434F50  
 # define CHUNK_ID_ICRD  0x49435244  
 # define CHUNK_ID_IENG  0x49454E47  
44  # define CHUNK_ID_IGNR  0x49474E52  # define CHUNK_ID_IGNR  0x49474E52
45  # define CHUNK_ID_IKEY  0x494B4559  # define CHUNK_ID_IKEY  0x494B4559
46  # define CHUNK_ID_IMED  0x494D4544  # define CHUNK_ID_IMED  0x494D4544
 # define CHUNK_ID_INAM  0x494E414D  
 # define CHUNK_ID_IPRD  0x49505244  
47  # define CHUNK_ID_ISBJ  0x4953424A  # define CHUNK_ID_ISBJ  0x4953424A
 # define CHUNK_ID_ISFT  0x49534654  
48  # define CHUNK_ID_ISRC  0x49535243  # define CHUNK_ID_ISRC  0x49535243
49  # define CHUNK_ID_ISRF  0x49535246  # define CHUNK_ID_ISRF  0x49535246
50  # define CHUNK_ID_ITCH  0x49544348  # define CHUNK_ID_ITCH  0x49544348
# Line 67  Line 58 
58  # define CHUNK_ID_PTBL  0x7074626C  # define CHUNK_ID_PTBL  0x7074626C
59  # define CHUNK_ID_WSMP  0x77736D70  # define CHUNK_ID_WSMP  0x77736D70
60  # define CHUNK_ID_COLH  0x636F6C68  # define CHUNK_ID_COLH  0x636F6C68
61    # define CHUNK_ID_ARTL  0x6172746C
62    # define CHUNK_ID_ART2  0x61727432
63  #else  // little endian  #else  // little endian
64  # define LIST_TYPE_INFO 0x4F464E49  # define RIFF_TYPE_DLS  0x20534C44
65  # define LIST_TYPE_WVPL 0x6C707677  # define LIST_TYPE_WVPL 0x6C707677
66  # define LIST_TYPE_DWPL 0x6C707764  ///< Seen on some files instead of a wvpl list chunk.  # define LIST_TYPE_DWPL 0x6C707764  ///< Seen on some files instead of a wvpl list chunk.
67  # define LIST_TYPE_WAVE 0x65766177  # define LIST_TYPE_WAVE 0x65766177
# Line 79  Line 72 
72  # define LIST_TYPE_LAR2 0x3272616C  # define LIST_TYPE_LAR2 0x3272616C
73  # define LIST_TYPE_RGN  0x206E6772  # define LIST_TYPE_RGN  0x206E6772
74  # define LIST_TYPE_RGN2 0x326E6772  # define LIST_TYPE_RGN2 0x326E6772
 # define LIST_TYPE_ART1 0x31747261  
 # define LIST_TYPE_ART2 0x32747261  
75  # define CHUNK_ID_IARL  0x4C524149  # define CHUNK_ID_IARL  0x4C524149
76  # define CHUNK_ID_IART  0x54524149  # define CHUNK_ID_IART  0x54524149
77  # define CHUNK_ID_ICMS  0x534D4349  # define CHUNK_ID_ICMS  0x534D4349
 # define CHUNK_ID_ICMT  0x544D4349  
 # define CHUNK_ID_ICOP  0x504F4349  
 # define CHUNK_ID_ICRD  0x44524349  
 # define CHUNK_ID_IENG  0x474E4549  
78  # define CHUNK_ID_IGNR  0x524E4749  # define CHUNK_ID_IGNR  0x524E4749
79  # define CHUNK_ID_IKEY  0x59454B49  # define CHUNK_ID_IKEY  0x59454B49
80  # define CHUNK_ID_IMED  0x44525049  # define CHUNK_ID_IMED  0x44454D49
 # define CHUNK_ID_INAM  0x4D414E49  
 # define CHUNK_ID_IPRD  0x44525049  
81  # define CHUNK_ID_ISBJ  0x4A425349  # define CHUNK_ID_ISBJ  0x4A425349
 # define CHUNK_ID_ISFT  0x54465349  
82  # define CHUNK_ID_ISRC  0x43525349  # define CHUNK_ID_ISRC  0x43525349
83  # define CHUNK_ID_ISRF  0x46525349  # define CHUNK_ID_ISRF  0x46525349
84  # define CHUNK_ID_ITCH  0x48435449  # define CHUNK_ID_ITCH  0x48435449
# Line 108  Line 92 
92  # define CHUNK_ID_PTBL  0x6C627470  # define CHUNK_ID_PTBL  0x6C627470
93  # define CHUNK_ID_WSMP  0x706D7377  # define CHUNK_ID_WSMP  0x706D7377
94  # define CHUNK_ID_COLH  0x686C6F63  # define CHUNK_ID_COLH  0x686C6F63
95    # define CHUNK_ID_ARTL  0x6C747261
96    # define CHUNK_ID_ART2  0x32747261
97  #endif // WORDS_BIGENDIAN  #endif // WORDS_BIGENDIAN
98    
99  #define WAVE_FORMAT_PCM                 0x0001  #define DLS_WAVE_FORMAT_PCM                     0x0001
   
 #define DRUM_TYPE_MASK                  0x00000001  
   
 #define F_RGN_OPTION_SELFNONEXCLUSIVE   0x0001  
   
 #define F_WAVELINK_PHASE_MASTER         0x0001  
 #define F_WAVELINK_MULTICHANNEL         0x0002  
   
 #define F_WSMP_NO_TRUNCATION            0x0001  
 #define F_WSMP_NO_COMPRESSION           0x0002  
   
 #define MIDI_BANK_COARSE(x)             ((x & 0x00007F00) >> 8)                 // CC0  
 #define MIDI_BANK_FINE(x)               (x & 0x0000007F)                        // CC32  
 #define MIDI_BANK_MERGE(coarse, fine)   ((((uint16_t) coarse) << 7) | fine)     // CC0 + CC32  
 #define CONN_TRANSFORM_SRC(x)           ((x >> 10) & 0x000F)  
 #define CONN_TRANSFORM_CTL(x)           ((x >> 4) & 0x000F)  
 #define CONN_TRANSFORM_DST(x)           (x & 0x000F)  
 #define CONN_TRANSFORM_BIPOLAR_SRC(x)   (x & 0x4000)  
 #define CONN_TRANSFORM_BIPOLAR_CTL(x)   (x & 0x0100)  
 #define CONN_TRANSFORM_INVERT_SRC(x)    (x & 0x8000)  
 #define CONN_TRANSFORM_INVERT_CTL(x)    (x & 0x0200)  
   
100    
101  //TODO: no support for conditional chunks <cdl> yet  //TODO: no support for conditional chunks <cdl> yet
102    
# Line 244  namespace DLS { Line 208  namespace DLS {
208    
209      /** Defines Sample Loop Points. */      /** Defines Sample Loop Points. */
210      struct sample_loop_t {      struct sample_loop_t {
211          uint32_t Size;          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!
212          uint32_t LoopType;          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).
213          uint32_t LoopStart;          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.
214          uint32_t LoopLength;          uint32_t LoopLength; ///< Length of the looping area (in sample points).
215      };      };
216    
217      // just symbol prototyping      // just symbol prototyping
# Line 278  namespace DLS { Line 242  namespace DLS {
242                  uint16_t transform;                  uint16_t transform;
243                  uint32_t scale;                  uint32_t scale;
244              };              };
245              Connection() {};              Connection() {}
246              void Init(conn_block_t* Header);              void Init(conn_block_t* Header);
247              virtual ~Connection() {};              conn_block_t ToConnBlock();
248                virtual ~Connection() {}
249              friend class Articulation;              friend class Articulation;
250      };      };
251    
# Line 289  namespace DLS { Line 254  namespace DLS {
254          public:          public:
255              Connection*  pConnections; ///< Points to the beginning of a <i>Connection</i> array.              Connection*  pConnections; ///< Points to the beginning of a <i>Connection</i> array.
256              uint32_t     Connections;  ///< Reflects the number of Connections.              uint32_t     Connections;  ///< Reflects the number of Connections.
257              Articulation(RIFF::List* artList);  
258             ~Articulation();              Articulation(RIFF::Chunk* artl);
259                virtual ~Articulation();
260                virtual void UpdateChunks();
261            protected:
262                RIFF::Chunk* pArticulationCk;
263                uint32_t     HeaderSize;
264      };      };
265    
266      /** Abstract base class for classes that provide articulation information (thus for <i>Instrument</i> and <i>Region</i> class). */      /** Abstract base class for classes that provide articulation information (thus for <i>Instrument</i> and <i>Region</i> class). */
# Line 299  namespace DLS { Line 269  namespace DLS {
269              Articulator(RIFF::List* ParentList);              Articulator(RIFF::List* ParentList);
270              Articulation* GetFirstArticulation();              Articulation* GetFirstArticulation();
271              Articulation* GetNextArticulation();              Articulation* GetNextArticulation();
272                virtual void  UpdateChunks();
273                virtual void  CopyAssign(const Articulator* orig);
274          protected:          protected:
275              typedef std::list<Articulation*> ArticulationList;              typedef std::list<Articulation*> ArticulationList;
276              RIFF::List*                 pParentList;              RIFF::List*                 pParentList;
# Line 306  namespace DLS { Line 278  namespace DLS {
278              ArticulationList::iterator  ArticulationsIterator;              ArticulationList::iterator  ArticulationsIterator;
279    
280              void LoadArticulations();              void LoadArticulations();
281             ~Articulator();              virtual ~Articulator();
282      };      };
283    
284      /** Optional information for DLS files, instruments, samples, etc. */      /** Optional information for DLS files, instruments, samples, etc. */
# Line 328  namespace DLS { Line 300  namespace DLS {
300              String Source;           ///< <ISRC-ck>. Identifies the name of the person or organization who supplied the original subject of the file.              String Source;           ///< <ISRC-ck>. Identifies the name of the person or organization who supplied the original subject of the file.
301              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>.              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>.
302              String Commissioned;     ///< <ICMS-ck>. Lists the name of the person or organization that commissioned the subject of the file, e.g., Pope Julian II.              String Commissioned;     ///< <ICMS-ck>. Lists the name of the person or organization that commissioned the subject of the file, e.g., Pope Julian II.
303                String Subject;          ///< <ISBJ-ck>. Describes the contents of the file.
304                bool UseFixedLengthStrings; ///< @deprecated Not used anymore, use SetFixedStringLengths() instead.
305    
306                struct string_length_t {
307                    uint32_t chunkId;
308                    int      length;
309                };
310    
311              Info(RIFF::List* list);              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:          private:
317              inline void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s) {              RIFF::List*            pResourceListChunk;
318                  RIFF::Chunk* ck = lstINFO->GetSubChunk(ChunkID);              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.
319                  if (ck) {  
320                      // TODO: no check for ZSTR terminated strings yet              static void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s);
321                      s = (char*) ck->LoadChunkData();              void SaveString(uint32_t ChunkID, RIFF::List* lstINFO, const String& s, const String& sDefault);
                     ck->ReleaseChunkData();  
                 }  
             }  
322      };      };
323    
324      /** Abstract base class which encapsulates data structures which all DLS resources are able to provide. */      /** Abstract base class which encapsulates data structures which all DLS resources are able to provide. */
325      class Resource {      class Resource {
326          public:          public:
327              Info*    pInfo;        ///< Points (in any case) to an <i>Info</i> object, providing additional, optional infos and comments.              Info*    pInfo;  ///< Points (in any case) to an <i>Info</i> object, providing additional, optional infos and comments.
328              dlsid_t* pDLSID;       ///< Points to a <i>dlsid_t</i> structure if the file provided a DLS ID else is <i>NULL</i>.              dlsid_t* pDLSID; ///< Points to a <i>dlsid_t</i> structure if the file provided a DLS ID else is <i>NULL</i>.
329    
330              Resource* GetParent() { return pParent; };              Resource* GetParent() { return pParent; }
331                virtual void UpdateChunks();
332                void GenerateDLSID();
333                virtual void CopyAssign(const Resource* orig);
334          protected:          protected:
335              Resource* pParent;              Resource* pParent;
336                RIFF::List* pResourceList;
337    
338              Resource(Resource* Parent, RIFF::List* lstResource);              Resource(Resource* Parent, RIFF::List* lstResource);
339             ~Resource();              virtual ~Resource();
340      };      };
341    
342      /** Abstract base class which provides mandatory informations about sample players in general. */      /** Abstract base class which provides mandatory informations about sample players in general. */
# Line 360  namespace DLS { Line 344  namespace DLS {
344          public:          public:
345              uint8_t        UnityNote;              uint8_t        UnityNote;
346              int16_t        FineTune;              int16_t        FineTune;
347              int32_t        Gain;              int32_t        Gain; ///< @deprecated Don't alter directly, use SetGain() instead!
348              bool           NoSampleDepthTruncation;              bool           NoSampleDepthTruncation;
349              bool           NoSampleCompression;              bool           NoSampleCompression;
350              uint32_t       SampleLoops;              ///< Reflects the number of sample loops.              uint32_t       SampleLoops;  ///< Reflects the number of sample loops.
351              sample_loop_t* pSampleLoops;             ///< Points to the beginning of a sample loop array, or is NULL if there are no loops defined.              sample_loop_t* pSampleLoops; ///< Points to the beginning of a sample loop array, or is NULL if there are no loops defined.
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:          protected:
359                RIFF::List*    pParentList;
360                uint32_t       uiHeaderSize;
361              uint32_t       SamplerOptions;              uint32_t       SamplerOptions;
362              Sampler(RIFF::List* ParentList);              Sampler(RIFF::List* ParentList);
363             ~Sampler();              virtual ~Sampler();
364      };      };
365    
366      /** Encapsulates sample waves used for playback. */      /** @brief Encapsulates sample waves used for playback.
367         *
368         * In case you created a new sample with File::AddSample(), you should
369         * first update all attributes with the desired meta informations
370         * (amount of channels, bit depth, sample rate, etc.), then call
371         * Resize() with the desired sample size. The latter will create
372         * the mandatory RIFF chunk which will hold the sample wave data.
373         */
374      class Sample : public Resource {      class Sample : public Resource {
375          public:          public:
376              uint16_t      FormatTag;             ///< Format ID of the waveform data (should be WAVE_FORMAT_PCM for DLS1 compliant files).              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()).
377              uint16_t      Channels;              ///< Number of channels represented in the waveform data, e.g. 1 for mono, 2 for stereo ().              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).
378              uint32_t      SamplesPerSecond;      ///< Sampling rate at which each channel should be played.              uint32_t      SamplesPerSecond;      ///< Sampling rate at which each channel should be played (defaults to 44100 if Sample was created with Instrument::AddSample() previously).
379              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).              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).
380              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.              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.
381              uint16_t      BitDepth;              ///< Size of each sample per channel (only if known sample data format is used, 0 otherwise).              uint16_t      BitDepth;              ///< Size of each sample per channel (only if known sample data format is used, 0 otherwise).
382              unsigned long SamplesTotal;          ///< Reflects total number of samples (only if known sample data format is used, 0 otherwise).              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.
383              uint          FrameSize;             ///< Reflects the size (in bytes) of one single sample (only if known sample data format is used, 0 otherwise).              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().
384    
385              void*         LoadSampleData();              ///< Load sample data into RAM. Returns a pointer to the data in RAM on success, <i>NULL</i> otherwise.              void*         LoadSampleData();
386              void          ReleaseSampleData();           ///< Release the samples once you used them if you don't want to be bothered to.              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);              unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
390              unsigned long Read(void* pBuffer, unsigned long SampleCount);              unsigned long Read(void* pBuffer, unsigned long SampleCount);
391                unsigned long Write(void* pBuffer, unsigned long SampleCount);
392                virtual void  UpdateChunks();
393          protected:          protected:
394                RIFF::List*   pWaveList;
395              RIFF::Chunk*  pCkData;              RIFF::Chunk*  pCkData;
396              RIFF::Chunk*  pCkFormat;              RIFF::Chunk*  pCkFormat;
397              unsigned long ulWavePoolOffset;  // needed for comparison with the wave pool link table, thus the link to instruments              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);              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);
400                virtual ~Sample();
401              friend class File;              friend class File;
402              friend class Region; // Region has to compare the wave pool offset to get its sample              friend class Region; // Region has to compare the wave pool offset to get its sample
403      };      };
# Line 400  namespace DLS { Line 405  namespace DLS {
405      /** Defines <i>Region</i> information of an <i>Instrument</i>. */      /** Defines <i>Region</i> information of an <i>Instrument</i>. */
406      class Region : public Resource, public Articulator, public Sampler {      class Region : public Resource, public Articulator, public Sampler {
407          public:          public:
408              range_t     KeyRange;              range_t     KeyRange; ///< @deprecated Only read, don't write! Use SetKeyRange() instead.
409              range_t     VelocityRange;              range_t     VelocityRange;
410              uint16_t    KeyGroup;              uint16_t    KeyGroup;
411              uint16_t    Layer;              uint16_t    Layer;
# Line 411  namespace DLS { Line 416  namespace DLS {
416              uint32_t    Channel;              uint32_t    Channel;
417    
418              Sample*     GetSample();              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:          protected:
424              RIFF::List* pCkRegion;              RIFF::List* pCkRegion;
425              uint32_t    WavePoolTableIndex; // index in the wave pool table to the sample wave this region is linked to              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              Sample*     pSample;            // every region refers to exactly one sample
427                uint16_t    FormatOptionFlags;
428                uint16_t    WaveLinkOptionFlags;
429    
430              Region(Instrument* pInstrument, RIFF::List* rgnList);              Region(Instrument* pInstrument, RIFF::List* rgnList);
431             ~Region();              virtual ~Region();
432              friend class Instrument;              friend class Instrument;
433      };      };
434    
# Line 425  namespace DLS { Line 436  namespace DLS {
436      class Instrument : public Resource, public Articulator {      class Instrument : public Resource, public Articulator {
437          public:          public:
438              bool     IsDrum;         ///< Indicates if the <i>Instrument</i> is a drum type, as they differ in the synthesis model of DLS from melodic instruments.              bool     IsDrum;         ///< Indicates if the <i>Instrument</i> is a drum type, as they differ in the synthesis model of DLS from melodic instruments.
439              uint16_t MIDIBank;       ///< Reflects combination of <i>MIDIBankCoarse</i> and <i>MIDIBankFine</i> (bank 1 - bank 16384).              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).
440              uint8_t  MIDIBankCoarse; ///< Reflects the MIDI Bank number for MIDI Control Change 0 (bank 1 - 128).              uint8_t  MIDIBankCoarse; ///< Reflects the MIDI Bank number for MIDI Control Change 0 (bank 1 - 128).
441              uint8_t  MIDIBankFine;   ///< Reflects the MIDI Bank number for MIDI Control Change 32 (bank 1 - 128).              uint8_t  MIDIBankFine;   ///< Reflects the MIDI Bank number for MIDI Control Change 32 (bank 1 - 128).
442              uint32_t MIDIProgram;    ///< Specifies the MIDI Program Change Number this Instrument should be assigned to.              uint32_t MIDIProgram;    ///< Specifies the MIDI Program Change Number this Instrument should be assigned to.
# Line 433  namespace DLS { Line 444  namespace DLS {
444    
445              Region*  GetFirstRegion();              Region*  GetFirstRegion();
446              Region*  GetNextRegion();              Region*  GetNextRegion();
447                Region*  AddRegion();
448                void     DeleteRegion(Region* pRegion);
449                virtual void UpdateChunks();
450                virtual void CopyAssign(const Instrument* orig);
451          protected:          protected:
452              typedef std::list<Region*> RegionList;              typedef std::list<Region*> RegionList;
453              struct midi_locale_t {              struct midi_locale_t {
# Line 445  namespace DLS { Line 460  namespace DLS {
460              RegionList::iterator RegionsIterator;              RegionList::iterator RegionsIterator;
461    
462              Instrument(File* pFile, RIFF::List* insList);              Instrument(File* pFile, RIFF::List* insList);
463              void LoadRegions();              void CopyAssignCore(const Instrument* orig);
464             ~Instrument();              virtual void LoadRegions();
465                virtual ~Instrument();
466              friend class File;              friend class File;
467                friend class Region;
468            private:
469                void MoveRegion(Region* pSrc, Region* pDst);
470      };      };
471    
472      /** Parses DLS Level 1 and 2 compliant files and provides abstract access to the data. */      /** Parses DLS Level 1 and 2 compliant files and provides abstract access to the data. */
# Line 456  namespace DLS { Line 475  namespace DLS {
475              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>.              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>.
476              uint32_t   Instruments;           ///< Reflects the number of available <i>Instrument</i> objects.              uint32_t   Instruments;           ///< Reflects the number of available <i>Instrument</i> objects.
477    
478                File();
479              File(RIFF::File* pRIFF);              File(RIFF::File* pRIFF);
480                String      GetFileName();
481              Sample*     GetFirstSample();     ///< Returns a pointer to the first <i>Sample</i> object of the file, <i>NULL</i> otherwise.              Sample*     GetFirstSample();     ///< Returns a pointer to the first <i>Sample</i> object of the file, <i>NULL</i> otherwise.
482              Sample*     GetNextSample();      ///< Returns a pointer to the next <i>Sample</i> object of the file, <i>NULL</i> otherwise.              Sample*     GetNextSample();      ///< Returns a pointer to the next <i>Sample</i> object of the file, <i>NULL</i> otherwise.
483                Sample*     AddSample();
484                void        DeleteSample(Sample* pSample);
485              Instrument* GetFirstInstrument(); ///< Returns a pointer to the first <i>Instrument</i> object of the file, <i>NULL</i> otherwise.              Instrument* GetFirstInstrument(); ///< Returns a pointer to the first <i>Instrument</i> object of the file, <i>NULL</i> otherwise.
486              Instrument* GetNextInstrument();  ///< Returns a pointer to the next <i>Instrument</i> object of the file, <i>NULL</i> otherwise.              Instrument* GetNextInstrument();  ///< Returns a pointer to the next <i>Instrument</i> object of the file, <i>NULL</i> otherwise.
487             ~File();              Instrument* AddInstrument();
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:          protected:
495              typedef std::list<Sample*>     SampleList;              typedef std::list<Sample*>     SampleList;
496              typedef std::list<Instrument*> InstrumentList;              typedef std::list<Instrument*> InstrumentList;
497    
498              RIFF::File*              pRIFF;              RIFF::File*              pRIFF;
499                std::list<RIFF::File*>   ExtensionFiles;
500              SampleList*              pSamples;              SampleList*              pSamples;
501              SampleList::iterator     SamplesIterator;              SampleList::iterator     SamplesIterator;
502              InstrumentList*          pInstruments;              InstrumentList*          pInstruments;
503              InstrumentList::iterator InstrumentsIterator;              InstrumentList::iterator InstrumentsIterator;
504                uint32_t                 WavePoolHeaderSize;
505              uint32_t                 WavePoolCount;              uint32_t                 WavePoolCount;
506              uint32_t*                pWavePoolTable;              uint32_t*                pWavePoolTable;
507                uint32_t*                pWavePoolTableHi;
508                bool                     b64BitWavePoolOffsets;
509    
510              void LoadSamples();              virtual void LoadSamples();
511              void LoadInstruments();              virtual void LoadInstruments();
512                void __ensureMandatoryChunksExist();
513              friend class Region; // Region has to look in the wave pool table to get its sample              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    
519      /** Will be thrown whenever a DLS specific error occurs while trying to access a DLS File. */      /**
520         * Will be thrown whenever a DLS specific error occurs while trying to
521         * access a DLS File. Note: In your application you should better catch
522         * for RIFF::Exception rather than this one, except you explicitly want
523         * to catch and handle DLS::Exception and RIFF::Exception independently,
524         * which usually shouldn't be necessary though.
525         */
526      class Exception : public RIFF::Exception {      class Exception : public RIFF::Exception {
527          public:          public:
528              Exception(String Message);              Exception(String Message);
529              void PrintMessage();              void PrintMessage();
530      };      };
531    
532        String libraryName();
533        String libraryVersion();
534    
535  } // namespace DLS  } // namespace DLS
536    
537  #endif // __DLS_H__  #endif // __DLS_H__
Legend:
Removed from v.2  
changed lines
  Added in v.2394
  ViewVC Help
Powered by ViewVC