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

Release 4.2.1 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:40:35 +02:00
committed by Stephen Sinclair
parent 11cf5faa0a
commit 21b93795e7
1041 changed files with 23984 additions and 16348 deletions
Download Patch File Download Diff File Expand all files Collapse all files

169
doc/html/classSingWave.html
View File

@@ -8,8 +8,8 @@
<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>SingWave Class Reference</h1><code>#include &lt;<a class="el" href="SingWave_8h-source.html">SingWave.h</a>&gt;</code>
<!-- Generated by Doxygen 1.4.4 -->
<h1>SingWave Class Reference</h1><!-- doxytag: class="SingWave" --><!-- doxytag: inherits="Generator" --><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.png" usemap="#SingWave_map" border="0" alt=""></center>
@@ -21,109 +21,95 @@
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 - 2004.
by Perry R. Cook and Gary P. Scavone, 1995 - 2005.
<p>
<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>.<table border=0 cellpadding=0 cellspacing=0>
<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>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSingWave.html#a0">SingWave</a> (std::string fileName, bool raw=false)</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> (std::string fileName, bool raw=false)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor taking filename argument. </em> <a href="#a0"></a><em><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 constructor taking filename argument. <a href="#a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="SingWave::~SingWave" ref="a1" args="()" -->
&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">Class destructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2"></a><!-- doxytag: member="SingWave::reset" ref="a2" args="()" -->
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">Reset file to beginning. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="SingWave::normalize" ref="a3" args="()" -->
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> (StkFloat peak)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Normalize the file to a maximum of +-1.0. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4"></a><!-- doxytag: member="SingWave::normalize" ref="a4" args="(StkFloat peak)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSingWave.html#a4">normalize</a> (StkFloat 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> (StkFloat frequency)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Normalize the file to a maximum of <em>+-</em> peak. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5"></a><!-- doxytag: member="SingWave::setFrequency" ref="a5" args="(StkFloat frequency)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSingWave.html#a5">setFrequency</a> (StkFloat 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> (StkFloat rate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set instrument parameters for a particular frequency. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6"></a><!-- doxytag: member="SingWave::setVibratoRate" ref="a6" args="(StkFloat rate)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSingWave.html#a6">setVibratoRate</a> (StkFloat rate)</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> (StkFloat gain)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the vibrato frequency in Hz. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7"></a><!-- doxytag: member="SingWave::setVibratoGain" ref="a7" args="(StkFloat gain)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSingWave.html#a7">setVibratoGain</a> (StkFloat 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> (StkFloat gain)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the vibrato gain. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8"></a><!-- doxytag: member="SingWave::setRandomGain" ref="a8" args="(StkFloat gain)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSingWave.html#a8">setRandomGain</a> (StkFloat 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> (StkFloat rate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the random-ness amount. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9"></a><!-- doxytag: member="SingWave::setSweepRate" ref="a9" args="(StkFloat rate)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSingWave.html#a9">setSweepRate</a> (StkFloat rate)</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> (StkFloat rate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the sweep rate. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a10"></a><!-- doxytag: member="SingWave::setGainRate" ref="a10" args="(StkFloat rate)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSingWave.html#a10">setGainRate</a> (StkFloat rate)</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> (StkFloat target)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the gain rate. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a11"></a><!-- doxytag: member="SingWave::setGainTarget" ref="a11" args="(StkFloat target)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSingWave.html#a11">setGainTarget</a> (StkFloat 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">Set the gain target value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a12"></a><!-- doxytag: member="SingWave::noteOn" ref="a12" args="()" -->
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">Start a note. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a13"></a><!-- doxytag: member="SingWave::noteOff" ref="a13" args="()" -->
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::tick" ></a>
StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSingWave.html#a14">tick</a> ()</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="a15" doxytag="SingWave::tick" ></a>
StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSingWave.html#a15">tick</a> (StkFloat *vector, unsigned int vectorSize)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute <em>vectorSize</em> outputs and return them in <em>vector</em>. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSingWave.html#a16">tick</a> (<a class="el" href="classStkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fill a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object with computed outputs. </em> <a href="#a16"></a><em><br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stop a note. <br></td></tr>
</table>
<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">
<a class="anchor" name="a0"></a><!-- doxytag: member="SingWave::SingWave" ref="a0" args="(std::string fileName, bool raw=false)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> SingWave::SingWave </td>
<td class="md" nowrap valign="top">SingWave::SingWave </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">std::string&nbsp;</td>
<td class="mdname" nowrap> <em>fileName</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>bool&nbsp;</td>
<td class="mdname" nowrap> <em>raw</em> = false</td>
<td class="mdname" nowrap> <em>raw</em> = <code>false</code></td>
</tr>
<tr>
<td></td>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
@@ -133,50 +119,7 @@ StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="
<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, a read error occurs, or the rawwave path is incorrectly set. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a16" doxytag="SingWave::tick" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classStkFrames.html">StkFrames</a>&amp; SingWave::tick </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td>
<td class="mdname" nowrap> <em>frames</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>channel</em> = 1</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Fill a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object with computed outputs.
<p>
The <code>channel</code> argument should be one or greater (the first channel is specified by 1). An <a class="el" href="classStkError.html">StkError</a> will be thrown if the <code>channel</code> argument is zero or it is greater than the number of channels in the <a class="el" href="classStkFrames.html">StkFrames</a> object.
<p>
Reimplemented from <a class="el" href="classGenerator.html#a5">Generator</a>. </td>
An <a class="el" href="classStkError.html">StkError</a> will be thrown if the file is not found, its format is unknown, a read error occurs, or the rawwave path is incorrectly set. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
@@ -185,7 +128,7 @@ Reimplemented from <a class="el" href="classGenerator.html#a5">Generator</a>.
<table>
<tr><td><A HREF="http://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>
<tr><td>&copy;1995-2005 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>