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

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

Parent Directory | Revision Log | View Patch Patch

-revision 2 by schoenebeck,
Sat Oct 25 20:15:04 2003 UTC
+revision 666 by persson,
Sun Jun 19 15:18:59 2005 UTC
 Line 2
   *                                                                         *
   *   libgig - C++ cross-platform Gigasampler format file loader library    *
   *                                                                         *
-  *   Copyright (C) 2003 by Christian Schoenebeck                           *
+  *   Copyright (C) 2003-2005 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 36
  /// reallocated which is time consuming and unefficient.
  #define INITIAL_SAMPLE_BUFFER_SIZE              512000 // 512 kB
- #if 0 //WORDS_BIGENDIAN
+ #if WORDS_BIGENDIAN
  # define LIST_TYPE_3PRG 0x33707267
  # define LIST_TYPE_3EWL 0x3365776C
  # define CHUNK_ID_SMPL  0x736D706C
 Line 57
  #endif // WORDS_BIGENDIAN
  /** (so far) every exponential paramater in the gig format has a basis of 1.000000008813822 */
- #define GIG_EXP_DECODE(x)                       (powl(1.000000008813822, x))
+ #define GIG_EXP_DECODE(x)                                       (pow(1.000000008813822, x))
- #define GIG_PITCH_TRACK_EXTRACT(x)              (!(x & 0x01))
+ #define GIG_PITCH_TRACK_EXTRACT(x)                              (!(x & 0x01))
- #define GIG_VCF_RESONANCE_CTRL_EXTRACT(x)       ((x >> 4) & 0x03)
+ #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_ATTACK_INFLUENCE_EXTRACT(x)                  ((x >> 1) & 0x03)
- #define GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(x)   ((x >> 3) & 0x03)
+ #define GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(x)                   ((x >> 3) & 0x03)
- #define GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(x) ((x >> 5) & 0x03)
+ #define GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(x)                 ((x >> 5) & 0x03)
  /** Gigasampler specific classes and definitions */
  namespace gig {
 Line 80 
 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 164 
 namespace gig {
+Line 169 
 namespace gig {
          vcf_res_ctrl_genpurpose6 = 3            ///< General Purpose Controller 6 (Button, MIDI Controller 81)
      } vcf_res_ctrl_t;
-     /** Defines how attenuation (=gain / VCA) is controlled by. */
+     /**
-     typedef enum {
+      * Defines a controller that has a certain contrained influence on a
-         attenuation_ctrl_none              = 0x00,
+      * particular synthesis parameter (used to define attenuation controller,
-         attenuation_ctrl_modwheel          = 0x03, ///< Modulation Wheel (MIDI Controller 1)
+      * EG1 controller and EG2 controller).
-         attenuation_ctrl_breath            = 0x05, ///< Breath Controller (Coarse, MIDI Controller 2)
+      *
-         attenuation_ctrl_foot              = 0x07, ///< Foot Pedal (Coarse, MIDI Controller 4)
+      * You should use the respective <i>typedef</i> (means either
-         attenuation_ctrl_effect1           = 0x0d, ///< Effect Controller 1 (Coarse, MIDI Controller 12)
+      * attenuation_ctrl_t, eg1_ctrl_t or eg2_ctrl_t) in your code!
-         attenuation_ctrl_effect2           = 0x0f, ///< Effect Controller 2 (Coarse, MIDI Controller 13)
+      */
-         attenuation_ctrl_genpurpose1       = 0x11, ///< General Purpose Controller 1 (Slider, MIDI Controller 16)
+     struct leverage_ctrl_t {
-         attenuation_ctrl_genpurpose2       = 0x13, ///< General Purpose Controller 2 (Slider, MIDI Controller 17)
+         typedef enum {
-         attenuation_ctrl_genpurpose3       = 0x15, ///< General Purpose Controller 3 (Slider, MIDI Controller 18)
+             type_none              = 0x00, ///< No controller defined
-         attenuation_ctrl_genpurpose4       = 0x17, ///< General Purpose Controller 4 (Slider, MIDI Controller 19)
+             type_channelaftertouch = 0x2f, ///< Channel Key Pressure
-         attenuation_ctrl_portamentotime    = 0x0b, ///< Portamento Time (Coarse, MIDI Controller 5)
+             type_velocity          = 0xff, ///< Key Velocity
-         attenuation_ctrl_sustainpedal      = 0x01, ///< Sustain Pedal (MIDI Controller 64)
+             type_controlchange     = 0xfe  ///< Ordinary MIDI control change controller, see field 'controller_number'
-         attenuation_ctrl_portamento        = 0x19, ///< Portamento (MIDI Controller 65)
+         } type_t;
-         attenuation_ctrl_sostenutopedal    = 0x1b, ///< Sostenuto Pedal (MIDI Controller 66)
-         attenuation_ctrl_softpedal         = 0x09, ///< Soft Pedal (MIDI Controller 67)
+         type_t type;              ///< Controller type
-         attenuation_ctrl_genpurpose5       = 0x1d, ///< General Purpose Controller 5 (Button, MIDI Controller 80)
+         uint   controller_number; ///< MIDI controller number if this controller is a control change controller, 0 otherwise
-         attenuation_ctrl_genpurpose6       = 0x1f, ///< General Purpose Controller 6 (Button, MIDI Controller 81)
+     };
-         attenuation_ctrl_genpurpose7       = 0x21, ///< General Purpose Controller 7 (Button, MIDI Controller 82)
-         attenuation_ctrl_genpurpose8       = 0x23, ///< General Purpose Controller 8 (Button, MIDI Controller 83)
+     /**
-         attenuation_ctrl_effect1depth      = 0x25, ///< Effect 1 Depth (MIDI Controller 91)
+      * Defines controller influencing attenuation.
-         attenuation_ctrl_effect2depth      = 0x27, ///< Effect 2 Depth (MIDI Controller 92)
+      *
-         attenuation_ctrl_effect3depth      = 0x29, ///< Effect 3 Depth (MIDI Controller 93)
+      * @see leverage_ctrl_t
-         attenuation_ctrl_effect4depth      = 0x2b, ///< Effect 4 Depth (MIDI Controller 94)
+      */
-         attenuation_ctrl_effect5depth      = 0x2d, ///< Effect 5 Depth (MIDI Controller 95)
+     typedef leverage_ctrl_t attenuation_ctrl_t;
-         attenuation_ctrl_channelaftertouch = 0x2f, ///< Channel Key Pressure
-         attenuation_ctrl_velocity          = 0xff  ///< Key Velocity
+     /**
-     } attenuation_ctrl_t, eg1_ctrl_t, eg2_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.
+      *
+      * @see leverage_ctrl_t
+      */
+     typedef leverage_ctrl_t eg2_ctrl_t;
      /**
       * Defines the type of dimension, that is how the dimension zones (and
-Line 208 
 namespace gig {
+Line 224 
 namespace gig {
          dimension_velocity          = 0x82, ///< Key Velocity (this is the only dimension 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_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 263 
 namespace gig {
+Line 281 
 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
      };
+     /** Reflects the current playback state for a sample. */
+     struct playback_state_t {
+         unsigned long position;          ///< Current position within the sample.
+         bool          reverse;           ///< If playback direction is currently backwards (in case there is a pingpong or reverse loop defined).
+         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;
      /** Encapsulates articulation information of a dimension region.
       *
-Line 310 
 namespace gig {
+Line 363 
 namespace gig {
              bool               EG1Hold;                       ///< If <i>true</i>, Decay1 stage should be postponed until the sample reached the sample loop start.
              eg1_ctrl_t         EG1Controller;                 ///< MIDI Controller which has influence on sample amplitude EG parameters (attack, decay, release).
              bool               EG1ControllerInvert;           ///< Invert values coming from defined EG1 controller.
-             uint8_t            EG1ControllerAttackInfluence;  ///< Amount EG1 Controller has influence on the EG1 Attack time.
+             uint8_t            EG1ControllerAttackInfluence;  ///< Amount EG1 Controller has influence on the EG1 Attack time (0 - 3, where 0 means off).
-             uint8_t            EG1ControllerDecayInfluence;   ///< Amount EG1 Controller has influence on the EG1 Decay time.
+             uint8_t            EG1ControllerDecayInfluence;   ///< Amount EG1 Controller has influence on the EG1 Decay time (0 - 3, where 0 means off).
-             uint8_t            EG1ControllerReleaseInfluence; ///< Amount EG1 Controller has influence on the EG1 Release time.
+             uint8_t            EG1ControllerReleaseInfluence; ///< Amount EG1 Controller has influence on the EG1 Release time (0 - 3, where 0 means off).
              double             LFO1Frequency;                 ///< Frequency of the sample amplitude LFO (0.10 - 10.00 Hz).
              uint16_t           LFO1InternalDepth;             ///< Firm pitch of the sample amplitude LFO (0 - 1200 cents).
              uint16_t           LFO1ControlDepth;              ///< Controller depth influencing sample amplitude LFO pitch (0 - 1200 cents).
-Line 329 
 namespace gig {
+Line 382 
 namespace gig {
              double             EG2Release;                    ///< Release time of the filter cutoff EG (0.000 - 60.000s).
              eg2_ctrl_t         EG2Controller;                 ///< MIDI Controller which has influence on filter cutoff EG parameters (attack, decay, release).
              bool               EG2ControllerInvert;           ///< Invert values coming from defined EG2 controller.
-             uint8_t            EG2ControllerAttackInfluence;  ///< Amount EG2 Controller has influence on the EG2 Attack time.
+             uint8_t            EG2ControllerAttackInfluence;  ///< Amount EG2 Controller has influence on the EG2 Attack time (0 - 3, where 0 means off).
-             uint8_t            EG2ControllerDecayInfluence;   ///< Amount EG2 Controller has influence on the EG2 Decay time.
+             uint8_t            EG2ControllerDecayInfluence;   ///< Amount EG2 Controller has influence on the EG2 Decay time (0 - 3, where 0 means off).
-             uint8_t            EG2ControllerReleaseInfluence; ///< Amount EG2 Controller has influence on the EG2 Release time.
+             uint8_t            EG2ControllerReleaseInfluence; ///< Amount EG2 Controller has influence on the EG2 Release time (0 - 3, where 0 means off).
              double             LFO2Frequency;                 ///< Frequency of the filter cutoff LFO (0.10 - 10.00 Hz).
              uint16_t           LFO2InternalDepth;             ///< Firm pitch of the filter cutoff LFO (0 - 1200 cents).
              uint16_t           LFO2ControlDepth;              ///< Controller depth influencing filter cutoff LFO pitch (0 - 1200).
-Line 360 
 namespace gig {
+Line 413 
 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;
+             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 372 
 namespace gig {
+Line 425 
 namespace gig {
              dim_bypass_ctrl_t  DimensionBypass;               ///< If defined, the MIDI controller can switch on/off the dimension in realtime.
              int8_t             Pan;                           ///< Panorama / Balance (-64..0..63 <-> left..middle..right)
              bool               SelfMask;                      ///< If <i>true</i>: high velocity notes will stop low velocity notes at the same note, with that you can save voices that wouldn't be audible anyway.
-             attenuation_ctrl_t AttenuationControl;            ///< MIDI Controller which has influence on the volume level of the sample (or entire sample group).
+             attenuation_ctrl_t AttenuationController;         ///< MIDI Controller which has influence on the volume level of the sample (or entire sample group).
-             bool               InvertAttenuationControl;      ///< Inverts the values coming from the defined Attenuation Controller.
+             bool               InvertAttenuationController;   ///< Inverts the values coming from the defined Attenuation Controller.
-             uint8_t            AttenuationControlTreshold;    ///< 0-127
+             uint8_t            AttenuationControllerThreshold;///< 0-127
              uint8_t            ChannelOffset;                 ///< Audio output where the audio signal of the dimension region should be routed to (0 - 9).
              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)
              // derived attributes from DLS::Sampler
              DLS::Sampler::UnityNote;
              DLS::Sampler::FineTune;
-Line 386 
 namespace gig {
+Line 441 
 namespace gig {
              DLS::Sampler::SampleLoops;
              DLS::Sampler::pSampleLoops;
+             // Methods
+             double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);
+             double GetVelocityRelease(uint8_t MIDIKeyVelocity);
+         protected:
              DimensionRegion(RIFF::List* _3ewl);
+            ~DimensionRegion();
+             friend class Region;
+         private:
+             typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller
+                 _lev_ctrl_none              = 0x00,
+                 _lev_ctrl_modwheel          = 0x03, ///< Modulation Wheel (MIDI Controller 1)
+                 _lev_ctrl_breath            = 0x05, ///< Breath Controller (Coarse, MIDI Controller 2)
+                 _lev_ctrl_foot              = 0x07, ///< Foot Pedal (Coarse, MIDI Controller 4)
+                 _lev_ctrl_effect1           = 0x0d, ///< Effect Controller 1 (Coarse, MIDI Controller 12)
+                 _lev_ctrl_effect2           = 0x0f, ///< Effect Controller 2 (Coarse, MIDI Controller 13)
+                 _lev_ctrl_genpurpose1       = 0x11, ///< General Purpose Controller 1 (Slider, MIDI Controller 16)
+                 _lev_ctrl_genpurpose2       = 0x13, ///< General Purpose Controller 2 (Slider, MIDI Controller 17)
+                 _lev_ctrl_genpurpose3       = 0x15, ///< General Purpose Controller 3 (Slider, MIDI Controller 18)
+                 _lev_ctrl_genpurpose4       = 0x17, ///< General Purpose Controller 4 (Slider, MIDI Controller 19)
+                 _lev_ctrl_portamentotime    = 0x0b, ///< Portamento Time (Coarse, MIDI Controller 5)
+                 _lev_ctrl_sustainpedal      = 0x01, ///< Sustain Pedal (MIDI Controller 64)
+                 _lev_ctrl_portamento        = 0x19, ///< Portamento (MIDI Controller 65)
+                 _lev_ctrl_sostenutopedal    = 0x1b, ///< Sostenuto Pedal (MIDI Controller 66)
+                 _lev_ctrl_softpedal         = 0x09, ///< Soft Pedal (MIDI Controller 67)
+                 _lev_ctrl_genpurpose5       = 0x1d, ///< General Purpose Controller 5 (Button, MIDI Controller 80)
+                 _lev_ctrl_genpurpose6       = 0x1f, ///< General Purpose Controller 6 (Button, MIDI Controller 81)
+                 _lev_ctrl_genpurpose7       = 0x21, ///< General Purpose Controller 7 (Button, MIDI Controller 82)
+                 _lev_ctrl_genpurpose8       = 0x23, ///< General Purpose Controller 8 (Button, MIDI Controller 83)
+                 _lev_ctrl_effect1depth      = 0x25, ///< Effect 1 Depth (MIDI Controller 91)
+                 _lev_ctrl_effect2depth      = 0x27, ///< Effect 2 Depth (MIDI Controller 92)
+                 _lev_ctrl_effect3depth      = 0x29, ///< Effect 3 Depth (MIDI Controller 93)
+                 _lev_ctrl_effect4depth      = 0x2b, ///< Effect 4 Depth (MIDI Controller 94)
+                 _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
+             leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);
+             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. */
-Line 397 
 namespace gig {
+Line 498 
 namespace gig {
              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       MIDIUnityNote;     ///< Specifies the musical note at which the sample will be played at it's original sample rate.
-             uint32_t       MIDIPitchFraction; ///< 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.
+             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       LoopID;            ///< Specifies the unique ID that corresponds to one of the defined cue points in the cue point list (only if Loops > 0).
+             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).
-             uint32_t       LoopStart;         ///< The start value specifies the byte offset into the waveform data of the first sample to be played in the loop (only if Loops > 0).
+             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       LoopEnd;           ///< The end value specifies the byte offset into the waveform data of the last 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       LoopSize;          ///< Length of the looping area (in sample points) which is equivalent to <i>LoopEnd - LoopStart</i>.
              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       LoopPlayCount;     ///< Number of times the loop should be played (only if Loops > 0, 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 415 
 namespace gig {
+Line 519 
 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();
              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, buffer_t* pExternalDecompressionBuffer = NULL);
          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.
              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)
-             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
+              * with a granularity given by \a WordSize.
+              *
+              * @param pData    - pointer to the memory area to be swapped
+              * @param AreaSize - size of the memory area to be swapped (in bytes)
+              * @param WordSize - size of the data words (in bytes)
+              */
+             inline void SwapMemoryArea(void* pData, unsigned long AreaSize, uint WordSize) {
+                 switch (WordSize) { // TODO: unefficient
+                     case 1: {
+                         uint8_t* pDst = (uint8_t*) pData;
+                         uint8_t  cache;
+                         unsigned long lo = 0, hi = AreaSize - 1;
+                         for (; lo < hi; hi--, lo++) {
+                             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;
+             }
+             inline long Abs(long val) { return (val > 0) ? val : -val; }
+             // Guess size (in bytes) of a compressed sample
+             inline unsigned long GuessSize(unsigned long samples) {
+                 // 16 bit: assume all frames are compressed - 1 byte
+                 // per sample and 5 bytes header per 2048 samples
+                 // 24 bit: assume next best compression rate - 1.5
+                 // bytes per sample and 13 bytes header per 256
+                 // samples
+                 const unsigned long size =
+                     BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13
+                                    : samples + (samples >> 10) * 5;
+                 // Double for stereo and add one worst case sample
+                 // frame
+                 return (Channels == 2 ? size << 1 : size) + WorstCaseFrameSize;
+             }
+             // 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);
+             }
          private:
              void ScanCompressedSample();
              friend class File;
-Line 442 
 namespace gig {
+Line 635 
 namespace gig {
      class Region : public DLS::Region {
          public:
              unsigned int            Dimensions;               ///< Number of defined dimensions.
-             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).
              uint32_t                DimensionRegions;         ///< Total number of DimensionRegions this Region contains.
-             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).
+             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.
-             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();
          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);
+             Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);
             ~Region();
              friend class Instrument;
      };
-Line 493 
 namespace gig {
+Line 687 
 namespace gig {
              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();
              friend class File;
      };
-Line 513 
 namespace gig {
+Line 707 
 namespace gig {
              DLS::Resource::GetParent;
              // overridden  methods
              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.
              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.
-            ~File() {};
+             Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);
+            ~File();
          protected:
              typedef std::list<Sample*>     SampleList;
              typedef std::list<Instrument*> InstrumentList;
-Line 527 
 namespace gig {
+Line 722 
 namespace gig {
              InstrumentList*          pInstruments;
              InstrumentList::iterator InstrumentsIterator;
-             void LoadSamples();
+             void LoadSamples(progress_t* pProgress = NULL);
-             void LoadInstruments();
+             void LoadInstruments(progress_t* pProgress = NULL);
              friend class Region;
+             std::list<RIFF::File*> ExtensionFiles;
      };
      /** Will be thrown whenever a gig specific error occurs while trying to access a Gigasampler File. */
-Line 539 
 namespace gig {
+Line 736 
 namespace gig {
              void PrintMessage();
      };
+     String libraryName();
+     String libraryVersion();
  } // namespace gig
  #endif // __GIG_H__

 Legend:



Removed from v.2
 


changed lines


 
Added in v.666
 Legend:



Removed from v.2
 


changed lines


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

	ViewVC Help
Powered by ViewVC