mirror of
https://github.com/thestk/stk
synced 2026-01-18 07:01:53 +00:00
Release 4.2.0 tarball
This commit is contained in:
Gary Scavone
committed by
Stephen Sinclair
Stephen Sinclair
parent
fe20fe92a2
commit
de344668dd
@@ -9,10 +9,7 @@
|
||||
<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.3.4 -->
|
||||
<h1>BlowHole Class Reference</h1>STK clarinet physical model with one register hole and one tonehole.
|
||||
<a href="#_details">More...</a>
|
||||
<p>
|
||||
<code>#include <<a class="el" href="BlowHole_8h-source.html">BlowHole.h</a>></code>
|
||||
<h1>BlowHole Class Reference</h1><code>#include <<a class="el" href="BlowHole_8h-source.html">BlowHole.h</a>></code>
|
||||
<p>
|
||||
<p>Inheritance diagram for BlowHole:
|
||||
<p><center><img src="classBlowHole.png" usemap="#BlowHole_map" border="0" alt=""></center>
|
||||
@@ -20,13 +17,25 @@
|
||||
<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>
|
||||
<a href="classBlowHole-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
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).<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>
|
||||
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
|
||||
<p>
|
||||
|
||||
<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>.<table border=0 cellpadding=0 cellspacing=0>
|
||||
<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>
|
||||
</td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a0">BlowHole</a> (MY_FLOAT lowestFrequency)</td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a0">BlowHole</a> (StkFloat lowestFrequency)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor. <br><br></td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor. </em> <a href="#a0"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="BlowHole::~BlowHole" ></a>
|
||||
</td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a1">~BlowHole</a> ()</td></tr>
|
||||
|
||||
@@ -36,61 +45,130 @@ void </td><td class="memItemRight" valign=bottom><a class="el" href="classB
|
||||
|
||||
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a3">setFrequency</a> (MY_FLOAT frequency)</td></tr>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a3">setFrequency</a> (StkFloat frequency)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a4">setTonehole</a> (MY_FLOAT newValue)</td></tr>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a4">setTonehole</a> (StkFloat newValue)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a5">setVent</a> (MY_FLOAT newValue)</td></tr>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a5">setVent</a> (StkFloat newValue)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a6">startBlowing</a> (MY_FLOAT amplitude, MY_FLOAT rate)</td></tr>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a6">startBlowing</a> (StkFloat amplitude, StkFloat rate)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a7">stopBlowing</a> (MY_FLOAT rate)</td></tr>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a7">stopBlowing</a> (StkFloat rate)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a8">noteOn</a> (MY_FLOAT frequency, MY_FLOAT amplitude)</td></tr>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a8">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><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a9" doxytag="BlowHole::noteOff" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a9">noteOff</a> (MY_FLOAT amplitude)</td></tr>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a9">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><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a10" doxytag="BlowHole::tick" ></a>
|
||||
MY_FLOAT </td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a10">tick</a> ()</td></tr>
|
||||
StkFloat </td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a10">tick</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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 </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="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a11" doxytag="BlowHole::tick" ></a>
|
||||
StkFloat * </td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a11">tick</a> (StkFloat *vector, unsigned int vectorSize)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Computer <em>vectorSize</em> outputs and return them in <em>vector</em>. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classStkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a12">tick</a> (<a class="el" href="classStkFrames.html">StkFrames</a> &frames, unsigned int channel=1)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fill a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object with computed outputs. </em> <a href="#a12"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a13" doxytag="BlowHole::controlChange" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classBlowHole.html#a13">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><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
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).<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>
|
||||
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
|
||||
<p>
|
||||
<hr><h2>Constructor & Destructor Documentation</h2>
|
||||
<a class="anchor" name="a0" doxytag="BlowHole::BlowHole" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> BlowHole::BlowHole </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">StkFloat </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>lowestFrequency</em> </td>
|
||||
<td class="md" valign="top"> ) </td>
|
||||
<td class="md" nowrap></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<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>
|
||||
Class constructor.
|
||||
<p>
|
||||
An <a class="el" href="classStkError.html">StkError</a> will be thrown if the rawwave path is incorrectly set. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<hr><h2>Member Function Documentation</h2>
|
||||
<a class="anchor" name="a12" doxytag="BlowHole::tick" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> <a class="el" href="classStkFrames.html">StkFrames</a>& BlowHole::tick </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="classStkFrames.html">StkFrames</a> & </td>
|
||||
<td class="mdname" nowrap> <em>frames</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>unsigned int </td>
|
||||
<td class="mdname" nowrap> <em>channel</em> = 1</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td class="md">) </td>
|
||||
<td class="md" colspan="2"><code> [virtual]</code></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
Fill a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object with computed outputs.
|
||||
<p>
|
||||
The <code>channel</code> argument should be one or greater (the first channel is specified by 1). An <a class="el" href="classStkError.html">StkError</a> will be thrown if the <code>channel</code> argument is zero or it is greater than the number of channels in the <a class="el" href="classStkFrames.html">StkFrames</a> object.
|
||||
<p>
|
||||
Reimplemented from <a class="el" href="classInstrmnt.html#a10">Instrmnt</a>. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<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><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
|
||||
<tr><td>©1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
</table>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user