/[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 55 by schoenebeck, Tue Apr 27 09:06:07 2004 UTC revision 2682 by schoenebeck, Mon Dec 29 16:25:51 2014 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, 2004 by Christian Schoenebeck                     *   *   Copyright (C) 2003-2014 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 27  Line 27 
27  #include "RIFF.h"  #include "RIFF.h"
28    
29  #if 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 140  Line 104 
104  namespace DLS {  namespace DLS {
105    
106      typedef std::string String;      typedef std::string String;
107        typedef RIFF::progress_t progress_t;
108    
109      /** Quadtuple version number ("major.minor.release.build"). */      /** Quadtuple version number ("major.minor.release.build"). */
110      struct version_t {      struct version_t {
# Line 235  namespace DLS { Line 200  namespace DLS {
200          conn_trn_convex  = 0x0002,          conn_trn_convex  = 0x0002,
201          conn_trn_switch  = 0x0003          conn_trn_switch  = 0x0003
202      } conn_trn_t;      } conn_trn_t;
203        
204      /** Lower and upper limit of a range. */      /** Lower and upper limit of a range. */
205      struct range_t {      struct range_t {
206          uint16_t low;  ///< Low value of range.          uint16_t low;  ///< Low value of range.
207          uint16_t high; ///< High value of range.          uint16_t high; ///< High value of range.
208    
209            inline bool operator< (const range_t& other) const {
210                if (low < other.low) return true;
211                if (low > other.low) return false;
212                return high < other.high;
213            }
214    
215            inline bool operator== (const range_t& other) const {
216                return low == other.low && high == other.high;
217            }
218    
219            inline bool overlaps(uint16_t scalar) const {
220                return low <= scalar && scalar <= high;
221            }
222    
223            inline bool overlaps(const range_t& other) const {
224                return overlaps(other.low) || overlaps(other.high) ||
225                       other.overlaps(low) || other.overlaps(high);
226            }
227      };      };
228    
229      /** Defines Sample Loop Points. */      /** Defines Sample Loop Points. */
230      struct sample_loop_t {      struct sample_loop_t {
231          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!
232          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).
233          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.
234          uint32_t LoopLength;          uint32_t LoopLength; ///< Length of the looping area (in sample points).
235      };      };
236    
237      // just symbol prototyping      // just symbol prototyping
# Line 278  namespace DLS { Line 262  namespace DLS {
262                  uint16_t transform;                  uint16_t transform;
263                  uint32_t scale;                  uint32_t scale;
264              };              };
265              Connection() {};              Connection() {}
266              void Init(conn_block_t* Header);              void Init(conn_block_t* Header);
267              virtual ~Connection() {};              conn_block_t ToConnBlock();
268                virtual ~Connection() {}
269              friend class Articulation;              friend class Articulation;
270      };      };
271    
# Line 289  namespace DLS { Line 274  namespace DLS {
274          public:          public:
275              Connection*  pConnections; ///< Points to the beginning of a <i>Connection</i> array.              Connection*  pConnections; ///< Points to the beginning of a <i>Connection</i> array.
276              uint32_t     Connections;  ///< Reflects the number of Connections.              uint32_t     Connections;  ///< Reflects the number of Connections.
277              Articulation(RIFF::List* artList);  
278             ~Articulation();              Articulation(RIFF::Chunk* artl);
279                virtual ~Articulation();
280                virtual void UpdateChunks(progress_t* pProgress);
281            protected:
282                RIFF::Chunk* pArticulationCk;
283                uint32_t     HeaderSize;
284      };      };
285    
286      /** 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 289  namespace DLS {
289              Articulator(RIFF::List* ParentList);              Articulator(RIFF::List* ParentList);
290              Articulation* GetFirstArticulation();              Articulation* GetFirstArticulation();
291              Articulation* GetNextArticulation();              Articulation* GetNextArticulation();
292                virtual void  UpdateChunks(progress_t* pProgress);
293                virtual void  CopyAssign(const Articulator* orig);
294          protected:          protected:
295              typedef std::list<Articulation*> ArticulationList;              typedef std::list<Articulation*> ArticulationList;
296              RIFF::List*                 pParentList;              RIFF::List*                 pParentList;
# Line 306  namespace DLS { Line 298  namespace DLS {
298              ArticulationList::iterator  ArticulationsIterator;              ArticulationList::iterator  ArticulationsIterator;
299    
300              void LoadArticulations();              void LoadArticulations();
301             ~Articulator();              virtual ~Articulator();
302      };      };
303    
304      /** Optional information for DLS files, instruments, samples, etc. */      /** Optional information for DLS files, instruments, samples, etc. */
# Line 328  namespace DLS { Line 320  namespace DLS {
320              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.
321              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>.
322              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.
323                String Subject;          ///< <ISBJ-ck>. Describes the contents of the file.
324                bool UseFixedLengthStrings; ///< @deprecated Not used anymore, use SetFixedStringLengths() instead.
325    
326                struct string_length_t {
327                    uint32_t chunkId;
328                    int      length;
329                };
330    
331              Info(RIFF::List* list);              Info(RIFF::List* list);
332                void SetFixedStringLengths(const string_length_t* lengths);
333                virtual ~Info();
334                virtual void UpdateChunks(progress_t* pProgress);
335                virtual void CopyAssign(const Info* orig);
336          private:          private:
337              inline void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s) {              RIFF::List*            pResourceListChunk;
338                  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.
339                  if (ck) {  
340                      // TODO: no check for ZSTR terminated strings yet              static void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s);
341                      s = (char*) ck->LoadChunkData();              void SaveString(uint32_t ChunkID, RIFF::List* lstINFO, const String& s, const String& sDefault);
                     ck->ReleaseChunkData();  
                 }  
             }  
