mirror of
https://github.com/thestk/stk
synced 2026-01-17 14:41:53 +00:00
174 lines
14 KiB
HTML
174 lines
14 KiB
HTML
<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_1Whistle.html">Whistle</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::Whistle Class Reference</h1><!-- doxytag: class="stk::Whistle" --><!-- doxytag: inherits="stk::Instrmnt" -->
|
|
<p>STK police/referee whistle instrument class.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="Whistle_8h_source.html">Whistle.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::Whistle:</div>
|
|
<div class="dynsection">
|
|
<div class="center">
|
|
<img src="classstk_1_1Whistle.png" usemap="#stk::Whistle_map" alt=""/>
|
|
<map id="stk::Whistle_map" name="stk::Whistle_map">
|
|
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,76,80"/>
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,76,24"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
|
|
<p><a href="classstk_1_1Whistle-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_1Whistle.html#ae577e98aaf1957164155e4247f39a604">Whistle</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor. <a href="#ae577e98aaf1957164155e4247f39a604"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab44c607efebd6d6d53bf06b95636a90b"></a><!-- doxytag: member="stk::Whistle::~Whistle" ref="ab44c607efebd6d6d53bf06b95636a90b" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Whistle.html#ab44c607efebd6d6d53bf06b95636a90b">~Whistle</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8551209b9079d3bc626702e0745b2eb8"></a><!-- doxytag: member="stk::Whistle::clear" ref="a8551209b9079d3bc626702e0745b2eb8" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Whistle.html#a8551209b9079d3bc626702e0745b2eb8">clear</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset and clear all internal state. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6fd2ded34c6bfda618d80d7068e829d4"></a><!-- doxytag: member="stk::Whistle::setFrequency" ref="a6fd2ded34c6bfda618d80d7068e829d4" args="(StkFloat frequency)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Whistle.html#a6fd2ded34c6bfda618d80d7068e829d4">setFrequency</a> (StkFloat frequency)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set instrument parameters for a particular frequency. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ade1532d8b10e8b3ce7dfecba86514eaa"></a><!-- doxytag: member="stk::Whistle::startBlowing" ref="ade1532d8b10e8b3ce7dfecba86514eaa" args="(StkFloat amplitude, StkFloat rate)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Whistle.html#ade1532d8b10e8b3ce7dfecba86514eaa">startBlowing</a> (StkFloat amplitude, StkFloat rate)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Apply breath velocity to instrument with given amplitude and rate of increase. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6f529770c888caca50fc35f454c98898"></a><!-- doxytag: member="stk::Whistle::stopBlowing" ref="a6f529770c888caca50fc35f454c98898" args="(StkFloat rate)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Whistle.html#a6f529770c888caca50fc35f454c98898">stopBlowing</a> (StkFloat rate)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrease breath velocity with given rate of decrease. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab8b80cab3827a6cf2bb95393c522c58b"></a><!-- doxytag: member="stk::Whistle::noteOn" ref="ab8b80cab3827a6cf2bb95393c522c58b" args="(StkFloat frequency, StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Whistle.html#ab8b80cab3827a6cf2bb95393c522c58b">noteOn</a> (StkFloat frequency, StkFloat amplitude)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start a note with the given frequency and amplitude. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a50c5a97cebe6f7dbb6615ab3e76e41e0"></a><!-- doxytag: member="stk::Whistle::noteOff" ref="a50c5a97cebe6f7dbb6615ab3e76e41e0" args="(StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Whistle.html#a50c5a97cebe6f7dbb6615ab3e76e41e0">noteOff</a> (StkFloat amplitude)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop a note with the given amplitude (speed of decay). <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7d5d2d24fb0103aae0fb8c6308e2a663"></a><!-- doxytag: member="stk::Whistle::controlChange" ref="a7d5d2d24fb0103aae0fb8c6308e2a663" args="(int number, StkFloat value)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Whistle.html#a7d5d2d24fb0103aae0fb8c6308e2a663">controlChange</a> (int number, StkFloat value)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0). <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3835e290dae97acfe79e1f7458a39cda"></a><!-- doxytag: member="stk::Whistle::tick" ref="a3835e290dae97acfe79e1f7458a39cda" args="(unsigned int channel=0)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Whistle.html#a3835e290dae97acfe79e1f7458a39cda">tick</a> (unsigned int channel=0)</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_1Whistle.html#a46135035da33d0825e3ff0db04b857d4">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="#a46135035da33d0825e3ff0db04b857d4"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>STK police/referee whistle instrument class. </p>
|
|
<p>This class implements a hybrid physical/spectral model of a police whistle (a la Cook).</p>
|
|
<p>Control Change Numbers:</p>
|
|
<ul>
|
|
<li><a class="el" href="classstk_1_1Noise.html" title="STK noise generator.">Noise</a> Gain = 4</li>
|
|
<li>Fipple Modulation Frequency = 11</li>
|
|
<li>Fipple Modulation Gain = 1</li>
|
|
<li>Blowing Frequency Modulation = 2</li>
|
|
<li>Volume = 128</li>
|
|
</ul>
|
|
<p>by Perry R. Cook 1995-2011. </p>
|
|
<hr/><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="ae577e98aaf1957164155e4247f39a604"></a><!-- doxytag: member="stk::Whistle::Whistle" ref="ae577e98aaf1957164155e4247f39a604" args="(void)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">stk::Whistle::Whistle </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Class constructor. </p>
|
|
<p>An <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> will be thrown if the rawwave path is incorrectly set. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/><h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="a46135035da33d0825e3ff0db04b857d4"></a><!-- doxytag: member="stk::Whistle::tick" ref="a46135035da33d0825e3ff0db04b857d4" 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::Whistle::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_1Instrmnt.html#a34c6733ca145763462d9e44ae3c772b6">stk::Instrmnt</a>.</p>
|
|
|
|
<p><div class="fragment"><pre class="fragment"><a name="l00101"></a>00101 {
|
|
<a name="l00102"></a>00102 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels = lastFrame_.channels();
|
|
<a name="l00103"></a>00103 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
|
|
<a name="l00104"></a>00104 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel > frames.channels() - nChannels ) {
|
|
<a name="l00105"></a>00105 oStream_ << <span class="stringliteral">"Whistle::tick(): channel and StkFrames arguments are incompatible!"</span>;
|
|
<a name="l00106"></a>00106 <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="l00107"></a>00107 }
|
|
<a name="l00108"></a>00108 <span class="preprocessor">#endif</span>
|
|
<a name="l00109"></a>00109 <span class="preprocessor"></span>
|
|
<a name="l00110"></a>00110 StkFloat *samples = &frames[channel];
|
|
<a name="l00111"></a>00111 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> j, hop = frames.channels() - nChannels;
|
|
<a name="l00112"></a>00112 <span class="keywordflow">if</span> ( nChannels == 1 ) {
|
|
<a name="l00113"></a>00113 <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="l00114"></a>00114 *samples++ = <a class="code" href="classstk_1_1Whistle.html#a3835e290dae97acfe79e1f7458a39cda" title="Compute and return one output sample.">tick</a>();
|
|
<a name="l00115"></a>00115 }
|
|
<a name="l00116"></a>00116 <span class="keywordflow">else</span> {
|
|
<a name="l00117"></a>00117 <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="l00118"></a>00118 *samples++ = <a class="code" href="classstk_1_1Whistle.html#a3835e290dae97acfe79e1f7458a39cda" title="Compute and return one output sample.">tick</a>();
|
|
<a name="l00119"></a>00119 <span class="keywordflow">for</span> ( j=1; j<nChannels; j++ )
|
|
<a name="l00120"></a>00120 *samples++ = lastFrame_[j];
|
|
<a name="l00121"></a>00121 }
|
|
<a name="l00122"></a>00122 }
|
|
<a name="l00123"></a>00123
|
|
<a name="l00124"></a>00124 <span class="keywordflow">return</span> frames;
|
|
<a name="l00125"></a>00125 }
|
|
</pre></div></p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Whistle_8h_source.html">Whistle.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-2011 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|