/[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 666 by persson, Sun Jun 19 15:18:59 2005 UTC revision 3323 by schoenebeck, Thu Jul 20 22:09:54 2017 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-2005 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2017 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  *
# 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        typedef RIFF::file_offset_t file_offset_t;
109    
110      /** Quadtuple version number ("major.minor.release.build"). */      /** Quadtuple version number ("major.minor.release.build"). */
111      struct version_t {      struct version_t {
# Line 158  namespace DLS { Line 124  namespace DLS {
124      };      };
125    
126      /** Connection Sources */      /** Connection Sources */
127      typedef enum {      enum conn_src_t {
128          // Modulator Sources          // Modulator Sources
129          conn_src_none            = 0x0000,          conn_src_none            = 0x0000,
130          conn_src_lfo             = 0x0001,          conn_src_lfo             = 0x0001,
# Line 181  namespace DLS { Line 147  namespace DLS {
147          conn_src_rpn0            = 0x0100,          conn_src_rpn0            = 0x0100,
148          conn_src_rpn1            = 0x0101,          conn_src_rpn1            = 0x0101,
149          conn_src_rpn2            = 0x0102          conn_src_rpn2            = 0x0102
150      } conn_src_t;      };
151    
152      /** Connection Destinations */      /** Connection Destinations */
153      typedef enum {      enum conn_dst_t {
154          // Generic Destinations          // Generic Destinations
155          conn_dst_none             = 0x0000,          conn_dst_none             = 0x0000,
156          conn_dst_gain             = 0x0001,          conn_dst_gain             = 0x0001,
# Line 226  namespace DLS { Line 192  namespace DLS {
192          // Filter Destinations          // Filter Destinations
193          conn_dst_filter_cutoff    = 0x0500,          conn_dst_filter_cutoff    = 0x0500,
194          conn_dst_filter_q         = 0x0501          conn_dst_filter_q         = 0x0501
195      } conn_dst_t;      };
196    
197      /** Connection Transforms */      /** Connection Transforms */
198      typedef enum {      enum conn_trn_t {
199          conn_trn_none    = 0x0000,          conn_trn_none    = 0x0000,
200          conn_trn_concave = 0x0001,          conn_trn_concave = 0x0001,
201          conn_trn_convex  = 0x0002,          conn_trn_convex  = 0x0002,
202          conn_trn_switch  = 0x0003          conn_trn_switch  = 0x0003
203      } conn_trn_t;      };
204    
205      /** Lower and upper limit of a range. */      /** Lower and upper limit of a range. */
206      struct range_t {      struct range_t {
207          uint16_t low;  ///< Low value of range.          uint16_t low;  ///< Low value of range.
208          uint16_t high; ///< High value of range.          uint16_t high; ///< High value of range.
209    
210            inline bool operator< (const range_t& other) const {
211                if (low < other.low) return true;
212                if (low > other.low) return false;
213                return high < other.high;
214            }
215    
216            inline bool operator== (const range_t& other) const {
217                return low == other.low && high == other.high;
218            }
219    
220            inline bool overlaps(uint16_t scalar) const {
221                return low <= scalar && scalar <= high;
222            }
223    
224            inline bool overlaps(const range_t& other) const {
225                return overlaps(other.low) || overlaps(other.high) ||
226                       other.overlaps(low) || other.overlaps(high);
227            }
228      };      };
229    
230      /** Defines Sample Loop Points. */      /** Defines Sample Loop Points. */
231      struct sample_loop_t {      struct sample_loop_t {
232          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!
233          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).
234          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.
235          uint32_t LoopLength;          uint32_t LoopLength; ///< Length of the looping area (in sample points).
236      };      };
237    
238      // just symbol prototyping      // just symbol prototyping
# Line 278  namespace DLS { Line 263  namespace DLS {
263                  uint16_t transform;                  uint16_t transform;
264                  uint32_t scale;                  uint32_t scale;
265              };              };
266              Connection() {};              Connection() {}
267              void Init(conn_block_t* Header);              void Init(conn_block_t* Header);
268              virtual ~Connection() {};              conn_block_t ToConnBlock();
269                virtual ~Connection() {}
270              friend class Articulation;              friend class Articulation;
271      };      };
272    
# Line 289  namespace DLS { Line 275  namespace DLS {
275          public:          public:
276              Connection*  pConnections; ///< Points to the beginning of a <i>Connection</i> array.              Connection*  pConnections; ///< Points to the beginning of a <i>Connection</i> array.
277              uint32_t     Connections;  ///< Reflects the number of Connections.              uint32_t     Connections;  ///< Reflects the number of Connections.
278              Articulation(RIFF::List* artList);  
279                Articulation(RIFF::Chunk* artl);
280              virtual ~Articulation();              virtual ~Articulation();
281                virtual void UpdateChunks(progress_t* pProgress);
282            protected:
283                RIFF::Chunk* pArticulationCk;
284                uint32_t     HeaderSize;
285      };      };
286    
287      /** 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 290  namespace DLS {
290              Articulator(RIFF::List* ParentList);              Articulator(RIFF::List* ParentList);
291              Articulation* GetFirstArticulation();              Articulation* GetFirstArticulation();
292              Articulation* GetNextArticulation();              Articulation* GetNextArticulation();
293                virtual void  UpdateChunks(progress_t* pProgress);
294                virtual void  CopyAssign(const Articulator* orig);
295          protected:          protected:
296              typedef std::list<Articulation*> ArticulationList;              typedef std::list<Articulation*> ArticulationList;
297              RIFF::List*                 pParentList;              RIFF::List*                 pParentList;
# Line 328  namespace DLS { Line 321  namespace DLS {
321              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.
322              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>.
323              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.
324                String Subject;          ///< <ISBJ-ck>. Describes the contents of the file.
325                bool UseFixedLengthStrings; ///< @deprecated Not used anymore, use SetFixedStringLengths() instead.
326    
327                struct string_length_t {
328                    uint32_t chunkId;
329                    int      length;
330                };
331    
332              Info(RIFF::List* list);              Info(RIFF::List* list);
333                void SetFixedStringLengths(const string_length_t* lengths);
334                virtual ~Info();
335                virtual void UpdateChunks(progress_t* pProgress);
336                virtual void CopyAssign(const Info* orig);
337          private:          private:
338              inline void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s) {              RIFF::List*            pResourceListChunk;
339                  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.
340                  if (ck) {  
341                      // TODO: no check for ZSTR terminated strings yet              static void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s);
342                      s = (char*) ck->LoadChunkData();              void SaveString(uint32_t ChunkID, RIFF::List* lstINFO, const String& s, const String& sDefault);
                     ck->ReleaseChunkData();  
                 }  
             }  
343      };      };
344    
345      /** 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. */
346      class Resource {      class Resource {
347          public:          public:
348              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.
349              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>.
350    
351              Resource* GetParent() { return pParent; };              Resource* GetParent() { return pParent; }
352                const Resource* GetParent() const { return pParent; }
353                virtual void UpdateChunks(progress_t* pProgress);
354                void GenerateDLSID();
355                virtual void CopyAssign(const Resource* orig);
356          protected:          protected:
357              Resource* pParent;              Resource* pParent;
358                RIFF::List* pResourceList;
359    
360              Resource(Resource* Parent, RIFF::List* lstResource);              Resource(Resource* Parent, RIFF::List* lstResource);
361              virtual ~Resource();              virtual ~Resource();
# Line 360  namespace DLS { Line 366  namespace DLS {
366          public:          public:
367              uint8_t        UnityNote;              uint8_t        UnityNote;
368              int16_t        FineTune;              int16_t        FineTune;
369              int32_t        Gain;              int32_t        Gain; ///< @deprecated Don't alter directly, use SetGain() instead!
370              bool           NoSampleDepthTruncation;              bool           NoSampleDepthTruncation;
371              bool           NoSampleCompression;              bool           NoSampleCompression;
372              uint32_t       SampleLoops;              ///< Reflects the number of sample loops.              uint32_t       SampleLoops;  ///< Reflects the number of sample loops.
373              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.
374    
375                void AddSampleLoop(sample_loop_t* pLoopDef);
376                void DeleteSampleLoop(sample_loop_t* pLoopDef);
377                virtual void SetGain(int32_t gain);
378                virtual void UpdateChunks(progress_t* pProgress);
379                virtual void CopyAssign(const Sampler* orig);
380          protected:          protected:
381                RIFF::List*    pParentList;
382                uint32_t       uiHeaderSize;
383              uint32_t       SamplerOptions;              uint32_t       SamplerOptions;
384              Sampler(RIFF::List* ParentList);              Sampler(RIFF::List* ParentList);
385              virtual ~Sampler();              virtual ~Sampler();
386      };      };
387    
388      /** Encapsulates sample waves used for playback. */      /** @brief Encapsulates sample waves used for playback.
389         *
390         * In case you created a new sample with File::AddSample(), you should
391         * first update all attributes with the desired meta informations
392         * (amount of channels, bit depth, sample rate, etc.), then call
393         * Resize() with the desired sample size. The latter will create
394         * the mandatory RIFF chunk which will hold the sample wave data.
395         */
396      class Sample : public Resource {      class Sample : public Resource {
397          public:          public:
398              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()).
399              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).
400              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).
401              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).
402              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.
403              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).
404              unsigned long SamplesTotal;          ///< Reflects total number of samples (only if known sample data format is used, 0 otherwise).              file_offset_t 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.
405              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().
406    
407                void*         LoadSampleData();
408                void          ReleaseSampleData();
409                file_offset_t GetSize() const;
410                void          Resize(file_offset_t NewSize);
411                file_offset_t SetPos(file_offset_t SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
412                file_offset_t Read(void* pBuffer, file_offset_t SampleCount);
413                file_offset_t Write(void* pBuffer, file_offset_t SampleCount);
414                virtual void  UpdateChunks(progress_t* pProgress);
415                virtual void  CopyAssign(const Sample* orig);
416    
             void*         LoadSampleData();              ///< Load sample data into RAM. Returns a pointer to the data in RAM on success, <i>NULL</i> otherwise.  
             void          ReleaseSampleData();           ///< Release the samples once you used them if you don't want to be bothered to.  
             unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);  
             unsigned long Read(void* pBuffer, unsigned long SampleCount);  
