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

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

Parent Directory | Revision Log | View Patch Patch

-revision 666 by persson,
Sun Jun 19 15:18:59 2005 UTC
+revision 2609 by schoenebeck,
Sun Jun  8 19:00:30 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-2005 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 27
  #include "RIFF.h"
  #if WORDS_BIGENDIAN
- # define LIST_TYPE_INFO 0x494E464F
+ # define RIFF_TYPE_DLS  0x444C5320
  # 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 38
  # define LIST_TYPE_LAR2 0x6C617232
  # define LIST_TYPE_RGN  0x72676E20
  # define LIST_TYPE_RGN2 0x72676E32
- # define LIST_TYPE_ART1 0x61727431
- # define LIST_TYPE_ART2 0x61727432
  # 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 67
+Line 58
  # define CHUNK_ID_PTBL  0x7074626C
  # define CHUNK_ID_WSMP  0x77736D70
  # define CHUNK_ID_COLH  0x636F6C68
+ # define CHUNK_ID_ARTL  0x6172746C
+ # define CHUNK_ID_ART2  0x61727432
  #else  // little endian
- # define LIST_TYPE_INFO 0x4F464E49
+ # define RIFF_TYPE_DLS  0x20534C44
  # 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 79
+Line 72
  # define LIST_TYPE_LAR2 0x3272616C
  # define LIST_TYPE_RGN  0x206E6772
  # define LIST_TYPE_RGN2 0x326E6772
- # define LIST_TYPE_ART1 0x31747261
- # define LIST_TYPE_ART2 0x32747261
  # 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  0x44525049
+ # 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 108
+Line 92
  # define CHUNK_ID_PTBL  0x6C627470
  # define CHUNK_ID_WSMP  0x706D7377
  # define CHUNK_ID_COLH  0x686C6F63
+ # define CHUNK_ID_ARTL  0x6C747261
+ # define CHUNK_ID_ART2  0x32747261
  #endif // WORDS_BIGENDIAN
- #define WAVE_FORMAT_PCM                 0x0001
+ #define DLS_WAVE_FORMAT_PCM                     0x0001
- #define DRUM_TYPE_MASK                  0x00000001
- #define F_RGN_OPTION_SELFNONEXCLUSIVE   0x0001
- #define F_WAVELINK_PHASE_MASTER         0x0001
- #define F_WAVELINK_MULTICHANNEL         0x0002
- #define F_WSMP_NO_TRUNCATION            0x0001
- #define F_WSMP_NO_COMPRESSION           0x0002
- #define MIDI_BANK_COARSE(x)             ((x & 0x00007F00) >> 8)                 // CC0
- #define MIDI_BANK_FINE(x)               (x & 0x0000007F)                        // CC32
- #define MIDI_BANK_MERGE(coarse, fine)   ((((uint16_t) coarse) << 7) | fine)     // CC0 + CC32
- #define CONN_TRANSFORM_SRC(x)           ((x >> 10) & 0x000F)
- #define CONN_TRANSFORM_CTL(x)           ((x >> 4) & 0x000F)
- #define CONN_TRANSFORM_DST(x)           (x & 0x000F)
- #define CONN_TRANSFORM_BIPOLAR_SRC(x)   (x & 0x4000)
- #define CONN_TRANSFORM_BIPOLAR_CTL(x)   (x & 0x0100)
- #define CONN_TRANSFORM_INVERT_SRC(x)    (x & 0x8000)
- #define CONN_TRANSFORM_INVERT_CTL(x)    (x & 0x0200)
  //TODO: no support for conditional chunks <cdl> yet
-Line 240 
 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 278 
 namespace DLS {
+Line 261 
 namespace DLS {
                  uint16_t transform;
                  uint32_t scale;
              };
-             Connection() {};
+             Connection() {}
              void Init(conn_block_t* Header);
-             virtual ~Connection() {};
+             conn_block_t ToConnBlock();
+             virtual ~Connection() {}
              friend class Articulation;
      };
