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

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

Parent Directory | Revision Log | View Patch Patch

-revision 933 by schoenebeck,
Fri Nov 24 12:50:05 2006 UTC
+revision 1316 by schoenebeck,
Fri Aug 31 19:09:13 2007 UTC
 Line 2
   *                                                                         *
   *   libgig - C++ cross-platform Gigasampler format file access library    *
   *                                                                         *
-  *   Copyright (C) 2003-2006 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 38
  # define CHUNK_ID_3EWG  0x33657767
  # define CHUNK_ID_EWAV  0x65776176
  # define CHUNK_ID_3GNM  0x33676E6D
+ # define CHUNK_ID_EINF  0x65696E66
+ # define CHUNK_ID_3CRC  0x33637263
  #else  // little endian
  # define LIST_TYPE_3PRG 0x67727033
  # define LIST_TYPE_3EWL 0x6C776533
-Line 50
+Line 52
  # define CHUNK_ID_3EWG  0x67776533
  # define CHUNK_ID_EWAV  0x76617765
  # define CHUNK_ID_3GNM  0x6D6E6733
+ # define CHUNK_ID_EINF  0x666E6965
+ # define CHUNK_ID_3CRC  0x63726333
  #endif // WORDS_BIGENDIAN
  /** Gigasampler specific classes and definitions */
