/[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 799 by persson, Sun Jun 19 15:18:59 2005 UTC revision 800 by schoenebeck, Wed Nov 9 20:04:11 2005 UTC
# Line 27  Line 27 
27  #include "RIFF.h"  #include "RIFF.h"
28    
29  #if WORDS_BIGENDIAN  #if WORDS_BIGENDIAN
30    # define RIFF_TYPE_DLS  0x646C7320
31  # define LIST_TYPE_INFO 0x494E464F  # define LIST_TYPE_INFO 0x494E464F
32  # define LIST_TYPE_WVPL 0x7776706C  # define LIST_TYPE_WVPL 0x7776706C
33  # 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.
# Line 38  Line 39 
39  # define LIST_TYPE_LAR2 0x6C617232  # define LIST_TYPE_LAR2 0x6C617232
40  # define LIST_TYPE_RGN  0x72676E20  # define LIST_TYPE_RGN  0x72676E20
41  # define LIST_TYPE_RGN2 0x72676E32  # define LIST_TYPE_RGN2 0x72676E32
 # define LIST_TYPE_ART1 0x61727431  
 # define LIST_TYPE_ART2 0x61727432  
42  # define CHUNK_ID_IARL  0x4941524C  # define CHUNK_ID_IARL  0x4941524C
43  # define CHUNK_ID_IART  0x49415254  # define CHUNK_ID_IART  0x49415254
44  # define CHUNK_ID_ICMS  0x49434D53  # define CHUNK_ID_ICMS  0x49434D53
# Line 67  Line 66 
66  # define CHUNK_ID_PTBL  0x7074626C  # define CHUNK_ID_PTBL  0x7074626C
67  # define CHUNK_ID_WSMP  0x77736D70  # define CHUNK_ID_WSMP  0x77736D70
68  # define CHUNK_ID_COLH  0x636F6C68  # define CHUNK_ID_COLH  0x636F6C68
69    # define CHUNK_ID_ARTL  0x6172746C
70    # define CHUNK_ID_ART2  0x61727432
71  #else  // little endian  #else  // little endian
72    # define RIFF_TYPE_DLS  0x20736C64
73  # define LIST_TYPE_INFO 0x4F464E49  # define LIST_TYPE_INFO 0x4F464E49
74  # define LIST_TYPE_WVPL 0x6C707677  # define LIST_TYPE_WVPL 0x6C707677
75  # 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.
# Line 79  Line 81 
81  # define LIST_TYPE_LAR2 0x3272616C  # define LIST_TYPE_LAR2 0x3272616C
82  # define LIST_TYPE_RGN  0x206E6772  # define LIST_TYPE_RGN  0x206E6772
83  # define LIST_TYPE_RGN2 0x326E6772  # define LIST_TYPE_RGN2 0x326E6772
 # define LIST_TYPE_ART1 0x31747261  
 # define LIST_TYPE_ART2 0x32747261  
84  # define CHUNK_ID_IARL  0x4C524149  # define CHUNK_ID_IARL  0x4C524149
85  # define CHUNK_ID_IART  0x54524149  # define CHUNK_ID_IART  0x54524149
86  # define CHUNK_ID_ICMS  0x534D4349  # define CHUNK_ID_ICMS  0x534D4349
# Line 108  Line 108 
108  # define CHUNK_ID_PTBL  0x6C627470  # define CHUNK_ID_PTBL  0x6C627470
109  # define CHUNK_ID_WSMP  0x706D7377  # define CHUNK_ID_WSMP  0x706D7377
110  # define CHUNK_ID_COLH  0x686C6F63  # define CHUNK_ID_COLH  0x686C6F63
111    # define CHUNK_ID_ARTL  0x6C747261
112    # define CHUNK_ID_ART2  0x32747261
113  #endif // WORDS_BIGENDIAN  #endif // WORDS_BIGENDIAN
114    
115  #define WAVE_FORMAT_PCM                 0x0001  #define WAVE_FORMAT_PCM                 0x0001
116    
 #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)  
   
   
117  //TODO: no support for conditional chunks <cdl> yet  //TODO: no support for conditional chunks <cdl> yet
118    
119  /** DLS specific classes and definitions */  /** DLS specific classes and definitions */
# Line 280  namespace DLS { Line 260  namespace DLS {
260              };              };
261              Connection() {};              Connection() {};
262              void Init(conn_block_t* Header);              void Init(conn_block_t* Header);
263                conn_block_t ToConnBlock();
264              virtual ~Connection() {};              virtual ~Connection() {};
265              friend class Articulation;              friend class Articulation;
266      };      };
# Line 289  namespace DLS { Line 270  namespace DLS {
270          public:          public:
271              Connection*  pConnections; ///< Points to the beginning of a <i>Connection</i> array.              Connection*  pConnections; ///< Points to the beginning of a <i>Connection</i> array.
272              uint32_t     Connections;  ///< Reflects the number of Connections.              uint32_t     Connections;  ///< Reflects the number of Connections.
273              Articulation(RIFF::List* artList);  
274                Articulation(RIFF::Chunk* artl);
275              virtual ~Articulation();              virtual ~Articulation();
276                virtual void UpdateChunks();
277            protected:
278                RIFF::Chunk* pArticulationCk;
279                uint32_t     HeaderSize;
280      };      };
281    
282      /** 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 285  namespace DLS {
285              Articulator(RIFF::List* ParentList);              Articulator(RIFF::List* ParentList);
286              Articulation* GetFirstArticulation();              Articulation* GetFirstArticulation();
287              Articulation* GetNextArticulation();              Articulation* GetNextArticulation();
288                virtual void  UpdateChunks();
289          protected:          protected:
290              typedef std::list<Articulation*> ArticulationList;              typedef std::list<Articulation*> ArticulationList;
291              RIFF::List*                 pParentList;              RIFF::List*                 pParentList;
# Line 330  namespace DLS { Line 317  namespace DLS {
317              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.
318    
319              Info(RIFF::List* list);              Info(RIFF::List* list);
320                virtual void UpdateChunks();
321          private:          private:
322              inline void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s) {              RIFF::List* pResourceListChunk;
323                  RIFF::Chunk* ck = lstINFO->GetSubChunk(ChunkID);  
324                  if (ck) {              void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s);
325                      // TODO: no check for ZSTR terminated strings yet              void SaveString(uint32_t ChunkID, RIFF::List* lstINFO, const String& s, const String& sDefault);
                     s = (char*) ck->LoadChunkData();  
                     ck->ReleaseChunkData();  
                 }  
             }  
326      };      };
327    
328      /** 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. */
329      class Resource {      class Resource {
330          public:          public:
331              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.
332              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>.
333    
334              Resource* GetParent() { return pParent; };              Resource* GetParent() { return pParent; };
335                virtual void UpdateChunks();
336          protected:          protected:
337              Resource* pParent;              Resource* pParent;
338                RIFF::List* pResourceList;
339    
340              Resource(Resource* Parent, RIFF::List* lstResource);              Resource(Resource* Parent, RIFF::List* lstResource);
341              virtual ~Resource();              virtual ~Resource();
# Line 363  namespace DLS { Line 349  namespace DLS {
349              int32_t        Gain;              int32_t        Gain;
350              bool           NoSampleDepthTruncation;              bool           NoSampleDepthTruncation;
351              bool           NoSampleCompression;              bool           NoSampleCompression;
352              uint32_t       SampleLoops;              ///< Reflects the number of sample loops.              uint32_t       SampleLoops;  ///< Reflects the number of sample loops.
353              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.
354    
355                virtual void UpdateChunks();
356          protected:          protected:
357                RIFF::List*    pParentList;
358                uint32_t       uiHeaderSize;
359              uint32_t       SamplerOptions;              uint32_t       SamplerOptions;
360              Sampler(RIFF::List* ParentList);              Sampler(RIFF::List* ParentList);
361              virtual ~Sampler();              virtual ~Sampler();
362      };      };
363    
364      /** Encapsulates sample waves used for playback. */      /** @brief Encapsulates sample waves used for playback.
365         *
366         * In case you created a new sample with File::AddSample(), you should
367         * first call Resize() with the desired sample size. This will create
368         * the mandatory RIFF chunk which will hold the sample wave data.
369         */
370      class Sample : public Resource {      class Sample : public Resource {
371          public:          public:
372              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 WAVE_FORMAT_PCM for DLS1 compliant files).
# Line 380  namespace DLS { Line 375  namespace DLS {
375              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).
376              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.
377              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).
378              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.
379              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).
380    
381              void*         LoadSampleData();              ///< Load sample data into RAM. Returns a pointer to the data in RAM on success, <i>NULL</i> otherwise.              void*         LoadSampleData();
382              void          ReleaseSampleData();           ///< Release the samples once you used them if you don't want to be bothered to.              void          ReleaseSampleData();
383                unsigned long GetSize();
384                void          Resize(int iNewSize);
385              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);
386              unsigned long Read(void* pBuffer, unsigned long SampleCount);              unsigned long Read(void* pBuffer, unsigned long SampleCount);
387                unsigned long Write(void* pBuffer, unsigned long SampleCount);
388                virtual void  UpdateChunks();
389          protected:          protected:
390                RIFF::List*   pWaveList;
391              RIFF::Chunk*  pCkData;              RIFF::Chunk*  pCkData;
392              RIFF::Chunk*  pCkFormat;              RIFF::Chunk*  pCkFormat;
393              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
394    
395              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);
396                virtual ~Sample();
397              friend class File;              friend class File;
398              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
399      };      };
# Line 411  namespace DLS { Line 412  namespace DLS {
412              uint32_t    Channel;              uint32_t    Channel;
413    
414              Sample*     GetSample();              Sample*     GetSample();
415                void        SetSample(Sample* pSample);
416                virtual void UpdateChunks();
417          protected:          protected:
418              RIFF::List* pCkRegion;              RIFF::List* pCkRegion;
419              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
420              Sample*     pSample;            // every region refers to exactly one sample              Sample*     pSample;            // every region refers to exactly one sample
421                uint16_t    FormatOptionFlags;
422                uint16_t    WaveLinkOptionFlags;
423    
424              Region(Instrument* pInstrument, RIFF::List* rgnList);              Region(Instrument* pInstrument, RIFF::List* rgnList);
425              virtual ~Region();              virtual ~Region();
# Line 425  namespace DLS { Line 430  namespace DLS {
430      class Instrument : public Resource, public Articulator {      class Instrument : public Resource, public Articulator {
431          public:          public:
432              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.
433              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).
434              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).
435              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).
436              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 438  namespace DLS {
438    
439              Region*  GetFirstRegion();              Region*  GetFirstRegion();
440              Region*  GetNextRegion();              Region*  GetNextRegion();
441                Region*  AddRegion();
442                void     DeleteRegion(Region* pRegion);
443                virtual void UpdateChunks();
444          protected:          protected:
445              typedef std::list<Region*> RegionList;              typedef std::list<Region*> RegionList;
446              struct midi_locale_t {              struct midi_locale_t {
# Line 456  namespace DLS { Line 464  namespace DLS {
464              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>.
465              uint32_t   Instruments;           ///< Reflects the number of available <i>Instrument</i> objects.              uint32_t   Instruments;           ///< Reflects the number of available <i>Instrument</i> objects.
466    
467                File();
468              File(RIFF::File* pRIFF);              File(RIFF::File* pRIFF);
469              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.
470              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.
471                Sample*     AddSample();
472                void        DeleteSample(Sample* pSample);
473              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.
474              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.
475                Instrument* AddInstrument();
476                void        DeleteInstrument(Instrument* pInstrument);
477                virtual void UpdateChunks();
478                virtual void Save(const String& Path);
479                virtual void Save();
480              virtual ~File();              virtual ~File();
481          protected:          protected:
482              typedef std::list<Sample*>     SampleList;              typedef std::list<Sample*>     SampleList;
# Line 471  namespace DLS { Line 487  namespace DLS {
487              SampleList::iterator     SamplesIterator;              SampleList::iterator     SamplesIterator;
488              InstrumentList*          pInstruments;              InstrumentList*          pInstruments;
489              InstrumentList::iterator InstrumentsIterator;              InstrumentList::iterator InstrumentsIterator;
490                uint32_t                 WavePoolHeaderSize;
491              uint32_t                 WavePoolCount;              uint32_t                 WavePoolCount;
492              uint32_t*                pWavePoolTable;              uint32_t*                pWavePoolTable;
493              uint32_t*                pWavePoolTableHi;              uint32_t*                pWavePoolTableHi;
494                bool                     b64BitWavePoolOffsets;
495    
496              void LoadSamples();              void LoadSamples();
497              void LoadInstruments();              void LoadInstruments();
498                void __ensureMandatoryChunksExist();
499              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
500            private:
501                void __UpdateWavePoolTableChunk();
502                void __UpdateWavePoolTable();
503      };      };
504    
505      /** Will be thrown whenever a DLS specific error occurs while trying to access a DLS File. */      /** Will be thrown whenever a DLS specific error occurs while trying to access a DLS File. */

Legend:
Removed from v.799  
changed lines
  Added in v.800

  ViewVC Help
Powered by ViewVC