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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
<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_1FM.html">FM</a>
</div>
<div class="contents">
<h1>stk::FM Class Reference</h1><!-- doxytag: class="stk::FM" --><!-- doxytag: inherits="stk::Instrmnt" -->
<p>STK abstract <a class="el" href="classstk_1_1FM.html" title="STK abstract FM synthesis base class.">FM</a> synthesis base class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="FM_8h_source.html">FM.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for stk::FM:</div>
<div class="dynsection">
<div class="center">
<img src="classstk_1_1FM.png" usemap="#stk::FM_map" alt=""/>
<map id="stk::FM_map" name="stk::FM_map">
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="303,56,394,80"/>
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="303,0,394,24"/>
<area href="classstk_1_1BeeThree.html" alt="stk::BeeThree" shape="rect" coords="0,168,91,192"/>
<area href="classstk_1_1FMVoices.html" alt="stk::FMVoices" shape="rect" coords="101,168,192,192"/>
<area href="classstk_1_1HevyMetl.html" alt="stk::HevyMetl" shape="rect" coords="202,168,293,192"/>
<area href="classstk_1_1PercFlut.html" alt="stk::PercFlut" shape="rect" coords="303,168,394,192"/>
<area href="classstk_1_1Rhodey.html" alt="stk::Rhodey" shape="rect" coords="404,168,495,192"/>
<area href="classstk_1_1TubeBell.html" alt="stk::TubeBell" shape="rect" coords="505,168,596,192"/>
<area href="classstk_1_1Wurley.html" alt="stk::Wurley" shape="rect" coords="606,168,697,192"/>
</map>
</div>
</div>
<p><a href="classstk_1_1FM-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_1FM.html#af4732c22ce00743e1f751880fa07aa15">FM</a> (unsigned int operators=4)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor, taking the number of wave/envelope operators to control. <a href="#af4732c22ce00743e1f751880fa07aa15"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaba7e8bff02d105e146f8b62b20a27b9"></a><!-- doxytag: member="stk::FM::~FM" ref="aaba7e8bff02d105e146f8b62b20a27b9" args="(void)" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#aaba7e8bff02d105e146f8b62b20a27b9">~FM</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="ac5697f9929afd43379e8720f2f271b2d"></a><!-- doxytag: member="stk::FM::clear" ref="ac5697f9929afd43379e8720f2f271b2d" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#ac5697f9929afd43379e8720f2f271b2d">clear</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset and clear all wave and envelope states. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0a32c8327e842bb71ce945024d583941"></a><!-- doxytag: member="stk::FM::loadWaves" ref="a0a32c8327e842bb71ce945024d583941" args="(const char **filenames)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#a0a32c8327e842bb71ce945024d583941">loadWaves</a> (const char **filenames)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load the rawwave filenames in waves. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8182c605d51ec623f90f4e07c2b90891"></a><!-- doxytag: member="stk::FM::setFrequency" ref="a8182c605d51ec623f90f4e07c2b90891" args="(StkFloat frequency)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#a8182c605d51ec623f90f4e07c2b90891">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="a58f0898b677750a259036f628ec1a91b"></a><!-- doxytag: member="stk::FM::setRatio" ref="a58f0898b677750a259036f628ec1a91b" args="(unsigned int waveIndex, StkFloat ratio)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#a58f0898b677750a259036f628ec1a91b">setRatio</a> (unsigned int waveIndex, StkFloat ratio)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the frequency ratio for the specified wave. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a65a8c54556f0c288871876ffad4d9eef"></a><!-- doxytag: member="stk::FM::setGain" ref="a65a8c54556f0c288871876ffad4d9eef" args="(unsigned int waveIndex, StkFloat gain)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#a65a8c54556f0c288871876ffad4d9eef">setGain</a> (unsigned int waveIndex, StkFloat gain)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the gain for the specified wave. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a33e5d60131014a12a435c0ef20d104b6"></a><!-- doxytag: member="stk::FM::setModulationSpeed" ref="a33e5d60131014a12a435c0ef20d104b6" args="(StkFloat mSpeed)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#a33e5d60131014a12a435c0ef20d104b6">setModulationSpeed</a> (StkFloat mSpeed)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the modulation speed in Hz. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a11584256f23153551bc13b59518b415a"></a><!-- doxytag: member="stk::FM::setModulationDepth" ref="a11584256f23153551bc13b59518b415a" args="(StkFloat mDepth)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#a11584256f23153551bc13b59518b415a">setModulationDepth</a> (StkFloat mDepth)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the modulation depth. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0425269a8fc0cc6bb7471d65b54b8a1a"></a><!-- doxytag: member="stk::FM::setControl1" ref="a0425269a8fc0cc6bb7471d65b54b8a1a" args="(StkFloat cVal)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#a0425269a8fc0cc6bb7471d65b54b8a1a">setControl1</a> (StkFloat cVal)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the value of control1. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad7e7d7067c8893040ef3bdf8a1fbe9ca"></a><!-- doxytag: member="stk::FM::setControl2" ref="ad7e7d7067c8893040ef3bdf8a1fbe9ca" args="(StkFloat cVal)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#ad7e7d7067c8893040ef3bdf8a1fbe9ca">setControl2</a> (StkFloat cVal)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the value of control1. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afc46280177d770404919f20ccf88e4ff"></a><!-- doxytag: member="stk::FM::keyOn" ref="afc46280177d770404919f20ccf88e4ff" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#afc46280177d770404919f20ccf88e4ff">keyOn</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start envelopes toward "on" targets. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7235e94a153df135330a591511269f7c"></a><!-- doxytag: member="stk::FM::keyOff" ref="a7235e94a153df135330a591511269f7c" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#a7235e94a153df135330a591511269f7c">keyOff</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start envelopes toward "off" targets. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a56cc61b1923dba2ff80859df4904d4f9"></a><!-- doxytag: member="stk::FM::noteOff" ref="a56cc61b1923dba2ff80859df4904d4f9" args="(StkFloat amplitude)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#a56cc61b1923dba2ff80859df4904d4f9">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="a1db9d177363fb7d8dedb20fa0c9104f1"></a><!-- doxytag: member="stk::FM::controlChange" ref="a1db9d177363fb7d8dedb20fa0c9104f1" args="(int number, StkFloat value)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#a1db9d177363fb7d8dedb20fa0c9104f1">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="a81f351fd8732fd6e686735b7b45a4241"></a><!-- doxytag: member="stk::FM::tick" ref="a81f351fd8732fd6e686735b7b45a4241" args="(unsigned int)=0" -->
virtual StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#a81f351fd8732fd6e686735b7b45a4241">tick</a> (unsigned int)=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">virtual <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#a870c602be292d2dcc1b0fd97f515f2ff">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &frames, unsigned int channel=0)=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="#a870c602be292d2dcc1b0fd97f515f2ff"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK abstract <a class="el" href="classstk_1_1FM.html" title="STK abstract FM synthesis base class.">FM</a> synthesis base class. </p>
<p>This class controls an arbitrary number of waves and envelopes, determined via a constructor argument.</p>
<p>Control Change Numbers:</p>
<ul>
<li>Control One = 2</li>
<li>Control Two = 4</li>
<li>LFO Speed = 11</li>
<li>LFO Depth = 1</li>
<li><a class="el" href="classstk_1_1ADSR.html" title="STK ADSR envelope class.">ADSR</a> 2 & 4 Target = 128</li>
</ul>
<p>The basic Chowning/Stanford <a class="el" href="classstk_1_1FM.html" title="STK abstract FM synthesis base class.">FM</a> patent expired in 1995, but there exist follow-on patents, mostly assigned to Yamaha. If you are of the type who should worry about this (making money) worry away.</p>
<p>by Perry R. Cook and Gary P. Scavone, 1995-2012. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af4732c22ce00743e1f751880fa07aa15"></a><!-- doxytag: member="stk::FM::FM" ref="af4732c22ce00743e1f751880fa07aa15" args="(unsigned int operators=4)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">stk::FM::FM </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>operators</em> = <code>4</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Class constructor, taking the number of wave/envelope operators to control. </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="a870c602be292d2dcc1b0fd97f515f2ff"></a><!-- doxytag: member="stk::FM::tick" ref="a870c602be292d2dcc1b0fd97f515f2ff" args="(StkFrames &frames, unsigned int channel=0)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a>& stk::FM::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> [pure 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>Implemented in <a class="el" href="classstk_1_1BeeThree.html#a30520efff3fac0674d3c7ab95ac35999">stk::BeeThree</a>, <a class="el" href="classstk_1_1FMVoices.html#abad16be89b38d4618a07c5d71ab49e26">stk::FMVoices</a>, <a class="el" href="classstk_1_1HevyMetl.html#a555f3bf9322fd11150b00bb99476769a">stk::HevyMetl</a>, <a class="el" href="classstk_1_1PercFlut.html#a4105b2b1dfe375bcf870fb4903509e4e">stk::PercFlut</a>, <a class="el" href="classstk_1_1Rhodey.html#a9d843b764e5219c8289884d0903462f9">stk::Rhodey</a>, <a class="el" href="classstk_1_1TubeBell.html#a664cede881352aea1d300ca93ba416ac">stk::TubeBell</a>, and <a class="el" href="classstk_1_1Wurley.html#a505f7e6499761f64d0cc4b6419d945c3">stk::Wurley</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="FM_8h_source.html">FM.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-2012 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>
|
