mirror of
https://github.com/thestk/stk
synced 2026-01-17 06:41:51 +00:00
Release 4.0 tarball
This commit is contained in:
Gary Scavone
committed by
Stephen Sinclair
Stephen Sinclair
parent
81475b04c5
commit
43dcd5775a
168
doc/html/classFormSwep.html
Normal file
168
doc/html/classFormSwep.html
Normal file
@@ -0,0 +1,168 @@
|
||||
<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>FormSwep Class Reference</h1>STK sweepable formant filter class.
|
||||
<a href="#_details">More...</a>
|
||||
<p>
|
||||
<code>#include <<a class="el" href="FormSwep_8h-source.html">FormSwep.h</a>></code>
|
||||
<p>
|
||||
<p>Inheritance diagram for FormSwep::
|
||||
<p><center><img src="classFormSwep.gif" usemap="#FormSwep_map" border="0"></center>
|
||||
<map name="FormSwep_map">
|
||||
<area href="classBiQuad.html" alt="BiQuad" shape="rect" coords="0,112,72,136">
|
||||
<area href="classFilter.html" alt="Filter" shape="rect" coords="0,56,72,80">
|
||||
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,72,24">
|
||||
</map>
|
||||
<a href="classFormSwep-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="FormSwep::FormSwep"></a>
|
||||
</td><td valign=bottom><a class="el" href="classFormSwep.html#a0">FormSwep</a> ()</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Default constructor creates a second-order pass-through filter.</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a1" doxytag="FormSwep::~FormSwep"></a>
|
||||
</td><td valign=bottom><a class="el" href="classFormSwep.html#a1">~FormSwep</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>void </td><td valign=bottom><a class="el" href="classFormSwep.html#a2">setResonance</a> (MY_FLOAT aFrequency, MY_FLOAT aRadius)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Sets the filter coefficients for a resonance at <em>frequency</em> (in Hz).</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a3" doxytag="FormSwep::setStates"></a>
|
||||
void </td><td valign=bottom><a class="el" href="classFormSwep.html#a3">setStates</a> (MY_FLOAT aFrequency, MY_FLOAT aRadius, MY_FLOAT aGain=1.0)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Set both the current and target resonance parameters.</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a4" doxytag="FormSwep::setTargets"></a>
|
||||
void </td><td valign=bottom><a class="el" href="classFormSwep.html#a4">setTargets</a> (MY_FLOAT aFrequency, MY_FLOAT aRadius, MY_FLOAT aGain=1.0)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Set target resonance parameters.</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classFormSwep.html#a5">setSweepRate</a> (MY_FLOAT aRate)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Set the sweep rate (between 0.0 - 1.0).</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classFormSwep.html#a6">setSweepTime</a> (MY_FLOAT aTime)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Set the sweep rate in terms of a time value in seconds.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a7" doxytag="FormSwep::tick"></a>
|
||||
MY_FLOAT </td><td valign=bottom><a class="el" href="classFormSwep.html#a7">tick</a> (MY_FLOAT sample)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Input one sample to the filter and return one output.</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a8" doxytag="FormSwep::tick"></a>
|
||||
MY_FLOAT* </td><td valign=bottom><a class="el" href="classFormSwep.html#a8">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Input <em>vectorSize</em> samples to the filter and return an equal number of outputs in <em>vector</em>.</em></font><br><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
STK sweepable formant filter class.
|
||||
<p>
|
||||
This public <a class="el" href="classBiQuad.html">BiQuad</a> filter subclass implements a formant (resonance) which can be "swept" over time from one frequency setting to another. It provides methods for controlling the sweep rate and target frequency.
|
||||
<p>
|
||||
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
|
||||
<p>
|
||||
<hr><h2>Member Function Documentation</h2>
|
||||
<a name="a2" doxytag="FormSwep::setResonance"></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 FormSwep::setResonance (
|
||||
</b></td>
|
||||
<td valign="bottom"><b>
|
||||
MY_FLOAT <em>aFrequency</em>,
|
||||
</b></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td><b>
|
||||
MY_FLOAT <em>aRadius</em> )
|
||||
</b></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
Sets the filter coefficients for a resonance at <em>frequency</em> (in Hz).
|
||||
<p>
|
||||
This method determines the filter coefficients corresponding to two complex-conjugate poles with the given <em>frequency</em> (in Hz) and <em>radius</em> from the z-plane origin. The filter zeros are placed at z = 1, z = -1, and the coefficients are then normalized to produce a constant unity gain (independent of the filter <em>gain</em> parameter). The resulting filter frequency response has a resonance at the given <em>frequency</em>. The closer the poles are to the unit-circle (<em>radius</em> close to one), the narrower the resulting resonance width. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<a name="a5" doxytag="FormSwep::setSweepRate"></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 FormSwep::setSweepRate (
|
||||
</b></td>
|
||||
<td valign="bottom"><b>
|
||||
MY_FLOAT <em>aRate</em> )
|
||||
</b></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
Set the sweep rate (between 0.0 - 1.0).
|
||||
<p>
|
||||
The formant parameters are varied in increments of the sweep rate between their current and target values. A sweep rate of 1.0 will produce an immediate change in resonance parameters from their current values to the target values. A sweep rate of 0.0 will produce no change in resonance parameters. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<a name="a6" doxytag="FormSwep::setSweepTime"></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 FormSwep::setSweepTime (
|
||||
</b></td>
|
||||
<td valign="bottom"><b>
|
||||
MY_FLOAT <em>aTime</em> )
|
||||
</b></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
Set the sweep rate in terms of a time value in seconds.
|
||||
<p>
|
||||
This method adjusts the sweep rate based on a given time for the formant parameters to reach their target values. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<hr>The documentation for this class was generated from the following file:<ul>
|
||||
<li><a class="el" href="FormSwep_8h-source.html">FormSwep.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>
|
||||
Reference in New Issue
Block a user