/[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 3474 by schoenebeck, Wed Feb 20 16:04:19 2019 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-2019 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    # define CHUNK_ID_XFIL  0x7866696C
64    # define CHUNK_ID_DOXF  0x646F7866
65  #else  // little endian  #else  // little endian
66  # define LIST_TYPE_INFO 0x4F464E49  # define RIFF_TYPE_DLS  0x20534C44
67  # define LIST_TYPE_WVPL 0x6C707677  # define LIST_TYPE_WVPL 0x6C707677
68  # 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.
69  # define LIST_TYPE_WAVE 0x65766177  # define LIST_TYPE_WAVE 0x65766177
# Line 79  Line 74 
74  # define LIST_TYPE_LAR2 0x3272616C  # define LIST_TYPE_LAR2 0x3272616C
75  # define LIST_TYPE_RGN  0x206E6772  # define LIST_TYPE_RGN  0x206E6772
76  # define LIST_TYPE_RGN2 0x326E6772  # define LIST_TYPE_RGN2 0x326E6772
 # define LIST_TYPE_ART1 0x31747261  
 # define LIST_TYPE_ART2 0x32747261  
77  # define CHUNK_ID_IARL  0x4C524149  # define CHUNK_ID_IARL  0x4C524149
78  # define CHUNK_ID_IART  0x54524149  # define CHUNK_ID_IART  0x54524149
79  # 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  
80  # define CHUNK_ID_IGNR  0x524E4749  # define CHUNK_ID_IGNR  0x524E4749
81  # define CHUNK_ID_IKEY  0x59454B49  # define CHUNK_ID_IKEY  0x59454B49
82  # define CHUNK_ID_IMED  0x44525049  # define CHUNK_ID_IMED  0x44454D49
 # define CHUNK_ID_INAM  0x4D414E49  
 # define CHUNK_ID_IPRD  0x44525049  
83  # define CHUNK_ID_ISBJ  0x4A425349  # define CHUNK_ID_ISBJ  0x4A425349
 # define CHUNK_ID_ISFT  0x54465349  
84  # define CHUNK_ID_ISRC  0x43525349  # define CHUNK_ID_ISRC  0x43525349
85  # define CHUNK_ID_ISRF  0x46525349  # define CHUNK_ID_ISRF  0x46525349
86  # define CHUNK_ID_ITCH  0x48435449  # define CHUNK_ID_ITCH  0x48435449
# Line 108  Line 94 
94  # define CHUNK_ID_PTBL  0x6C627470  # define CHUNK_ID_PTBL  0x6C627470
95  # define CHUNK_ID_WSMP  0x706D7377  # define CHUNK_ID_WSMP  0x706D7377
96  # define CHUNK_ID_COLH  0x686C6F63  # define CHUNK_ID_COLH  0x686C6F63
97    # define CHUNK_ID_ARTL  0x6C747261
98    # define CHUNK_ID_ART2  0x32747261
99    # define CHUNK_ID_XFIL  0x6C696678
100    # define CHUNK_ID_DOXF  0x66786F64
101  #endif // WORDS_BIGENDIAN  #endif // WORDS_BIGENDIAN
102    
103  #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)  
   
104    
105  //TODO: no support for conditional chunks <cdl> yet  //TODO: no support for conditional chunks <cdl> yet
106    
# Line 140  Line 108 
108  namespace DLS {  namespace DLS {
109    
110      typedef std::string String;      typedef std::string String;
111        typedef RIFF::progress_t progress_t;
112        typedef RIFF::file_offset_t file_offset_t;
113    
114      /** Quadtuple version number ("major.minor.release.build"). */      /** Quadtuple version number ("major.minor.release.build"). */
115      struct version_t {      struct version_t {
# Line 158  namespace DLS { Line 128  namespace DLS {
128      };      };
129    
130      /** Connection Sources */      /** Connection Sources */
131      typedef enum {      enum conn_src_t {
132          // Modulator Sources          // Modulator Sources
133          conn_src_none            = 0x0000,          conn_src_none            = 0x0000,
134          conn_src_lfo             = 0x0001,          conn_src_lfo             = 0x0001,
# Line 181  namespace DLS { Line 151  namespace DLS {
151          conn_src_rpn0            = 0x0100,          conn_src_rpn0            = 0x0100,
152          conn_src_rpn1            = 0x0101,          conn_src_rpn1            = 0x0101,
153          conn_src_rpn2            = 0x0102          conn_src_rpn2            = 0x0102
154      } conn_src_t;      };
155    
156      /** Connection Destinations */      /** Connection Destinations */
157      typedef enum {      enum conn_dst_t {
158          // Generic Destinations          // Generic Destinations
159          conn_dst_none             = 0x0000,          conn_dst_none             = 0x0000,
160          conn_dst_gain             = 0x0001,          conn_dst_gain             = 0x0001,
# Line 226  namespace DLS { Line 196  namespace DLS {
196          // Filter Destinations          // Filter Destinations
197          conn_dst_filter_cutoff    = 0x0500,          conn_dst_filter_cutoff    = 0x0500,
198          conn_dst_filter_q         = 0x0501          conn_dst_filter_q         = 0x0501
199      } conn_dst_t;      };
200    
201      /** Connection Transforms */      /** Connection Transforms */
202      typedef enum {      enum conn_trn_t {
203          conn_trn_none    = 0x0000,          conn_trn_none    = 0x0000,
204          conn_trn_concave = 0x0001,          conn_trn_concave = 0x0001,
205          conn_trn_convex  = 0x0002,          conn_trn_convex  = 0x0002,
206          conn_trn_switch  = 0x0003          conn_trn_switch  = 0x0003
207      } conn_trn_t;      };
208    
209      /** Lower and upper limit of a range. */      /** Lower and upper limit of a range. */
210      struct range_t {      struct range_t {
211          uint16_t low;  ///< Low value of range.          uint16_t low;  ///< Low value of range.
212          uint16_t high; ///< High value of range.          uint16_t high; ///< High value of range.
213    
214            inline bool operator< (const range_t& other) const {
215                if (low < other.low) return true;
216                if (low > other.low) return false;
217                return high < other.high;
218            }
219    
220            inline bool operator== (const range_t& other) const {
221                return low == other.low && high == other.high;
222            }
223    
224            inline bool overlaps(uint16_t scalar) const {
225                return low <= scalar && scalar <= high;
226            }
227    
228            inline bool overlaps(const range_t& other) const {
229                return overlaps(other.low) || overlaps(other.high) ||
230                       other.overlaps(low) || other.overlaps(high);
231            }
232      };      };
233    
234      /** Defines Sample Loop Points. */      /** Defines Sample Loop Points. */
235      struct sample_loop_t {      struct sample_loop_t {
236          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!
237          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).
238          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.
239          uint32_t LoopLength;          uint32_t LoopLength; ///< Length of the looping area (in sample points).
240      };      };
241    
242      // just symbol prototyping      // just symbol prototyping
# Line 278  namespace DLS { Line 267  namespace DLS {
267                  uint16_t transform;                  uint16_t transform;
268                  uint32_t scale;                  uint32_t scale;
269              };              };
270              Connection() {};              Connection() {}
271              void Init(conn_block_t* Header);              void Init(conn_block_t* Header);
272              virtual ~Connection() {};              conn_block_t ToConnBlock();
273                virtual ~Connection() {}
274              friend class Articulation;              friend class Articulation;
275      };      };
276    
# Line 289  namespace DLS { Line 279  namespace DLS {
279          public:          public:
280              Connection*  pConnections; ///< Points to the beginning of a <i>Connection</i> array.              Connection*  pConnections; ///< Points to the beginning of a <i>Connection</i> array.
281              uint32_t     Connections;  ///< Reflects the number of Connections.              uint32_t     Connections;  ///< Reflects the number of Connections.
282              Articulation(RIFF::List* artList);  
283             ~Articulation();              Articulation(RIFF::Chunk* artl);
284                virtual ~Articulation();
285                virtual void UpdateChunks(progress_t* pProgress);
286            protected:
287                RIFF::Chunk* pArticulationCk;
288                uint32_t     HeaderSize;
289      };      };
290    
291      /** 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 294  namespace DLS {
294              Articulator(RIFF::List* ParentList);              Articulator(RIFF::List* ParentList);
295              Articulation* GetFirstArticulation();              Articulation* GetFirstArticulation();
296              Articulation* GetNextArticulation();              Articulation* GetNextArticulation();
297                virtual void  UpdateChunks(progress_t* pProgress);
298                virtual void  CopyAssign(const Articulator* orig);
299          protected:          protected:
300              typedef std::list<Articulation*> ArticulationList;              typedef std::list<Articulation*> ArticulationList;
301              RIFF::List*                 pParentList;              RIFF::List*                 pParentList;
# Line 306  namespace DLS { Line 303  namespace DLS {
303              ArticulationList::iterator  ArticulationsIterator;              ArticulationList::iterator  ArticulationsIterator;
304    
305              void LoadArticulations();              void LoadArticulations();
306             ~Articulator();              virtual ~Articulator();
307      };      };
308    
309      /** Optional information for DLS files, instruments, samples, etc. */      /** Optional information for DLS files, instruments, samples, etc. */
# Line 328  namespace DLS { Line 325  namespace DLS {
325              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.
326              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>.
327              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.
328                String Subject;          ///< <ISBJ-ck>. Describes the contents of the file.
329                bool UseFixedLengthStrings; ///< @deprecated Not used anymore, use SetFixedStringLengths() instead.
330    
331                struct string_length_t {
332                    uint32_t chunkId;
333                    int      length;
334                };
335    
336              Info(RIFF::List* list);              Info(RIFF::List* list);
337                void SetFixedStringLengths(const string_length_t* lengths);
338                virtual ~Info();
339                virtual void UpdateChunks(progress_t* pProgress);
340                virtual void CopyAssign(const Info* orig);
341          private:          private:
342              inline void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s) {              RIFF::List*            pResourceListChunk;
343                  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.
344                  if (ck) {  
345                      // TODO: no check for ZSTR terminated strings yet              static void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s);
346                      s = (char*) ck->LoadChunkData();              void SaveString(uint32_t ChunkID, RIFF::List* lstINFO, const String& s, const String& sDefault);
                     ck->ReleaseChunkData();  
                 }  
             }  
