/[svn]/libgig/trunk/src/DLS.h

Diff of /libgig/trunk/src/DLS.h

Parent Directory | Revision Log | View Patch Patch

-revision 929 by schoenebeck,
Tue Oct 24 22:24:45 2006 UTC
+revision 2547 by schoenebeck,
Tue May 13 11:17:24 2014 UTC
 Line 1
  /***************************************************************************
   *                                                                         *
-  *   libgig - C++ cross-platform Gigasampler format file loader library    *
+  *   libgig - C++ cross-platform Gigasampler format file access library    *
   *                                                                         *
-  *   Copyright (C) 2003-2006 by Christian Schoenebeck                      *
+  *   Copyright (C) 2003-2014 by Christian Schoenebeck                      *
   *                              <cuse@users.sourceforge.net>               *
   *                                                                         *
   *   This library is free software; you can redistribute it and/or modify  *
 Line 28
  #if WORDS_BIGENDIAN
  # define RIFF_TYPE_DLS  0x444C5320
- # define LIST_TYPE_INFO 0x494E464F
  # define LIST_TYPE_WVPL 0x7776706C
  # define LIST_TYPE_DWPL 0x6477706C  ///< Seen on some files instead of a wvpl list chunk.
  # define LIST_TYPE_WAVE 0x77617665
-Line 42
+Line 41
  # define CHUNK_ID_IARL  0x4941524C
  # define CHUNK_ID_IART  0x49415254
  # 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
  # define CHUNK_ID_IGNR  0x49474E52
  # define CHUNK_ID_IKEY  0x494B4559
  # define CHUNK_ID_IMED  0x494D4544
- # define CHUNK_ID_INAM  0x494E414D
- # define CHUNK_ID_IPRD  0x49505244
  # define CHUNK_ID_ISBJ  0x4953424A
- # define CHUNK_ID_ISFT  0x49534654
  # define CHUNK_ID_ISRC  0x49535243
  # define CHUNK_ID_ISRF  0x49535246
  # define CHUNK_ID_ITCH  0x49544348
-Line 70
+Line 62
  # define CHUNK_ID_ART2  0x61727432
  #else  // little endian
  # define RIFF_TYPE_DLS  0x20534C44
- # define LIST_TYPE_INFO 0x4F464E49
  # define LIST_TYPE_WVPL 0x6C707677
  # define LIST_TYPE_DWPL 0x6C707764  ///< Seen on some files instead of a wvpl list chunk.
  # define LIST_TYPE_WAVE 0x65766177
-Line 84
+Line 75
  # define CHUNK_ID_IARL  0x4C524149
  # define CHUNK_ID_IART  0x54524149
  # 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
  # define CHUNK_ID_IGNR  0x524E4749
  # define CHUNK_ID_IKEY  0x59454B49
  # define CHUNK_ID_IMED  0x44454D49
- # define CHUNK_ID_INAM  0x4D414E49
- # define CHUNK_ID_IPRD  0x44525049
  # define CHUNK_ID_ISBJ  0x4A425349
- # define CHUNK_ID_ISFT  0x54465349
  # define CHUNK_ID_ISRC  0x43525349
  # define CHUNK_ID_ISRF  0x46525349
  # define CHUNK_ID_ITCH  0x48435449
-Line 112
+Line 96
  # define CHUNK_ID_ART2  0x32747261
  #endif // WORDS_BIGENDIAN
- #define WAVE_FORMAT_PCM                 0x0001
+ #define DLS_WAVE_FORMAT_PCM                     0x0001
  //TODO: no support for conditional chunks <cdl> yet
-Line 220 
 namespace DLS {
+Line 204 
 namespace DLS {
      struct range_t {
          uint16_t low;  ///< Low value of range.
          uint16_t high; ///< High value of range.
+         inline bool operator< (const range_t& other) const {
+             if (low < other.low) return true;
+             if (low > other.low) return false;
+             return high < other.high;
+         }
+         inline bool operator== (const range_t& other) const {
+             return low == other.low && high == other.high;
+         }
+         inline bool overlaps(uint16_t scalar) const {
+             return low <= scalar && scalar <= high;
+         }
+         inline bool overlaps(const range_t& other) const {
+             return overlaps(other.low) || overlaps(other.high) ||
+                    other.overlaps(low) || other.overlaps(high);
+         }
      };
      /** Defines Sample Loop Points. */
      struct sample_loop_t {
-         uint32_t Size;
+         uint32_t Size;       ///< For internal usage only: usually reflects exactly @c sizeof(sample_loop_t), otherwise if the value is larger then the DLS format was extended!
-         uint32_t LoopType;
+         uint32_t LoopType;   ///< Defines how the waveform samples will be looped (appropriate loop types for the gig format are defined by gig::loop_type_t).
-         uint32_t LoopStart;
+         uint32_t LoopStart;  ///< The start value specifies the offset (in sample points) in the waveform data of the first sample point to be played in the loop.
-         uint32_t LoopLength;
+         uint32_t LoopLength; ///< Length of the looping area (in sample points).
      };
      // just symbol prototyping
