mirror of
https://github.com/thestk/stk
synced 2026-01-13 04:51:53 +00:00
115 lines
7.0 KiB
HTML
115 lines
7.0 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>StifKarp Class Reference</h1>STK plucked stiff string instrument.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="StifKarp_8h-source.html">StifKarp.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for StifKarp::
|
|
<p><center><img src="classStifKarp.gif" usemap="#StifKarp_map" border="0"></center>
|
|
<map name="StifKarp_map">
|
|
<area href="classInstrmnt.html" alt="Instrmnt" shape="rect" coords="0,56,57,80">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,57,24">
|
|
</map>
|
|
<a href="classStifKarp-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="StifKarp::StifKarp"></a>
|
|
</td><td valign=bottom><a class="el" href="classStifKarp.html#a0">StifKarp</a> (MY_FLOAT lowestFrequency)</td></tr>
|
|
<tr><td> </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="StifKarp::~StifKarp"></a>
|
|
</td><td valign=bottom><a class="el" href="classStifKarp.html#a1">~StifKarp</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="StifKarp::clear"></a>
|
|
void </td><td valign=bottom><a class="el" href="classStifKarp.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="StifKarp::setFrequency"></a>
|
|
void </td><td valign=bottom><a class="el" href="classStifKarp.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="StifKarp::setStretch"></a>
|
|
void </td><td valign=bottom><a class="el" href="classStifKarp.html#a4">setStretch</a> (MY_FLOAT stretch)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the stretch "factor" of the string (0.0 - 1.0).</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a5" doxytag="StifKarp::setPickupPosition"></a>
|
|
void </td><td valign=bottom><a class="el" href="classStifKarp.html#a5">setPickupPosition</a> (MY_FLOAT position)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the pluck or "excitation" position along the string (0.0 - 1.0).</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classStifKarp.html#a6">setBaseLoopGain</a> (MY_FLOAT aGain)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the base loop gain.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a7" doxytag="StifKarp::pluck"></a>
|
|
void </td><td valign=bottom><a class="el" href="classStifKarp.html#a7">pluck</a> (MY_FLOAT amplitude)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Pluck the string with the given amplitude using the current frequency.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a8" doxytag="StifKarp::noteOn"></a>
|
|
void </td><td valign=bottom><a class="el" href="classStifKarp.html#a8">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="a9" doxytag="StifKarp::noteOff"></a>
|
|
void </td><td valign=bottom><a class="el" href="classStifKarp.html#a9">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="a10" doxytag="StifKarp::tick"></a>
|
|
MY_FLOAT </td><td valign=bottom><a class="el" href="classStifKarp.html#a10">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="a11" doxytag="StifKarp::controlChange"></a>
|
|
void </td><td valign=bottom><a class="el" href="classStifKarp.html#a11">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 plucked stiff string instrument.
|
|
<p>
|
|
This class implements a simple plucked string algorithm (Karplus Strong) with enhancements (Jaffe-Smith, Smith, and others), including string stiffness and pluck position controls. The stiffness is modeled with allpass filters.
|
|
<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>Pickup Position = 4<li>String Sustain = 11<li>String Stretch = 1</ul>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
|
|
<p>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a name="a6" doxytag="StifKarp::setBaseLoopGain"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td nowrap valign="top"><b>
|
|
void StifKarp::setBaseLoopGain (
|
|
</b></td>
|
|
<td valign="bottom"><b>
|
|
MY_FLOAT <em>aGain</em> )
|
|
</b></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Set the base loop gain.
|
|
<p>
|
|
The actual loop gain is set according to the frequency. Because of high-frequency loop filter roll-off, higher frequency settings have greater loop gains. </td>
|
|
</tr>
|
|
</table>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="StifKarp_8h-source.html">StifKarp.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>
|