-Line 210 
 namespace gig {
+Line 214 
 namespace gig {
          dimension_none              = 0x00, ///< Dimension not in use.
          dimension_samplechannel     = 0x80, ///< If used sample has more than one channel (thus is not mono).
          dimension_layer             = 0x81, ///< For layering of up to 8 instruments (and eventually crossfading of 2 or 4 layers).
-         dimension_velocity          = 0x82, ///< Key Velocity (this is the only dimension where the ranges can exactly be defined).
+         dimension_velocity          = 0x82, ///< Key Velocity (this is the only dimension in gig2 where the ranges can exactly be defined).
          dimension_channelaftertouch = 0x83, ///< Channel Key Pressure
          dimension_releasetrigger    = 0x84, ///< Special dimension for triggering samples on releasing a key.
          dimension_keyboard          = 0x85, ///< Dimension for keyswitching
          dimension_roundrobin        = 0x86, ///< Different samples triggered each time a note is played, dimension regions selected in sequence
          dimension_random            = 0x87, ///< Different samples triggered each time a note is played, random order
+         dimension_smartmidi         = 0x88, ///< For MIDI tools like legato and repetition mode
+         dimension_roundrobinkeyboard = 0x89, ///< Different samples triggered each time a note is played, any key advances the counter
          dimension_modwheel          = 0x01, ///< Modulation Wheel (MIDI Controller 1)
          dimension_breath            = 0x02, ///< Breath Controller (Coarse, MIDI Controller 2)
          dimension_foot              = 0x04, ///< Foot Pedal (Coarse, MIDI Controller 4)
-Line 317 
 namespace gig {
+Line 323 
 namespace gig {
          progress_t();
      };
+     /** @brief CRC-32 checksum implementation
+      *
+      * This class is used to calculate checksums of the sample data in
+      * a gig file. The checksums are stored in the 3crc chunk of the
+      * gig file and automatically updated when a sample is written
+      * with Sample::Write().
+      */
+     class CRC {
+     private:
+         uint32_t value;
+         static const uint32_t* table;
+         static uint32_t* initTable();
+     public:
+         CRC() {
+             reset();
+         }
+         void reset() {
+             value = 0xffffffff;
+         }
+         void update(unsigned char* buf, int len) {
+             for (int i = 0 ; i < len ; i++) {
+                 value = table[(value ^ buf[i]) & 0xff] ^ (value >> 8);
+             }
+         }
+         uint32_t getValue() {
+             return value ^ 0xffffffff;
+         }
+     };
      // just symbol prototyping
      class File;
      class Instrument;
-Line 324 
 namespace gig {
+Line 359 
 namespace gig {
      class Region;
      class Group;
-     /** Encapsulates articulation information of a dimension region.
+     /** @brief Encapsulates articulation information of a dimension region.
       *
       *  Every Gigasampler Instrument has at least one dimension region
       *  (exactly then when it has no dimension defined).
-Line 338 
 namespace gig {
+Line 373 
 namespace gig {
       */
      class DimensionRegion : protected DLS::Sampler {
          public:
-             uint8_t            VelocityUpperLimit;            ///< Defines the upper velocity value limit of a velocity split (only if an user defined limit was set, thus a value not equal to 128/NumberOfSplits, else this value is 0).
+             uint8_t            VelocityUpperLimit;            ///< Defines the upper velocity value limit of a velocity split (only if an user defined limit was set, thus a value not equal to 128/NumberOfSplits, else this value is 0). Only for gig2, otherwise the DimensionUpperLimts are used instead.
              Sample*            pSample;                       ///< Points to the Sample which is assigned to the dimension region.
              // Sample Amplitude EG/LFO
              uint16_t           EG1PreAttack;                  ///< Preattack value of the sample amplitude EG (0 - 1000 permille).
-Line 422 
 namespace gig {
+Line 457 
 namespace gig {
              bool               MSDecode;                      ///< Gigastudio flag: defines if Mid Side Recordings should be decoded.
              uint16_t           SampleStartOffset;             ///< Number of samples the sample start should be moved (0 - 2000).
              double             SampleAttenuation;             ///< Sample volume (calculated from DLS::Sampler::Gain)
+             uint8_t            DimensionUpperLimits[8];       ///< gig3: defines the upper limit of the dimension values for this dimension region
              // derived attributes from DLS::Sampler
              DLS::Sampler::UnityNote;
-Line 434 
 namespace gig {
+Line 470 
 namespace gig {
              double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);
              double GetVelocityRelease(uint8_t MIDIKeyVelocity);
              double GetVelocityCutoff(uint8_t MIDIKeyVelocity);
+             Region* GetParent() const;
+             // derived methods
+             DLS::Sampler::AddSampleLoop;
+             DLS::Sampler::DeleteSampleLoop;
              // overridden methods
              virtual void UpdateChunks();
          protected:
              uint8_t* VelocityTable; ///< For velocity dimensions with custom defined zone ranges only: used for fast converting from velocity MIDI value to dimension bit number.
-             DimensionRegion(RIFF::List* _3ewl);
+             DimensionRegion(Region* pParent, RIFF::List* _3ewl);
+             DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src);
             ~DimensionRegion();
              friend class Region;
          private:
-Line 477 
 namespace gig {
+Line 518 
 namespace gig {
              double*                  pVelocityAttenuationTable;  ///< Points to the velocity table corresponding to the velocity parameters of this DimensionRegion.
              double*                  pVelocityReleaseTable;      ///< Points to the velocity table corresponding to the release velocity parameters of this DimensionRegion
              double*                  pVelocityCutoffTable;       ///< Points to the velocity table corresponding to the filter velocity parameters of this DimensionRegion
+             Region*                  pRegion;
              leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);
              _lev_ctrl_t     EncodeLeverageController(leverage_ctrl_t DecodedController);
-Line 493 
 namespace gig {
+Line 535 
 namespace gig {
       * will create the mandatory RIFF chunk which will hold the sample wave
       * data and / or resize the file so you will be able to Write() the
       * sample data directly to disk.
+      *
+      * @e Caution: for gig synthesis, most looping relevant information are
+      * retrieved from the respective DimensionRegon instead from the Sample
+      * itself. This was made for allowing different loop definitions for the
+      * same sample under different conditions.
       */
      class Sample : public DLS::Sample {
          public:
-Line 503 
 namespace gig {
+Line 550 
 namespace gig {
              uint32_t       FineTune;          ///< Specifies the fraction of a semitone up from the specified MIDI unity note field. A value of 0x80000000 means 1/2 semitone (50 cents) and a value of 0x00000000 means no fine tuning between semitones.
              smpte_format_t SMPTEFormat;       ///< Specifies the Society of Motion Pictures and Television E time format used in the following <i>SMPTEOffset</i> field. If a value of 0 is set, <i>SMPTEOffset</i> should also be set to 0.
              uint32_t       SMPTEOffset;       ///< The SMPTE Offset value specifies the time offset to be used for the synchronization / calibration to the first sample in the waveform. This value uses a format of 0xhhmmssff where hh is a signed value that specifies the number of hours (-23 to 23), mm is an unsigned value that specifies the number of minutes (0 to 59), ss is an unsigned value that specifies the number of seconds (0 to 59) and ff is an unsigned value that specifies the number of frames (0 to -1).
-             uint32_t       Loops;             ///< Number of defined sample loops (so far only seen single loops in gig files - please report me if you encounter more!).
+             uint32_t       Loops;             ///< @e Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: Number of defined sample loops. So far only seen single loops in gig files - please report if you encounter more!)
              uint32_t       LoopID;            ///< Specifies the unique ID that corresponds to one of the defined cue points in the cue point list (only if Loops > 0), as the Gigasampler format only allows one loop definition at the moment, this attribute isn't really useful for anything.
-             loop_type_t    LoopType;          ///< The type field defines how the waveform samples will be looped (only if Loops > 0).
+             loop_type_t    LoopType;          ///< @e Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: The type field defines how the waveform samples will be looped.)
-             uint32_t       LoopStart;         ///< The start value specifies the offset (in sample points) in the waveform data of the first sample to be played in the loop (only if Loops > 0).
+             uint32_t       LoopStart;         ///< @e Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: The start value specifies the offset [in sample points] in the waveform data of the first sample to be played in the loop [only if Loops > 0].)
-             uint32_t       LoopEnd;           ///< The end value specifies the offset (in sample points) in the waveform data which represents the end of the loop (only if Loops > 0).
+             uint32_t       LoopEnd;           ///< @e Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: The end value specifies the offset [in sample points] in the waveform data which represents the end of the loop [only if Loops > 0].)
-             uint32_t       LoopSize;          ///< Length of the looping area (in sample points) which is equivalent to <i>LoopEnd - LoopStart</i>.
+             uint32_t       LoopSize;          ///< @e Caution: Use the respective fields in the DimensionRegion instead of this one! (Intended purpose: Length of the looping area [in sample points] which is equivalent to @code LoopEnd - LoopStart @endcode.)
-             uint32_t       LoopFraction;      ///< The fractional value specifies a fraction of a sample at which to loop (only if Loops > 0). This allows a loop to be fine tuned at a resolution greater than one sample. A value of 0 means no fraction, a value of 0x80000000 means 1/2 of a sample length. 0xFFFFFFFF is the smallest fraction of a sample that can be represented.
+             uint32_t       LoopFraction;      ///< The fractional value specifies a fraction of a sample at which to loop. This allows a loop to be fine tuned at a resolution greater than one sample. A value of 0 means no fraction, a value of 0x80000000 means 1/2 of a sample length. 0xFFFFFFFF is the smallest fraction of a sample that can be represented.
-             uint32_t       LoopPlayCount;     ///< Number of times the loop should be played (only if Loops > 0, a value of 0 = infinite).
+             uint32_t       LoopPlayCount;     ///< Number of times the loop should be played (a value of 0 = infinite).
              bool           Compressed;        ///< If the sample wave is compressed (probably just interesting for instrument and sample editors, as this library already handles the decompression in it's sample access methods anyway).
              uint32_t       TruncatedBits;     ///< For 24-bit compressed samples only: number of bits truncated during compression (0, 4 or 6)
              bool           Dithered;          ///< For 24-bit compressed samples only: if dithering was used during compression with bit reduction
-Line 548 
 namespace gig {
+Line 595 
 namespace gig {
              unsigned long        FileNo;                  ///< File number (> 0 when sample is stored in an extension file, 0 when it's in the gig)
              RIFF::Chunk*         pCk3gix;
              RIFF::Chunk*         pCkSmpl;
+             CRC                  crc;                     ///< CRC-32 checksum of the raw sample data
              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo = 0);
             ~Sample();
-Line 629 
 namespace gig {
+Line 677 
 namespace gig {
              // derived methods from DLS::Resource
              DLS::Resource::GetParent;
+             // derived methods from DLS::Instrument
+             DLS::Instrument::MoveRegion;
              // overridden methods
              Region*   GetFirstRegion();
              Region*   GetNextRegion();
-Line 682 
 namespace gig {
+Line 732 
 namespace gig {
      /** Parses Gigasampler files and provides abstract access to the data. */
      class File : protected DLS::File {
          public:
+             static const DLS::version_t VERSION_2;
+             static const DLS::version_t VERSION_3;
              // derived attributes from DLS::Resource
              DLS::Resource::pInfo;
              DLS::Resource::pDLSID;
-Line 710 
 namespace gig {
+Line 763 
 namespace gig {
              Group*      GetGroup(uint index);
              Group*      AddGroup();
              void        DeleteGroup(Group* pGroup);
+             void        DeleteGroupOnly(Group* pGroup);
              virtual    ~File();
+             virtual void UpdateChunks();
          protected:
              // overridden protected methods from DLS::File
              virtual void LoadSamples();
-Line 719 
 namespace gig {
+Line 774 
 namespace gig {
              // own protected methods
              virtual void LoadSamples(progress_t* pProgress);
              virtual void LoadInstruments(progress_t* pProgress);
+             void SetSampleChecksum(Sample* pSample, uint32_t crc);
              friend class Region;
              friend class Sample;
              friend class Group; // so Group can access protected member pRIFF
          private:
+             static const DLS::Info::FixedStringLength FixedStringLengths[];
              std::list<Group*>*          pGroups;
              std::list<Group*>::iterator GroupsIterator;
      };
-     /** Will be thrown whenever a gig specific error occurs while trying to access a Gigasampler File. */
+     /**
+      * Will be thrown whenever a gig specific error occurs while trying to
+      * access a Gigasampler File. Note: In your application you should
+      * better catch for RIFF::Exception rather than this one, except you
+      * explicitly want to catch and handle gig::Exception, DLS::Exception
+      * and RIFF::Exception independently, which usually shouldn't be
+      * necessary though.
+      */
      class Exception : public DLS::Exception {
          public:
              Exception(String Message);

 Legend:



Removed from v.933
 


changed lines


 
Added in v.1316
 Legend:



Removed from v.933
 


changed lines


 
Added in v.1316
-Removed from v.933
+Added in v.1316

	ViewVC Help
Powered by ViewVC