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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 21 by schoenebeck, Thu Dec 25 01:09:08 2003 UTC revision 774 by persson, Sun Sep 18 12:41:56 2005 UTC
# Line 2  Line 2 
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file loader library    *   *   libgig - C++ cross-platform Gigasampler format file loader library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003 by Christian Schoenebeck                           *   *   Copyright (C) 2003-2005 by Christian Schoenebeck                      *
6   *                         <cuse@users.sourceforge.net>                    *   *                              <cuse@users.sourceforge.net>               *
7   *                                                                         *   *                                                                         *
8   *   This library is free software; you can redistribute it and/or modify  *   *   This library is free software; you can redistribute it and/or modify  *
9   *   it under the terms of the GNU General Public License as published by  *   *   it under the terms of the GNU General Public License as published by  *
# Line 63  Line 63 
63  #define GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(x)                  ((x >> 1) & 0x03)  #define GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(x)                  ((x >> 1) & 0x03)
64  #define GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(x)                   ((x >> 3) & 0x03)  #define GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(x)                   ((x >> 3) & 0x03)
65  #define GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(x)                 ((x >> 5) & 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)))  
66    
67  /** Gigasampler specific classes and definitions */  /** Gigasampler specific classes and definitions */
68  namespace gig {  namespace gig {
# Line 84  namespace gig { Line 80  namespace gig {
80          void*         pStart;            ///< Points to the beginning of the buffer.          void*         pStart;            ///< Points to the beginning of the buffer.
81          unsigned long Size;              ///< Size of the actual data in the buffer in bytes.          unsigned long Size;              ///< Size of the actual data in the buffer in bytes.
82          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. :)          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. :)
83            buffer_t() {
84                pStart            = NULL;
85                Size              = 0;
86                NullExtensionSize = 0;
87            }
88      };      };
89    
90      /** Standard types of sample loops. */      /** Standard types of sample loops. */
# Line 147  namespace gig { Line 148  namespace gig {
148      /** Defines how the filter cutoff frequency is controlled by. */      /** Defines how the filter cutoff frequency is controlled by. */
149      typedef enum {      typedef enum {
150          vcf_cutoff_ctrl_none         = 0x00,          vcf_cutoff_ctrl_none         = 0x00,
151            vcf_cutoff_ctrl_none2        = 0x01,  ///< The difference betwheen none and none2 is unknown
152          vcf_cutoff_ctrl_modwheel     = 0x81,  ///< Modulation Wheel (MIDI Controller 1)          vcf_cutoff_ctrl_modwheel     = 0x81,  ///< Modulation Wheel (MIDI Controller 1)
153          vcf_cutoff_ctrl_effect1      = 0x8c,  ///< Effect Controller 1 (Coarse, MIDI Controller 12)          vcf_cutoff_ctrl_effect1      = 0x8c,  ///< Effect Controller 1 (Coarse, MIDI Controller 12)
154          vcf_cutoff_ctrl_effect2      = 0x8d,  ///< Effect Controller 2 (Coarse, MIDI Controller 13)          vcf_cutoff_ctrl_effect2      = 0x8d,  ///< Effect Controller 2 (Coarse, MIDI Controller 13)
# Line 168  namespace gig { Line 170  namespace gig {
170          vcf_res_ctrl_genpurpose6 = 3            ///< General Purpose Controller 6 (Button, MIDI Controller 81)          vcf_res_ctrl_genpurpose6 = 3            ///< General Purpose Controller 6 (Button, MIDI Controller 81)
171      } vcf_res_ctrl_t;      } vcf_res_ctrl_t;
172    
173      /** Defines how attenuation (=gain / VCA) is controlled by. */      /**
174      typedef enum {       * Defines a controller that has a certain contrained influence on a
175          attenuation_ctrl_none              = 0x00,       * particular synthesis parameter (used to define attenuation controller,
176          attenuation_ctrl_modwheel          = 0x03, ///< Modulation Wheel (MIDI Controller 1)       * EG1 controller and EG2 controller).
177          attenuation_ctrl_breath            = 0x05, ///< Breath Controller (Coarse, MIDI Controller 2)       *
178          attenuation_ctrl_foot              = 0x07, ///< Foot Pedal (Coarse, MIDI Controller 4)       * You should use the respective <i>typedef</i> (means either
179          attenuation_ctrl_effect1           = 0x0d, ///< Effect Controller 1 (Coarse, MIDI Controller 12)       * attenuation_ctrl_t, eg1_ctrl_t or eg2_ctrl_t) in your code!
180          attenuation_ctrl_effect2           = 0x0f, ///< Effect Controller 2 (Coarse, MIDI Controller 13)       */
181          attenuation_ctrl_genpurpose1       = 0x11, ///< General Purpose Controller 1 (Slider, MIDI Controller 16)      struct leverage_ctrl_t {
182          attenuation_ctrl_genpurpose2       = 0x13, ///< General Purpose Controller 2 (Slider, MIDI Controller 17)          typedef enum {
183          attenuation_ctrl_genpurpose3       = 0x15, ///< General Purpose Controller 3 (Slider, MIDI Controller 18)              type_none              = 0x00, ///< No controller defined
184          attenuation_ctrl_genpurpose4       = 0x17, ///< General Purpose Controller 4 (Slider, MIDI Controller 19)              type_channelaftertouch = 0x2f, ///< Channel Key Pressure
185          attenuation_ctrl_portamentotime    = 0x0b, ///< Portamento Time (Coarse, MIDI Controller 5)              type_velocity          = 0xff, ///< Key Velocity
186          attenuation_ctrl_sustainpedal      = 0x01, ///< Sustain Pedal (MIDI Controller 64)              type_controlchange     = 0xfe  ///< Ordinary MIDI control change controller, see field 'controller_number'
187          attenuation_ctrl_portamento        = 0x19, ///< Portamento (MIDI Controller 65)          } type_t;
188          attenuation_ctrl_sostenutopedal    = 0x1b, ///< Sostenuto Pedal (MIDI Controller 66)  
189          attenuation_ctrl_softpedal         = 0x09, ///< Soft Pedal (MIDI Controller 67)          type_t type;              ///< Controller type
190          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
191          attenuation_ctrl_genpurpose6       = 0x1f, ///< General Purpose Controller 6 (Button, MIDI Controller 81)      };
192          attenuation_ctrl_genpurpose7       = 0x21, ///< General Purpose Controller 7 (Button, MIDI Controller 82)  
193          attenuation_ctrl_genpurpose8       = 0x23, ///< General Purpose Controller 8 (Button, MIDI Controller 83)      /**
194          attenuation_ctrl_effect1depth      = 0x25, ///< Effect 1 Depth (MIDI Controller 91)       * Defines controller influencing attenuation.
195          attenuation_ctrl_effect2depth      = 0x27, ///< Effect 2 Depth (MIDI Controller 92)       *
196          attenuation_ctrl_effect3depth      = 0x29, ///< Effect 3 Depth (MIDI Controller 93)       * @see leverage_ctrl_t
197          attenuation_ctrl_effect4depth      = 0x2b, ///< Effect 4 Depth (MIDI Controller 94)       */
198          attenuation_ctrl_effect5depth      = 0x2d, ///< Effect 5 Depth (MIDI Controller 95)      typedef leverage_ctrl_t attenuation_ctrl_t;
199          attenuation_ctrl_channelaftertouch = 0x2f, ///< Channel Key Pressure  
200          attenuation_ctrl_velocity          = 0xff  ///< Key Velocity      /**
201      } attenuation_ctrl_t, eg1_ctrl_t, eg2_ctrl_t;       * Defines controller influencing envelope generator 1.
202         *
203         * @see leverage_ctrl_t
204         */
205        typedef leverage_ctrl_t eg1_ctrl_t;
206    
207        /**
208         * Defines controller influencing envelope generator 2.
209         *
210         * @see leverage_ctrl_t
211         */
212        typedef leverage_ctrl_t eg2_ctrl_t;
213    
214      /**      /**
215       * Defines the type of dimension, that is how the dimension zones (and       * Defines the type of dimension, that is how the dimension zones (and
# Line 212  namespace gig { Line 225  namespace gig {
225          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 where the ranges can exactly be defined).
226          dimension_channelaftertouch = 0x83, ///< Channel Key Pressure          dimension_channelaftertouch = 0x83, ///< Channel Key Pressure
227          dimension_releasetrigger    = 0x84, ///< Special dimension for triggering samples on releasing a key.          dimension_releasetrigger    = 0x84, ///< Special dimension for triggering samples on releasing a key.
228          dimension_keyboard          = 0x85, ///< Key Position          dimension_keyboard          = 0x85, ///< Dimension for keyswitching
229            dimension_roundrobin        = 0x86, ///< Different samples triggered each time a note is played, dimension regions selected in sequence
230            dimension_random            = 0x87, ///< Different samples triggered each time a note is played, random order
231          dimension_modwheel          = 0x01, ///< Modulation Wheel (MIDI Controller 1)          dimension_modwheel          = 0x01, ///< Modulation Wheel (MIDI Controller 1)
232          dimension_breath            = 0x02, ///< Breath Controller (Coarse, MIDI Controller 2)          dimension_breath            = 0x02, ///< Breath Controller (Coarse, MIDI Controller 2)
233          dimension_foot              = 0x04, ///< Foot Pedal (Coarse, MIDI Controller 4)          dimension_foot              = 0x04, ///< Foot Pedal (Coarse, MIDI Controller 4)
# Line 255  namespace gig { Line 270  namespace gig {
270          uint8_t      zones;      ///< Number of zones the dimension has.          uint8_t      zones;      ///< Number of zones the dimension has.
271          split_type_t split_type; ///< Intended for internal usage: will be used to convert a dimension value into the corresponding dimension bit number.          split_type_t split_type; ///< Intended for internal usage: will be used to convert a dimension value into the corresponding dimension bit number.
272          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).          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).
273          unsigned int zone_size;  ///< Intended for internal usage: reflects the size of each zone (128/zones) for normal split types only, 0 otherwise.          float        zone_size;  ///< Intended for internal usage: reflects the size of each zone (128/zones) for normal split types only, 0 otherwise.
274      };      };
275    
276      /** Defines which frequencies are filtered by the VCF. */      /** Defines which frequencies are filtered by the VCF. */
# Line 267  namespace gig { Line 282  namespace gig {
282          vcf_type_bandreject   = 0x03          vcf_type_bandreject   = 0x03
283      } vcf_type_t;      } vcf_type_t;
284    
285      /** Defines the envelope of a crossfade. */      /**
286         * Defines the envelope of a crossfade.
287         *
288         * Note: The default value for crossfade points is 0,0,0,0. Layers with
289         * such a default value should be treated as if they would not have a
290         * crossfade.
291         */
292      struct crossfade_t {      struct crossfade_t {
293          #if WORDS_BIGENDIAN          #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  
294          uint8_t out_end;    ///< End postition of fade out.          uint8_t out_end;    ///< End postition of fade out.
295          uint8_t out_start;  ///< Start position of fade out.          uint8_t out_start;  ///< Start position of fade out.
296          uint8_t in_end;     ///< End position of fade in.          uint8_t in_end;     ///< End position of fade in.
297          uint8_t in_start;   ///< Start position of fade in.          uint8_t in_start;   ///< Start position of fade in.
298            #else // little endian
299            uint8_t in_start;   ///< Start position of fade in.
300            uint8_t in_end;     ///< End position of fade in.
301            uint8_t out_start;  ///< Start position of fade out.
302            uint8_t out_end;    ///< End postition of fade out.
303          #endif // WORDS_BIGENDIAN          #endif // WORDS_BIGENDIAN
304      };      };
305    
306        /** Reflects the current playback state for a sample. */
307        struct playback_state_t {
308            unsigned long position;          ///< Current position within the sample.
309            bool          reverse;           ///< If playback direction is currently backwards (in case there is a pingpong or reverse loop defined).
310            unsigned long loop_cycles_left;  ///< How many times the loop has still to be passed, this value will be decremented with each loop cycle.
311        };
312    
313        /**
314         * @brief Used for indicating the progress of a certain task.
315         *
316         * The function pointer argument has to be supplied with a valid
317         * function of the given signature which will then be called on
318         * progress changes. An equivalent progress_t structure will be passed
319         * back as argument to the callback function on each progress change.
320         * The factor field of the supplied progress_t structure will then
321         * reflect the current progress as value between 0.0 and 1.0. You might
322         * want to use the custom field for data needed in your callback
323         * function.
324         */
325        struct progress_t {
326            void (*callback)(progress_t*); ///< Callback function pointer which has to be assigned to a function for progress notification.
327            float factor;                  ///< Reflects current progress as value between 0.0 and 1.0.
328            void* custom;                  ///< This pointer can be used for arbitrary data.
329            float __range_min;             ///< Only for internal usage, do not modify!
330            float __range_max;             ///< Only for internal usage, do not modify!
331            progress_t();
332        };
333    
334      // just symbol prototyping      // just symbol prototyping
335      class File;      class File;
336      class Instrument;      class Instrument;
337      class Sample;      class Sample;
338        class Region;
339    
340      /** Encapsulates articulation information of a dimension region.      /** Encapsulates articulation information of a dimension region.
341       *       *
# Line 314  namespace gig { Line 364  namespace gig {
364              bool               EG1Hold;                       ///< If <i>true</i>, Decay1 stage should be postponed until the sample reached the sample loop start.              bool               EG1Hold;                       ///< If <i>true</i>, Decay1 stage should be postponed until the sample reached the sample loop start.
365              eg1_ctrl_t         EG1Controller;                 ///< MIDI Controller which has influence on sample amplitude EG parameters (attack, decay, release).              eg1_ctrl_t         EG1Controller;                 ///< MIDI Controller which has influence on sample amplitude EG parameters (attack, decay, release).
366              bool               EG1ControllerInvert;           ///< Invert values coming from defined EG1 controller.              bool               EG1ControllerInvert;           ///< Invert values coming from defined EG1 controller.
367              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).
368              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).
369              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).
370              double             LFO1Frequency;                 ///< Frequency of the sample amplitude LFO (0.10 - 10.00 Hz).              double             LFO1Frequency;                 ///< Frequency of the sample amplitude LFO (0.10 - 10.00 Hz).
371              uint16_t           LFO1InternalDepth;             ///< Firm pitch of the sample amplitude LFO (0 - 1200 cents).              uint16_t           LFO1InternalDepth;             ///< Firm pitch of the sample amplitude LFO (0 - 1200 cents).
372              uint16_t           LFO1ControlDepth;              ///< Controller depth influencing sample amplitude LFO pitch (0 - 1200 cents).              uint16_t           LFO1ControlDepth;              ///< Controller depth influencing sample amplitude LFO pitch (0 - 1200 cents).
# Line 333  namespace gig { Line 383  namespace gig {
383              double             EG2Release;                    ///< Release time of the filter cutoff EG (0.000 - 60.000s).              double             EG2Release;                    ///< Release time of the filter cutoff EG (0.000 - 60.000s).
384              eg2_ctrl_t         EG2Controller;                 ///< MIDI Controller which has influence on filter cutoff EG parameters (attack, decay, release).              eg2_ctrl_t         EG2Controller;                 ///< MIDI Controller which has influence on filter cutoff EG parameters (attack, decay, release).
385              bool               EG2ControllerInvert;           ///< Invert values coming from defined EG2 controller.              bool               EG2ControllerInvert;           ///< Invert values coming from defined EG2 controller.
386              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).
387              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).
388              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).
389              double             LFO2Frequency;                 ///< Frequency of the filter cutoff LFO (0.10 - 10.00 Hz).              double             LFO2Frequency;                 ///< Frequency of the filter cutoff LFO (0.10 - 10.00 Hz).
390              uint16_t           LFO2InternalDepth;             ///< Firm pitch of the filter cutoff LFO (0 - 1200 cents).              uint16_t           LFO2InternalDepth;             ///< Firm pitch of the filter cutoff LFO (0 - 1200 cents).
391              uint16_t           LFO2ControlDepth;              ///< Controller depth influencing filter cutoff LFO pitch (0 - 1200).              uint16_t           LFO2ControlDepth;              ///< Controller depth influencing filter cutoff LFO pitch (0 - 1200).
# Line 354  namespace gig { Line 404  namespace gig {
404              bool               VCFEnabled;                    ///< If filter should be used.              bool               VCFEnabled;                    ///< If filter should be used.
405              vcf_type_t         VCFType;                       ///< Defines the general filter characteristic (lowpass, highpass, bandpass, etc.).              vcf_type_t         VCFType;                       ///< Defines the general filter characteristic (lowpass, highpass, bandpass, etc.).
406              vcf_cutoff_ctrl_t  VCFCutoffController;           ///< Specifies which external controller has influence on the filter cutoff frequency.              vcf_cutoff_ctrl_t  VCFCutoffController;           ///< Specifies which external controller has influence on the filter cutoff frequency.
407                bool               VCFCutoffControllerInvert;     ///< Inverts values coming from the defined cutoff controller
408              uint8_t            VCFCutoff;                     ///< Max. cutoff frequency.              uint8_t            VCFCutoff;                     ///< Max. cutoff frequency.
409              curve_type_t       VCFVelocityCurve;              ///< Defines a transformation curve for the incoming velocity values, affecting the VCF.              curve_type_t       VCFVelocityCurve;              ///< Defines a transformation curve for the incoming velocity values, affecting the VCF.
410              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).
411              uint8_t            VCFVelocityDynamicRange;       ///< 0x04 = lowest, 0x00 = highest              uint8_t            VCFVelocityDynamicRange;       ///< 0x04 = lowest, 0x00 = highest
412              uint8_t            VCFResonance;                  ///< Firm internal filter resonance weight.              uint8_t            VCFResonance;                  ///< Firm internal filter resonance weight.
413              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).              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 364  namespace gig { Line 415  namespace gig {
415              bool               VCFKeyboardTracking;           ///< If <i>true</i>: VCF cutoff frequence will be dependend to the note key position relative to the defined breakpoint value.              bool               VCFKeyboardTracking;           ///< If <i>true</i>: VCF cutoff frequence will be dependend to the note key position relative to the defined breakpoint value.
416              uint8_t            VCFKeyboardTrackingBreakpoint; ///< See VCFKeyboardTracking (0 - 127).              uint8_t            VCFKeyboardTrackingBreakpoint; ///< See VCFKeyboardTracking (0 - 127).
417              // Key Velocity Transformations              // Key Velocity Transformations
418              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).
419              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).
420              uint8_t            VelocityResponseCurveScaling;  ///< 0 - 127              uint8_t            VelocityResponseCurveScaling;  ///< 0 - 127 (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead)
421              curve_type_t       ReleaseVelocityResponseCurve;  ///< Defines a transformation curve to the incoming release veloctiy values affecting envelope times.              curve_type_t       ReleaseVelocityResponseCurve;  ///< Defines a transformation curve to the incoming release veloctiy values affecting envelope times.
422              uint8_t            ReleaseVelocityResponseDepth;  ///< Dynamic range of release velocity affecting envelope time (0 - 4).              uint8_t            ReleaseVelocityResponseDepth;  ///< Dynamic range of release velocity affecting envelope time (0 - 4).
423              uint8_t            ReleaseTriggerDecay;           ///< 0 - 8              uint8_t            ReleaseTriggerDecay;           ///< 0 - 8
# Line 376  namespace gig { Line 427  namespace gig {
427              dim_bypass_ctrl_t  DimensionBypass;               ///< If defined, the MIDI controller can switch on/off the dimension in realtime.              dim_bypass_ctrl_t  DimensionBypass;               ///< If defined, the MIDI controller can switch on/off the dimension in realtime.
428              int8_t             Pan;                           ///< Panorama / Balance (-64..0..63 <-> left..middle..right)              int8_t             Pan;                           ///< Panorama / Balance (-64..0..63 <-> left..middle..right)
429              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.              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.
430              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).
431              bool               InvertAttenuationControl;      ///< Inverts the values coming from the defined Attenuation Controller.              bool               InvertAttenuationController;   ///< Inverts the values coming from the defined Attenuation Controller.
432              uint8_t            AttenuationControlTreshold;    ///< 0-127              uint8_t            AttenuationControllerThreshold;///< 0-127
433              uint8_t            ChannelOffset;                 ///< Audio output where the audio signal of the dimension region should be routed to (0 - 9).              uint8_t            ChannelOffset;                 ///< Audio output where the audio signal of the dimension region should be routed to (0 - 9).
434              bool               SustainDefeat;                 ///< If <i>true</i>: Sustain pedal will not hold a note.              bool               SustainDefeat;                 ///< If <i>true</i>: Sustain pedal will not hold a note.
435              bool               MSDecode;                      ///< Gigastudio flag: defines if Mid Side Recordings should be decoded.              bool               MSDecode;                      ///< Gigastudio flag: defines if Mid Side Recordings should be decoded.
436              uint16_t           SampleStartOffset;             ///< Number of samples the sample start should be moved (0 - 2000).              uint16_t           SampleStartOffset;             ///< Number of samples the sample start should be moved (0 - 2000).
437                double             SampleAttenuation;             ///< Sample volume (calculated from DLS::Sampler::Gain)
438    
439              // derived attributes from DLS::Sampler              // derived attributes from DLS::Sampler
440              DLS::Sampler::UnityNote;              DLS::Sampler::UnityNote;
441              DLS::Sampler::FineTune;              DLS::Sampler::FineTune;
# Line 392  namespace gig { Line 445  namespace gig {
445    
446              // Methods              // Methods
447              double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);              double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);
448                double GetVelocityRelease(uint8_t MIDIKeyVelocity);
449                double GetVelocityCutoff(uint8_t MIDIKeyVelocity);
450    
451          protected:          protected:
452              DimensionRegion(RIFF::List* _3ewl);              DimensionRegion(RIFF::List* _3ewl);
453             ~DimensionRegion();             ~DimensionRegion();
454              friend class Region;              friend class Region;
455          private:          private:
456                typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller
457                    _lev_ctrl_none              = 0x00,
458                    _lev_ctrl_modwheel          = 0x03, ///< Modulation Wheel (MIDI Controller 1)
459                    _lev_ctrl_breath            = 0x05, ///< Breath Controller (Coarse, MIDI Controller 2)
460                    _lev_ctrl_foot              = 0x07, ///< Foot Pedal (Coarse, MIDI Controller 4)
461                    _lev_ctrl_effect1           = 0x0d, ///< Effect Controller 1 (Coarse, MIDI Controller 12)
462                    _lev_ctrl_effect2           = 0x0f, ///< Effect Controller 2 (Coarse, MIDI Controller 13)
463                    _lev_ctrl_genpurpose1       = 0x11, ///< General Purpose Controller 1 (Slider, MIDI Controller 16)
464                    _lev_ctrl_genpurpose2       = 0x13, ///< General Purpose Controller 2 (Slider, MIDI Controller 17)
465                    _lev_ctrl_genpurpose3       = 0x15, ///< General Purpose Controller 3 (Slider, MIDI Controller 18)
466                    _lev_ctrl_genpurpose4       = 0x17, ///< General Purpose Controller 4 (Slider, MIDI Controller 19)
467                    _lev_ctrl_portamentotime    = 0x0b, ///< Portamento Time (Coarse, MIDI Controller 5)
468                    _lev_ctrl_sustainpedal      = 0x01, ///< Sustain Pedal (MIDI Controller 64)
469                    _lev_ctrl_portamento        = 0x19, ///< Portamento (MIDI Controller 65)
470                    _lev_ctrl_sostenutopedal    = 0x1b, ///< Sostenuto Pedal (MIDI Controller 66)
471                    _lev_ctrl_softpedal         = 0x09, ///< Soft Pedal (MIDI Controller 67)
472                    _lev_ctrl_genpurpose5       = 0x1d, ///< General Purpose Controller 5 (Button, MIDI Controller 80)
473                    _lev_ctrl_genpurpose6       = 0x1f, ///< General Purpose Controller 6 (Button, MIDI Controller 81)
474                    _lev_ctrl_genpurpose7       = 0x21, ///< General Purpose Controller 7 (Button, MIDI Controller 82)
475                    _lev_ctrl_genpurpose8       = 0x23, ///< General Purpose Controller 8 (Button, MIDI Controller 83)
476                    _lev_ctrl_effect1depth      = 0x25, ///< Effect 1 Depth (MIDI Controller 91)
477                    _lev_ctrl_effect2depth      = 0x27, ///< Effect 2 Depth (MIDI Controller 92)
478                    _lev_ctrl_effect3depth      = 0x29, ///< Effect 3 Depth (MIDI Controller 93)
479                    _lev_ctrl_effect4depth      = 0x2b, ///< Effect 4 Depth (MIDI Controller 94)
480                    _lev_ctrl_effect5depth      = 0x2d, ///< Effect 5 Depth (MIDI Controller 95)
481                    _lev_ctrl_channelaftertouch = 0x2f, ///< Channel Key Pressure
482                    _lev_ctrl_velocity          = 0xff  ///< Key Velocity
483                } _lev_ctrl_t;
484              typedef std::map<uint32_t, double*> VelocityTableMap;              typedef std::map<uint32_t, double*> VelocityTableMap;
485    
486              static uint              Instances;                  ///< Number of DimensionRegion instances.              static uint              Instances;                  ///< Number of DimensionRegion instances.
487              static VelocityTableMap* pVelocityTables;            ///< Contains the tables corresponding to the various velocity parameters (VelocityResponseCurve and VelocityResponseDepth).              static VelocityTableMap* pVelocityTables;            ///< Contains the tables corresponding to the various velocity parameters (VelocityResponseCurve and VelocityResponseDepth).
488              double*                  pVelocityAttenuationTable;  ///< Points to the velocity table corresponding to the velocity parameters of this DimensionRegion.              double*                  pVelocityAttenuationTable;  ///< Points to the velocity table corresponding to the velocity parameters of this DimensionRegion.
489                double*                  pVelocityReleaseTable;      ///< Points to the velocity table corresponding to the release velocity parameters of this DimensionRegion
490                double*                  pVelocityCutoffTable;       ///< Points to the velocity table corresponding to the filter velocity parameters of this DimensionRegion
491    
492                leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);
493                double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
494                double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
495      };      };
496    
497      /** Encapsulates sample waves used for playback. */      /** Encapsulates sample waves used for playback. */
# Line 424  namespace gig { Line 514  namespace gig {
514              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 (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.
515              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 (only if Loops > 0, a value of 0 = infinite).
516              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).              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).
517                uint32_t       TruncatedBits;     ///< For 24-bit compressed samples only: number of bits truncated during compression (0, 4 or 6)
518                bool           Dithered;          ///< For 24-bit compressed samples only: if dithering was used during compression with bit reduction
519    
520              // own methods              // own methods
521              buffer_t      LoadSampleData();              buffer_t      LoadSampleData();
# Line 431  namespace gig { Line 523  namespace gig {
523              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);
524              buffer_t      LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);              buffer_t      LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);
525              buffer_t      GetCache();              buffer_t      GetCache();
526                // own static methods
527                static buffer_t CreateDecompressionBuffer(unsigned long MaxReadSize);
528                static void     DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);
529              // overridden methods              // overridden methods
530              void          ReleaseSampleData();              void          ReleaseSampleData();
531              unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);              unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
532              unsigned long GetPos();              unsigned long GetPos();
533              unsigned long Read(void* pBuffer, unsigned long SampleCount);              unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);
534                unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState, buffer_t* pExternalDecompressionBuffer = NULL);
535          protected:          protected:
536              static unsigned int  Instances;               ///< Number of instances of class Sample.              static unsigned int  Instances;               ///< Number of instances of class Sample.
537              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.  
538              unsigned long        FrameOffset;             ///< Current offset (sample points) in current sample frame (for decompression only).              unsigned long        FrameOffset;             ///< Current offset (sample points) in current sample frame (for decompression only).
539              unsigned long*       FrameTable;              ///< For positioning within compressed samples only: stores the offset values for each frame.              unsigned long*       FrameTable;              ///< For positioning within compressed samples only: stores the offset values for each frame.
540              unsigned long        SamplePos;               ///< For compressed samples only: stores the current position (in sample points).              unsigned long        SamplePos;               ///< For compressed samples only: stores the current position (in sample points).
541                unsigned long        SamplesInLastFrame;      ///< For compressed samples only: length of the last sample frame.
542                unsigned long        WorstCaseFrameSize;      ///< For compressed samples only: size (in bytes) of the largest possible sample frame.
543                unsigned long        SamplesPerFrame;         ///< For compressed samples only: number of samples in a full sample frame.
544              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.
545                unsigned long        FileNo;                  ///< File number (> 0 when sample is stored in an extension file, 0 when it's in the gig)
546    
547              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo = 0);
548             ~Sample();             ~Sample();
549                /**
550                 * Swaps the order of the data words in the given memory area
551                 * with a granularity given by \a WordSize.
552                 *
553                 * @param pData    - pointer to the memory area to be swapped
554                 * @param AreaSize - size of the memory area to be swapped (in bytes)
555                 * @param WordSize - size of the data words (in bytes)
556                 */
557                inline void SwapMemoryArea(void* pData, unsigned long AreaSize, uint WordSize) {
558                    switch (WordSize) { // TODO: unefficient
559                        case 1: {
560                            uint8_t* pDst = (uint8_t*) pData;
561                            uint8_t  cache;
562                            unsigned long lo = 0, hi = AreaSize - 1;
563                            for (; lo < hi; hi--, lo++) {
564                                cache    = pDst[lo];
565                                pDst[lo] = pDst[hi];
566                                pDst[hi] = cache;
567                            }
568                            break;
569                        }
570                        case 2: {
571                            uint16_t* pDst = (uint16_t*) pData;
572                            uint16_t  cache;
573                            unsigned long lo = 0, hi = (AreaSize >> 1) - 1;
574                            for (; lo < hi; hi--, lo++) {
575                                cache    = pDst[lo];
576                                pDst[lo] = pDst[hi];
577                                pDst[hi] = cache;
578                            }
579                            break;
580                        }
581                        case 4: {
582                            uint32_t* pDst = (uint32_t*) pData;
583                            uint32_t  cache;
584                            unsigned long lo = 0, hi = (AreaSize >> 2) - 1;
585                            for (; lo < hi; hi--, lo++) {
586                                cache    = pDst[lo];
587                                pDst[lo] = pDst[hi];
588                                pDst[hi] = cache;
589                            }
590                            break;
591                        }
592                        default: {
593                            uint8_t* pCache = new uint8_t[WordSize]; // TODO: unefficient
594                            unsigned long lo = 0, hi = AreaSize - WordSize;
595                            for (; lo < hi; hi -= WordSize, lo += WordSize) {
596                                memcpy(pCache, (uint8_t*) pData + lo, WordSize);
597                                memcpy((uint8_t*) pData + lo, (uint8_t*) pData + hi, WordSize);
598                                memcpy((uint8_t*) pData + hi, pCache, WordSize);
599                            }
600                            delete[] pCache;
601                            break;
602                        }
603                    }
604                }
605                inline long Min(long A, long B) {
606                    return (A > B) ? B : A;
607                }
608                inline long Abs(long val) { return (val > 0) ? val : -val; }
609    
610                // Guess size (in bytes) of a compressed sample
611                inline unsigned long GuessSize(unsigned long samples) {
612                    // 16 bit: assume all frames are compressed - 1 byte
613                    // per sample and 5 bytes header per 2048 samples
614    
615                    // 24 bit: assume next best compression rate - 1.5
616                    // bytes per sample and 13 bytes header per 256
617                    // samples
618                    const unsigned long size =
619                        BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13
620                                       : samples + (samples >> 10) * 5;
621                    // Double for stereo and add one worst case sample
622                    // frame
623                    return (Channels == 2 ? size << 1 : size) + WorstCaseFrameSize;
624                }
625    
626                // Worst case amount of sample points that can be read with the
627                // given decompression buffer.
628                inline unsigned long WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {
629                    return (unsigned long) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);
630                }
631          private:          private:
632              void ScanCompressedSample();              void ScanCompressedSample();
633              friend class File;              friend class File;
# Line 458  namespace gig { Line 639  namespace gig {
639      class Region : public DLS::Region {      class Region : public DLS::Region {
640          public:          public:
641              unsigned int            Dimensions;               ///< Number of defined dimensions.              unsigned int            Dimensions;               ///< Number of defined dimensions.
642              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).
643              uint32_t                DimensionRegions;         ///< Total number of DimensionRegions this Region contains.              uint32_t                DimensionRegions;         ///< Total number of DimensionRegions this Region contains.
644              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).
645                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.
646    
647              DimensionRegion* GetDimensionRegionByValue(uint Dim4Val, uint Dim3Val, uint Dim2Val, uint Dim1Val, uint Dim0Val);              DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);
648              DimensionRegion* GetDimensionRegionByBit(uint8_t Dim4Bit, uint8_t Dim3Bit, uint8_t Dim2Bit, uint8_t Dim1Bit, uint8_t Dim0Bit);              DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);
649              Sample*          GetSample();              Sample*          GetSample();
650          protected:          protected:
651              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.              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.
652    
653              Region(Instrument* pInstrument, RIFF::List* rgnList);              Region(Instrument* pInstrument, RIFF::List* rgnList);
654              void LoadDimensionRegions(RIFF::List* rgn);              void LoadDimensionRegions(RIFF::List* rgn);
655              Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex);              Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);
656             ~Region();             ~Region();
657              friend class Instrument;              friend class Instrument;
658      };      };
# Line 509  namespace gig { Line 691  namespace gig {
691              Region*   RegionKeyTable[128]; ///< fast lookup for the corresponding Region of a MIDI key              Region*   RegionKeyTable[128]; ///< fast lookup for the corresponding Region of a MIDI key
692              int       RegionIndex;              int       RegionIndex;
693    
694              Instrument(File* pFile, RIFF::List* insList);              Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);
695             ~Instrument();             ~Instrument();
696              friend class File;              friend class File;
697      };      };
# Line 529  namespace gig { Line 711  namespace gig {
711              DLS::Resource::GetParent;              DLS::Resource::GetParent;
712              // overridden  methods              // overridden  methods
713              File(RIFF::File* pRIFF);              File(RIFF::File* pRIFF);
714              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.
715              Sample*     GetNextSample();      ///< Returns a pointer to the next <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.
716              Instrument* GetFirstInstrument(); ///< Returns a pointer to the first <i>Instrument</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.
717              Instrument* GetNextInstrument();  ///< Returns a pointer to the next <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.
718              Instrument* GetInstrument(uint index);              Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);
719             ~File() {};             ~File();
720          protected:          protected:
721              typedef std::list<Sample*>     SampleList;              typedef std::list<Sample*>     SampleList;
722              typedef std::list<Instrument*> InstrumentList;              typedef std::list<Instrument*> InstrumentList;
# Line 544  namespace gig { Line 726  namespace gig {
726              InstrumentList*          pInstruments;              InstrumentList*          pInstruments;
727              InstrumentList::iterator InstrumentsIterator;              InstrumentList::iterator InstrumentsIterator;
728    
729              void LoadSamples();              void LoadSamples(progress_t* pProgress = NULL);
730              void LoadInstruments();              void LoadInstruments(progress_t* pProgress = NULL);
731              friend class Region;              friend class Region;
732    
733                std::list<RIFF::File*> ExtensionFiles;
734      };      };
735    
736      /** 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. */
# Line 556  namespace gig { Line 740  namespace gig {
740              void PrintMessage();              void PrintMessage();
741      };      };
742    
743        String libraryName();
744        String libraryVersion();
745    
746  } // namespace gig  } // namespace gig
747    
748  #endif // __GIG_H__  #endif // __GIG_H__
Legend:
Removed from v.21  
changed lines
  Added in v.774
  ViewVC Help
Powered by ViewVC