342      };      };
343    
344      /** 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. */
345      class Resource {      class Resource {
346          public:          public:
347              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.
348              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>.
349    
350              Resource* GetParent() { return pParent; };              Resource* GetParent() { return pParent; }
351                const Resource* GetParent() const { return pParent; }
352                virtual void UpdateChunks(progress_t* pProgress);
353                void GenerateDLSID();
354                virtual void CopyAssign(const Resource* orig);
355          protected:          protected:
356              Resource* pParent;              Resource* pParent;
357                RIFF::List* pResourceList;
358    
359              Resource(Resource* Parent, RIFF::List* lstResource);              Resource(Resource* Parent, RIFF::List* lstResource);
360             ~Resource();              virtual ~Resource();
361      };      };
362    
363      /** 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 365  namespace DLS {
365          public:          public:
366              uint8_t        UnityNote;              uint8_t        UnityNote;
367              int16_t        FineTune;              int16_t        FineTune;
368              int32_t        Gain;              int32_t        Gain; ///< @deprecated Don't alter directly, use SetGain() instead!
369              bool           NoSampleDepthTruncation;              bool           NoSampleDepthTruncation;
370              bool           NoSampleCompression;              bool           NoSampleCompression;
371              uint32_t       SampleLoops;              ///< Reflects the number of sample loops.              uint32_t       SampleLoops;  ///< Reflects the number of sample loops.
372              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.
373    
374                void AddSampleLoop(sample_loop_t* pLoopDef);
375                void DeleteSampleLoop(sample_loop_t* pLoopDef);
376                virtual void SetGain(int32_t gain);
377                virtual void UpdateChunks(progress_t* pProgress);
378                virtual void CopyAssign(const Sampler* orig);
379          protected:          protected:
380                RIFF::List*    pParentList;
381                uint32_t       uiHeaderSize;
382              uint32_t       SamplerOptions;              uint32_t       SamplerOptions;
383              Sampler(RIFF::List* ParentList);              Sampler(RIFF::List* ParentList);
384             ~Sampler();              virtual ~Sampler();
385      };      };
386    
387      /** Encapsulates sample waves used for playback. */      /** @brief Encapsulates sample waves used for playback.
388         *
389         * In case you created a new sample with File::AddSample(), you should
390         * first update all attributes with the desired meta informations
391         * (amount of channels, bit depth, sample rate, etc.), then call
392         * Resize() with the desired sample size. The latter will create
393         * the mandatory RIFF chunk which will hold the sample wave data.
394         */
395      class Sample : public Resource {      class Sample : public Resource {
396          public:          public:
397              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()).
398              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).
399              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).
400              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).
401              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.
402              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).
403              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.
404              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().
405    
406              void*         LoadSampleData();              ///< Load sample data into RAM. Returns a pointer to the data in RAM on success, <i>NULL</i> otherwise.              void*         LoadSampleData();
407              void          ReleaseSampleData();           ///< Release the samples once you used them if you don't want to be bothered to.              void          ReleaseSampleData();
408                unsigned long GetSize() const;
409                void          Resize(int iNewSize);
410              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);
411              unsigned long Read(void* pBuffer, unsigned long SampleCount);              unsigned long Read(void* pBuffer, unsigned long SampleCount);
412                unsigned long Write(void* pBuffer, unsigned long SampleCount);
413                virtual void  UpdateChunks(progress_t* pProgress);
414                virtual void  CopyAssign(const Sample* orig);
415          protected:          protected:
416                RIFF::List*   pWaveList;
417              RIFF::Chunk*  pCkData;              RIFF::Chunk*  pCkData;
418              RIFF::Chunk*  pCkFormat;              RIFF::Chunk*  pCkFormat;
419              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
420    
421              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);
422                virtual ~Sample();
423                void CopyAssignCore(const Sample* orig);
424              friend class File;              friend class File;
425              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
426      };      };
# Line 400  namespace DLS { Line 428  namespace DLS {
428      /** Defines <i>Region</i> information of an <i>Instrument</i>. */      /** Defines <i>Region</i> information of an <i>Instrument</i>. */
429      class Region : public Resource, public Articulator, public Sampler {      class Region : public Resource, public Articulator, public Sampler {
430          public:          public:
431              range_t     KeyRange;              range_t     KeyRange; ///< @deprecated Only read, don't write! Use SetKeyRange() instead.
432              range_t     VelocityRange;              range_t     VelocityRange;
433              uint16_t    KeyGroup;              uint16_t    KeyGroup;
434              uint16_t    Layer;              uint16_t    Layer;
# Line 411  namespace DLS { Line 439  namespace DLS {
439              uint32_t    Channel;              uint32_t    Channel;
440    
441              Sample*     GetSample();              Sample*     GetSample();
442                void        SetSample(Sample* pSample);
443                virtual void SetKeyRange(uint16_t Low, uint16_t High);
444                virtual void UpdateChunks(progress_t* pProgress);
445                virtual void CopyAssign(const Region* orig);
446          protected:          protected:
447              RIFF::List* pCkRegion;              RIFF::List* pCkRegion;
448              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
449              Sample*     pSample;            // every region refers to exactly one sample              Sample*     pSample;            // every region refers to exactly one sample
450                uint16_t    FormatOptionFlags;
451                uint16_t    WaveLinkOptionFlags;
452    
453              Region(Instrument* pInstrument, RIFF::List* rgnList);              Region(Instrument* pInstrument, RIFF::List* rgnList);
454             ~Region();              virtual ~Region();
455              friend class Instrument;              friend class Instrument;
456      };      };
457    
# Line 425  namespace DLS { Line 459  namespace DLS {
459      class Instrument : public Resource, public Articulator {      class Instrument : public Resource, public Articulator {
460          public:          public:
461              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.
462              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).
463              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).
464              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).
465              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 467  namespace DLS {
467    
468              Region*  GetFirstRegion();              Region*  GetFirstRegion();
469              Region*  GetNextRegion();              Region*  GetNextRegion();
470                Region*  AddRegion();
471                void     DeleteRegion(Region* pRegion);
472                virtual void UpdateChunks(progress_t* pProgress);
473                virtual void CopyAssign(const Instrument* orig);
474          protected:          protected:
475              typedef std::list<Region*> RegionList;              typedef std::list<Region*> RegionList;
476              struct midi_locale_t {              struct midi_locale_t {
# Line 445  namespace DLS { Line 483  namespace DLS {
483              RegionList::iterator RegionsIterator;              RegionList::iterator RegionsIterator;
484    
485              Instrument(File* pFile, RIFF::List* insList);              Instrument(File* pFile, RIFF::List* insList);
486              void LoadRegions();              void CopyAssignCore(const Instrument* orig);
487             ~Instrument();              virtual void LoadRegions();
488                virtual ~Instrument();
489              friend class File;              friend class File;
490                friend class Region;
491            private:
492                void MoveRegion(Region* pSrc, Region* pDst);
493      };      };
494    
495      /** 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 498  namespace DLS {
498              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>.
499              uint32_t   Instruments;           ///< Reflects the number of available <i>Instrument</i> objects.              uint32_t   Instruments;           ///< Reflects the number of available <i>Instrument</i> objects.
500    
501                File();
502              File(RIFF::File* pRIFF);              File(RIFF::File* pRIFF);
503                String      GetFileName();
504                void        SetFileName(const String& name);
505              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.
506              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.
507                Sample*     AddSample();
508                void        DeleteSample(Sample* pSample);
509              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.
510              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.
511             ~File();              Instrument* AddInstrument();
512                void        DeleteInstrument(Instrument* pInstrument);
513                RIFF::File* GetExtensionFile(int index);
514                virtual void UpdateChunks(progress_t* pProgress);
515                virtual void Save(const String& Path, progress_t* pProgress = NULL);
516                virtual void Save(progress_t* pProgress = NULL);
517                virtual ~File();
518          protected:          protected:
519              typedef std::list<Sample*>     SampleList;              typedef std::list<Sample*>     SampleList;
520              typedef std::list<Instrument*> InstrumentList;              typedef std::list<Instrument*> InstrumentList;
521    
522              RIFF::File*              pRIFF;              RIFF::File*              pRIFF;
523                std::list<RIFF::File*>   ExtensionFiles;
524              SampleList*              pSamples;              SampleList*              pSamples;
525              SampleList::iterator     SamplesIterator;              SampleList::iterator     SamplesIterator;
526              InstrumentList*          pInstruments;              InstrumentList*          pInstruments;
527              InstrumentList::iterator InstrumentsIterator;              InstrumentList::iterator InstrumentsIterator;
528                uint32_t                 WavePoolHeaderSize;
529              uint32_t                 WavePoolCount;              uint32_t                 WavePoolCount;
530              uint32_t*                pWavePoolTable;              uint32_t*                pWavePoolTable;
531                uint32_t*                pWavePoolTableHi;
532                bool                     b64BitWavePoolOffsets;
533    
534              void LoadSamples();              virtual void LoadSamples();
535              void LoadInstruments();              virtual void LoadInstruments();
536                virtual void UpdateFileOffsets();
537                void __ensureMandatoryChunksExist();
538              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
539            private:
540                void __UpdateWavePoolTableChunk();
541                void __UpdateWavePoolTable();
542      };      };
543    
544      /** Will be thrown whenever a DLS specific error occurs while trying to access a DLS File. */      /**
545         * Will be thrown whenever a DLS specific error occurs while trying to
546         * access a DLS File. Note: In your application you should better catch
547         * for RIFF::Exception rather than this one, except you explicitly want
548         * to catch and handle DLS::Exception and RIFF::Exception independently,
549         * which usually shouldn't be necessary though.
550         */
551      class Exception : public RIFF::Exception {      class Exception : public RIFF::Exception {
552          public:          public:
553              Exception(String Message);              Exception(String Message);
554              void PrintMessage();              void PrintMessage();
555      };      };
556    
557        String libraryName();
558        String libraryVersion();
559    
560  } // namespace DLS  } // namespace DLS
561    
562  #endif // __DLS_H__  #endif // __DLS_H__

Legend:
Removed from v.55  
changed lines
  Added in v.2682

  ViewVC Help
Powered by ViewVC