ref: ab2f66165913c6ea18e105ce5da7431fb21a2fbd
dir: /docs/leaf/group__tpluck.html/
<!-- HTML header for doxygen 1.8.18--> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8" /> <meta http-equiv="X-UA-Compatible" content="IE=9" /> <meta name="generator" content="Doxygen 1.8.16" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <title>LEAF: tPluck</title> <link href="tabs.css" rel="stylesheet" type="text/css" /> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <script type="text/javascript" src="../js/iframeResizer.contentWindow.min.js"></script> <!-- <script src="/js/template.js"></script> --> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(function() { init_search(); }); /* @license-end */ </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="customdoxygen.css" rel="stylesheet" type="text/css"/> <!-- <link rel="stylesheet" href="/css/tachyons.css" type="text/css" /> --> </head> <body class="bg-washed-green black-70 ph0 sans-serif" onload="iframeResizePipe()"> <div> <!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr> </tr> </tbody> </table> </div> <!-- end header part --> </div> </body> </html><!-- Generated by Doxygen 1.8.16 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); /* @license-end */ </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li class="current"><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> </div><!-- top --> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div class="header"> <div class="summary"> <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">tPluck<div class="ingroups"><a class="el" href="group__physical.html">Physical Models</a></div></div> </div> </div><!--header--> <div class="contents"> <p>Karplus-Strong model. <a href="#details">More...</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:gac7b5e386d09e10b097545b7f9ee3d161"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpluck.html#gac7b5e386d09e10b097545b7f9ee3d161">tPluck_init</a> (tPluck *const, float lowestFrequency, <a class="el" href="struct_l_e_a_f.html">LEAF</a> *const leaf)</td></tr> <tr class="memdesc:gac7b5e386d09e10b097545b7f9ee3d161"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tPluck to the default mempool of a <a class="el" href="struct_l_e_a_f.html" title="Struct for an instance of LEAF.">LEAF</a> instance. <a href="group__tpluck.html#gac7b5e386d09e10b097545b7f9ee3d161">More...</a><br /></td></tr> <tr class="separator:gac7b5e386d09e10b097545b7f9ee3d161"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga6fce342b82d04d5b30ebeadc0ac2102d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpluck.html#ga6fce342b82d04d5b30ebeadc0ac2102d">tPluck_initToPool</a> (tPluck *const, float lowestFrequency, tMempool *const)</td></tr> <tr class="memdesc:ga6fce342b82d04d5b30ebeadc0ac2102d"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tPluck to a specified mempool. <a href="group__tpluck.html#ga6fce342b82d04d5b30ebeadc0ac2102d">More...</a><br /></td></tr> <tr class="separator:ga6fce342b82d04d5b30ebeadc0ac2102d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gab05fa8211c49e8e1301882ba0dfb4933"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpluck.html#gab05fa8211c49e8e1301882ba0dfb4933">tPluck_free</a> (tPluck *const)</td></tr> <tr class="memdesc:gab05fa8211c49e8e1301882ba0dfb4933"><td class="mdescLeft"> </td><td class="mdescRight">Free a tPluck from its mempool. <a href="group__tpluck.html#gab05fa8211c49e8e1301882ba0dfb4933">More...</a><br /></td></tr> <tr class="separator:gab05fa8211c49e8e1301882ba0dfb4933"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga5abd143bdbe1ff441491b4a09218e967"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpluck.html#ga5abd143bdbe1ff441491b4a09218e967">tPluck_tick</a> (tPluck *const)</td></tr> <tr class="separator:ga5abd143bdbe1ff441491b4a09218e967"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga4e23f3d5ec42910130c176662e9d7e91"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpluck.html#ga4e23f3d5ec42910130c176662e9d7e91">tPluck_pluck</a> (tPluck *const, float amplitude)</td></tr> <tr class="memdesc:ga4e23f3d5ec42910130c176662e9d7e91"><td class="mdescLeft"> </td><td class="mdescRight">Pluck the string. <a href="group__tpluck.html#ga4e23f3d5ec42910130c176662e9d7e91">More...</a><br /></td></tr> <tr class="separator:ga4e23f3d5ec42910130c176662e9d7e91"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga4aa769eb18600d5f777a2d33e18fb7cb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpluck.html#ga4aa769eb18600d5f777a2d33e18fb7cb">tPluck_noteOn</a> (tPluck *const, float frequency, float amplitude)</td></tr> <tr class="memdesc:ga4aa769eb18600d5f777a2d33e18fb7cb"><td class="mdescLeft"> </td><td class="mdescRight">Start a note with the given frequency and amplitude. <a href="group__tpluck.html#ga4aa769eb18600d5f777a2d33e18fb7cb">More...</a><br /></td></tr> <tr class="separator:ga4aa769eb18600d5f777a2d33e18fb7cb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga215b593535f5bff5a6887ce905bc7602"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpluck.html#ga215b593535f5bff5a6887ce905bc7602">tPluck_noteOff</a> (tPluck *const, float amplitude)</td></tr> <tr class="memdesc:ga215b593535f5bff5a6887ce905bc7602"><td class="mdescLeft"> </td><td class="mdescRight">Stop a note with the given amplitude (speed of decay) <a href="group__tpluck.html#ga215b593535f5bff5a6887ce905bc7602">More...</a><br /></td></tr> <tr class="separator:ga215b593535f5bff5a6887ce905bc7602"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga9f20651baa36041ba43836dbe7c1de5b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpluck.html#ga9f20651baa36041ba43836dbe7c1de5b">tPluck_setFrequency</a> (tPluck *const, float frequency)</td></tr> <tr class="memdesc:ga9f20651baa36041ba43836dbe7c1de5b"><td class="mdescLeft"> </td><td class="mdescRight">Set instrument parameters for a particular frequency. <a href="group__tpluck.html#ga9f20651baa36041ba43836dbe7c1de5b">More...</a><br /></td></tr> <tr class="separator:ga9f20651baa36041ba43836dbe7c1de5b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga371e8ab225a043b3415979766647d155"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpluck.html#ga371e8ab225a043b3415979766647d155">tPluck_controlChange</a> (tPluck *const, int number, float value)</td></tr> <tr class="memdesc:ga371e8ab225a043b3415979766647d155"><td class="mdescLeft"> </td><td class="mdescRight">Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0). <a href="group__tpluck.html#ga371e8ab225a043b3415979766647d155">More...</a><br /></td></tr> <tr class="separator:ga371e8ab225a043b3415979766647d155"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga8a2365d67f4b17a4f578fbb14f280e74"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpluck.html#ga8a2365d67f4b17a4f578fbb14f280e74">tPluck_getLastOut</a> (tPluck *const)</td></tr> <tr class="separator:ga8a2365d67f4b17a4f578fbb14f280e74"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>Karplus-Strong model. </p> <h2 class="groupheader">Function Documentation</h2> <a id="gac7b5e386d09e10b097545b7f9ee3d161"></a> <h2 class="memtitle"><span class="permalink"><a href="#gac7b5e386d09e10b097545b7f9ee3d161">◆ </a></span>tPluck_init()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tPluck_init </td> <td>(</td> <td class="paramtype">tPluck * const </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>lowestFrequency</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="struct_l_e_a_f.html">LEAF</a> *const </td> <td class="paramname"><em>leaf</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Initialize a tPluck to the default mempool of a <a class="el" href="struct_l_e_a_f.html" title="Struct for an instance of LEAF.">LEAF</a> instance. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">string</td><td>A pointer to the tPluck to initialize. </td></tr> <tr><td class="paramname">leaf</td><td>A pointer to the leaf instance. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga6fce342b82d04d5b30ebeadc0ac2102d"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga6fce342b82d04d5b30ebeadc0ac2102d">◆ </a></span>tPluck_initToPool()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tPluck_initToPool </td> <td>(</td> <td class="paramtype">tPluck * const </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>lowestFrequency</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">tMempool * const </td> <td class="paramname"> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Initialize a tPluck to a specified mempool. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">string</td><td>A pointer to the tPluck to initialize. </td></tr> <tr><td class="paramname">mempool</td><td>A pointer to the tMempool to use. </td></tr> </table> </dd> </dl> </div> </div> <a id="gab05fa8211c49e8e1301882ba0dfb4933"></a> <h2 class="memtitle"><span class="permalink"><a href="#gab05fa8211c49e8e1301882ba0dfb4933">◆ </a></span>tPluck_free()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tPluck_free </td> <td>(</td> <td class="paramtype">tPluck * const </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Free a tPluck from its mempool. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">string</td><td>A pointer to the tPluck to free. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga5abd143bdbe1ff441491b4a09218e967"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga5abd143bdbe1ff441491b4a09218e967">◆ </a></span>tPluck_tick()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float tPluck_tick </td> <td>(</td> <td class="paramtype">tPluck * const </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">string</td><td>A pointer to the relevant tPluck. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga4e23f3d5ec42910130c176662e9d7e91"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga4e23f3d5ec42910130c176662e9d7e91">◆ </a></span>tPluck_pluck()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tPluck_pluck </td> <td>(</td> <td class="paramtype">tPluck * const </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>amplitude</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Pluck the string. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">string</td><td>A pointer to the relevant tPluck. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga4aa769eb18600d5f777a2d33e18fb7cb"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga4aa769eb18600d5f777a2d33e18fb7cb">◆ </a></span>tPluck_noteOn()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tPluck_noteOn </td> <td>(</td> <td class="paramtype">tPluck * const </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>frequency</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>amplitude</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Start a note with the given frequency and amplitude. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">string</td><td>A pointer to the relevant tPluck. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga215b593535f5bff5a6887ce905bc7602"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga215b593535f5bff5a6887ce905bc7602">◆ </a></span>tPluck_noteOff()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tPluck_noteOff </td> <td>(</td> <td class="paramtype">tPluck * const </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>amplitude</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Stop a note with the given amplitude (speed of decay) </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">string</td><td>A pointer to the relevant tPluck. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga9f20651baa36041ba43836dbe7c1de5b"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga9f20651baa36041ba43836dbe7c1de5b">◆ </a></span>tPluck_setFrequency()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tPluck_setFrequency </td> <td>(</td> <td class="paramtype">tPluck * const </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>frequency</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set instrument parameters for a particular frequency. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">string</td><td>A pointer to the relevant tPluck. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga371e8ab225a043b3415979766647d155"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga371e8ab225a043b3415979766647d155">◆ </a></span>tPluck_controlChange()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tPluck_controlChange </td> <td>(</td> <td class="paramtype">tPluck * const </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>number</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>value</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0). </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">string</td><td>A pointer to the relevant tPluck. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga8a2365d67f4b17a4f578fbb14f280e74"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga8a2365d67f4b17a4f578fbb14f280e74">◆ </a></span>tPluck_getLastOut()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float tPluck_getLastOut </td> <td>(</td> <td class="paramtype">tPluck * const </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">string</td><td>A pointer to the relevant tPluck. </td></tr> </table> </dd> </dl> </div> </div> </div><!-- contents --> <!-- HTML footer for doxygen 1.8.18--> <!-- start footer part --> </body> </html>