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

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

Parent Directory | Revision Log | View Patch Patch

-revision 802 by schoenebeck,
Thu Nov 10 19:53:34 2005 UTC
+revision 1154 by schoenebeck,
Wed Apr 11 16:33:56 2007 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-2007 by Christian Schoenebeck                      *
   *                              <cuse@users.sourceforge.net>               *
   *                                                                         *
   *   This library is free software; you can redistribute it and/or modify  *
 Line 90
  # 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
 Line 112
  # 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 224 
 namespace DLS {
      /** 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 315 
 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; ///< 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.
              Info(RIFF::List* list);
+             virtual ~Info();
              virtual void UpdateChunks();
          private:
              RIFF::List* pResourceListChunk;
-             void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s);
+             static void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s);
-             void SaveString(uint32_t ChunkID, RIFF::List* lstINFO, const String& s, const String& sDefault);
+             static void SaveString(uint32_t ChunkID, RIFF::List* lstINFO, const String& s, const String& sDefault, bool bUseFixedLengthStrings, int size);
      };
      /** Abstract base class which encapsulates data structures which all DLS resources are able to provide. */
-Line 352 
 namespace DLS {
+Line 355 
 namespace DLS {
              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 UpdateChunks();
          protected:
              RIFF::List*    pParentList;
-Line 364 
 namespace DLS {
+Line 369 
 namespace DLS {
      /** @brief Encapsulates sample waves used for playback.
       *
       * In case you created a new sample with File::AddSample(), you should
-      * first call Resize() with the desired sample size. This will create
+      * 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 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 point (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();
              void          ReleaseSampleData();
-Line 439 
 namespace DLS {
+Line 446 
 namespace DLS {
              Region*  GetFirstRegion();
              Region*  GetNextRegion();
              Region*  AddRegion();
+             void     MoveRegion(Region* pSrc, Region* pDst);
              void     DeleteRegion(Region* pRegion);
              virtual void UpdateChunks();
          protected:
-Line 453 
 namespace DLS {
+Line 461 
 namespace DLS {
              RegionList::iterator RegionsIterator;
              Instrument(File* pFile, RIFF::List* insList);
-             void LoadRegions();
+             virtual void LoadRegions();
              virtual ~Instrument();
              friend class File;
      };
-Line 483 
 namespace DLS {
+Line 491 
 namespace DLS {
              typedef std::list<Instrument*> InstrumentList;
              RIFF::File*              pRIFF;
+             std::list<RIFF::File*>   ExtensionFiles;
              SampleList*              pSamples;
              SampleList::iterator     SamplesIterator;
              InstrumentList*          pInstruments;
-Line 493 
 namespace DLS {
+Line 502 
 namespace DLS {
              uint32_t*                pWavePoolTableHi;
              bool                     b64BitWavePoolOffsets;
-             void LoadSamples();
+             virtual void LoadSamples();
-             void LoadInstruments();
+             virtual void LoadInstruments();
              void __ensureMandatoryChunksExist();
              friend class Region; // Region has to look in the wave pool table to get its sample
          private:
-Line 502 
 namespace DLS {
+Line 511 
 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.802
 


changed lines


 
Added in v.1154
 Legend:



Removed from v.802
 


changed lines


 
Added in v.1154
-Removed from v.802
+Added in v.1154

	ViewVC Help
Powered by ViewVC