mirror of
https://github.com/thestk/stk
synced 2026-01-16 22:31:52 +00:00
113 lines
9.1 KiB
HTML
113 lines
9.1 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="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Clarinet.html">Clarinet</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::Clarinet Class Reference</h1><!-- doxytag: class="stk::Clarinet" --><!-- doxytag: inherits="stk::Instrmnt" -->
|
|
<p>STK clarinet physical model class.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="Clarinet_8h_source.html">Clarinet.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::Clarinet:</div>
|
|
<div class="dynsection">
|
|
<div class="center">
|
|
<img src="classstk_1_1Clarinet.png" usemap="#stk::Clarinet_map" alt=""/>
|
|
<map id="stk::Clarinet_map" name="stk::Clarinet_map">
|
|
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,77,80"/>
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,77,24"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
|
|
<p><a href="classstk_1_1Clarinet-members.html">List of all members.</a></p>
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Clarinet.html#a82e32a30e6d9664ac9fe748070bec23c">Clarinet</a> (StkFloat lowestFrequency)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor, taking the lowest desired playing frequency. <a href="#a82e32a30e6d9664ac9fe748070bec23c"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5166db9f4cf180fa189ba2e135affe34"></a><!-- doxytag: member="stk::Clarinet::~Clarinet" ref="a5166db9f4cf180fa189ba2e135affe34" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Clarinet.html#a5166db9f4cf180fa189ba2e135affe34">~Clarinet</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7eae4377eb4178067c2dba704032a2d1"></a><!-- doxytag: member="stk::Clarinet::clear" ref="a7eae4377eb4178067c2dba704032a2d1" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Clarinet.html#a7eae4377eb4178067c2dba704032a2d1">clear</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset and clear all internal state. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af7c1cda6af97908c9b81b1be0c2a896d"></a><!-- doxytag: member="stk::Clarinet::setFrequency" ref="af7c1cda6af97908c9b81b1be0c2a896d" args="(StkFloat frequency)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Clarinet.html#af7c1cda6af97908c9b81b1be0c2a896d">setFrequency</a> (StkFloat frequency)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set instrument parameters for a particular frequency. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e4d016135c3ee291f4d74e9b030caee"></a><!-- doxytag: member="stk::Clarinet::startBlowing" ref="a0e4d016135c3ee291f4d74e9b030caee" args="(StkFloat amplitude, StkFloat rate)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Clarinet.html#a0e4d016135c3ee291f4d74e9b030caee">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/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae33627365f66f30c3685dc72cd7fadce"></a><!-- doxytag: member="stk::Clarinet::stopBlowing" ref="ae33627365f66f30c3685dc72cd7fadce" args="(StkFloat rate)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Clarinet.html#ae33627365f66f30c3685dc72cd7fadce">stopBlowing</a> (StkFloat rate)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrease breath pressure with given rate of decrease. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a35f9158176c1b654c74bdf6f1296df67"></a><!-- doxytag: member="stk::Clarinet::noteOn" ref="a35f9158176c1b654c74bdf6f1296df67" args="(StkFloat frequency, StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Clarinet.html#a35f9158176c1b654c74bdf6f1296df67">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/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a501413064397d1650e18edac92a98b2e"></a><!-- doxytag: member="stk::Clarinet::noteOff" ref="a501413064397d1650e18edac92a98b2e" args="(StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Clarinet.html#a501413064397d1650e18edac92a98b2e">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/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a63582205ab940101f5f9419fc717ff78"></a><!-- doxytag: member="stk::Clarinet::controlChange" ref="a63582205ab940101f5f9419fc717ff78" args="(int number, StkFloat value)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Clarinet.html#a63582205ab940101f5f9419fc717ff78">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/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4cd08bca954ad434bc636eda957ca8d5"></a><!-- doxytag: member="stk::Clarinet::tick" ref="a4cd08bca954ad434bc636eda957ca8d5" args="(unsigned int channel=0)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Clarinet.html#a4cd08bca954ad434bc636eda957ca8d5">tick</a> (unsigned int channel=0)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute and return one output sample. <br/></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>STK clarinet physical model class. </p>
|
|
<p>This class implements a simple clarinet physical model, as discussed by Smith (1986), McIntyre, Schumacher, Woodhouse (1983), and others.</p>
|
|
<p>This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others.</p>
|
|
<p>Control Change Numbers:</p>
|
|
<ul>
|
|
<li>Reed Stiffness = 2</li>
|
|
<li><a class="el" href="classstk_1_1Noise.html" title="STK noise generator.">Noise</a> Gain = 4</li>
|
|
<li>Vibrato Frequency = 11</li>
|
|
<li>Vibrato Gain = 1</li>
|
|
<li>Breath Pressure = 128</li>
|
|
</ul>
|
|
<p>by Perry R. Cook and Gary P. Scavone, 1995 - 2010. </p>
|
|
<hr/><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a82e32a30e6d9664ac9fe748070bec23c"></a><!-- doxytag: member="stk::Clarinet::Clarinet" ref="a82e32a30e6d9664ac9fe748070bec23c" args="(StkFloat lowestFrequency)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">stk::Clarinet::Clarinet </td>
|
|
<td>(</td>
|
|
<td class="paramtype">StkFloat </td>
|
|
<td class="paramname"> <em>lowestFrequency</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Class constructor, taking the lowest desired playing frequency. </p>
|
|
<p>An <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> will be thrown if the rawwave path is incorrectly set. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Clarinet_8h_source.html">Clarinet.h</a></li>
|
|
</ul>
|
|
</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-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|