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::SoundSystem</title> 51 </head> 52 <body> 53 <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/snd/Overview.html">snd</a>::SoundSystem</CODE> Class</h1> 54 <div class="section"> 55 <b>Header file: </b>nw/snd/snd_SoundSystem.h</div> 56 <h2>Syntax</h2> 57 <div class="section"> 58 <pre class="definition">class SoundSystem</pre> 59 </div> 60 <h2>Description</h2> 61 <div class="section"> 62 <p>Configures settings related to the overall sound system.</p><p><br /></p><p>[Effect Processing Overview]</p><p>Effects can be registered and cleared with the <a href="../../../nw/snd/SoundSystem/AppendEffect.html">AppendEffect</a> and <a href="../../../nw/snd/SoundSystem/ClearEffect.html">ClearEffect</a> functions.</p><p>Effects are either effects provided by NW4C (<a href="../../../nw/snd/FxBase/Overview.html">nw::snd::FxBase</a>, <a href="../../../nw/snd/FxDelay/Overview.html">nw::snd::FxDelay</a>, and <a href="../../../nw/snd/FxReverb/Overview.html">nw::snd::FxReverb</a>) or effects provided by CTR_SDK (nn::snd::FxDelay and nn::snd::FxReverb). Either can be registered with the <a href="../../../nw/snd/SoundSystem/AppendEffect.html">AppendEffect</a> function.</p><p>Be sure to execute effects provided by NW4C with the application core. Whereas there is the demerit of putting a load on the application core, multiple effects can be set in a single AUX bus and the user can execute effects that are implemented by inheriting <a href="../../../nw/snd/FxBase/Overview.html">FxBase</a>.</p><p>Effects provided by the SDK are executed by the system core when the sound thread is operated by the system core. Whereas the load for effect processing is assumed by the system core, only nnsnd::FxDelay or nn::snd::FxReverb, but not both, can be set for a single AUX bus. Further, because nnsnd::FxReverb suppresses the processing volume of the system core, reverb processing on only the front 2 ch is possible. (Refer to the CTR_SDK nn::snd::FxReverb class in the Reference Manual for details.) Unlike effects provided by NW4C, the user cannot executed effects implemented by the user. Also, if the sound thread is run by the application core, the effects provided by the SDK are also run by the application core.</p><p>Effects provided by NW4C and effects provided by the SDK can be individually registered in each AUX bus. For example, it is possible to registered "NW4C FxDelay," "NW4C effect implemented by the user," and "SDK FxReverb" in AUX_BUS_A and "NW4C FxReverb" and "SDK FxDelay" in AUX_BUS_B.</p><p>Also, effect processing is performed in the order of "NW4C provided effects" -> "SDK provided effects."</p></div> 63 <a name="class" id="class"> 64 <h2>Classes</h2> 65 <div class="section"> 66 <table class="members"> 67 <tr> 68 <th> 69 <a href="../../../nw/snd/SoundSystem/SoundThreadScopedLock/Overview.html">nw::snd::SoundSystem::SoundThreadScopedLock</a> 70 </th> 71 <td>Locks a sound thread starting when an object is created, and continues locking it until the the object goes out of scope.</td> 72 </tr> </table> 73 </div> 74 </a> <a name="struct" id="struct"> 75 <h2>Structures</h2> 76 <div class="section"> 77 <table class="members"> 78 <tr> 79 <th> 80 <a href="../../../nw/snd/SoundSystem/SoundSystemParam/Overview.html"><CODE>nw::snd::SoundSystem::SoundSystemParam</CODE></a> 81 </th> 82 <td>Structure used to initialize the sound system.</td> 83 </tr> </table> 84 </div> 85 </a> <a name="constant" id="constant"> 86 <h2>Member Constants</h2> 87 <div class="section"> 88 <table class="members"> 89 <tr> 90 <th class="category" colspan="4">Gauging Performance</th> 91 </tr> 92 <tr> 93 <td width="100"> 94 <span class="static_style" title="static">S</span> 95 </td> 96 <th> 97 <span class="argument"><a href="../../../nw/snd/SoundSystem/SOUND_THREAD_INTERVAL_USEC.html"><CODE>SOUND_THREAD_INTERVAL_USEC</CODE></a></span> 98 </th> 99 <td width="100"><CODE>const int</CODE></td> 100 <td>The interval for sound thread operations, measured in microseconds.</td> 101 </tr> </table> 102 </div> 103 </a> <a name="function" id="function"> 104 <h2>Member Functions</h2> 105 <div class="section"> 106 <table class="members"> 107 <tr> 108 <th class="category" colspan="3">Gauging Performance</th> 109 </tr> 110 <tr> 111 <td width="100"> 112 <span class="static_style" title="static">S</span> </td> 113 <th> 114 <a href="../../../nw/snd/SoundSystem/GetSoundThreadTickCount.html"><CODE>GetSoundThreadTickCount</CODE></a> 115 </th> 116 <td>Gets the cumulative processing time of and the number of operations that occurred within the sound thread process.</td> 117 </tr> 118 <tr> 119 <td width="100"> 120 <span class="static_style" title="static">S</span> </td> 121 <th> 122 <a href="../../../nw/snd/SoundSystem/ClearSoundThreadTickCount.html"><CODE>ClearSoundThreadTickCount</CODE></a> 123 </th> 124 <td>Resets to zero the cumulative processing time of and the number of operations that occurred within the sound thread process.</td> 125 </tr> 126 <tr> 127 <th class="category" colspan="3">System</th> 128 </tr> 129 <tr> 130 <td width="100"> 131 <span class="static_style" title="static">S</span> </td> 132 <th> 133 <a href="../../../nw/snd/SoundSystem/Initialize.html"><CODE>Initialize</CODE></a> 134 </th> 135 <td>The sound library is initialized.</td> 136 </tr> 137 <tr> 138 <td width="100"> 139 <span class="static_style" title="static">S</span> </td> 140 <th> 141 <a href="../../../nw/snd/SoundSystem/GetRequiredMemSize.html">GetRequiredMemSize</a> 142 </th> 143 <td>Gets the memory size required to initialize the sound library.</td> 144 </tr> 145 <tr> 146 <td width="100"> 147 <span class="static_style" title="static">S</span> </td> 148 <th> 149 <a href="../../../nw/snd/SoundSystem/Finalize.html">Finalize</a> 150 </th> 151 <td>Shuts down the sound system.</td> 152 </tr> 153 <tr> 154 <td width="100"> 155 <span class="static_style" title="static">S</span> </td> 156 <th> 157 <a href="../../../nw/snd/SoundSystem/SetSoundFrameUserCallback.html">SetSoundFrameUserCallback</a> 158 </th> 159 <td>Sets the callback function called from the sound frame process.</td> 160 </tr> 161 <tr> 162 <td width="100"> 163 <span class="static_style" title="static">S</span> </td> 164 <th> 165 <a href="../../../nw/snd/SoundSystem/ClearSoundFrameUserCallback.html">ClearSoundFrameUserCallback</a> 166 </th> 167 <td>Clears the callback function called from the sound frame process.</td> 168 </tr> 169 <tr> 170 <td width="100"> 171 <span class="static_style" title="static">S</span> </td> 172 <th> 173 <a href="../../../nw/snd/SoundSystem/SoundFrameProcess.html">SoundFrameProcess</a> 174 </th> 175 <td>Executes the sound frame process.</td> 176 </tr> 177 <tr> 178 <td width="100"> 179 <span class="static_style" title="static">S</span> </td> 180 <th> 181 <a href="../../../nw/snd/SoundSystem/IsInitialized.html"><CODE>IsInitialized</CODE></a> 182 </th> 183 <td>Determines whether the sound system has been initialized.</td> 184 </tr> 185 <tr> 186 <td width="100"> 187 <span class="static_style" title="static">S</span> </td> 188 <th> 189 <a href="../../../nw/snd/SoundSystem/LockSoundThread.html">LockSoundThread</a> 190 </th> 191 <td>Locks sound threads.</td> 192 </tr> 193 <tr> 194 <td width="100"> 195 <span class="static_style" title="static">S</span> </td> 196 <th> 197 <a href="../../../nw/snd/SoundSystem/UnlockSoundThread.html">UnlockSoundThread</a> 198 </th> 199 <td>Unlocks sound threads.</td> 200 </tr> 201 <tr> 202 <td width="100"> 203 <span class="static_style" title="static">S</span> </td> 204 <th> 205 <a href="../../../nw/snd/SoundSystem/EnterSleep.html">EnterSleep</a> 206 </th> 207 <td>Prepares the sound library for sleep mode.</td> 208 </tr> 209 <tr> 210 <td width="100"> 211 <span class="static_style" title="static">S</span> </td> 212 <th> 213 <a href="../../../nw/snd/SoundSystem/LeaveSleep.html">LeaveSleep</a> 214 </th> 215 <td>Executes sound library processing for leaving sleep.</td> 216 </tr> 217 <tr> 218 <th class="category" colspan="3">Output Modes</th> 219 </tr> 220 <tr> 221 <td width="100"> 222 <span class="static_style" title="static">S</span> </td> 223 <th> 224 <a href="../../../nw/snd/SoundSystem/SetOutputMode.html"><CODE>SetOutputMode</CODE></a> 225 </th> 226 <td>Sets the output mode for a sound.</td> 227 </tr> 228 <tr> 229 <td width="100"> 230 <span class="static_style" title="static">S</span> </td> 231 <th> 232 <a href="../../../nw/snd/SoundSystem/GetOutputMode.html"><CODE>GetOutputMode</CODE></a> 233 </th> 234 <td>Gets the current sound output mode.</td> 235 </tr> 236 <tr> 237 <th class="category" colspan="3">Master volume</th> 238 </tr> 239 <tr> 240 <td width="100"> 241 <span class="static_style" title="static">S</span> </td> 242 <th> 243 <a href="../../../nw/snd/SoundSystem/SetMasterVolume.html"><CODE>SetMasterVolume</CODE></a> 244 </th> 245 <td>This function sets the master volume.</td> 246 </tr> 247 <tr> 248 <td width="100"> 249 <span class="static_style" title="static">S</span> </td> 250 <th> 251 <a href="../../../nw/snd/SoundSystem/GetMasterVolume.html"><CODE>GetMasterVolume</CODE></a> 252 </th> 253 <td>Gets the current master volume.</td> 254 </tr> 255 <tr> 256 <th class="category" colspan="3">Effect</th> 257 </tr> 258 <tr> 259 <td width="100"> 260 <span class="static_style" title="static">S</span> </td> 261 <th> 262 <a href="../../../nw/snd/SoundSystem/AppendEffect.html">AppendEffect</a> 263 </th> 264 <td>Adds the specified effect to the AUX bus.</td> 265 </tr> 266 <tr> 267 <td width="100"> 268 <span class="static_style" title="static">S</span> </td> 269 <th> 270 <a href="../../../nw/snd/SoundSystem/ClearEffect.html">ClearEffect</a> 271 </th> 272 <td>Deletes from the bus all effects registered to the specified AUX bus.</td> 273 </tr> 274 <tr> 275 <td width="100"> 276 <span class="static_style" title="static">S</span> </td> 277 <th> 278 <a href="../../../nw/snd/SoundSystem/IsFinishedClearEffect.html">IsFinishedClearEffect</a> 279 </th> 280 <td>Checks whether ClearEffect is completed.</td> 281 </tr> 282 <tr> 283 <th class="category" colspan="3">SRC Type</th> 284 </tr> 285 <tr> 286 <td width="100"> 287 <span class="static_style" title="static">S</span> </td> 288 <th> 289 <a href="../../../nw/snd/SoundSystem/SetSrcType.html">SetSrcType</a> 290 </th> 291 <td>Sets the SRC type (the interpolation method for the sampling rate converter).</td> 292 </tr> 293 <tr> 294 <td width="100"> 295 <span class="static_style" title="static">S</span> </td> 296 <th> 297 <a href="../../../nw/snd/SoundSystem/GetSrcType.html"><CODE>GetSrcType</CODE></a> 298 </th> 299 <td>Gets the SRC type (the interpolation method for the sampling rate converter) that is currently set.</td> 300 </tr> 301 <tr> 302 <th class="category" colspan="3">Sequence Variable Output Settings</th> 303 </tr> 304 <tr> 305 <td width="100"> 306 <span class="static_style" title="static">S</span> </td> 307 <th> 308 <a href="../../../nw/snd/SoundSystem/EnableSeqPrintVar.html"><CODE>EnableSeqPrintVar</CODE></a> 309 </th> 310 <td>Enables the <span>printvar</span> sequence command.</td> 311 </tr> 312 <tr> 313 <td width="100"> 314 <span class="static_style" title="static">S</span> </td> 315 <th> 316 <a href="../../../nw/snd/SoundSystem/DisableSeqPrintVar.html"><CODE>DisableSeqPrintVar</CODE></a> 317 </th> 318 <td>Disables the <span>printvar</span> sequence command.</td> 319 </tr> 320 <tr> 321 <td width="100"> 322 <span class="static_style" title="static">S</span> </td> 323 <th> 324 <a href="../../../nw/snd/SoundSystem/IsEnabledSeqPrintVar.html"><CODE>IsEnabledSeqPrintVar</CODE></a> 325 </th> 326 <td>Gets a value indicating whether the <span>printvar</span> sequence command is enabled.</td> 327 </tr> 328 <tr> 329 <th class="category" colspan="3">Number of voices being used</th> 330 </tr> 331 <tr> 332 <td width="100"> 333 <span class="static_style" title="static">S</span> </td> 334 <th> 335 <a href="../../../nw/snd/SoundSystem/GetVoiceCount.html"><CODE>GetVoiceCount</CODE></a> 336 </th> 337 <td>Gets the number of voices that are currently being played by the sound library.</td> 338 </tr> 339 <tr> 340 <td width="100"> 341 <span class="static_style" title="static">S</span> </td> 342 <th> 343 <a href="../../../nw/snd/SoundSystem/GetMaxVoiceCount.html"><CODE>GetMaxVoiceCount</CODE></a> 344 </th> 345 <td>Gets the maximum number of voices that can be used with the sound library.</td> 346 </tr> 347 <tr> 348 <td width="100"> 349 <span class="static_style" title="static">S</span> </td> 350 <th> 351 <a href="../../../nw/snd/SoundSystem/SetMaxVoiceCount.html"><CODE>SetMaxVoiceCount</CODE></a> 352 </th> 353 <td>Sets the maximum number of voices to use with the sound library.</td> 354 </tr> 355 <tr> 356 <th class="category" colspan="3">biquad Filter</th> 357 </tr> 358 <tr> 359 <td width="100"> 360 <span class="static_style" title="static">S</span> </td> 361 <th> 362 <a href="../../../nw/snd/SoundSystem/SetBiquadFilterCallback.html">SetBiquadFilterCallback</a> 363 </th> 364 <td>Registers an user defined biquad filter.</td> 365 </tr> </table> 366 </div> 367 </a> 368 <h2>Revision History</h2> 369 <div class="section"> 370 <dl class="history"> 371 <dt>2010/20/21</dt> 372 <dd>Added [Effect Processing Overview]<br /> 373 </dd> 374 <dt>2010/01/15</dt> 375 <dd>Initial version.<br /> 376 </dd> 377 </dl> 378 </div> 379 <hr><p>CONFIDENTIAL</p></body> 380</html>