mirror of
https://github.com/thestk/stk
synced 2026-01-12 04:21:52 +00:00
201 lines
13 KiB
HTML
201 lines
13 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="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>
|
|
<p>
|
|
<p>Inheritance diagram for FM:
|
|
<p><center><img src="classFM.png" usemap="#FM_map" border="0" alt=""></center>
|
|
<map name="FM_map">
|
|
<area href="classInstrmnt.html" alt="Instrmnt" shape="rect" coords="240,56,310,80">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="240,0,310,24">
|
|
<area href="classBeeThree.html" alt="BeeThree" shape="rect" coords="0,168,70,192">
|
|
<area href="classFMVoices.html" alt="FMVoices" shape="rect" coords="80,168,150,192">
|
|
<area href="classHevyMetl.html" alt="HevyMetl" shape="rect" coords="160,168,230,192">
|
|
<area href="classPercFlut.html" alt="PercFlut" shape="rect" coords="240,168,310,192">
|
|
<area href="classRhodey.html" alt="Rhodey" shape="rect" coords="320,168,390,192">
|
|
<area href="classTubeBell.html" alt="TubeBell" shape="rect" coords="400,168,470,192">
|
|
<area href="classWurley.html" alt="Wurley" shape="rect" coords="480,168,550,192">
|
|
</map>
|
|
<a href="classFM-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK abstract FM synthesis base class.
|
|
<p>
|
|
This class controls an arbitrary number of waves and envelopes, determined via a constructor argument.<p>
|
|
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.
|
|
<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>
|
|
<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 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 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">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">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">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 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 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 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 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 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><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">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 "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">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">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>
|
|
</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">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<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="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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>
|
|
</tr>
|
|
</table>
|
|
<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></ul>
|
|
<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-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|