CRI ADX  Last Updated: 2024-07-17 10:47 p
Macros
Delay / Echo / Multitap Delay Parameters
CriAtomExAsr API » Parameters of the ASR bus effect

Delay / Echo / Definition of parameters to be set with multi tap delay. More...

Macros

#define CRIATOMEXASR_DELAY_PARAMETER_DELAY_TIME_MS   (0)
 Delay time [ms]. More...
 
#define CRIATOMEXASR_DELAY_NUM_PARAMETERS   (1)
 Number of delay parameters.
 
#define CRIATOMEXASR_DELAY_PARAMETER_MIN_DELAY_TIME_MS   (50.0f)
 Minimum delay time that can be set with delay [ms].
 
#define CRIATOMEXASR_DELAY_PARAMETER_MAX_DELAY_TIME_MS   (1000.0f)
 Maximum delay time that can be set with delay [ms]. More...
 
#define CRIATOMEXASR_ECHO_PARAMETER_DELAY_TIME_MS   (0)
 Delay time [ms]. More...
 
#define CRIATOMEXASR_ECHO_PARAMETER_FB_GAIN   (1)
 Feedback gain. More...
 
#define CRIATOMEXASR_ECHO_NUM_PARAMETERS   (2)
 Number of parameters of echo.
 
#define CRIATOMEXASR_ECHO_PARAMETER_MIN_DELAY_TIME_MS   (0.0f)
 Minimum delay time that can be set by echo [ms].
 
#define CRIATOMEXASR_ECHO_PARAMETER_MAX_DELAY_TIME_MS   (1000.0f)
 Maximum delay time that can be set by echo [ms]. More...
 
#define CRIATOMEXASR_ECHO_PARAMETER_MIN_FB_GAIN   (-0.99f)
 Minimum feedback gain settable with echo.
 
#define CRIATOMEXASR_ECHO_PARAMETER_MAX_FB_GAIN   (0.99f)
 Maximum feedback gain settable with echo.
 
#define CRIATOMEXASR_MULTITAP_DELAY_NUM_TAPS   (4)
 Number of taps of multi tap delay.
 
#define CRIATOMEXASR_MULTITAP_DELAY_NUM_CHANNELS   (4)
 Number of output channels of multi-tap delay. More...
 
#define CRIATOMEXASR_MULTITAP_DELAY_PARAMETER_MAX_DELAY_TIME_MS   (10000.0f)
 Maximum delay time that can be set with multi tap delay [ms]. More...
 
#define CRIATOMEXASR_MULTITAP_DELAY_NUM_PARAMETER_PAR_TAP   (4)
 Number of parameters per tap of multi-tap delay.
 
#define CRIATOMEXASR_MULTITAP_DELAY_PARAMETER_MAX_SUM_FEEDBACK_GAIN   (0.90f)
 The upper limit value of feedback total amount of multitap delay. More...
 
#define CRIATOMEXASR_MULTITAP_DELAY_NUM_PARAMETERS    (CRIATOMEXASR_MULTITAP_DELAY_NUM_PARAMETER_PAR_TAP * CRIATOMEXASR_MULTITAP_DELAY_NUM_TAPS)
 Number of multi-tap delay parameters.
 
#define CRIATOMEXASR_MULTITAP_DELAY_PARAMETER_DELAY_TIME_MS(i_tap)    (0 + (i_tap) * CRIATOMEXASR_MULTITAP_DELAY_NUM_PARAMETER_PAR_TAP)
 Delay time [ms]. More...
 
#define CRIATOMEXASR_MULTITAP_DELAY_PARAMETER_LEVEL(i_tap)    (1 + (i_tap) * CRIATOMEXASR_MULTITAP_DELAY_NUM_PARAMETER_PAR_TAP)
 Output level [amplitude]. More...
 
#define CRIATOMEXASR_MULTITAP_DELAY_PARAMETER_AZIMUTH(i_tap)    (2 + (i_tap) * CRIATOMEXASR_MULTITAP_DELAY_NUM_PARAMETER_PAR_TAP)
 Direction (pan) angle [degree]. More...
 
#define CRIATOMEXASR_MULTITAP_DELAY_PARAMETER_FEEDBACK(i_tap)    (3 + (i_tap) * CRIATOMEXASR_MULTITAP_DELAY_NUM_PARAMETER_PAR_TAP)
 Feedback gain. More...
 

Detailed Description

Delay / Echo / Definition of parameters to be set with multi tap delay.

See also
criAtomExAsrRack_SetEffectParameter, criAtomExAsrRack_GetEffectParameter

Macro Definition Documentation

◆ CRIATOMEXASR_DELAY_PARAMETER_DELAY_TIME_MS

#define CRIATOMEXASR_DELAY_PARAMETER_DELAY_TIME_MS   (0)

Delay time [ms].

Description:
Specify the delay time of the delay in this parameter index.
It is initialized with half the maximum delay time. The minimum value of the parameter is 50.0 f, and the maximum value is 1000.0 f.

◆ CRIATOMEXASR_DELAY_PARAMETER_MAX_DELAY_TIME_MS

#define CRIATOMEXASR_DELAY_PARAMETER_MAX_DELAY_TIME_MS   (1000.0f)

Maximum delay time that can be set with delay [ms].

Attention
Even if you set it to be equal to or greater than the configured value, this value is prioritized and restricted.

