e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-18 07:01:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.1.2 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:37:27 +02:00
committed by Stephen Sinclair
parent d12ef806ac
commit 5d63b50e85
436 changed files with 17966 additions and 14506 deletions
Download Patch File Download Diff File Expand all files Collapse all files

163
doc/html/classSingWave.html
View File

@@ -5,96 +5,117 @@
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
<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.2.8.1 -->
<h1>SingWave Class Reference</h1>STK "singing" looped soundfile class.
<!-- Generated by Doxygen 1.3.6 -->
<h1>SingWave Class Reference</h1>STK "singing" looped soundfile class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="SingWave_8h-source.html">SingWave.h</a>&gt;</code>
<p>
<p>Inheritance diagram for SingWave::
<p><center><img src="classSingWave.gif" usemap="#SingWave_map" border="0"></center>
<p>Inheritance diagram for SingWave:
<p><center><img src="classSingWave.png" usemap="#SingWave_map" border="0" alt=""></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>&nbsp;</td><td valign=bottom><a class="el" href="classSingWave.html#a0">SingWave</a> (const char *fileName, bool raw=FALSE)</td></tr>
<tr><td>&nbsp;</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>
&nbsp;</td><td valign=bottom><a class="el" href="classSingWave.html#a1">~SingWave</a> ()</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classSingWave.html#a2">reset</a> ()</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classSingWave.html#a3">normalize</a> ()</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classSingWave.html#a4">normalize</a> (MY_FLOAT peak)</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classSingWave.html#a5">setFrequency</a> (MY_FLOAT frequency)</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classSingWave.html#a6">setVibratoRate</a> (MY_FLOAT aRate)</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classSingWave.html#a7">setVibratoGain</a> (MY_FLOAT gain)</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classSingWave.html#a8">setRandomGain</a> (MY_FLOAT gain)</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classSingWave.html#a9">setSweepRate</a> (MY_FLOAT aRate)</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classSingWave.html#a10">setGainRate</a> (MY_FLOAT aRate)</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classSingWave.html#a11">setGainTarget</a> (MY_FLOAT target)</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classSingWave.html#a12">noteOn</a> ()</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classSingWave.html#a13">noteOff</a> ()</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classSingWave.html#a14">lastOut</a> ()</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classSingWave.html#a15">tick</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Compute one output sample.</em></font><br><br></td></tr>
<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>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSingWave.html#a0">SingWave</a> (const char *fileName, bool raw=FALSE)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor taking filename argument. <a href="#a0"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="SingWave::~SingWave" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSingWave.html#a1">~SingWave</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="SingWave::reset" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSingWave.html#a2">reset</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset file to beginning. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="SingWave::normalize" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSingWave.html#a3">normalize</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Normalize the file to a maximum of +-1.0. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="SingWave::normalize" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSingWave.html#a4">normalize</a> (MY_FLOAT peak)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Normalize the file to a maximum of <em>+-</em> peak. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="SingWave::setFrequency" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSingWave.html#a5">setFrequency</a> (MY_FLOAT frequency)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set instrument parameters for a particular frequency. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="SingWave::setVibratoRate" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSingWave.html#a6">setVibratoRate</a> (MY_FLOAT aRate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the vibrato frequency in Hz. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a7" doxytag="SingWave::setVibratoGain" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSingWave.html#a7">setVibratoGain</a> (MY_FLOAT gain)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the vibrato gain. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a8" doxytag="SingWave::setRandomGain" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSingWave.html#a8">setRandomGain</a> (MY_FLOAT gain)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the random-ness amount. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a9" doxytag="SingWave::setSweepRate" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSingWave.html#a9">setSweepRate</a> (MY_FLOAT aRate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the sweep rate. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a10" doxytag="SingWave::setGainRate" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSingWave.html#a10">setGainRate</a> (MY_FLOAT aRate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the gain rate. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a11" doxytag="SingWave::setGainTarget" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSingWave.html#a11">setGainTarget</a> (MY_FLOAT target)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the gain target value. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a12" doxytag="SingWave::noteOn" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSingWave.html#a12">noteOn</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start a note. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a13" doxytag="SingWave::noteOff" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSingWave.html#a13">noteOff</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stop a note. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a14" doxytag="SingWave::lastOut" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSingWave.html#a14">lastOut</a> ()</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="a15" doxytag="SingWave::tick" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSingWave.html#a15">tick</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute one output sample. <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.
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 &amp; Destructor Documentation</h2>
<a name="a0" doxytag="SingWave::SingWave"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<p>
Definition at line <a class="el" href="SingWave_8h-source.html#l00023">23</a> of file <a class="el" href="SingWave_8h-source.html">SingWave.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="SingWave::SingWave" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="md">
<td class="mdRow">
<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>
<td class="md" nowrap valign="top"> SingWave::SingWave </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const char *&nbsp;</td>
<td class="mdname" nowrap> <em>fileName</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool&nbsp;</td>
<td class="mdname" nowrap> <em>raw</em> = FALSE</td>
</tr>
<tr>
<td></td>
<td><b>
bool <em>raw</em> = FALSE&nbsp;)
</b></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
@@ -109,7 +130,7 @@ bool <em>raw</em> = FALSE&nbsp;)
<td>
<p>
Class constructor taking filename argument.
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>
@@ -120,7 +141,7 @@ An <a class="el" href="classStkError.html">StkError</a> will be thrown if the fi
<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-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>