mirror of
https://github.com/thestk/stk
synced 2026-01-13 13:01:52 +00:00
150 lines
11 KiB
HTML
150 lines
11 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_1Modulate.html">Modulate</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::Modulate Class Reference</h1><!-- doxytag: class="stk::Modulate" --><!-- doxytag: inherits="stk::Generator" -->
|
|
<p>STK periodic/random modulator.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="Modulate_8h_source.html">Modulate.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::Modulate:</div>
|
|
<div class="dynsection">
|
|
<div class="center">
|
|
<img src="classstk_1_1Modulate.png" usemap="#stk::Modulate_map" alt=""/>
|
|
<map id="stk::Modulate_map" name="stk::Modulate_map">
|
|
<area href="classstk_1_1Generator.html" alt="stk::Generator" shape="rect" coords="0,56,90,80"/>
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,90,24"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
|
|
<p><a href="classstk_1_1Modulate-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_1Modulate.html#a96812173415bfb086f5d8d738f4d0c2e">Modulate</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor. <a href="#a96812173415bfb086f5d8d738f4d0c2e"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="add541ec0d037a21bd236b5790878d060"></a><!-- doxytag: member="stk::Modulate::~Modulate" ref="add541ec0d037a21bd236b5790878d060" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modulate.html#add541ec0d037a21bd236b5790878d060">~Modulate</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="a6cb78fe2dec3bebf2586764421556706"></a><!-- doxytag: member="stk::Modulate::reset" ref="a6cb78fe2dec3bebf2586764421556706" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modulate.html#a6cb78fe2dec3bebf2586764421556706">reset</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset internal state. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a298b25f4b7cc56f2dffae5474a05999d"></a><!-- doxytag: member="stk::Modulate::setVibratoRate" ref="a298b25f4b7cc56f2dffae5474a05999d" args="(StkFloat rate)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modulate.html#a298b25f4b7cc56f2dffae5474a05999d">setVibratoRate</a> (StkFloat rate)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the periodic (vibrato) rate or frequency in Hz. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a08f2d489a3fba3a10d1f301aed869ed4"></a><!-- doxytag: member="stk::Modulate::setVibratoGain" ref="a08f2d489a3fba3a10d1f301aed869ed4" args="(StkFloat gain)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modulate.html#a08f2d489a3fba3a10d1f301aed869ed4">setVibratoGain</a> (StkFloat gain)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the periodic (vibrato) gain. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac6e7a02378facf59916f2460ed5c2fa5"></a><!-- doxytag: member="stk::Modulate::setRandomGain" ref="ac6e7a02378facf59916f2460ed5c2fa5" args="(StkFloat gain)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modulate.html#ac6e7a02378facf59916f2460ed5c2fa5">setRandomGain</a> (StkFloat gain)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the random modulation gain. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="addf73f58590ab082f106c9745c5bedc9"></a><!-- doxytag: member="stk::Modulate::lastOut" ref="addf73f58590ab082f106c9745c5bedc9" args="(void) const " -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modulate.html#addf73f58590ab082f106c9745c5bedc9">lastOut</a> (void) const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the last computed output value. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a237b96dd553d65253abbf00a186e293d"></a><!-- doxytag: member="stk::Modulate::tick" ref="a237b96dd553d65253abbf00a186e293d" args="(void)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modulate.html#a237b96dd553d65253abbf00a186e293d">tick</a> (void)</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_1Modulate.html#a942eee1bb78318e1b59afeb311748b2d">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="#a942eee1bb78318e1b59afeb311748b2d"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>STK periodic/random modulator. </p>
|
|
<p>This class combines random and periodic modulations to give a nice, natural human modulation function.</p>
|
|
<p>by Perry R. Cook and Gary P. Scavone, 1995-2011. </p>
|
|
<hr/><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a96812173415bfb086f5d8d738f4d0c2e"></a><!-- doxytag: member="stk::Modulate::Modulate" ref="a96812173415bfb086f5d8d738f4d0c2e" args="(void)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">stk::Modulate::Modulate </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> can be thrown if the rawwave path is incorrect. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/><h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="a942eee1bb78318e1b59afeb311748b2d"></a><!-- doxytag: member="stk::Modulate::tick" ref="a942eee1bb78318e1b59afeb311748b2d" 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::Modulate::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_1Generator.html#a86bb0421223cf27e25704d5f27b97425">stk::Generator</a>.</p>
|
|
|
|
<p><div class="fragment"><pre class="fragment"><a name="l00090"></a>00090 {
|
|
<a name="l00091"></a>00091 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
|
|
<a name="l00092"></a>00092 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel >= frames.channels() ) {
|
|
<a name="l00093"></a>00093 oStream_ << <span class="stringliteral">"Modulate::tick(): channel and StkFrames arguments are incompatible!"</span>;
|
|
<a name="l00094"></a>00094 <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="l00095"></a>00095 }
|
|
<a name="l00096"></a>00096 <span class="preprocessor">#endif</span>
|
|
<a name="l00097"></a>00097 <span class="preprocessor"></span>
|
|
<a name="l00098"></a>00098 StkFloat *samples = &frames[channel];
|
|
<a name="l00099"></a>00099 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> hop = frames.channels();
|
|
<a name="l00100"></a>00100 <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="l00101"></a>00101 *samples = <a class="code" href="classstk_1_1Modulate.html#a237b96dd553d65253abbf00a186e293d" title="Compute and return one output sample.">Modulate::tick</a>();
|
|
<a name="l00102"></a>00102
|
|
<a name="l00103"></a>00103 <span class="keywordflow">return</span> frames;
|
|
<a name="l00104"></a>00104 }
|
|
</pre></div></p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Modulate_8h_source.html">Modulate.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>
|