/[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 1180 by persson, Sat May 12 12:39:25 2007 UTC revision 2547 by schoenebeck, Tue May 13 11:17:24 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 220  namespace DLS { Line 204  namespace DLS {
204      struct range_t {      struct range_t {
205          uint16_t low;  ///< Low value of range.          uint16_t low;  ///< Low value of range.
206          uint16_t high; ///< High value of range.          uint16_t high; ///< High value of range.
207    
208            inline bool operator< (const range_t& other) const {
209                if (low < other.low) return true;
210                if (low > other.low) return false;
211                return high < other.high;
212            }
213    
214            inline bool operator== (const range_t& other) const {
215                return low == other.low && high == other.high;
216            }
217    
218            inline bool overlaps(uint16_t scalar) const {
219                return low <= scalar && scalar <= high;
220            }
221    
222            inline bool overlaps(const range_t& other) const {
223                return overlaps(other.low) || overlaps(other.high) ||
224                       other.overlaps(low) || other.overlaps(high);
225            }
226      };      };
227    
228      /** Defines Sample Loop Points. */      /** Defines Sample Loop Points. */
# Line 258  namespace DLS { Line 261  namespace DLS {
261                  uint16_t transform;                  uint16_t transform;
262                  uint32_t scale;                  uint32_t scale;
263              };              };
264              Connection() {};              Connection() {}
265              void Init(conn_block_t* Header);              void Init(conn_block_t* Header);
266              conn_block_t ToConnBlock();              conn_block_t ToConnBlock();
267              virtual ~Connection() {};              virtual ~Connection() {}
268              friend class Articulation;              friend class Articulation;
269      };      };
270    
# Line 286  namespace DLS { Line 289  namespace DLS {
289              Articulation* GetFirstArticulation();              Articulation* GetFirstArticulation();
290              Articulation* GetNextArticulation();              Articulation* GetNextArticulation();
291              virtual void  UpdateChunks();              virtual void  UpdateChunks();
292                virtual void  CopyAssign(const Articulator* orig);
293          protected:          protected:
294              typedef std::list<Articulation*> ArticulationList;              typedef std::list<Articulation*> ArticulationList;
295              RIFF::List*                 pParentList;              RIFF::List*                 pParentList;
# Line 316  namespace DLS { Line 320  namespace DLS {
320              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>.
321              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.
322              String Subject;          ///< <ISBJ-ck>. Describes the contents of the file.              String Subject;          ///< <ISBJ-ck>. Describes the contents of the file.
323                bool UseFixedLengthStrings; ///< @deprecated Not used anymore, use SetFixedStringLengths() instead.
324    
325              struct FixedStringLength {              struct string_length_t {
326                  uint32_t chunkId;                  uint32_t chunkId;
327                  int length;                  int      length;
328              };              };
329              const FixedStringLength* FixedStringLengths; ///< 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.  
330              Info(RIFF::List* list);              Info(RIFF::List* list);
331                void SetFixedStringLengths(const string_length_t* lengths);
332              virtual ~Info();              virtual ~Info();
333              virtual void UpdateChunks();              virtual void UpdateChunks();
334                virtual void CopyAssign(const Info* orig);
335          private:          private:
336              RIFF::List* pResourceListChunk;              RIFF::List*            pResourceListChunk;
337                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.
338    
339              static void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s);              static void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s);
340              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);
# Line 338  namespace DLS { Line 346  namespace DLS {
346              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.
347              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>.
348    
349              Resource* GetParent() { return pParent; };              Resource* GetParent() { return pParent; }
350                const Resource* GetParent() const { return pParent; }
351              virtual void UpdateChunks();              virtual void UpdateChunks();
352                void GenerateDLSID();
353                virtual void CopyAssign(const Resource* orig);
354          protected:          protected:
355              Resource* pParent;              Resource* pParent;
356              RIFF::List* pResourceList;              RIFF::List* pResourceList;
# Line 353  namespace DLS { Line 364  namespace DLS {
364          public:          public:
365              uint8_t        UnityNote;              uint8_t        UnityNote;
366              int16_t        FineTune;              int16_t        FineTune;
367              int32_t        Gain;              int32_t        Gain; ///< @deprecated Don't alter directly, use SetGain() instead!
368              bool           NoSampleDepthTruncation;              bool           NoSampleDepthTruncation;
369              bool           NoSampleCompression;              bool           NoSampleCompression;
370              uint32_t       SampleLoops;  ///< Reflects the number of sample loops.              uint32_t       SampleLoops;  ///< Reflects the number of sample loops.
# Line 361  namespace DLS { Line 372  namespace DLS {
372    
373              void AddSampleLoop(sample_loop_t* pLoopDef);              void AddSampleLoop(sample_loop_t* pLoopDef);
374              void DeleteSampleLoop(sample_loop_t* pLoopDef);              void DeleteSampleLoop(sample_loop_t* pLoopDef);
375                virtual void SetGain(int32_t gain);
376              virtual void UpdateChunks();              virtual void UpdateChunks();
377                virtual void CopyAssign(const Sampler* orig);
378          protected:          protected:
379              RIFF::List*    pParentList;              RIFF::List*    pParentList;
380              uint32_t       uiHeaderSize;              uint32_t       uiHeaderSize;
# Line 391  namespace DLS { Line 404  namespace DLS {
404    
405              void*         LoadSampleData();              void*         LoadSampleData();
406              void          ReleaseSampleData();              void          ReleaseSampleData();
407              unsigned long GetSize();              unsigned long GetSize() const;
408              void          Resize(int iNewSize);              void          Resize(int iNewSize);
409              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);
410              unsigned long Read(void* pBuffer, unsigned long SampleCount);              unsigned long Read(void* pBuffer, unsigned long SampleCount);
411              unsigned long Write(void* pBuffer, unsigned long SampleCount);              unsigned long Write(void* pBuffer, unsigned long SampleCount);
412              virtual void  UpdateChunks();              virtual void  UpdateChunks();
413                virtual void  CopyAssign(const Sample* orig);
414          protected:          protected:
415              RIFF::List*   pWaveList;              RIFF::List*   pWaveList;
416              RIFF::Chunk*  pCkData;              RIFF::Chunk*  pCkData;
# Line 405  namespace DLS { Line 419  namespace DLS {
419    
420              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);
421              virtual ~Sample();              virtual ~Sample();
422                void CopyAssignCore(const Sample* orig);
423              friend class File;              friend class File;
424              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
425      };      };
# Line 412  namespace DLS { Line 427  namespace DLS {
427      /** Defines <i>Region</i> information of an <i>Instrument</i>. */      /** Defines <i>Region</i> information of an <i>Instrument</i>. */
428      class Region : public Resource, public Articulator, public Sampler {      class Region : public Resource, public Articulator, public Sampler {
429          public:          public:
430              range_t     KeyRange;              range_t     KeyRange; ///< @deprecated Only read, don't write! Use SetKeyRange() instead.
431              range_t     VelocityRange;              range_t     VelocityRange;
432              uint16_t    KeyGroup;              uint16_t    KeyGroup;
433              uint16_t    Layer;              uint16_t    Layer;
# Line 424  namespace DLS { Line 439  namespace DLS {
439    
440              Sample*     GetSample();              Sample*     GetSample();
441              void        SetSample(Sample* pSample);              void        SetSample(Sample* pSample);
442                virtual void SetKeyRange(uint16_t Low, uint16_t High);
443              virtual void UpdateChunks();              virtual void UpdateChunks();
444                virtual void CopyAssign(const Region* orig);
445          protected:          protected:
446              RIFF::List* pCkRegion;              RIFF::List* pCkRegion;
447              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 450  namespace DLS { Line 467  namespace DLS {
467              Region*  GetFirstRegion();              Region*  GetFirstRegion();
468              Region*  GetNextRegion();              Region*  GetNextRegion();
469              Region*  AddRegion();              Region*  AddRegion();
             void     MoveRegion(Region* pSrc, Region* pDst);  
470              void     DeleteRegion(Region* pRegion);              void     DeleteRegion(Region* pRegion);
471              virtual void UpdateChunks();              virtual void UpdateChunks();
472                virtual void CopyAssign(const Instrument* orig);
473          protected:          protected:
474              typedef std::list<Region*> RegionList;              typedef std::list<Region*> RegionList;
475              struct midi_locale_t {              struct midi_locale_t {
# Line 465  namespace DLS { Line 482  namespace DLS {
482              RegionList::iterator RegionsIterator;              RegionList::iterator RegionsIterator;
483    
484              Instrument(File* pFile, RIFF::List* insList);              Instrument(File* pFile, RIFF::List* insList);
485                void CopyAssignCore(const Instrument* orig);
486              virtual void LoadRegions();              virtual void LoadRegions();
487              virtual ~Instrument();              virtual ~Instrument();
488              friend class File;              friend class File;
489                friend class Region;
490            private:
491                void MoveRegion(Region* pSrc, Region* pDst);
492      };      };
493    
494      /** 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 478  namespace DLS { Line 499  namespace DLS {
499    
500              File();              File();
501              File(RIFF::File* pRIFF);              File(RIFF::File* pRIFF);
502                String      GetFileName();
503                void        SetFileName(const String& name);
504              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.
505              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.
506              Sample*     AddSample();              Sample*     AddSample();
# Line 486  namespace DLS { Line 509  namespace DLS {
509              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.
510              Instrument* AddInstrument();              Instrument* AddInstrument();
511              void        DeleteInstrument(Instrument* pInstrument);              void        DeleteInstrument(Instrument* pInstrument);
512                RIFF::File* GetExtensionFile(int index);
513              virtual void UpdateChunks();              virtual void UpdateChunks();
514              virtual void Save(const String& Path);              virtual void Save(const String& Path);
515              virtual void Save();              virtual void Save();
Legend:
Removed from v.1180  
changed lines
  Added in v.2547
  ViewVC Help
Powered by ViewVC