mirror of
https://github.com/thestk/stk
synced 2026-04-20 14:36:55 +00:00
Release 4.2.1 tarball
This commit is contained in:
Gary Scavone
committed by
Stephen Sinclair
Stephen Sinclair
parent
11cf5faa0a
commit
21b93795e7
@@ -8,8 +8,8 @@
|
||||
<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="tutorial.html">Tutorial</a></CENTER>
|
||||
<HR>
|
||||
<!-- Generated by Doxygen 1.3.4 -->
|
||||
<h1>FM Class Reference</h1><code>#include <<a class="el" href="FM_8h-source.html">FM.h</a>></code>
|
||||
<!-- Generated by Doxygen 1.4.4 -->
|
||||
<h1>FM Class Reference</h1><!-- doxytag: class="FM" --><!-- doxytag: inherits="Instrmnt" --><code>#include <<a class="el" href="FM_8h-source.html">FM.h</a>></code>
|
||||
<p>
|
||||
<p>Inheritance diagram for FM:
|
||||
<p><center><img src="classFM.png" usemap="#FM_map" border="0" alt=""></center>
|
||||
@@ -32,104 +32,90 @@ Control Change Numbers:<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="classADSR.html">ADSR</a> 2 & 4 Target = 128</li></ul>
|
||||
<p>
|
||||
The basic Chowning/Stanford FM 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>
|
||||
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
|
||||
by Perry R. Cook and Gary P. Scavone, 1995 - 2005.
|
||||
<p>
|
||||
|
||||
<p>
|
||||
Definition at line <a class="el" href="FM_8h-source.html#l00034">34</a> of file <a class="el" href="FM_8h-source.html">FM.h</a>.<table border=0 cellpadding=0 cellspacing=0>
|
||||
<table border="0" cellpadding="0" cellspacing="0">
|
||||
<tr><td></td></tr>
|
||||
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classFM.html#a0">FM</a> (unsigned int operators=4)</td></tr>
|
||||
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFM.html#a0">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. </em> <a href="#a0"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="FM::~FM" ></a>
|
||||
virtual </td><td class="memItemRight" valign=bottom><a class="el" href="classFM.html#a1">~FM</a> ()</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor, taking the number of wave/envelope operators to control. <a href="#a0"></a><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="FM::~FM" ref="a1" args="()" -->
|
||||
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classFM.html#a1">~FM</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a2" doxytag="FM::clear" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classFM.html#a2">clear</a> ()</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2"></a><!-- doxytag: member="FM::clear" ref="a2" args="()" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFM.html#a2">clear</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset and clear all wave and envelope states. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="FM::loadWaves" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classFM.html#a3">loadWaves</a> (const char **filenames)</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" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="FM::loadWaves" ref="a3" args="(const char **filenames)" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFM.html#a3">loadWaves</a> (const char **filenames)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load the rawwave filenames in waves. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="FM::setFrequency" ></a>
|
||||
virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classFM.html#a4">setFrequency</a> (StkFloat frequency)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load the rawwave filenames in waves. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4"></a><!-- doxytag: member="FM::setFrequency" ref="a4" args="(StkFloat frequency)" -->
|
||||
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFM.html#a4">setFrequency</a> (StkFloat frequency)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set instrument parameters for a particular frequency. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="FM::setRatio" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classFM.html#a5">setRatio</a> (unsigned int waveIndex, StkFloat ratio)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set instrument parameters for a particular frequency. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5"></a><!-- doxytag: member="FM::setRatio" ref="a5" args="(unsigned int waveIndex, StkFloat ratio)" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFM.html#a5">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><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="FM::setGain" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classFM.html#a6">setGain</a> (unsigned int waveIndex, StkFloat gain)</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" nowrap align="right" valign="top"><a class="anchor" name="a6"></a><!-- doxytag: member="FM::setGain" ref="a6" args="(unsigned int waveIndex, StkFloat gain)" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFM.html#a6">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><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a7" doxytag="FM::setModulationSpeed" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classFM.html#a7">setModulationSpeed</a> (StkFloat mSpeed)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the gain for the specified wave. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7"></a><!-- doxytag: member="FM::setModulationSpeed" ref="a7" args="(StkFloat mSpeed)" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFM.html#a7">setModulationSpeed</a> (StkFloat mSpeed)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the modulation speed in Hz. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a8" doxytag="FM::setModulationDepth" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classFM.html#a8">setModulationDepth</a> (StkFloat mDepth)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the modulation speed in Hz. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8"></a><!-- doxytag: member="FM::setModulationDepth" ref="a8" args="(StkFloat mDepth)" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFM.html#a8">setModulationDepth</a> (StkFloat mDepth)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the modulation depth. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a9" doxytag="FM::setControl1" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classFM.html#a9">setControl1</a> (StkFloat cVal)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the modulation depth. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9"></a><!-- doxytag: member="FM::setControl1" ref="a9" args="(StkFloat cVal)" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFM.html#a9">setControl1</a> (StkFloat cVal)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the value of control1. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a10" doxytag="FM::setControl2" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classFM.html#a10">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" nowrap align="right" valign="top"><a class="anchor" name="a10"></a><!-- doxytag: member="FM::setControl2" ref="a10" args="(StkFloat cVal)" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFM.html#a10">setControl2</a> (StkFloat cVal)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the value of control1. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a11" doxytag="FM::keyOn" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classFM.html#a11">keyOn</a> ()</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the value of control1. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a11"></a><!-- doxytag: member="FM::keyOn" ref="a11" args="()" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFM.html#a11">keyOn</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start envelopes toward "on" targets. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a12" doxytag="FM::keyOff" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classFM.html#a12">keyOff</a> ()</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start envelopes toward "on" targets. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a12"></a><!-- doxytag: member="FM::keyOff" ref="a12" args="()" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFM.html#a12">keyOff</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start envelopes toward "off" targets. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a13" doxytag="FM::noteOff" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classFM.html#a13">noteOff</a> (StkFloat amplitude)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start envelopes toward "off" targets. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a13"></a><!-- doxytag: member="FM::noteOff" ref="a13" args="(StkFloat amplitude)" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFM.html#a13">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><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a14" doxytag="FM::tick" ></a>
|
||||
virtual StkFloat </td><td class="memItemRight" valign=bottom><a class="el" href="classFM.html#a14">tick</a> ()=0</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" nowrap align="right" valign="top"><a class="anchor" name="a14"></a><!-- doxytag: member="FM::controlChange" ref="a14" args="(int number, StkFloat value)" -->
|
||||
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFM.html#a14">controlChange</a> (int number, StkFloat value)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pure virtual function ... must be defined in subclasses. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a15" doxytag="FM::tick" ></a>
|
||||
virtual StkFloat * </td><td class="memItemRight" valign=bottom><a class="el" href="classFM.html#a15">tick</a> (StkFloat *vector, unsigned int vectorSize)=0</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Computer <em>vectorSize</em> outputs and return them in <em>vector</em>. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classStkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="classFM.html#a16">tick</a> (<a class="el" href="classStkFrames.html">StkFrames</a> &frames, unsigned int channel=1)=0</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fill a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object with computed outputs. </em> <a href="#a16"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a17" doxytag="FM::controlChange" ></a>
|
||||
virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classFM.html#a17">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><br></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>
|
||||
</table>
|
||||
<hr><h2>Constructor & Destructor Documentation</h2>
|
||||
<a class="anchor" name="a0" doxytag="FM::FM" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<a class="anchor" name="a0"></a><!-- doxytag: member="FM::FM" ref="a0" args="(unsigned int operators=4)" --><p>
|
||||
<table class="mdTable" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> FM::FM </td>
|
||||
<td class="md" nowrap valign="top">FM::FM </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">unsigned int </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>operators</em> = 4 </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>operators</em> = <code>4</code> </td>
|
||||
<td class="md" valign="top"> ) </td>
|
||||
<td class="md" nowrap></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<table cellspacing="5" cellpadding="0" border="0">
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
@@ -139,52 +125,7 @@ virtual void </td><td class="memItemRight" valign=bottom><a class="el" href
|
||||
<p>
|
||||
Class constructor, taking the number of wave/envelope operators to control.
|
||||
<p>
|
||||
An <a class="el" href="classStkError.html">StkError</a> will be thrown if the rawwave path is incorrectly set. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<hr><h2>Member Function Documentation</h2>
|
||||
<a class="anchor" name="a16" doxytag="FM::tick" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> virtual <a class="el" href="classStkFrames.html">StkFrames</a>& FM::tick </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="classStkFrames.html">StkFrames</a> & </td>
|
||||
<td class="mdname" nowrap> <em>frames</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>unsigned int </td>
|
||||
<td class="mdname" nowrap> <em>channel</em> = 1</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td class="md">) </td>
|
||||
<td class="md" colspan="2"><code> [pure virtual]</code></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
Fill a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object with computed outputs.
|
||||
<p>
|
||||
The <code>channel</code> argument should be one or greater (the first channel is specified by 1). An <a class="el" href="classStkError.html">StkError</a> will be thrown if the <code>channel</code> argument is zero or it is greater than the number of channels in the <a class="el" href="classStkFrames.html">StkFrames</a> object.
|
||||
<p>
|
||||
Reimplemented from <a class="el" href="classInstrmnt.html#a10">Instrmnt</a>.
|
||||
<p>
|
||||
Implemented in <a class="el" href="classBeeThree.html#a5">BeeThree</a>, <a class="el" href="classFMVoices.html#a6">FMVoices</a>, <a class="el" href="classHevyMetl.html#a5">HevyMetl</a>, <a class="el" href="classPercFlut.html#a6">PercFlut</a>, <a class="el" href="classRhodey.html#a6">Rhodey</a>, <a class="el" href="classTubeBell.html#a5">TubeBell</a>, and <a class="el" href="classWurley.html#a6">Wurley</a>. </td>
|
||||
An <a class="el" href="classStkError.html">StkError</a> will be thrown if the rawwave path is incorrectly set. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<hr>The documentation for this class was generated from the following file:<ul>
|
||||
@@ -193,7 +134,7 @@ Implemented in <a class="el" href="classBeeThree.html#a5">BeeThree</a>, <a class
|
||||
|
||||
<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-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
<tr><td>©1995-2005 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
</table>
|
||||
|
||||
</BODY>
|
||||
|
||||
Reference in New Issue
Block a user