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

Release 4.2.0 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:39:37 +02:00
committed by Stephen Sinclair
parent fe20fe92a2
commit de344668dd
347 changed files with 16972 additions and 8538 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
doc/html/classSingWave.html
View File

@@ -9,20 +9,26 @@
<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>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>
<h1>SingWave Class Reference</h1><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>
<map name="SingWave_map">
<area href="classGenerator.html" alt="Generator" shape="rect" coords="0,56,69,80">
<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>
<a href="classSingWave-members.html">List of all members.</a><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 - 2004.
<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>
<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="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>
@@ -38,35 +44,35 @@ void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classS
<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>
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> (MY_FLOAT frequency)</td></tr>
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> (MY_FLOAT aRate)</td></tr>
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> (MY_FLOAT gain)</td></tr>
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> (MY_FLOAT gain)</td></tr>
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> (MY_FLOAT aRate)</td></tr>
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> (MY_FLOAT aRate)</td></tr>
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> (MY_FLOAT target)</td></tr>
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>
@@ -77,24 +83,19 @@ void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classS
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="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>
</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>
<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>
<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>
<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>
</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">
<tr>
@@ -103,14 +104,14 @@ Definition at line <a class="el" href="SingWave_8h-source.html#l00023">23</a> of
<tr>
<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="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>bool&nbsp;</td>
<td class="mdname" nowrap> <em>raw</em> = FALSE</td>
<td class="mdname" nowrap> <em>raw</em> = false</td>
</tr>
<tr>
<td></td>
@@ -132,7 +133,50 @@ Definition at line <a class="el" href="SingWave_8h-source.html#l00023">23</a> of
<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>
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>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
@@ -140,7 +184,7 @@ An <a class="el" href="classStkError.html">StkError</a> will be thrown if the fi
<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><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>
</table>