mirror of
https://github.com/thestk/stk
synced 2026-01-17 06:41:51 +00:00
159 lines
14 KiB
HTML
159 lines
14 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"> <img src="mcgill.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="faq.html">FAQ</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.6.2 -->
|
|
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Bowed.html">Bowed</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::Bowed Class Reference</h1><!-- doxytag: class="stk::Bowed" --><!-- doxytag: inherits="stk::Instrmnt" -->
|
|
<p>STK bowed string instrument class.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="Bowed_8h_source.html">Bowed.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::Bowed:</div>
|
|
<div class="dynsection">
|
|
<div class="center">
|
|
<img src="classstk_1_1Bowed.png" usemap="#stk::Bowed_map" alt=""/>
|
|
<map id="stk::Bowed_map" name="stk::Bowed_map">
|
|
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,76,80"/>
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,76,24"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
|
|
<p><a href="classstk_1_1Bowed-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"><a class="anchor" id="a1b442f60bbec3d07d2dd322ff761c767"></a><!-- doxytag: member="stk::Bowed::Bowed" ref="a1b442f60bbec3d07d2dd322ff761c767" args="(StkFloat lowestFrequency=8.0)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Bowed.html#a1b442f60bbec3d07d2dd322ff761c767">Bowed</a> (StkFloat lowestFrequency=8.0)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor, taking the lowest desired playing frequency. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8067e4808bf7576922be4698f853c96c"></a><!-- doxytag: member="stk::Bowed::~Bowed" ref="a8067e4808bf7576922be4698f853c96c" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Bowed.html#a8067e4808bf7576922be4698f853c96c">~Bowed</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d522c36a35b86f90a06cf135fc83b11"></a><!-- doxytag: member="stk::Bowed::clear" ref="a8d522c36a35b86f90a06cf135fc83b11" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Bowed.html#a8d522c36a35b86f90a06cf135fc83b11">clear</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset and clear all internal state. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a02dbcfbd0766fee8a2e75a8df809e62c"></a><!-- doxytag: member="stk::Bowed::setFrequency" ref="a02dbcfbd0766fee8a2e75a8df809e62c" args="(StkFloat frequency)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Bowed.html#a02dbcfbd0766fee8a2e75a8df809e62c">setFrequency</a> (StkFloat frequency)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set instrument parameters for a particular frequency. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7cf229e206a61259d381cf153a1c5096"></a><!-- doxytag: member="stk::Bowed::setVibrato" ref="a7cf229e206a61259d381cf153a1c5096" args="(StkFloat gain)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Bowed.html#a7cf229e206a61259d381cf153a1c5096">setVibrato</a> (StkFloat gain)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set vibrato gain. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a519d511ddcc1cf23e897aeacdfe45020"></a><!-- doxytag: member="stk::Bowed::startBowing" ref="a519d511ddcc1cf23e897aeacdfe45020" args="(StkFloat amplitude, StkFloat rate)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Bowed.html#a519d511ddcc1cf23e897aeacdfe45020">startBowing</a> (StkFloat amplitude, StkFloat rate)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Apply breath pressure to instrument with given amplitude and rate of increase. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aae2a57d8e23536fd37a00af1fe07f21c"></a><!-- doxytag: member="stk::Bowed::stopBowing" ref="aae2a57d8e23536fd37a00af1fe07f21c" args="(StkFloat rate)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Bowed.html#aae2a57d8e23536fd37a00af1fe07f21c">stopBowing</a> (StkFloat rate)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrease breath pressure with given rate of decrease. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4ebaf6bd27d90975e7b0aea0ee727dc1"></a><!-- doxytag: member="stk::Bowed::noteOn" ref="a4ebaf6bd27d90975e7b0aea0ee727dc1" args="(StkFloat frequency, StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Bowed.html#a4ebaf6bd27d90975e7b0aea0ee727dc1">noteOn</a> (StkFloat frequency, StkFloat amplitude)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start a note with the given frequency and amplitude. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab86db568328b51e4adfae8b62987fc85"></a><!-- doxytag: member="stk::Bowed::noteOff" ref="ab86db568328b51e4adfae8b62987fc85" args="(StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Bowed.html#ab86db568328b51e4adfae8b62987fc85">noteOff</a> (StkFloat amplitude)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop a note with the given amplitude (speed of decay). <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad066af9bb1340b6fcf9002d6922021f4"></a><!-- doxytag: member="stk::Bowed::controlChange" ref="ad066af9bb1340b6fcf9002d6922021f4" args="(int number, StkFloat value)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Bowed.html#ad066af9bb1340b6fcf9002d6922021f4">controlChange</a> (int number, StkFloat value)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0). <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4d583369f0b22335fff8cee3ce6f2750"></a><!-- doxytag: member="stk::Bowed::tick" ref="a4d583369f0b22335fff8cee3ce6f2750" args="(unsigned int channel=0)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Bowed.html#a4d583369f0b22335fff8cee3ce6f2750">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_1Bowed.html#ab7985e95058016201d16f3717039e1cd">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="#ab7985e95058016201d16f3717039e1cd"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>STK bowed string instrument class. </p>
|
|
<p>This class implements a bowed string model, a la Smith (1986), after McIntyre, Schumacher, Woodhouse (1983).</p>
|
|
<p>This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others.</p>
|
|
<p>Control Change Numbers:</p>
|
|
<ul>
|
|
<li>Bow Pressure = 2</li>
|
|
<li>Bow Position = 4</li>
|
|
<li>Vibrato Frequency = 11</li>
|
|
<li>Vibrato Gain = 1</li>
|
|
<li>Bow Velocity = 100</li>
|
|
<li>Frequency = 101</li>
|
|
<li>Volume = 128</li>
|
|
</ul>
|
|
<p>by Perry R. Cook and Gary P. Scavone, 1995-2012. Contributions by Esteban Maestre, 2011. </p>
|
|
<hr/><h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="ab7985e95058016201d16f3717039e1cd"></a><!-- doxytag: member="stk::Bowed::tick" ref="ab7985e95058016201d16f3717039e1cd" 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::Bowed::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="l00129"></a>00129 {
|
|
<a name="l00130"></a>00130 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels = lastFrame_.channels();
|
|
<a name="l00131"></a>00131 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
|
|
<a name="l00132"></a>00132 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel > frames.channels() - nChannels ) {
|
|
<a name="l00133"></a>00133 oStream_ << <span class="stringliteral">"Bowed::tick(): channel and StkFrames arguments are incompatible!"</span>;
|
|
<a name="l00134"></a>00134 <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="l00135"></a>00135 }
|
|
<a name="l00136"></a>00136 <span class="preprocessor">#endif</span>
|
|
<a name="l00137"></a>00137 <span class="preprocessor"></span>
|
|
<a name="l00138"></a>00138 StkFloat *samples = &frames[channel];
|
|
<a name="l00139"></a>00139 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> j, hop = frames.channels() - nChannels;
|
|
<a name="l00140"></a>00140 <span class="keywordflow">if</span> ( nChannels == 1 ) {
|
|
<a name="l00141"></a>00141 <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="l00142"></a>00142 *samples++ = <a class="code" href="classstk_1_1Bowed.html#a4d583369f0b22335fff8cee3ce6f2750" title="Compute and return one output sample.">tick</a>();
|
|
<a name="l00143"></a>00143 }
|
|
<a name="l00144"></a>00144 <span class="keywordflow">else</span> {
|
|
<a name="l00145"></a>00145 <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="l00146"></a>00146 *samples++ = <a class="code" href="classstk_1_1Bowed.html#a4d583369f0b22335fff8cee3ce6f2750" title="Compute and return one output sample.">tick</a>();
|
|
<a name="l00147"></a>00147 <span class="keywordflow">for</span> ( j=1; j<nChannels; j++ )
|
|
<a name="l00148"></a>00148 *samples++ = lastFrame_[j];
|
|
<a name="l00149"></a>00149 }
|
|
<a name="l00150"></a>00150 }
|
|
<a name="l00151"></a>00151
|
|
<a name="l00152"></a>00152 <span class="keywordflow">return</span> frames;
|
|
<a name="l00153"></a>00153 }
|
|
</pre></div></p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Bowed_8h_source.html">Bowed.h</a></li>
|
|
</ul>
|
|
</div>
|
|
<HR>
|
|
|
|
<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-2012 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|