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

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

Parent Directory | Revision Log | View Patch Patch

-revision 36 by schoenebeck,
Wed Mar 10 21:34:28 2004 UTC
+revision 1180 by persson,
Sat May 12 12:39:25 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 by Christian Schoenebeck                           *
+  *   Copyright (C) 2003-2007 by Christian Schoenebeck                      *
-  *                         <cuse@users.sourceforge.net>                    *
+  *                              <cuse@users.sourceforge.net>               *
   *                                                                         *
   *   This library is free software; you can redistribute it and/or modify  *
   *   it under the terms of the GNU General Public License as published by  *
 Line 26
  #include "DLS.h"
- #include <math.h>
- #include <string.h>
- /// Initial size of the sample buffer which is used for decompression of
- /// compressed sample wave streams - this value should always be bigger than
- /// the biggest sample piece expected to be read by the sampler engine,
- /// otherwise the buffer size will be raised at runtime and thus the buffer
- /// reallocated which is time consuming and unefficient.
- #define INITIAL_SAMPLE_BUFFER_SIZE              512000 // 512 kB
  #if WORDS_BIGENDIAN
  # define LIST_TYPE_3PRG 0x33707267
  # define LIST_TYPE_3EWL 0x3365776C
+ # define LIST_TYPE_3GRI 0x33677269
+ # define LIST_TYPE_3GNL 0x33676E6C
  # define CHUNK_ID_SMPL  0x736D706C
  # define CHUNK_ID_3GIX  0x33676978
  # define CHUNK_ID_3EWA  0x33657761
  # define CHUNK_ID_3LNK  0x336C6E6B
  # define CHUNK_ID_3EWG  0x33657767
  # define CHUNK_ID_EWAV  0x65776176
+ # define CHUNK_ID_3GNM  0x33676E6D
  #else  // little endian
  # define LIST_TYPE_3PRG 0x67727033
  # define LIST_TYPE_3EWL 0x6C776533
+ # define LIST_TYPE_3GRI 0x69726733
+ # define LIST_TYPE_3GNL 0x6C6E6733
  # define CHUNK_ID_SMPL  0x6C706D73
  # define CHUNK_ID_3GIX  0x78696733
  # define CHUNK_ID_3EWA  0x61776533
  # define CHUNK_ID_3LNK  0x6B6E6C33
  # define CHUNK_ID_3EWG  0x67776533
  # define CHUNK_ID_EWAV  0x76617765
+ # define CHUNK_ID_3GNM  0x6D6E6733
  #endif // WORDS_BIGENDIAN
