nn::snd::CTR::DspFxReverb::Param Structure

Syntax

struct Param
{
   u32 m_EarlyReflectionTime;
   u32 m_FusedTime;
   u32 m_PreDelayTime;
   f32 m_Coloration;
   f32 m_Damping;
   FilterSize * m_pFilterSize;
   f32 m_EarlyGain;
   f32 m_FusedGain;
   bool m_UseHpfDamping;
};

Description

The structure for reverb parameters.

Reverb can be broadly thought of in terms of an initial reflection and a back-end reverberation.

The initial reflection can be adjusted with m_EarlyReflectionTime and m_EarlyGain.

m_EarlyReflectionTime represents the time for the initial reflection to return. The larger its value, the longer it takes for the sound to be reflected and return. The units are in milliseconds and must be set in multiples of 5, at a value of 5 or larger. The initial value is set to 60.

m_EarlyGain represents the initial reflection's output gain. Configure a value between 0.0f and 1.0f. When you set it to 0.0f, you do not hear the initial reflection. The initial value is set to 0.6f.

The back-end reverberation can be adjusted with m_FusedTime, m_FusedGain, m_PreDelayTime, m_Coloration, m_Damping, and m_pFilterSize.

m_FusedTime represents how long the back-end reverberation continues to sound. The larger this value is, the easier it is to express the space as one in which echoes occur. The units are in milliseconds and the initial value is set to 4,000.

m_FusedGain represents the back-end reverberation's output gain. Configure a value between 0.0f and 1.0f. When you set it to 0.0f, you do not hear the back-end reverberation. The initial value is set to 0.4f.

m_PreDelayTime represents the delay time placed before the back-end reverberation. The larger this value is, the greater the delay before the back-end reverberation is heard. The units are in milliseconds and must be set in multiples of 5, at a value of 5 or larger. The initial value is 100.

m_Coloration represents the coefficient for the back-end reverberation's all-pass filter. The larger this value, the more detailed the back-end reverberation, and the more complex the reverberation becomes. Configure a value between 0.0f and 1.0f. When set to 0.0f the all-pass filter is completely open. The initial value is 0.5f.

m_Damping represents the effect of the filter on the back-end reverberation. As the filter type, you can select either low-pass or high-pass (specified by m_UseHpfDamping). Configure a value between 0.0f and 1.0f. If using the low-pass filter, the larger the value for m_Damping, the lower the cutoff frequency. (If set to 0.0f the low-pass filter is not applied.) If using the high-pass filter, the larger the value for m_Damping, the higher the cutoff frequency. (If set to 0.0f the high-pass filter is not applied and the phase is reversed.) The default value for m_Damping is 0.4f. The default value for m_UseHpfDamping is false (low-pass).

For more information on the member variables of m_pFilterSize, see the description of nn::snd::CTR::DspFxReverb::FilterSize.

The required memory size that you can get with the nn::snd::CTR::DspFxReverb::GetRequiredMemorySize function depends on the following.

  

Noise may occur if you change the following values while an effect is running.

In addition, if you continually change the following values even while an effect is executing, noise will not occur.

Call the nn::snd::CTR::DspFxReverb::SetParam function to change parameters while an effect is running.

Member Variables

m_EarlyReflectionTime u32 The initial reflection time (in milliseconds). It must be a multiple of 5 that is no less than 5.
m_FusedTime u32 The attenuation time (in milliseconds) of the back-end reverberation.
m_PreDelayTime u32 The pre-delay time (in milliseconds). It must be a multiple of 5 that is no less than 5.
m_Coloration f32 A coefficient for the all-pass filter. Specify a value between 0.0f and 1.0f.
m_Damping f32 The effect of the back-end reverberation filter. Specify a value between 0.0f and 1.0f.
m_pFilterSize FilterSize * The filter size. The default value is set if NULL is specified.
m_EarlyGain f32 Output gain for the initial reflection. Specify a value between 0.0f and 1.0f.
m_FusedGain f32 Output gain for the back-end reverberation. Specify a value between 0.0f and 1.0f.
m_UseHpfDamping bool Flag for whether to use the high-pass filter as the filter for back-end reverberation.

Member Functions

Param Constructor.

Revision History

2012/02/27
Revised and added content about m_Damping and m_UseHpfDamping.
2011/10/04
Initial version.

CONFIDENTIAL