347      };      };
348    
349      /** 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. */
350      class Resource {      class Resource {
351          public:          public:
352              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.
353              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>.
354    
355              Resource* GetParent() { return pParent; };              Resource* GetParent() { return pParent; }
356                const Resource* GetParent() const { return pParent; }
357                virtual void UpdateChunks(progress_t* pProgress);
358                void GenerateDLSID();
359                static void GenerateDLSID(dlsid_t* pDLSID);
360                virtual void CopyAssign(const Resource* orig);
361          protected:          protected:
362              Resource* pParent;              Resource* pParent;
363                RIFF::List* pResourceList;
364    
365              Resource(Resource* Parent, RIFF::List* lstResource);              Resource(Resource* Parent, RIFF::List* lstResource);
366             ~Resource();              virtual ~Resource();
367      };      };
368    
369      /** 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 371  namespace DLS {
371          public:          public:
372              uint8_t        UnityNote;              uint8_t        UnityNote;
373              int16_t        FineTune;              int16_t        FineTune;
374              int32_t        Gain;              int32_t        Gain; ///< @deprecated Don't alter directly, use SetGain() instead!
375              bool           NoSampleDepthTruncation;              bool           NoSampleDepthTruncation;
376              bool           NoSampleCompression;              bool           NoSampleCompression;
377              uint32_t       SampleLoops;              ///< Reflects the number of sample loops.              uint32_t       SampleLoops;  ///< Reflects the number of sample loops.
378              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.
379    
380                void AddSampleLoop(sample_loop_t* pLoopDef);
381                void DeleteSampleLoop(sample_loop_t* pLoopDef);
382                virtual void SetGain(int32_t gain);
383                virtual void UpdateChunks(progress_t* pProgress);
384                virtual void CopyAssign(const Sampler* orig);
385          protected:          protected:
386                RIFF::List*    pParentList;
387                uint32_t       uiHeaderSize;
388              uint32_t       SamplerOptions;              uint32_t       SamplerOptions;
389              Sampler(RIFF::List* ParentList);              Sampler(RIFF::List* ParentList);
390             ~Sampler();              virtual ~Sampler();
391      };      };
392    
393      /** Encapsulates sample waves used for playback. */      /** @brief Encapsulates sample waves used for playback.
394         *
395         * In case you created a new sample with File::AddSample(), you should
396         * first update all attributes with the desired meta informations
397         * (amount of channels, bit depth, sample rate, etc.), then call
398         * Resize() with the desired sample size. The latter will create
399         * the mandatory RIFF chunk which will hold the sample wave data.
400         */
401      class Sample : public Resource {      class Sample : public Resource {
402          public:          public:
403              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()).
404              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).
405              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).
406              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).
407              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.
408              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).
409              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.
410              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().
411    
412                void*         LoadSampleData();
413                void          ReleaseSampleData();
414                file_offset_t GetSize() const;
415                void          Resize(file_offset_t NewSize);
416                file_offset_t SetPos(file_offset_t SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
417                file_offset_t Read(void* pBuffer, file_offset_t SampleCount);
418                file_offset_t Write(void* pBuffer, file_offset_t SampleCount);
419                virtual void  UpdateChunks(progress_t* pProgress);
420                virtual void  CopyAssign(const Sample* orig);
421    
             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);  