417          protected:          protected:
418                RIFF::List*   pWaveList;
419              RIFF::Chunk*  pCkData;              RIFF::Chunk*  pCkData;
420              RIFF::Chunk*  pCkFormat;              RIFF::Chunk*  pCkFormat;
421              unsigned long ulWavePoolOffset;  // needed for comparison with the wave pool link table, thus the link to instruments              file_offset_t ullWavePoolOffset;  // needed for comparison with the wave pool link table, thus the link to instruments
422    
423              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);              Sample(File* pFile, RIFF::List* waveList, file_offset_t WavePoolOffset);
424                virtual ~Sample();
425                void CopyAssignCore(const Sample* orig);
426              friend class File;              friend class File;
427              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
428      };      };
# Line 400  namespace DLS { Line 430  namespace DLS {
430      /** Defines <i>Region</i> information of an <i>Instrument</i>. */      /** Defines <i>Region</i> information of an <i>Instrument</i>. */
431      class Region : public Resource, public Articulator, public Sampler {      class Region : public Resource, public Articulator, public Sampler {
432          public:          public:
433              range_t     KeyRange;              range_t     KeyRange; ///< @deprecated Only read, don't write! Use SetKeyRange() instead.
434              range_t     VelocityRange;              range_t     VelocityRange;
435              uint16_t    KeyGroup;              uint16_t    KeyGroup;
436              uint16_t    Layer;              uint16_t    Layer;
# Line 411  namespace DLS { Line 441  namespace DLS {
441              uint32_t    Channel;              uint32_t    Channel;
442    
443              Sample*     GetSample();              Sample*     GetSample();
444                void        SetSample(Sample* pSample);
445                virtual void SetKeyRange(uint16_t Low, uint16_t High);
446                virtual void UpdateChunks(progress_t* pProgress);
447                virtual void CopyAssign(const Region* orig);
448          protected:          protected:
449              RIFF::List* pCkRegion;              RIFF::List* pCkRegion;
450              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
451              Sample*     pSample;            // every region refers to exactly one sample              Sample*     pSample;            // every region refers to exactly one sample
452                uint16_t    FormatOptionFlags;
453                uint16_t    WaveLinkOptionFlags;
454    
455              Region(Instrument* pInstrument, RIFF::List* rgnList);              Region(Instrument* pInstrument, RIFF::List* rgnList);
456              virtual ~Region();              virtual ~Region();
# Line 425  namespace DLS { Line 461  namespace DLS {
461      class Instrument : public Resource, public Articulator {      class Instrument : public Resource, public Articulator {
462          public:          public:
463              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.
464              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).
465              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).
466              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).
467              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 469  namespace DLS {
469    
470              Region*  GetFirstRegion();              Region*  GetFirstRegion();
471              Region*  GetNextRegion();              Region*  GetNextRegion();
472                Region*  AddRegion();
473                void     DeleteRegion(Region* pRegion);
474                virtual void UpdateChunks(progress_t* pProgress);
475                virtual void CopyAssign(const Instrument* orig);
476          protected:          protected:
477              typedef std::list<Region*> RegionList;              typedef std::list<Region*> RegionList;
478              struct midi_locale_t {              struct midi_locale_t {
# Line 445  namespace DLS { Line 485  namespace DLS {
485              RegionList::iterator RegionsIterator;              RegionList::iterator RegionsIterator;
486    
487              Instrument(File* pFile, RIFF::List* insList);              Instrument(File* pFile, RIFF::List* insList);
488              void LoadRegions();              void CopyAssignCore(const Instrument* orig);
489                virtual void LoadRegions();
490              virtual ~Instrument();              virtual ~Instrument();
491              friend class File;              friend class File;
492                friend class Region;
493            private:
494                void MoveRegion(Region* pSrc, Region* pDst);
495      };      };
496    
497      /** 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 500  namespace DLS {
500              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>.
501              uint32_t   Instruments;           ///< Reflects the number of available <i>Instrument</i> objects.              uint32_t   Instruments;           ///< Reflects the number of available <i>Instrument</i> objects.
502    
503                File();
504              File(RIFF::File* pRIFF);              File(RIFF::File* pRIFF);
505                String      GetFileName();
506                void        SetFileName(const String& name);
507              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.
508              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.
509                Sample*     AddSample();
510                void        DeleteSample(Sample* pSample);
511              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.
512              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.
513                Instrument* AddInstrument();
514                void        DeleteInstrument(Instrument* pInstrument);
515                RIFF::File* GetExtensionFile(int index);
516                virtual void UpdateChunks(progress_t* pProgress);
517                virtual void Save(const String& Path, progress_t* pProgress = NULL);
518                virtual void Save(progress_t* pProgress = NULL);
519              virtual ~File();              virtual ~File();
520          protected:          protected:
521              typedef std::list<Sample*>     SampleList;              typedef std::list<Sample*>     SampleList;
522              typedef std::list<Instrument*> InstrumentList;              typedef std::list<Instrument*> InstrumentList;
523    
524              RIFF::File*              pRIFF;              RIFF::File*              pRIFF;
525                std::list<RIFF::File*>   ExtensionFiles;
526              SampleList*              pSamples;              SampleList*              pSamples;
527              SampleList::iterator     SamplesIterator;              SampleList::iterator     SamplesIterator;
528              InstrumentList*          pInstruments;              InstrumentList*          pInstruments;
529              InstrumentList::iterator InstrumentsIterator;              InstrumentList::iterator InstrumentsIterator;
530                uint32_t                 WavePoolHeaderSize;
531              uint32_t                 WavePoolCount;              uint32_t                 WavePoolCount;
532              uint32_t*                pWavePoolTable;              uint32_t*                pWavePoolTable;
533              uint32_t*                pWavePoolTableHi;              uint32_t*                pWavePoolTableHi;
534                bool                     b64BitWavePoolOffsets;
535    
536              void LoadSamples();              virtual void LoadSamples();
537              void LoadInstruments();              virtual void LoadInstruments();
538                virtual void UpdateFileOffsets();
539                void __ensureMandatoryChunksExist();
540              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
541            private:
542                void __UpdateWavePoolTableChunk();
543                void __UpdateWavePoolTable();
544      };      };
545    
546      /** Will be thrown whenever a DLS specific error occurs while trying to access a DLS File. */      /**
547         * Will be thrown whenever a DLS specific error occurs while trying to
548         * access a DLS File. Note: In your application you should better catch
549         * for RIFF::Exception rather than this one, except you explicitly want
550         * to catch and handle DLS::Exception and RIFF::Exception independently,
551         * which usually shouldn't be necessary though.
552         */
553      class Exception : public RIFF::Exception {      class Exception : public RIFF::Exception {
554          public:          public:
555              Exception(String Message);              Exception(String format, ...);
556                Exception(String format, va_list arg);
557              void PrintMessage();              void PrintMessage();
558            protected:
559                Exception();
560      };      };
561    
562      String libraryName();      String libraryName();
Legend:
Removed from v.666  
changed lines
  Added in v.3323
  ViewVC Help
Powered by ViewVC