/[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 2543 by schoenebeck, Sat May 10 02:06:58 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-2005 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  *
# 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 240  namespace DLS { Line 204  namespace DLS {
204      struct range_t {      struct range_t {
205          uint16_t low;  ///< Low value of range.          uint16_t low;  ///< Low value of range.
206          uint16_t high; ///< High value of range.          uint16_t high; ///< High value of range.
207    
208            inline bool operator< (const range_t& other) const {
209                if (low < other.low) return true;
210                if (low > other.low) return false;
211                return high < other.high;
212            }
213    
214            inline bool operator== (const range_t& other) const {
215                return low == other.low && high == other.high;
216            }
217      };      };
218    
219      /** Defines Sample Loop Points. */      /** Defines Sample Loop Points. */
220      struct sample_loop_t {      struct sample_loop_t {
221          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!
222          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).
223          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.
224          uint32_t LoopLength;          uint32_t LoopLength; ///< Length of the looping area (in sample points).
225      };      };
226    
227      // just symbol prototyping      // just symbol prototyping
# Line 278  namespace DLS { Line 252  namespace DLS {
252                  uint16_t transform;                  uint16_t transform;
253                  uint32_t scale;                  uint32_t scale;
254              };              };
255              Connection() {};              Connection() {}
256              void Init(conn_block_t* Header);              void Init(conn_block_t* Header);
257              virtual ~Connection() {};              conn_block_t ToConnBlock();
258                virtual ~Connection() {}
259              friend class Articulation;              friend class Articulation;
260      };      };
261    
# Line 289  namespace DLS { Line 264  namespace DLS {
264          public:          public:
265              Connection*  pConnections; ///< Points to the beginning of a <i>Connection</i> array.              Connection*  pConnections; ///< Points to the beginning of a <i>Connection</i> array.
266              uint32_t     Connections;  ///< Reflects the number of Connections.              uint32_t     Connections;  ///< Reflects the number of Connections.
267              Articulation(RIFF::List* artList);  
268                Articulation(RIFF::Chunk* artl);
269              virtual ~Articulation();              virtual ~Articulation();
270                virtual void UpdateChunks();
271            protected:
272                RIFF::Chunk* pArticulationCk;
273                uint32_t     HeaderSize;
274      };      };
275    
276      /** 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 279  namespace DLS {
279              Articulator(RIFF::List* ParentList);              Articulator(RIFF::List* ParentList);
280              Articulation* GetFirstArticulation();              Articulation* GetFirstArticulation();
281              Articulation* GetNextArticulation();              Articulation* GetNextArticulation();
282                virtual void  UpdateChunks();
283                virtual void  CopyAssign(const Articulator* orig);
284          protected:          protected:
285              typedef std::list<Articulation*> ArticulationList;              typedef std::list<Articulation*> ArticulationList;
286              RIFF::List*                 pParentList;              RIFF::List*                 pParentList;
# Line 328  namespace DLS { Line 310  namespace DLS {
310              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.
311              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>.
312              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.
313                String Subject;          ///< <ISBJ-ck>. Describes the contents of the file.
314                bool UseFixedLengthStrings; ///< @deprecated Not used anymore, use SetFixedStringLengths() instead.
315    
316                struct string_length_t {
317                    uint32_t chunkId;
318                    int      length;
319                };
320    
321              Info(RIFF::List* list);              Info(RIFF::List* list);
322                void SetFixedStringLengths(const string_length_t* lengths);
323                virtual ~Info();
324                virtual void UpdateChunks();
325                virtual void CopyAssign(const Info* orig);
326          private:          private:
327              inline void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s) {              RIFF::List*            pResourceListChunk;
328                  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.
329                  if (ck) {  
330                      // TODO: no check for ZSTR terminated strings yet              static void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s);
331                      s = (char*) ck->LoadChunkData();              void SaveString(uint32_t ChunkID, RIFF::List* lstINFO, const String& s, const String& sDefault);
                     ck->ReleaseChunkData();  
                 }  
             }  
332      };      };
333    
334      /** 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. */
335      class Resource {      class Resource {
336          public:          public:
337              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.
338              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>.
339    
340              Resource* GetParent() { return pParent; };              Resource* GetParent() { return pParent; }
341                const Resource* GetParent() const { return pParent; }
342                virtual void UpdateChunks();
343                void GenerateDLSID();
344                virtual void CopyAssign(const Resource* orig);
345          protected:          protected:
346              Resource* pParent;              Resource* pParent;
347                RIFF::List* pResourceList;
348    
349              Resource(Resource* Parent, RIFF::List* lstResource);              Resource(Resource* Parent, RIFF::List* lstResource);
350              virtual ~Resource();              virtual ~Resource();
# Line 360  namespace DLS { Line 355  namespace DLS {
355          public:          public:
356              uint8_t        UnityNote;              uint8_t        UnityNote;
357              int16_t        FineTune;              int16_t        FineTune;
358              int32_t        Gain;              int32_t        Gain; ///< @deprecated Don't alter directly, use SetGain() instead!
359              bool           NoSampleDepthTruncation;              bool           NoSampleDepthTruncation;
360              bool           NoSampleCompression;              bool           NoSampleCompression;
361              uint32_t       SampleLoops;              ///< Reflects the number of sample loops.              uint32_t       SampleLoops;  ///< Reflects the number of sample loops.
362              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.
363    
364                void AddSampleLoop(sample_loop_t* pLoopDef);
365                void DeleteSampleLoop(sample_loop_t* pLoopDef);
366                virtual void SetGain(int32_t gain);
367                virtual void UpdateChunks();
368                virtual void CopyAssign(const Sampler* orig);
369          protected:          protected:
370                RIFF::List*    pParentList;
371                uint32_t       uiHeaderSize;
372              uint32_t       SamplerOptions;              uint32_t       SamplerOptions;
373              Sampler(RIFF::List* ParentList);              Sampler(RIFF::List* ParentList);
374              virtual ~Sampler();              virtual ~Sampler();
375      };      };
376    
377      /** Encapsulates sample waves used for playback. */      /** @brief Encapsulates sample waves used for playback.
378         *
379         * In case you created a new sample with File::AddSample(), you should
380         * first update all attributes with the desired meta informations
381         * (amount of channels, bit depth, sample rate, etc.), then call
382         * Resize() with the desired sample size. The latter will create
383         * the mandatory RIFF chunk which will hold the sample wave data.
384         */
385      class Sample : public Resource {      class Sample : public Resource {
386          public:          public:
387              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()).
388              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).
389              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).
390              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).
391              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.
392              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).
393              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.
394              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().
395    
396              void*         LoadSampleData();              ///< Load sample data into RAM. Returns a pointer to the data in RAM on success, <i>NULL</i> otherwise.              void*         LoadSampleData();
397              void          ReleaseSampleData();           ///< Release the samples once you used them if you don't want to be bothered to.              void          ReleaseSampleData();
398                unsigned long GetSize() const;
399                void          Resize(int iNewSize);
400              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);
401              unsigned long Read(void* pBuffer, unsigned long SampleCount);              unsigned long Read(void* pBuffer, unsigned long SampleCount);
402                unsigned long Write(void* pBuffer, unsigned long SampleCount);
403                virtual void  UpdateChunks();
404                virtual void  CopyAssign(const Sample* orig);
405          protected:          protected:
406                RIFF::List*   pWaveList;
407              RIFF::Chunk*  pCkData;              RIFF::Chunk*  pCkData;
408              RIFF::Chunk*  pCkFormat;              RIFF::Chunk*  pCkFormat;
409              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
410    
411              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);
412                virtual ~Sample();
413                void CopyAssignCore(const Sample* orig);
414              friend class File;              friend class File;
415              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
416      };      };
# Line 400  namespace DLS { Line 418  namespace DLS {
418      /** Defines <i>Region</i> information of an <i>Instrument</i>. */      /** Defines <i>Region</i> information of an <i>Instrument</i>. */
419      class Region : public Resource, public Articulator, public Sampler {      class Region : public Resource, public Articulator, public Sampler {
420          public:          public:
421              range_t     KeyRange;              range_t     KeyRange; ///< @deprecated Only read, don't write! Use SetKeyRange() instead.
422              range_t     VelocityRange;              range_t     VelocityRange;
423              uint16_t    KeyGroup;              uint16_t    KeyGroup;
424              uint16_t    Layer;              uint16_t    Layer;
# Line 411  namespace DLS { Line 429  namespace DLS {
429              uint32_t    Channel;              uint32_t    Channel;
430    
431              Sample*     GetSample();              Sample*     GetSample();
432                void        SetSample(Sample* pSample);
433                virtual void SetKeyRange(uint16_t Low, uint16_t High);
434                virtual void UpdateChunks();
435                virtual void CopyAssign(const Region* orig);
436          protected:          protected:
437              RIFF::List* pCkRegion;              RIFF::List* pCkRegion;
438              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
439              Sample*     pSample;            // every region refers to exactly one sample              Sample*     pSample;            // every region refers to exactly one sample
440                uint16_t    FormatOptionFlags;
441                uint16_t    WaveLinkOptionFlags;
442    
443              Region(Instrument* pInstrument, RIFF::List* rgnList);              Region(Instrument* pInstrument, RIFF::List* rgnList);
444              virtual ~Region();              virtual ~Region();
# Line 425  namespace DLS { Line 449  namespace DLS {
449      class Instrument : public Resource, public Articulator {      class Instrument : public Resource, public Articulator {
450          public:          public:
451              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.
452              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).
453              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).
454              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).
455              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 457  namespace DLS {
457    
458              Region*  GetFirstRegion();              Region*  GetFirstRegion();
459              Region*  GetNextRegion();              Region*  GetNextRegion();
460                Region*  AddRegion();
461                void     DeleteRegion(Region* pRegion);
462                virtual void UpdateChunks();
463                virtual void CopyAssign(const Instrument* orig);
464          protected:          protected:
465              typedef std::list<Region*> RegionList;              typedef std::list<Region*> RegionList;
466              struct midi_locale_t {              struct midi_locale_t {
# Line 445  namespace DLS { Line 473  namespace DLS {
473              RegionList::iterator RegionsIterator;              RegionList::iterator RegionsIterator;
474    
475              Instrument(File* pFile, RIFF::List* insList);              Instrument(File* pFile, RIFF::List* insList);
476              void LoadRegions();              void CopyAssignCore(const Instrument* orig);
477                virtual void LoadRegions();
478              virtual ~Instrument();              virtual ~Instrument();
479              friend class File;              friend class File;
480                friend class Region;
481            private:
482                void MoveRegion(Region* pSrc, Region* pDst);
483      };      };
484    
485      /** 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 488  namespace DLS {
488              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>.
489              uint32_t   Instruments;           ///< Reflects the number of available <i>Instrument</i> objects.              uint32_t   Instruments;           ///< Reflects the number of available <i>Instrument</i> objects.
490    
491                File();
492              File(RIFF::File* pRIFF);              File(RIFF::File* pRIFF);
493                String      GetFileName();
494                void        SetFileName(const String& name);
495              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.
496              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.
497                Sample*     AddSample();
498                void        DeleteSample(Sample* pSample);
499              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.
500              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.
501                Instrument* AddInstrument();
502                void        DeleteInstrument(Instrument* pInstrument);
503                RIFF::File* GetExtensionFile(int index);
504                virtual void UpdateChunks();
505                virtual void Save(const String& Path);
506                virtual void Save();
507              virtual ~File();              virtual ~File();
508          protected:          protected:
509              typedef std::list<Sample*>     SampleList;              typedef std::list<Sample*>     SampleList;
510              typedef std::list<Instrument*> InstrumentList;              typedef std::list<Instrument*> InstrumentList;
511    
512              RIFF::File*              pRIFF;              RIFF::File*              pRIFF;
513                std::list<RIFF::File*>   ExtensionFiles;
514              SampleList*              pSamples;              SampleList*              pSamples;
515              SampleList::iterator     SamplesIterator;              SampleList::iterator     SamplesIterator;
516              InstrumentList*          pInstruments;              InstrumentList*          pInstruments;
517              InstrumentList::iterator InstrumentsIterator;              InstrumentList::iterator InstrumentsIterator;
518                uint32_t                 WavePoolHeaderSize;
519              uint32_t                 WavePoolCount;              uint32_t                 WavePoolCount;
520              uint32_t*                pWavePoolTable;              uint32_t*                pWavePoolTable;
521              uint32_t*                pWavePoolTableHi;              uint32_t*                pWavePoolTableHi;
522                bool                     b64BitWavePoolOffsets;
523    
524              void LoadSamples();              virtual void LoadSamples();
525              void LoadInstruments();              virtual void LoadInstruments();
526                void __ensureMandatoryChunksExist();
527              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
528            private:
529                void __UpdateWavePoolTableChunk();
530                void __UpdateWavePoolTable();
531      };      };
532    
533      /** Will be thrown whenever a DLS specific error occurs while trying to access a DLS File. */      /**
534         * Will be thrown whenever a DLS specific error occurs while trying to
535         * access a DLS File. Note: In your application you should better catch
536         * for RIFF::Exception rather than this one, except you explicitly want
537         * to catch and handle DLS::Exception and RIFF::Exception independently,
538         * which usually shouldn't be necessary though.
539         */
540      class Exception : public RIFF::Exception {      class Exception : public RIFF::Exception {
541          public:          public:
542              Exception(String Message);              Exception(String Message);
Legend:
Removed from v.666  
changed lines
  Added in v.2543
  ViewVC Help
Powered by ViewVC