mirror of
https://github.com/thestk/stk
synced 2026-01-13 04:51:53 +00:00
81 lines
6.5 KiB
HTML
81 lines
6.5 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="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.2.8.1 -->
|
|
<h1>Saxofony Class Reference</h1>STK faux conical bore reed instrument class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="Saxofony_8h-source.html">Saxofony.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for Saxofony::
|
|
<p><center><img src="classSaxofony.gif" usemap="#Saxofony_map" border="0"></center>
|
|
<map name="Saxofony_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="classSaxofony-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="Saxofony::Saxofony"></a>
|
|
</td><td valign=bottom><a class="el" href="classSaxofony.html#a0">Saxofony</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="Saxofony::~Saxofony"></a>
|
|
</td><td valign=bottom><a class="el" href="classSaxofony.html#a1">~Saxofony</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="Saxofony::clear"></a>
|
|
void </td><td valign=bottom><a class="el" href="classSaxofony.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="Saxofony::setFrequency"></a>
|
|
void </td><td valign=bottom><a class="el" href="classSaxofony.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="Saxofony::setBlowPosition"></a>
|
|
void </td><td valign=bottom><a class="el" href="classSaxofony.html#a4">setBlowPosition</a> (MY_FLOAT aPosition)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the "blowing" position between the air column terminations (0.0 - 1.0).</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a5" doxytag="Saxofony::startBlowing"></a>
|
|
void </td><td valign=bottom><a class="el" href="classSaxofony.html#a5">startBlowing</a> (MY_FLOAT amplitude, MY_FLOAT rate)</td></tr>
|
|
<tr><td> </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="a6" doxytag="Saxofony::stopBlowing"></a>
|
|
void </td><td valign=bottom><a class="el" href="classSaxofony.html#a6">stopBlowing</a> (MY_FLOAT rate)</td></tr>
|
|
<tr><td> </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="a7" doxytag="Saxofony::noteOn"></a>
|
|
void </td><td valign=bottom><a class="el" href="classSaxofony.html#a7">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="a8" doxytag="Saxofony::noteOff"></a>
|
|
void </td><td valign=bottom><a class="el" href="classSaxofony.html#a8">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="a9" doxytag="Saxofony::tick"></a>
|
|
MY_FLOAT </td><td valign=bottom><a class="el" href="classSaxofony.html#a9">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="a10" doxytag="Saxofony::controlChange"></a>
|
|
void </td><td valign=bottom><a class="el" href="classSaxofony.html#a10">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 faux conical bore reed instrument class.
|
|
<p>
|
|
This class implements a "hybrid" digital waveguide instrument that can generate a variety of wind-like sounds. It has also been referred to as the "blowed string" model. The waveguide section is essentially that of a string, with one rigid and one lossy termination. The non-linear function is a reed table. The string can be "blown" at any point between the terminations, though just as with strings, it is impossible to excite the system at either end. If the excitation is placed at the string mid-point, the sound is that of a clarinet. At points closer to the "bridge", the sound is closer to that of a saxophone. See Scavone (2002) for more details.
|
|
<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>Reed Aperture = 26<li><a class="el" href="classNoise.html">Noise</a> Gain = 4<li>Blow Position = 11<li>Vibrato Frequency = 29<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>
|
|
<li><a class="el" href="Saxofony_8h-source.html">Saxofony.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>
|