mirror of
https://github.com/thestk/stk
synced 2026-01-13 21:11:53 +00:00
76 lines
5.4 KiB
HTML
76 lines
5.4 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"><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="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.2.8.1 -->
|
|
<h1>Whistle Class Reference</h1>STK police/referee whistle instrument class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="Whistle_8h-source.html">Whistle.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for Whistle::
|
|
<p><center><img src="classWhistle.gif" usemap="#Whistle_map" border="0"></center>
|
|
<map name="Whistle_map">
|
|
<area href="classInstrmnt.html" alt="Instrmnt" shape="rect" coords="0,56,55,80">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,55,24">
|
|
</map>
|
|
<a href="classWhistle-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
|
|
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a0" doxytag="Whistle::Whistle"></a>
|
|
</td><td valign=bottom><a class="el" href="classWhistle.html#a0">Whistle</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Class constructor.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a1" doxytag="Whistle::~Whistle"></a>
|
|
</td><td valign=bottom><a class="el" href="classWhistle.html#a1">~Whistle</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Class destructor.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a2" doxytag="Whistle::clear"></a>
|
|
void </td><td valign=bottom><a class="el" href="classWhistle.html#a2">clear</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Reset and clear all internal state.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a3" doxytag="Whistle::setFrequency"></a>
|
|
void </td><td valign=bottom><a class="el" href="classWhistle.html#a3">setFrequency</a> (MY_FLOAT frequency)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set instrument parameters for a particular frequency.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a4" doxytag="Whistle::startBlowing"></a>
|
|
void </td><td valign=bottom><a class="el" href="classWhistle.html#a4">startBlowing</a> (MY_FLOAT amplitude, MY_FLOAT rate)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Apply breath velocity to instrument with given amplitude and rate of increase.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a5" doxytag="Whistle::stopBlowing"></a>
|
|
void </td><td valign=bottom><a class="el" href="classWhistle.html#a5">stopBlowing</a> (MY_FLOAT rate)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Decrease breath velocity with given rate of decrease.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a6" doxytag="Whistle::noteOn"></a>
|
|
void </td><td valign=bottom><a class="el" href="classWhistle.html#a6">noteOn</a> (MY_FLOAT frequency, MY_FLOAT amplitude)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Start a note with the given frequency and amplitude.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a7" doxytag="Whistle::noteOff"></a>
|
|
void </td><td valign=bottom><a class="el" href="classWhistle.html#a7">noteOff</a> (MY_FLOAT amplitude)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Stop a note with the given amplitude (speed of decay).</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a8" doxytag="Whistle::tick"></a>
|
|
MY_FLOAT </td><td valign=bottom><a class="el" href="classWhistle.html#a8">tick</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Compute one output sample.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a9" doxytag="Whistle::controlChange"></a>
|
|
void </td><td valign=bottom><a class="el" href="classWhistle.html#a9">controlChange</a> (int number, MY_FLOAT value)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0).</em></font><br><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK police/referee whistle instrument class.
|
|
<p>
|
|
This class implements a hybrid physical/spectral model of a police whistle (a la Cook).
|
|
<p>
|
|
Control Change Numbers: <ul>
|
|
<li><a class="el" href="classNoise.html">Noise</a> Gain = 4<li>Fipple Modulation Frequency = 11<li>Fipple Modulation Gain = 1<li>Blowing Frequency Modulation = 2<li>Volume = 128</ul>
|
|
by Perry R. Cook 1996 - 2002.
|
|
<p>
|
|
<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></ul>
|
|
<HR>
|
|
|
|
<table>
|
|
<tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
|
|
<tr><td>©1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|