mirror of
https://github.com/thestk/stk
synced 2026-01-14 13:31:53 +00:00
149 lines
13 KiB
HTML
149 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="faq.html">FAQ</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.5.8 -->
|
|
<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" -->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>
|
|
<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">
|
|
|
|
<p><center><img src="classstk_1_1FM.png" usemap="#stk::FM_map" border="0" alt=""></center>
|
|
<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>
|
|
|
|
<p>
|
|
<a href="classstk_1_1FM-members.html">List of all members.</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="classstk_1_1FM.html#f4732c22ce00743e1f751880fa07aa15">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="#f4732c22ce00743e1f751880fa07aa15"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aba7e8bff02d105e146f8b62b20a27b9"></a><!-- doxytag: member="stk::FM::~FM" ref="aba7e8bff02d105e146f8b62b20a27b9" args="(void)" -->
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#aba7e8bff02d105e146f8b62b20a27b9">~FM</a> (void)</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="c5697f9929afd43379e8720f2f271b2d"></a><!-- doxytag: member="stk::FM::clear" ref="c5697f9929afd43379e8720f2f271b2d" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#c5697f9929afd43379e8720f2f271b2d">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" nowrap align="right" valign="top"><a class="anchor" name="0a32c8327e842bb71ce945024d583941"></a><!-- doxytag: member="stk::FM::loadWaves" ref="0a32c8327e842bb71ce945024d583941" args="(const char **filenames)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#0a32c8327e842bb71ce945024d583941">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" nowrap align="right" valign="top"><a class="anchor" name="8182c605d51ec623f90f4e07c2b90891"></a><!-- doxytag: member="stk::FM::setFrequency" ref="8182c605d51ec623f90f4e07c2b90891" args="(StkFloat frequency)" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#8182c605d51ec623f90f4e07c2b90891">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" nowrap align="right" valign="top"><a class="anchor" name="58f0898b677750a259036f628ec1a91b"></a><!-- doxytag: member="stk::FM::setRatio" ref="58f0898b677750a259036f628ec1a91b" args="(unsigned int waveIndex, StkFloat ratio)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#58f0898b677750a259036f628ec1a91b">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" nowrap align="right" valign="top"><a class="anchor" name="65a8c54556f0c288871876ffad4d9eef"></a><!-- doxytag: member="stk::FM::setGain" ref="65a8c54556f0c288871876ffad4d9eef" args="(unsigned int waveIndex, StkFloat gain)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#65a8c54556f0c288871876ffad4d9eef">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" nowrap align="right" valign="top"><a class="anchor" name="33e5d60131014a12a435c0ef20d104b6"></a><!-- doxytag: member="stk::FM::setModulationSpeed" ref="33e5d60131014a12a435c0ef20d104b6" args="(StkFloat mSpeed)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#33e5d60131014a12a435c0ef20d104b6">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" nowrap align="right" valign="top"><a class="anchor" name="11584256f23153551bc13b59518b415a"></a><!-- doxytag: member="stk::FM::setModulationDepth" ref="11584256f23153551bc13b59518b415a" args="(StkFloat mDepth)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#11584256f23153551bc13b59518b415a">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" nowrap align="right" valign="top"><a class="anchor" name="0425269a8fc0cc6bb7471d65b54b8a1a"></a><!-- doxytag: member="stk::FM::setControl1" ref="0425269a8fc0cc6bb7471d65b54b8a1a" args="(StkFloat cVal)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#0425269a8fc0cc6bb7471d65b54b8a1a">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" nowrap align="right" valign="top"><a class="anchor" name="d7e7d7067c8893040ef3bdf8a1fbe9ca"></a><!-- doxytag: member="stk::FM::setControl2" ref="d7e7d7067c8893040ef3bdf8a1fbe9ca" args="(StkFloat cVal)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#d7e7d7067c8893040ef3bdf8a1fbe9ca">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="fc46280177d770404919f20ccf88e4ff"></a><!-- doxytag: member="stk::FM::keyOn" ref="fc46280177d770404919f20ccf88e4ff" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#fc46280177d770404919f20ccf88e4ff">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" nowrap align="right" valign="top"><a class="anchor" name="7235e94a153df135330a591511269f7c"></a><!-- doxytag: member="stk::FM::keyOff" ref="7235e94a153df135330a591511269f7c" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#7235e94a153df135330a591511269f7c">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" nowrap align="right" valign="top"><a class="anchor" name="56cc61b1923dba2ff80859df4904d4f9"></a><!-- doxytag: member="stk::FM::noteOff" ref="56cc61b1923dba2ff80859df4904d4f9" args="(StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#56cc61b1923dba2ff80859df4904d4f9">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" nowrap align="right" valign="top"><a class="anchor" name="1db9d177363fb7d8dedb20fa0c9104f1"></a><!-- doxytag: member="stk::FM::controlChange" ref="1db9d177363fb7d8dedb20fa0c9104f1" args="(int number, StkFloat value)" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#1db9d177363fb7d8dedb20fa0c9104f1">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" nowrap align="right" valign="top"><a class="anchor" name="81f351fd8732fd6e686735b7b45a4241"></a><!-- doxytag: member="stk::FM::tick" ref="81f351fd8732fd6e686735b7b45a4241" args="(unsigned int)=0" -->
|
|
virtual StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1FM.html#81f351fd8732fd6e686735b7b45a4241">tick</a> (unsigned int)=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute and return one output sample. <br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK abstract <a class="el" href="classstk_1_1FM.html" title="STK abstract FM synthesis base class.">FM</a> 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="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>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" name="f4732c22ce00743e1f751880fa07aa15"></a><!-- doxytag: member="stk::FM::FM" ref="f4732c22ce00743e1f751880fa07aa15" 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>
|
|
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.
|
|
</div>
|
|
</div><p>
|
|
<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>
|
|
</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-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|