Compressor / limiter parameters

It is the definition of the parameter to set with the compressor / limiter. More...

Macros
#define	CRIATOMEXASR_COMPRESSOR_PARAMETER_THRESHOLD   (0)
	Threshold. More...
#define	CRIATOMEXASR_COMPRESSOR_PARAMETER_RATIO   (1)
	Ratio. More...
#define	CRIATOMEXASR_COMPRESSOR_PARAMETER_ATTACK_TIME_MS   (2)
	Attack time [ms]. More...
#define	CRIATOMEXASR_COMPRESSOR_PARAMETER_RELEASE_TIME_MS   (3)
	Release time [ms]. More...
#define	CRIATOMEXASR_COMPRESSOR_PARAMETER_OUTPUT_GAIN   (4)
	Maximum output gain [amplitude]. More...
#define	CRIATOMEXASR_COMPRESSOR_PARAMETER_SURROUND_LINK   (5)
	Surround link strength. More...
#define	CRIATOMEXASR_COMPRESSOR_PARAMETER_SPLIT_EQ_TYPE   (6)
	Type of split EQ. More...
#define	CRIATOMEXASR_COMPRESSOR_PARAMETER_SPLIT_EQ_FREQUENCY   (7)
	Split EQ processing frequency [Hz]. More...
#define	CRIATOMEXASR_COMPRESSOR_PARAMETER_SPLIT_EQ_QUALITY_FACTOR   (8)
	Q value of split EQ. More...
#define	CRIATOMEXASR_COMPRESSOR_NUM_PARAMETERS   (9)
	Number of parameters of the compressor.
#define	CRIATOMEXASR_COMPRESSOR_SPLIT_EQ_TYPE_NONE   (0)
	Set value when not using split EQ.
#define	CRIATOMEXASR_COMPRESSOR_SPLIT_EQ_TYPE_LOWPASS   (1)
	Set value when using low pass filter with split EQ.
#define	CRIATOMEXASR_COMPRESSOR_SPLIT_EQ_TYPE_HIGHPASS   (2)
	Set value when using high pass filter with split EQ.
#define	CRIATOMEXASR_COMPRESSOR_SPLIT_EQ_TYPE_BANDPASS   (3)
	Set value when using band pass filter with split EQ.
#define	CRIATOMEXASR_COMPRESSOR_SPLIT_EQ_TYPE_NOTCH   (4)
	Set value when using notch filter with split EQ.
#define	CRIATOMEXASR_COMPRESSOR_MODE_NORMAL   (0)
	Set value when operating the compressor according to its own amplitude measurement result.
#define	CRIATOMEXASR_COMPRESSOR_MODE_SIDE_CHAIN   (1)
	Set value when operating the compressor using side chain.
#define	CRIATOMEXASR_COMPRESSOR_TYPE_PEAK   (0)
	Set value when setting the amplitude detection type of the compressor to the peak value.
#define	CRIATOMEXASR_COMPRESSOR_TYPE_RMS   (1)
	Set value when setting the amplitude detection type of the compressor to RMS.
#define	CRIATOMEXASR_LIMITER_PARAMETER_THRESHOLD   (0)
	Threshold. More...
#define	CRIATOMEXASR_LIMITER_PARAMETER_ATTACK_TIME_MS   (1)
	Attack time [ms]. More...
#define	CRIATOMEXASR_LIMITER_PARAMETER_RELEASE_TIME_MS   (2)
	Release time [ms]. More...
#define	CRIATOMEXASR_LIMITER_PARAMETER_OUTPUT_GAIN   (3)
	Maximum output gain [amplitude]. More...
#define	CRIATOMEXASR_LIMITER_PARAMETER_SURROUND_LINK   (4)
	Surround link strength. More...
#define	CRIATOMEXASR_LIMITER_PARAMETER_TYPE   (5)
	Amplitude detection value type. More...
#define	CRIATOMEXASR_LIMITER_NUM_PARAMETERS   (6)
	Number of limiter parameters.
#define	CRIATOMEXASR_LIMITER_MODE_NORMAL   (0)
	Set value when operating the limiter according to its own amplitude measurement result.
