mirror of
https://github.com/thestk/stk
synced 2026-01-13 04:51:53 +00:00
67 lines
4.4 KiB
HTML
67 lines
4.4 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>PitShift Class Reference</h1>STK simple pitch shifter effect class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="PitShift_8h-source.html">PitShift.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for PitShift::
|
|
<p><center><img src="classPitShift.gif" usemap="#PitShift_map" border="0"></center>
|
|
<map name="PitShift_map">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,51,24">
|
|
</map>
|
|
<a href="classPitShift-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="PitShift::PitShift"></a>
|
|
</td><td valign=bottom><a class="el" href="classPitShift.html#a0">PitShift</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Class constructor.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a1" doxytag="PitShift::~PitShift"></a>
|
|
</td><td valign=bottom><a class="el" href="classPitShift.html#a1">~PitShift</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="PitShift::clear"></a>
|
|
void </td><td valign=bottom><a class="el" href="classPitShift.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="PitShift::setShift"></a>
|
|
void </td><td valign=bottom><a class="el" href="classPitShift.html#a3">setShift</a> (MY_FLOAT shift)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the pitch shift factor (1.0 produces no shift).</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a4" doxytag="PitShift::setEffectMix"></a>
|
|
void </td><td valign=bottom><a class="el" href="classPitShift.html#a4">setEffectMix</a> (MY_FLOAT mix)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the mixture of input and processed levels in the output (0.0 = input only, 1.0 = processed only).</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a5" doxytag="PitShift::lastOut"></a>
|
|
MY_FLOAT </td><td valign=bottom><a class="el" href="classPitShift.html#a5">lastOut</a> () const</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Return the last output value.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a6" doxytag="PitShift::tick"></a>
|
|
MY_FLOAT </td><td valign=bottom><a class="el" href="classPitShift.html#a6">tick</a> (MY_FLOAT input)</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="a7" doxytag="PitShift::tick"></a>
|
|
MY_FLOAT* </td><td valign=bottom><a class="el" href="classPitShift.html#a7">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 simple pitch shifter effect class.
|
|
<p>
|
|
This class implements a simple pitch shifter using delay lines.
|
|
<p>
|
|
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="PitShift_8h-source.html">PitShift.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>
|