libgig  4.0.0
gig::DimensionRegion Class Reference

Encapsulates articulation informations of a dimension region. More...

#include <gig.h>

Inheritance diagram for gig::DimensionRegion:
DLS::Sampler

Public Member Functions

double GetVelocityAttenuation (uint8_t MIDIKeyVelocity)
 Returns the correct amplitude factor for the given MIDIKeyVelocity. More...
 
double GetVelocityRelease (uint8_t MIDIKeyVelocity)
 
double GetVelocityCutoff (uint8_t MIDIKeyVelocity)
 
void SetVelocityResponseCurve (curve_type_t curve)
 Updates the respective member variable and the lookup table / cache that depends on this value. More...
 
void SetVelocityResponseDepth (uint8_t depth)
 Updates the respective member variable and the lookup table / cache that depends on this value. More...
 
void SetVelocityResponseCurveScaling (uint8_t scaling)
 Updates the respective member variable and the lookup table / cache that depends on this value. More...
 
void SetReleaseVelocityResponseCurve (curve_type_t curve)
 Updates the respective member variable and the lookup table / cache that depends on this value. More...
 
void SetReleaseVelocityResponseDepth (uint8_t depth)
 Updates the respective member variable and the lookup table / cache that depends on this value. More...
 
void SetVCFCutoffController (vcf_cutoff_ctrl_t controller)
 Updates the respective member variable and the lookup table / cache that depends on this value. More...
 
void SetVCFVelocityCurve (curve_type_t curve)
 Updates the respective member variable and the lookup table / cache that depends on this value. More...
 
void SetVCFVelocityDynamicRange (uint8_t range)
 Updates the respective member variable and the lookup table / cache that depends on this value. More...
 
void SetVCFVelocityScale (uint8_t scaling)
 Updates the respective member variable and the lookup table / cache that depends on this value. More...
 
RegionGetParent () const
 
virtual void SetGain (int32_t gain)
 Updates the respective member variable and updates SampleAttenuation which depends on this value. More...
 
virtual void UpdateChunks (progress_t *pProgress)
 Apply dimension region settings to the respective RIFF chunks. More...
 
virtual void CopyAssign (const DimensionRegion *orig)
 Make a (semi) deep copy of the DimensionRegion object given by orig and assign it to this object. More...
 

Public Attributes

uint8_t VelocityUpperLimit
 Defines the upper velocity value limit of a velocity split (only if an user defined limit was set, thus a value not equal to 128/NumberOfSplits, else this value is 0). Only for gig2, for gig3 and above the DimensionUpperLimits are used instead. More...
 
SamplepSample
 Points to the Sample which is assigned to the dimension region. More...
 
uint16_t EG1PreAttack
 Preattack value of the sample amplitude EG (0 - 1000 permille). More...
 
double EG1Attack
 Attack time of the sample amplitude EG (0.000 - 60.000s). More...
 
double EG1Decay1
 Decay time of the sample amplitude EG (0.000 - 60.000s). More...
 
double EG1Decay2
 Only if EG1InfiniteSustain == false: 2nd decay stage time of the sample amplitude EG (0.000 - 60.000s). More...
 
bool EG1InfiniteSustain
 If true, instead of going into Decay2 phase, Decay1 level will be hold until note will be released. More...
 
uint16_t EG1Sustain
 Sustain value of the sample amplitude EG (0 - 1000 permille). More...
 
double EG1Release
 Release time of the sample amplitude EG (0.000 - 60.000s). More...
 
bool EG1Hold
 If true, Decay1 stage should be postponed until the sample reached the sample loop start. More...
 
eg1_ctrl_t EG1Controller
 MIDI Controller which has influence on sample amplitude EG parameters (attack, decay, release). More...
 
bool EG1ControllerInvert
 Invert values coming from defined EG1 controller. More...
 
uint8_t EG1ControllerAttackInfluence
 Amount EG1 Controller has influence on the EG1 Attack time (0 - 3, where 0 means off). More...
 
uint8_t EG1ControllerDecayInfluence
 Amount EG1 Controller has influence on the EG1 Decay time (0 - 3, where 0 means off). More...
 
uint8_t EG1ControllerReleaseInfluence
 Amount EG1 Controller has influence on the EG1 Release time (0 - 3, where 0 means off). More...
 
double LFO1Frequency
 Frequency of the sample amplitude LFO (0.10 - 10.00 Hz). More...
 
uint16_t LFO1InternalDepth
 Firm pitch of the sample amplitude LFO (0 - 1200 cents). More...
 
uint16_t LFO1ControlDepth
 Controller depth influencing sample amplitude LFO pitch (0 - 1200 cents). More...
 
lfo1_ctrl_t LFO1Controller
 MIDI Controller which controls sample amplitude LFO. More...
 
bool LFO1FlipPhase
 Inverts phase of the sample amplitude LFO wave. More...
 
bool LFO1Sync
 If set to true only one LFO should be used for all voices. More...
 
uint16_t EG2PreAttack
 Preattack value of the filter cutoff EG (0 - 1000 permille). More...
 
double EG2Attack
 Attack time of the filter cutoff EG (0.000 - 60.000s). More...
 
double EG2Decay1
 Decay time of the filter cutoff EG (0.000 - 60.000s). More...
 
double EG2Decay2
 Only if EG2InfiniteSustain == false: 2nd stage decay time of the filter cutoff EG (0.000 - 60.000s). More...
 
bool EG2InfiniteSustain
 If true, instead of going into Decay2 phase, Decay1 level will be hold until note will be released. More...
 
uint16_t EG2Sustain
 Sustain value of the filter cutoff EG (0 - 1000 permille). More...
 
double EG2Release
 Release time of the filter cutoff EG (0.000 - 60.000s). More...
 
eg2_ctrl_t EG2Controller
 MIDI Controller which has influence on filter cutoff EG parameters (attack, decay, release). More...
 
bool EG2ControllerInvert
 Invert values coming from defined EG2 controller. More...
 
uint8_t EG2ControllerAttackInfluence
 Amount EG2 Controller has influence on the EG2 Attack time (0 - 3, where 0 means off). More...
 
uint8_t EG2ControllerDecayInfluence
 Amount EG2 Controller has influence on the EG2 Decay time (0 - 3, where 0 means off). More...
 
