/[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 800 by schoenebeck, Wed Nov 9 20:04:11 2005 UTC revision 1358 by schoenebeck, Sun Sep 30 18:13:33 2007 UTC
# Line 1  Line 1 
1  /***************************************************************************  /***************************************************************************
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file loader library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003-2005 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2007 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 27  Line 27 
27  #include "RIFF.h"  #include "RIFF.h"
28    
29  #if WORDS_BIGENDIAN  #if WORDS_BIGENDIAN
30  # define RIFF_TYPE_DLS  0x646C7320  # define RIFF_TYPE_DLS  0x444C5320
31  # define LIST_TYPE_INFO 0x494E464F  # define LIST_TYPE_INFO 0x494E464F
32  # define LIST_TYPE_WVPL 0x7776706C  # define LIST_TYPE_WVPL 0x7776706C
33  # 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.
# Line 69  Line 69 
69  # define CHUNK_ID_ARTL  0x6172746C  # define CHUNK_ID_ARTL  0x6172746C
70  # define CHUNK_ID_ART2  0x61727432  # define CHUNK_ID_ART2  0x61727432
71  #else  // little endian  #else  // little endian
72  # define RIFF_TYPE_DLS  0x20736C64  # define RIFF_TYPE_DLS  0x20534C44
73  # define LIST_TYPE_INFO 0x4F464E49  # define LIST_TYPE_INFO 0x4F464E49
74  # define LIST_TYPE_WVPL 0x6C707677  # define LIST_TYPE_WVPL 0x6C707677
75  # 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.
# Line 90  Line 90 
90  # define CHUNK_ID_IENG  0x474E4549  # define CHUNK_ID_IENG  0x474E4549
91  # define CHUNK_ID_IGNR  0x524E4749  # define CHUNK_ID_IGNR  0x524E4749
92  # define CHUNK_ID_IKEY  0x59454B49  # define CHUNK_ID_IKEY  0x59454B49
93  # define CHUNK_ID_IMED  0x44525049  # define CHUNK_ID_IMED  0x44454D49
94  # define CHUNK_ID_INAM  0x4D414E49  # define CHUNK_ID_INAM  0x4D414E49
95  # define CHUNK_ID_IPRD  0x44525049  # define CHUNK_ID_IPRD  0x44525049
96  # define CHUNK_ID_ISBJ  0x4A425349  # define CHUNK_ID_ISBJ  0x4A425349
# Line 112  Line 112 
112  # define CHUNK_ID_ART2  0x32747261  # define CHUNK_ID_ART2  0x32747261
113  #endif // WORDS_BIGENDIAN  #endif // WORDS_BIGENDIAN
114    
115  #define WAVE_FORMAT_PCM                 0x0001  #define DLS_WAVE_FORMAT_PCM                     0x0001
116    
117  //TODO: no support for conditional chunks <cdl> yet  //TODO: no support for conditional chunks <cdl> yet
118    
# Line 224  namespace DLS { Line 224  namespace DLS {
224    
225      /** Defines Sample Loop Points. */      /** Defines Sample Loop Points. */
226      struct sample_loop_t {      struct sample_loop_t {
227          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!
228          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).
229          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.
230          uint32_t LoopLength;          uint32_t LoopLength; ///< Length of the looping area (in sample points).
231      };      };
232    
233      // just symbol prototyping      // just symbol prototyping
# Line 315  namespace DLS { Line 315  namespace DLS {
315              String Source;           ///< <ISRC-ck>. Identifies the name of the person or organization who supplied the original subject of the file.              String Source;           ///< <ISRC-ck>. Identifies the name of the person or organization who supplied the original subject of the file.
316              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>.
317              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.
318                String Subject;          ///< <ISBJ-ck>. Describes the contents of the file.
319                bool UseFixedLengthStrings; ///< @deprecated Use #FixedStringLengths instead.
320    
321                struct FixedStringLength {
322                    uint32_t chunkId;
323                    int length;
324                };
325                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.
326              Info(RIFF::List* list);              Info(RIFF::List* list);
327                virtual ~Info();
328              virtual void UpdateChunks();              virtual void UpdateChunks();
329          private:          private:
330              RIFF::List* pResourceListChunk;              RIFF::List* pResourceListChunk;
331    
332              void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s);              static void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s);
333              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);
334      };      };
335    
# Line 333  namespace DLS { Line 341  namespace DLS {
341    
342              Resource* GetParent() { return pParent; };              Resource* GetParent() { return pParent; };
343              virtual void UpdateChunks();              virtual void UpdateChunks();
344                void GenerateDLSID();
345          protected:          protected:
346              Resource* pParent;              Resource* pParent;
347              RIFF::List* pResourceList;              RIFF::List* pResourceList;
# Line 346  namespace DLS { Line 355  namespace DLS {
355          public:          public:
356              uint8_t        UnityNote;              uint8_t        UnityNote;
357              int16_t        FineTune;              int16_t        FineTune;
358              int32_t        Gain;              int32_t        Gain; ///< @deprecated Don't alter directly, use SetGain() instead!
359              bool           NoSampleDepthTruncation;              bool           NoSampleDepthTruncation;
360              bool           NoSampleCompression;              bool           NoSampleCompression;
361              uint32_t       SampleLoops;  ///< Reflects the number of sample loops.              uint32_t       SampleLoops;  ///< Reflects the number of sample loops.
362              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.
363    
364                void AddSampleLoop(sample_loop_t* pLoopDef);
365                void DeleteSampleLoop(sample_loop_t* pLoopDef);
366                virtual void SetGain(int32_t gain);
367              virtual void UpdateChunks();              virtual void UpdateChunks();
368          protected:          protected:
369              RIFF::List*    pParentList;              RIFF::List*    pParentList;
# Line 364  namespace DLS { Line 376  namespace DLS {
376      /** @brief Encapsulates sample waves used for playback.      /** @brief Encapsulates sample waves used for playback.
377       *       *
378       * In case you created a new sample with File::AddSample(), you should       * In case you created a new sample with File::AddSample(), you should
379       * first call Resize() with the desired sample size. This will create       * first update all attributes with the desired meta informations
380         * (amount of channels, bit depth, sample rate, etc.), then call
381         * Resize() with the desired sample size. The latter will create
382       * the mandatory RIFF chunk which will hold the sample wave data.       * the mandatory RIFF chunk which will hold the sample wave data.
383       */       */
384      class Sample : public Resource {      class Sample : public Resource {
385          public:          public:
386              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()).
387              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).
388              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).
389              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).
390              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.
391              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).
392              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.              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.
393              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().
394    
395              void*         LoadSampleData();              void*         LoadSampleData();
396              void          ReleaseSampleData();              void          ReleaseSampleData();
# Line 401  namespace DLS { Line 415  namespace DLS {
415      /** Defines <i>Region</i> information of an <i>Instrument</i>. */      /** Defines <i>Region</i> information of an <i>Instrument</i>. */
416      class Region : public Resource, public Articulator, public Sampler {      class Region : public Resource, public Articulator, public Sampler {
417          public:          public:
418              range_t     KeyRange;              range_t     KeyRange; ///< @deprecated Only read, don't write! Use SetKeyRange() instead.
419              range_t     VelocityRange;              range_t     VelocityRange;
420              uint16_t    KeyGroup;              uint16_t    KeyGroup;
421              uint16_t    Layer;              uint16_t    Layer;
# Line 413  namespace DLS { Line 427  namespace DLS {
427    
428              Sample*     GetSample();              Sample*     GetSample();
429              void        SetSample(Sample* pSample);              void        SetSample(Sample* pSample);
430                virtual void SetKeyRange(uint16_t Low, uint16_t High);
431              virtual void UpdateChunks();              virtual void UpdateChunks();
432          protected:          protected:
433              RIFF::List* pCkRegion;              RIFF::List* pCkRegion;
# Line 453  namespace DLS { Line 468  namespace DLS {
468              RegionList::iterator RegionsIterator;              RegionList::iterator RegionsIterator;
469    
470              Instrument(File* pFile, RIFF::List* insList);              Instrument(File* pFile, RIFF::List* insList);
471              void LoadRegions();              virtual void LoadRegions();
472              virtual ~Instrument();              virtual ~Instrument();
473              friend class File;              friend class File;
474                friend class Region;
475            private:
476                void MoveRegion(Region* pSrc, Region* pDst);
477      };      };
478    
479      /** 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 483  namespace DLS { Line 501  namespace DLS {
501              typedef std::list<Instrument*> InstrumentList;              typedef std::list<Instrument*> InstrumentList;
502    
503              RIFF::File*              pRIFF;              RIFF::File*              pRIFF;
504                std::list<RIFF::File*>   ExtensionFiles;
505              SampleList*              pSamples;              SampleList*              pSamples;
506              SampleList::iterator     SamplesIterator;              SampleList::iterator     SamplesIterator;
507              InstrumentList*          pInstruments;              InstrumentList*          pInstruments;
# Line 493  namespace DLS { Line 512  namespace DLS {
512              uint32_t*                pWavePoolTableHi;              uint32_t*                pWavePoolTableHi;
513              bool                     b64BitWavePoolOffsets;              bool                     b64BitWavePoolOffsets;
514    
515              void LoadSamples();              virtual void LoadSamples();
516              void LoadInstruments();              virtual void LoadInstruments();
517              void __ensureMandatoryChunksExist();              void __ensureMandatoryChunksExist();
518              friend class Region; // Region has to look in the wave pool table to get its sample              friend class Region; // Region has to look in the wave pool table to get its sample
519          private:          private:
# Line 502  namespace DLS { Line 521  namespace DLS {
521              void __UpdateWavePoolTable();              void __UpdateWavePoolTable();
522      };      };
523    
524      /** Will be thrown whenever a DLS specific error occurs while trying to access a DLS File. */      /**
525         * Will be thrown whenever a DLS specific error occurs while trying to
526         * access a DLS File. Note: In your application you should better catch
527         * for RIFF::Exception rather than this one, except you explicitly want
528         * to catch and handle DLS::Exception and RIFF::Exception independently,
529         * which usually shouldn't be necessary though.
530         */
531      class Exception : public RIFF::Exception {      class Exception : public RIFF::Exception {
532          public:          public:
533              Exception(String Message);              Exception(String Message);
Legend:
Removed from v.800  
changed lines
  Added in v.1358
  ViewVC Help
Powered by ViewVC