422          protected:          protected:
423                RIFF::List*   pWaveList;
424              RIFF::Chunk*  pCkData;              RIFF::Chunk*  pCkData;
425              RIFF::Chunk*  pCkFormat;              RIFF::Chunk*  pCkFormat;
426              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
427    
428              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);              Sample(File* pFile, RIFF::List* waveList, file_offset_t WavePoolOffset);
429                virtual ~Sample();
430                void CopyAssignCore(const Sample* orig);
431              friend class File;              friend class File;
432              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
433      };      };
# Line 400  namespace DLS { Line 435  namespace DLS {
435      /** Defines <i>Region</i> information of an <i>Instrument</i>. */      /** Defines <i>Region</i> information of an <i>Instrument</i>. */
436      class Region : public Resource, public Articulator, public Sampler {      class Region : public Resource, public Articulator, public Sampler {
437          public:          public:
438              range_t     KeyRange;              range_t     KeyRange; ///< @deprecated Only read, don't write! Use SetKeyRange() instead.
439              range_t     VelocityRange;              range_t     VelocityRange;
440              uint16_t    KeyGroup;              uint16_t    KeyGroup;
441              uint16_t    Layer;              uint16_t    Layer;
# Line 411  namespace DLS { Line 446  namespace DLS {
446              uint32_t    Channel;              uint32_t    Channel;
447    
448              Sample*     GetSample();              Sample*     GetSample();
449                void        SetSample(Sample* pSample);
450                virtual void SetKeyRange(uint16_t Low, uint16_t High);
451                virtual void UpdateChunks(progress_t* pProgress);
452                virtual void CopyAssign(const Region* orig);
453          protected:          protected:
454              RIFF::List* pCkRegion;              RIFF::List* pCkRegion;
455              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
456              Sample*     pSample;            // every region refers to exactly one sample              Sample*     pSample;            // every region refers to exactly one sample
457                uint16_t    FormatOptionFlags;
458                uint16_t    WaveLinkOptionFlags;
459    
460              Region(Instrument* pInstrument, RIFF::List* rgnList);              Region(Instrument* pInstrument, RIFF::List* rgnList);
461             ~Region();              virtual ~Region();
462              friend class Instrument;              friend class Instrument;
463      };      };
464    
# Line 425  namespace DLS { Line 466  namespace DLS {
466      class Instrument : public Resource, public Articulator {      class Instrument : public Resource, public Articulator {
467          public:          public:
468              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.
469              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).
470              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).
471              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).
472              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 474  namespace DLS {
474    
475              Region*  GetFirstRegion();              Region*  GetFirstRegion();
476              Region*  GetNextRegion();              Region*  GetNextRegion();
477                Region*  AddRegion();
478                void     DeleteRegion(Region* pRegion);
479                virtual void UpdateChunks(progress_t* pProgress);
480                virtual void CopyAssign(const Instrument* orig);
481          protected:          protected:
482              typedef std::list<Region*> RegionList;              typedef std::list<Region*> RegionList;
483              struct midi_locale_t {              struct midi_locale_t {
# Line 445  namespace DLS { Line 490  namespace DLS {
490              RegionList::iterator RegionsIterator;              RegionList::iterator RegionsIterator;
491    
492              Instrument(File* pFile, RIFF::List* insList);              Instrument(File* pFile, RIFF::List* insList);
493              void LoadRegions();              void CopyAssignCore(const Instrument* orig);
494             ~Instrument();              virtual void LoadRegions();
495                virtual ~Instrument();
496              friend class File;              friend class File;
497                friend class Region;
498            private:
499                void MoveRegion(Region* pSrc, Region* pDst);
500      };      };
501    
502      /** 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 505  namespace DLS {
505              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>.
506              uint32_t   Instruments;           ///< Reflects the number of available <i>Instrument</i> objects.              uint32_t   Instruments;           ///< Reflects the number of available <i>Instrument</i> objects.
507    
508                File();
509              File(RIFF::File* pRIFF);              File(RIFF::File* pRIFF);
510                String      GetFileName();
511                void        SetFileName(const String& name);
512              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.
513              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.
514                Sample*     AddSample();
515                void        DeleteSample(Sample* pSample);
516              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.
517              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.
518             ~File();              Instrument* AddInstrument();
519                void        DeleteInstrument(Instrument* pInstrument);
520                RIFF::File* GetExtensionFile(int index);
521                virtual void UpdateChunks(progress_t* pProgress);
522                virtual void Save(const String& Path, progress_t* pProgress = NULL);
523                virtual void Save(progress_t* pProgress = NULL);
524                virtual ~File();
525          protected:          protected:
526              typedef std::list<Sample*>     SampleList;              typedef std::list<Sample*>     SampleList;
527              typedef std::list<Instrument*> InstrumentList;              typedef std::list<Instrument*> InstrumentList;
528    
529              RIFF::File*              pRIFF;              RIFF::File*              pRIFF;
530                std::list<RIFF::File*>   ExtensionFiles; //FIXME: These should automatically be freed, since implicitly allocated.
531              SampleList*              pSamples;              SampleList*              pSamples;
532              SampleList::iterator     SamplesIterator;              SampleList::iterator     SamplesIterator;
533              InstrumentList*          pInstruments;              InstrumentList*          pInstruments;
534              InstrumentList::iterator InstrumentsIterator;              InstrumentList::iterator InstrumentsIterator;
535                uint32_t                 WavePoolHeaderSize;
536              uint32_t                 WavePoolCount;              uint32_t                 WavePoolCount;
537              uint32_t*                pWavePoolTable;              uint32_t*                pWavePoolTable;
538                uint32_t*                pWavePoolTableHi;
539              void LoadSamples();              bool                     b64BitWavePoolOffsets;
540              void LoadInstruments();              bool                     bOwningRiff; ///< If @c true then @c pRIFF was implicitly allocated by this class and hence pRIFF will automatically be freed by the @c DLS::File destructor in that case.
541    
542                virtual void LoadSamples();
543                virtual void LoadInstruments();
544                virtual void UpdateFileOffsets();
545                void __ensureMandatoryChunksExist();
546              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
547            private:
548                void __UpdateWavePoolTableChunk();
549                void __UpdateWavePoolTable();
550      };      };
551    
552      /** Will be thrown whenever a DLS specific error occurs while trying to access a DLS File. */      /**
553         * Will be thrown whenever a DLS specific error occurs while trying to
554         * access a DLS File. Note: In your application you should better catch
555         * for RIFF::Exception rather than this one, except you explicitly want
556         * to catch and handle DLS::Exception and RIFF::Exception independently,
557         * which usually shouldn't be necessary though.
558         */
559      class Exception : public RIFF::Exception {      class Exception : public RIFF::Exception {
560          public:          public:
561              Exception(String Message);              Exception(String format, ...);
562                Exception(String format, va_list arg);
563              void PrintMessage();              void PrintMessage();
564            protected:
565                Exception();
566      };      };
567    
568        String libraryName();
569        String libraryVersion();
570    
571  } // namespace DLS  } // namespace DLS
572    
573  #endif // __DLS_H__  #endif // __DLS_H__
Legend:
Removed from v.2  
changed lines
  Added in v.3474
  ViewVC Help
Powered by ViewVC