1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 5 <meta http-equiv="Content-Style-Type" content="text/css" /> 6 <link rel="stylesheet" href="../../../../../css/manpage.css" type="text/css" /> 7 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 22 span.virtual_style 23 { 24 font-size : 8pt; 25 color : white; 26 font-weight : bold; 27 background : #0a0; 28 border-left : solid 1px #0f0; 29 border-top : solid 1px #0f0; 30 border-right : solid 1px #060; 31 border-bottom : solid 1px #060; 32 padding-left : 2px; 33 padding-right : 2px; 34 } 35 36 span.protected_style 37 { 38 font-size : 8pt; 39 color : white; 40 font-weight : bold; 41 background : #444; 42 border-left : solid 1px #ccc; 43 border-top : solid 1px #ccc; 44 border-right : solid 1px #222; 45 border-bottom : solid 1px #222; 46 padding-left : 2px; 47 padding-right : 2px; 48 } 49 --></style> 50<title>nn::snd::CTR::DspFxReverb::Param</title> 51 </head> 52 <body> 53<h1><CODE><a href="../../../../../nn/Overview.html">nn</a>::<a href="../../../../../nn/snd/Overview.html">snd</a>::<a href="../../../../../nn/snd/CTR/Overview.html">CTR</a>::<a href="../../../../../nn/snd/CTR/DspFxReverb/Overview.html">DspFxReverb</a>::Param</CODE> Structure</h1> 54<h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">struct Param 57{ 58 <a href="../../../../../nn_types/u32.html">u32</a> m_EarlyReflectionTime; 59 <a href="../../../../../nn_types/u32.html">u32</a> m_FusedTime; 60 <a href="../../../../../nn_types/u32.html">u32</a> m_PreDelayTime; 61 <a href="../../../../../nn_types/f32.html">f32</a> m_Coloration; 62 <a href="../../../../../nn_types/f32.html">f32</a> m_Damping; 63 <a href="../../../../../nn/snd/CTR/DspFxReverb/FilterSize/Overview.html">FilterSize</a> * m_pFilterSize; 64 <a href="../../../../../nn_types/f32.html">f32</a> m_EarlyGain; 65 <a href="../../../../../nn_types/f32.html">f32</a> m_FusedGain; 66 bool m_UseHpfDamping; 67}; 68</pre> 69 </div> 70<h2>Description</h2> 71 <div class="section"> 72<p>The structure for reverb parameters.</p><p> 73Reverb can be broadly thought of in terms of an initial reflection and a back-end reverberation. 74 </p><p> 75The initial reflection can be adjusted with <CODE>m_EarlyReflectionTime</CODE> and <CODE>m_EarlyGain</CODE>. 76 </p><p> 77<CODE>m_EarlyReflectionTime</CODE> 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 <CODE>60</CODE>. 78 </p><p> 79<CODE>m_EarlyGain</CODE> represents the initial reflection's output gain. Configure a value between <CODE>0.0f</CODE> and <CODE>1.0f</CODE>. When you set it to <CODE>0.0f</CODE>, you do not hear the initial reflection. The initial value is set to <CODE>0.6f</CODE>. 80 </p><p> 81The back-end reverberation can be adjusted with <CODE>m_FusedTime</CODE>, <CODE>m_FusedGain</CODE>, <CODE>m_PreDelayTime</CODE>, <CODE>m_Coloration</CODE>, <CODE>m_Damping</CODE>, and <CODE>m_pFilterSize</CODE>. 82 </p><p> 83<CODE>m_FusedTime</CODE> 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 <CODE>4,000</CODE>. 84 </p><p> 85<CODE>m_FusedGain</CODE> represents the back-end reverberation's output gain. Configure a value between <CODE>0.0f</CODE> and <CODE>1.0f</CODE>. When you set it to <CODE>0.0f</CODE>, you do not hear the back-end reverberation. The initial value is set to <CODE>0.4f</CODE>. 86 </p><p> 87<CODE>m_PreDelayTime</CODE> 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 <CODE>100</CODE>. 88 </p><p> 89<CODE>m_Coloration</CODE> 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 <CODE>0.0f</CODE> and <CODE>1.0f</CODE>. When set to <CODE>0.0f</CODE> the all-pass filter is completely open. The initial value is <CODE>0.5f</CODE>. 90 </p><p> 91<SPAN class="argument">m_Damping</SPAN> 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 <SPAN class="argument">m_UseHpfDamping</SPAN>). Configure a value between <CODE>0.0f</CODE> and <CODE>1.0f</CODE>. If using the low-pass filter, the larger the value for <SPAN class="argument">m_Damping</SPAN>, the lower the cutoff frequency. (If set to <CODE>0.0f</CODE> the low-pass filter is not applied.) If using the high-pass filter, the larger the value for <SPAN class="argument">m_Damping</SPAN>, the higher the cutoff frequency. (If set to <CODE>0.0f</CODE> the high-pass filter is not applied and the phase is reversed.) The default value for <SPAN class="argument">m_Damping</SPAN> is <CODE>0.4f</CODE>. The default value for <SPAN class="argument">m_UseHpfDamping</SPAN> is <CODE>false</CODE> (low-pass). 92 </p><p> 93For more information on the member variables of <CODE>m_pFilterSize</CODE>, see the description of <a href="../../../../../nn/snd/CTR/DspFxReverb/FilterSize/Overview.html"><CODE>nn::snd::CTR::DspFxReverb::FilterSize</CODE></a>. 94</p><p>The required memory size that you can get with the <CODE><a href="../../../../../nn/snd/CTR/DspFxReverb/GetRequiredMemorySize.html">nn::snd::CTR::DspFxReverb::GetRequiredMemorySize</a></CODE> function depends on the following. 95<ul><li><CODE>m_EarlyReflectionTime</CODE></li><li><CODE>m_PreDelayTime</CODE></li><li><CODE>m_pFilterSize</CODE></li></ul> 96 97 </p><p> 98Noise may occur if you change the following values while an effect is running. 99<ul><li><CODE>m_EarlyReflectionTime</CODE></li><li><CODE>m_PreDelayTime</CODE></li></ul></p><p> 100In addition, if you continually change the following values even while an effect is executing, noise will not occur. 101<ul><li><CODE>m_FusedTime</CODE></li><li><CODE>m_Coloration</CODE></li><li><CODE>m_Damping</CODE></li><li><CODE>m_EarlyGain</CODE></li><li><CODE>m_FusedGain</CODE></li></ul></p><p> 102Call the <a href="../../../../../nn/snd/CTR/DspFxReverb/SetParam.html"><CODE>nn::snd::CTR::DspFxReverb::SetParam</CODE></a> function to change parameters while an effect is running. 103 </p></div> 104 <a name="variable" id="variable"> 105<h2>Member Variables</h2> 106 <div class="section"> 107 <table class="members"> 108 <tr> 109 <td width="100"> </td> 110 <th> 111<span class="argument"><CODE>m_EarlyReflectionTime</CODE></span> 112 </th> 113<td width="100"><a href="../../../../../nn_types/u32.html">u32</a></td> 114<td>The initial reflection time (in milliseconds). It must be a multiple of 5 that is no less than 5.</td> 115 </tr> 116 <tr> 117 <td width="100"> </td> 118 <th> 119<span class="argument"><CODE>m_FusedTime</CODE></span> 120 </th> 121<td width="100"><a href="../../../../../nn_types/u32.html">u32</a></td> 122<td>The attenuation time (in milliseconds) of the back-end reverberation.</td> 123 </tr> 124 <tr> 125 <td width="100"> </td> 126 <th> 127<span class="argument"><CODE>m_PreDelayTime</CODE></span> 128 </th> 129<td width="100"><a href="../../../../../nn_types/u32.html">u32</a></td> 130<td>The pre-delay time (in milliseconds). It must be a multiple of 5 that is no less than 5.</td> 131 </tr> 132 <tr> 133 <td width="100"> </td> 134 <th> 135<span class="argument"><CODE>m_Coloration</CODE></span> 136 </th> 137<td width="100"><a href="../../../../../nn_types/f32.html">f32</a></td> 138<td>A coefficient for the all-pass filter. Specify a value between <CODE>0.0f</CODE> and <CODE>1.0f</CODE>.</td> 139 </tr> 140 <tr> 141 <td width="100"> </td> 142 <th> 143<span class="argument"><CODE>m_Damping</CODE></span> 144 </th> 145<td width="100"><a href="../../../../../nn_types/f32.html">f32</a></td> 146<td>The effect of the back-end reverberation filter. Specify a value between <CODE>0.0f</CODE> and <CODE>1.0f</CODE>.</td> 147 </tr> 148 <tr> 149 <td width="100"> </td> 150 <th> 151<span class="argument"><CODE>m_pFilterSize</CODE></span> 152 </th> 153<td width="100"><a href="../../../../../nn/snd/CTR/DspFxReverb/FilterSize/Overview.html">FilterSize</a> *</td> 154<td>The filter size. The default value is set if <CODE>NULL</CODE> is specified.</td> 155 </tr> 156 <tr> 157 <td width="100"> </td> 158 <th> 159<span class="argument"><CODE>m_EarlyGain</CODE></span> 160 </th> 161<td width="100"><a href="../../../../../nn_types/f32.html">f32</a></td> 162<td>Output gain for the initial reflection. Specify a value between <CODE>0.0f</CODE> and <CODE>1.0f</CODE>.</td> 163 </tr> 164 <tr> 165 <td width="100"> </td> 166 <th> 167<span class="argument"><CODE>m_FusedGain</CODE></span> 168 </th> 169<td width="100"><a href="../../../../../nn_types/f32.html">f32</a></td> 170<td>Output gain for the back-end reverberation. Specify a value between <CODE>0.0f</CODE> and <CODE>1.0f</CODE>.</td> 171 </tr> 172 <tr> 173 <td width="100"> </td> 174 <th> 175<span class="argument">m_UseHpfDamping</span> 176 </th> 177<td width="100">bool</td> 178<td>Flag for whether to use the high-pass filter as the filter for back-end reverberation.</td> 179 </tr> </table> 180 </div> 181 </a> <a name="function" id="function"> 182<h2>Member Functions</h2> 183 <div class="section"> 184 <table class="members"> 185 <tr> 186 <td width="100"> </td> 187 <th> 188<a href="../../../../../nn/snd/CTR/DspFxReverb/Param/Param.html"><CODE>Param</CODE></a> 189 </th> 190<td>Constructor.</td> 191 </tr> </table> 192 </div> 193 </a> 194<h2>Revision History</h2> 195 <div class="section"> 196 <dl class="history"> 197 <dt>2012/02/27</dt> 198<dd>Revised and added content about <CODE>m_Damping</CODE> and <CODE>m_UseHpfDamping</CODE>.<br /> 199 </dd> 200 <dt>2011/10/04</dt> 201<dd>Initial version.<br /> 202 </dd> 203 </dl> 204 </div> 205 <hr><p>CONFIDENTIAL</p></body> 206</html>