mirror of
https://github.com/thestk/stk
synced 2026-01-12 20:41:52 +00:00
128 lines
7.7 KiB
HTML
128 lines
7.7 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>SingWave Class Reference</h1>STK "singing" looped soundfile class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="SingWave_8h-source.html">SingWave.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for SingWave::
|
|
<p><center><img src="classSingWave.gif" usemap="#SingWave_map" border="0"></center>
|
|
<map name="SingWave_map">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,69,24">
|
|
</map>
|
|
<a href="classSingWave-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> </td><td valign=bottom><a class="el" href="classSingWave.html#a0">SingWave</a> (const char *fileName, bool raw=FALSE)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Class constructor taking filename argument.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a1" doxytag="SingWave::~SingWave"></a>
|
|
</td><td valign=bottom><a class="el" href="classSingWave.html#a1">~SingWave</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="SingWave::reset"></a>
|
|
void </td><td valign=bottom><a class="el" href="classSingWave.html#a2">reset</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Reset file to beginning.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a3" doxytag="SingWave::normalize"></a>
|
|
void </td><td valign=bottom><a class="el" href="classSingWave.html#a3">normalize</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Normalize the file to a maximum of +-1.0.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a4" doxytag="SingWave::normalize"></a>
|
|
void </td><td valign=bottom><a class="el" href="classSingWave.html#a4">normalize</a> (MY_FLOAT peak)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Normalize the file to a maximum of <em>+-</em> peak.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a5" doxytag="SingWave::setFrequency"></a>
|
|
void </td><td valign=bottom><a class="el" href="classSingWave.html#a5">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="a6" doxytag="SingWave::setVibratoRate"></a>
|
|
void </td><td valign=bottom><a class="el" href="classSingWave.html#a6">setVibratoRate</a> (MY_FLOAT aRate)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the vibrato frequency in Hz.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a7" doxytag="SingWave::setVibratoGain"></a>
|
|
void </td><td valign=bottom><a class="el" href="classSingWave.html#a7">setVibratoGain</a> (MY_FLOAT gain)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the vibrato gain.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a8" doxytag="SingWave::setRandomGain"></a>
|
|
void </td><td valign=bottom><a class="el" href="classSingWave.html#a8">setRandomGain</a> (MY_FLOAT gain)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the random-ness amount.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a9" doxytag="SingWave::setSweepRate"></a>
|
|
void </td><td valign=bottom><a class="el" href="classSingWave.html#a9">setSweepRate</a> (MY_FLOAT aRate)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the sweep rate.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a10" doxytag="SingWave::setGainRate"></a>
|
|
void </td><td valign=bottom><a class="el" href="classSingWave.html#a10">setGainRate</a> (MY_FLOAT aRate)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the gain rate.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a11" doxytag="SingWave::setGainTarget"></a>
|
|
void </td><td valign=bottom><a class="el" href="classSingWave.html#a11">setGainTarget</a> (MY_FLOAT target)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the gain target value.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a12" doxytag="SingWave::noteOn"></a>
|
|
void </td><td valign=bottom><a class="el" href="classSingWave.html#a12">noteOn</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Start a note.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a13" doxytag="SingWave::noteOff"></a>
|
|
void </td><td valign=bottom><a class="el" href="classSingWave.html#a13">noteOff</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Stop a note.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a14" doxytag="SingWave::lastOut"></a>
|
|
MY_FLOAT </td><td valign=bottom><a class="el" href="classSingWave.html#a14">lastOut</a> ()</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="a15" doxytag="SingWave::tick"></a>
|
|
MY_FLOAT </td><td valign=bottom><a class="el" href="classSingWave.html#a15">tick</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Compute one output sample.</em></font><br><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK "singing" looped soundfile class.
|
|
<p>
|
|
This class contains all that is needed to make a pitched musical sound, like a simple voice or violin. In general, it will not be used alone because of munchkinification effects from pitch shifting. It will be used as an excitation source for other instruments.
|
|
<p>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
|
|
<p>
|
|
<hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a name="a0" doxytag="SingWave::SingWave"></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>
|
|
SingWave::SingWave (
|
|
</b></td>
|
|
<td valign="bottom"><b>
|
|
const char * <em>fileName</em>,
|
|
</b></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><b>
|
|
bool <em>raw</em> = FALSE )
|
|
</b></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Class constructor taking filename argument.
|
|
<p>
|
|
An <a class="el" href="classStkError.html">StkError</a> will be thrown if the file is not found, its format is unknown, or a read error occurs. </td>
|
|
</tr>
|
|
</table>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="SingWave_8h-source.html">SingWave.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>
|