-Line 258 
 namespace DLS {
+Line 261 
 namespace DLS {
                  uint16_t transform;
                  uint32_t scale;
              };
-             Connection() {};
+             Connection() {}
              void Init(conn_block_t* Header);
              conn_block_t ToConnBlock();
-             virtual ~Connection() {};
+             virtual ~Connection() {}
              friend class Articulation;
      };
-Line 286 
 namespace DLS {
+Line 289 
 namespace DLS {
              Articulation* GetFirstArticulation();
              Articulation* GetNextArticulation();
              virtual void  UpdateChunks();
+             virtual void  CopyAssign(const Articulator* orig);
          protected:
              typedef std::list<Articulation*> ArticulationList;
              RIFF::List*                 pParentList;
-Line 316 
 namespace DLS {
+Line 320 
 namespace DLS {
              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 Commissioned;     ///< <ICMS-ck>. Lists the name of the person or organization that commissioned the subject of the file, e.g., Pope Julian II.
              String Subject;          ///< <ISBJ-ck>. Describes the contents of the file.
-             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.
+             struct string_length_t {
+                 uint32_t chunkId;
+                 int      length;
+             };
              Info(RIFF::List* list);
+             void SetFixedStringLengths(const string_length_t* lengths);
              virtual ~Info();
              virtual void UpdateChunks();
+             virtual void CopyAssign(const Info* orig);
          private:
-             RIFF::List* pResourceListChunk;
+             RIFF::List*            pResourceListChunk;
+             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.
              static void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s);
-             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);
      };
      /** Abstract base class which encapsulates data structures which all DLS resources are able to provide. */
-Line 334 
 namespace DLS {
+Line 346 
 namespace DLS {
              Info*    pInfo;  ///< Points (in any case) to an <i>Info</i> object, providing additional, optional infos and comments.
              dlsid_t* pDLSID; ///< Points to a <i>dlsid_t</i> structure if the file provided a DLS ID else is <i>NULL</i>.
-             Resource* GetParent() { return pParent; };
+             Resource* GetParent() { return pParent; }
+             const Resource* GetParent() const { return pParent; }
              virtual void UpdateChunks();
+             void GenerateDLSID();
+             virtual void CopyAssign(const Resource* orig);
          protected:
              Resource* pParent;
              RIFF::List* pResourceList;
-Line 349 
 namespace DLS {
+Line 364 
 namespace DLS {
          public:
              uint8_t        UnityNote;
              int16_t        FineTune;
-             int32_t        Gain;
+             int32_t        Gain; ///< @deprecated Don't alter directly, use SetGain() instead!
              bool           NoSampleDepthTruncation;
              bool           NoSampleCompression;
              uint32_t       SampleLoops;  ///< Reflects the number of sample loops.
              sample_loop_t* pSampleLoops; ///< Points to the beginning of a sample loop array, or is NULL if there are no loops defined.
+             void AddSampleLoop(sample_loop_t* pLoopDef);
+             void DeleteSampleLoop(sample_loop_t* pLoopDef);
+             virtual void SetGain(int32_t gain);
              virtual void UpdateChunks();
+             virtual void CopyAssign(const Sampler* orig);
          protected:
              RIFF::List*    pParentList;
              uint32_t       uiHeaderSize;
-Line 374 
 namespace DLS {
+Line 393 
 namespace DLS {
       */
      class Sample : public Resource {
          public:
-             uint16_t      FormatTag;             ///< Format ID of the waveform data (should be WAVE_FORMAT_PCM for DLS1 compliant files, this is also the default value if Sample was created with Instrument::AddSample()).
+             uint16_t      FormatTag;             ///< Format ID of the waveform data (should be DLS_WAVE_FORMAT_PCM for DLS1 compliant files, this is also the default value if Sample was created with Instrument::AddSample()).
              uint16_t      Channels;              ///< Number of channels represented in the waveform data, e.g. 1 for mono, 2 for stereo (defaults to 1=mono if Sample was created with Instrument::AddSample() previously).
              uint32_t      SamplesPerSecond;      ///< Sampling rate at which each channel should be played (defaults to 44100 if Sample was created with Instrument::AddSample() previously).
              uint32_t      AverageBytesPerSecond; ///< The average number of bytes per second at which the waveform data should be transferred (Playback software can estimate the buffer size using this value).
-Line 385 
 namespace DLS {
+Line 404 
 namespace DLS {
              void*         LoadSampleData();
              void          ReleaseSampleData();
-             unsigned long GetSize();
+             unsigned long GetSize() const;
              void          Resize(int iNewSize);
              unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
              unsigned long Read(void* pBuffer, unsigned long SampleCount);
              unsigned long Write(void* pBuffer, unsigned long SampleCount);
              virtual void  UpdateChunks();
+             virtual void  CopyAssign(const Sample* orig);
          protected:
              RIFF::List*   pWaveList;
              RIFF::Chunk*  pCkData;
-Line 399 
 namespace DLS {
+Line 419 
 namespace DLS {
              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);
              virtual ~Sample();
+             void CopyAssignCore(const Sample* orig);
              friend class File;
              friend class Region; // Region has to compare the wave pool offset to get its sample
      };
-Line 406 
 namespace DLS {
+Line 427 
 namespace DLS {
      /** Defines <i>Region</i> information of an <i>Instrument</i>. */
      class Region : public Resource, public Articulator, public Sampler {
          public:
-             range_t     KeyRange;
+             range_t     KeyRange; ///< @deprecated Only read, don't write! Use SetKeyRange() instead.
              range_t     VelocityRange;
              uint16_t    KeyGroup;
              uint16_t    Layer;
-Line 418 
 namespace DLS {
+Line 439 
 namespace DLS {
              Sample*     GetSample();
              void        SetSample(Sample* pSample);
+             virtual void SetKeyRange(uint16_t Low, uint16_t High);
              virtual void UpdateChunks();
+             virtual void CopyAssign(const Region* orig);
          protected:
              RIFF::List* pCkRegion;
              uint32_t    WavePoolTableIndex; // index in the wave pool table to the sample wave this region is linked to
-Line 446 
 namespace DLS {
+Line 469 
 namespace DLS {
              Region*  AddRegion();
              void     DeleteRegion(Region* pRegion);
              virtual void UpdateChunks();
+             virtual void CopyAssign(const Instrument* orig);
          protected:
              typedef std::list<Region*> RegionList;
              struct midi_locale_t {
-Line 458 
 namespace DLS {
+Line 482 
 namespace DLS {
              RegionList::iterator RegionsIterator;
              Instrument(File* pFile, RIFF::List* insList);
+             void CopyAssignCore(const Instrument* orig);
              virtual void LoadRegions();
              virtual ~Instrument();
              friend class File;
+             friend class Region;
+         private:
+             void MoveRegion(Region* pSrc, Region* pDst);
      };
      /** Parses DLS Level 1 and 2 compliant files and provides abstract access to the data. */
-Line 471 
 namespace DLS {
+Line 499 
 namespace DLS {
              File();
              File(RIFF::File* pRIFF);
+             String      GetFileName();
+             void        SetFileName(const String& name);
              Sample*     GetFirstSample();     ///< Returns a pointer to the first <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.
              Sample*     AddSample();
-Line 479 
 namespace DLS {
+Line 509 
 namespace DLS {
              Instrument* GetNextInstrument();  ///< Returns a pointer to the next <i>Instrument</i> object of the file, <i>NULL</i> otherwise.
              Instrument* AddInstrument();
              void        DeleteInstrument(Instrument* pInstrument);
+             RIFF::File* GetExtensionFile(int index);
              virtual void UpdateChunks();
              virtual void Save(const String& Path);
              virtual void Save();
-Line 508 
 namespace DLS {
+Line 539 
 namespace DLS {
              void __UpdateWavePoolTable();
      };
-     /** Will be thrown whenever a DLS specific error occurs while trying to access a DLS File. */
+     /**
+      * Will be thrown whenever a DLS specific error occurs while trying to
+      * access a DLS File. Note: In your application you should better catch
+      * for RIFF::Exception rather than this one, except you explicitly want
+      * to catch and handle DLS::Exception and RIFF::Exception independently,
+      * which usually shouldn't be necessary though.
+      */
      class Exception : public RIFF::Exception {
          public:
              Exception(String Message);

 Legend:



Removed from v.929
 


changed lines


 
Added in v.2547
 Legend:



Removed from v.929
 


changed lines


 
Added in v.2547
-Removed from v.929
+Added in v.2547

	ViewVC Help
Powered by ViewVC