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>nw::snd::FxReverb::Param</title> 51 </head> 52 <body> 53 <h1>nw::snd::FxReverb::Param Structure</h1> 54 <div class="section"> 55 <b>Header file: </b>nw/snd/snd_FxReverb.h</div> 56 <h2>Syntax</h2> 57 <div class="section"> 58 <pre class="definition">struct Param 59{ 60 <span>u32</span> m_EarlyReflectionTime; 61 <span>u32</span> m_FusedTime; 62 <span>u32</span> m_PreDelayTime; 63 <span>f32</span> m_Coloration; 64 <span>f32</span> m_Damping; 65 <a href="../../../../nw/snd/FxReverb/FilterSize/Overview.html">FilterSize</a> * m_pFilterSize; 66 <span>f32</span> m_EarlyGain; 67 <span>f32</span> m_FusedGain; 68 bool m_IsEnableSurround; 69}; 70</pre> 71 </div> 72 <h2>Description</h2> 73 <div class="section"> 74 <p>The data structure for reverb parameters.</p><p>Reverb can be divided into two large groups: "early reflection" and "subsequent reverb sounds."</p><p>"Early reflection" can be adjusted with m_EarlyReflectionTime and m_EarlyGain.</p><p>m_EarlyReflectionTime signifies the time until the early reflection returns. Larger values indicate longer times from when the sound reflects until it returns. Units are in msec and must be larger than 5 set in multiples of 5. The initial value is set to 60.</p><p>m_EarlyGain signifies the output gain for early reflection. Set a value from 0.0.f to 1.0.f. When set to 0.0f, the early reflection cannot be heard. The initial value is set to 0.6f.</p><p>"Subsequent reverb sound" can be adjusted with m_FusedTime, m_FusedGain, m_PreDelayTime, m_Coloration, m_Damping, and m_pFilterSize.</p><p>m_FusedTime signifies the time that the subsequent reverb sound continues to play. Larger values can express spaces where sounds are easily reflected. Units are in msec, and the initial value is set to 4000.</p><p>m_FusedGain signifies the output gain for subsequent reverb sound. Set a value from 0.0.f to 1.0.f. When set to 0.0f, the subsequent reverb sound cannot be heard. The initial value is set to 0.4f.</p><p>m_PreDelayTime is the lag time before the subsequent reverb sound. Larger values cause the subsequent reverb sound to be heard later. Units are in msec and must be larger than 5 set in multiples of 5. The initial value is 100.</p><p>m_Coloration signifies the coefficient for the full band pass filter of the subsequent reverb sound. Large values make the subsequent reverb sound more detailed and mix in more complex echoes. Set a value from 0.0.f to 1.0.f. When set to 0.0f, the full band pass filter is passed through. The initial value is 0.5.0f.</p><p>m_Damping indicates how the low-pass filter (LPF) is applied to subsequent reverb sound. Set a value from 0.0.f to 1.0.f. The greater this value is made to be, the lower the cutoff frequency. Setting 0.0f results in the LPF not being applied at all. The initial value is 0.4.0f.</p><p>See the <a href="../../../../nw/snd/FxReverb/FilterSize/Overview.html">FilterSize</a> description regarding each member variable of m_pFilterSize.</p><p>m_IsEnableSurround signifies whether the reverb process will enable the sound channel. When true, surround components (rear L and R channels) also undergo reverb processing. If false, reverb processing of surround components is skipped. The process load can be reduced by the corresponding amount by setting false. The initial value is <CODE>false</CODE>.</p><p>The required memory size obtained by <a href="../../../../nw/snd/FxReverb/GetRequiredMemSize.html">GetRequiredMemSize</a> depends on:<br /> ・m_EarlyReflectionTime <br /> ・m_PreDelayTime <br /> ・m_pFilterSize <br /> ・m_IsEnableSurround <br /></p><p>If following values are changed while an effect is executing, noise may be generated.<br /> ・m_EarlyReflectionTime <br /> ・m_PreDelayTime</p><p>Also, if the following values are changed "continuously", no noise is generated even if an effect is being executed.<br /> ・m_FusedTime <br /> ・m_Coloration <br /> ・m_Damping <br /> ・m_EarlyGain <br /> ・m_FusedGain</p><p>Call <a href="../../../../nw/snd/FxReverb/SetParam.html">SetParam</a> to change parameters while an effect is being executed.</p></div> 75 <a name="variable" id="variable"> 76 <h2>Member Variables</h2> 77 <div class="section"> 78 <table class="members"> 79 <tr> 80 <td width="100"> </td> 81 <th> 82 <span class="argument">m_EarlyReflectionTime</span> 83 </th> 84 <td>Early reflection time (msec).</td> 85 </tr> 86 <tr> 87 <td width="100"> </td> 88 <th> 89 <span class="argument">m_FusedTime</span> 90 </th> 91 <td>Attenuation time (msec) for subsequent reverb sounds.</td> 92 </tr> 93 <tr> 94 <td width="100"> </td> 95 <th> 96 <span class="argument">m_PreDelayTime</span> 97 </th> 98 <td>Subsequent reverb sound pre-delay time (msec).</td> 99 </tr> 100 <tr> 101 <td width="100"> </td> 102 <th> 103 <span class="argument">m_Coloration</span> 104 </th> 105 <td>Coefficient for the full band pass filter for subsequent reverb sound.</td> 106 </tr> 107 <tr> 108 <td width="100"> </td> 109 <th> 110 <span class="argument">m_Damping</span> 111 </th> 112 <td>Low-pass filter damping for subsequent reverb sound.</td> 113 </tr> 114 <tr> 115 <td width="100"> </td> 116 <th> 117 <span class="argument">m_pFilterSize</span> 118 </th> 119 <td>Filter size. The default values of the FilterSize structure are set if NULL is specified.</td> 120 </tr> 121 <tr> 122 <td width="100"> </td> 123 <th> 124 <span class="argument">m_EarlyGain</span> 125 </th> 126 <td>Output gain for early reflection.</td> 127 </tr> 128 <tr> 129 <td width="100"> </td> 130 <th> 131 <span class="argument">m_FusedGain</span> 132 </th> 133 <td>Output gain for subsequent reverb sound.</td> 134 </tr> 135 <tr> 136 <td width="100"> </td> 137 <th> 138 <span class="argument">m_IsEnableSurround</span> 139 </th> 140 <td>Flag indicating whether to enable reverb processing for surround channels.</td> 141 </tr> </table> 142 </div> 143 </a> <a name="function" id="function"> 144 <h2>Member Functions</h2> 145 <div class="section"> 146 <table class="members"> 147 <tr> 148 <td width="100"> </td> 149 <th> 150 <a href="../../../../nw/snd/FxReverb/Param/Param.html">Param</a> 151 </th> 152 <td>Constructor.</td> 153 </tr> </table> 154 </div> 155 </a> 156 <h2>Revision History</h2> 157 <div class="section"> 158 <dl class="history"> 159 <dt>2010/10/14</dt> 160 <dd>Added to the description for each variable<br /> 161 </dd> 162 <dt>2010/09/30</dt> 163 <dd>Added information about initial values and the required memory size.<BR> 164 </dd> 165 <dt>2010/07/22</dt> 166 <dd>Added m_IsEnableSurround<br /> 167 </dd> 168 <dt>2010/07/07</dt> 169 <dd>Clarified that the unit of m_PreDelayTime is msec<br /> 170 </dd> 171 <dt>2010/06/17</dt> 172 <dd>Initial version.<br /> 173 </dd> 174 </dl> 175 </div> 176 <hr><p>CONFIDENTIAL</p></body> 177</html>