/[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 823 by schoenebeck, Fri Dec 23 01:38:50 2005 UTC revision 2482 by schoenebeck, Mon Nov 25 02:22:38 2013 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-2013 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 28  Line 28 
28    
29  #if WORDS_BIGENDIAN  #if WORDS_BIGENDIAN
30  # define RIFF_TYPE_DLS  0x444C5320  # define RIFF_TYPE_DLS  0x444C5320
 # define LIST_TYPE_INFO 0x494E464F  
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 42  Line 41 
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 70  Line 62 
62  # define CHUNK_ID_ART2  0x61727432  # define CHUNK_ID_ART2  0x61727432
63  #else  // little endian  #else  // little endian
64  # define RIFF_TYPE_DLS  0x20534C44  # define RIFF_TYPE_DLS  0x20534C44
 # define LIST_TYPE_INFO 0x4F464E49  
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 84  Line 75 
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 112  Line 96 
96  # define CHUNK_ID_ART2  0x32747261  # 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
100    
101  //TODO: no support for conditional chunks <cdl> yet  //TODO: no support for conditional chunks <cdl> yet
102    
# Line 224  namespace DLS { Line 208  namespace DLS {
208    
209      /** Defines Sample Loop Points. */      /** Defines Sample Loop Points. */
210      struct sample_loop_t {      struct sample_loop_t {
211          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!
212          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).
213          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.
214          uint32_t LoopLength;          uint32_t LoopLength; ///< Length of the looping area (in sample points).
215      };      };
216    
217      // just symbol prototyping      // just symbol prototyping
# Line 258  namespace DLS { Line 242  namespace DLS {
242                  uint16_t transform;                  uint16_t transform;
243                  uint32_t scale;                  uint32_t scale;
244              };              };
245              Connection() {};              Connection() {}
246              void Init(conn_block_t* Header);              void Init(conn_block_t* Header);
247              conn_block_t ToConnBlock();              conn_block_t ToConnBlock();
248              virtual ~Connection() {};              virtual ~Connection() {}
249              friend class Articulation;              friend class Articulation;
250      };      };
251    
# Line 286  namespace DLS { Line 270  namespace DLS {
270              Articulation* GetFirstArticulation();              Articulation* GetFirstArticulation();
271              Articulation* GetNextArticulation();              Articulation* GetNextArticulation();
272              virtual void  UpdateChunks();              virtual void  UpdateChunks();
273                virtual void  CopyAssign(const Articulator* orig);
274          protected:          protected:
275              typedef std::list<Articulation*> ArticulationList;              typedef std::list<Articulation*> ArticulationList;
276              RIFF::List*                 pParentList;              RIFF::List*                 pParentList;
# Line 315  namespace DLS { Line 300  namespace DLS {
300              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.
301              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>.
302              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.
303                String Subject;          ///< <ISBJ-ck>. Describes the contents of the file.
304                bool UseFixedLengthStrings; ///< @deprecated Not used anymore, use SetFixedStringLengths() instead.
305    
306                struct string_length_t {
307                    uint32_t chunkId;
308                    int      length;
309                };
310    
311              Info(RIFF::List* list);              Info(RIFF::List* list);
312                void SetFixedStringLengths(const string_length_t* lengths);
313              virtual ~Info();              virtual ~Info();
314              virtual void UpdateChunks();              virtual void UpdateChunks();
315                virtual void CopyAssign(const Info* orig);
316          private:          private:
317              RIFF::List* pResourceListChunk;              RIFF::List*            pResourceListChunk;
318                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.
319    
320              void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s);              static void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s);
321              void SaveString(uint32_t ChunkID, RIFF::List* lstINFO, const String& s, const String& sDefault);              void SaveString(uint32_t ChunkID, RIFF::List* lstINFO, const String& s, const String& sDefault);
322      };      };
323    
# Line 332  namespace DLS { Line 327  namespace DLS {
327              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.
328              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>.
329    
330              Resource* GetParent() { return pParent; };              Resource* GetParent() { return pParent; }
331                const Resource* GetParent() const { return pParent; }
332              virtual void UpdateChunks();              virtual void UpdateChunks();
333                void GenerateDLSID();
334                virtual void CopyAssign(const Resource* orig);
335          protected:          protected:
336              Resource* pParent;              Resource* pParent;
337              RIFF::List* pResourceList;              RIFF::List* pResourceList;
# Line 347  namespace DLS { Line 345  namespace DLS {
345          public:          public:
346              uint8_t        UnityNote;              uint8_t        UnityNote;
347              int16_t        FineTune;              int16_t        FineTune;
348              int32_t        Gain;              int32_t        Gain; ///< @deprecated Don't alter directly, use SetGain() instead!
349              bool           NoSampleDepthTruncation;              bool           NoSampleDepthTruncation;
350              bool           NoSampleCompression;              bool           NoSampleCompression;
351              uint32_t       SampleLoops;  ///< Reflects the number of sample loops.              uint32_t       SampleLoops;  ///< Reflects the number of sample loops.
352              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.
353    
354                void AddSampleLoop(sample_loop_t* pLoopDef);
355                void DeleteSampleLoop(sample_loop_t* pLoopDef);
356                virtual void SetGain(int32_t gain);
357              virtual void UpdateChunks();              virtual void UpdateChunks();
358                virtual void CopyAssign(const Sampler* orig);
359          protected:          protected:
360              RIFF::List*    pParentList;              RIFF::List*    pParentList;
361              uint32_t       uiHeaderSize;              uint32_t       uiHeaderSize;
# Line 372  namespace DLS { Line 374  namespace DLS {
374       */       */
375      class Sample : public Resource {      class Sample : public Resource {
376          public:          public:
377              uint16_t      FormatTag;             ///< Format ID of the waveform data (should be WAVE_FORMAT_PCM for DLS1 compliant files, this is also the default value if Sample was created with Instrument::AddSample()).              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()).
378              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).              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).
379              uint32_t      SamplesPerSecond;      ///< Sampling rate at which each channel should be played (defaults to 44100 if Sample was created with Instrument::AddSample() previously).              uint32_t      SamplesPerSecond;      ///< Sampling rate at which each channel should be played (defaults to 44100 if Sample was created with Instrument::AddSample() previously).
380              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).
# Line 383  namespace DLS { Line 385  namespace DLS {
385    
386              void*         LoadSampleData();              void*         LoadSampleData();
387              void          ReleaseSampleData();              void          ReleaseSampleData();
388              unsigned long GetSize();              unsigned long GetSize() const;
389              void          Resize(int iNewSize);              void          Resize(int iNewSize);
390              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);
391              unsigned long Read(void* pBuffer, unsigned long SampleCount);              unsigned long Read(void* pBuffer, unsigned long SampleCount);
392              unsigned long Write(void* pBuffer, unsigned long SampleCount);              unsigned long Write(void* pBuffer, unsigned long SampleCount);
393              virtual void  UpdateChunks();              virtual void  UpdateChunks();
394                virtual void  CopyAssign(const Sample* orig);
395          protected:          protected:
396              RIFF::List*   pWaveList;              RIFF::List*   pWaveList;
397              RIFF::Chunk*  pCkData;              RIFF::Chunk*  pCkData;
# Line 397  namespace DLS { Line 400  namespace DLS {
400    
401              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);
402              virtual ~Sample();              virtual ~Sample();
403                void CopyAssignCore(const Sample* orig);
404              friend class File;              friend class File;
405              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
406      };      };
# Line 404  namespace DLS { Line 408  namespace DLS {
408      /** Defines <i>Region</i> information of an <i>Instrument</i>. */      /** Defines <i>Region</i> information of an <i>Instrument</i>. */
409      class Region : public Resource, public Articulator, public Sampler {      class Region : public Resource, public Articulator, public Sampler {
410          public:          public:
411              range_t     KeyRange;              range_t     KeyRange; ///< @deprecated Only read, don't write! Use SetKeyRange() instead.
412              range_t     VelocityRange;              range_t     VelocityRange;
413              uint16_t    KeyGroup;              uint16_t    KeyGroup;
414              uint16_t    Layer;              uint16_t    Layer;
# Line 416  namespace DLS { Line 420  namespace DLS {
420    
421              Sample*     GetSample();              Sample*     GetSample();
422              void        SetSample(Sample* pSample);              void        SetSample(Sample* pSample);
423                virtual void SetKeyRange(uint16_t Low, uint16_t High);
424              virtual void UpdateChunks();              virtual void UpdateChunks();
425                virtual void CopyAssign(const Region* orig);
426          protected:          protected:
427              RIFF::List* pCkRegion;              RIFF::List* pCkRegion;
428              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
# Line 444  namespace DLS { Line 450  namespace DLS {
450              Region*  AddRegion();              Region*  AddRegion();
451              void     DeleteRegion(Region* pRegion);              void     DeleteRegion(Region* pRegion);
452              virtual void UpdateChunks();              virtual void UpdateChunks();
453                virtual void CopyAssign(const Instrument* orig);
454          protected:          protected:
455              typedef std::list<Region*> RegionList;              typedef std::list<Region*> RegionList;
456              struct midi_locale_t {              struct midi_locale_t {
# Line 456  namespace DLS { Line 463  namespace DLS {
463              RegionList::iterator RegionsIterator;              RegionList::iterator RegionsIterator;
464    
465              Instrument(File* pFile, RIFF::List* insList);              Instrument(File* pFile, RIFF::List* insList);
466                void CopyAssignCore(const Instrument* orig);
467              virtual void LoadRegions();              virtual void LoadRegions();
468              virtual ~Instrument();              virtual ~Instrument();
469              friend class File;              friend class File;
470                friend class Region;
471            private:
472                void MoveRegion(Region* pSrc, Region* pDst);
473      };      };
474    
475      /** 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 469  namespace DLS { Line 480  namespace DLS {
480    
481              File();              File();
482              File(RIFF::File* pRIFF);              File(RIFF::File* pRIFF);
483                String      GetFileName();
484                void        SetFileName(const String& name);
485              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.
486              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.
487              Sample*     AddSample();              Sample*     AddSample();
# Line 477  namespace DLS { Line 490  namespace DLS {
490              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.
491              Instrument* AddInstrument();              Instrument* AddInstrument();
492              void        DeleteInstrument(Instrument* pInstrument);              void        DeleteInstrument(Instrument* pInstrument);
493                RIFF::File* GetExtensionFile(int index);
494              virtual void UpdateChunks();              virtual void UpdateChunks();
495              virtual void Save(const String& Path);              virtual void Save(const String& Path);
496              virtual void Save();              virtual void Save();
# Line 486  namespace DLS { Line 500  namespace DLS {
500              typedef std::list<Instrument*> InstrumentList;              typedef std::list<Instrument*> InstrumentList;
501    
502              RIFF::File*              pRIFF;              RIFF::File*              pRIFF;
503                std::list<RIFF::File*>   ExtensionFiles;
504              SampleList*              pSamples;              SampleList*              pSamples;
505              SampleList::iterator     SamplesIterator;              SampleList::iterator     SamplesIterator;
506              InstrumentList*          pInstruments;              InstrumentList*          pInstruments;
# Line 505  namespace DLS { Line 520  namespace DLS {
520              void __UpdateWavePoolTable();              void __UpdateWavePoolTable();
521      };      };
522    
523      /** Will be thrown whenever a DLS specific error occurs while trying to access a DLS File. */      /**
524         * Will be thrown whenever a DLS specific error occurs while trying to
525         * access a DLS File. Note: In your application you should better catch
526         * for RIFF::Exception rather than this one, except you explicitly want
527         * to catch and handle DLS::Exception and RIFF::Exception independently,
528         * which usually shouldn't be necessary though.
529         */
530      class Exception : public RIFF::Exception {      class Exception : public RIFF::Exception {
531          public:          public:
532              Exception(String Message);              Exception(String Message);
Legend:
Removed from v.823  
changed lines
  Added in v.2482
  ViewVC Help
Powered by ViewVC