◆ CRIATOMEXASR_ECHO_PARAMETER_DELAY_TIME_MS

#define CRIATOMEXASR_ECHO_PARAMETER_DELAY_TIME_MS   (0)

Delay time [ms].

Description:
Specify the echo delay time in this parameter index.

◆ CRIATOMEXASR_ECHO_PARAMETER_FB_GAIN

#define CRIATOMEXASR_ECHO_PARAMETER_FB_GAIN   (1)

Feedback gain.

Description:
Specify the echo feedback gain in this parameter index.
Please note that the echo sound due to the large feedback gain does not stop even if playback is stopped.Although the maximum value of the absolute value of the feedback gain is 1.0 f, internally it is truncated to 0.99 f,so there is no danger of sustained oscillation (no echo disappearing).
Description:
The initial value of the parameter is 0.0 f, the minimum value is -0.99 f, and the maximum value is 0.99 f.Due to the above limitation, attenuation will occur even if 1.0 f is set.

◆ CRIATOMEXASR_ECHO_PARAMETER_MAX_DELAY_TIME_MS

#define CRIATOMEXASR_ECHO_PARAMETER_MAX_DELAY_TIME_MS   (1000.0f)

Maximum delay time that can be set by echo [ms].

Attention
This value is preferentially limited over the maximum delay time set in the configuration.

◆ CRIATOMEXASR_MULTITAP_DELAY_NUM_CHANNELS

#define CRIATOMEXASR_MULTITAP_DELAY_NUM_CHANNELS   (4)

Number of output channels of multi-tap delay.

Description:
Normally, it is set to 4 channels (L, R, Surround L, Surround R).

◆ CRIATOMEXASR_MULTITAP_DELAY_PARAMETER_MAX_DELAY_TIME_MS

#define CRIATOMEXASR_MULTITAP_DELAY_PARAMETER_MAX_DELAY_TIME_MS   (10000.0f)

Maximum delay time that can be set with multi tap delay [ms].

Attention
Even if you set it above this value in the configuration, this value will be preferentially restricted.

◆ CRIATOMEXASR_MULTITAP_DELAY_PARAMETER_MAX_SUM_FEEDBACK_GAIN

#define CRIATOMEXASR_MULTITAP_DELAY_PARAMETER_MAX_SUM_FEEDBACK_GAIN   (0.90f)

The upper limit value of feedback total amount of multitap delay.

Description:
Since multi-tap delay feeds back at each tap, the output may diverge in some cases.Avoid divergence as much as possible by using the feedback total upper limit value of all taps.
Attention
Even if this upper limit value is used, output may diverge.

◆ CRIATOMEXASR_MULTITAP_DELAY_PARAMETER_DELAY_TIME_MS

#define CRIATOMEXASR_MULTITAP_DELAY_PARAMETER_DELAY_TIME_MS (   i_tap)     (0 + (i_tap) * CRIATOMEXASR_MULTITAP_DELAY_NUM_PARAMETER_PAR_TAP)

Delay time [ms].

Parameters
[in]i_tapIndex of tap to be set
Description:
In this parameter index, specify the delay time of each tap of the multi tap delay.
The initial value of the parameter is limited to half the maximum delay time, the maximum value is 10000.0 f,and the minimum value is limited to 20.0 f, 40.0 f, 60.0 f, and 80.0 f with 4 taps 1, 2, 3, and 4 respectively.

◆ CRIATOMEXASR_MULTITAP_DELAY_PARAMETER_LEVEL

#define CRIATOMEXASR_MULTITAP_DELAY_PARAMETER_LEVEL (   i_tap)     (1 + (i_tap) * CRIATOMEXASR_MULTITAP_DELAY_NUM_PARAMETER_PAR_TAP)

Output level [amplitude].

Parameters
[in]i_tapIndex of tap to be set
Description:
In this parameter index, specify the output level of each tap of the multi tap delay.
The initial value of the parameter is 0.0 f, the minimum value is 0.0 f, and the maximum value is 1.0 f.

◆ CRIATOMEXASR_MULTITAP_DELAY_PARAMETER_AZIMUTH

#define CRIATOMEXASR_MULTITAP_DELAY_PARAMETER_AZIMUTH (   i_tap)     (2 + (i_tap) * CRIATOMEXASR_MULTITAP_DELAY_NUM_PARAMETER_PAR_TAP)

Direction (pan) angle [degree].

Parameters
[in]i_tapIndex of tap to be set
Description:
In this parameter index, specify the horizontal angle of each tap of the multi tap delay.
By specifying this angle, you can express delayed sound with spreading in the horizontal direction.
The initial parameter value is 0.0 f, the minimum value is -180.0 f, and the maximum value is 180 f.

◆ CRIATOMEXASR_MULTITAP_DELAY_PARAMETER_FEEDBACK

#define CRIATOMEXASR_MULTITAP_DELAY_PARAMETER_FEEDBACK (   i_tap)     (3 + (i_tap) * CRIATOMEXASR_MULTITAP_DELAY_NUM_PARAMETER_PAR_TAP)

Feedback gain.

Parameters
[in]i_tapIndex of tap to be set
Description:
In this parameter index, specify feedback gain of multi tap delay.
Attention
When the feedback gain is too large, the output diverges.
The initial value of the parameter is 0.0 f, the minimum value is 0.0 f, and the maximum value is 1.0 f at each tap, but the total of all the taps is limited to 0.90 f.