/[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 2682 by schoenebeck, Mon Dec 29 16:25:51 2014 UTC revision 3926 by schoenebeck, Tue Jun 15 10:16:40 2021 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-2014 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2021 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 60  Line 60 
60  # define CHUNK_ID_COLH  0x636F6C68  # define CHUNK_ID_COLH  0x636F6C68
61  # define CHUNK_ID_ARTL  0x6172746C  # define CHUNK_ID_ARTL  0x6172746C
62  # define CHUNK_ID_ART2  0x61727432  # define CHUNK_ID_ART2  0x61727432
63    # define CHUNK_ID_XFIL  0x7866696C
64    # define CHUNK_ID_DOXF  0x646F7866
65  #else  // little endian  #else  // little endian
66  # define RIFF_TYPE_DLS  0x20534C44  # define RIFF_TYPE_DLS  0x20534C44
67  # define LIST_TYPE_WVPL 0x6C707677  # define LIST_TYPE_WVPL 0x6C707677
# Line 94  Line 96 
96  # define CHUNK_ID_COLH  0x686C6F63  # define CHUNK_ID_COLH  0x686C6F63
97  # define CHUNK_ID_ARTL  0x6C747261  # define CHUNK_ID_ARTL  0x6C747261
98  # define CHUNK_ID_ART2  0x32747261  # define CHUNK_ID_ART2  0x32747261
99    # define CHUNK_ID_XFIL  0x6C696678
100    # define CHUNK_ID_DOXF  0x66786F64
101  #endif // WORDS_BIGENDIAN  #endif // WORDS_BIGENDIAN
102    
103  #define DLS_WAVE_FORMAT_PCM                     0x0001  #define DLS_WAVE_FORMAT_PCM                     0x0001
# Line 105  namespace DLS { Line 109  namespace DLS {
109    
110      typedef std::string String;      typedef std::string String;
111      typedef RIFF::progress_t progress_t;      typedef RIFF::progress_t progress_t;
112        typedef RIFF::file_offset_t file_offset_t;
113    
114      /** Quadtuple version number ("major.minor.release.build"). */      /** Quadtuple version number ("major.minor.release.build"). */
115      struct version_t {      struct version_t {
# Line 123  namespace DLS { Line 128  namespace DLS {
128      };      };
129    
130      /** Connection Sources */      /** Connection Sources */
131      typedef enum {      enum conn_src_t {
132          // Modulator Sources          // Modulator Sources
133          conn_src_none            = 0x0000,          conn_src_none            = 0x0000,
134          conn_src_lfo             = 0x0001,          conn_src_lfo             = 0x0001,
# Line 146  namespace DLS { Line 151  namespace DLS {
151          conn_src_rpn0            = 0x0100,          conn_src_rpn0            = 0x0100,
152          conn_src_rpn1            = 0x0101,          conn_src_rpn1            = 0x0101,
153          conn_src_rpn2            = 0x0102          conn_src_rpn2            = 0x0102
154      } conn_src_t;      };
155    
156      /** Connection Destinations */      /** Connection Destinations */
157      typedef enum {      enum conn_dst_t {
158          // Generic Destinations          // Generic Destinations
159          conn_dst_none             = 0x0000,          conn_dst_none             = 0x0000,
160          conn_dst_gain             = 0x0001,          conn_dst_gain             = 0x0001,
# Line 191  namespace DLS { Line 196  namespace DLS {
196          // Filter Destinations          // Filter Destinations
197          conn_dst_filter_cutoff    = 0x0500,          conn_dst_filter_cutoff    = 0x0500,
198          conn_dst_filter_q         = 0x0501          conn_dst_filter_q         = 0x0501
199      } conn_dst_t;      };
200    
201      /** Connection Transforms */      /** Connection Transforms */
202      typedef enum {      enum conn_trn_t {
203          conn_trn_none    = 0x0000,          conn_trn_none    = 0x0000,
204          conn_trn_concave = 0x0001,          conn_trn_concave = 0x0001,
205          conn_trn_convex  = 0x0002,          conn_trn_convex  = 0x0002,
206          conn_trn_switch  = 0x0003          conn_trn_switch  = 0x0003
207      } conn_trn_t;      };
208        
209      /** Lower and upper limit of a range. */      /** Lower and upper limit of a range. */
210      struct range_t {      struct range_t {
211          uint16_t low;  ///< Low value of range.          uint16_t low;  ///< Low value of range.
# Line 269  namespace DLS { Line 274  namespace DLS {
274              friend class Articulation;              friend class Articulation;
275      };      };
276    
277        /** @brief Abstract base class for all classes using RIFF::Chunks for persistency.
278         *
279         * This abstract base class defines the general interface for all classes
280         * which are using RIFF::Chunks to actually load and store their data
281         * persistently from/to disk.
282         */
283        class Storage {
284        public:
285            /** @brief Apply object's changes to the respective RIF::Chunks.
286             *
287             * This abstract interface method is intended to be implemented by the
288             * deriving classes by updating the respective RIFF chunks associated
289             * with the object such that those RIFF chunks reflect the object's
290             * current data (i.e. object's current member variables). So the purpose
291             * of this method is to prepare for saving the object's current state
292             * persistently to the actual RIFF file.
293             *
294             * After returning from this method the changes are just scheduled to be
295             * saved to the RIFF file, it is required to call File::Save()
296             * subsequently to make the changes actually persistent on file level.
297             *
298             * Usually there is no need to call this method directly from an
299             * application. This method is called automatically by libgig if one of
300             * the respective API methods is called to save the file persistently
301             * to disk (i.e. DLS::File::Save() or gig::File::Save()).
302             *
303             * @param pProgress - callback function for progress notification
304             */
305            virtual void UpdateChunks(progress_t* pProgress) = 0;
306    
307            /** @brief Remove all RIFF chunks associated with this object.
308             *
309             * This abstract interface method is intended to be implemented by the
310             * deriving classes by removing every RIFF::Chunk the deriving overall
311             * object is using to store the object in the final RIFF::File. In other
312             * words: the intention is to remove the deriving class(es)'s object
313             * persistently from the currently open file.
314             *
315             * Note that the RIFF::Chunks deletions is just scheduled after
316             * returning from this method. You have to call File::Save() to make
317             * these changes persistent on file level.
318             *
319             * Usually there is no need to call this method directly from an
320             * application. This method is called automatically by libgig if one of
321             * the respective API methods is called to remove the respective object
322             * persistently (i.e. File::DeleteInstrument() or File::DeleteSample()).
323             */
324            virtual void DeleteChunks() = 0;
325        };
326    
327      /** Provides access to the defined connections used for the synthesis model. */      /** Provides access to the defined connections used for the synthesis model. */
328      class Articulation {      class Articulation : public Storage {
329          public:          public:
330              Connection*  pConnections; ///< Points to the beginning of a <i>Connection</i> array.              Connection*  pConnections; ///< Points to the beginning of a <i>Connection</i> array.
331              uint32_t     Connections;  ///< Reflects the number of Connections.              uint32_t     Connections;  ///< Reflects the number of Connections.
332    
333              Articulation(RIFF::Chunk* artl);              Articulation(RIFF::Chunk* artl);
334              virtual ~Articulation();              virtual ~Articulation();
335              virtual void UpdateChunks(progress_t* pProgress);              virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
336                virtual void DeleteChunks() OVERRIDE;
337          protected:          protected:
338              RIFF::Chunk* pArticulationCk;              RIFF::Chunk* pArticulationCk;
339              uint32_t     HeaderSize;              uint32_t     HeaderSize;
340      };      };
341    
342      /** 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). */
343      class Articulator {      class Articulator : public Storage {
344          public:          public:
345              Articulator(RIFF::List* ParentList);              Articulator(RIFF::List* ParentList);
346              Articulation* GetFirstArticulation();              Articulation* GetFirstArticulation();
347              Articulation* GetNextArticulation();              Articulation* GetNextArticulation();
348              virtual void  UpdateChunks(progress_t* pProgress);              virtual void  UpdateChunks(progress_t* pProgress) OVERRIDE;
349                virtual void  DeleteChunks() OVERRIDE;
350              virtual void  CopyAssign(const Articulator* orig);              virtual void  CopyAssign(const Articulator* orig);
351          protected:          protected:
352              typedef std::list<Articulation*> ArticulationList;              typedef std::list<Articulation*> ArticulationList;
# Line 302  namespace DLS { Line 359  namespace DLS {
359      };      };
360    
361      /** Optional information for DLS files, instruments, samples, etc. */      /** Optional information for DLS files, instruments, samples, etc. */
362      class Info {      class Info : public Storage {
363          public:          public:
364              String Name;             ///< <INAM-ck>. Stores the title of the subject of the file, such as, Seattle From Above.              String Name;             ///< <INAM-ck>. Stores the title of the subject of the file, such as, Seattle From Above.
365              String ArchivalLocation; ///< <IARL-ck>. Indicates where the subject of the file is stored.              String ArchivalLocation; ///< <IARL-ck>. Indicates where the subject of the file is stored.
# Line 331  namespace DLS { Line 388  namespace DLS {
388              Info(RIFF::List* list);              Info(RIFF::List* list);
389              void SetFixedStringLengths(const string_length_t* lengths);              void SetFixedStringLengths(const string_length_t* lengths);
390              virtual ~Info();              virtual ~Info();
391              virtual void UpdateChunks(progress_t* pProgress);              virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
392                virtual void DeleteChunks() OVERRIDE;
393              virtual void CopyAssign(const Info* orig);              virtual void CopyAssign(const Info* orig);
394          private:          private:
395              RIFF::List*            pResourceListChunk;              RIFF::List*            pResourceListChunk;
# Line 342  namespace DLS { Line 400  namespace DLS {
400      };      };
401    
402      /** 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. */
403      class Resource {      class Resource : public Storage {
404          public:          public:
405              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.
406              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>.
407    
408              Resource* GetParent() { return pParent; }              Resource* GetParent() { return pParent; }
409              const Resource* GetParent() const { return pParent; }              const Resource* GetParent() const { return pParent; }
410              virtual void UpdateChunks(progress_t* pProgress);              virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
411                virtual void DeleteChunks() OVERRIDE;
412              void GenerateDLSID();              void GenerateDLSID();
413                static void GenerateDLSID(dlsid_t* pDLSID);
414              virtual void CopyAssign(const Resource* orig);              virtual void CopyAssign(const Resource* orig);
415          protected:          protected:
416              Resource* pParent;              Resource* pParent;
# Line 361  namespace DLS { Line 421  namespace DLS {
421      };      };
422    
423      /** Abstract base class which provides mandatory informations about sample players in general. */      /** Abstract base class which provides mandatory informations about sample players in general. */
424      class Sampler {      class Sampler : public Storage {
425          public:          public:
426              uint8_t        UnityNote;              uint8_t        UnityNote;
427              int16_t        FineTune;              int16_t        FineTune;
# Line 374  namespace DLS { Line 434  namespace DLS {
434              void AddSampleLoop(sample_loop_t* pLoopDef);              void AddSampleLoop(sample_loop_t* pLoopDef);
435              void DeleteSampleLoop(sample_loop_t* pLoopDef);              void DeleteSampleLoop(sample_loop_t* pLoopDef);
436              virtual void SetGain(int32_t gain);              virtual void SetGain(int32_t gain);
437              virtual void UpdateChunks(progress_t* pProgress);              virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
438                virtual void DeleteChunks() OVERRIDE;
439              virtual void CopyAssign(const Sampler* orig);              virtual void CopyAssign(const Sampler* orig);
440          protected:          protected:
441              RIFF::List*    pParentList;              RIFF::List*    pParentList;
# Line 400  namespace DLS { Line 461  namespace DLS {
461              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).
462              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.
463              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).
464              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.
465              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().
466    
467              void*         LoadSampleData();              void*         LoadSampleData();
468              void          ReleaseSampleData();              void          ReleaseSampleData();
469              unsigned long GetSize() const;              file_offset_t GetSize() const;
470              void          Resize(int iNewSize);              void          Resize(file_offset_t NewSize);
471              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);
472              unsigned long Read(void* pBuffer, unsigned long SampleCount);              file_offset_t Read(void* pBuffer, file_offset_t SampleCount);
473              unsigned long Write(void* pBuffer, unsigned long SampleCount);              file_offset_t Write(void* pBuffer, file_offset_t SampleCount);
474              virtual void  UpdateChunks(progress_t* pProgress);              virtual void  UpdateChunks(progress_t* pProgress) OVERRIDE;
475                virtual void  DeleteChunks() OVERRIDE;
476              virtual void  CopyAssign(const Sample* orig);              virtual void  CopyAssign(const Sample* orig);
477    
478          protected:          protected:
479              RIFF::List*   pWaveList;              RIFF::List*   pWaveList;
480              RIFF::Chunk*  pCkData;              RIFF::Chunk*  pCkData;
481              RIFF::Chunk*  pCkFormat;              RIFF::Chunk*  pCkFormat;
482              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
483    
484              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);              Sample(File* pFile, RIFF::List* waveList, file_offset_t WavePoolOffset);
485              virtual ~Sample();              virtual ~Sample();
486              void CopyAssignCore(const Sample* orig);              void CopyAssignCore(const Sample* orig);
487              friend class File;              friend class File;
# Line 441  namespace DLS { Line 504  namespace DLS {
504              Sample*     GetSample();              Sample*     GetSample();
505              void        SetSample(Sample* pSample);              void        SetSample(Sample* pSample);
506              virtual void SetKeyRange(uint16_t Low, uint16_t High);              virtual void SetKeyRange(uint16_t Low, uint16_t High);
507              virtual void UpdateChunks(progress_t* pProgress);              virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
508                virtual void DeleteChunks() OVERRIDE;
509              virtual void CopyAssign(const Region* orig);              virtual void CopyAssign(const Region* orig);
510          protected:          protected:
511              RIFF::List* pCkRegion;              RIFF::List* pCkRegion;
# Line 465  namespace DLS { Line 529  namespace DLS {
529              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.
530              uint32_t Regions;        ///< Reflects the number of <i>Region</i> defintions this Instrument has.              uint32_t Regions;        ///< Reflects the number of <i>Region</i> defintions this Instrument has.
531    
532              Region*  GetFirstRegion();              Region*  GetRegionAt(size_t pos);
533              Region*  GetNextRegion();              Region*  GetFirstRegion() LIBGIG_DEPRECATED("Use GetRegionAt() instead.");
534                Region*  GetNextRegion() LIBGIG_DEPRECATED("Use GetRegionAt() instead.");
535              Region*  AddRegion();              Region*  AddRegion();
536              void     DeleteRegion(Region* pRegion);              void     DeleteRegion(Region* pRegion);
537              virtual void UpdateChunks(progress_t* pProgress);              virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
538                virtual void DeleteChunks() OVERRIDE;
539              virtual void CopyAssign(const Instrument* orig);              virtual void CopyAssign(const Instrument* orig);
540          protected:          protected:
541              typedef std::list<Region*> RegionList;              typedef std::vector<Region*> RegionList;
542              struct midi_locale_t {              struct midi_locale_t {
543                  uint32_t bank;                  uint32_t bank;
544                  uint32_t instrument;                  uint32_t instrument;
# Line 510  namespace DLS { Line 576  namespace DLS {
576              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.
577              Instrument* AddInstrument();              Instrument* AddInstrument();
578              void        DeleteInstrument(Instrument* pInstrument);              void        DeleteInstrument(Instrument* pInstrument);
579                RIFF::File* GetRiffFile();
580              RIFF::File* GetExtensionFile(int index);              RIFF::File* GetExtensionFile(int index);
581              virtual void UpdateChunks(progress_t* pProgress);              virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
582              virtual void Save(const String& Path, progress_t* pProgress = NULL);              virtual void Save(const String& Path, progress_t* pProgress = NULL);
583              virtual void Save(progress_t* pProgress = NULL);              virtual void Save(progress_t* pProgress = NULL);
584              virtual ~File();              virtual ~File();
# Line 520  namespace DLS { Line 587  namespace DLS {
587              typedef std::list<Instrument*> InstrumentList;              typedef std::list<Instrument*> InstrumentList;
588    
589              RIFF::File*              pRIFF;              RIFF::File*              pRIFF;
590              std::list<RIFF::File*>   ExtensionFiles;              std::list<RIFF::File*>   ExtensionFiles; //FIXME: These should automatically be freed, since implicitly allocated.
591              SampleList*              pSamples;              SampleList*              pSamples;
592              SampleList::iterator     SamplesIterator;              SampleList::iterator     SamplesIterator;
593              InstrumentList*          pInstruments;              InstrumentList*          pInstruments;
# Line 530  namespace DLS { Line 597  namespace DLS {
597              uint32_t*                pWavePoolTable;              uint32_t*                pWavePoolTable;
598              uint32_t*                pWavePoolTableHi;              uint32_t*                pWavePoolTableHi;
599              bool                     b64BitWavePoolOffsets;              bool                     b64BitWavePoolOffsets;
600                bool                     bOwningRiff; ///< If @c true then @c pRIFF was implicitly allocated by this class and hence pRIFF will automatically be freed by the @c DLS::File destructor in that case.
601    
602              virtual void LoadSamples();              virtual void LoadSamples();
603              virtual void LoadInstruments();              virtual void LoadInstruments();
# Line 550  namespace DLS { Line 618  namespace DLS {
618       */       */
619      class Exception : public RIFF::Exception {      class Exception : public RIFF::Exception {
620          public:          public:
621              Exception(String Message);              Exception(String format, ...);
622                Exception(String format, va_list arg);
623              void PrintMessage();              void PrintMessage();
624            protected:
625                Exception();
626      };      };
627    
628      String libraryName();      String libraryName();
Legend:
Removed from v.2682  
changed lines
  Added in v.3926
  ViewVC Help
Powered by ViewVC