mirror of
https://github.com/thestk/stk
synced 2026-01-15 22:11:52 +00:00
169 lines
13 KiB
HTML
169 lines
13 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_1Moog.html">Moog</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::Moog Class Reference</h1><!-- doxytag: class="stk::Moog" --><!-- doxytag: inherits="stk::Sampler" -->
|
|
<p>STK moog-like swept filter sampling synthesis class.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="Moog_8h_source.html">Moog.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::Moog:</div>
|
|
<div class="dynsection">
|
|
<div class="center">
|
|
<img src="classstk_1_1Moog.png" usemap="#stk::Moog_map" alt=""/>
|
|
<map id="stk::Moog_map" name="stk::Moog_map">
|
|
<area href="classstk_1_1Sampler.html" alt="stk::Sampler" shape="rect" coords="0,112,79,136"/>
|
|
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,79,80"/>
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,79,24"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
|
|
<p><a href="classstk_1_1Moog-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_1Moog.html#a07c8d02638711d5f08a3b320b7274156">Moog</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor. <a href="#a07c8d02638711d5f08a3b320b7274156"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac05815f49aab07e01ff0d4e5e8c4edba"></a><!-- doxytag: member="stk::Moog::~Moog" ref="ac05815f49aab07e01ff0d4e5e8c4edba" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Moog.html#ac05815f49aab07e01ff0d4e5e8c4edba">~Moog</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="ab0d66174dd734d55ef7224d6d8f2cb06"></a><!-- doxytag: member="stk::Moog::setFrequency" ref="ab0d66174dd734d55ef7224d6d8f2cb06" args="(StkFloat frequency)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Moog.html#ab0d66174dd734d55ef7224d6d8f2cb06">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="a899bc1c5c76fb29875d4df4ce594d44e"></a><!-- doxytag: member="stk::Moog::noteOn" ref="a899bc1c5c76fb29875d4df4ce594d44e" args="(StkFloat frequency, StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Moog.html#a899bc1c5c76fb29875d4df4ce594d44e">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="afeb63bf762f07851db22ae5bf18f0a81"></a><!-- doxytag: member="stk::Moog::setModulationSpeed" ref="afeb63bf762f07851db22ae5bf18f0a81" args="(StkFloat mSpeed)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Moog.html#afeb63bf762f07851db22ae5bf18f0a81">setModulationSpeed</a> (StkFloat mSpeed)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the modulation (vibrato) speed in Hz. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a32e5ee083d5d92494bbe9fac43c2070f"></a><!-- doxytag: member="stk::Moog::setModulationDepth" ref="a32e5ee083d5d92494bbe9fac43c2070f" args="(StkFloat mDepth)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Moog.html#a32e5ee083d5d92494bbe9fac43c2070f">setModulationDepth</a> (StkFloat mDepth)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the modulation (vibrato) depth. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acadb54eccab35e3b18b62ffd96c18ac4"></a><!-- doxytag: member="stk::Moog::controlChange" ref="acadb54eccab35e3b18b62ffd96c18ac4" args="(int number, StkFloat value)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Moog.html#acadb54eccab35e3b18b62ffd96c18ac4">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="ab9635044198c12a5c1b5dbb94245ab5a"></a><!-- doxytag: member="stk::Moog::tick" ref="ab9635044198c12a5c1b5dbb94245ab5a" args="(unsigned int channel=0)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Moog.html#ab9635044198c12a5c1b5dbb94245ab5a">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_1Moog.html#aee6aa6373c424e941f963b2709310f4e">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="#aee6aa6373c424e941f963b2709310f4e"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>STK moog-like swept filter sampling synthesis class. </p>
|
|
<p>This instrument uses one attack wave, one looped wave, and an <a class="el" href="classstk_1_1ADSR.html" title="STK ADSR envelope class.">ADSR</a> envelope (inherited from the <a class="el" href="classstk_1_1Sampler.html" title="STK sampling synthesis abstract base class.">Sampler</a> class) and adds two sweepable formant (<a class="el" href="classstk_1_1FormSwep.html" title="STK sweepable formant filter class.">FormSwep</a>) filters.</p>
|
|
<p>Control Change Numbers:</p>
|
|
<ul>
|
|
<li><a class="el" href="classstk_1_1Filter.html" title="STK abstract filter class.">Filter</a> Q = 2</li>
|
|
<li><a class="el" href="classstk_1_1Filter.html" title="STK abstract filter class.">Filter</a> Sweep Rate = 4</li>
|
|
<li>Vibrato Frequency = 11</li>
|
|
<li>Vibrato Gain = 1</li>
|
|
<li>Gain = 128</li>
|
|
</ul>
|
|
<p>by Perry R. Cook and Gary P. Scavone, 1995-2011. </p>
|
|
<hr/><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a07c8d02638711d5f08a3b320b7274156"></a><!-- doxytag: member="stk::Moog::Moog" ref="a07c8d02638711d5f08a3b320b7274156" args="(void)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">stk::Moog::Moog </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Class constructor. </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="aee6aa6373c424e941f963b2709310f4e"></a><!-- doxytag: member="stk::Moog::tick" ref="aee6aa6373c424e941f963b2709310f4e" 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::Moog::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_1Sampler.html#a30ef51142f99faf0586e2da78bc6daf6">stk::Sampler</a>.</p>
|
|
|
|
<p><div class="fragment"><pre class="fragment"><a name="l00097"></a>00097 {
|
|
<a name="l00098"></a>00098 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels = lastFrame_.channels();
|
|
<a name="l00099"></a>00099 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
|
|
<a name="l00100"></a>00100 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel > frames.channels() - nChannels ) {
|
|
<a name="l00101"></a>00101 oStream_ << <span class="stringliteral">"Moog::tick(): channel and StkFrames arguments are incompatible!"</span>;
|
|
<a name="l00102"></a>00102 <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="l00103"></a>00103 }
|
|
<a name="l00104"></a>00104 <span class="preprocessor">#endif</span>
|
|
<a name="l00105"></a>00105 <span class="preprocessor"></span>
|
|
<a name="l00106"></a>00106 StkFloat *samples = &frames[channel];
|
|
<a name="l00107"></a>00107 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> j, hop = frames.channels() - nChannels;
|
|
<a name="l00108"></a>00108 <span class="keywordflow">if</span> ( nChannels == 1 ) {
|
|
<a name="l00109"></a>00109 <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="l00110"></a>00110 *samples++ = <a class="code" href="classstk_1_1Moog.html#ab9635044198c12a5c1b5dbb94245ab5a" title="Compute and return one output sample.">tick</a>();
|
|
<a name="l00111"></a>00111 }
|
|
<a name="l00112"></a>00112 <span class="keywordflow">else</span> {
|
|
<a name="l00113"></a>00113 <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="l00114"></a>00114 *samples++ = <a class="code" href="classstk_1_1Moog.html#ab9635044198c12a5c1b5dbb94245ab5a" title="Compute and return one output sample.">tick</a>();
|
|
<a name="l00115"></a>00115 <span class="keywordflow">for</span> ( j=1; j<nChannels; j++ )
|
|
<a name="l00116"></a>00116 *samples++ = lastFrame_[j];
|
|
<a name="l00117"></a>00117 }
|
|
<a name="l00118"></a>00118 }
|
|
<a name="l00119"></a>00119
|
|
<a name="l00120"></a>00120 <span class="keywordflow">return</span> frames;
|
|
<a name="l00121"></a>00121 }
|
|
</pre></div></p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Moog_8h_source.html">Moog.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>
|