e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-04-19 22:16:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.1.2 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:37:27 +02:00
committed by Stephen Sinclair
parent d12ef806ac
commit 5d63b50e85
436 changed files with 17966 additions and 14506 deletions
Download Patch File Download Diff File Expand all files Collapse all files

117
doc/html/classBlowHole.html
View File

@@ -5,80 +5,93 @@
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"> &nbsp; <img src="mcgill.gif"><P>
<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<h1>BlowHole Class Reference</h1>STK clarinet physical model with one register hole and one tonehole.
<!-- Generated by Doxygen 1.3.6 -->
<h1>BlowHole Class Reference</h1>STK clarinet physical model with one register hole and one tonehole.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="BlowHole_8h-source.html">BlowHole.h</a>&gt;</code>
<p>
<p>Inheritance diagram for BlowHole::
<p><center><img src="classBlowHole.gif" usemap="#BlowHole_map" border="0"></center>
<p>Inheritance diagram for BlowHole:
<p><center><img src="classBlowHole.png" usemap="#BlowHole_map" border="0" alt=""></center>
<map name="BlowHole_map">
<area href="classInstrmnt.html" alt="Instrmnt" shape="rect" coords="0,56,65,80">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,65,24">
</map>
<a href="classBlowHole-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="BlowHole::BlowHole"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classBlowHole.html#a0">BlowHole</a> (MY_FLOAT lowestFrequency)</td></tr>
<tr><td>&nbsp;</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="BlowHole::~BlowHole"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classBlowHole.html#a1">~BlowHole</a> ()</td></tr>
<tr><td>&nbsp;</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="BlowHole::clear"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classBlowHole.html#a2">clear</a> ()</td></tr>
<tr><td>&nbsp;</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="BlowHole::setFrequency"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classBlowHole.html#a3">setFrequency</a> (MY_FLOAT frequency)</td></tr>
<tr><td>&nbsp;</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="BlowHole::setTonehole"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classBlowHole.html#a4">setTonehole</a> (MY_FLOAT newValue)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set the tonehole state (0.0 = closed, 1.0 = fully open).</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a5" doxytag="BlowHole::setVent"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classBlowHole.html#a5">setVent</a> (MY_FLOAT newValue)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set the register hole state (0.0 = closed, 1.0 = fully open).</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a6" doxytag="BlowHole::startBlowing"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classBlowHole.html#a6">startBlowing</a> (MY_FLOAT amplitude, MY_FLOAT rate)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Apply breath pressure to instrument with given amplitude and rate of increase.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a7" doxytag="BlowHole::stopBlowing"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classBlowHole.html#a7">stopBlowing</a> (MY_FLOAT rate)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Decrease breath pressure with given rate of decrease.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a8" doxytag="BlowHole::noteOn"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classBlowHole.html#a8">noteOn</a> (MY_FLOAT frequency, MY_FLOAT amplitude)</td></tr>
<tr><td>&nbsp;</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="a9" doxytag="BlowHole::noteOff"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classBlowHole.html#a9">noteOff</a> (MY_FLOAT amplitude)</td></tr>
<tr><td>&nbsp;</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="a10" doxytag="BlowHole::tick"></a>
MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classBlowHole.html#a10">tick</a> ()</td></tr>
<tr><td>&nbsp;</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="a11" doxytag="BlowHole::controlChange"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classBlowHole.html#a11">controlChange</a> (int number, MY_FLOAT value)</td></tr>
<tr><td>&nbsp;</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>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a0" doxytag="BlowHole::BlowHole" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a0">BlowHole</a> (MY_FLOAT lowestFrequency)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="BlowHole::~BlowHole" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a1">~BlowHole</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a2" doxytag="BlowHole::clear" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a2">clear</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset and clear all internal state. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="BlowHole::setFrequency" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a3">setFrequency</a> (MY_FLOAT frequency)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set instrument parameters for a particular frequency. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="BlowHole::setTonehole" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a4">setTonehole</a> (MY_FLOAT newValue)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the tonehole state (0.0 = closed, 1.0 = fully open). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="BlowHole::setVent" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a5">setVent</a> (MY_FLOAT newValue)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the register hole state (0.0 = closed, 1.0 = fully open). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="BlowHole::startBlowing" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a6">startBlowing</a> (MY_FLOAT amplitude, MY_FLOAT rate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Apply breath pressure to instrument with given amplitude and rate of increase. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a7" doxytag="BlowHole::stopBlowing" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a7">stopBlowing</a> (MY_FLOAT rate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Decrease breath pressure with given rate of decrease. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a8" doxytag="BlowHole::noteOn" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a8">noteOn</a> (MY_FLOAT frequency, MY_FLOAT amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start a note with the given frequency and amplitude. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a9" doxytag="BlowHole::noteOff" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a9">noteOff</a> (MY_FLOAT amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stop a note with the given amplitude (speed of decay). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a10" doxytag="BlowHole::tick" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a10">tick</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute one output sample. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a11" doxytag="BlowHole::controlChange" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a11">controlChange</a> (int number, MY_FLOAT value)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0). <br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK clarinet physical model with one register hole and one tonehole.
STK clarinet physical model with one register hole and one tonehole.
<p>
This class is based on the clarinet model, with the addition of a two-port register hole and a three-port dynamic tonehole implementation, as discussed by Scavone and Cook (1998).
This class is based on the clarinet model, with the addition of a two-port register hole and a three-port dynamic tonehole implementation, as discussed by Scavone and Cook (1998).<p>
In this implementation, the distances between the reed/register hole and tonehole/bell are fixed. As a result, both the tonehole and register hole will have variable influence on the playing frequency, which is dependent on the length of the air column. In addition, the highest playing freqeuency is limited by these fixed lengths.<p>
This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others.<p>
Control Change Numbers:<ul>
<li>Reed Stiffness = 2</li><li><a class="el" href="classNoise.html">Noise</a> Gain = 4</li><li>Tonehole State = 11</li><li>Register State = 1</li><li>Breath Pressure = 128</li></ul>
<p>
In this implementation, the distances between the reed/register hole and tonehole/bell are fixed. As a result, both the tonehole and register hole will have variable influence on the playing frequency, which is dependent on the length of the air column. In addition, the highest playing freqeuency is limited by these fixed lengths.
<p>
This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others.
<p>
Control Change Numbers: <ul>
<li>Reed Stiffness = 2<li><a class="el" href="classNoise.html">Noise</a> Gain = 4<li>Tonehole State = 11<li>Register State = 1<li>Breath Pressure = 128</ul>
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
<p>
<hr>The documentation for this class was generated from the following file:<ul>
<p>
Definition at line <a class="el" href="BlowHole_8h-source.html#l00048">48</a> of file <a class="el" href="BlowHole_8h-source.html">BlowHole.h</a>.<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="BlowHole_8h-source.html">BlowHole.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>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>