- /** (so far) every exponential paramater in the gig format has a basis of 1.000000008813822 */
- #define GIG_EXP_DECODE(x)                                       (pow(1.000000008813822, x))
- #define GIG_PITCH_TRACK_EXTRACT(x)                              (!(x & 0x01))
- #define GIG_VCF_RESONANCE_CTRL_EXTRACT(x)                       ((x >> 4) & 0x03)
- #define GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(x)                  ((x >> 1) & 0x03)
- #define GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(x)                   ((x >> 3) & 0x03)
- #define GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(x)                 ((x >> 5) & 0x03)
- //TODO: the transformation functions are not very accurate compared to the original ones
- #define GIG_VELOCITY_TRANSFORM_NONLINEAR(x,dynamic,scale)       ((1.0-1.0/pow(x,1.0/(129.0-x))) * (1.0+scale/20.0) + (5.0-dynamic)*pow(x/300.0* (1.0+2.0*scale/128.0),2))
- #define GIG_VELOCITY_TRANSFORM_LINEAR(x,dynamic,scale)          ((1.0+scale*3.0/128.0)/110.0*x+(5.0-dynamic)/5.0+(5.0-dynamic)*scale)
- #define GIG_VELOCITY_TRANSFORM_SPECIAL(x,dynamic,scale)         ((1.0+9.0*scale/129.0)*(1.0-1.0/pow(x,1.0/(129.0-x))+pow(3.0*x/pow(129,2),2)+pow((5.0-dynamic)*x/500.0,2)))
  /** Gigasampler specific classes and definitions */
  namespace gig {
-Line 84 
 namespace gig {
+Line 68 
 namespace gig {
          void*         pStart;            ///< Points to the beginning of the buffer.
          unsigned long Size;              ///< Size of the actual data in the buffer in bytes.
          unsigned long NullExtensionSize; ///< The buffer might be bigger than the actual data, if that's the case that unused space at the end of the buffer is filled with NULLs and NullExtensionSize reflects that unused buffer space in bytes. Those NULL extensions are mandatory for differential algorithms that have to take the following data words into account, thus have to access past the buffer's boundary. If you don't know what I'm talking about, just forget this variable. :)
+         buffer_t() {
+             pStart            = NULL;
+             Size              = 0;
+             NullExtensionSize = 0;
+         }
      };
      /** Standard types of sample loops. */
-Line 147 
 namespace gig {
+Line 136 
 namespace gig {
      /** Defines how the filter cutoff frequency is controlled by. */
      typedef enum {
          vcf_cutoff_ctrl_none         = 0x00,
+         vcf_cutoff_ctrl_none2        = 0x01,  ///< The difference between none and none2 is unknown
          vcf_cutoff_ctrl_modwheel     = 0x81,  ///< Modulation Wheel (MIDI Controller 1)
          vcf_cutoff_ctrl_effect1      = 0x8c,  ///< Effect Controller 1 (Coarse, MIDI Controller 12)
          vcf_cutoff_ctrl_effect2      = 0x8d,  ///< Effect Controller 2 (Coarse, MIDI Controller 13)
-Line 167 
 namespace gig {
+Line 157 
 namespace gig {
          vcf_res_ctrl_genpurpose5 = 2,           ///< General Purpose Controller 5 (Button, MIDI Controller 80)
          vcf_res_ctrl_genpurpose6 = 3            ///< General Purpose Controller 6 (Button, MIDI Controller 81)
      } vcf_res_ctrl_t;
      /**
       * Defines a controller that has a certain contrained influence on a
       * particular synthesis parameter (used to define attenuation controller,
-Line 183 
 namespace gig {
+Line 173 
 namespace gig {
              type_velocity          = 0xff, ///< Key Velocity
              type_controlchange     = 0xfe  ///< Ordinary MIDI control change controller, see field 'controller_number'
          } type_t;
          type_t type;              ///< Controller type
          uint   controller_number; ///< MIDI controller number if this controller is a control change controller, 0 otherwise
      };
      /**
       * Defines controller influencing attenuation.
       *
       * @see leverage_ctrl_t
       */
      typedef leverage_ctrl_t attenuation_ctrl_t;
      /**
       * Defines controller influencing envelope generator 1.
       *
       * @see leverage_ctrl_t
       */
      typedef leverage_ctrl_t eg1_ctrl_t;
      /**
       * Defines controller influencing envelope generator 2.
       *
-Line 220 
 namespace gig {
+Line 210 
 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, ///< Key Position
+         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 254 
 namespace gig {
+Line 248 
 namespace gig {
       * into the corresponding dimension bit number.
       */
      typedef enum {
-         split_type_normal,         ///< dimension value between 0-127, no custom range of zones
+         split_type_normal,         ///< dimension value between 0-127
-         split_type_customvelocity, ///< a velocity dimension split with custom range definition for each zone (if a velocity dimension split has no custom defined zone ranges then it's also just of type split_type_normal)
          split_type_bit             ///< dimension values are already the sought bit number
      } split_type_t;
-Line 265 
 namespace gig {
+Line 258 
 namespace gig {
          uint8_t      bits;       ///< Number of "bits" (1 bit = 2 splits/zones, 2 bit = 4 splits/zones, 3 bit = 8 splits/zones,...).
          uint8_t      zones;      ///< Number of zones the dimension has.
          split_type_t split_type; ///< Intended for internal usage: will be used to convert a dimension value into the corresponding dimension bit number.
-         range_t*     ranges;     ///< Intended for internal usage: Points to the beginning of a range_t array which reflects the value ranges of each dimension zone (only if custom defined ranges are defined, is NULL otherwise).
+         float        zone_size;  ///< Intended for internal usage: reflects the size of each zone (128/zones) for normal split types only, 0 otherwise.
-         unsigned int zone_size;  ///< Intended for internal usage: reflects the size of each zone (128/zones) for normal split types only, 0 otherwise.
      };
      /** Defines which frequencies are filtered by the VCF. */
-Line 278 
 namespace gig {
+Line 270 
 namespace gig {
          vcf_type_bandreject   = 0x03
      } vcf_type_t;
-     /** Defines the envelope of a crossfade. */
+     /**
+      * Defines the envelope of a crossfade.
+      *
+      * Note: The default value for crossfade points is 0,0,0,0. Layers with
+      * such a default value should be treated as if they would not have a
+      * crossfade.
+      */
      struct crossfade_t {
          #if WORDS_BIGENDIAN
-         uint8_t in_start;   ///< Start position of fade in.
-         uint8_t in_end;     ///< End position of fade in.
-         uint8_t out_start;  ///< Start position of fade out.
-         uint8_t out_end;    ///< End postition of fade out.
-         #else // little endian
          uint8_t out_end;    ///< End postition of fade out.
          uint8_t out_start;  ///< Start position of fade out.
          uint8_t in_end;     ///< End position of fade in.
          uint8_t in_start;   ///< Start position of fade in.
+         #else // little endian
+         uint8_t in_start;   ///< Start position of fade in.
+         uint8_t in_end;     ///< End position of fade in.
+         uint8_t out_start;  ///< Start position of fade out.
+         uint8_t out_end;    ///< End postition of fade out.
          #endif // WORDS_BIGENDIAN
      };
-Line 300 
 namespace gig {
+Line 298 
 namespace gig {
          unsigned long loop_cycles_left;  ///< How many times the loop has still to be passed, this value will be decremented with each loop cycle.
      };
+     /**
+      * @brief Used for indicating the progress of a certain task.
+      *
+      * The function pointer argument has to be supplied with a valid
+      * function of the given signature which will then be called on
+      * progress changes. An equivalent progress_t structure will be passed
+      * back as argument to the callback function on each progress change.
+      * The factor field of the supplied progress_t structure will then
+      * reflect the current progress as value between 0.0 and 1.0. You might
+      * want to use the custom field for data needed in your callback
+      * function.
+      */
+     struct progress_t {
+         void (*callback)(progress_t*); ///< Callback function pointer which has to be assigned to a function for progress notification.
+         float factor;                  ///< Reflects current progress as value between 0.0 and 1.0.
+         void* custom;                  ///< This pointer can be used for arbitrary data.
+         float __range_min;             ///< Only for internal usage, do not modify!
+         float __range_max;             ///< Only for internal usage, do not modify!
+         progress_t();
+     };
      // just symbol prototyping
      class File;
      class Instrument;
      class Sample;
+     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 319 
 namespace gig {
+Line 340 
 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 372 
 namespace gig {
+Line 393 
 namespace gig {
              bool               VCFEnabled;                    ///< If filter should be used.
              vcf_type_t         VCFType;                       ///< Defines the general filter characteristic (lowpass, highpass, bandpass, etc.).
              vcf_cutoff_ctrl_t  VCFCutoffController;           ///< Specifies which external controller has influence on the filter cutoff frequency.
+             bool               VCFCutoffControllerInvert;     ///< Inverts values coming from the defined cutoff controller
              uint8_t            VCFCutoff;                     ///< Max. cutoff frequency.
              curve_type_t       VCFVelocityCurve;              ///< Defines a transformation curve for the incoming velocity values, affecting the VCF.
-             uint8_t            VCFVelocityScale;              ///< (0-127) Amount velocity controls VCF cutoff frequency (only if no other VCF cutoff controller is defined).
+             uint8_t            VCFVelocityScale;              ///< (0-127) Amount velocity controls VCF cutoff frequency (only if no other VCF cutoff controller is defined, otherwise this is the minimum cutoff).
              uint8_t            VCFVelocityDynamicRange;       ///< 0x04 = lowest, 0x00 = highest
              uint8_t            VCFResonance;                  ///< Firm internal filter resonance weight.
              bool               VCFResonanceDynamic;           ///< If <i>true</i>: Increases the resonance Q according to changes of controllers that actually control the VCF cutoff frequency (EG2, ext. VCF MIDI controller).
-Line 382 
 namespace gig {
+Line 404 
 namespace gig {
              bool               VCFKeyboardTracking;           ///< If <i>true</i>: VCF cutoff frequence will be dependend to the note key position relative to the defined breakpoint value.
              uint8_t            VCFKeyboardTrackingBreakpoint; ///< See VCFKeyboardTracking (0 - 127).
              // Key Velocity Transformations
-             curve_type_t       VelocityResponseCurve;         ///< Defines a transformation curve to the incoming velocity values affecting amplitude.
+             curve_type_t       VelocityResponseCurve;         ///< Defines a transformation curve to the incoming velocity values affecting amplitude (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead).
-             uint8_t            VelocityResponseDepth;         ///< Dynamic range of velocity affecting amplitude (0 - 4).
+             uint8_t            VelocityResponseDepth;         ///< Dynamic range of velocity affecting amplitude (0 - 4) (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead).
-             uint8_t            VelocityResponseCurveScaling;  ///< 0 - 127
+             uint8_t            VelocityResponseCurveScaling;  ///< 0 - 127 (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead)
              curve_type_t       ReleaseVelocityResponseCurve;  ///< Defines a transformation curve to the incoming release veloctiy values affecting envelope times.
              uint8_t            ReleaseVelocityResponseDepth;  ///< Dynamic range of release velocity affecting envelope time (0 - 4).
              uint8_t            ReleaseTriggerDecay;           ///< 0 - 8
-Line 401 
 namespace gig {
+Line 423 
 namespace gig {
              bool               SustainDefeat;                 ///< If <i>true</i>: Sustain pedal will not hold a note.
              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;
              DLS::Sampler::FineTune;
-Line 408 
 namespace gig {
+Line 433 
 namespace gig {
              DLS::Sampler::SampleLoops;
              DLS::Sampler::pSampleLoops;
-             // Methods
+             // own methods
              double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);
+             double GetVelocityRelease(uint8_t MIDIKeyVelocity);
+             double GetVelocityCutoff(uint8_t MIDIKeyVelocity);
+             // 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();
              friend class Region;
-Line 442 
 namespace gig {
+Line 475 
 namespace gig {
                  _lev_ctrl_effect5depth      = 0x2d, ///< Effect 5 Depth (MIDI Controller 95)
                  _lev_ctrl_channelaftertouch = 0x2f, ///< Channel Key Pressure
                  _lev_ctrl_velocity          = 0xff  ///< Key Velocity
              } _lev_ctrl_t;
              typedef std::map<uint32_t, double*> VelocityTableMap;
              static uint              Instances;                  ///< Number of DimensionRegion instances.
              static VelocityTableMap* pVelocityTables;            ///< Contains the tables corresponding to the various velocity parameters (VelocityResponseCurve and VelocityResponseDepth).
              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
              leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);
+             _lev_ctrl_t     EncodeLeverageController(leverage_ctrl_t DecodedController);
+             double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
+             double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
      };
-     /** 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, followed by File::Save(), this
+      * 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:
-             uint16_t       SampleGroup;
              uint32_t       Manufacturer;      ///< Specifies the MIDI Manufacturer's Association (MMA) Manufacturer code for the sampler intended to receive this file's waveform. If no particular manufacturer is to be specified, a value of 0 should be used.
              uint32_t       Product;           ///< Specifies the MIDI model ID defined by the manufacturer corresponding to the Manufacturer field. If no particular manufacturer's product is to be specified, a value of 0 should be used.
-             uint32_t       SamplePeriod;      ///< Specifies the duration of time that passes during the playback of one sample in nanoseconds (normally equal to 1 / Samplers Per Second, where Samples Per Second is the value found in the format chunk).
+             uint32_t       SamplePeriod;      ///< Specifies the duration of time that passes during the playback of one sample in nanoseconds (normally equal to 1 / Samples Per Second, where Samples Per Second is the value found in the format chunk), don't bother to update this attribute, it won't be saved.
              uint32_t       MIDIUnityNote;     ///< Specifies the musical note at which the sample will be played at it's original sample rate.
              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
              // own methods
              buffer_t      LoadSampleData();
-Line 479 
 namespace gig {
+Line 532 
 namespace gig {
              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);
              buffer_t      LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);
              buffer_t      GetCache();
+             // own static methods
+             static buffer_t CreateDecompressionBuffer(unsigned long MaxReadSize);
+             static void     DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);
              // overridden methods
              void          ReleaseSampleData();
+             void          Resize(int iNewSize);
              unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
              unsigned long GetPos();
-             unsigned long Read(void* pBuffer, unsigned long SampleCount);
+             unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);
-             unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState);
+             unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState, DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer = NULL);
+             unsigned long Write(void* pBuffer, unsigned long SampleCount);
+             Group*        GetGroup() const;
+             virtual void  UpdateChunks();
          protected:
              static unsigned int  Instances;               ///< Number of instances of class Sample.
-             static unsigned long DecompressionBufferSize; ///< Current size of the decompression buffer.
+             static buffer_t      InternalDecompressionBuffer; ///< Buffer used for decompression as well as for truncation of 24 Bit -> 16 Bit samples.
-             static void*         pDecompressionBuffer;    ///< Small buffer used for decompression only.
+             Group*               pGroup;                  ///< pointer to the Group this sample belongs to (always not-NULL)
              unsigned long        FrameOffset;             ///< Current offset (sample points) in current sample frame (for decompression only).
              unsigned long*       FrameTable;              ///< For positioning within compressed samples only: stores the offset values for each frame.
              unsigned long        SamplePos;               ///< For compressed samples only: stores the current position (in sample points).
+             unsigned long        SamplesInLastFrame;      ///< For compressed samples only: length of the last sample frame.
+             unsigned long        WorstCaseFrameSize;      ///< For compressed samples only: size (in bytes) of the largest possible sample frame.
+             unsigned long        SamplesPerFrame;         ///< For compressed samples only: number of samples in a full sample frame.
              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.
+             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;
-             Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);
+             Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo = 0);
             ~Sample();
-             /**
-              * Swaps the order of the data words in the given memory area
+             // Guess size (in bytes) of a compressed sample
-              * with a granularity given by \a WordSize.
+             inline unsigned long GuessSize(unsigned long samples) {
-              *
+                 // 16 bit: assume all frames are compressed - 1 byte
-              * @param pData    - pointer to the memory area to be swapped
+                 // per sample and 5 bytes header per 2048 samples
-              * @param AreaSize - size of the memory area to be swapped (in bytes)
-              * @param WordSize - size of the data words (in bytes)
+                 // 24 bit: assume next best compression rate - 1.5
-              */
+                 // bytes per sample and 13 bytes header per 256
-             inline void SwapMemoryArea(void* pData, unsigned long AreaSize, uint WordSize) {
+                 // samples
-                 switch (WordSize) { // TODO: unefficient
+                 const unsigned long size =
-                     case 1: {
+                     BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13
-                         uint8_t* pDst = (uint8_t*) pData;
+                                    : samples + (samples >> 10) * 5;
-                         uint8_t  cache;
+                 // Double for stereo and add one worst case sample
-                         unsigned long lo = 0, hi = AreaSize - 1;
+                 // frame
-                         for (; lo < hi; hi--, lo++) {
+                 return (Channels == 2 ? size << 1 : size) + WorstCaseFrameSize;
-                             cache    = pDst[lo];
-                             pDst[lo] = pDst[hi];
-                             pDst[hi] = cache;
-                         }
-                         break;
-                     }
-                     case 2: {
-                         uint16_t* pDst = (uint16_t*) pData;
-                         uint16_t  cache;
-                         unsigned long lo = 0, hi = (AreaSize >> 1) - 1;
-                         for (; lo < hi; hi--, lo++) {
-                             cache    = pDst[lo];
-                             pDst[lo] = pDst[hi];
-                             pDst[hi] = cache;
-                         }
-                         break;
-                     }
-                     case 4: {
-                         uint32_t* pDst = (uint32_t*) pData;
-                         uint32_t  cache;
-                         unsigned long lo = 0, hi = (AreaSize >> 2) - 1;
-                         for (; lo < hi; hi--, lo++) {
-                             cache    = pDst[lo];
-                             pDst[lo] = pDst[hi];
-                             pDst[hi] = cache;
-                         }
-                         break;
-                     }
-                     default: {
-                         uint8_t* pCache = new uint8_t[WordSize]; // TODO: unefficient
-                         unsigned long lo = 0, hi = AreaSize - WordSize;
-                         for (; lo < hi; hi -= WordSize, lo += WordSize) {
-                             memcpy(pCache, (uint8_t*) pData + lo, WordSize);
-                             memcpy((uint8_t*) pData + lo, (uint8_t*) pData + hi, WordSize);
-                             memcpy((uint8_t*) pData + hi, pCache, WordSize);
-                         }
-                         delete[] pCache;
-                         break;
-                     }
-                 }
              }
-             inline long Min(long A, long B) {
-                 return (A > B) ? B : A;
+             // Worst case amount of sample points that can be read with the
+             // given decompression buffer.
+             inline unsigned long WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {
+                 return (unsigned long) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);
              }
-             inline long Abs(long val) { return (val > 0) ? val : -val; }
          private:
              void ScanCompressedSample();
              friend class File;
              friend class Region;
+             friend class Group; // allow to modify protected member pGroup
      };
      // TODO: <3dnl> list not used yet - not important though (just contains optional descriptions for the dimensions)
      /** Defines <i>Region</i> information of an <i>Instrument</i>. */
      class Region : public DLS::Region {
          public:
-             unsigned int            Dimensions;               ///< Number of defined dimensions.
+             unsigned int            Dimensions;               ///< Number of defined dimensions, do not alter!
-             dimension_def_t         pDimensionDefinitions[5]; ///< Defines the five possible dimensions (the dimension's controller and number of bits/splits).
+             dimension_def_t         pDimensionDefinitions[8]; ///< Defines the five (gig2) or eight (gig3) possible dimensions (the dimension's controller and number of bits/splits). Use AddDimension() and DeleteDimension() to create a new dimension or delete an existing one.
-             uint32_t                DimensionRegions;         ///< Total number of DimensionRegions this Region contains.
+             uint32_t                DimensionRegions;         ///< Total number of DimensionRegions this Region contains, do not alter!
-             DimensionRegion*        pDimensionRegions[32];    ///< Pointer array to the 32 possible dimension regions (reflects NULL for dimension regions not in use). Avoid to access the array directly and better use GetDimensionRegionByValue() instead, but of course in some cases it makes sense to use the array (e.g. iterating through all DimensionRegions).
+             DimensionRegion*        pDimensionRegions[256];   ///< Pointer array to the 32 (gig2) or 256 (gig3) possible dimension regions (reflects NULL for dimension regions not in use). Avoid to access the array directly and better use GetDimensionRegionByValue() instead, but of course in some cases it makes sense to use the array (e.g. iterating through all DimensionRegions). Use AddDimension() and DeleteDimension() to create a new dimension or delete an existing one (which will create or delete the respective dimension region(s) automatically).
+             unsigned int            Layers;                   ///< Amount of defined layers (1 - 32). A value of 1 actually means no layering, a value > 1 means there is Layer dimension. The same information can of course also be obtained by accessing pDimensionDefinitions. Do not alter this value!
-             DimensionRegion* GetDimensionRegionByValue(uint Dim4Val, uint Dim3Val, uint Dim2Val, uint Dim1Val, uint Dim0Val);
+             DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);
-             DimensionRegion* GetDimensionRegionByBit(uint8_t Dim4Bit, uint8_t Dim3Bit, uint8_t Dim2Bit, uint8_t Dim1Bit, uint8_t Dim0Bit);
+             DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);
              Sample*          GetSample();
+             void             AddDimension(dimension_def_t* pDimDef);
+             void             DeleteDimension(dimension_def_t* pDimDef);
+             virtual void     UpdateChunks();
          protected:
-             uint8_t VelocityTable[128]; ///< For velocity dimensions with custom defined zone ranges only: used for fast converting from velocity MIDI value to dimension bit number.
              Region(Instrument* pInstrument, RIFF::List* rgnList);
              void LoadDimensionRegions(RIFF::List* rgn);
-             Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex);
+             void UpdateVelocityTable();
+             Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);
             ~Region();
              friend class Instrument;
      };
-Line 608 
 namespace gig {
+Line 640 
 namespace gig {
              // derived methods from DLS::Resource
              DLS::Resource::GetParent;
+             // derived methods from DLS::Instrument
+             DLS::Instrument::MoveRegion;
              // overridden methods
              Region*   GetFirstRegion();
              Region*   GetNextRegion();
+             Region*   AddRegion();
+             void      DeleteRegion(Region* pRegion);
+             virtual void UpdateChunks();
              // own methods
              Region*   GetRegion(unsigned int Key);
          protected:
-             Region**  pRegions;            ///< Pointer array to the regions
              Region*   RegionKeyTable[128]; ///< fast lookup for the corresponding Region of a MIDI key
-             int       RegionIndex;
-             Instrument(File* pFile, RIFF::List* insList);
+             Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);
             ~Instrument();
+             void UpdateRegionKeyTable();
+             friend class File;
+     };
+     /** @brief Group of Gigasampler objects
+      *
+      * Groups help to organize a huge collection of Gigasampler objects.
+      * Groups are not concerned at all for the synthesis, but they help
+      * sound library developers when working on complex instruments with an
+      * instrument editor (as long as that instrument editor supports it ;-).
+      *
+      * At the moment, it seems as only samples can be grouped together in
+      * the Gigasampler format yet. If this is false in the meantime, please
+      * tell us !
+      *
+      * A sample is always assigned to exactly one Group. This also means
+      * there is always at least one Group in a .gig file, no matter if you
+      * created one yet or not.
+      */
+     class Group {
+         public:
+             String Name; ///< Stores the name of this Group.
+             Sample* GetFirstSample();
+             Sample* GetNextSample();
+             void AddSample(Sample* pSample);
+         protected:
+             Group(File* file, RIFF::Chunk* ck3gnm);
+             virtual ~Group();
+             virtual void UpdateChunks();
+             void MoveAll();
              friend class File;
+         private:
+             File*        pFile;
+             RIFF::Chunk* pNameChunk;
      };
-     // TODO: <3gnm> chunk not added yet (just contains the names of the sample groups)
      /** Parses Gigasampler files and provides abstract access to the data. */
      class File : protected DLS::File {
          public:
-Line 636 
 namespace gig {
+Line 704 
 namespace gig {
              // derived methods from DLS::Resource
              DLS::Resource::GetParent;
+             // derived methods from DLS::File
+             DLS::File::Save;
              // overridden  methods
+             File();
              File(RIFF::File* pRIFF);
-             Sample*     GetFirstSample();     ///< Returns a pointer to the first <i>Sample</i> object of the file, <i>NULL</i> otherwise.
+             Sample*     GetFirstSample(progress_t* pProgress = NULL); ///< 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* GetInstrument(uint index);
+             Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);
-            ~File() {};
+             Instrument* AddInstrument();
+             void        DeleteInstrument(Instrument* pInstrument);
+             Group*      GetFirstGroup(); ///< Returns a pointer to the first <i>Group</i> object of the file, <i>NULL</i> otherwise.
+             Group*      GetNextGroup();  ///< Returns a pointer to the next <i>Group</i> object of the file, <i>NULL</i> otherwise.
+             Group*      GetGroup(uint index);
+             Group*      AddGroup();
+             void        DeleteGroup(Group* pGroup);
+             void        DeleteGroupOnly(Group* pGroup);
+             virtual    ~File();
+             virtual void UpdateChunks();
          protected:
-             typedef std::list<Sample*>     SampleList;
+             // overridden protected methods from DLS::File
-             typedef std::list<Instrument*> InstrumentList;
+             virtual void LoadSamples();
+             virtual void LoadInstruments();
-             SampleList*              pSamples;
+             virtual void LoadGroups();
-             SampleList::iterator     SamplesIterator;
+             // own protected methods
-             InstrumentList*          pInstruments;
+             virtual void LoadSamples(progress_t* pProgress);
-             InstrumentList::iterator InstrumentsIterator;
+             virtual void LoadInstruments(progress_t* pProgress);
-             void LoadSamples();
-             void LoadInstruments();
              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);
              void PrintMessage();
      };
+     String libraryName();
+     String libraryVersion();
  } // namespace gig
  #endif // __GIG_H__

 Legend:



Removed from v.36
 


changed lines


 
Added in v.1180
 Legend:



Removed from v.36
 


changed lines


 
Added in v.1180
-Removed from v.36
+Added in v.1180

	ViewVC Help
Powered by ViewVC