1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
<HTML>
<HEAD>
<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<img src="princeton.gif"> <img src="ccrma.gif"> <img src="mcgill.gif"><P>
<a class="qindex" href="index.html">Home</a> <a class="qindex" href="information.html">Information</a> <a class="qindex" href="classes.html">Classes</a> <a class="qindex" href="download.html">Download</a> <a class="qindex" href="usage.html">Usage</a> <a class="qindex" href="maillist.html">Mail List</a> <a class="qindex" href="system.html">Requirements</a> <a class="qindex" href="links.html">Links</a> <a class="qindex" href="faq.html">FAQ</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.6.2 -->
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Noise.html">Noise</a>
</div>
<div class="contents">
<h1>stk::Noise Class Reference</h1><!-- doxytag: class="stk::Noise" --><!-- doxytag: inherits="stk::Generator" -->
<p>STK noise generator.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="Noise_8h_source.html">Noise.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for stk::Noise:</div>
<div class="dynsection">
<div class="center">
<img src="classstk_1_1Noise.png" usemap="#stk::Noise_map" alt=""/>
<map id="stk::Noise_map" name="stk::Noise_map">
<area href="classstk_1_1Generator.html" alt="stk::Generator" shape="rect" coords="0,56,90,80"/>
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,90,24"/>
</map>
</div>
</div>
<p><a href="classstk_1_1Noise-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Noise.html#a2d442a08883be25f10952dff4e515f98">Noise</a> (unsigned int seed=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor that can also take a specific seed value. <a href="#a2d442a08883be25f10952dff4e515f98"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Noise.html#a9507ae6eb261c577a64b4ecb5c1805dc">setSeed</a> (unsigned int seed=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Seed the random number generator with a specific seed value. <a href="#a9507ae6eb261c577a64b4ecb5c1805dc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1d6c8ed80425cd0cea014bd2e328c823"></a><!-- doxytag: member="stk::Noise::lastOut" ref="a1d6c8ed80425cd0cea014bd2e328c823" args="(void) const " -->
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Noise.html#a1d6c8ed80425cd0cea014bd2e328c823">lastOut</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the last computed output value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8ac40f69475eb744e803d557e8438a6d"></a><!-- doxytag: member="stk::Noise::tick" ref="a8ac40f69475eb744e803d557e8438a6d" args="(void)" -->
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Noise.html#a8ac40f69475eb744e803d557e8438a6d">tick</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute and return one output sample. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Noise.html#a2f92e91787dc19309305cf246632cd50">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &frames, unsigned int channel=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fill a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object with computed outputs. <a href="#a2f92e91787dc19309305cf246632cd50"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK noise generator. </p>
<p>Generic random number generation using the C rand() function. The quality of the rand() function varies from one OS to another.</p>
<p>by Perry R. Cook and Gary P. Scavone, 1995-2012. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a2d442a08883be25f10952dff4e515f98"></a><!-- doxytag: member="stk::Noise::Noise" ref="a2d442a08883be25f10952dff4e515f98" args="(unsigned int seed=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">stk::Noise::Noise </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>seed</em> = <code>0</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor that can also take a specific seed value. </p>
<p>If the seed value is zero (the default value), the random number generator is seeded with the system time. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9507ae6eb261c577a64b4ecb5c1805dc"></a><!-- doxytag: member="stk::Noise::setSeed" ref="a9507ae6eb261c577a64b4ecb5c1805dc" args="(unsigned int seed=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stk::Noise::setSeed </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>seed</em> = <code>0</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Seed the random number generator with a specific seed value. </p>
<p>If no seed is provided or the seed value is zero, the random number generator is seeded with the current system time. </p>
</div>
</div>
<a class="anchor" id="a2f92e91787dc19309305cf246632cd50"></a><!-- doxytag: member="stk::Noise::tick" ref="a2f92e91787dc19309305cf246632cd50" args="(StkFrames &frames, unsigned int channel=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & stk::Noise::tick </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td>
<td class="paramname"> <em>frames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>channel</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fill a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object with computed outputs. </p>
<p>The <code>channel</code> argument must be less than the number of channels in the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception. </p>
<p>Implements <a class="el" href="classstk_1_1Generator.html#a86bb0421223cf27e25704d5f27b97425">stk::Generator</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00065"></a>00065 {
<a name="l00066"></a>00066 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
<a name="l00067"></a>00067 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel >= frames.channels() ) {
<a name="l00068"></a>00068 oStream_ << <span class="stringliteral">"Noise::tick(): channel and StkFrames arguments are incompatible!"</span>;
<a name="l00069"></a>00069 <a class="code" href="classstk_1_1Stk.html#a48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">handleError</a>( StkError::FUNCTION_ARGUMENT );
<a name="l00070"></a>00070 }
<a name="l00071"></a>00071 <span class="preprocessor">#endif</span>
<a name="l00072"></a>00072 <span class="preprocessor"></span>
<a name="l00073"></a>00073 StkFloat *samples = &frames[channel];
<a name="l00074"></a>00074 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> hop = frames.channels();
<a name="l00075"></a>00075 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i<frames.frames(); i++, samples += hop )
<a name="l00076"></a>00076 *samples = (StkFloat) ( 2.0 * rand() / (RAND_MAX + 1.0) - 1.0 );
<a name="l00077"></a>00077
<a name="l00078"></a>00078 lastFrame_[0] = *(samples-hop);
<a name="l00079"></a>00079 <span class="keywordflow">return</span> frames;
<a name="l00080"></a>00080 }
</pre></div></p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Noise_8h_source.html">Noise.h</a></li>
</ul>
</div>
<HR>
<table>
<tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<tr><td>©1995-2012 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>
|
