/[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 2922 by schoenebeck, Wed May 18 18:04:49 2016 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-2016 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        typedef RIFF::file_offset_t file_offset_t;
109    
110      /** Quadtuple version number ("major.minor.release.build"). */      /** Quadtuple version number ("major.minor.release.build"). */
111      struct version_t {      struct version_t {
# Line 215  namespace DLS { Line 201  namespace DLS {
201          conn_trn_convex  = 0x0002,          conn_trn_convex  = 0x0002,
202          conn_trn_switch  = 0x0003          conn_trn_switch  = 0x0003
203      } conn_trn_t;      } conn_trn_t;
204        
205      /** Lower and upper limit of a range. */      /** Lower and upper limit of a range. */
206      struct range_t {      struct range_t {
207          uint16_t low;  ///< Low value of range.          uint16_t low;  ///< Low value of range.
208          uint16_t high; ///< High value of range.          uint16_t high; ///< High value of range.
209    
210            inline bool operator< (const range_t& other) const {
211                if (low < other.low) return true;
212                if (low > other.low) return false;
213                return high < other.high;
214            }
215    
216            inline bool operator== (const range_t& other) const {
217                return low == other.low && high == other.high;
218            }
219    
220            inline bool overlaps(uint16_t scalar) const {
221                return low <= scalar && scalar <= high;
222            }
223    
224            inline bool overlaps(const range_t& other) const {
225                return overlaps(other.low) || overlaps(other.high) ||
226                       other.overlaps(low) || other.overlaps(high);
227            }
228      };      };
229    
230      /** Defines Sample Loop Points. */      /** Defines Sample Loop Points. */
# Line 258  namespace DLS { Line 263  namespace DLS {
263                  uint16_t transform;                  uint16_t transform;
264                  uint32_t scale;                  uint32_t scale;
265              };              };
266              Connection() {};              Connection() {}
267              void Init(conn_block_t* Header);              void Init(conn_block_t* Header);
268              conn_block_t ToConnBlock();              conn_block_t ToConnBlock();
269              virtual ~Connection() {};              virtual ~Connection() {}
270              friend class Articulation;              friend class Articulation;
271      };      };
272    
# Line 273  namespace DLS { Line 278  namespace DLS {
278    
279              Articulation(RIFF::Chunk* artl);              Articulation(RIFF::Chunk* artl);
280              virtual ~Articulation();              virtual ~Articulation();
281              virtual void UpdateChunks();              virtual void UpdateChunks(progress_t* pProgress);
282          protected:          protected:
283              RIFF::Chunk* pArticulationCk;              RIFF::Chunk* pArticulationCk;
284              uint32_t     HeaderSize;              uint32_t     HeaderSize;
# Line 285  namespace DLS { Line 290  namespace DLS {
290              Articulator(RIFF::List* ParentList);              Articulator(RIFF::List* ParentList);
291              Articulation* GetFirstArticulation();              Articulation* GetFirstArticulation();
292              Articulation* GetNextArticulation();              Articulation* GetNextArticulation();
293              virtual void  UpdateChunks();              virtual void  UpdateChunks(progress_t* pProgress);
294                virtual void  CopyAssign(const Articulator* orig);
295          protected:          protected:
296              typedef std::list<Articulation*> ArticulationList;              typedef std::list<Articulation*> ArticulationList;
297              RIFF::List*                 pParentList;              RIFF::List*                 pParentList;
# Line 316  namespace DLS { Line 322  namespace DLS {
322              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>.
323              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.
324              String Subject;          ///< <ISBJ-ck>. Describes the contents of the file.              String Subject;          ///< <ISBJ-ck>. Describes the contents of the file.
325              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.
326    
327                struct string_length_t {
328                    uint32_t chunkId;
329                    int      length;
330                };
331    
332              Info(RIFF::List* list);              Info(RIFF::List* list);
333                void SetFixedStringLengths(const string_length_t* lengths);
334              virtual ~Info();              virtual ~Info();
335              virtual void UpdateChunks();              virtual void UpdateChunks(progress_t* pProgress);
336                virtual void CopyAssign(const Info* orig);
337          private:          private:
338              RIFF::List* pResourceListChunk;              RIFF::List*            pResourceListChunk;
339                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.
340    
341              static void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s);              static void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s);
342              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);
343      };      };
344    
345      /** 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 348  namespace DLS {
348              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.
349              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>.
350    
351              Resource* GetParent() { return pParent; };              Resource* GetParent() { return pParent; }
352              virtual void UpdateChunks();              const Resource* GetParent() const { return pParent; }
353                virtual void UpdateChunks(progress_t* pProgress);
354                void GenerateDLSID();
355                virtual void CopyAssign(const Resource* orig);
356          protected:          protected:
357              Resource* pParent;              Resource* pParent;
358              RIFF::List* pResourceList;              RIFF::List* pResourceList;
# Line 349  namespace DLS { Line 366  namespace DLS {
366          public:          public:
367              uint8_t        UnityNote;              uint8_t        UnityNote;
368              int16_t        FineTune;              int16_t        FineTune;
369              int32_t        Gain;              int32_t        Gain; ///< @deprecated Don't alter directly, use SetGain() instead!
370              bool           NoSampleDepthTruncation;              bool           NoSampleDepthTruncation;
371              bool           NoSampleCompression;              bool           NoSampleCompression;
372              uint32_t       SampleLoops;  ///< Reflects the number of sample loops.              uint32_t       SampleLoops;  ///< Reflects the number of sample loops.
# Line 357  namespace DLS { Line 374  namespace DLS {
374    
375              void AddSampleLoop(sample_loop_t* pLoopDef);              void AddSampleLoop(sample_loop_t* pLoopDef);
376              void DeleteSampleLoop(sample_loop_t* pLoopDef);              void DeleteSampleLoop(sample_loop_t* pLoopDef);
377              virtual void UpdateChunks();              virtual void SetGain(int32_t gain);
378                virtual void UpdateChunks(progress_t* pProgress);
379                virtual void CopyAssign(const Sampler* orig);
380          protected:          protected:
381              RIFF::List*    pParentList;              RIFF::List*    pParentList;
382              uint32_t       uiHeaderSize;              uint32_t       uiHeaderSize;
# Line 382  namespace DLS { Line 401  namespace DLS {
401              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).
402              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.
403              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).
404              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.              file_offset_t SamplesTotal;          ///< Reflects total number of sample points (only if known sample data format is used, 0 otherwise), do not bother to change this value, it will not be saved.
405              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().              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().
406    
407              void*         LoadSampleData();              void*         LoadSampleData();
408              void          ReleaseSampleData();              void          ReleaseSampleData();
409              unsigned long GetSize();              file_offset_t GetSize() const;
410              void          Resize(int iNewSize);              void          Resize(file_offset_t NewSize);
411              unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);              file_offset_t SetPos(file_offset_t SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
412              unsigned long Read(void* pBuffer, unsigned long SampleCount);              file_offset_t Read(void* pBuffer, file_offset_t SampleCount);
413              unsigned long Write(void* pBuffer, unsigned long SampleCount);              file_offset_t Write(void* pBuffer, file_offset_t SampleCount);
414              virtual void  UpdateChunks();              virtual void  UpdateChunks(progress_t* pProgress);
415                virtual void  CopyAssign(const Sample* orig);
416    
417          protected:          protected:
418              RIFF::List*   pWaveList;              RIFF::List*   pWaveList;
419              RIFF::Chunk*  pCkData;              RIFF::Chunk*  pCkData;
420              RIFF::Chunk*  pCkFormat;              RIFF::Chunk*  pCkFormat;
421              unsigned long ulWavePoolOffset;  // needed for comparison with the wave pool link table, thus the link to instruments              file_offset_t ullWavePoolOffset;  // needed for comparison with the wave pool link table, thus the link to instruments
422    
423              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);              Sample(File* pFile, RIFF::List* waveList, file_offset_t WavePoolOffset);
424              virtual ~Sample();              virtual ~Sample();
425                void CopyAssignCore(const Sample* orig);
426              friend class File;              friend class File;
427              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
428      };      };
# Line 408  namespace DLS { Line 430  namespace DLS {
430      /** Defines <i>Region</i> information of an <i>Instrument</i>. */      /** Defines <i>Region</i> information of an <i>Instrument</i>. */
431      class Region : public Resource, public Articulator, public Sampler {      class Region : public Resource, public Articulator, public Sampler {
432          public:          public:
433              range_t     KeyRange;              range_t     KeyRange; ///< @deprecated Only read, don't write! Use SetKeyRange() instead.
434              range_t     VelocityRange;              range_t     VelocityRange;
435              uint16_t    KeyGroup;              uint16_t    KeyGroup;
436              uint16_t    Layer;              uint16_t    Layer;
# Line 420  namespace DLS { Line 442  namespace DLS {
442    
443              Sample*     GetSample();              Sample*     GetSample();
444              void        SetSample(Sample* pSample);              void        SetSample(Sample* pSample);
445              virtual void UpdateChunks();              virtual void SetKeyRange(uint16_t Low, uint16_t High);
446                virtual void UpdateChunks(progress_t* pProgress);
447                virtual void CopyAssign(const Region* orig);
448          protected:          protected:
449              RIFF::List* pCkRegion;              RIFF::List* pCkRegion;
450              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 470  namespace DLS {
470              Region*  GetFirstRegion();              Region*  GetFirstRegion();
471              Region*  GetNextRegion();              Region*  GetNextRegion();
472              Region*  AddRegion();              Region*  AddRegion();
             void     MoveRegion(Region* pSrc, Region* pDst);  
473              void     DeleteRegion(Region* pRegion);              void     DeleteRegion(Region* pRegion);
474              virtual void UpdateChunks();              virtual void UpdateChunks(progress_t* pProgress);
475                virtual void CopyAssign(const Instrument* orig);
476          protected:          protected:
477              typedef std::list<Region*> RegionList;              typedef std::list<Region*> RegionList;
478              struct midi_locale_t {              struct midi_locale_t {
# Line 461  namespace DLS { Line 485  namespace DLS {
485              RegionList::iterator RegionsIterator;              RegionList::iterator RegionsIterator;
486    
487              Instrument(File* pFile, RIFF::List* insList);              Instrument(File* pFile, RIFF::List* insList);
488                void CopyAssignCore(const Instrument* orig);
489              virtual void LoadRegions();              virtual void LoadRegions();
490              virtual ~Instrument();              virtual ~Instrument();
491              friend class File;              friend class File;
492                friend class Region;
493            private:
494                void MoveRegion(Region* pSrc, Region* pDst);
495      };      };
496    
497      /** 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 502  namespace DLS {
502    
503              File();              File();
504              File(RIFF::File* pRIFF);              File(RIFF::File* pRIFF);
505                String      GetFileName();
506                void        SetFileName(const String& name);
507              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.
508              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.
509              Sample*     AddSample();              Sample*     AddSample();
# Line 482  namespace DLS { Line 512  namespace DLS {
512              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.
513              Instrument* AddInstrument();              Instrument* AddInstrument();
514              void        DeleteInstrument(Instrument* pInstrument);              void        DeleteInstrument(Instrument* pInstrument);
515              virtual void UpdateChunks();              RIFF::File* GetExtensionFile(int index);
516              virtual void Save(const String& Path);              virtual void UpdateChunks(progress_t* pProgress);
517              virtual void Save();              virtual void Save(const String& Path, progress_t* pProgress = NULL);
518                virtual void Save(progress_t* pProgress = NULL);
519              virtual ~File();              virtual ~File();
520          protected:          protected:
521              typedef std::list<Sample*>     SampleList;              typedef std::list<Sample*>     SampleList;
# Line 504  namespace DLS { Line 535  namespace DLS {
535    
536              virtual void LoadSamples();              virtual void LoadSamples();
537              virtual void LoadInstruments();              virtual void LoadInstruments();
538                virtual void UpdateFileOffsets();
539              void __ensureMandatoryChunksExist();              void __ensureMandatoryChunksExist();
540              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
541          private:          private:
Legend:
Removed from v.1154  
changed lines
  Added in v.2922
  ViewVC Help
Powered by ViewVC