File: Mandolin_8h_source.html

package info (click to toggle)
stk 4.4.4-5
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 24,856 kB
  • sloc: cpp: 33,976; tcl: 2,375; sh: 2,319; ansic: 163; perl: 114; makefile: 37
file content (122 lines) | stat: -rw-r--r-- 13,335 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
<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"> &nbsp; <img src="ccrma.gif"> &nbsp; <img src="mcgill.gif"><P>
<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="faq.html">FAQ</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.6.2 -->
  <div class="navpath"><a class="el" href="dir_221deb9bdff892d63ed1e409450a60d2.html">include</a>
  </div>
<div class="contents">
<h1>Mandolin.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef STK_MANDOLIN_H</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define STK_MANDOLIN_H</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span>
<a name="l00004"></a>00004 <span class="preprocessor">#include &quot;Instrmnt.h&quot;</span>
<a name="l00005"></a>00005 <span class="preprocessor">#include &quot;Twang.h&quot;</span>
<a name="l00006"></a>00006 <span class="preprocessor">#include &quot;FileWvIn.h&quot;</span>
<a name="l00007"></a>00007 
<a name="l00008"></a>00008 <span class="keyword">namespace </span>stk {
<a name="l00009"></a>00009 
<a name="l00010"></a>00010 <span class="comment">/***************************************************/</span>
<a name="l00036"></a>00036 <span class="comment">/***************************************************/</span>
<a name="l00037"></a>00037 
<a name="l00038"></a><a class="code" href="classstk_1_1Mandolin.html">00038</a> <span class="keyword">class </span><a class="code" href="classstk_1_1Mandolin.html" title="STK mandolin instrument model class.">Mandolin</a> : <span class="keyword">public</span> <a class="code" href="classstk_1_1Instrmnt.html" title="STK instrument abstract base class.">Instrmnt</a>
<a name="l00039"></a>00039 {
<a name="l00040"></a>00040  <span class="keyword">public</span>:
<a name="l00042"></a>00042   <a class="code" href="classstk_1_1Mandolin.html#a5b2aaaf5697cbe57df62b568982f6300" title="Class constructor, taking the lowest desired playing frequency.">Mandolin</a>( StkFloat lowestFrequency );
<a name="l00043"></a>00043 
<a name="l00045"></a>00045   <a class="code" href="classstk_1_1Mandolin.html#a92d50a0f0c1c974683bf4685cfc6ff86" title="Class destructor.">~Mandolin</a>( <span class="keywordtype">void</span> );
<a name="l00046"></a>00046 
<a name="l00048"></a>00048   <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Mandolin.html#a2caec477ed0fe9479ed6d1fbdb45d827" title="Reset and clear all internal state.">clear</a>( <span class="keywordtype">void</span> );
<a name="l00049"></a>00049 
<a name="l00051"></a>00051   <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Mandolin.html#af46367787cd0a21a04655be82d18df08" title="Detune the two strings by the given factor. A value of 1.0 produces unison strings...">setDetune</a>( StkFloat detune );
<a name="l00052"></a>00052 
<a name="l00054"></a>00054   <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Mandolin.html#a21a5b0669b013cfd9c7142174530f629" title="Set the body size (a value of 1.0 produces the &amp;quot;default&amp;quot; size).">setBodySize</a>( StkFloat size );
<a name="l00055"></a>00055 
<a name="l00057"></a>00057   <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Mandolin.html#a8a0df47cccec5225e26d3b0e702a7c02" title="Set the pluck or &amp;quot;excitation&amp;quot; position along the string (0.0 - 1.0).">setPluckPosition</a>( StkFloat position );
<a name="l00058"></a>00058 
<a name="l00060"></a>00060   <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Mandolin.html#af5beeafcdfef7b71a5dda14e0c30c7fb" title="Set instrument parameters for a particular frequency.">setFrequency</a>( StkFloat frequency );
<a name="l00061"></a>00061 
<a name="l00063"></a>00063   <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Mandolin.html#a3a2398d39b72e1c330f81f6545ac0f5c" title="Pluck the strings with the given amplitude (0.0 - 1.0) using the current frequency...">pluck</a>( StkFloat amplitude );
<a name="l00064"></a>00064 
<a name="l00066"></a>00066   <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Mandolin.html#a3a2398d39b72e1c330f81f6545ac0f5c" title="Pluck the strings with the given amplitude (0.0 - 1.0) using the current frequency...">pluck</a>( StkFloat amplitude,StkFloat position );
<a name="l00067"></a>00067 
<a name="l00069"></a>00069   <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Mandolin.html#a8b60733652e54f1d6c93d63c915c9ca7" title="Start a note with the given frequency and amplitude (0.0 - 1.0).">noteOn</a>( StkFloat frequency, StkFloat amplitude );
<a name="l00070"></a>00070 
<a name="l00072"></a>00072   <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Mandolin.html#a569de60008c218f0939ab9aedd038776" title="Stop a note with the given amplitude (speed of decay).">noteOff</a>( StkFloat amplitude );
<a name="l00073"></a>00073 
<a name="l00075"></a>00075   <span class="keywordtype">void</span> <a class="code" href="classstk_1_1Mandolin.html#abf341aa5e7d751012178ff7b853b73a1" title="Perform the control change specified by number and value (0.0 - 128.0).">controlChange</a>( <span class="keywordtype">int</span> number, StkFloat value );
<a name="l00076"></a>00076 
<a name="l00078"></a>00078   StkFloat <a class="code" href="classstk_1_1Mandolin.html#a99f5b51e76c97299dd8c58f27a6d0e62" title="Compute and return one output sample.">tick</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 0 );
<a name="l00079"></a>00079 
<a name="l00081"></a>00081 
<a name="l00088"></a>00088   <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>&amp; <a class="code" href="classstk_1_1Mandolin.html#a99f5b51e76c97299dd8c58f27a6d0e62" title="Compute and return one output sample.">tick</a>( <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>&amp; frames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 0 );
<a name="l00089"></a>00089 
<a name="l00090"></a>00090   <span class="keyword">protected</span>:
<a name="l00091"></a>00091 
<a name="l00092"></a>00092   <a class="code" href="classstk_1_1Twang.html" title="STK enhanced plucked string class.">Twang</a> strings_[2];
<a name="l00093"></a>00093   <a class="code" href="classstk_1_1FileWvIn.html" title="STK audio file input class.">FileWvIn</a> soundfile_[12];
<a name="l00094"></a>00094 
<a name="l00095"></a>00095   <span class="keywordtype">int</span> mic_;
<a name="l00096"></a>00096   StkFloat detuning_;
<a name="l00097"></a>00097   StkFloat frequency_;
<a name="l00098"></a>00098   StkFloat pluckAmplitude_;
<a name="l00099"></a>00099 };
<a name="l00100"></a>00100 
<a name="l00101"></a><a class="code" href="classstk_1_1Mandolin.html#a99f5b51e76c97299dd8c58f27a6d0e62">00101</a> <span class="keyword">inline</span> StkFloat <a class="code" href="classstk_1_1Mandolin.html#a99f5b51e76c97299dd8c58f27a6d0e62" title="Compute and return one output sample.">Mandolin :: tick</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> )
<a name="l00102"></a>00102 {
<a name="l00103"></a>00103   StkFloat temp = 0.0;
<a name="l00104"></a>00104   <span class="keywordflow">if</span> ( !soundfile_[mic_].isFinished() )
<a name="l00105"></a>00105     temp = soundfile_[mic_].<a class="code" href="classstk_1_1FileWvIn.html#ada668a0bc0bf89e155ef341de00babc2" title="Compute a sample frame and return the specified channel value.">tick</a>() * pluckAmplitude_;
<a name="l00106"></a>00106 
<a name="l00107"></a>00107   lastFrame_[0] = strings_[0].<a class="code" href="classstk_1_1Twang.html#a3441ff449e3f7a451873e67d4c680ce9" title="Compute and return one output sample.">tick</a>( temp );
<a name="l00108"></a>00108   lastFrame_[0] += strings_[1].<a class="code" href="classstk_1_1Twang.html#a3441ff449e3f7a451873e67d4c680ce9" title="Compute and return one output sample.">tick</a>( temp );
<a name="l00109"></a>00109   lastFrame_[0] *= 0.2;
<a name="l00110"></a>00110 
<a name="l00111"></a>00111   <span class="keywordflow">return</span> lastFrame_[0];
<a name="l00112"></a>00112 }
<a name="l00113"></a>00113 
<a name="l00114"></a><a class="code" href="classstk_1_1Mandolin.html#a37134f89e73e3e62ad5dfcfb0300a12d">00114</a> <span class="keyword">inline</span> <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>&amp; <a class="code" href="classstk_1_1Mandolin.html#a99f5b51e76c97299dd8c58f27a6d0e62" title="Compute and return one output sample.">Mandolin :: tick</a>( <a class="code" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a>&amp; frames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel )
<a name="l00115"></a>00115 {
<a name="l00116"></a>00116   <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nChannels = lastFrame_.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>();
<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 &gt; frames.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() - nChannels ) {
<a name="l00119"></a>00119     oStream_ &lt;&lt; <span class="stringliteral">&quot;Mandolin::tick(): channel and StkFrames arguments are incompatible!&quot;</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 = &amp;frames[channel];
<a name="l00125"></a>00125   <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> j, hop = frames.<a class="code" href="classstk_1_1StkFrames.html#aec7ef9c46675a24111aa6e2fda3ba870" title="Return the number of channels represented by the data.">channels</a>() - 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&lt;frames.<a class="code" href="classstk_1_1StkFrames.html#a05b1ab6fa750a8221a7d65c30e0cdab9" title="Return the number of sample frames represented by the data.">frames</a>(); 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&lt;frames.<a class="code" href="classstk_1_1StkFrames.html#a05b1ab6fa750a8221a7d65c30e0cdab9" title="Return the number of sample frames represented by the data.">frames</a>(); 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&lt;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 }
<a name="l00140"></a>00140 
<a name="l00141"></a>00141 } <span class="comment">// stk namespace</span>
<a name="l00142"></a>00142 
<a name="l00143"></a>00143 <span class="preprocessor">#endif</span>
</pre></div></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>&copy;1995-2012 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>

</BODY>
</HTML>