e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-19 07:31:52 +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

121
doc/html/classFlute.html
View File

@@ -5,81 +5,96 @@
</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>Flute Class Reference</h1>STK flute physical model class.
<!-- Generated by Doxygen 1.3.6 -->
<h1>Flute Class Reference</h1>STK flute physical model class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Flute_8h-source.html">Flute.h</a>&gt;</code>
<p>
<p>Inheritance diagram for Flute::
<p><center><img src="classFlute.gif" usemap="#Flute_map" border="0"></center>
<p>Inheritance diagram for Flute:
<p><center><img src="classFlute.png" usemap="#Flute_map" border="0" alt=""></center>
<map name="Flute_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="classFlute-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="Flute::Flute"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classFlute.html#a0">Flute</a> (MY_FLOAT lowestFrequency)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Class constructor, taking the lowest desired playing frequency.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a1" doxytag="Flute::~Flute"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classFlute.html#a1">~Flute</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="Flute::clear"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classFlute.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="Flute::setFrequency"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classFlute.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="Flute::setJetReflection"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classFlute.html#a4">setJetReflection</a> (MY_FLOAT coefficient)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set the reflection coefficient for the jet delay (-1.0 - 1.0).</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a5" doxytag="Flute::setEndReflection"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classFlute.html#a5">setEndReflection</a> (MY_FLOAT coefficient)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set the reflection coefficient for the air column delay (-1.0 - 1.0).</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a6" doxytag="Flute::setJetDelay"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classFlute.html#a6">setJetDelay</a> (MY_FLOAT aRatio)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set the length of the jet delay in terms of a ratio of jet delay to air column delay lengths.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a7" doxytag="Flute::startBlowing"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classFlute.html#a7">startBlowing</a> (MY_FLOAT amplitude, MY_FLOAT rate)</td></tr>
<tr><td>&nbsp;</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="a8" doxytag="Flute::stopBlowing"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classFlute.html#a8">stopBlowing</a> (MY_FLOAT rate)</td></tr>
<tr><td>&nbsp;</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="a9" doxytag="Flute::noteOn"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classFlute.html#a9">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="a10" doxytag="Flute::noteOff"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classFlute.html#a10">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="a11" doxytag="Flute::tick"></a>
MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classFlute.html#a11">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="a12" doxytag="Flute::controlChange"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classFlute.html#a12">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="Flute::Flute" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFlute.html#a0">Flute</a> (MY_FLOAT lowestFrequency)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor, taking the lowest desired playing frequency. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="Flute::~Flute" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFlute.html#a1">~Flute</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="Flute::clear" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFlute.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="Flute::setFrequency" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFlute.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="Flute::setJetReflection" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFlute.html#a4">setJetReflection</a> (MY_FLOAT coefficient)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the reflection coefficient for the jet delay (-1.0 - 1.0). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="Flute::setEndReflection" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFlute.html#a5">setEndReflection</a> (MY_FLOAT coefficient)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the reflection coefficient for the air column delay (-1.0 - 1.0). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="Flute::setJetDelay" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFlute.html#a6">setJetDelay</a> (MY_FLOAT aRatio)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the length of the jet delay in terms of a ratio of jet delay to air column delay lengths. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a7" doxytag="Flute::startBlowing" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFlute.html#a7">startBlowing</a> (MY_FLOAT amplitude, MY_FLOAT rate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Apply breath velocity 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="a8" doxytag="Flute::stopBlowing" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFlute.html#a8">stopBlowing</a> (MY_FLOAT rate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Decrease breath velocity with given rate of decrease. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a9" doxytag="Flute::noteOn" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFlute.html#a9">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="a10" doxytag="Flute::noteOff" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFlute.html#a10">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="a11" doxytag="Flute::tick" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFlute.html#a11">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="a12" doxytag="Flute::controlChange" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFlute.html#a12">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 flute physical model class.
STK flute physical model class.
<p>
This class implements a simple flute physical model, as discussed by Karjalainen, Smith, Waryznyk, etc. The jet model uses a polynomial, a la Cook.
This class implements a simple flute physical model, as discussed by Karjalainen, Smith, Waryznyk, etc. The jet model uses a polynomial, a la Cook.<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>Jet <a class="el" href="classDelay.html">Delay</a> = 2</li><li><a class="el" href="classNoise.html">Noise</a> Gain = 4</li><li>Vibrato Frequency = 11</li><li>Vibrato Gain = 1</li><li>Breath Pressure = 128</li></ul>
<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>Jet <a class="el" href="classDelay.html">Delay</a> = 2<li><a class="el" href="classNoise.html">Noise</a> Gain = 4<li>Vibrato Frequency = 11<li>Vibrato Gain = 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="Flute_8h-source.html#l00037">37</a> of file <a class="el" href="Flute_8h-source.html">Flute.h</a>.<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Flute_8h-source.html">Flute.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>