mirror of
https://github.com/thestk/stk
synced 2026-01-16 06:21:51 +00:00
164 lines
15 KiB
HTML
164 lines
15 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_1Mandolin.html">Mandolin</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::Mandolin Class Reference</h1><!-- doxytag: class="stk::Mandolin" --><!-- doxytag: inherits="stk::Instrmnt" -->
|
|
<p>STK mandolin instrument model class.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="Mandolin_8h_source.html">Mandolin.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::Mandolin:</div>
|
|
<div class="dynsection">
|
|
<div class="center">
|
|
<img src="classstk_1_1Mandolin.png" usemap="#stk::Mandolin_map" alt=""/>
|
|
<map id="stk::Mandolin_map" name="stk::Mandolin_map">
|
|
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,85,80"/>
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,85,24"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
|
|
<p><a href="classstk_1_1Mandolin-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="a5b2aaaf5697cbe57df62b568982f6300"></a><!-- doxytag: member="stk::Mandolin::Mandolin" ref="a5b2aaaf5697cbe57df62b568982f6300" args="(StkFloat lowestFrequency)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mandolin.html#a5b2aaaf5697cbe57df62b568982f6300">Mandolin</a> (StkFloat lowestFrequency)</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="a92d50a0f0c1c974683bf4685cfc6ff86"></a><!-- doxytag: member="stk::Mandolin::~Mandolin" ref="a92d50a0f0c1c974683bf4685cfc6ff86" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mandolin.html#a92d50a0f0c1c974683bf4685cfc6ff86">~Mandolin</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="a2caec477ed0fe9479ed6d1fbdb45d827"></a><!-- doxytag: member="stk::Mandolin::clear" ref="a2caec477ed0fe9479ed6d1fbdb45d827" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mandolin.html#a2caec477ed0fe9479ed6d1fbdb45d827">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="af46367787cd0a21a04655be82d18df08"></a><!-- doxytag: member="stk::Mandolin::setDetune" ref="af46367787cd0a21a04655be82d18df08" args="(StkFloat detune)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mandolin.html#af46367787cd0a21a04655be82d18df08">setDetune</a> (StkFloat detune)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Detune the two strings by the given factor. A value of 1.0 produces unison strings. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a21a5b0669b013cfd9c7142174530f629"></a><!-- doxytag: member="stk::Mandolin::setBodySize" ref="a21a5b0669b013cfd9c7142174530f629" args="(StkFloat size)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mandolin.html#a21a5b0669b013cfd9c7142174530f629">setBodySize</a> (StkFloat size)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the body size (a value of 1.0 produces the "default" size). <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8a0df47cccec5225e26d3b0e702a7c02"></a><!-- doxytag: member="stk::Mandolin::setPluckPosition" ref="a8a0df47cccec5225e26d3b0e702a7c02" args="(StkFloat position)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mandolin.html#a8a0df47cccec5225e26d3b0e702a7c02">setPluckPosition</a> (StkFloat position)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the pluck or "excitation" position along the string (0.0 - 1.0). <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af5beeafcdfef7b71a5dda14e0c30c7fb"></a><!-- doxytag: member="stk::Mandolin::setFrequency" ref="af5beeafcdfef7b71a5dda14e0c30c7fb" args="(StkFloat frequency)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mandolin.html#af5beeafcdfef7b71a5dda14e0c30c7fb">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="a3a2398d39b72e1c330f81f6545ac0f5c"></a><!-- doxytag: member="stk::Mandolin::pluck" ref="a3a2398d39b72e1c330f81f6545ac0f5c" args="(StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mandolin.html#a3a2398d39b72e1c330f81f6545ac0f5c">pluck</a> (StkFloat amplitude)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pluck the strings with the given amplitude (0.0 - 1.0) using the current frequency. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a77bf06efc96f2a83e0fe2c91db83dbd3"></a><!-- doxytag: member="stk::Mandolin::pluck" ref="a77bf06efc96f2a83e0fe2c91db83dbd3" args="(StkFloat amplitude, StkFloat position)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mandolin.html#a77bf06efc96f2a83e0fe2c91db83dbd3">pluck</a> (StkFloat amplitude, StkFloat position)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pluck the strings with the given amplitude (0.0 - 1.0) and position (0.0 - 1.0). <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8b60733652e54f1d6c93d63c915c9ca7"></a><!-- doxytag: member="stk::Mandolin::noteOn" ref="a8b60733652e54f1d6c93d63c915c9ca7" args="(StkFloat frequency, StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mandolin.html#a8b60733652e54f1d6c93d63c915c9ca7">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 (0.0 - 1.0). <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a569de60008c218f0939ab9aedd038776"></a><!-- doxytag: member="stk::Mandolin::noteOff" ref="a569de60008c218f0939ab9aedd038776" args="(StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mandolin.html#a569de60008c218f0939ab9aedd038776">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="abf341aa5e7d751012178ff7b853b73a1"></a><!-- doxytag: member="stk::Mandolin::controlChange" ref="abf341aa5e7d751012178ff7b853b73a1" args="(int number, StkFloat value)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mandolin.html#abf341aa5e7d751012178ff7b853b73a1">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="a99f5b51e76c97299dd8c58f27a6d0e62"></a><!-- doxytag: member="stk::Mandolin::tick" ref="a99f5b51e76c97299dd8c58f27a6d0e62" args="(unsigned int channel=0)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mandolin.html#a99f5b51e76c97299dd8c58f27a6d0e62">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_1Mandolin.html#a37134f89e73e3e62ad5dfcfb0300a12d">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="#a37134f89e73e3e62ad5dfcfb0300a12d"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>STK mandolin instrument model class. </p>
|
|
<p>This class uses two "twang" models and "commuted
|
|
synthesis" techniques to model a mandolin instrument.</p>
|
|
<p>This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others. Commuted Synthesis, in particular, is covered by patents, granted, pending, and/or applied-for. All are assigned to the Board of Trustees, Stanford University. For information, contact the Office of Technology Licensing, Stanford University.</p>
|
|
<p>Control Change Numbers:</p>
|
|
<ul>
|
|
<li>Body Size = 2</li>
|
|
<li>Pluck Position = 4</li>
|
|
<li>String Sustain = 11</li>
|
|
<li>String Detuning = 1</li>
|
|
<li>Microphone Position = 128</li>
|
|
</ul>
|
|
<p>by Perry R. Cook and Gary P. Scavone, 1995-2011. </p>
|
|
<hr/><h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="a37134f89e73e3e62ad5dfcfb0300a12d"></a><!-- doxytag: member="stk::Mandolin::tick" ref="a37134f89e73e3e62ad5dfcfb0300a12d" 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::Mandolin::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="l00115"></a>00115 {
|
|
<a name="l00116"></a>00116 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels = lastFrame_.channels();
|
|
<a name="l00117"></a>00117 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
|
|
<a name="l00118"></a>00118 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel > frames.channels() - nChannels ) {
|
|
<a name="l00119"></a>00119 oStream_ << <span class="stringliteral">"Mandolin::tick(): channel and StkFrames arguments are incompatible!"</span>;
|
|
<a name="l00120"></a>00120 <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="l00121"></a>00121 }
|
|
<a name="l00122"></a>00122 <span class="preprocessor">#endif</span>
|
|
<a name="l00123"></a>00123 <span class="preprocessor"></span>
|
|
<a name="l00124"></a>00124 StkFloat *samples = &frames[channel];
|
|
<a name="l00125"></a>00125 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> j, hop = frames.channels() - nChannels;
|
|
<a name="l00126"></a>00126 <span class="keywordflow">if</span> ( nChannels == 1 ) {
|
|
<a name="l00127"></a>00127 <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="l00128"></a>00128 *samples++ = <a class="code" href="classstk_1_1Mandolin.html#a99f5b51e76c97299dd8c58f27a6d0e62" title="Compute and return one output sample.">tick</a>();
|
|
<a name="l00129"></a>00129 }
|
|
<a name="l00130"></a>00130 <span class="keywordflow">else</span> {
|
|
<a name="l00131"></a>00131 <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="l00132"></a>00132 *samples++ = <a class="code" href="classstk_1_1Mandolin.html#a99f5b51e76c97299dd8c58f27a6d0e62" title="Compute and return one output sample.">tick</a>();
|
|
<a name="l00133"></a>00133 <span class="keywordflow">for</span> ( j=1; j<nChannels; j++ )
|
|
<a name="l00134"></a>00134 *samples++ = lastFrame_[j];
|
|
<a name="l00135"></a>00135 }
|
|
<a name="l00136"></a>00136 }
|
|
<a name="l00137"></a>00137
|
|
<a name="l00138"></a>00138 <span class="keywordflow">return</span> frames;
|
|
<a name="l00139"></a>00139 }
|
|
</pre></div></p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Mandolin_8h_source.html">Mandolin.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-2011 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|