uint8_t EG2ControllerReleaseInfluence
 Amount EG2 Controller has influence on the EG2 Release time (0 - 3, where 0 means off). More...
 
double LFO2Frequency
 Frequency of the filter cutoff LFO (0.10 - 10.00 Hz). More...
 
uint16_t LFO2InternalDepth
 Firm pitch of the filter cutoff LFO (0 - 1200 cents). More...
 
uint16_t LFO2ControlDepth
 Controller depth influencing filter cutoff LFO pitch (0 - 1200). More...
 
lfo2_ctrl_t LFO2Controller
 MIDI Controlle which controls the filter cutoff LFO. More...
 
bool LFO2FlipPhase
 Inverts phase of the filter cutoff LFO wave. More...
 
bool LFO2Sync
 If set to true only one LFO should be used for all voices. More...
 
double EG3Attack
 Attack time of the sample pitch EG (0.000 - 10.000s). More...
 
int16_t EG3Depth
 Depth of the sample pitch EG (-1200 - +1200). More...
 
double LFO3Frequency
 Frequency of the sample pitch LFO (0.10 - 10.00 Hz). More...
 
int16_t LFO3InternalDepth
 Firm depth of the sample pitch LFO (-1200 - +1200 cents). More...
 
int16_t LFO3ControlDepth
 Controller depth of the sample pitch LFO (-1200 - +1200 cents). More...
 
lfo3_ctrl_t LFO3Controller
 MIDI Controller which controls the sample pitch LFO. More...
 
bool LFO3Sync
 If set to true only one LFO should be used for all voices. More...
 
bool VCFEnabled
 If filter should be used. More...
 
vcf_type_t VCFType
 Defines the general filter characteristic (lowpass, highpass, bandpass, etc.). More...
 
vcf_cutoff_ctrl_t VCFCutoffController
 Specifies which external controller has influence on the filter cutoff frequency. More...
 
bool VCFCutoffControllerInvert
 Inverts values coming from the defined cutoff controller. More...
 
uint8_t VCFCutoff
 Max. cutoff frequency. More...
 
curve_type_t VCFVelocityCurve
 Defines a transformation curve for the incoming velocity values, affecting the VCF. More...
 
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). More...
 
uint8_t VCFVelocityDynamicRange
 0x04 = lowest, 0x00 = highest . More...
 
uint8_t VCFResonance
 Firm internal filter resonance weight. More...
 
bool VCFResonanceDynamic
 If true: Increases the resonance Q according to changes of controllers that actually control the VCF cutoff frequency (EG2, ext. VCF MIDI controller). More...
 
vcf_res_ctrl_t VCFResonanceController
 Specifies which external controller has influence on the filter resonance Q. More...
 
bool VCFKeyboardTracking
 If true: VCF cutoff frequence will be dependend to the note key position relative to the defined breakpoint value. More...
 
uint8_t VCFKeyboardTrackingBreakpoint
 See VCFKeyboardTracking (0 - 127). More...
 
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). More...
 
uint8_t VelocityResponseDepth
 Dynamic range of velocity affecting amplitude (0 - 4) (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead). More...
 
uint8_t VelocityResponseCurveScaling
 0 - 127 (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead). More...
 
curve_type_t ReleaseVelocityResponseCurve
 Defines a transformation curve to the incoming release veloctiy values affecting envelope times. More...
 
uint8_t ReleaseVelocityResponseDepth
 Dynamic range of release velocity affecting envelope time (0 - 4). More...
 
uint8_t ReleaseTriggerDecay
 0 - 8 More...
 
crossfade_t Crossfade
 
bool PitchTrack
 If true: sample will be pitched according to the key position (this will be disabled for drums for example). More...
 
dim_bypass_ctrl_t DimensionBypass
 If defined, the MIDI controller can switch on/off the dimension in realtime. More...
 
int8_t Pan
 Panorama / Balance (-64..0..63 <-> left..middle..right) More...
 
bool SelfMask
 If true: high velocity notes will stop low velocity notes at the same note, with that you can save voices that wouldn't be audible anyway. More...
 
attenuation_ctrl_t AttenuationController
 MIDI Controller which has influence on the volume level of the sample (or entire sample group). More...
 
bool InvertAttenuationController
 Inverts the values coming from the defined Attenuation Controller. More...
 
uint8_t AttenuationControllerThreshold
 0-127 More...
 
uint8_t ChannelOffset
 Audio output where the audio signal of the dimension region should be routed to (0 - 9). More...
 
bool SustainDefeat
 If true: Sustain pedal will not hold a note. More...
 
bool MSDecode
 Gigastudio flag: defines if Mid Side Recordings should be decoded. More...
 
uint16_t SampleStartOffset
 Number of samples the sample start should be moved (0 - 2000). More...
 
double SampleAttenuation
 Sample volume (calculated from DLS::Sampler::Gain) More...
 
uint8_t DimensionUpperLimits [8]
 gig3: defines the upper limit of the dimension values for this dimension region. In case you wondered why this is defined on DimensionRegion level and not on Region level: the zone sizes (upper limits) of the velocity dimension can indeed differ in the individual dimension regions, depending on which zones of the other dimension types are currently selected. So this is exceptional for the velocity dimension only. All other dimension types have the same dimension zone sizes for every single DimensionRegion (of the sample Region). More...
 

Protected Member Functions

 DimensionRegion (Region *pParent, RIFF::List *_3ewl)
 
 DimensionRegion (RIFF::List *_3ewl, const DimensionRegion &src)
 
 ~DimensionRegion ()
 
void CopyAssign (const DimensionRegion *orig, const std::map< Sample *, Sample * > *mSamples)
 Make a (semi) deep copy of the DimensionRegion object given by orig and assign it to this object. More...
 
void AddSampleLoop (sample_loop_t *pLoopDef)
 Adds a new sample loop with the provided loop definition. More...
 
void DeleteSampleLoop (sample_loop_t *pLoopDef)
 Deletes an existing sample loop. More...
 
virtual void CopyAssign (const Sampler *orig)
 Make a deep copy of the Sampler object given by orig and assign it to this object. More...
 

Protected Attributes

uint8_t * VelocityTable
 For velocity dimensions with custom defined zone ranges only: used for fast converting from velocity MIDI value to dimension bit number. More...
 
