mirror of
https://github.com/thestk/stk
synced 2026-04-20 14:36:55 +00:00
Release 4.4.3 tarball
This commit is contained in:
Gary Scavone
committed by
Stephen Sinclair
Stephen Sinclair
parent
cfdfe7736a
commit
f13d5bb3cd
@@ -32,8 +32,8 @@ Inheritance diagram for stk::Clarinet:</div>
|
||||
<p><a href="classstk_1_1Clarinet-members.html">List of all members.</a></p>
|
||||
<table border="0" cellpadding="0" cellspacing="0">
|
||||
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Clarinet.html#a82e32a30e6d9664ac9fe748070bec23c">Clarinet</a> (StkFloat lowestFrequency)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor, taking the lowest desired playing frequency. <a href="#a82e32a30e6d9664ac9fe748070bec23c"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Clarinet.html#aad5cf9fb562ee87f2dc0aed0b4cd6c5b">Clarinet</a> (StkFloat lowestFrequency=8.0)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor, taking the lowest desired playing frequency. <a href="#aad5cf9fb562ee87f2dc0aed0b4cd6c5b"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5166db9f4cf180fa189ba2e135affe34"></a><!-- doxytag: member="stk::Clarinet::~Clarinet" ref="a5166db9f4cf180fa189ba2e135affe34" args="(void)" -->
|
||||
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Clarinet.html#a5166db9f4cf180fa189ba2e135affe34">~Clarinet</a> (void)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br/></td></tr>
|
||||
@@ -61,6 +61,8 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="clas
|
||||
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4cd08bca954ad434bc636eda957ca8d5"></a><!-- doxytag: member="stk::Clarinet::tick" ref="a4cd08bca954ad434bc636eda957ca8d5" args="(unsigned int channel=0)" -->
|
||||
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Clarinet.html#a4cd08bca954ad434bc636eda957ca8d5">tick</a> (unsigned int channel=0)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute and return one output sample. <br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Clarinet.html#a059174eb1ab84e306bfad1d8b5833548">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &frames, unsigned int channel=0)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fill a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object with computed outputs. <a href="#a059174eb1ab84e306bfad1d8b5833548"></a><br/></td></tr>
|
||||
</table>
|
||||
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
||||
<p>STK clarinet physical model class. </p>
|
||||
@@ -74,9 +76,9 @@ StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="
|
||||
<li>Vibrato Gain = 1</li>
|
||||
<li>Breath Pressure = 128</li>
|
||||
</ul>
|
||||
<p>by Perry R. Cook and Gary P. Scavone, 1995 - 2010. </p>
|
||||
<p>by Perry R. Cook and Gary P. Scavone, 1995-2011. </p>
|
||||
<hr/><h2>Constructor & Destructor Documentation</h2>
|
||||
<a class="anchor" id="a82e32a30e6d9664ac9fe748070bec23c"></a><!-- doxytag: member="stk::Clarinet::Clarinet" ref="a82e32a30e6d9664ac9fe748070bec23c" args="(StkFloat lowestFrequency)" -->
|
||||
<a class="anchor" id="aad5cf9fb562ee87f2dc0aed0b4cd6c5b"></a><!-- doxytag: member="stk::Clarinet::Clarinet" ref="aad5cf9fb562ee87f2dc0aed0b4cd6c5b" args="(StkFloat lowestFrequency=8.0)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
@@ -84,7 +86,7 @@ StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="
|
||||
<td class="memname">stk::Clarinet::Clarinet </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">StkFloat </td>
|
||||
<td class="paramname"> <em>lowestFrequency</em></td>
|
||||
<td class="paramname"> <em>lowestFrequency</em> = <code>8.0</code></td>
|
||||
<td> ) </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
@@ -95,6 +97,66 @@ StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="
|
||||
<p>Class constructor, taking the lowest desired playing frequency. </p>
|
||||
<p>An <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> will be thrown if the rawwave path is incorrectly set. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/><h2>Member Function Documentation</h2>
|
||||
<a class="anchor" id="a059174eb1ab84e306bfad1d8b5833548"></a><!-- doxytag: member="stk::Clarinet::tick" ref="a059174eb1ab84e306bfad1d8b5833548" args="(StkFrames &frames, unsigned int channel=0)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & stk::Clarinet::tick </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td>
|
||||
<td class="paramname"> <em>frames</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">unsigned int </td>
|
||||
<td class="paramname"> <em>channel</em> = <code>0</code></td><td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td><td><code> [inline, virtual]</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Fill a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object with computed outputs. </p>
|
||||
<p>The <code>channel</code> argument must be less than the number of channels in the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception. </p>
|
||||
|
||||
<p>Implements <a class="el" href="classstk_1_1Instrmnt.html#a34c6733ca145763462d9e44ae3c772b6">stk::Instrmnt</a>.</p>
|
||||
|
||||
<p><div class="fragment"><pre class="fragment"><a name="l00124"></a>00124 {
|
||||
<a name="l00125"></a>00125 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels = lastFrame_.channels();
|
||||
<a name="l00126"></a>00126 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
|
||||
<a name="l00127"></a>00127 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel > frames.channels() - nChannels ) {
|
||||
<a name="l00128"></a>00128 oStream_ << <span class="stringliteral">"Clarinet::tick(): channel and StkFrames arguments are incompatible!"</span>;
|
||||
<a name="l00129"></a>00129 <a class="code" href="classstk_1_1Stk.html#a48ac73a0d8ca28445ba1a054e1f061ff" title="Static function for error reporting and handling using c-strings.">handleError</a>( StkError::FUNCTION_ARGUMENT );
|
||||
<a name="l00130"></a>00130 }
|
||||
<a name="l00131"></a>00131 <span class="preprocessor">#endif</span>
|
||||
<a name="l00132"></a>00132 <span class="preprocessor"></span>
|
||||
<a name="l00133"></a>00133 StkFloat *samples = &frames[channel];
|
||||
<a name="l00134"></a>00134 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> j, hop = frames.channels() - nChannels;
|
||||
<a name="l00135"></a>00135 <span class="keywordflow">if</span> ( nChannels == 1 ) {
|
||||
<a name="l00136"></a>00136 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i<frames.frames(); i++, samples += hop )
|
||||
<a name="l00137"></a>00137 *samples++ = <a class="code" href="classstk_1_1Clarinet.html#a4cd08bca954ad434bc636eda957ca8d5" title="Compute and return one output sample.">tick</a>();
|
||||
<a name="l00138"></a>00138 }
|
||||
<a name="l00139"></a>00139 <span class="keywordflow">else</span> {
|
||||
<a name="l00140"></a>00140 <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i<frames.frames(); i++, samples += hop ) {
|
||||
<a name="l00141"></a>00141 *samples++ = <a class="code" href="classstk_1_1Clarinet.html#a4cd08bca954ad434bc636eda957ca8d5" title="Compute and return one output sample.">tick</a>();
|
||||
<a name="l00142"></a>00142 <span class="keywordflow">for</span> ( j=1; j<nChannels; j++ )
|
||||
<a name="l00143"></a>00143 *samples++ = lastFrame_[j];
|
||||
<a name="l00144"></a>00144 }
|
||||
<a name="l00145"></a>00145 }
|
||||
<a name="l00146"></a>00146
|
||||
<a name="l00147"></a>00147 <span class="keywordflow">return</span> frames;
|
||||
<a name="l00148"></a>00148 }
|
||||
</pre></div></p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/>The documentation for this class was generated from the following file:<ul>
|
||||
@@ -105,7 +167,7 @@ StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="
|
||||
|
||||
<table>
|
||||
<tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
|
||||
<tr><td>©1995-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
<tr><td>©1995-2011 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
</table>
|
||||
|
||||
</BODY>
|
||||
|
||||
Reference in New Issue
Block a user