/[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 1154 by schoenebeck, Wed Apr 11 16:33:56 2007 UTC revision 2682 by schoenebeck, Mon Dec 29 16:25:51 2014 UTC
# Line 2  Line 2 
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file access library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003-2007 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 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  0x44454D49  # 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 120  Line 104 
104  namespace DLS {  namespace DLS {
105    
106      typedef std::string String;      typedef std::string String;
107        typedef RIFF::progress_t progress_t;
108    
109      /** Quadtuple version number ("major.minor.release.build"). */      /** Quadtuple version number ("major.minor.release.build"). */
110      struct version_t {      struct version_t {
# Line 215  namespace DLS { Line 200  namespace DLS {
200          conn_trn_convex  = 0x0002,          conn_trn_convex  = 0x0002,
201          conn_trn_switch  = 0x0003          conn_trn_switch  = 0x0003
202      } conn_trn_t;      } conn_trn_t;
203        
204      /** Lower and upper limit of a range. */      /** Lower and upper limit of a range. */
205      struct range_t {      struct range_t {
206          uint16_t low;  ///< Low value of range.          uint16_t low;  ///< Low value of range.
207          uint16_t high; ///< High value of range.          uint16_t high; ///< High value of range.
208    
209            inline bool operator< (const range_t& other) const {
210                if (low < other.low) return true;
211                if (low > other.low) return false;
212                return high < other.high;
213            }
214    
215            inline bool operator== (const range_t& other) const {
216                return low == other.low && high == other.high;
217            }
218    
219            inline bool overlaps(uint16_t scalar) const {
220                return low <= scalar && scalar <= high;
221            }
222    
223            inline bool overlaps(const range_t& other) const {
224                return overlaps(other.low) || overlaps(other.high) ||
225                       other.overlaps(low) || other.overlaps(high);
226            }
227      };      };
228    
229      /** Defines Sample Loop Points. */      /** Defines Sample Loop Points. */
# Line 258  namespace DLS { Line 262  namespace DLS {
262                  uint16_t transform;                  uint16_t transform;
263                  uint32_t scale;                  uint32_t scale;
264              };              };
265              Connection() {};              Connection() {}
266              void Init(conn_block_t* Header);              void Init(conn_block_t* Header);
267              conn_block_t ToConnBlock();              conn_block_t ToConnBlock();
268              virtual ~Connection() {};              virtual ~Connection() {}
269              friend class Articulation;              friend class Articulation;
270      };      };
271    
# Line 273  namespace DLS { Line 277  namespace DLS {
277    
278              Articulation(RIFF::Chunk* artl);              Articulation(RIFF::Chunk* artl);
279              virtual ~Articulation();              virtual ~Articulation();
280              virtual void UpdateChunks();              virtual void UpdateChunks(progress_t* pProgress);
281          protected:          protected:
282              RIFF::Chunk* pArticulationCk;              RIFF::Chunk* pArticulationCk;
283              uint32_t     HeaderSize;              uint32_t     HeaderSize;
# Line 285  namespace DLS { Line 289  namespace DLS {
289              Articulator(RIFF::List* ParentList);              Articulator(RIFF::List* ParentList);
290              Articulation* GetFirstArticulation();              Articulation* GetFirstArticulation();
291              Articulation* GetNextArticulation();              Articulation* GetNextArticulation();
292              virtual void  UpdateChunks();              virtual void  UpdateChunks(progress_t* pProgress);
293                virtual void  CopyAssign(const Articulator* orig);
294          protected:          protected:
295              typedef std::list<Articulation*> ArticulationList;              typedef std::list<Articulation*> ArticulationList;
296              RIFF::List*                 pParentList;              RIFF::List*                 pParentList;
# Line 316  namespace DLS { Line 321  namespace DLS {
321              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>.
322              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.
323              String Subject;          ///< <ISBJ-ck>. Describes the contents of the file.              String Subject;          ///< <ISBJ-ck>. Describes the contents of the file.
324              bool UseFixedLengthStrings; ///< Set this to true if the info strings should be stored with a fixed length format. This is used for gig files, not for ordinary DLS files.              bool UseFixedLengthStrings; ///< @deprecated Not used anymore, use SetFixedStringLengths() instead.
325    
326                struct string_length_t {
327                    uint32_t chunkId;
328                    int      length;
329                };
330    
331              Info(RIFF::List* list);              Info(RIFF::List* list);
332                void SetFixedStringLengths(const string_length_t* lengths);
333              virtual ~Info();              virtual ~Info();
334              virtual void UpdateChunks();              virtual void UpdateChunks(progress_t* pProgress);
335                virtual void CopyAssign(const Info* orig);
336          private:          private:
337              RIFF::List* pResourceListChunk;              RIFF::List*            pResourceListChunk;
338                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.
339    
340              static void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s);              static void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s);
341              static void SaveString(uint32_t ChunkID, RIFF::List* lstINFO, const String& s, const String& sDefault, bool bUseFixedLengthStrings, int size);              void SaveString(uint32_t ChunkID, RIFF::List* lstINFO, const String& s, const String& sDefault);
342      };      };
343    
344      /** 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. */
# Line 334  namespace DLS { Line 347  namespace DLS {
347              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.
348              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>.
349    
350              Resource* GetParent() { return pParent; };              Resource* GetParent() { return pParent; }
351              virtual void UpdateChunks();              const Resource* GetParent() const { return pParent; }
352                virtual void UpdateChunks(progress_t* pProgress);
353                void GenerateDLSID();
354                virtual void CopyAssign(const Resource* orig);
355          protected:          protected:
356              Resource* pParent;              Resource* pParent;
357              RIFF::List* pResourceList;              RIFF::List* pResourceList;
# Line 349  namespace DLS { Line 365  namespace DLS {
365          public:          public:
366              uint8_t        UnityNote;              uint8_t        UnityNote;
367              int16_t        FineTune;              int16_t        FineTune;
368              int32_t        Gain;              int32_t        Gain; ///< @deprecated Don't alter directly, use SetGain() instead!
369              bool           NoSampleDepthTruncation;              bool           NoSampleDepthTruncation;
370              bool           NoSampleCompression;              bool           NoSampleCompression;
371              uint32_t       SampleLoops;  ///< Reflects the number of sample loops.              uint32_t       SampleLoops;  ///< Reflects the number of sample loops.
# Line 357  namespace DLS { Line 373  namespace DLS {
373    
374              void AddSampleLoop(sample_loop_t* pLoopDef);              void AddSampleLoop(sample_loop_t* pLoopDef);
375              void DeleteSampleLoop(sample_loop_t* pLoopDef);              void DeleteSampleLoop(sample_loop_t* pLoopDef);
376              virtual void UpdateChunks();              virtual void SetGain(int32_t gain);
377                virtual void UpdateChunks(progress_t* pProgress);
378                virtual void CopyAssign(const Sampler* orig);
379          protected:          protected:
380              RIFF::List*    pParentList;              RIFF::List*    pParentList;
381              uint32_t       uiHeaderSize;              uint32_t       uiHeaderSize;
# Line 387  namespace DLS { Line 405  namespace DLS {
405    
406              void*         LoadSampleData();              void*         LoadSampleData();
407              void          ReleaseSampleData();              void          ReleaseSampleData();
408              unsigned long GetSize();              unsigned long GetSize() const;
409              void          Resize(int iNewSize);              void          Resize(int iNewSize);
410              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);
411              unsigned long Read(void* pBuffer, unsigned long SampleCount);              unsigned long Read(void* pBuffer, unsigned long SampleCount);
412              unsigned long Write(void* pBuffer, unsigned long SampleCount);              unsigned long Write(void* pBuffer, unsigned long SampleCount);
413              virtual void  UpdateChunks();              virtual void  UpdateChunks(progress_t* pProgress);
414                virtual void  CopyAssign(const Sample* orig);
415          protected:          protected:
416              RIFF::List*   pWaveList;              RIFF::List*   pWaveList;
417              RIFF::Chunk*  pCkData;              RIFF::Chunk*  pCkData;
# Line 401  namespace DLS { Line 420  namespace DLS {
420    
421              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);
422              virtual ~Sample();              virtual ~Sample();
423                void CopyAssignCore(const Sample* orig);
424              friend class File;              friend class File;
425              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
426      };      };
# Line 408  namespace DLS { Line 428  namespace DLS {
428      /** Defines <i>Region</i> information of an <i>Instrument</i>. */      /** Defines <i>Region</i> information of an <i>Instrument</i>. */
429      class Region : public Resource, public Articulator, public Sampler {      class Region : public Resource, public Articulator, public Sampler {
430          public:          public:
431              range_t     KeyRange;              range_t     KeyRange; ///< @deprecated Only read, don't write! Use SetKeyRange() instead.
432              range_t     VelocityRange;              range_t     VelocityRange;
433              uint16_t    KeyGroup;              uint16_t    KeyGroup;
434              uint16_t    Layer;              uint16_t    Layer;
# Line 420  namespace DLS { Line 440  namespace DLS {
440    
441              Sample*     GetSample();              Sample*     GetSample();
442              void        SetSample(Sample* pSample);              void        SetSample(Sample* pSample);
443              virtual void UpdateChunks();              virtual void SetKeyRange(uint16_t Low, uint16_t High);
444                virtual void UpdateChunks(progress_t* pProgress);
445                virtual void CopyAssign(const Region* orig);
446          protected:          protected:
447              RIFF::List* pCkRegion;              RIFF::List* pCkRegion;
448              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 446  namespace DLS { Line 468  namespace DLS {
468              Region*  GetFirstRegion();              Region*  GetFirstRegion();
469              Region*  GetNextRegion();              Region*  GetNextRegion();
470              Region*  AddRegion();              Region*  AddRegion();
             void     MoveRegion(Region* pSrc, Region* pDst);  
471              void     DeleteRegion(Region* pRegion);              void     DeleteRegion(Region* pRegion);
472              virtual void UpdateChunks();              virtual void UpdateChunks(progress_t* pProgress);
473                virtual void CopyAssign(const Instrument* orig);
474          protected:          protected:
475              typedef std::list<Region*> RegionList;              typedef std::list<Region*> RegionList;
476              struct midi_locale_t {              struct midi_locale_t {
# Line 461  namespace DLS { Line 483  namespace DLS {
483              RegionList::iterator RegionsIterator;              RegionList::iterator RegionsIterator;
484    
485              Instrument(File* pFile, RIFF::List* insList);              Instrument(File* pFile, RIFF::List* insList);
486                void CopyAssignCore(const Instrument* orig);
487              virtual void LoadRegions();              virtual void LoadRegions();
488              virtual ~Instrument();              virtual ~Instrument();
489              friend class File;              friend class File;
490                friend class Region;
491            private:
492                void MoveRegion(Region* pSrc, Region* pDst);
493      };      };
494    
495      /** 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 474  namespace DLS { Line 500  namespace DLS {
500    
501              File();              File();
502              File(RIFF::File* pRIFF);              File(RIFF::File* pRIFF);
503                String      GetFileName();
504                void        SetFileName(const String& name);
505              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.
506              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.
507              Sample*     AddSample();              Sample*     AddSample();
# Line 482  namespace DLS { Line 510  namespace DLS {
510              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.
511              Instrument* AddInstrument();              Instrument* AddInstrument();
512              void        DeleteInstrument(Instrument* pInstrument);              void        DeleteInstrument(Instrument* pInstrument);
513              virtual void UpdateChunks();              RIFF::File* GetExtensionFile(int index);
514              virtual void Save(const String& Path);              virtual void UpdateChunks(progress_t* pProgress);
515              virtual void Save();              virtual void Save(const String& Path, progress_t* pProgress = NULL);
516                virtual void Save(progress_t* pProgress = NULL);
517              virtual ~File();              virtual ~File();
518          protected:          protected:
519              typedef std::list<Sample*>     SampleList;              typedef std::list<Sample*>     SampleList;
# Line 504  namespace DLS { Line 533  namespace DLS {
533    
534              virtual void LoadSamples();              virtual void LoadSamples();
535              virtual void LoadInstruments();              virtual void LoadInstruments();
536                virtual void UpdateFileOffsets();
537              void __ensureMandatoryChunksExist();              void __ensureMandatoryChunksExist();
538              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
539          private:          private:
Legend:
Removed from v.1154  
changed lines
  Added in v.2682
  ViewVC Help
Powered by ViewVC