uint8_t UnityNote
 
int16_t FineTune
 
int32_t Gain
 
bool NoSampleDepthTruncation
 
bool NoSampleCompression
 
uint32_t SampleLoops
 Reflects the number of sample loops. More...
 
sample_loop_t * pSampleLoops
 Points to the beginning of a sample loop array, or is NULL if there are no loops defined. More...
 
RIFF::ListpParentList
 
uint32_t uiHeaderSize
 
uint32_t SamplerOptions
 

Friends

class Region
 

Detailed Description

Encapsulates articulation informations of a dimension region.

This is the most important data object of the Gigasampler / GigaStudio format. A DimensionRegion provides the link to the sample to be played and all required articulation informations to be interpreted for playing back the sample and processing it appropriately by the sampler software. Every Region of a Gigasampler Instrument has at least one dimension region (exactly then when the Region has no dimension defined). Many Regions though provide more than one DimensionRegion, which reflect different playing "cases". For example a different sample might be played if a certain pedal is pressed down, or if the note was triggered with different velocity.

One instance of a DimensionRegion reflects exactly one particular case while playing an instrument (for instance "note between C3 and E3 was triggered AND note on velocity was between 20 and 42 AND modulation wheel controller is between 80 and 127). The DimensionRegion defines what to do under that one particular case, that is which sample to play back and how to play that sample back exactly and how to process it. So a DimensionRegion object is always linked to exactly one sample. It may however also link to no sample at all, for defining a "silence" case where nothing shall be played (for example when note on velocity was below 6).

Note that a DimensionRegion object only defines "what to do", but it does not define "when to do it". To actually resolve which DimensionRegion to pick under which situation, you need to refer to the DimensionRegions' parent Region object. The Region object contains the necessary "Dimension" definitions, which in turn define which DimensionRegion is associated with which playing case exactly.

The Gigasampler/GigaStudio format defines 3 Envelope Generators and 3 Low Frequency Oscillators:

  • EG1 and LFO1, both controlling sample amplitude
  • EG2 and LFO2, both controlling filter cutoff frequency
  • EG3 and LFO3, both controlling sample pitch

Since the gig format was designed as extension to the DLS file format, this class is derived from the DLS::Sampler class. So also refer to DLS::Sampler for additional informations, class attributes and methods.

Definition at line 366 of file gig.h.

Constructor & Destructor Documentation

◆ DimensionRegion() [1/2]

gig::DimensionRegion::DimensionRegion ( Region pParent,
RIFF::List _3ewl 
)
protected

Definition at line 1359 of file gig.cpp.

References AttenuationController, AttenuationControllerThreshold, ChannelOffset, CHUNK_ID_3EWA, CHUNK_ID_WSMP, gig::leverage_ctrl_t::controller_number, Crossfade, gig::curve_type_linear, gig::curve_type_nonlinear, gig::curve_type_special, gig::curve_type_unknown, gig::dim_bypass_ctrl_94, gig::dim_bypass_ctrl_95, gig::dim_bypass_ctrl_none, DimensionBypass, DimensionUpperLimits, EG1Attack, EG1Controller, EG1ControllerAttackInfluence, EG1ControllerDecayInfluence, EG1ControllerInvert, EG1ControllerReleaseInfluence, EG1Decay1, EG1Decay2, EG1Hold, EG1InfiniteSustain, EG1PreAttack, EG1Release, EG1Sustain, EG2Attack, EG2Controller, EG2ControllerAttackInfluence, EG2ControllerDecayInfluence, EG2ControllerInvert, EG2ControllerReleaseInfluence, EG2Decay1, EG2Decay2, EG2InfiniteSustain, EG2PreAttack, EG2Release, EG2Sustain, EG3Attack, EG3Depth, DLS::Sampler::Gain, RIFF::List::GetSubChunk(), GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT, GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT, GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT, GIG_EXP_DECODE, GIG_PITCH_TRACK_EXTRACT, GIG_VCF_RESONANCE_CTRL_EXTRACT, InvertAttenuationController, gig::lfo1_ctrl_internal, LFO1ControlDepth, LFO1Controller, LFO1FlipPhase, LFO1Frequency, LFO1InternalDepth, LFO1Sync, gig::lfo2_ctrl_internal, LFO2ControlDepth, LFO2Controller, LFO2FlipPhase, LFO2Frequency, LFO2InternalDepth, LFO2Sync, gig::lfo3_ctrl_modwheel, LFO3ControlDepth, LFO3Controller, LFO3Frequency, LFO3InternalDepth, LFO3Sync, MSDecode, Pan, PitchTrack, pSample, RIFF::Chunk::Read(), RIFF::Chunk::ReadInt16(), RIFF::Chunk::ReadInt32(), RIFF::Chunk::ReadInt8(), RIFF::Chunk::ReadUint16(), RIFF::Chunk::ReadUint8(), ReleaseTriggerDecay, ReleaseVelocityResponseCurve, ReleaseVelocityResponseDepth, RIFF::Chunk::RemainingBytes(), SampleAttenuation, DLS::Sampler::SamplerOptions, SampleStartOffset, SelfMask, SustainDefeat, gig::leverage_ctrl_t::type, gig::leverage_ctrl_t::type_none, gig::vcf_cutoff_ctrl_none, gig::vcf_res_ctrl_none, gig::vcf_type_lowpass, gig::vcf_type_lowpassturbo, VCFCutoff, VCFCutoffController, VCFCutoffControllerInvert, VCFEnabled, VCFKeyboardTracking, VCFKeyboardTrackingBreakpoint, VCFResonance, VCFResonanceController, VCFResonanceDynamic, VCFType, VCFVelocityCurve, VCFVelocityDynamicRange, VCFVelocityScale, VelocityResponseCurve, VelocityResponseCurveScaling, VelocityResponseDepth, VelocityTable, and VelocityUpperLimit.

◆ DimensionRegion() [2/2]

gig::DimensionRegion::DimensionRegion ( RIFF::List _3ewl,
const DimensionRegion src 
)
protected

◆ ~DimensionRegion()

gig::DimensionRegion::~DimensionRegion ( )
protected

Definition at line 2709 of file gig.cpp.

References VelocityTable.

Member Function Documentation

◆ AddSampleLoop()

void DLS::Sampler::AddSampleLoop ( sample_loop_t pLoopDef)
inherited

Adds a new sample loop with the provided loop definition.

Parameters
pLoopDef- points to a loop definition that is to be copied

Definition at line 633 of file DLS.cpp.

References DLS::Sampler::pSampleLoops, DLS::Sampler::SampleLoops, and DLS::sample_loop_t::Size.

◆ CopyAssign() [1/3]

void DLS::Sampler::CopyAssign ( const Sampler orig)
virtualinherited

Make a deep copy of the Sampler object given by orig and assign it to this object.

Parameters
orig- original Sampler object to be copied from

Definition at line 679 of file DLS.cpp.

References DLS::Sampler::FineTune, DLS::Sampler::Gain, DLS::Sampler::NoSampleCompression, DLS::Sampler::NoSampleDepthTruncation, DLS::Sampler::pSampleLoops, DLS::Sampler::SampleLoops, DLS::Sampler::SamplerOptions, and DLS::Sampler::UnityNote.

Referenced by DLS::Region::CopyAssign().

◆ CopyAssign() [2/3]

void gig::DimensionRegion::CopyAssign ( const DimensionRegion orig)
virtual

Make a (semi) deep copy of the DimensionRegion object given by orig and assign it to this object.

Note that all sample pointers referenced by orig are simply copied as memory address. Thus the respective samples are shared, not duplicated!

Parameters
orig- original DimensionRegion object to be copied from

Definition at line 1655 of file gig.cpp.

Referenced by gig::Region::CopyAssign(), gig::Region::DeleteDimensionZone(), and gig::Region::SplitDimensionZone().

◆ CopyAssign() [3/3]

void gig::DimensionRegion::CopyAssign ( const DimensionRegion orig,
const std::map< Sample *, Sample * > *  mSamples 
)
protected

Make a (semi) deep copy of the DimensionRegion object given by orig and assign it to this object.

Parameters
orig- original DimensionRegion object to be copied from
mSamples- crosslink map between the foreign file's samples and this file's samples

Definition at line 1667 of file gig.cpp.

References DLS::Resource::GetParent(), DLS::Sampler::pParentList, pSample, DLS::Sampler::pSampleLoops, DLS::Sampler::SampleLoops, and VelocityTable.

◆ DeleteSampleLoop()

void DLS::Sampler::DeleteSampleLoop ( sample_loop_t pLoopDef)
inherited

Deletes an existing sample loop.

Parameters
pLoopDef- pointer to existing loop definition
Exceptions
Exception- if given loop definition does not exist

Definition at line 655 of file DLS.cpp.

References DLS::Sampler::pSampleLoops, and DLS::Sampler::SampleLoops.

◆ GetParent()

Region * gig::DimensionRegion::GetParent ( ) const

Definition at line 2060 of file gig.cpp.

Referenced by UpdateChunks().

◆ GetVelocityAttenuation()

double gig::DimensionRegion::GetVelocityAttenuation ( uint8_t  MIDIKeyVelocity)

Returns the correct amplitude factor for the given MIDIKeyVelocity.

All involved parameters (VelocityResponseCurve, VelocityResponseDepth and VelocityResponseCurveScaling) involved are taken into account to calculate the amplitude factor. Use this method when a key was triggered to get the volume with which the sample should be played back.

Parameters
MIDIKeyVelocityMIDI velocity value of the triggered key (between 0 and 127)
Returns
amplitude factor (between 0.0 and 1.0)

Definition at line 2736 of file gig.cpp.

◆ GetVelocityCutoff()

double gig::DimensionRegion::GetVelocityCutoff ( uint8_t  MIDIKeyVelocity)

Definition at line 2744 of file gig.cpp.

◆ GetVelocityRelease()

double gig::DimensionRegion::GetVelocityRelease ( uint8_t  MIDIKeyVelocity)

Definition at line 2740 of file gig.cpp.

◆ SetGain()

void gig::DimensionRegion::SetGain ( int32_t  gain)
virtual

Updates the respective member variable and updates SampleAttenuation which depends on this value.

Reimplemented from DLS::Sampler.

Definition at line 1713 of file gig.cpp.

References DLS::Sampler::Gain, SampleAttenuation, and DLS::Sampler::SetGain().

◆ SetReleaseVelocityResponseCurve()

void gig::DimensionRegion::SetReleaseVelocityResponseCurve ( curve_type_t  curve)

Updates the respective member variable and the lookup table / cache that depends on this value.

Definition at line 2788 of file gig.cpp.

References ReleaseVelocityResponseCurve, and ReleaseVelocityResponseDepth.

◆ SetReleaseVelocityResponseDepth()

void gig::DimensionRegion::SetReleaseVelocityResponseDepth ( uint8_t  depth)

Updates the respective member variable and the lookup table / cache that depends on this value.

Definition at line 2797 of file gig.cpp.

References ReleaseVelocityResponseCurve, and ReleaseVelocityResponseDepth.

◆ SetVCFCutoffController()

void gig::DimensionRegion::SetVCFCutoffController ( vcf_cutoff_ctrl_t  controller)

Updates the respective member variable and the lookup table / cache that depends on this value.

Definition at line 2806 of file gig.cpp.

References VCFCutoffController, VCFVelocityCurve, VCFVelocityDynamicRange, and VCFVelocityScale.

◆ SetVCFVelocityCurve()

void gig::DimensionRegion::SetVCFVelocityCurve ( curve_type_t  curve)

Updates the respective member variable and the lookup table / cache that depends on this value.

Definition at line 2815 of file gig.cpp.

References VCFCutoffController, VCFVelocityCurve, VCFVelocityDynamicRange, and VCFVelocityScale.

◆ SetVCFVelocityDynamicRange()

void gig::DimensionRegion::SetVCFVelocityDynamicRange ( uint8_t  range)

Updates the respective member variable and the lookup table / cache that depends on this value.

Definition at line 2824 of file gig.cpp.

References VCFCutoffController, VCFVelocityCurve, VCFVelocityDynamicRange, and VCFVelocityScale.

◆ SetVCFVelocityScale()

void gig::DimensionRegion::SetVCFVelocityScale ( uint8_t  scaling)

Updates the respective member variable and the lookup table / cache that depends on this value.

Definition at line 2833 of file gig.cpp.

References VCFCutoffController, VCFVelocityCurve, VCFVelocityDynamicRange, and VCFVelocityScale.

◆ SetVelocityResponseCurve()

void gig::DimensionRegion::SetVelocityResponseCurve ( curve_type_t  curve)

Updates the respective member variable and the lookup table / cache that depends on this value.

Definition at line 2752 of file gig.cpp.

References VelocityResponseCurve, VelocityResponseCurveScaling, and VelocityResponseDepth.

◆ SetVelocityResponseCurveScaling()

void gig::DimensionRegion::SetVelocityResponseCurveScaling ( uint8_t  scaling)

Updates the respective member variable and the lookup table / cache that depends on this value.

Definition at line 2776 of file gig.cpp.

References VelocityResponseCurve, VelocityResponseCurveScaling, and VelocityResponseDepth.

◆ SetVelocityResponseDepth()

void gig::DimensionRegion::SetVelocityResponseDepth ( uint8_t  depth)

Updates the respective member variable and the lookup table / cache that depends on this value.

Definition at line 2764 of file gig.cpp.

References VelocityResponseCurve, VelocityResponseCurveScaling, and VelocityResponseDepth.

◆ UpdateChunks()

void gig::DimensionRegion::UpdateChunks ( progress_t pProgress)
virtual

Apply dimension region settings to the respective RIFF chunks.

You have to call File::Save() to make changes persistent.

Usually there is absolutely no need to call this method explicitly. It will be called automatically when File::Save() was called.

Parameters
pProgress- callback function for progress notification

Reimplemented from DLS::Sampler.

Definition at line 1727 of file gig.cpp.

References RIFF::List::AddSubChunk(), AttenuationController, AttenuationControllerThreshold, ChannelOffset, CHUNK_ID_3EWA, CHUNK_ID_WSMP, Crossfade, gig::curve_type_linear, gig::curve_type_nonlinear, gig::curve_type_special, gig::curve_type_unknown, gig::dim_bypass_ctrl_94, gig::dim_bypass_ctrl_95, gig::dim_bypass_ctrl_none, DimensionBypass, DimensionUpperLimits, EG1Attack, EG1Controller, EG1ControllerAttackInfluence, EG1ControllerDecayInfluence, EG1ControllerInvert, EG1ControllerReleaseInfluence, EG1Decay1, EG1Decay2, EG1Hold, EG1InfiniteSustain, EG1PreAttack, EG1Release, EG1Sustain, EG2Attack, EG2Controller, EG2ControllerAttackInfluence, EG2ControllerDecayInfluence, EG2ControllerInvert, EG2ControllerReleaseInfluence, EG2Decay1, EG2Decay2, EG2InfiniteSustain, EG2PreAttack, EG2Release, EG2Sustain, EG3Attack, EG3Depth, RIFF::Chunk::GetNewSize(), DLS::Resource::GetParent(), GetParent(), RIFF::List::GetSubChunk(), GIG_EG_CTR_ATTACK_INFLUENCE_ENCODE, GIG_EG_CTR_DECAY_INFLUENCE_ENCODE, GIG_EG_CTR_RELEASE_INFLUENCE_ENCODE, GIG_EXP_ENCODE, GIG_PITCH_TRACK_ENCODE, GIG_VCF_RESONANCE_CTRL_ENCODE, gig::crossfade_t::in_end, gig::crossfade_t::in_start, InvertAttenuationController, LFO1ControlDepth, LFO1Controller, LFO1FlipPhase, LFO1Frequency, LFO1InternalDepth, LFO1Sync, LFO2ControlDepth, LFO2Controller, LFO2FlipPhase, LFO2Frequency, LFO2InternalDepth, LFO2Sync, LFO3ControlDepth, LFO3Controller, LFO3Frequency, LFO3InternalDepth, LFO3Sync, RIFF::Chunk::LoadChunkData(), DLS::version_t::major, MSDecode, gig::crossfade_t::out_end, gig::crossfade_t::out_start, Pan, PitchTrack, DLS::Sampler::pParentList, DLS::File::pVersion, ReleaseTriggerDecay, ReleaseVelocityResponseCurve, ReleaseVelocityResponseDepth, SampleStartOffset, SelfMask, SustainDefeat, DLS::Sampler::UpdateChunks(), gig::vcf_res_ctrl_none, gig::vcf_type_lowpass, gig::vcf_type_lowpassturbo, VCFCutoff, VCFCutoffController, VCFCutoffControllerInvert, VCFEnabled, VCFKeyboardTracking, VCFKeyboardTrackingBreakpoint, VCFResonance, VCFResonanceController, VCFResonanceDynamic, VCFType, VCFVelocityCurve, VCFVelocityDynamicRange, VCFVelocityScale, VelocityResponseCurve, VelocityResponseCurveScaling, VelocityResponseDepth, and VelocityUpperLimit.

Referenced by gig::Region::UpdateChunks().

Friends And Related Function Documentation

◆ Region

friend class Region
friend

Definition at line 488 of file gig.h.

Member Data Documentation

◆ AttenuationController

attenuation_ctrl_t gig::DimensionRegion::AttenuationController

MIDI Controller which has influence on the volume level of the sample (or entire sample group).

Definition at line 444 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ AttenuationControllerThreshold

uint8_t gig::DimensionRegion::AttenuationControllerThreshold

0-127

Definition at line 446 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ ChannelOffset

uint8_t gig::DimensionRegion::ChannelOffset

Audio output where the audio signal of the dimension region should be routed to (0 - 9).

Definition at line 447 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ Crossfade

crossfade_t gig::DimensionRegion::Crossfade

Definition at line 439 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ DimensionBypass

dim_bypass_ctrl_t gig::DimensionRegion::DimensionBypass

If defined, the MIDI controller can switch on/off the dimension in realtime.

Definition at line 441 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ DimensionUpperLimits

uint8_t gig::DimensionRegion::DimensionUpperLimits[8]

gig3: defines the upper limit of the dimension values for this dimension region. In case you wondered why this is defined on DimensionRegion level and not on Region level: the zone sizes (upper limits) of the velocity dimension can indeed differ in the individual dimension regions, depending on which zones of the other dimension types are currently selected. So this is exceptional for the velocity dimension only. All other dimension types have the same dimension zone sizes for every single DimensionRegion (of the sample Region).

Definition at line 452 of file gig.h.

Referenced by gig::Region::AddDimension(), gig::Region::DeleteDimension(), gig::Region::DeleteDimensionZone(), DimensionRegion(), gig::Region::SplitDimensionZone(), UpdateChunks(), and gig::Region::UpdateVelocityTable().

◆ EG1Attack

double gig::DimensionRegion::EG1Attack

Attack time of the sample amplitude EG (0.000 - 60.000s).

Definition at line 372 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG1Controller

eg1_ctrl_t gig::DimensionRegion::EG1Controller

MIDI Controller which has influence on sample amplitude EG parameters (attack, decay, release).

Definition at line 379 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG1ControllerAttackInfluence

uint8_t gig::DimensionRegion::EG1ControllerAttackInfluence

Amount EG1 Controller has influence on the EG1 Attack time (0 - 3, where 0 means off).

Definition at line 381 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG1ControllerDecayInfluence

uint8_t gig::DimensionRegion::EG1ControllerDecayInfluence

Amount EG1 Controller has influence on the EG1 Decay time (0 - 3, where 0 means off).

Definition at line 382 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG1ControllerInvert

bool gig::DimensionRegion::EG1ControllerInvert

Invert values coming from defined EG1 controller.

Definition at line 380 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG1ControllerReleaseInfluence

uint8_t gig::DimensionRegion::EG1ControllerReleaseInfluence

Amount EG1 Controller has influence on the EG1 Release time (0 - 3, where 0 means off).

Definition at line 383 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG1Decay1

double gig::DimensionRegion::EG1Decay1

Decay time of the sample amplitude EG (0.000 - 60.000s).

Definition at line 373 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG1Decay2

double gig::DimensionRegion::EG1Decay2

Only if EG1InfiniteSustain == false: 2nd decay stage time of the sample amplitude EG (0.000 - 60.000s).

Definition at line 374 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG1Hold

bool gig::DimensionRegion::EG1Hold

If true, Decay1 stage should be postponed until the sample reached the sample loop start.

Definition at line 378 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG1InfiniteSustain

bool gig::DimensionRegion::EG1InfiniteSustain

If true, instead of going into Decay2 phase, Decay1 level will be hold until note will be released.

Definition at line 375 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG1PreAttack

uint16_t gig::DimensionRegion::EG1PreAttack

Preattack value of the sample amplitude EG (0 - 1000 permille).

Definition at line 371 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG1Release

double gig::DimensionRegion::EG1Release

Release time of the sample amplitude EG (0.000 - 60.000s).

Definition at line 377 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG1Sustain

uint16_t gig::DimensionRegion::EG1Sustain

Sustain value of the sample amplitude EG (0 - 1000 permille).

Definition at line 376 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG2Attack

double gig::DimensionRegion::EG2Attack

Attack time of the filter cutoff EG (0.000 - 60.000s).

Definition at line 392 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG2Controller

eg2_ctrl_t gig::DimensionRegion::EG2Controller

MIDI Controller which has influence on filter cutoff EG parameters (attack, decay, release).

Definition at line 398 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG2ControllerAttackInfluence

uint8_t gig::DimensionRegion::EG2ControllerAttackInfluence

Amount EG2 Controller has influence on the EG2 Attack time (0 - 3, where 0 means off).

Definition at line 400 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG2ControllerDecayInfluence

uint8_t gig::DimensionRegion::EG2ControllerDecayInfluence

Amount EG2 Controller has influence on the EG2 Decay time (0 - 3, where 0 means off).

Definition at line 401 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG2ControllerInvert

bool gig::DimensionRegion::EG2ControllerInvert

Invert values coming from defined EG2 controller.

Definition at line 399 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG2ControllerReleaseInfluence

uint8_t gig::DimensionRegion::EG2ControllerReleaseInfluence

Amount EG2 Controller has influence on the EG2 Release time (0 - 3, where 0 means off).

Definition at line 402 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG2Decay1

double gig::DimensionRegion::EG2Decay1

Decay time of the filter cutoff EG (0.000 - 60.000s).

Definition at line 393 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG2Decay2

double gig::DimensionRegion::EG2Decay2

Only if EG2InfiniteSustain == false: 2nd stage decay time of the filter cutoff EG (0.000 - 60.000s).

Definition at line 394 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG2InfiniteSustain

bool gig::DimensionRegion::EG2InfiniteSustain

If true, instead of going into Decay2 phase, Decay1 level will be hold until note will be released.

Definition at line 395 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG2PreAttack

uint16_t gig::DimensionRegion::EG2PreAttack

Preattack value of the filter cutoff EG (0 - 1000 permille).

Definition at line 391 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG2Release

double gig::DimensionRegion::EG2Release

Release time of the filter cutoff EG (0.000 - 60.000s).

Definition at line 397 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG2Sustain

uint16_t gig::DimensionRegion::EG2Sustain

Sustain value of the filter cutoff EG (0 - 1000 permille).

Definition at line 396 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG3Attack

double gig::DimensionRegion::EG3Attack

Attack time of the sample pitch EG (0.000 - 10.000s).

Definition at line 410 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ EG3Depth

int16_t gig::DimensionRegion::EG3Depth

Depth of the sample pitch EG (-1200 - +1200).

Definition at line 411 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ FineTune

int16_t DLS::Sampler::FineTune
inherited

◆ Gain

int32_t DLS::Sampler::Gain
inherited

◆ InvertAttenuationController

bool gig::DimensionRegion::InvertAttenuationController

Inverts the values coming from the defined Attenuation Controller.

Definition at line 445 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ LFO1ControlDepth

uint16_t gig::DimensionRegion::LFO1ControlDepth

Controller depth influencing sample amplitude LFO pitch (0 - 1200 cents).

Definition at line 386 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ LFO1Controller

lfo1_ctrl_t gig::DimensionRegion::LFO1Controller

MIDI Controller which controls sample amplitude LFO.

Definition at line 387 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ LFO1FlipPhase

bool gig::DimensionRegion::LFO1FlipPhase

Inverts phase of the sample amplitude LFO wave.

Definition at line 388 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ LFO1Frequency

double gig::DimensionRegion::LFO1Frequency

Frequency of the sample amplitude LFO (0.10 - 10.00 Hz).

Definition at line 384 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ LFO1InternalDepth

uint16_t gig::DimensionRegion::LFO1InternalDepth

Firm pitch of the sample amplitude LFO (0 - 1200 cents).

Definition at line 385 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ LFO1Sync

bool gig::DimensionRegion::LFO1Sync

If set to true only one LFO should be used for all voices.

Definition at line 389 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ LFO2ControlDepth

uint16_t gig::DimensionRegion::LFO2ControlDepth

Controller depth influencing filter cutoff LFO pitch (0 - 1200).

Definition at line 405 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ LFO2Controller

lfo2_ctrl_t gig::DimensionRegion::LFO2Controller

MIDI Controlle which controls the filter cutoff LFO.

Definition at line 406 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ LFO2FlipPhase

bool gig::DimensionRegion::LFO2FlipPhase

Inverts phase of the filter cutoff LFO wave.

Definition at line 407 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ LFO2Frequency

double gig::DimensionRegion::LFO2Frequency

Frequency of the filter cutoff LFO (0.10 - 10.00 Hz).

Definition at line 403 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ LFO2InternalDepth

uint16_t gig::DimensionRegion::LFO2InternalDepth

Firm pitch of the filter cutoff LFO (0 - 1200 cents).

Definition at line 404 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ LFO2Sync

bool gig::DimensionRegion::LFO2Sync

If set to true only one LFO should be used for all voices.

Definition at line 408 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ LFO3ControlDepth

int16_t gig::DimensionRegion::LFO3ControlDepth

Controller depth of the sample pitch LFO (-1200 - +1200 cents).

Definition at line 414 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ LFO3Controller

lfo3_ctrl_t gig::DimensionRegion::LFO3Controller

MIDI Controller which controls the sample pitch LFO.

Definition at line 415 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ LFO3Frequency

double gig::DimensionRegion::LFO3Frequency

Frequency of the sample pitch LFO (0.10 - 10.00 Hz).

Definition at line 412 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ LFO3InternalDepth

int16_t gig::DimensionRegion::LFO3InternalDepth

Firm depth of the sample pitch LFO (-1200 - +1200 cents).

Definition at line 413 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ LFO3Sync

bool gig::DimensionRegion::LFO3Sync

If set to true only one LFO should be used for all voices.

Definition at line 416 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ MSDecode

bool gig::DimensionRegion::MSDecode

Gigastudio flag: defines if Mid Side Recordings should be decoded.

Definition at line 449 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ NoSampleCompression

bool DLS::Sampler::NoSampleCompression
inherited

◆ NoSampleDepthTruncation

bool DLS::Sampler::NoSampleDepthTruncation
inherited

◆ Pan

int8_t gig::DimensionRegion::Pan

Panorama / Balance (-64..0..63 <-> left..middle..right)

Definition at line 442 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ PitchTrack

bool gig::DimensionRegion::PitchTrack

If true: sample will be pitched according to the key position (this will be disabled for drums for example).

Definition at line 440 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ pParentList

RIFF::List* DLS::Sampler::pParentList
protectedinherited

◆ pSample

Sample* gig::DimensionRegion::pSample

Points to the Sample which is assigned to the dimension region.

Definition at line 369 of file gig.h.

Referenced by CopyAssign(), gig::File::DeleteSample(), DimensionRegion(), gig::Region::Region(), gig::Region::UpdateChunks(), and gig::File::UpdateChunks().

◆ pSampleLoops

sample_loop_t* DLS::Sampler::pSampleLoops
inherited

Points to the beginning of a sample loop array, or is NULL if there are no loops defined.

Definition at line 372 of file DLS.h.

Referenced by DLS::Sampler::AddSampleLoop(), DLS::Sampler::CopyAssign(), CopyAssign(), DLS::Sampler::DeleteSampleLoop(), DimensionRegion(), gig::Sample::ReadAndLoop(), DLS::Sampler::Sampler(), DLS::Sampler::UpdateChunks(), and DLS::Sampler::~Sampler().

◆ ReleaseTriggerDecay

uint8_t gig::DimensionRegion::ReleaseTriggerDecay

0 - 8

Definition at line 437 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ ReleaseVelocityResponseCurve

curve_type_t gig::DimensionRegion::ReleaseVelocityResponseCurve

Defines a transformation curve to the incoming release veloctiy values affecting envelope times.

Deprecated:
Don't alter directly, use SetReleaseVelocityResponseCurve() instead!

Definition at line 435 of file gig.h.

Referenced by DimensionRegion(), SetReleaseVelocityResponseCurve(), SetReleaseVelocityResponseDepth(), and UpdateChunks().

◆ ReleaseVelocityResponseDepth

uint8_t gig::DimensionRegion::ReleaseVelocityResponseDepth

Dynamic range of release velocity affecting envelope time (0 - 4).

Deprecated:
Don't alter directly, use SetReleaseVelocityResponseDepth() instead!

Definition at line 436 of file gig.h.

Referenced by DimensionRegion(), SetReleaseVelocityResponseCurve(), SetReleaseVelocityResponseDepth(), and UpdateChunks().

◆ SampleAttenuation

double gig::DimensionRegion::SampleAttenuation

Sample volume (calculated from DLS::Sampler::Gain)

Definition at line 451 of file gig.h.

Referenced by DimensionRegion(), and SetGain().

◆ SampleLoops

◆ SamplerOptions

uint32_t DLS::Sampler::SamplerOptions
protectedinherited

◆ SampleStartOffset

uint16_t gig::DimensionRegion::SampleStartOffset

Number of samples the sample start should be moved (0 - 2000).

Definition at line 450 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ SelfMask

bool gig::DimensionRegion::SelfMask

If true: high velocity notes will stop low velocity notes at the same note, with that you can save voices that wouldn't be audible anyway.

Definition at line 443 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ SustainDefeat

bool gig::DimensionRegion::SustainDefeat

If true: Sustain pedal will not hold a note.

Definition at line 448 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ uiHeaderSize

uint32_t DLS::Sampler::uiHeaderSize
protectedinherited

Definition at line 381 of file DLS.h.

Referenced by DLS::Sampler::Sampler(), and DLS::Sampler::UpdateChunks().

◆ UnityNote

uint8_t DLS::Sampler::UnityNote
inherited

◆ VCFCutoff

uint8_t gig::DimensionRegion::VCFCutoff

Max. cutoff frequency.

Definition at line 422 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ VCFCutoffController

vcf_cutoff_ctrl_t gig::DimensionRegion::VCFCutoffController

Specifies which external controller has influence on the filter cutoff frequency.

Deprecated:
Don't alter directly, use SetVCFCutoffController() instead!

Definition at line 420 of file gig.h.

Referenced by DimensionRegion(), SetVCFCutoffController(), SetVCFVelocityCurve(), SetVCFVelocityDynamicRange(), SetVCFVelocityScale(), and UpdateChunks().

◆ VCFCutoffControllerInvert

bool gig::DimensionRegion::VCFCutoffControllerInvert

Inverts values coming from the defined cutoff controller.

Definition at line 421 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ VCFEnabled

bool gig::DimensionRegion::VCFEnabled

If filter should be used.

Definition at line 418 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ VCFKeyboardTracking

bool gig::DimensionRegion::VCFKeyboardTracking

If true: VCF cutoff frequence will be dependend to the note key position relative to the defined breakpoint value.

Definition at line 429 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ VCFKeyboardTrackingBreakpoint

uint8_t gig::DimensionRegion::VCFKeyboardTrackingBreakpoint

See VCFKeyboardTracking (0 - 127).

Definition at line 430 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ VCFResonance

uint8_t gig::DimensionRegion::VCFResonance

Firm internal filter resonance weight.

Definition at line 426 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ VCFResonanceController

vcf_res_ctrl_t gig::DimensionRegion::VCFResonanceController

Specifies which external controller has influence on the filter resonance Q.

Definition at line 428 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ VCFResonanceDynamic

bool gig::DimensionRegion::VCFResonanceDynamic

If true: Increases the resonance Q according to changes of controllers that actually control the VCF cutoff frequency (EG2, ext. VCF MIDI controller).

Definition at line 427 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ VCFType

vcf_type_t gig::DimensionRegion::VCFType

Defines the general filter characteristic (lowpass, highpass, bandpass, etc.).

Definition at line 419 of file gig.h.

Referenced by DimensionRegion(), and UpdateChunks().

◆ VCFVelocityCurve

curve_type_t gig::DimensionRegion::VCFVelocityCurve

Defines a transformation curve for the incoming velocity values, affecting the VCF.

Deprecated:
Don't alter directly, use SetVCFVelocityCurve() instead!

Definition at line 423 of file gig.h.

Referenced by DimensionRegion(), SetVCFCutoffController(), SetVCFVelocityCurve(), SetVCFVelocityDynamicRange(), SetVCFVelocityScale(), and UpdateChunks().

◆ VCFVelocityDynamicRange

uint8_t gig::DimensionRegion::VCFVelocityDynamicRange

0x04 = lowest, 0x00 = highest .

Deprecated:
Don't alter directly, use SetVCFVelocityDynamicRange() instead!

Definition at line 425 of file gig.h.

Referenced by DimensionRegion(), SetVCFCutoffController(), SetVCFVelocityCurve(), SetVCFVelocityDynamicRange(), SetVCFVelocityScale(), and UpdateChunks().

◆ VCFVelocityScale

uint8_t gig::DimensionRegion::VCFVelocityScale

(0-127) Amount velocity controls VCF cutoff frequency (only if no other VCF cutoff controller is defined, otherwise this is the minimum cutoff).

Deprecated:
Don't alter directly, use SetVCFVelocityScale() instead!

Definition at line 424 of file gig.h.

Referenced by DimensionRegion(), SetVCFCutoffController(), SetVCFVelocityCurve(), SetVCFVelocityDynamicRange(), SetVCFVelocityScale(), and UpdateChunks().

◆ VelocityResponseCurve

curve_type_t gig::DimensionRegion::VelocityResponseCurve

Defines a transformation curve to the incoming velocity values affecting amplitude (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead).

Deprecated:
Don't alter directly, use SetVelocityResponseCurve() instead!

Definition at line 432 of file gig.h.

Referenced by DimensionRegion(), SetVelocityResponseCurve(), SetVelocityResponseCurveScaling(), SetVelocityResponseDepth(), and UpdateChunks().

◆ VelocityResponseCurveScaling

uint8_t gig::DimensionRegion::VelocityResponseCurveScaling

0 - 127 (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead).

Deprecated:
Don't alter directly, use SetVelocityResponseCurveScaling() instead!

Definition at line 434 of file gig.h.

Referenced by DimensionRegion(), SetVelocityResponseCurve(), SetVelocityResponseCurveScaling(), SetVelocityResponseDepth(), and UpdateChunks().

◆ VelocityResponseDepth

uint8_t gig::DimensionRegion::VelocityResponseDepth

Dynamic range of velocity affecting amplitude (0 - 4) (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead).

Deprecated:
Don't alter directly, use SetVelocityResponseDepth() instead!

Definition at line 433 of file gig.h.

Referenced by DimensionRegion(), SetVelocityResponseCurve(), SetVelocityResponseCurveScaling(), SetVelocityResponseDepth(), and UpdateChunks().

◆ VelocityTable

uint8_t* gig::DimensionRegion::VelocityTable
protected

For velocity dimensions with custom defined zone ranges only: used for fast converting from velocity MIDI value to dimension bit number.

Definition at line 483 of file gig.h.

Referenced by CopyAssign(), DimensionRegion(), gig::Region::GetDimensionRegionByValue(), gig::Region::GetDimensionRegionIndexByValue(), gig::Region::UpdateVelocityTable(), and ~DimensionRegion().

◆ VelocityUpperLimit

uint8_t gig::DimensionRegion::VelocityUpperLimit

Defines the upper velocity value limit of a velocity split (only if an user defined limit was set, thus a value not equal to 128/NumberOfSplits, else this value is 0). Only for gig2, for gig3 and above the DimensionUpperLimits are used instead.

Definition at line 368 of file gig.h.

Referenced by DimensionRegion(), UpdateChunks(), and gig::Region::UpdateVelocityTable().


The documentation for this class was generated from the following files: