Files
stk/doc/html/classPitShift.html
2013-09-29 23:38:16 +02:00

77 lines
5.2 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"> &nbsp; <img src="ccrma.gif"> &nbsp; <img src="mcgill.gif"><P>
<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.3.4 -->
<h1>PitShift Class Reference</h1>STK simple pitch shifter effect class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PitShift_8h-source.html">PitShift.h</a>&gt;</code>
<p>
<p>Inheritance diagram for PitShift:
<p><center><img src="classPitShift.png" usemap="#PitShift_map" border="0" alt=""></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></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a0" doxytag="PitShift::PitShift" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPitShift.html#a0">PitShift</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="PitShift::~PitShift" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPitShift.html#a1">~PitShift</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a2" doxytag="PitShift::clear" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPitShift.html#a2">clear</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset and clear all internal state. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="PitShift::setShift" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPitShift.html#a3">setShift</a> (MY_FLOAT shift)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the pitch shift factor (1.0 produces no shift). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="PitShift::setEffectMix" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPitShift.html#a4">setEffectMix</a> (MY_FLOAT mix)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the mixture of input and processed levels in the output (0.0 = input only, 1.0 = processed only). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="PitShift::lastOut" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPitShift.html#a5">lastOut</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last output value. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="PitShift::tick" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPitShift.html#a6">tick</a> (MY_FLOAT input)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute one output sample. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a7" doxytag="PitShift::tick" ></a>
MY_FLOAT *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPitShift.html#a7">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Input <em>vectorSize</em> samples to the filter and return an equal number of outputs in <em>vector</em>. <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>
<p>
Definition at line <a class="el" href="PitShift_8h-source.html#l00018">18</a> of file <a class="el" href="PitShift_8h-source.html">PitShift.h</a>.<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>&copy;1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>