mirror of
https://github.com/thestk/stk
synced 2026-01-15 05:51:52 +00:00
119 lines
12 KiB
HTML
119 lines
12 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="dir_221deb9bdff892d63ed1e409450a60d2.html">include</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>Whistle.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef STK_WHISTLE_H</span>
|
|
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define STK_WHISTLE_H</span>
|
|
<a name="l00003"></a>00003 <span class="preprocessor"></span>
|
|
<a name="l00004"></a>00004 <span class="preprocessor">#include "Instrmnt.h"</span>
|
|
<a name="l00005"></a>00005 <span class="preprocessor">#include "Sphere.h"</span>
|
|
<a name="l00006"></a>00006 <span class="preprocessor">#include "Vector3D.h"</span>
|
|
<a name="l00007"></a>00007 <span class="preprocessor">#include "Noise.h"</span>
|
|
<a name="l00008"></a>00008 <span class="preprocessor">#include "SineWave.h"</span>
|
|
<a name="l00009"></a>00009 <span class="preprocessor">#include "OnePole.h"</span>
|
|
<a name="l00010"></a>00010 <span class="preprocessor">#include "Envelope.h"</span>
|
|
<a name="l00011"></a>00011
|
|
<a name="l00012"></a>00012 <span class="keyword">namespace </span>stk {
|
|
<a name="l00013"></a>00013
|
|
<a name="l00014"></a>00014 <span class="comment">/***************************************************/</span>
|
|
<a name="l00030"></a>00030 <span class="comment">/***************************************************/</span>
|
|
<a name="l00031"></a>00031
|
|
<a name="l00032"></a><a class="code" href="classstk_1_1Whistle.html">00032</a> <span class="keyword">class </span><a class="code" href="classstk_1_1Whistle.html" title="STK police/referee whistle instrument class.">Whistle</a> : <span class="keyword">public</span> <a class="code" href="classstk_1_1Instrmnt.html" title="STK instrument abstract base class.">Instrmnt</a>
|
|
<a name="l00033"></a>00033 {
|
|
<a name="l00034"></a>00034 <span class="keyword">public</span>:
|
|
<a name="l00036"></a>00036
|
|
<a name="l00039"></a>00039 <a class="code" href="classstk_1_1Whistle.html#ae577e98aaf1957164155e4247f39a604" title="Class constructor.">Whistle</a>( <span class="keywordtype">void</span> );
|
|
<a name="l00040"></a>00040
|
|
<a name="l00042"></a>00042 <a class="code" href="classstk_1_1Whistle.html#ab44c607efebd6d6d53bf06b95636a90b" title="Class destructor.">~Whistle</a>( <span class="keywordtype">void</span> );
|
|
<a name="l00043"></a>00043
|
|
<a name="l00045"></a>00045 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Whistle.html#a8551209b9079d3bc626702e0745b2eb8" title="Reset and clear all internal state.">clear</a>( <span class="keywordtype">void</span> );
|
|
<a name="l00046"></a>00046
|
|
<a name="l00048"></a>00048 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Whistle.html#a6fd2ded34c6bfda618d80d7068e829d4" title="Set instrument parameters for a particular frequency.">setFrequency</a>( StkFloat frequency );
|
|
<a name="l00049"></a>00049
|
|
<a name="l00051"></a>00051 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Whistle.html#ade1532d8b10e8b3ce7dfecba86514eaa" title="Apply breath velocity to instrument with given amplitude and rate of increase.">startBlowing</a>( StkFloat amplitude, StkFloat rate );
|
|
<a name="l00052"></a>00052
|
|
<a name="l00054"></a>00054 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Whistle.html#a6f529770c888caca50fc35f454c98898" title="Decrease breath velocity with given rate of decrease.">stopBlowing</a>( StkFloat rate );
|
|
<a name="l00055"></a>00055
|
|
<a name="l00057"></a>00057 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Whistle.html#ab8b80cab3827a6cf2bb95393c522c58b" title="Start a note with the given frequency and amplitude.">noteOn</a>( StkFloat frequency, StkFloat amplitude );
|
|
<a name="l00058"></a>00058
|
|
<a name="l00060"></a>00060 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Whistle.html#a50c5a97cebe6f7dbb6615ab3e76e41e0" title="Stop a note with the given amplitude (speed of decay).">noteOff</a>( StkFloat amplitude );
|
|
<a name="l00061"></a>00061
|
|
<a name="l00063"></a>00063 <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Whistle.html#a7d5d2d24fb0103aae0fb8c6308e2a663" title="Perform the control change specified by number and value (0.0 - 128.0).">controlChange</a>( <span class="keywordtype">int</span> number, StkFloat value );
|
|
<a name="l00064"></a>00064
|
|
<a name="l00066"></a>00066 StkFloat <a class="code" href="classstk_1_1Whistle.html#a3835e290dae97acfe79e1f7458a39cda" title="Compute and return one output sample.">tick</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 0 );
|
|
<a name="l00067"></a>00067
|
|
<a name="l00069"></a>00069
|
|
<a name="l00076"></a>00076 <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& <a class="code" href="classstk_1_1Whistle.html#a3835e290dae97acfe79e1f7458a39cda" title="Compute and return one output sample.">tick</a>( <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& frames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 0 );
|
|
<a name="l00077"></a>00077
|
|
<a name="l00078"></a>00078 <span class="keyword">protected</span>:
|
|
<a name="l00079"></a>00079
|
|
<a name="l00080"></a>00080 <a class="code" href="classstk_1_1Vector3D.html" title="STK 3D vector class.">Vector3D</a> *tempVectorP_;
|
|
<a name="l00081"></a>00081 <a class="code" href="classstk_1_1Vector3D.html" title="STK 3D vector class.">Vector3D</a> tempVector_;
|
|
<a name="l00082"></a>00082 <a class="code" href="classstk_1_1OnePole.html" title="STK one-pole filter class.">OnePole</a> onepole_;
|
|
<a name="l00083"></a>00083 <a class="code" href="classstk_1_1Noise.html" title="STK noise generator.">Noise</a> noise_;
|
|
<a name="l00084"></a>00084 <a class="code" href="classstk_1_1Envelope.html" title="STK linear line envelope class.">Envelope</a> envelope_;
|
|
<a name="l00085"></a>00085 <a class="code" href="classstk_1_1Sphere.html" title="STK sphere class.">Sphere</a> can_; <span class="comment">// Declare a Spherical "can".</span>
|
|
<a name="l00086"></a>00086 <a class="code" href="classstk_1_1Sphere.html" title="STK sphere class.">Sphere</a> pea_, bumper_; <span class="comment">// One spherical "pea", and a spherical "bumper".</span>
|
|
<a name="l00087"></a>00087
|
|
<a name="l00088"></a>00088 <a class="code" href="classstk_1_1SineWave.html" title="STK sinusoid oscillator class.">SineWave</a> sine_;
|
|
<a name="l00089"></a>00089
|
|
<a name="l00090"></a>00090 StkFloat baseFrequency_;
|
|
<a name="l00091"></a>00091 StkFloat noiseGain_;
|
|
<a name="l00092"></a>00092 StkFloat fippleFreqMod_;
|
|
<a name="l00093"></a>00093 StkFloat fippleGainMod_;
|
|
<a name="l00094"></a>00094 StkFloat blowFreqMod_;
|
|
<a name="l00095"></a>00095 StkFloat tickSize_;
|
|
<a name="l00096"></a>00096 StkFloat canLoss_;
|
|
<a name="l00097"></a>00097 <span class="keywordtype">int</span> subSample_, subSampCount_;
|
|
<a name="l00098"></a>00098 };
|
|
<a name="l00099"></a>00099
|
|
<a name="l00100"></a><a class="code" href="classstk_1_1Whistle.html#a46135035da33d0825e3ff0db04b857d4">00100</a> <span class="keyword">inline</span> <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& <a class="code" href="classstk_1_1Whistle.html#a3835e290dae97acfe79e1f7458a39cda" title="Compute and return one output sample.">Whistle :: tick</a>( <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>& frames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel )
|
|
<a name="l00101"></a>00101 {
|
|
<a name="l00102"></a>00102 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels = lastFrame_.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>();
|
|
<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.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() - 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.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() - 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.<a class="code" href="classstk_1_1StkFrames.html#a05b1ab6fa750a8221a7d65c30e0cdab9" title="Return the number of sample frames represented by the data.">frames</a>(); 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.<a class="code" href="classstk_1_1StkFrames.html#a05b1ab6fa750a8221a7d65c30e0cdab9" title="Return the number of sample frames represented by the data.">frames</a>(); 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 }
|
|
<a name="l00126"></a>00126
|
|
<a name="l00127"></a>00127 } <span class="comment">// stk namespace</span>
|
|
<a name="l00128"></a>00128 <span class="preprocessor">#endif</span>
|
|
</pre></div></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>
|