#define	CRIATOMEXASR_LIMITER_MODE_SIDE_CHAIN   (1)
	Set value when operating the limiter using side chain.
#define	CRIATOMEXASR_LIMITER_TYPE_PEAK   (0)
	Set value when setting the amplitude detection type of the limiter to the peak value.
#define	CRIATOMEXASR_LIMITER_TYPE_RMS   (1)
	Set value when setting limiter amplitude detection type to RMS.

Detailed Description

It is the definition of the parameter to set with the compressor / limiter.

See also

criAtomExAsrRack_SetEffectParameter, criAtomExAsrRack_GetEffectParameter

Macro Definition Documentation

CRIATOMEXASR_COMPRESSOR_PARAMETER_THRESHOLD

#define CRIATOMEXASR_COMPRESSOR_PARAMETER_THRESHOLD   (0)

Threshold.

Description:

In this parameter index, specify the compressor threshold (the value at which amplitude starts to be compressed).
The initial value of the parameter is 1.0 f, the minimum value is 0.0 f, and the maximum value is 1.0 f.

Note

To convert from ratio value to dB value, take the common logarithm (logarithm with base 10) of the ratio value and multiply it by 20.0f.

// Convert from db to ratio
ratio = powf(10.0f, db / 20.0f);
// Convert from ratio to cent
db = 20.0f * log10f(ratio);

CRIATOMEXASR_COMPRESSOR_PARAMETER_RATIO

#define CRIATOMEXASR_COMPRESSOR_PARAMETER_RATIO   (1)

Ratio.

Description:

Specify the compressor ratio (compression value) for this parameter index.
The parameter's initial value is 1.0f, and there are no minimum or maximum limits, but the minimum value is limited to 0.01f during signal processing.

CRIATOMEXASR_COMPRESSOR_PARAMETER_ATTACK_TIME_MS

#define CRIATOMEXASR_COMPRESSOR_PARAMETER_ATTACK_TIME_MS   (2)

Attack time [ms].

Description:

In this parameter index, specify the compressor attack time (the time to compress to the specified ratio).
The initial value of the parameter is 0.0 f, the minimum value is 0.0 f, and the maximum value is 300.0 f.

CRIATOMEXASR_COMPRESSOR_PARAMETER_RELEASE_TIME_MS

#define CRIATOMEXASR_COMPRESSOR_PARAMETER_RELEASE_TIME_MS   (3)

Release time [ms].

Description:

This parameter index specifies the release time of the compressor (the time it takes for compression to end after the amplitude falls below the threshold).
The initial value of the parameter is 0.0f, the minimum value is 0.0f, and the maximum value is 50000.0f.

CRIATOMEXASR_COMPRESSOR_PARAMETER_OUTPUT_GAIN

#define CRIATOMEXASR_COMPRESSOR_PARAMETER_OUTPUT_GAIN   (4)

Maximum output gain [amplitude].

Description:

Specify the maximum output gain of the compressor in this parameter index.
The initial value of the parameter is 1.0 f, the minimum value is the (-24/5) th power of 10 (corresponding to -96 dB),and the maximum value is the (12/5) th power of 10 (corresponding to 48 dB).

CRIATOMEXASR_COMPRESSOR_PARAMETER_SURROUND_LINK

#define CRIATOMEXASR_COMPRESSOR_PARAMETER_SURROUND_LINK   (5)

Surround link strength.

Description:

Specify the strength of the surround link of the compressor in this parameter index.
The surround link function is a function that changes the strength of compression by using the lowest amplitude value in all channels.
When 1.0 f, the lowest amplitude value in all channels is completely used, and at 0.0 f, the surround link function is turned OFF.

CRIATOMEXASR_COMPRESSOR_PARAMETER_SPLIT_EQ_TYPE

#define CRIATOMEXASR_COMPRESSOR_PARAMETER_SPLIT_EQ_TYPE   (6)

Type of split EQ.

Description:

In this parameter index, specify the type of split EQ of the compressor.
Split EQ is an EQ that divides the band into two. The compressor is applied only to the band extracted by the filter, and it is combined with the remaining band.

See also

CRIATOMEXASR_COMPRESSOR_SPLIT_EQ_TYPE_NONE, CRIATOMEXASR_COMPRESSOR_SPLIT_EQ_TYPE_LOWPASS, CRIATOMEXASR_COMPRESSOR_SPLIT_EQ_TYPE_HIGHPASS, CRIATOMEXASR_COMPRESSOR_SPLIT_EQ_TYPE_BANDPASS, CRIATOMEXASR_COMPRESSOR_SPLIT_EQ_TYPE_NOTCH

CRIATOMEXASR_COMPRESSOR_PARAMETER_SPLIT_EQ_FREQUENCY

#define CRIATOMEXASR_COMPRESSOR_PARAMETER_SPLIT_EQ_FREQUENCY   (7)

Split EQ processing frequency [Hz].

Description:

In this parameter index, specify the processing frequency of the split EQ of the compressor.
The minimum value of the parameter is 24.0 f, and the maximum value is 24000.0 f.

CRIATOMEXASR_COMPRESSOR_PARAMETER_SPLIT_EQ_QUALITY_FACTOR

#define CRIATOMEXASR_COMPRESSOR_PARAMETER_SPLIT_EQ_QUALITY_FACTOR   (8)

Q value of split EQ.

Description:

In this parameter index, specify the Q value (sharpness, quality factor) of the split EQ of the compressor.
The initial value of the parameter is 1.0f, the minimum value is 0.0f, and the maximum value is 10.0f.

CRIATOMEXASR_LIMITER_PARAMETER_THRESHOLD

#define CRIATOMEXASR_LIMITER_PARAMETER_THRESHOLD   (0)

Threshold.

Description:

In this parameter index, specify the threshold of the limiter (the threshold at which the amplitude is compressed).

CRIATOMEXASR_LIMITER_PARAMETER_ATTACK_TIME_MS

#define CRIATOMEXASR_LIMITER_PARAMETER_ATTACK_TIME_MS   (1)

Attack time [ms].

Description:

Specify the attack time of the limiter (time until compression is completed) in this parameter index. The initial value of the parameter is 0.0 f, the minimum value is 0.0 f, and the maximum value is 200.0 f.

CRIATOMEXASR_LIMITER_PARAMETER_RELEASE_TIME_MS

#define CRIATOMEXASR_LIMITER_PARAMETER_RELEASE_TIME_MS   (2)

Release time [ms].

Description:

In this parameter index, specify the release time of the limiter (the time until the compression ends after the amplitude becomes below the threshold value). The initial value of the parameter is 0.0 f, the minimum value is 0.0 f, and the maximum value is 50000.0 f.

CRIATOMEXASR_LIMITER_PARAMETER_OUTPUT_GAIN

#define CRIATOMEXASR_LIMITER_PARAMETER_OUTPUT_GAIN   (3)

Maximum output gain [amplitude].

Description:

Specify the maximum output gain of the limiter in this parameter index.
The initial value of the parameter is 1.0 f, the minimum value is -4 to the power of -4.8 (corresponding to -96 dB),and the maximum value is 2.4 power (equivalent to 48 dB) of 10.

CRIATOMEXASR_LIMITER_PARAMETER_SURROUND_LINK

#define CRIATOMEXASR_LIMITER_PARAMETER_SURROUND_LINK   (4)

Surround link strength.

Description:

Specify the strength of the surround link of the limiter in this parameter index.
The surround link function is a function that changes the strength of compression by using the lowest amplitude value in all channels.
When 1.0 f, the lowest amplitude value in all channels is completely used, and at 0.0 f, the surround link function is turned OFF.

CRIATOMEXASR_LIMITER_PARAMETER_TYPE

#define CRIATOMEXASR_LIMITER_PARAMETER_TYPE   (5)

Amplitude detection value type.

Description:

Specify the amplitude detection value type of the limiter in this parameter index.

See also

CRIATOMEXASR_LIMITER_TYPE_PEAK, CRIATOMEXASR_LIMITER_TYPE_RMS