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::FxReverb::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/FxReverb/Overview.html">FxReverb</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/FxReverb/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>Reverb can be broadly thought of in terms of an initial reflection and a back-end reverberation.</p><p>The initial reflection can be adjusted with <CODE>m_EarlyReflectionTime</CODE> and <CODE>m_EarlyGain</CODE>.</p><p><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 60.</p><p><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 0.0f, you will no longer hear the initial reflection. The initial value is set to 0.6f.</p><p>The 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>.</p><p><CODE>m_FusedTime</CODE> represents how long the back-end reverberation will continue 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 4000.</p><p><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 0.0f, you will no longer hear the back-end reverberation. The initial value is set to 0.4f.</p><p><CODE>m_PreDelayTime</CODE> represents the delay time placed before the back-end reverberation. The larger this value is, the greater the delay before we hear the back-end reverberation. 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.</p><p><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 will become. Configure a value between <CODE>0.0f</CODE> and <CODE>1.0f</CODE>. When set to 0.0f the all-pass filter will be completely open. This value is initially 0.5f.</p><p><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 a low-pass filter or high-pass filter (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).</p><p>See the description of <CODE><A>FilterSize</A></CODE> for more on the member variables of <CODE>m_pFilterSize</CODE>.</p><p>The necessary memory that you can get with the <CODE><a href="../../../../../nn/snd/CTR/FxReverb/GetRequiredMemSize.html">GetRequiredMemSize</a></CODE> function is dependent on <CODE>m_EarlyReflectionTime</CODE>, <CODE>m_PreDelayTime</CODE> and <CODE>m_pFilterSize</CODE>.</p><p>Changing the following values while an effect is executing can cause noise. ・<CODE>m_EarlyReflectionTime</CODE> <br /> ・<CODE>m_PreDelayTime</CODE></p><p>Continually changing the following values while an effect is executing can cause noise. ・<CODE>m_FusedTime</CODE> <br /> ・<CODE>m_Coloration</CODE> <br /> ・<CODE>m_Damping</CODE> <br /> ・<CODE>m_EarlyGain</CODE> <br /> ・<CODE>m_FusedGain</CODE></p> 73<p>To change a parameter while an effect is executing, call the <CODE><a href="../../../../../nn/snd/CTR/FxDelay/SetParam.html">SetParam</a></CODE> function.</p><!-- write here --></div> 74 <a name="variable" id="variable"> 75<h2>Member Variables</h2> 76 <div class="section"> 77 <table class="members"> 78 <tr> 79 <td width="100"> </td> 80 <th> 81<span class="argument"><CODE>m_EarlyReflectionTime</CODE></span> 82 </th> 83<td width="100"><a href="../../../../../nn_types/u32.html">u32</a></td> 84<td>The initial reflection time (in msec).</td> 85 </tr> 86 <tr> 87 <td width="100"> </td> 88 <th> 89<span class="argument"><CODE>m_FusedTime</CODE></span> 90 </th> 91<td width="100"><a href="../../../../../nn_types/u32.html">u32</a></td> 92<td>The attenuation time (in msec) of the back-end reverberation.</td> 93 </tr> 94 <tr> 95 <td width="100"> </td> 96 <th> 97<span class="argument"><CODE>m_PreDelayTime</CODE></span> 98 </th> 99<td width="100"><a href="../../../../../nn_types/u32.html">u32</a></td> 100<td>The pre-delay time (in msec) of the back-end reverberation.</td> 101 </tr> 102 <tr> 103 <td width="100"> </td> 104 <th> 105<span class="argument"><CODE>m_Coloration</CODE></span> 106 </th> 107<td width="100"><a href="../../../../../nn_types/f32.html">f32</a></td> 108<td>The coefficient of the all-pass filter for the back-end reverberation.</td> 109 </tr> 110 <tr> 111 <td width="100"> </td> 112 <th> 113<span class="argument"><CODE>m_Damping</CODE></span> 114 </th> 115<td width="100"><a href="../../../../../nn_types/f32.html">f32</a></td> 116<td>The effect of the filter on the back-end reverberation.</td> 117 </tr> 118 <tr> 119 <td width="100"> </td> 120 <th> 121<span class="argument"><CODE>m_pFilterSize</CODE></span> 122 </th> 123<td width="100"><a href="../../../../../nn/snd/CTR/FxReverb/FilterSize/Overview.html">FilterSize</a> *</td> 124<td>The filter size. If you specify NULL, the default value of the <CODE>FilterSize</CODE> structure is set.</td> 125 </tr> 126 <tr> 127 <td width="100"> </td> 128 <th> 129<span class="argument"><CODE>m_EarlyGain</CODE></span> 130 </th> 131<td width="100"><a href="../../../../../nn_types/f32.html">f32</a></td> 132<td>Output gain for the initial reflection.</td> 133 </tr> 134 <tr> 135 <td width="100"> </td> 136 <th> 137<span class="argument"><CODE>m_FusedGain</CODE></span> 138 </th> 139<td width="100"><a href="../../../../../nn_types/f32.html">f32</a></td> 140<td>Output gain for the back-end reverberation.</td> 141 </tr> 142 <tr> 143 <td width="100"> </td> 144 <th> 145<span class="argument">m_UseHpfDamping</span> 146 </th> 147<td width="100">bool</td> 148<td>Flag for whether to use the high-pass filter as the filter for back-end reverberation.</td> 149 </tr> </table> 150 </div> 151 </a> <a name="function" id="function"> 152<h2>Member Functions</h2> 153 <div class="section"> 154 <table class="members"> 155 <tr> 156 <td width="100"> </td> 157 <th> 158<a href="../../../../../nn/snd/CTR/FxReverb/Param/Param.html"><CODE>Param</CODE></a> 159 </th> 160<td>Constructor.</td> 161 </tr> </table> 162 </div> 163 </a> 164<h2>Revision History</h2> 165 <div class="section"> 166 <dl class="history"> 167 <dt>2010/11/10</dt> 168<dd>Initial version.<br /> 169 </dd> 170 </dl> 171 </div> 172 <hr><p>CONFIDENTIAL</p></body> 173</html>