mirror of
https://github.com/thestk/stk
synced 2026-01-17 14:41:53 +00:00
178 lines
14 KiB
HTML
178 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_1Brass.html">Brass</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::Brass Class Reference</h1><!-- doxytag: class="stk::Brass" --><!-- doxytag: inherits="stk::Instrmnt" -->
|
|
<p>STK simple brass instrument class.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="Brass_8h_source.html">Brass.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::Brass:</div>
|
|
<div class="dynsection">
|
|
<div class="center">
|
|
<img src="classstk_1_1Brass.png" usemap="#stk::Brass_map" alt=""/>
|
|
<map id="stk::Brass_map" name="stk::Brass_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_1Brass-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_1Brass.html#a5bf59263a54250be84c027198c7d2d1d">Brass</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="#a5bf59263a54250be84c027198c7d2d1d"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a474528a75bd4fb88cdb9c783d73df8f6"></a><!-- doxytag: member="stk::Brass::~Brass" ref="a474528a75bd4fb88cdb9c783d73df8f6" args="()" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Brass.html#a474528a75bd4fb88cdb9c783d73df8f6">~Brass</a> ()</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="a64e48334efdc8f2508c29c5ea4281f2d"></a><!-- doxytag: member="stk::Brass::clear" ref="a64e48334efdc8f2508c29c5ea4281f2d" args="()" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Brass.html#a64e48334efdc8f2508c29c5ea4281f2d">clear</a> ()</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="a5e99e7fee1b92138566a46c828df93e8"></a><!-- doxytag: member="stk::Brass::setFrequency" ref="a5e99e7fee1b92138566a46c828df93e8" args="(StkFloat frequency)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Brass.html#a5e99e7fee1b92138566a46c828df93e8">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="a2e1a150328504050499c5cb9fa0e536f"></a><!-- doxytag: member="stk::Brass::setLip" ref="a2e1a150328504050499c5cb9fa0e536f" args="(StkFloat frequency)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Brass.html#a2e1a150328504050499c5cb9fa0e536f">setLip</a> (StkFloat frequency)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the lips frequency. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a02533e02818e2848fb6480106a54ce94"></a><!-- doxytag: member="stk::Brass::startBlowing" ref="a02533e02818e2848fb6480106a54ce94" args="(StkFloat amplitude, StkFloat rate)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Brass.html#a02533e02818e2848fb6480106a54ce94">startBlowing</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="a8bf1624aca6283fafb830a3f22546199"></a><!-- doxytag: member="stk::Brass::stopBlowing" ref="a8bf1624aca6283fafb830a3f22546199" args="(StkFloat rate)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Brass.html#a8bf1624aca6283fafb830a3f22546199">stopBlowing</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="ae74eba698f27abd43e66e825f5ce72da"></a><!-- doxytag: member="stk::Brass::noteOn" ref="ae74eba698f27abd43e66e825f5ce72da" args="(StkFloat frequency, StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Brass.html#ae74eba698f27abd43e66e825f5ce72da">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="a32e2a6d2c9285bb5cf033d8a6b90e3c9"></a><!-- doxytag: member="stk::Brass::noteOff" ref="a32e2a6d2c9285bb5cf033d8a6b90e3c9" args="(StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Brass.html#a32e2a6d2c9285bb5cf033d8a6b90e3c9">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="a4d75ac361d11fcc870a330d393dbad80"></a><!-- doxytag: member="stk::Brass::controlChange" ref="a4d75ac361d11fcc870a330d393dbad80" args="(int number, StkFloat value)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Brass.html#a4d75ac361d11fcc870a330d393dbad80">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="a4af1b7c4c1b374b65e04ccaa90886321"></a><!-- doxytag: member="stk::Brass::tick" ref="a4af1b7c4c1b374b65e04ccaa90886321" args="(unsigned int channel=0)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Brass.html#a4af1b7c4c1b374b65e04ccaa90886321">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_1Brass.html#a10334fc5573b68f2b5c2819bdba786b8">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="#a10334fc5573b68f2b5c2819bdba786b8"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>STK simple brass instrument class. </p>
|
|
<p>This class implements a simple brass instrument waveguide model, a la Cook (TBone, HosePlayer).</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>Lip Tension = 2</li>
|
|
<li>Slide Length = 4</li>
|
|
<li>Vibrato Frequency = 11</li>
|
|
<li>Vibrato Gain = 1</li>
|
|
<li>Volume = 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="a5bf59263a54250be84c027198c7d2d1d"></a><!-- doxytag: member="stk::Brass::Brass" ref="a5bf59263a54250be84c027198c7d2d1d" args="(StkFloat lowestFrequency=8.0)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">stk::Brass::Brass </td>
|
|
<td>(</td>
|
|
<td class="paramtype">StkFloat </td>
|
|
<td class="paramname"> <em>lowestFrequency</em> = <code>8.0</code></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<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="a10334fc5573b68f2b5c2819bdba786b8"></a><!-- doxytag: member="stk::Brass::tick" ref="a10334fc5573b68f2b5c2819bdba786b8" 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::Brass::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="l00119"></a>00119 {
|
|
<a name="l00120"></a>00120 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels = lastFrame_.channels();
|
|
<a name="l00121"></a>00121 <span class="preprocessor">#if defined(_STK_DEBUG_)</span>
|
|
<a name="l00122"></a>00122 <span class="preprocessor"></span> <span class="keywordflow">if</span> ( channel > frames.channels() - nChannels ) {
|
|
<a name="l00123"></a>00123 oStream_ << <span class="stringliteral">"Brass::tick(): channel and StkFrames arguments are incompatible!"</span>;
|
|
<a name="l00124"></a>00124 <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="l00125"></a>00125 }
|
|
<a name="l00126"></a>00126 <span class="preprocessor">#endif</span>
|
|
<a name="l00127"></a>00127 <span class="preprocessor"></span>
|
|
<a name="l00128"></a>00128 StkFloat *samples = &frames[channel];
|
|
<a name="l00129"></a>00129 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> j, hop = frames.channels() - nChannels;
|
|
<a name="l00130"></a>00130 <span class="keywordflow">if</span> ( nChannels == 1 ) {
|
|
<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_1Brass.html#a4af1b7c4c1b374b65e04ccaa90886321" title="Compute and return one output sample.">tick</a>();
|
|
<a name="l00133"></a>00133 }
|
|
<a name="l00134"></a>00134 <span class="keywordflow">else</span> {
|
|
<a name="l00135"></a>00135 <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="l00136"></a>00136 *samples++ = <a class="code" href="classstk_1_1Brass.html#a4af1b7c4c1b374b65e04ccaa90886321" title="Compute and return one output sample.">tick</a>();
|
|
<a name="l00137"></a>00137 <span class="keywordflow">for</span> ( j=1; j<nChannels; j++ )
|
|
<a name="l00138"></a>00138 *samples++ = lastFrame_[j];
|
|
<a name="l00139"></a>00139 }
|
|
<a name="l00140"></a>00140 }
|
|
<a name="l00141"></a>00141
|
|
<a name="l00142"></a>00142 <span class="keywordflow">return</span> frames;
|
|
<a name="l00143"></a>00143 }
|
|
</pre></div></p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Brass_8h_source.html">Brass.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>
|