-Line 289 
 namespace DLS {
+Line 273 
 namespace DLS {
          public:
              Connection*  pConnections; ///< Points to the beginning of a <i>Connection</i> array.
              uint32_t     Connections;  ///< Reflects the number of Connections.
-             Articulation(RIFF::List* artList);
+             Articulation(RIFF::Chunk* artl);
              virtual ~Articulation();
+             virtual void UpdateChunks();
+         protected:
+             RIFF::Chunk* pArticulationCk;
+             uint32_t     HeaderSize;
      };
      /** Abstract base class for classes that provide articulation information (thus for <i>Instrument</i> and <i>Region</i> class). */
-Line 299 
 namespace DLS {
+Line 288 
 namespace DLS {
              Articulator(RIFF::List* ParentList);
              Articulation* GetFirstArticulation();
              Articulation* GetNextArticulation();
+             virtual void  UpdateChunks();
+             virtual void  CopyAssign(const Articulator* orig);
          protected:
              typedef std::list<Articulation*> ArticulationList;
              RIFF::List*                 pParentList;
-Line 328 
 namespace DLS {
+Line 319 
 namespace DLS {
              String Source;           ///< <ISRC-ck>. Identifies the name of the person or organization who supplied the original subject of the file.
              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; ///< @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:
-             inline void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s) {
+             RIFF::List*            pResourceListChunk;
-                 RIFF::Chunk* ck = lstINFO->GetSubChunk(ChunkID);
+             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.
-                 if (ck) {
-                     // TODO: no check for ZSTR terminated strings yet
+             static void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s);
-                     s = (char*) ck->LoadChunkData();
+             void SaveString(uint32_t ChunkID, RIFF::List* lstINFO, const String& s, const String& sDefault);
-                     ck->ReleaseChunkData();
-                 }
-             }
      };
      /** Abstract base class which encapsulates data structures which all DLS resources are able to provide. */
      class Resource {
          public:
-             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.
-             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>.
-             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;
              Resource(Resource* Parent, RIFF::List* lstResource);
              virtual ~Resource();
-Line 360 
 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.
+             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.
+             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;
              uint32_t       SamplerOptions;
              Sampler(RIFF::List* ParentList);
              virtual ~Sampler();
      };
-     /** Encapsulates sample waves used for playback. */
+     /** @brief Encapsulates sample waves used for playback.
+      *
+      * In case you created a new sample with File::AddSample(), you should
+      * first update all attributes with the desired meta informations
+      * (amount of channels, bit depth, sample rate, etc.), then call
+      * Resize() with the desired sample size. The latter will create
+      * the mandatory RIFF chunk which will hold the sample wave data.
+      */
      class Sample : public Resource {
          public:
-             uint16_t      FormatTag;             ///< Format ID of the waveform data (should be WAVE_FORMAT_PCM for DLS1 compliant files).
+             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 ().
+             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.
+             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).
              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      BitDepth;              ///< Size of each sample per channel (only if known sample data format is used, 0 otherwise).
-             unsigned long SamplesTotal;          ///< Reflects total number of samples (only if known sample data format is used, 0 otherwise).
+             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.
-             uint          FrameSize;             ///< Reflects the size (in bytes) of one single sample (only if known sample data format is used, 0 otherwise).
+             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().
-             void*         LoadSampleData();              ///< Load sample data into RAM. Returns a pointer to the data in RAM on success, <i>NULL</i> otherwise.
+             void*         LoadSampleData();
-             void          ReleaseSampleData();           ///< Release the samples once you used them if you don't want to be bothered to.
+             void          ReleaseSampleData();
+             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;
              RIFF::Chunk*  pCkFormat;
              unsigned long ulWavePoolOffset;  // needed for comparison with the wave pool link table, thus the link to instruments
              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 400 
 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 411 
 namespace DLS {
+Line 438 
 namespace DLS {
              uint32_t    Channel;
              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
              Sample*     pSample;            // every region refers to exactly one sample
+             uint16_t    FormatOptionFlags;
+             uint16_t    WaveLinkOptionFlags;
              Region(Instrument* pInstrument, RIFF::List* rgnList);
              virtual ~Region();
-Line 425 
 namespace DLS {
+Line 458 
 namespace DLS {
      class Instrument : public Resource, public Articulator {
          public:
              bool     IsDrum;         ///< Indicates if the <i>Instrument</i> is a drum type, as they differ in the synthesis model of DLS from melodic instruments.
-             uint16_t MIDIBank;       ///< Reflects combination of <i>MIDIBankCoarse</i> and <i>MIDIBankFine</i> (bank 1 - bank 16384).
+             uint16_t MIDIBank;       ///< Reflects combination of <i>MIDIBankCoarse</i> and <i>MIDIBankFine</i> (bank 1 - bank 16384). Do not change this value, it will not be saved! Change MIDIBankCoarse and MIDIBankFine instead (we might change that in future).
              uint8_t  MIDIBankCoarse; ///< Reflects the MIDI Bank number for MIDI Control Change 0 (bank 1 - 128).
              uint8_t  MIDIBankFine;   ///< Reflects the MIDI Bank number for MIDI Control Change 32 (bank 1 - 128).
              uint32_t MIDIProgram;    ///< Specifies the MIDI Program Change Number this Instrument should be assigned to.
-Line 433 
 namespace DLS {
+Line 466 
 namespace DLS {
              Region*  GetFirstRegion();
              Region*  GetNextRegion();
+             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 445 
 namespace DLS {
+Line 482 
 namespace DLS {
              RegionList::iterator RegionsIterator;
              Instrument(File* pFile, RIFF::List* insList);
-             void LoadRegions();
+             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 456 
 namespace DLS {
+Line 497 
 namespace DLS {
              version_t* pVersion;              ///< Points to a <i>version_t</i> structure if the file provided a version number else is set to <i>NULL</i>.
              uint32_t   Instruments;           ///< Reflects the number of available <i>Instrument</i> objects.
+             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();
+             void        DeleteSample(Sample* pSample);
              Instrument* GetFirstInstrument(); ///< Returns a pointer to the first <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.
+             Instrument* AddInstrument();
+             void        DeleteInstrument(Instrument* pInstrument);
+             RIFF::File* GetExtensionFile(int index);
+             virtual void UpdateChunks();
+             virtual void Save(const String& Path);
+             virtual void Save();
              virtual ~File();
          protected:
              typedef std::list<Sample*>     SampleList;
              typedef std::list<Instrument*> InstrumentList;
              RIFF::File*              pRIFF;
+             std::list<RIFF::File*>   ExtensionFiles;
              SampleList*              pSamples;
              SampleList::iterator     SamplesIterator;
              InstrumentList*          pInstruments;
              InstrumentList::iterator InstrumentsIterator;
+             uint32_t                 WavePoolHeaderSize;
              uint32_t                 WavePoolCount;
              uint32_t*                pWavePoolTable;
              uint32_t*                pWavePoolTableHi;
+             bool                     b64BitWavePoolOffsets;
-             void LoadSamples();
+             virtual void LoadSamples();
-             void LoadInstruments();
+             virtual void LoadInstruments();
+             virtual void UpdateFileOffsets();
+             void __ensureMandatoryChunksExist();
              friend class Region; // Region has to look in the wave pool table to get its sample
+         private:
+             void __UpdateWavePoolTableChunk();
+             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.666
 


changed lines


 
Added in v.2609
 Legend:



Removed from v.666
 


changed lines


 
Added in v.2609
-Removed from v.666
+Added in v.2609

	ViewVC Help
Powered by ViewVC