visus
/
teensy-audio
关注 1
点赞 0
派生 0
代码 工单 0 合并请求 0 版本发布 0 百科 动态
您最多选择25个主题 主题必须以字母或数字开头，可以包含连字符 (-)，并且长度不得超过35个字符
342 提交
2 分支
目录树: 29b7efaa2d
分支列表 标签列表
${ item.name }
创建分支 ${ searchTerm }
从 '29b7efaa2d'
${ noResults }
teensy-audio/gui/index.html

3125 行
121KB
原始文件 Blame 文件历史 

  1. <!DOCTYPE html>

  2. <!-- vim: set ts=4: -->

  3. <html>

  4. <meta charset="utf-8">

  5. <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=0"/>

  6. <meta name="apple-mobile-web-app-capable" content="yes">

  7. <meta name="mobile-web-app-capable" content="yes">

  8. 

  9. <!--

  10.   Modified from original Node-Red source, for audio system visualization

  11. 

  12.   Copyright 2013 IBM Corp.

  13. 

  14.   Licensed under the Apache License, Version 2.0 (the "License");

  15.   you may not use this file except in compliance with the License.

  16.   You may obtain a copy of the License at

  17. 

  18.   http://www.apache.org/licenses/LICENSE-2.0

  19. 

  20.   Unless required by applicable law or agreed to in writing, software

  21.   distributed under the License is distributed on an "AS IS" BASIS,

  22.   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  23.   See the License for the specific language governing permissions and

  24.   limitations under the License.

  25. -->

  26. <head>

  27. <title>Audio System Design Tool for Teensy Audio Library</title>

  28. <link href="bootstrap/css/bootstrap.min.css" rel="stylesheet" media="screen">

  29. <link href="jquery/css/smoothness/jquery-ui-1.10.3.custom.min.css" rel="stylesheet" media="screen">

  30. <link rel="stylesheet" type="text/css" href="orion/built-editor.css"/>

  31. <link rel="stylesheet" type="text/css" href="font-awesome/css/font-awesome.min.css"/>

  32. <link rel="stylesheet" href="style.css">

  33. <style>

  34. table.doc {border-spacing:3px; border-collapse:separate; font-size: 80%}

  35. tr.top {background-color:#C0C0C0}

  36. tr.odd {background-color:#F0F0F0}

  37. tr.even {background-color:#E0E0E0}

  38. p.func {padding-bottom:0; margin:0px}

  39. p.desc {padding-left:2em; margin:0px; padding-top:0.2em; padding-bottom:0.8em; font-size:0.75em}

  40. p.exam {padding-left:2em; text-indent:-1.2em; margin:0px; padding-top:0; padding-bottom:0.5em; font-size:0.75em; font-weight:bold}

  41. pre.desc {padding-left:3em; margin:0px; padding-top:0em; padding-bottom:0.8em; font-size:0.75em;

  42. 	background-color:#FFFFFF; border:0px; line-height:100%;

  43. }

  44. span.indent {padding-left:2em}

  45. span.literal {color: #006699}

  46. span.comment {color: #777755}

  47. span.keyword {color: #cc6600}

  48. span.function {color: #996600}

  49. span.mainfunction {color: #993300; font-weight: bolder}

  50. </style>

  51. </head>

  52. <body spellcheck="false">

  53. <div class="navbar navbar-inverse navbar-fixed-top">

  54. 	<div class="navbar-inner">

  55. 		<div class="container-fluid">

  56. 			<span class="brand">Audio System Design Tool for <a href="http://www.pjrc.com/teensy/td_libs_Audio.html" target="_blank">Teensy Audio Library</a></span>

  57. 			<div class="btn-group pull-right">

  58. 				<a class="btn dropdown-toggle" data-toggle="dropdown" href="#"><i class="icon-align-justify"></i> <span class="caret"></span></a>

  59. 				<ul class="dropdown-menu">

  60. 					<li><a id="btn-sidebar" tabindex="-1" href="#"><i class="icon-ok pull-right"></i><i class="icon-list-alt"></i> Sidebar</a></li>

  61. 					<li class="divider"></li>

  62. 					<!-- <li><a id="btn-node-status" tabindex="-1" href="#"><i class="icon-ok pull-right"></i><i class="icon-info-sign"></i> Node Status</a></li>

  63. 					<li class="divider"></li> -->

  64. 					<!--<li class="dropdown-submenu pull-left"><a tabindex="-1" href="#"><i class="icon-edit"></i> Import from...</a>

  65. 						<ul class="dropdown-menu">

  66. 							<li><a id="btn-import" tabindex="-1" href="#"><i class="icon-edit"></i> Clipboard...</a></li>

  67. 							<li id="flow-menu-parent" class="dropdown-submenu pull-left">

  68. 								<a tabindex="-1" href="#"><i class="icon-book"></i> Library</a>

  69. 								<ul class="dropdown-menu"></ul>

  70. 							</li>

  71. 						</ul>

  72. 					</li>

  73. 					<li id="li-menu-export" class="dropdown-submenu disabled pull-left"><a tabindex="-1" href="#"><i class="icon-share"></i> Export to...</a>

  74. 						<ul class="dropdown-menu">

  75. 							<li id="li-menu-export-clipboard" class="disabled"><a id="btn-export-clipboard" tabindex="-1" href="#"><i class="icon-share"></i> Clipboard...</a></li>

  76. 							<li id="li-menu-export-library" class="disabled"><a id="btn-export-library" tabindex="-1" href="#"><i class="icon-book"></i> Library...</a></li>

  77. 						</ul>

  78. 					</li>

  79. 					<li class="divider"></li>-->

  80. 					<!-- <li><a id="btn-config-nodes" tabindex="-1" href="#"><i class="icon-th-list"></i> Configuration nodes...</a></li>

  81. 					<li class="divider"></li>-->

  82. 					<!--<li class="dropdown-submenu pull-left"><a tabindex="-1" href="#"><i class="icon-th-large"></i> Workspaces</a>

  83. 						<ul id="workspace-menu-list" class="dropdown-menu">

  84. 							<li><a id="btn-workspace-add" tabindex="-1" href="#"><i class="icon-plus"></i> Add</a></li>

  85. 							<li><a id="btn-workspace-edit" tabindex="-1" href="#"><i class="icon-edit"></i> Rename</a></li>

  86. 							<li><a id="btn-workspace-delete" tabindex="-1" href="#"><i class="icon-minus"></i> Delete</a></li>

  87. 							<li class="divider"></li>

  88. 						</ul>

  89. 					</li>

  90. 					<li class="divider"></li>-->

  91. 					<li><a id="btn-keyboard-shortcuts" tabindex="-1" href="#"><i class="icon-question-sign"></i> Keyboard Shortcuts</a></li>

  92. 					<li><a id="btn-help" tabindex="-1" href="http://node-red.github.io/docs" target="_blank"><i class="icon-question-sign"></i> Help...</a></li>

  93. 				</ul>

  94. 			</div>

  95. 			<div class="btn-group pull-left">

  96. 				<a id="btn-deploy" class="btn action-deploy disabled" href="#"><i id="btn-icn-deploy" class="icon-upload"></i>Export</a>

  97. 			</div>

  98. 		</div>

  99. 	</div>

  100. </div>

  101. <div id="main-container" class="sidebar-closed">

  102. 	<div id="palette">

  103. 		<img src="img/spin.svg" class="palette-spinner"/>

  104. 		<div id="palette-container" class="palette-scroll">

  105. 		</div>

  106. 		<div id="palette-search">

  107. 			<i class="icon-search"></i><input id="palette-search-input" type="text" placeholder="filter"><a href="#" id="palette-search-clear"><i class="icon-remove"></i></a></input>

  108. 		</div>

  109. 	</div><!-- /palette -->

  110. 

  111. 	<div id="workspace">

  112. 		<ul id="workspace-tabs"></ul>

  113. 		<!--<div id="workspace-add-tab"><a id="btn-workspace-add-tab" href="#"><i class="icon-plus"></i></a></div>-->

  114. 		<div id="chart"></div>

  115. 		<div id="workspace-toolbar">

  116. 			<div class="btn-group">

  117. 				<a class="btn btn-small" href="#"><i class="icon-zoom-out"></i></a>

  118. 				<a class="btn btn-small" href="#"><i class="icon-th"></i></a>

  119. 				<a class="btn btn-small" href="#"><i class="icon-zoom-in"></i></a>

  120. 			</div>

  121. 		</div>

  122. 	</div>

  123. 

  124. 	<div id="chart-zoom-controls">

  125. 		<div class="btn-group">

  126. 			<a class="btn btn-mini" id="btn-zoom-out" href="#"><i class="icon-zoom-out"></i></a>

  127. 			<a class="btn btn-mini" id="btn-zoom-zero" href="#"><i class="icon-th"></i></a>

  128. 			<a class="btn btn-mini" id="btn-zoom-in" href="#"><i class="icon-zoom-in"></i></a>

  129. 		</div>

  130. 	</div>

  131. 

  132. 	<div id="sidebar">

  133. 		<ul id="sidebar-tabs"></ul>

  134. 		<div id="sidebar-content"></div>

  135. 	</div>

  136. 

  137. 	<div id="sidebar-separator"></div>

  138. 

  139. </div>

  140. 

  141. <div id="notifications"></div>

  142. <div id="dropTarget"><div>Drop the flow here</div></div>

  143. 

  144. <div id="dialog" class="hide"><form id="dialog-form" class="form-horizontal"></form></div>

  145. <div id="node-config-dialog" class="hide"><form id="dialog-config-form" class="form-horizontal"></form><div class="form-tips" id="node-config-dialog-user-count"></div></div>

  146. 

  147. <div id="node-dialog-confirm-deploy" class="hide">

  148. 	<form class="form-horizontal">

  149. 		<div id="node-dialog-confirm-deploy-config" style="text-align: center; padding-top: 30px;">

  150. 		 Some of the nodes are not properly configured. Are you sure you want to deploy?

  151. 		</div>

  152. 		<div id="node-dialog-confirm-deploy-unknown" style="text-align: center; padding-top: 10px;">

  153. 		 The workspace contains some unknown node types:

  154. 		 <ul style="width: 300px; margin: auto; text-align: left;" id="node-dialog-confirm-deploy-unknown-list"></ul>

  155. 		 Are you sure you want to deploy?

  156. 		</div>

  157. 	</form>

  158. </div>

  159. 

  160. <div id="node-help" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="node-help-label" aria-hidden="true">

  161.   <div class="modal-header">

  162. 	<h5 id="node-help-label">Keyboard Shortcuts <span style="float: right;"><a href="http://node-red.github.io/docs" target="_blank">Open help in new window &raquo;</a></span></h5>

  163.   </div>

  164.   <div class="modal-body">

  165. 	<table>

  166. 		<tr>

  167. 		  <td><span class="help-key">?</span></td><td>Help</td>

  168. 		  <td><span class="help-key">Ctrl</span> <span class="help-key">a</span></td><td>Select all nodes</td>

  169. 		</tr>

  170. 		<tr>

  171. 		  <td><span class="help-key">Ctrl</span> <span class="help-key">Space</span></td><td>Toggle sidebar</td>

  172. 		  <td><span class="help-key">Shift</span> <span class="help-key">Click</span></td><td>Select all connected nodes</td>

  173. 		</tr>

  174. 		<tr>

  175. 		  <td><span class="help-key">Ctrl</span> <span class="help-key">z</span></td><td>Undo</td>

  176. 		  <td><span class="help-key">Ctrl</span> <span class="help-key">Click</span></td><td>Add/remove node from selection</td>

  177. 		</tr>

  178. 		<tr>

  179. 		  <td></td><td></td>

  180. 		  <td><span class="help-key">Delete</span></td><td>Delete selected nodes or link</td>

  181. 		</tr>

  182. 		<tr>

  183. 		  <td><span class="help-key">Ctrl</span> <span class="help-key">x</span></td><td>Cut selected nodes</td>

  184. 		  <td></td><td></td>

  185. 		</tr>

  186. 		<tr>

  187. 		  <td><span class="help-key">Ctrl</span> <span class="help-key">c</span></td><td>Copy selected nodes</td>

  188. 		  <td><span class="help-key">Ctrl</span> <span class="help-key">v</span></td><td>Paste nodes</td>

  189. 		</tr>

  190. 		<tr>

  191. 		  <td><span class="help-key">Ctrl</span> <span class="help-key">i</span></td><td>Import nodes</td>

  192. 		  <td><span class="help-key">Ctrl</span> <span class="help-key">e</span></td><td>Export selected nodes</td>

  193. 		</tr>

  194. 		<tr>

  195. 		  <td colspan="2"></td>

  196. 		</tr>

  197. 		<tr>

  198. 		  <td><span class="help-key">Ctrl</span> <span class="help-key">+</span></td><td>Zoom in</td>

  199. 		  <td><span class="help-key">Ctrl</span> <span class="help-key">-</span></td><td>Zoom out</td>

  200. 		</tr>

  201. 	</table>

  202.   </div>

  203.   <div class="modal-footer">

  204. 	<button class="btn" data-dismiss="modal" aria-hidden="true">Close</button>

  205.   </div>

  206. </div>

  207. 

  208. <div id="node-dialog-library-save-confirm" class="hide">

  209. 	<form class="form-horizontal">

  210. 		<div style="text-align: center; padding-top: 30px;">

  211. 		 A <span id="node-dialog-library-save-type"></span> called <span id="node-dialog-library-save-name"></span> already exists. Overwrite?

  212. 		</div>

  213. 	</form>

  214. </div>

  215. 

  216. <div id="node-dialog-library-save" class="hide">

  217. 	<form class="form-horizontal">

  218. 		<div class="form-row">

  219. 			<label for="node-dialog-library-save-folder"><i class="icon-folder-open"></i> Folder</label>

  220. 			<input type="text" id="node-dialog-library-save-folder" placeholder="Folder">

  221. 		</div>

  222. 		<div class="form-row">

  223. 			<label for="node-dialog-library-save-filename"><i class="icon-file"></i> Filename</label>

  224. 			<input type="text" id="node-dialog-library-save-filename" placeholder="Filename">

  225. 		</div>

  226. 	</form>

  227. </div>

  228. 

  229. <div id="node-dialog-library-lookup" class="hide">

  230. 	<form class="form-horizontal">

  231. 		<div class="form-row">

  232. 			<ul id="node-dialog-library-breadcrumbs" class="breadcrumb">

  233. 				<li class="active"><a href="#">Library</a></li>

  234. 			</ul>

  235. 		</div>

  236. 		<div class="form-row">

  237. 			<div style="vertical-align: top; display: inline-block; height: 100%; width: 30%; padding-right: 20px;">

  238. 				<div id="node-select-library" style="border: 1px solid #999; width: 100%; height: 100%; overflow:scroll;"><ul></ul></div>

  239. 			</div>

  240. 			<div style="vertical-align: top; display: inline-block;width: 65%; height: 100%;">

  241. 				<div style="height: 100%; width: 95%;" class="node-text-editor" id="node-select-library-text" ></div>

  242. 			</div>

  243. 		</div>

  244. 	</form>

  245. </div>

  246. <div id="node-dialog-rename-workspace" class="hide">

  247. 	<form class="form-horizontal">

  248. 		<div class="form-row">

  249. 			<label for="node-input-workspace-name" ><i class="icon-tag"></i> Name:</label>

  250. 			<input type="text" id="node-input-workspace-name">

  251. 		</div>

  252. 	</form>

  253. </div>

  254. <div id="node-dialog-delete-workspace" class="hide">

  255. 	<form class="form-horizontal">

  256. 		<div style="text-align: center; padding-top: 30px;">

  257. 		 Are you sure you want to delete '<span id="node-dialog-delete-workspace-name"></span>'?

  258. 		</div>

  259. 	</form>

  260. </div>

  261. 

  262. <script type="text/x-red" data-template-name="export-clipboard-dialog">

  263. 	<div class="form-row">

  264. 		<label for="node-input-export" style="display: block; width:100%;"><i class="icon-share"></i> Source Code:</label>

  265. 		<textarea readonly style="font-family: monospace; font-size: 12px; background:rgb(226, 229, 255); padding-left: 0.5em;" class="input-block-level" id="node-input-export" rows="12"></textarea>

  266. 	</div>

  267. 	<div class="form-tips">

  268. 		Select the text above and copy to the clipboard with Ctrl-A Ctrl-C.

  269. 	</div>

  270. </script>

  271. <script type="text/x-red" data-template-name="export-library-dialog">

  272. 	<div class="form-row">

  273. 		<label for="node-input-filename" ><i class="icon-tag"></i> Filename:</label>

  274. 		<input type="text" id="node-input-filename" placeholder="Filename">

  275. 	</div>

  276. </script>

  277. <script type="text/x-red" data-template-name="import-dialog">

  278. 	<div class="form-row">

  279. 		<label for="node-input-export"><i class="icon-share"></i>Nodes:</label>

  280. 		<textarea style="font-family: monospace; font-size: 12px; background:rgb(226, 229, 255); padding-left: 0.5em;" class="input-block-level" id="node-input-import" rows="5" placeholder="Paste nodes here, or lookup in the library"></textarea>

  281. 	</div>

  282. </script>

  283. 

  284. <script src="jquery/js/jquery-1.9.1.js"></script>

  285. <script src="bootstrap/js/bootstrap.min.js"></script>

  286. <script src="jquery/js/jquery-ui-1.10.3.custom.min.js"></script>

  287. <script src="jquery/js/jquery.ui.touch-punch.min.js"></script>

  288. <script src="orion/built-editor.min.js"></script>

  289. <script src="red/d3/d3.v3.min.js"></script>

  290. <script src="red/main.js"></script>

  291. <script src="red/ui/state.js"></script>

  292. <script src="red/nodes.js"></script>

  293. <script src="red/storage.js"></script>

  294. <script src="red/history.js"></script>

  295. <script src="red/ui/keyboard.js"></script>

  296. <script src="red/ui/tabs.js"></script>

  297. <script src="red/ui/view.js"></script>

  298. <script src="red/ui/sidebar.js"></script>

  299. <script src="red/ui/palette.js"></script>

  300. <script src="red/ui/tab-info.js"></script>

  301. <script src="red/ui/tab-config.js"></script>

  302. <script src="red/ui/editor.js"></script>

  303. <script src="red/ui/library.js"></script>

  304. <script src="red/ui/notifications.js"></script>

  305. <script src="red/ui/touch/radialMenu.js"></script>

  306. 

  307. 

  308. 

  309. <!-- TODO: generate some or all of this automatically from the C++ source -->

  310. 

  311. <!-- TODO: add a field for maximum instance count -->

  312. <!-- TODO: add a field for exclusive to other objects (not allowed if they're used) -->

  313. <!-- TODO: add "parameters" fields, to replace the form html stuff -->

  314. 

  315. <script type="text/javascript">

  316. 	RED.nodes.registerType('AudioInputI2S',{

  317. 	shortName: "i2s",

  318. 		inputs:0,

  319. 		outputs:2,

  320. 		category: 'input-function',

  321. 		color:"#E6E0F8",

  322. 		icon: "arrow-in.png"

  323. 	});

  324. </script>

  325. <script type="text/x-red" data-help-name="AudioInputI2S">

  326. 	<h3>Summary</h3>

  327. 	<p>Receive 16 bit stereo audio from the

  328. 	<a href="http://www.pjrc.com/store/teensy3_audio.html" target="_blank">audio shield</a>

  329. 		or another I2S device, using I2S master mode.</p>

  330. 	<p align=center><img src="img/audioshield_inputs.jpg"></p>

  331. 	<h3>Audio Connections</h3>

  332. 	<table class=doc align=center cellpadding=3>

  333. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  334. 		<tr class=odd><td align=center>Out 0</td><td>Left Channel</td></tr>

  335. 		<tr class=odd><td align=center>Out 1</td><td>Right Channel</td></tr>

  336. 	</table>

  337. 	<h3>Functions</h3>

  338. 	<p>This object has no functions to call from the Arduino sketch.  It

  339. 		simply streams data from the I2S hardware to its 2 output ports.</p>

  340. 	<h3>Hardware</h3>

  341. 	<p align=center><img src="img/audioshield_backside.jpg"></p>

  342. 	<p>The I2S signals are used in "master" mode, where Teensy creates

  343. 		all 3 clock signals and controls all data timing.</p>

  344. 	<table class=doc align=center cellpadding=3>

  345. 		<tr class=top><th>Pin</th><th>Signal</th><th>Direction</th></tr>

  346. 		<tr class=odd><td align=center>9</td><td>BCLK</td><td>Output</td></tr>

  347. 		<tr class=odd><td align=center>11</td><td>MCLK</td><td>Output</td></tr>

  348. 		<tr class=odd><td align=center>13</td><td>RX</td><td>Input</td></tr>

  349. 		<tr class=odd><td align=center>23</td><td>LRCLK</td><td>Output</td></tr>

  350. 	</table>

  351. 	<p>Audio from

  352. 		master mode I2S may be used in the same project as ADC, DAC and

  353. 		PWM signals, because all remain in sync to Teensy's timing</p>

  354. 	<h3>Examples</h3>

  355. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; PassThroughStereo

  356. 	</p>

  357. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Recorder

  358. 	</p>

  359. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Analysis &gt; PeakMeterStereo

  360. 	</p>

  361. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Analysis &gt; FFT

  362. 	</p>

  363. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Analysis &gt; SpectrumAnalyzerBasic

  364. 	</p>

  365. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Effects &gt; Chorus

  366. 	</p>

  367. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Effects &gt; Flange

  368. 	</p>

  369. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Effects &gt; Filter

  370. 	</p>

  371. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Effects &gt; Filter_FIR

  372. 	</p>

  373. 	<h3>Notes</h3>

  374. 	<p>Normally, this object is used with the Audio Shield, which

  375. 		is controlled separately by the "sgtl5000" object.</p>

  376. 	<p>Only one I2S input and one I2S output object may be used.  Master

  377. 		and slave modes may not be mixed (both must be of the same type).

  378. 	</p>

  379. 	<p>I2S master objects can be used together with non-I2S input and output

  380. 		objects, for simultaneous audio streaming on different hardware.</p>

  381. </script>

  382. <script type="text/x-red" data-template-name="AudioInputI2S">

  383. 	<div class="form-row">

  384. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  385. 		<input type="text" id="node-input-name" placeholder="Name">

  386. 	</div>

  387. </script>

  388. 

  389. 

  390. <script type="text/javascript">

  391. 	RED.nodes.registerType('AudioInputAnalog',{

  392. 	shortName: "adc",

  393. 		inputs:0,

  394. 		outputs:1,

  395. 		category: 'input-function',

  396. 		color:"#E6E0F8",

  397. 		icon: "arrow-in.png"

  398. 	});

  399. </script>

  400. <script type="text/x-red" data-help-name="AudioInputAnalog">

  401. 	<h3>Summary</h3>

  402. 	<p>Receive audio using the built-in analog to digital converter.</p>

  403. 	<h3>Audio Connections</h3>

  404. 	<table class=doc align=center cellpadding=3>

  405. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  406. 		<tr class=odd><td align=center>Out 0</td><td>Audio Channel</td></tr>

  407. 	</table>

  408. 	<h3>Functions</h3>

  409. 	<p>This object has no functions to call from the Arduino sketch.  It

  410. 		simply streams data from the ADC to its output port.</p>

  411. 	<h3>Hardware</h3>

  412. 	<p>Pin A2 is used for audio input.  This circuitry is recommended.</p>

  413. 	<p align=center><img src="img/adccircuit.png"></p>

  414. 	<p>Signal range is 0 to 1.2V</p>

  415. 	<h3>Examples</h3>

  416. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; PassThroughMono

  417. 	</p>

  418. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Analysis &gt; PeakMeterMono

  419. 	</p>

  420. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Analysis &gt; DialTone_7segment

  421. 	</p>

  422. 	<h3>Notes</h3>

  423. 	<p>A different pin may be used, but adding it as an parameter

  424. 		to the AudioInputAnalog object definition.

  425. 	</p>

  426. 	<p>For example, to use pin A3:

  427. 	</p>

  428. 	<p class=desc><span class=keyword>AudioInputAnalog</span>  adc1(<span class=literal>A3</span>);

  429. 	</p>

  430. 

  431. 	<p>Noise due to high source impedance, which allows rapidly switching digital signals

  432. 		to capacitively couple... avoiding higher analog impedance is the solution.</p>

  433. 	<p>Power Supply rejection issue with simple DC bias (bigger capacitor may be needed if 3.3V has low frequency noise)</p>

  434. 	<p>Algorithm for automatic DC bias tracking</p>

  435. 	<p>TODO: actual noise measurements with different input circuitry

  436. 		(it's not as quiet as the audio shield)</p>

  437. </script>

  438. <script type="text/x-red" data-template-name="AudioInputAnalog">

  439. 	<div class="form-row">

  440. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  441. 		<input type="text" id="node-input-name" placeholder="Name">

  442. 	</div>

  443. </script>

  444. 

  445. 

  446. <script type="text/javascript">

  447. 	RED.nodes.registerType('AudioInputI2Sslave',{

  448. 	shortName: "i2ss",

  449. 		inputs:0,

  450. 		outputs:2,

  451. 		category: 'input-function',

  452. 		color:"#E6E0F8",

  453. 		icon: "arrow-in.png"

  454. 	});

  455. </script>

  456. <script type="text/x-red" data-help-name="AudioInputI2Sslave">

  457. 	<h3>Summary</h3>

  458. 	<p>Receive 16 bit stereo audio from an I2S device using I2S slave mode.</p>

  459. 	<h3>Audio Connections</h3>

  460. 	<table class=doc align=center cellpadding=3>

  461. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  462. 		<tr class=odd><td align=center>Out 0</td><td>Left Channel</td></tr>

  463. 		<tr class=odd><td align=center>Out 1</td><td>Right Channel</td></tr>

  464. 	</table>

  465. 	<h3>Functions</h3>

  466. 	<p>This object has no functions to call from the Arduino sketch.  It

  467. 		simply streams data from the I2S hardware to its 2 output ports.</p>

  468. 	<h3>Hardware</h3>

  469. 	<p>The I2S signals are used in "slave" mode, where the I2S device controls

  470. 		data timing.</p>

  471. 	<table class=doc align=center cellpadding=3>

  472. 		<tr class=top><th>Pin</th><th>Signal</th><th>Direction</th></tr>

  473. 		<tr class=odd><td align=center>9</td><td>BCLK</td><td>Input</td></tr>

  474. 		<tr class=odd><td align=center>13</td><td>RX</td><td>Input</td></tr>

  475. 		<tr class=odd><td align=center>23</td><td>LRCLK</td><td>Input</td></tr>

  476. 	</table>

  477. 	<!--<h3>Examples</h3>

  478. 	<p class=exam>File &gt; Examples &gt; Audio &gt; 

  479. 	</p>-->

  480. 	<h3>Notes</h3>

  481. 	<p>Slave mode I2S <b>should not used in the same project as ADC, DAC and

  482. 		PWM</b> signals.  Differences in timing between the I2S device and

  483. 		Teensy's clock can cause occasional audio glitches when I2S slave mode

  484. 		is used together with other input or output objects based on Teensy's

  485. 		timing.</p>

  486. 	<p>Only one I2S input and one I2S output object may be used.  Master

  487. 		and slave modes may not be mixed (both must be of the same type).

  488. 	</p>

  489. </script>

  490. <script type="text/x-red" data-template-name="AudioInputI2Sslave">

  491. 	<div class="form-row">

  492. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  493. 		<input type="text" id="node-input-name" placeholder="Name">

  494. 	</div>

  495. </script>

  496. 

  497. 

  498. 

  499. 

  500. <script type="text/javascript">

  501. 	RED.nodes.registerType('AudioOutputI2S',{

  502. 	shortName: "i2s",

  503. 		inputs:2,

  504. 		outputs:0,

  505. 		category: 'output-function',

  506. 		color:"#E6E0F8",

  507. 		icon: "arrow-in.png"

  508. 	});

  509. </script>

  510. <script type="text/x-red" data-help-name="AudioOutputI2S">

  511. 	<h3>Summary</h3>

  512. 	<p>Transmit 16 bit stereo audio to the

  513. 	<a href="http://www.pjrc.com/store/teensy3_audio.html" target="_blank">audio shield</a>

  514. 		or another I2S device, using I2S master mode.</p>

  515. 	<p align=center><img src="img/audioshield_outputs.jpg"></p>

  516. 	<h3>Audio Connections</h3>

  517. 	<table class=doc align=center cellpadding=3>

  518. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  519. 		<tr class=odd><td align=center>In 0</td><td>Left Channel</td></tr>

  520. 		<tr class=odd><td align=center>In 1</td><td>Right Channel</td></tr>

  521. 	</table>

  522. 	<h3>Functions</h3>

  523. 	<p>This object has no functions to call from the Arduino sketch.  It

  524. 		simply streams data from its 2 input ports to the I2S hardware.</p>

  525. 	<h3>Hardware</h3>

  526. 	<p align=center><img src="img/audioshield_backside.jpg"></p>

  527. 	<p>The I2S signals are used in "master" mode, where Teensy creates

  528. 		all 3 clock signals and controls all data timing.</p>

  529. 	<table class=doc align=center cellpadding=3>

  530. 		<tr class=top><th>Pin</th><th>Signal</th><th>Direction</th></tr>

  531. 		<tr class=odd><td align=center>9</td><td>BCLK</td><td>Output</td></tr>

  532. 		<tr class=odd><td align=center>11</td><td>MCLK</td><td>Output</td></tr>

  533. 		<tr class=odd><td align=center>22</td><td>TX</td><td>Output</td></tr>

  534. 		<tr class=odd><td align=center>23</td><td>LRCLK</td><td>Output</td></tr>

  535. 	</table>

  536. 	<p>Audio from

  537. 		master mode I2S may be used in the same project as ADC, DAC and

  538. 		PWM signals, because all remain in sync to Teensy's timing</p>

  539. 	<h3>Examples</h3>

  540. 	<p>Nearly all the examples use this object.  Here are some of the highlights:</p>

  541. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; PassThroughStereo

  542. 	</p>

  543. 	<p class=exam>File &gt; Examples &gt; Audio &gt; SamplePlayer

  544. 	</p>

  545. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Recorder

  546. 	</p>

  547. 	<p class=exam>File &gt; Examples &gt; Audio &gt; WavFilePlayer

  548. 	</p>

  549. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Effects &gt; Chorus

  550. 	</p>

  551. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Synthesis &gt; PlaySynthMusic

  552. 	</p>

  553. 	<h3>Notes</h3>

  554. 	<p>Normally, this object is used with the Audio Shield, which

  555. 		is controlled separately by the "sgtl5000" object.</p>

  556. 	<p>Only one I2S input and one I2S output object may be used.  Master

  557. 		and slave modes may not be mixed (both must be of the same type).

  558. 	</p>

  559. </script>

  560. <script type="text/x-red" data-template-name="AudioOutputI2S">

  561. 	<div class="form-row">

  562. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  563. 		<input type="text" id="node-input-name" placeholder="Name">

  564. 	</div>

  565. </script>

  566. 

  567. 

  568. <script type="text/javascript">

  569. 	RED.nodes.registerType('AudioOutputSPDIF',{

  570. 	shortName: "spdif",

  571. 		inputs:2,

  572. 		outputs:0,

  573. 		category: 'output-function',

  574. 		color:"#E6E0F8",

  575. 		icon: "arrow-in.png"

  576. 	});

  577. </script>

  578. <script type="text/x-red" data-help-name="AudioOutputSPDIF">

  579. 	<h3>Summary</h3>

  580. 	<p>Transmit 16 bit stereo audio as Digital S/PDIF.</p>

  581. 	<p align=center><img src="img/spdif_proto.jpg"></p>

  582. 	<h3>Audio Connections</h3>

  583. 	<table class=doc align=center cellpadding=3>

  584. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  585. 		<tr class=odd><td align=center>In 0</td><td>Left Channel</td></tr>

  586. 		<tr class=odd><td align=center>In 1</td><td>Right Channel</td></tr>

  587. 	</table>

  588. 	<h3>Functions</h3>

  589. 	<p>This object has no functions to call from the Arduino sketch.  It

  590. 		simply streams data from its 2 input ports S/PDIF encoded digital

  591. 		audio on pin 22.</p>

  592. 	<h3>Hardware</h3>

  593. 	<p>The S/PDIF output signal can be used to drive an optical TOSLINK

  594. 		cable, or a standard (usually orange) RCA jack.</p>

  595. 	<table class=doc align=center cellpadding=3>

  596. 		<tr class=top><th>Pin</th><th>Signal</th><th>Direction</th></tr>

  597. 		<tr class=odd><td align=center>22</td><td>S/PDIF</td><td>Output</td></tr>

  598. 	</table>

  599. 	<p>For optical TOSLINK output, this

  600. 		<a href="https://www.oshpark.com/shared_projects/KcDBKHta" target="_blank">OSH Park board</a>

  601. 		can be used with the inexpensive Everlight PLT133/T6A connector, available

  602. 		at Digikey, 1080-1434-ND.

  603. 		</p>

  604. 	<h3>Examples</h3>

  605. 	<p>The AudioOutputSPDIF object can be used in place of the AudioOutputI2S object,

  606. 	<p>used in nearly all the examples.  The WavFilePlayer shows how to substitute

  607. 		output objects for different hardware types.

  608. 	</p>

  609. 	<p class=exam>File &gt; Examples &gt; Audio &gt; WavFilePlayer

  610. 	</p>

  611. 	<h3>Credits</h3>

  612. 	<p><a href="https://github.com/FrankBoesing" target="_blank">Frank Boesing</a>

  613. 		developed the AudioOutputSPDIF code.  The original

  614. 		<a href="https://forum.pjrc.com/threads/28639-S-pdif" target="_blank">forum disussion</a>

  615. 		included valuable input and code from "kpc".

  616. 	<h3>Notes</h3>

  617. 	<p>S/PDIF output uses the I2S hardware.  This object can not be used

  618. 		together with any of the I2S objects, because it requires the I2S

  619. 		hardware with different internal settings.</p>

  620. 	</p>

  621. </script>

  622. <script type="text/x-red" data-template-name="AudioOutputSPDIF">

  623. 	<div class="form-row">

  624. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  625. 		<input type="text" id="node-input-name" placeholder="Name">

  626. 	</div>

  627. </script>

  628. 

  629. 

  630. <script type="text/javascript">

  631. 	RED.nodes.registerType('AudioOutputAnalog',{

  632. 	shortName: "dac",

  633. 		inputs:1,

  634. 		outputs:0,

  635. 		category: 'output-function',

  636. 		color:"#E6E0F8",

  637. 		icon: "arrow-in.png"

  638. 	});

  639. </script>

  640. <script type="text/x-red" data-help-name="AudioOutputAnalog">

  641. 	<h3>Summary</h3>

  642. 	<p>Transmit 12 bit audio using Teensy 3.1's built-in digital to analog converter.</p>

  643. 	<h3>Audio Connections</h3>

  644. 	<table class=doc align=center cellpadding=3>

  645. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  646. 		<tr class=odd><td align=center>In 0</td><td>Audio Channel</td></tr>

  647. 	</table>

  648. 	<h3>Functions</h3>

  649. 	<p>This object has no functions to call from the Arduino sketch.  It

  650. 		simply streams data from the ADC to its output port.</p>

  651. 	<h3>Hardware</h3>

  652. 	<p align=center><img src="img/dacpin.jpg"></p>

  653. 	<p>Signal range is 0 to 1.2V</p>

  654. 	<p>Most applications require at least a 10&micro;F DC-blocking capacitor.</p>

  655. 	<p>TODO: photo of Teensy 3.1 with 10&micro;F capacitor and 3.5mm jack.</p>

  656. 	<h3>Examples</h3>

  657. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; PassThroughMono

  658. 	</p>

  659. 	<p class=exam>File &gt; Examples &gt; Audio &gt; SamplePlayer

  660. 	</p>

  661. 	<h3>Notes</h3>

  662. 	<p>The output rate is 44.1 kHz (no oversampling).  Ultrasonic noise present if

  663. 		not filtered.  This may not

  664. 		be an issue for many uses, but care should be used if amplified and driven

  665. 		to high power tweeters.</p>

  666. </script>

  667. <script type="text/x-red" data-template-name="AudioOutputAnalog">

  668. 	<div class="form-row">

  669. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  670. 		<input type="text" id="node-input-name" placeholder="Name">

  671. 	</div>

  672. </script>

  673. 

  674. 

  675. <script type="text/javascript">

  676. 	RED.nodes.registerType('AudioOutputPWM',{

  677. 	shortName: "pwm",

  678. 		inputs:1,

  679. 		outputs:0,

  680. 		category: 'output-function',

  681. 		color:"#E6E0F8",

  682. 		icon: "arrow-in.png"

  683. 	});

  684. </script>

  685. <script type="text/x-red" data-help-name="AudioOutputPWM">

  686. 	<h3>Summary</h3>

  687. 	<p>Transmit audio using Teensy 3.1's PWM pins.  Two pins are

  688. 		used for coarse and fine pulses, to be combined by scaled

  689. 		resistors.</p>

  690. 	<h3>Audio Connections</h3>

  691. 	<table class=doc align=center cellpadding=3>

  692. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  693. 		<tr class=odd><td align=center>In 0</td><td>Audio Channel</td></tr>

  694. 	</table>

  695. 	<h3>Functions</h3>

  696. 	<p>This object has no functions to call from the Arduino sketch.  It

  697. 		simply streams data from the its input port to the PWM pins.</p>

  698. 	<h3>Hardware</h3>

  699. 	<p>The following circuit is recommended.</p>

  700. 	<p align=center><img src="img/pwmdualcircuit.jpg"></p>

  701. 	<p>Signal range is approx 1.55 Vp-p.</p>

  702. 	<p>These resistor values assume approx 20 ohms output impedance

  703. 		on the digital pins.  The 127K resistor may be adjusted or

  704. 		trimmed for variation in output drive and tolerance on the

  705. 		475 ohm resistor.</p>

  706. 	<p>A plastic film (Polypropylene, Polyethylene, Polyester, etc) or

  707. 		C0G/NPO ceramic capacitor should be used for filtering.  Low

  708. 		quality ceramic (X7R, Y5V, Z5U, etc) can cause signal distortion.</p>

  709. 	<h3>Examples</h3>

  710. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; PassThroughMono

  711. 	</p>

  712. 	<h3>Notes</h3>

  713. 	<p>This object only works properly when Tools > CPU_Speed is set to

  714. 		48 or 96 MHz.  Other speeds aren't supported and will likely fail

  715. 		in strange ways.</p>

  716. 	<p>The PWM carrier frequency is 88.2 kHz.  The suggested circuit

  717. 		will only slightly filter the carrier.  Extra filtering will be

  718. 		required for a clean signal without the ultrasonic PWM carrier.

  719. 		</p>

  720. 	<p>Analog signals created by filtering PWM waveforms use the digital

  721. 		power supply as their reference voltage.  Any noise on the digital

  722. 		power line can directly couple to the output signal.  The built-in DAC or

  723. 		<a href="http://www.pjrc.com/store/teensy3_audio.html" target="_blank">audio shield</a>

  724. 		should be used when higher quality signals are needed.</p>

  725. </script>

  726. <script type="text/x-red" data-template-name="AudioOutputPWM">

  727. 	<div class="form-row">

  728. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  729. 		<input type="text" id="node-input-name" placeholder="Name">

  730. 	</div>

  731. </script>

  732. 

  733. 

  734. <script type="text/javascript">

  735. 	RED.nodes.registerType('AudioOutputI2Sslave',{

  736. 	shortName: "i2ss",

  737. 		inputs:2,

  738. 		outputs:0,

  739. 		category: 'output-function',

  740. 		color:"#E6E0F8",

  741. 		icon: "arrow-in.png"

  742. 	});

  743. </script>

  744. <script type="text/x-red" data-help-name="AudioOutputI2Sslave">

  745. 	<h3>Summary</h3>

  746. 	<p>Transmit 16 bit stereo audio to an I2S device using I2S slave mode.</p>

  747. 	<h3>Audio Connections</h3>

  748. 	<table class=doc align=center cellpadding=3>

  749. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  750. 		<tr class=odd><td align=center>In 0</td><td>Left Channel</td></tr>

  751. 		<tr class=odd><td align=center>In 1</td><td>Right Channel</td></tr>

  752. 	</table>

  753. 	<h3>Functions</h3>

  754. 	<p>This object has no functions to call from the Arduino sketch.  It

  755. 		simply streams data from its 2 input ports to the I2S hardware.</p>

  756. 	<h3>Hardware</h3>

  757. 	<p>The I2S signals are used in "slave" mode, where the I2S device controls

  758. 		data timing.</p>

  759. 	<table class=doc align=center cellpadding=3>

  760. 		<tr class=top><th>Pin</th><th>Signal</th><th>Direction</th></tr>

  761. 		<tr class=odd><td align=center>9</td><td>BCLK</td><td>Input</td></tr>

  762. 		<tr class=odd><td align=center>22</td><td>TX</td><td>Output</td></tr>

  763. 		<tr class=odd><td align=center>23</td><td>LRCLK</td><td>Input</td></tr>

  764. 	</table>

  765. 	<h3>Examples</h3>

  766. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; WM8731MikroSine

  767. 	</p>

  768. 	<h3>Notes</h3>

  769. 	<p>Slave mode I2S <b>should not used in the same project as ADC, DAC and

  770. 		PWM</b> signals.  Differences in timing between the I2S device and

  771. 		Teensy's clock can cause occasional audio glitches when I2S slave mode

  772. 		is used together with other input or output objects based on Teensy's

  773. 		timing.</p>

  774. 	<p>Only one I2S input and one I2S output object may be used.  Master

  775. 		and slave modes may not be mixed (both must be of the same type).

  776. 	</p>

  777. </script>

  778. <script type="text/x-red" data-template-name="AudioOutputI2Sslave">

  779. 	<div class="form-row">

  780. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  781. 		<input type="text" id="node-input-name" placeholder="Name">

  782. 	</div>

  783. </script>

  784. 

  785. 

  786. <script type="text/javascript">

  787. 	RED.nodes.registerType('AudioMixer4',{

  788. 	shortName: "mixer",

  789. 		inputs:4,

  790. 		outputs:1,

  791. 		category: 'mixer-function',

  792. 		color:"#E6E0F8",

  793. 		icon: "arrow-in.png"

  794. 	});

  795. </script>

  796. <script type="text/x-red" data-help-name="AudioMixer4">

  797. 	<h3>Summary</h3>

  798. 	<p>Combine up to 4 audio signals together, each with adjustable gain.

  799. 		All channels support signal attenuation or amplification.</p>

  800. 	<h3>Audio Connections</h3>

  801. 	<table class=doc align=center cellpadding=3>

  802. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  803. 		<tr class=odd><td align=center>In 0</td><td>Input signal #1</td></tr>

  804. 		<tr class=odd><td align=center>In 1</td><td>Input signal #2</td></tr>

  805. 		<tr class=odd><td align=center>In 2</td><td>Input signal #3</td></tr>

  806. 		<tr class=odd><td align=center>In 3</td><td>Input signal #4</td></tr>

  807. 		<tr class=odd><td align=center>Out 0</td><td>Sum of all inputs</td></tr>

  808. 	</table>

  809. 	<h3>Functions</h3>

  810. 	<p class=func><span class=keyword>gain</span>(channel, level);</p>

  811. 	<p class=desc>Adjust the amplification or attenuation.  "channel" must

  812. 		be 0 to 3.  "level" may be any floating point number from 0 to 32767.

  813. 		1.0 passes the signal through directly.  Level of 0 shuts the channel

  814. 		off completely.  Between 0 to 1.0 attenuates the signal, and above

  815. 		1.0 amplifies it.  All 4 channels have separate settings.

  816. 	</p>

  817. 	<h3>Examples</h3>

  818. 	<p class=exam>File &gt; Examples &gt; Audio &gt; SamplePlayer

  819. 	</p>

  820. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Synthesis &gt; PlaySynthMusic

  821. 	</p>

  822. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Analysis &gt; SpectrumAnalyzerBasic

  823. 	</p>

  824. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Analysis &gt; DialTone_Serial

  825. 	</p>

  826. 	<p class=exam>File &gt; Examples &gt; Audio &gt; MemoryAndCpuUsage

  827. 	</p>

  828. 	<h3>Notes</h3>

  829. 	<p>Signal clipping can occur when any channel has gain greater than 1.0,

  830. 		or when multiple signals add together to greater than 1.0.</p>

  831. 	<p>More than 4 channels may be combined by connecting multiple mixers

  832. 		in tandem.  For example, a 16 channel mixer may be built using 5

  833. 		mixers, where the fifth mixer combines the outputs of the first 4.

  834. 	</p>

  835. </script>

  836. <script type="text/x-red" data-template-name="AudioMixer4">

  837. 	<div class="form-row">

  838. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  839. 		<input type="text" id="node-input-name" placeholder="Name">

  840. 	</div>

  841. </script>

  842. 

  843. 

  844. 

  845. <script type="text/javascript">

  846. 	RED.nodes.registerType('AudioPlayMemory',{

  847. 	shortName: "playMem",

  848. 		inputs:0,

  849. 		outputs:1,

  850. 		category: 'play-function',

  851. 		color:"#E6E0F8",

  852. 		icon: "arrow-in.png"

  853. 	});

  854. </script>

  855. <script type="text/x-red" data-help-name="AudioPlayMemory">

  856. 	<h3>Summary</h3>

  857. 	<p>Play a short sound clip, stored directly in memory.

  858. 		Data files are created with the

  859. 		<a href="https://github.com/PaulStoffregen/Audio/tree/master/examples/SamplePlayer/wav2sketch" target="_blank">wav2sketch program</a>,

  860. 		and copied to the sketch folder to become part of your sketch.</p>

  861. 	<h3>Audio Connections</h3>

  862. 	<table class=doc align=center cellpadding=3>

  863. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  864. 		<tr class=odd><td align=center>Out 0</td><td>Sound Output</td></tr>

  865. 	</table>

  866. 	<h3>Functions</h3>

  867. 	<p class=func><span class=keyword>play</span>(data);</p>

  868. 	<p class=desc>Begin playing a sound clip.  If already playing, the

  869. 		currently playing clip is stopped and this new data begins

  870. 		playing from the beginning.

  871. 	</p>

  872. 	<p class=func><span class=keyword>stop</span>();</p>

  873. 	<p class=desc>Stop playing.  If not playing, this function has no effect.

  874. 	</p>

  875. 	<p class=func><span class=keyword>isPlaying</span>();</p>

  876. 	<p class=desc>Return true (non-zero) if playing, or false (zero)

  877. 		when not playing.

  878. 	</p>

  879. 	<p class=func><span class=keyword>positionMillis</span>();</p>

  880. 	<p class=desc>While playing, return the current time offset, in

  881. 		milliseconds.  When not playing, the return from this function

  882. 		is undefined.

  883. 	</p>

  884. 	<p class=func><span class=keyword>lengthMillis</span>();</p>

  885. 	<p class=desc>Return the total length of the current sound clip,

  886. 		in milliseconds.  When not playing, the return from this function

  887. 		is undefined.

  888. 	</p>

  889. 	<h3>Examples</h3>

  890. 	<p class=exam>File &gt; Examples &gt; Audio &gt; SamplePlayer

  891. 	</p>

  892. 	<h3>Notes</h3>

  893. 	<p>TODO: supported sample rates: 11.025, 22.05, 44.1</p>

  894. 	<p>TODO: ulaw vs uncompressed encoding</p>

  895. 	<p>Polyphonic playback can be built by creating multiple

  896. 		objects, with their output combined by mixers.</p>

  897. </script>

  898. <script type="text/x-red" data-template-name="AudioPlayMemory">

  899. 	<div class="form-row">

  900. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  901. 		<input type="text" id="node-input-name" placeholder="Name">

  902. 	</div>

  903. </script>

  904. 

  905. 

  906. 

  907. <script type="text/javascript">

  908. 	RED.nodes.registerType('AudioPlaySdWav',{

  909. 	shortName: "playSdWav",

  910. 		inputs:0,

  911. 		outputs:2,

  912. 		category: 'play-function',

  913. 		color:"#E6E0F8",

  914. 		icon: "arrow-in.png"

  915. 	});

  916. </script>

  917. <script type="text/x-red" data-help-name="AudioPlaySdWav">

  918. 	<h3>Summary</h3>

  919. 	<p>Play a WAV file, stored on a SD card.</p>

  920. 	<h3>Audio Connections</h3>

  921. 	<table class=doc align=center cellpadding=3>

  922. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  923. 		<tr class=odd><td align=center>Out 0</td><td>Left Channel Output</td></tr>

  924. 		<tr class=odd><td align=center>Out 1</td><td>Right Channel Output</td></tr>

  925. 	</table>

  926. 	<h3>Functions</h3>

  927. 	<p class=func><span class=keyword>play</span>(filename);</p>

  928. 	<p class=desc>Begin playing a WAV file.  If a file is already playing,

  929. 		it is stopped and this file starts playing from the beginning.

  930. 	</p>

  931. 	<p class=func><span class=keyword>stop</span>();</p>

  932. 	<p class=desc>Stop playing.  If not playing, this function has no effect.

  933. 	</p>

  934. 	<p class=func><span class=keyword>isPlaying</span>();</p>

  935. 	<p class=desc>Return true (non-zero) if playing, or false (zero)

  936. 		when not playing.  See the note below about delayed start.

  937. 	</p>

  938. 	<p class=func><span class=keyword>positionMillis</span>();</p>

  939. 	<p class=desc>While playing, return the current time offset, in

  940. 		milliseconds.  When not playing, the return from this function

  941. 		is undefined.

  942. 	</p>

  943. 	<p class=func><span class=keyword>lengthMillis</span>();</p>

  944. 	<p class=desc>Return the total length of the current sound clip,

  945. 		in milliseconds.  When not playing, the return from this function

  946. 		is undefined.

  947. 	</p>

  948. 	<h3>Examples</h3>

  949. 	<p class=exam>File &gt; Examples &gt; Audio &gt; WavFilePlayer

  950. 	</p>

  951. 	<h3>Notes</h3>

  952. 	<p>Only 16 bit PCM, 44100 Hz WAV files are supported.  When mono

  953. 		files are played, both output ports transmit a copy of the

  954. 		single sound.  Of course, stereo WAV files play with the left

  955. 		channel on port 0 and the right channel on port 1.

  956. 	</p>

  957. 	<p>A brief delay after calling play() will usually occur before

  958. 		isPlaying() returns true and positionMillis() returns valid

  959. 		time offset.  WAV files have a header at the beginning of the

  960. 		file, which the audio library must read and parse before

  961. 		playing can begin.

  962. 	</p>

  963. 	<p>While playing, the audio library accesses the SD card automatically.

  964. 		If card access is required, you must

  965. 		<a href="http://www.pjrc.com/teensy/td_libs_AudioProcessorUsage.html" target="_blank">use AudioNoInterrupts()</a>

  966. 		to prevent the library from accessing the SD card while you use it.

  967. 		Disabling the audio library interrupt for too long may cause audible

  968. 		dropouts or glitches.

  969. 	</p>

  970. </script>

  971. <script type="text/x-red" data-template-name="AudioPlaySdWav">

  972. 	<div class="form-row">

  973. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  974. 		<input type="text" id="node-input-name" placeholder="Name">

  975. 	</div>

  976. </script>

  977. 

  978. 

  979. 

  980. <script type="text/javascript">

  981. 	RED.nodes.registerType('AudioPlaySdRaw',{

  982. 	shortName: "playSdRaw",

  983. 		inputs:0,

  984. 		outputs:1,

  985. 		category: 'play-function',

  986. 		color:"#E6E0F8",

  987. 		icon: "arrow-in.png"

  988. 	});

  989. </script>

  990. <script type="text/x-red" data-help-name="AudioPlaySdRaw">

  991. 	<h3>Summary</h3>

  992. 	<p>Play a RAW data file, stored on a SD card.  RAW format is simpler

  993. 		than WAV and begins playing immediately, without parsing WAV file

  994. 		header info.</p>

  995. 	<h3>Audio Connections</h3>

  996. 	<table class=doc align=center cellpadding=3>

  997. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  998. 		<tr class=odd><td align=center>Out 0</td><td>Sound Output</td></tr>

  999. 	</table>

  1000. 	<h3>Functions</h3>

  1001. 	<p class=func><span class=keyword>play</span>(filename);</p>

  1002. 	<p class=desc>Begin playing a RAW data file.  If a file is already playing,

  1003. 		it is stopped and this file starts playing from the beginning.

  1004. 	</p>

  1005. 	<p class=func><span class=keyword>stop</span>();</p>

  1006. 	<p class=desc>Stop playing.  If not playing, this function has no effect.

  1007. 	</p>

  1008. 	<p class=func><span class=keyword>isPlaying</span>();</p>

  1009. 	<p class=desc>Return true (non-zero) if playing, or false (zero)

  1010. 		when not playing.

  1011. 	</p>

  1012. 	<p class=func><span class=keyword>positionMillis</span>();</p>

  1013. 	<p class=desc>While playing, return the current time offset, in

  1014. 		milliseconds.  When not playing, the return from this function

  1015. 		is undefined.

  1016. 	</p>

  1017. 	<p class=func><span class=keyword>lengthMillis</span>();</p>

  1018. 	<p class=desc>Return the total length of the current sound clip,

  1019. 		in milliseconds.  When not playing, the return from this function

  1020. 		is undefined.

  1021. 	</p>

  1022. 	<h3>Examples</h3>

  1023. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Recorder

  1024. 	</p>

  1025. 	<h3>Notes</h3>

  1026. 	<p>The data file must be RAW 16 bit signed integers in LSB-first format.

  1027. 	</p>

  1028. 	<p>While playing, the audio library accesses the SD card automatically.

  1029. 		If card access is required, you must

  1030. 		<a href="http://www.pjrc.com/teensy/td_libs_AudioProcessorUsage.html" target="_blank">AudioNoInterrupts()</a>

  1031. 		to prevent the library from accessing the SD card while you use it.

  1032. 		Disabling the audio library interrupt for too long may cause audible

  1033. 		dropouts or glitches.

  1034. 	</p>

  1035. </script>

  1036. <script type="text/x-red" data-template-name="AudioPlaySdRaw">

  1037. 	<div class="form-row">

  1038. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  1039. 		<input type="text" id="node-input-name" placeholder="Name">

  1040. 	</div>

  1041. </script>

  1042. 

  1043. 

  1044. <script type="text/javascript">

  1045. 	RED.nodes.registerType('AudioPlaySerialflashRaw',{

  1046. 	shortName: "playFlashRaw",

  1047. 		inputs:0,

  1048. 		outputs:1,

  1049. 		category: 'play-function',

  1050. 		color:"#E6E0F8",

  1051. 		icon: "arrow-in.png"

  1052. 	});

  1053. </script>

  1054. <script type="text/x-red" data-help-name="AudioPlaySerialflashRaw">

  1055. 	<h3>Summary</h3>

  1056. 	<div>

  1057. 	<p>Play a RAW data file, stored on a Serial Flash chip.  These chips

  1058. 		are far more efficient than SD cards, allowing many files to be

  1059. 		played simultaneously by copies of this object.

  1060. 		</p>

  1061. 	<p align=center><img src="img/w25q128fv.jpg"><br><small>W25Q128FV Serial Flash</small></p>

  1062. 	</div>

  1063. 	<h3>Audio Connections</h3>

  1064. 	<table class=doc align=center cellpadding=3>

  1065. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  1066. 		<tr class=odd><td align=center>Out 0</td><td>Sound Output</td></tr>

  1067. 	</table>

  1068. 	<h3>Functions</h3>

  1069. 	<p class=func><span class=keyword>play</span>(filename);</p>

  1070. 	<p class=desc>Begin playing a RAW data file.  If a file is already playing,

  1071. 		it is stopped and this file starts playing from the beginning.

  1072. 	</p>

  1073. 	<p class=func><span class=keyword>stop</span>();</p>

  1074. 	<p class=desc>Stop playing.  If not playing, this function has no effect.

  1075. 	</p>

  1076. 	<p class=func><span class=keyword>isPlaying</span>();</p>

  1077. 	<p class=desc>Return true (non-zero) if playing, or false (zero)

  1078. 		when not playing.

  1079. 	</p>

  1080. 	<p class=func><span class=keyword>positionMillis</span>();</p>

  1081. 	<p class=desc>While playing, return the current time offset, in

  1082. 		milliseconds.  When not playing, the return from this function

  1083. 		is undefined.

  1084. 	</p>

  1085. 	<p class=func><span class=keyword>lengthMillis</span>();</p>

  1086. 	<p class=desc>Return the total length of the current sound clip,

  1087. 		in milliseconds.  When not playing, the return from this function

  1088. 		is undefined.

  1089. 	</p>

  1090. 	<h3>Examples</h3>

  1091. 	<!--<p class=exam>File &gt; Examples &gt; Audio &gt; Recorder-->

  1092. 	<p class=exam>TODO: play example needed....

  1093. 	</p>

  1094. 	<p class=exam>File &gt; Examples &gt; SerialFlash &gt; CopyFromSD

  1095. 	</p>

  1096. 	<h3>Notes</h3>

  1097. 	<p>The data file must be RAW 16 bit signed integers in LSB-first format.

  1098. 	</p>

  1099. 	<p>The <a href="https://github.com/PaulStoffregen/SerialFlash" target="_blank">SerialFlash library</a>

  1100. 		is used to access the flash chip.  You can also use SerialFlash's functions

  1101. 		to access the stored files, or add data to the flash chip.

  1102. 	</p>

  1103. 	<p>File names are case sensitive with SerialFlash.  If your sound does

  1104. 		not play, use <b>File &gt; Examples &gt; SerialFlash &gt; ListFiles</b> to

  1105. 		check the exact file names stored in the flash memory chip.

  1106. </script>

  1107. <script type="text/x-red" data-template-name="AudioPlaySerialflashRaw">

  1108. 	<div class="form-row">

  1109. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  1110. 		<input type="text" id="node-input-name" placeholder="Name">

  1111. 	</div>

  1112. </script>

  1113. 

  1114. 

  1115. <script type="text/javascript">

  1116. 	RED.nodes.registerType('AudioPlayQueue',{

  1117. 	shortName: "queue",

  1118. 		inputs:0,

  1119. 		outputs:1,

  1120. 		category: 'play-function',

  1121. 		color:"#E6E0F8",

  1122. 		icon: "arrow-in.png"

  1123. 	});

  1124. </script>

  1125. <script type="text/x-red" data-help-name="AudioPlayQueue">

  1126. 	<h3>Summary</h3>

  1127. 	<p>Play audio data provided by the Arduino sketch.  This object provides

  1128. 		functions to allow the sketch code to push data into the audio system.</p>

  1129. 	<h3>Audio Connections</h3>

  1130. 	<table class=doc align=center cellpadding=3>

  1131. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  1132. 		<tr class=odd><td align=center>Out 0</td><td>Sound Output</td></tr>

  1133. 	</table>

  1134. 	<h3>Functions</h3>

  1135. 	<p class=func><span class=keyword>play</span>(int16);</p>

  1136. 	<p class=desc>not yet implemented

  1137. 	</p>

  1138. 	<p class=func><span class=keyword>play</span>(int16[], length);</p>

  1139. 	<p class=desc>not yet implemented

  1140. 	</p>

  1141. 	<p class=func><span class=keyword>getBuffer</span>();</p>

  1142. 	<p class=desc>Returns a pointer to an array of 128 int16.  This buffer

  1143. 		is within the audio library memory pool, providing the most efficient

  1144. 		way to input data to the audio system.  The buffer is likely to be

  1145. 		populated by previously used data, so the entire 128 words should be

  1146. 		written before calling playBuffer().  Only a single buffer should be

  1147. 		requested at a time.  This function may return NULL if no memory is

  1148. 		available.

  1149. 	</p>

  1150. 	<p class=func><span class=keyword>playBuffer</span>();</p>

  1151. 	<p class=desc>Transmit the buffer previously obtained from getBuffer().

  1152. 	</p>

  1153. 	<h3>Examples</h3>

  1154. 		<p><a href="http://community.arm.com/groups/embedded/blog/2014/05/23/led-video-panel-at-maker-faire-2014" target="_blank">4320 LED Video+Sound Project</a>

  1155. 		</p>

  1156. 	<!--<p class=exam>File &gt; Examples &gt; Audio &gt; 

  1157. 	</p>-->

  1158. 	<h3>Notes</h3>

  1159. 	<p>TODO: many caveats....</p>

  1160. 	<p>

  1161. 	</p>

  1162. </script>

  1163. <script type="text/x-red" data-template-name="AudioPlayQueue">

  1164. 	<div class="form-row">

  1165. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  1166. 		<input type="text" id="node-input-name" placeholder="Name">

  1167. 	</div>

  1168. </script>

  1169. 

  1170. 

  1171. 

  1172. <script type="text/javascript">

  1173. 	RED.nodes.registerType('AudioRecordQueue',{

  1174. 	shortName: "queue",

  1175. 		inputs:1,

  1176. 		outputs:0,

  1177. 		category: 'record-function',

  1178. 		color:"#E6E0F8",

  1179. 		icon: "arrow-in.png"

  1180. 	});

  1181. </script>

  1182. <script type="text/x-red" data-help-name="AudioRecordQueue">

  1183. 	<h3>Summary</h3>

  1184. 	<p>Record audio data by sending to the Arduino sketch.  This object allows

  1185. 		sketch code to receive audio packets.</p>

  1186. 	<h3>Audio Connections</h3>

  1187. 	<table class=doc align=center cellpadding=3>

  1188. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  1189. 		<tr class=odd><td align=center>In 0</td><td>Sound To Access</td></tr>

  1190. 	</table>

  1191. 	<h3>Functions</h3>

  1192. 	<p class=func><span class=keyword>begin</span>();</p>

  1193. 	<p class=desc>Begin capturing incoming audio to the queue.  After calling

  1194. 		begin, readBuffer() and freeBuffer(), or clear() must be used frequently

  1195. 		to prevent the queue from filling up.

  1196. 	</p>

  1197. 	<p class=func><span class=keyword>available</span>();</p>

  1198. 	<p class=desc>Returns the number of audio packets available to read.

  1199. 	</p>

  1200. 	<p class=func><span class=keyword>readBuffer</span>();</p>

  1201. 	<p class=desc>Read a single audio packet.  A pointer to a 128 sample

  1202. 		array of 16 bit integers is returned.  NULL is returned if no packets

  1203. 		are available.

  1204. 	</p>

  1205. 	<p class=func><span class=keyword>freeBuffer</span>();</p>

  1206. 	<p class=desc>Release the memory from the previously read packet returned

  1207. 		from readBuffer().  Only a single packet at a time may be read, and

  1208. 		each packet must be freed with this function, to return the memory to

  1209. 		the audio library.

  1210. 	</p>

  1211. 	<p class=func><span class=keyword>clear</span>();</p>

  1212. 	<p class=desc>Discard all audio held in the queue.

  1213. 	</p>

  1214. 	<p class=func><span class=keyword>end</span>();</p>

  1215. 	<p class=desc>Stop capturing incoming audio into the queue.  Data already

  1216. 		captured remains in the queue and may be read with readBuffer().

  1217. 	</p>

  1218. 	<h3>Examples</h3>

  1219. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Recorder

  1220. 	</p>

  1221. 	<h3>Notes</h3>

  1222. 	<p>

  1223. 		Up to 52 packets may be queued by this object, which allows approximately

  1224. 		150 ms of audio to be held in the queue, to allow time for the Arduino

  1225. 		sketch to write data to media or do other high-latency tasks.

  1226. 

  1227. The actual packets are taken

  1228. 		from the pool created by AudioMemory().

  1229. 	</p>

  1230. </script>

  1231. <script type="text/x-red" data-template-name="AudioRecordQueue">

  1232. 	<div class="form-row">

  1233. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  1234. 		<input type="text" id="node-input-name" placeholder="Name">

  1235. 	</div>

  1236. </script>

  1237. 

  1238. 

  1239. 

  1240. 

  1241. 

  1242. <script type="text/javascript">

  1243. 	RED.nodes.registerType('AudioSynthWaveformSine',{

  1244. 	shortName: "sine",

  1245. 		inputs:0,

  1246. 		outputs:1,

  1247. 		category: 'synth-function',

  1248. 		color:"#E6E0F8",

  1249. 		icon: "arrow-in.png"

  1250. 	});

  1251. </script>

  1252. <script type="text/x-red" data-help-name="AudioSynthWaveformSine">

  1253. 	<h3>Summary</h3>

  1254. 	<p>Create a sine wave signal</p>

  1255. 	<h3>Audio Connections</h3>

  1256. 	<table class=doc align=center cellpadding=3>

  1257. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  1258. 		<tr class=odd><td align=center>Out 0</td><td>Sine Wave Output</td></tr>

  1259. 	</table>

  1260. 	<h3>Functions</h3>

  1261. 	<p class=func><span class=keyword>amplitude</span>(level);</p>

  1262. 	<p class=desc>Set the amplitude, from 0 to 1.0.

  1263. 	</p>

  1264. 	<p class=func><span class=keyword>frequency</span>(freq);</p>

  1265. 	<p class=desc>Set the frequency, from 0 to 22000.  Very low values may

  1266. 		be used to create a LFO (Low Frequency Oscillator) for objects

  1267. 		with modulation signal inputs.

  1268. 	</p>

  1269. 	<p class=func><span class=keyword>phase</span>(angle);</p>

  1270. 	<p class=desc>

  1271. 		Cause the generated waveform to jump to a specific point within

  1272. 		its cycle.  Angle is from 0 to 360 degrees.  When multiple objects

  1273. 		are configured,

  1274. 		<a href="http://www.pjrc.com/teensy/td_libs_AudioProcessorUsage.html" target="_blank">AudioNoInterrupts()</a>

  1275. 		should be used to guarantee all new settings take effect together.

  1276. 	</p>

  1277. 	<h3>Examples</h3>

  1278. 	<p class=exam>File &gt; Examples &gt; Audio &gt; MemoryAndCpuUsage

  1279. 	</p>

  1280. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Analysis &gt; DialTone_Serial

  1281. 	</p>

  1282. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Analysis &gt; FFT

  1283. 	</p>

  1284. 	<h3>Notes</h3>

  1285. 	<p></p>

  1286. </script>

  1287. <script type="text/x-red" data-template-name="AudioSynthWaveformSine">

  1288. 	<div class="form-row">

  1289. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  1290. 		<input type="text" id="node-input-name" placeholder="Name">

  1291. 	</div>

  1292. </script>

  1293. 

  1294. 

  1295. 

  1296. <script type="text/javascript">

  1297. 	RED.nodes.registerType('AudioSynthWaveformSineModulated',{

  1298. 	shortName: "sine_fm",

  1299. 		inputs:1,

  1300. 		outputs:1,

  1301. 		category: 'synth-function',

  1302. 		color:"#E6E0F8",

  1303. 		icon: "arrow-in.png"

  1304. 	});

  1305. </script>

  1306. <script type="text/x-red" data-help-name="AudioSynthWaveformSineModulated">

  1307. 	<h3>Summary</h3>

  1308. 	<p>Create a modulated sine wave, using any audio signal to continuously

  1309. 		modulate the sine wave frequency.</p>

  1310. 	<h3>Audio Connections</h3>

  1311. 	<table class=doc align=center cellpadding=3>

  1312. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  1313. 		<tr class=odd><td align=center>In 0</td><td>Modulation Signal</td></tr>

  1314. 		<tr class=odd><td align=center>Out 0</td><td>Sine Wave Output</td></tr>

  1315. 	</table>

  1316. 	<h3>Functions</h3>

  1317. 	<p class=func><span class=keyword>amplitude</span>(level);</p>

  1318. 	<p class=desc>Set the amplitude, from 0 to 1.0.

  1319. 	</p>

  1320. 	<p class=func><span class=keyword>frequency</span>(freq);</p>

  1321. 	<p class=desc>Set the center frequency, from 0 to 11000.  The output will

  1322. 		be this center frequency when the input modulation signal is zero.

  1323. 		Modulation input 1.0 causes the frequency to double, and input -1.0

  1324. 		causes zero Hz (DC) output.  For less modulation, attenuate the input

  1325. 		signal (perhaps with a mixer object) before it arrives here.

  1326. 	</p>

  1327. 	<p class=func><span class=keyword>phase</span>(angle);</p>

  1328. 	<p class=desc>

  1329. 		Cause the generated waveform to jump to a specific point within

  1330. 		its cycle.  Angle is from 0 to 360 degrees.  When multiple objects

  1331. 		are configured,

  1332. 		<a href="http://www.pjrc.com/teensy/td_libs_AudioProcessorUsage.html" target="_blank">AudioNoInterrupts()</a>

  1333. 		should be used to guarantee all new settings take effect together.

  1334. 	</p>

  1335. 	<!--<h3>Examples</h3>

  1336. 	<p class=exam>File &gt; Examples &gt; Audio &gt; 

  1337. 	</p>-->

  1338. 	<h3>Notes</h3>

  1339. 	<p></p>

  1340. </script>

  1341. <script type="text/x-red" data-template-name="AudioSynthWaveformSineModulated">

  1342. 	<div class="form-row">

  1343. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  1344. 		<input type="text" id="node-input-name" placeholder="Name">

  1345. 	</div>

  1346. </script>

  1347. 

  1348. 

  1349. 

  1350. <script type="text/javascript">

  1351. 	RED.nodes.registerType('AudioSynthWaveform',{

  1352. 	shortName: "waveform",

  1353. 		inputs:0,

  1354. 		outputs:1,

  1355. 		category: 'synth-function',

  1356. 		color:"#E6E0F8",

  1357. 		icon: "arrow-in.png"

  1358. 	});

  1359. </script>

  1360. <script type="text/x-red" data-help-name="AudioSynthWaveform">

  1361. 	<h3>Summary</h3>

  1362. 	<p>Create a waveform: sine, sawtooth, square, triangle, pulse or arbitrary.</p>

  1363. 	<h3>Audio Connections</h3>

  1364. 	<table class=doc align=center cellpadding=3>

  1365. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  1366. 		<tr class=odd><td align=center>Out 0</td><td>Waveform Output</td></tr>

  1367. 	</table>

  1368. 	<h3>Functions</h3>

  1369. 	<p class=func><span class=keyword>begin</span>(waveform);</p>

  1370. 	<p class=desc>Configure the waveform type to create.

  1371. 	</p>

  1372. 	<p class=func><span class=keyword>begin</span>(level, frequency, waveform);</p>

  1373. 	<p class=desc>Output a waveform, and set the amplitude and frequency.

  1374. 	</p>

  1375. 	<p class=func><span class=keyword>frequency</span>(freq);</p>

  1376. 	<p class=desc>Change the frequency.

  1377. 	</p>

  1378. 	<p class=func><span class=keyword>amplitude</span>(level);</p>

  1379. 	<p class=desc>Change the amplitude.  Set to 0 to turn the signal off.

  1380. 	</p>

  1381. 	<p class=func><span class=keyword>phase</span>(angle);</p>

  1382. 	<p class=desc>

  1383. 		Cause the generated waveform to jump to a specific point within

  1384. 		its cycle.  Angle is from 0 to 360 degrees.  When multiple objects

  1385. 		are configured,

  1386. 		<a href="http://www.pjrc.com/teensy/td_libs_AudioProcessorUsage.html" target="_blank">AudioNoInterrupts()</a>

  1387. 		should be used to guarantee all new settings take effect together.

  1388. 	</p>

  1389. 	<p class=func><span class=keyword>pulseWidth</span>(amount);</p>

  1390. 	<p class=desc>Change the width (duty cycle) of the pulse.</p>

  1391. 	<p class=func><span class=keyword>arbitraryWaveform</span>(array, maxFreq);</p>

  1392. 	<p class=desc>

  1393. 		Configure the waveform to be used with WAVEFORM_ARBITRARY.  Array

  1394. 		must be an array of 256 samples.  Currently, the data is used

  1395. 		without any filtering, which can cause aliasing with frequencies

  1396. 		above 172 Hz.  For higher frequency output, you must bandwidth

  1397. 		limit your waveform data.  Someday, "maxFreq" will be used to

  1398. 		do this automatically.

  1399. 	</p>

  1400. 	<h3>Examples</h3>

  1401. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Synthesis &gt; PlaySynthMusic

  1402. 	</p>

  1403. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Synthesis &gt; pulseWidth

  1404. 	</p>

  1405. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; WM8731MikroSine

  1406. 	</p>

  1407. 	<h3>Notes</h3>

  1408. 	<p>Supported Waveforms:<br>

  1409. 		<ul>

  1410. 		<li><span class=literal>WAVEFORM_SINE</span></li>

  1411. 		<li><span class=literal>WAVEFORM_SAWTOOTH</span></li>

  1412. 		<li><span class=literal>WAVEFORM_SQUARE</span></li>

  1413. 		<li><span class=literal>WAVEFORM_TRIANGLE</span></li>

  1414. 		<li><span class=literal>WAVEFORM_ARBITRARY</span></li>

  1415. 		<li><span class=literal>WAVEFORM_PULSE</span></li>

  1416. 		</ul>

  1417. 	</p>

  1418. </script>

  1419. <script type="text/x-red" data-template-name="AudioSynthWaveform">

  1420. 	<div class="form-row">

  1421. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  1422. 		<input type="text" id="node-input-name" placeholder="Name">

  1423. 	</div>

  1424. </script>

  1425. 

  1426. 

  1427. 

  1428. <script type="text/javascript">

  1429. 	RED.nodes.registerType('AudioSynthToneSweep',{

  1430. 	shortName: "tonesweep",

  1431. 		inputs:0,

  1432. 		outputs:1,

  1433. 		category: 'synth-function',

  1434. 		color:"#E6E0F8",

  1435. 		icon: "arrow-in.png"

  1436. 	});

  1437. </script>

  1438. <script type="text/x-red" data-help-name="AudioSynthToneSweep">

  1439. 	<h3>Summary</h3>

  1440. 	<p>Create a continuously varying (in frequency) sine wave</p>

  1441. 	<h3>Audio Connections</h3>

  1442. 	<table class=doc align=center cellpadding=3>

  1443. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  1444. 		<tr class=odd><td align=center>Out 0</td><td>Continuously varying tone</td></tr>

  1445. 	</table>

  1446. 	<h3>Functions</h3>

  1447. 	<p class=func><span class=keyword>play</span>(level, lowFreq, highFreq, time);</p>

  1448. 	<p class=desc>Start generating frequency sweep output.  The time is specified

  1449. 		in milliseconds.  Level is 0 to 1.0.

  1450. 	</p>

  1451. 	<p class=func><span class=keyword>isPlaying</span>();</p>

  1452. 	<p class=desc>Returns true (non-zero) while the output is active.

  1453. 	</p>

  1454. 	<h3>Examples</h3>

  1455. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; ToneSweep

  1456. 	</p>

  1457. 	<h3>Notes</h3>

  1458. 	<p>Uses excessive CPU time</p>

  1459. </script>

  1460. <script type="text/x-red" data-template-name="AudioSynthToneSweep">

  1461. 	<div class="form-row">

  1462. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  1463. 		<input type="text" id="node-input-name" placeholder="Name">

  1464. 	</div>

  1465. </script>

  1466. 

  1467. 

  1468. <script type="text/javascript">

  1469. 	RED.nodes.registerType('AudioSynthWaveformDc',{

  1470. 	shortName: "dc",

  1471. 		inputs:0,

  1472. 		outputs:1,

  1473. 		category: 'synth-function',

  1474. 		color:"#E6E0F8",

  1475. 		icon: "arrow-in.png"

  1476. 	});

  1477. </script>

  1478. <script type="text/x-red" data-help-name="AudioSynthWaveformDc">

  1479. 	<h3>Summary</h3>

  1480. 	<p>Create constant (DC) signal, useful for control of objects that take

  1481. 		a modulation or control input signal.  This constant level can be

  1482. 		used to modify other waveforms using mixer or multiplier objects</p>

  1483. 	<h3>Audio Connections</h3>

  1484. 	<table class=doc align=center cellpadding=3>

  1485. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  1486. 		<tr class=odd><td align=center>Out 0</td><td>Output constant DC level</td></tr>

  1487. 	</table>

  1488. 	<h3>Functions</h3>

  1489. 	<p class=func><span class=keyword>amplitude</span>(level);</p>

  1490. 	<p class=desc>Set the output.  Level is -1.0 to 1.0.  The output is

  1491. 		changed immediately.

  1492. 	</p>

  1493. 	<p class=func><span class=keyword>amplitude</span>(level, milliseconds);</p>

  1494. 	<p class=desc>Set the output.  Level is -1.0 to 1.0.  The output is

  1495. 		gradually changed over a "milliseconds" time period.  Any time may

  1496. 		be specified, but periods longer than 1 second may be automatically

  1497. 		shortened for small level changes, due to numerical precision limits.

  1498. 	</p>

  1499. 	<!--<h3>Examples</h3>

  1500. 	<p class=exam>File &gt; Examples &gt; Audio &gt; 

  1501. 	</p>-->

  1502. 	<h3>Notes</h3>

  1503. 	<p>Of course, the term "DC", for Direct Current, doesn't properly apply

  1504. 		to a pure digital stream of numerical values.  But the term is widely

  1505. 		understood in audio applications, so hopefully it's not too confusing?</p>

  1506. </script>

  1507. <script type="text/x-red" data-template-name="AudioSynthWaveformDc">

  1508. 	<div class="form-row">

  1509. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  1510. 		<input type="text" id="node-input-name" placeholder="Name">

  1511. 	</div>

  1512. </script>

  1513. 

  1514. 

  1515. <script type="text/javascript">

  1516. 	RED.nodes.registerType('AudioSynthNoiseWhite',{

  1517. 	shortName: "noise",

  1518. 		inputs:0,

  1519. 		outputs:1,

  1520. 		category: 'synth-function',

  1521. 		color:"#E6E0F8",

  1522. 		icon: "arrow-in.png"

  1523. 	});

  1524. </script>

  1525. <script type="text/x-red" data-help-name="AudioSynthNoiseWhite">

  1526. 	<h3>Summary</h3>

  1527. 	<div>

  1528. 	<p>Create white noise.

  1529. 		</p>

  1530. 	<p align=center><img src="img/whitenoise.png"></p>

  1531. 	</div>

  1532. 	<h3>Audio Connections</h3>

  1533. 	<table class=doc align=center cellpadding=3>

  1534. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  1535. 		<tr class=odd><td align=center>Out 0</td><td>White Noise</td></tr>

  1536. 	</table>

  1537. 	<h3>Functions</h3>

  1538. 	<p class=func><span class=keyword>amplitude</span>(level);</p>

  1539. 	<p class=desc>Set the output peak level, from 0 (off) to 1.0.

  1540. 		The default is off.  Noise is generated only after setting

  1541. 		to a non-zero level.

  1542. 	</p>

  1543. 	<h3>Examples</h3>

  1544. 	<p class=exam>File &gt; Examples &gt; Audio &gt; 

  1545. 	</p>

  1546. 	<h3>Notes</h3>

  1547. 	<p>Setting the amplitude to zero causes this object to stop using

  1548. 		CPU time to generate random numbers.

  1549. 	</p>

  1550. </script>

  1551. <script type="text/x-red" data-template-name="AudioSynthNoiseWhite">

  1552. 	<div class="form-row">

  1553. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  1554. 		<input type="text" id="node-input-name" placeholder="Name">

  1555. 	</div>

  1556. </script>

  1557. 

  1558. 

  1559. 

  1560. <script type="text/javascript">

  1561. 	RED.nodes.registerType('AudioSynthNoisePink',{

  1562. 	shortName: "pink",

  1563. 		inputs:0,

  1564. 		outputs:1,

  1565. 		category: 'synth-function',

  1566. 		color:"#E6E0F8",

  1567. 		icon: "arrow-in.png"

  1568. 	});

  1569. </script>

  1570. <script type="text/x-red" data-help-name="AudioSynthNoisePink">

  1571. 	<h3>Summary</h3>

  1572. 	<div>

  1573. 	<p>Create pink noise, using Stefan Stenzel's "New Shade Of Pink" algorithm.

  1574. 		</p>

  1575. 	<!--<p align=center><img src="img/whitenoise.png"></p>-->

  1576. 	</div>

  1577. 	<h3>Audio Connections</h3>

  1578. 	<table class=doc align=center cellpadding=3>

  1579. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  1580. 		<tr class=odd><td align=center>Out 0</td><td>Pink Noise</td></tr>

  1581. 	</table>

  1582. 	<h3>Functions</h3>

  1583. 	<p class=func><span class=keyword>amplitude</span>(level);</p>

  1584. 	<p class=desc>Set the output peak level, from 0 (off) to 1.0.

  1585. 		The default is off.  Noise is generated only after setting

  1586. 		to a non-zero level.

  1587. 	</p>

  1588. 	<h3>Examples</h3>

  1589. 	<p class=exam>File &gt; Examples &gt; Audio &gt; MemoryAndCpuUsage

  1590. 	</p>

  1591. 	<h3>Notes</h3>

  1592. 	<p>Setting the amplitude to zero causes this object to stop using

  1593. 		CPU time.  CPU usage is approx 3% on Teensy 3.1.

  1594. 	</p>

  1595. 	<p>Stefan Stenzel's

  1596. 		<a href="http://stenzel.waldorfmusic.de/post/pink/" target="_blank">New Shade Of Pink</a>

  1597. 		algorithm.  Stefan's terms of use are "Use for any purpose. If used

  1598. 		in a commercial product, you should give me one."

  1599. 	</p>

  1600. </script>

  1601. <script type="text/x-red" data-template-name="AudioSynthNoisePink">

  1602. 	<div class="form-row">

  1603. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  1604. 		<input type="text" id="node-input-name" placeholder="Name">

  1605. 	</div>

  1606. </script>

  1607. 

  1608. 

  1609. 

  1610. 

  1611. <script type="text/javascript">

  1612. 	RED.nodes.registerType('AudioEffectFade',{

  1613. 	shortName: "fade",

  1614. 		inputs:1,

  1615. 		outputs:1,

  1616. 		category: 'effect-function',

  1617. 		color:"#E6E0F8",

  1618. 		icon: "arrow-in.png"

  1619. 	});

  1620. </script>

  1621. <script type="text/x-red" data-help-name="AudioEffectFade">

  1622. 	<h3>Summary</h3>

  1623. 	<p>Gradually increase or decrease audio level.</p>

  1624. 	<h3>Audio Connections</h3>

  1625. 	<table class=doc align=center cellpadding=3>

  1626. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  1627. 		<tr class=odd><td align=center>In 0</td><td>Signal Input</td></tr>

  1628. 		<tr class=odd><td align=center>Out 0</td><td>Signal Output</td></tr>

  1629. 	</table>

  1630. 	<h3>Functions</h3>

  1631. 	<p class=func><span class=keyword>fadeIn</span>(milliseconds);</p>

  1632. 	<p class=desc>Begin increasing the audio level, to reach 1.0 (input passed

  1633. 		directly to the output) after "milliseconds" time.

  1634. 	</p>

  1635. 	<p class=func><span class=keyword>fadeOut</span>(milliseconds);</p>

  1636. 	<p class=desc>Begin decreasing the audio level, to reach 0 (no output)

  1637. 		after "milliseconds" time.

  1638. 	</p>

  1639. 	<!--<h3>Examples</h3>

  1640. 	<p class=exam>File &gt; Examples &gt; Audio &gt; 

  1641. 	</p>-->

  1642. 	<h3>Notes</h3>

  1643. 	<p>Cross fading can be built with 2 fade objects fed into a mixer.

  1644. 		When one fade object is off (fully faded out) and the other on

  1645. 		(fully faded in), if both are started at the same moment for the

  1646. 		same time duration, their signal gains always add to 1.0.  This

  1647. 		allows 2 fade objects to work together for a smooth transition

  1648. 		between a pair of signals.

  1649. 	</p>

  1650. 	<p><a href="http://www.pjrc.com/teensy/td_libs_AudioProcessorUsage.html" target="_blank">AudioNoInterrupts()</a>

  1651. 		should be used when changing

  1652. 		settings on multiple objects, so all changes always take effect

  1653. 		at the same moment.

  1654. 	</p>

  1655. </script>

  1656. <script type="text/x-red" data-template-name="AudioEffectFade">

  1657. 	<div class="form-row">

  1658. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  1659. 		<input type="text" id="node-input-name" placeholder="Name">

  1660. 	</div>

  1661. </script>

  1662. 

  1663. 

  1664. <script type="text/javascript">

  1665. 	RED.nodes.registerType('AudioEffectChorus',{

  1666. 	shortName: "chorus",

  1667. 		inputs:1,

  1668. 		outputs:1,

  1669. 		category: 'effect-function',

  1670. 		color:"#E6E0F8",

  1671. 		icon: "arrow-in.png"

  1672. 	});

  1673. </script>

  1674. <script type="text/x-red" data-help-name="AudioEffectChorus">

  1675. <h3>Summary</h3>

  1676. 	<p>The chorus effect simulates the richness of several nearly-identical

  1677. 	sound sources (like the way a choir sounds different to a single singer).

  1678. 	It does this by sampling from a delay line, so each voice is actually

  1679. 	the same but at a slightly different point in time. This is a type of

  1680. 	comb filtering.</p>

  1681. 	<p>Chorus combines one or more samples ranging from the most recent

  1682. 	sample back to about 50ms ago. The additional samples are evenly spread

  1683. 	through the supplied delay line, and there is no modulation.</p>

  1684. 	<p>If the number of voices is specified as 2, then the

  1685. 	effect combines the current sample and the oldest sample (the last one

  1686. 	in the delay line). If the number of voices is 3 then the effect combines

  1687. 	the most recent sample, the oldest sample and the sample in the middle of

  1688. 	the delay line.</p>

  1689. 	<p>For two voices the effect can be represented as:<br/>

  1690. 	result = (sample(0) + sample(dt))/2<br/>

  1691. 	where sample(0) represents the current sample and sample(dt)

  1692. 	is the sample in the delay line from dt milliseconds ago.</p>

  1693. 	<h3>Audio Connections</h3>

  1694. 	<table class=doc align=center cellpadding=3>

  1695. 		<tr class="top"><th>Port</th><th>Purpose</th></tr>

  1696. 		<tr class="odd"><td align="center">In 0</td><td>Signal Input</td></tr>

  1697. 		<tr class="odd"><td align="center">Out 0</td><td>Chorused Output</td></tr>

  1698. 	</table>

  1699. 	<h3>Functions</h3>

  1700. 	<p class=func><span class=keyword>begin</span>(delayBuffer, length, n_chorus);</p>

  1701. 	<p class=desc>Create a chorus by specifying the address of the delayline, the

  1702. 	total number of samples in the delay line (often done as an integer multiple of

  1703. 	AUDIO_BLOCK_SAMPLES) and the number of voices in the chorus <em>including</em>

  1704. 	the original voice (so, 2 and up to get a chorus effect, although you can

  1705. 	specify 1 if you want).

  1706. 	</p>

  1707. 	<p class=func><span class=keyword>modify</span>(n_chorus);</p>

  1708. 	<p class=desc>Alters the number of voices in a running chorus (previously started with begin).

  1709. 	</p>

  1710. 	<h3>Examples</h3>

  1711. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Effects &gt; Chorus

  1712. 	</p>

  1713. 	<h3>Notes</h3>

  1714. 	<p>The longer the length of the chorus, the more memory blocks are used.</p>

  1715. </script>

  1716. <script type="text/x-red" data-template-name="AudioEffectChorus">

  1717. 	<div class="form-row">

  1718. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  1719. 		<input type="text" id="node-input-name" placeholder="Name">

  1720. 	</div>

  1721. </script>

  1722. 

  1723. 

  1724. <script type="text/javascript">

  1725. 	RED.nodes.registerType('AudioEffectFlange',{

  1726. 	shortName: "flange",

  1727. 		inputs:1,

  1728. 		outputs:1,

  1729. 		category: 'effect-function',

  1730. 		color:"#E6E0F8",

  1731. 		icon: "arrow-in.png"

  1732. 	});

  1733. </script>

  1734. <script type="text/x-red" data-help-name="AudioEffectFlange">

  1735. <h3>Summary</h3>

  1736. 	<p>Originally, flanging was produced by playing the same signal on two synchronized

  1737. 	reel-to-reel tape recorders and making one of the reels slow down and speed up by

  1738. 	pressing on the flange of the reel (hence the name). This is a type of

  1739. 	comb filtering, and produces a harmonically-related series of peaks and notches

  1740. 	in the audio spectrum.</p>

  1741. 	<p>This flanger uses a delay line, combining the original voice with only one sample from the delay

  1742. 	line, but the position of that sample varies sinusoidally.</p>

  1743. 	<p>The effect can be represented as:<br>

  1744. 	result = sample(0) + sample(dt + depth*sin(2*PI*Fe))</p>

  1745. 	<p>The value of the sine function is always a number from -1 to +1 and

  1746. 	so the result of depth*(sin(Fe)) is always a number from -depth to +depth.

  1747. 	Thus, the delayed sample will be selected from the range (dt-depth) to

  1748. 	(dt+depth). This selection will vary at whatever rate is specified as the

  1749. 	frequency of the effect, Fe. Typically a low frequency (a few Hertz) is used.

  1750. 	<h3>Audio Connections</h3>

  1751. 	<table class=doc align=center cellpadding=3>

  1752. 		<tr class="top"><th>Port</th><th>Purpose</th></tr>

  1753. 		<tr class="odd"><td align="center">In 0</td><td>Signal Input</td></tr>

  1754. 		<tr class="odd"><td align="center">Out 0</td><td>Flanged Output</td></tr>

  1755. 	</table>

  1756. 	<h3>Functions</h3>

  1757. 	<p class=func><span class=keyword>begin</span>(delayBuffer, length, offset, depth, delayRate);</p>

  1758. 	<p class=desc>Create a flanger by specifying the address of the delayline, the

  1759. 	total number of samples in the delay line (often done as an integer multiple of

  1760. 	AUDIO_BLOCK_SAMPLES), the offset (how far back the flanged sample is from the original voice),

  1761. 	the modulation depth (larger values give a greater variation) and the modulation

  1762. 	frequency, in Hertz.

  1763. 	</p>

  1764. 	<p class=func><span class=keyword>modify</span>(offset, depth, delayRate);</p>

  1765. 	<p class=desc>Alters the parameters in a running flanger (previously started with begin).

  1766. 	</p>

  1767. 

  1768. 	<h3>Examples</h3>

  1769. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Effects &gt; Flange

  1770. 	</p>

  1771. 	<h3>Notes</h3>

  1772. 	<p>The longer the length of the delay buffer, the more memory blocks are used.</p>

  1773. 	<p>Try these settings:<br>

  1774. #define FLANGE_DELAY_LENGTH (2*AUDIO_BLOCK_SAMPLES)<br>

  1775. and<br>

  1776. int s_idx = 2*FLANGE_DELAY_LENGTH/4;<br>

  1777. int s_depth = FLANGE_DELAY_LENGTH/4;<br>

  1778. double s_freq = 3;</p>

  1779. <p>The flange effect can also produce a chorus-like effect if a longer

  1780. delay line is used with a slower modulation rate, for example try:<br>

  1781. #define FLANGE_DELAY_LENGTH (12*AUDIO_BLOCK_SAMPLES)<br>

  1782. and<br>

  1783. int s_idx = 3*FLANGE_DELAY_LENGTH/4;<br>

  1784. int s_depth = FLANGE_DELAY_LENGTH/8;<br>

  1785. double s_freq = .0625;</p>

  1786. </script>

  1787. <script type="text/x-red" data-template-name="AudioEffectFlange">

  1788. 	<div class="form-row">

  1789. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  1790. 		<input type="text" id="node-input-name" placeholder="Name">

  1791. 	</div>

  1792. </script>

  1793. 

  1794. 

  1795. 

  1796. <script type="text/javascript">

  1797. 	RED.nodes.registerType('AudioEffectEnvelope',{

  1798. 	shortName: "envelope",

  1799. 		inputs:1,

  1800. 		outputs:1,

  1801. 		category: 'effect-function',

  1802. 		color:"#E6E0F8",

  1803. 		icon: "arrow-in.png"

  1804. 	});

  1805. </script>

  1806. <script type="text/x-red" data-help-name="AudioEffectEnvelope">

  1807. 	<h3>Summary</h3>

  1808. 	<div>

  1809. 	<p>Modify a signal with a DAHDSR (Delay Attack Hold Decay Sustain

  1810. 		Release) envelope.

  1811. 	</p>

  1812. 	<p align=center><img src="img/dahdsr.png"></p>

  1813. 	</div>

  1814. 	<h3>Audio Connections</h3>

  1815. 	<table class=doc align=center cellpadding=3>

  1816. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  1817. 		<tr class=odd><td align=center>In 0</td><td>Signal Input</td></tr>

  1818. 		<tr class=odd><td align=center>Out 0</td><td>Signal with Envelope Applied</td></tr>

  1819. 	</table>

  1820. 	<h3>Functions</h3>

  1821. 	<p class=func><span class=keyword>noteOn</span>();</p>

  1822. 	<p class=desc>Begin the delay to attack, or the attack phase is

  1823. 		delay is zero.

  1824. 	</p>

  1825. 	<p class=func><span class=keyword>noteOff</span>();</p>

  1826. 	<p class=desc>Begin the release phase.

  1827. 	</p>

  1828. 	<p class=func><span class=keyword>delay</span>(milliseconds);</p>

  1829. 	<p class=desc>Set the delay from noteOn to the attach phase.  The

  1830. 		default is zero, for no delay.

  1831. 	</p>

  1832. 	<p class=func><span class=keyword>attack</span>(milliseconds);</p>

  1833. 	<p class=desc>Set the attack time.  The default is 1.5 milliseconds.

  1834. 	</p>

  1835. 	<p class=func><span class=keyword>hold</span>(milliseconds);</p>

  1836. 	<p class=desc>Set the hold time.  The default is 0.5 milliseconds.

  1837. 	</p>

  1838. 	<p class=func><span class=keyword>decay</span>(milliseconds);</p>

  1839. 	<p class=desc>Set the decay time.  The default is 15 milliseconds.

  1840. 	</p>

  1841. 	<p class=func><span class=keyword>sustain</span>(level);</p>

  1842. 	<p class=desc>Set the sustain level.  The range is 0 to 1.0.  The

  1843. 		gain will be maintained at this level after the decay phase,

  1844. 		until noteOff() is called.

  1845. 	</p>

  1846. 	<p class=func><span class=keyword>release</span>(milliseconds);</p>

  1847. 	<p class=desc>Set the release time.  The default is 30 millisecond.

  1848. 	</p>

  1849. 	<h3>Examples</h3>

  1850. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Synthesis &gt; PlaySynthMusic

  1851. 	</p>

  1852. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Synthesis &gt; pulseWidth

  1853. 	</p>

  1854. 	<p class=exam>File &gt; Examples &gt; Audio &gt; MemoryAndCpuUsage

  1855. 	</p>

  1856. 	<h3>Notes</h3>

  1857. 	<p>To achieve the more common ADSR shape, simply

  1858.         set delay and hold to zero.</p>

  1859. 	<p>The recommended range for each of the 5 timing inputs is 0 to 50

  1860. 		milliseconds.  Up to 200 ms can be used, with somewhat reduced

  1861. 		accuracy</p>

  1862. </script>

  1863. <script type="text/x-red" data-template-name="AudioEffectEnvelope">

  1864. 	<div class="form-row">

  1865. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  1866. 		<input type="text" id="node-input-name" placeholder="Name">

  1867. 	</div>

  1868. </script>

  1869. 

  1870. 

  1871. 

  1872. <script type="text/javascript">

  1873. 	RED.nodes.registerType('AudioEffectMultiply',{

  1874. 	shortName: "multiply",

  1875. 		inputs:2,

  1876. 		outputs:1,

  1877. 		category: 'effect-function',

  1878. 		color:"#E6E0F8",

  1879. 		icon: "arrow-in.png"

  1880. 	});

  1881. </script>

  1882. <script type="text/x-red" data-help-name="AudioEffectMultiply">

  1883. 	<h3>Summary</h3>

  1884. 	<div>

  1885. 	<p>Multiply two signals together, useful for amplitude modulation

  1886. 		or "voltage controlled amplification".

  1887. 	</p>

  1888. 	<p align=center><img src="img/multiply.png"><br><small>56 Hz and 1 kHz sine waves multiplied.</small></p>

  1889. 	</div>

  1890. 	<h3>Audio Connections</h3>

  1891. 	<table class=doc align=center cellpadding=3>

  1892. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  1893. 		<tr class=odd><td align=center>In 0</td><td>Signal Input</td></tr>

  1894. 		<tr class=odd><td align=center>In 1</td><td>Signal Input</td></tr>

  1895. 		<tr class=odd><td align=center>Out 0</td><td>Signal with Envelope Applied</td></tr>

  1896. 	</table>

  1897. 	<h3>Functions</h3>

  1898. 	<p>There are no functions to call from the Arduino sketch.

  1899. 		This object simply multiplies the 2 signals to create

  1900. 		a continuous output

  1901. 	</p>

  1902. 	<!--<h3>Examples</h3>

  1903. 	<p class=exam>File &gt; Examples &gt; Audio &gt; 

  1904. 	</p>-->

  1905. 	<h3>Notes</h3>

  1906. 	<p>

  1907.     </p>

  1908. </script>

  1909. <script type="text/x-red" data-template-name="AudioEffectMultiply">

  1910. 	<div class="form-row">

  1911. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  1912. 		<input type="text" id="node-input-name" placeholder="Name">

  1913. 	</div>

  1914. </script>

  1915. 

  1916. 

  1917. 

  1918. <script type="text/javascript">

  1919. 	RED.nodes.registerType('AudioEffectDelay',{

  1920. 	shortName: "delay",

  1921. 		inputs:1,

  1922. 		outputs:8,

  1923. 		category: 'effect-function',

  1924. 		color:"#E6E0F8",

  1925. 		icon: "arrow-in.png"

  1926. 	});

  1927. </script>

  1928. <script type="text/x-red" data-help-name="AudioEffectDelay">

  1929. 	<h3>Summary</h3>

  1930. 	<div>

  1931. 	<p>Delay a signal.  Up to 8 separate delay taps can be used.</p>

  1932. 	<p align=center><img src="img/delay.png"><br><small>1 kHz burst, delayed 5.2 ms.</small></p>

  1933. 	</div>

  1934. 	<h3>Audio Connections</h3>

  1935. 	<table class=doc align=center cellpadding=3>

  1936. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  1937. 		<tr class=odd><td align=center>In 0</td><td>Signal Input</td></tr>

  1938. 		<tr class=odd><td align=center>Out 0</td><td>Delay Tap #1</td></tr>

  1939. 		<tr class=odd><td align=center>Out 1</td><td>Delay Tap #2</td></tr>

  1940. 		<tr class=odd><td align=center>Out 2</td><td>Delay Tap #3</td></tr>

  1941. 		<tr class=odd><td align=center>Out 3</td><td>Delay Tap #4</td></tr>

  1942. 		<tr class=odd><td align=center>Out 4</td><td>Delay Tap #5</td></tr>

  1943. 		<tr class=odd><td align=center>Out 5</td><td>Delay Tap #6</td></tr>

  1944. 		<tr class=odd><td align=center>Out 6</td><td>Delay Tap #7</td></tr>

  1945. 		<tr class=odd><td align=center>Out 7</td><td>Delay Tap #8</td></tr>

  1946. 	</table>

  1947. 	<h3>Functions</h3>

  1948. 	<p class=func><span class=keyword>delay</span>(channel, milliseconds);</p>

  1949. 	<p class=desc>Set output channel (0 to 7) to delay the signals by

  1950. 		milliseconds.  The maximum delay is approx 333 ms.  The actual delay

  1951. 		is rounded to the nearest sample.  Each channel can be configured for

  1952. 		any delay.  There is no requirement to configure the "taps" in increasing

  1953. 		delay order.

  1954. 	</p>

  1955. 	<p class=func><span class=keyword>disable</span>(channel);</p>

  1956. 	<p class=desc>Disable a channel.  The output of this channel becomes

  1957. 		silent.  If this channel is the longest delay, memory usage is

  1958. 		automatically reduced to accomodate only the remaining channels used.

  1959. 	</p>

  1960. 	<h3>Examples</h3>

  1961. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Effects &gt; Delay

  1962. 	</p>

  1963. 	<h3>Notes</h3>

  1964. 	<p>Memory for the delayed signal is take from the memory pool allocated by

  1965. 		<a href="http://www.pjrc.com/teensy/td_libs_AudioConnection.html" target="_blank">AudioMemory()</a>.

  1966. 		Each block allows about 3 milliseconds of delay, so AudioMemory

  1967. 		should be increased to allow for the longest delay tap.

  1968. 	</p>

  1969. </script>

  1970. <script type="text/x-red" data-template-name="AudioEffectDelay">

  1971. 	<div class="form-row">

  1972. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  1973. 		<input type="text" id="node-input-name" placeholder="Name">

  1974. 	</div>

  1975. </script>

  1976. 

  1977. 

  1978. <script type="text/javascript">

  1979. 	RED.nodes.registerType('AudioEffectDelayExternal',{

  1980. 	shortName: "delayExt",

  1981. 		inputs:1,

  1982. 		outputs:8,

  1983. 		category: 'effect-function',

  1984. 		color:"#E6E0F8",

  1985. 		icon: "arrow-in.png"

  1986. 	});

  1987. </script>

  1988. <script type="text/x-red" data-help-name="AudioEffectDelayExternal">

  1989. 	<h3>Summary</h3>

  1990. 	<div>

  1991. 	<p>Delay a signal, using external memory for longer delay times!  Up to 8 separate delay taps can be used.</p>

  1992. 	<p align=center><img src="img/delay.png"><br><small>1 kHz burst, delayed 5.2 ms.</small></p>

  1993. 	</div>

  1994. 	<h3>Audio Connections</h3>

  1995. 	<table class=doc align=center cellpadding=3>

  1996. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  1997. 		<tr class=odd><td align=center>In 0</td><td>Signal Input</td></tr>

  1998. 		<tr class=odd><td align=center>Out 0</td><td>Delay Tap #1</td></tr>

  1999. 		<tr class=odd><td align=center>Out 1</td><td>Delay Tap #2</td></tr>

  2000. 		<tr class=odd><td align=center>Out 2</td><td>Delay Tap #3</td></tr>

  2001. 		<tr class=odd><td align=center>Out 3</td><td>Delay Tap #4</td></tr>

  2002. 		<tr class=odd><td align=center>Out 4</td><td>Delay Tap #5</td></tr>

  2003. 		<tr class=odd><td align=center>Out 5</td><td>Delay Tap #6</td></tr>

  2004. 		<tr class=odd><td align=center>Out 6</td><td>Delay Tap #7</td></tr>

  2005. 		<tr class=odd><td align=center>Out 7</td><td>Delay Tap #8</td></tr>

  2006. 	</table>

  2007. 	<h3>Functions</h3>

  2008. 	<p class=func><span class=keyword>delay</span>(channel, milliseconds);</p>

  2009. 	<p class=desc>Set output channel (0 to 7) to delay the signals by

  2010. 		milliseconds.  The maximum delay is approx 333 ms.  The actual delay

  2011. 		is rounded to the nearest sample.  Each channel can be configured for

  2012. 		any delay.  There is no requirement to configure the "taps" in increasing

  2013. 		delay order.

  2014. 	</p>

  2015. 	<p class=func><span class=keyword>disable</span>(channel);</p>

  2016. 	<p class=desc>Disable a channel.  The output of this channel becomes

  2017. 		silent.  If this channel is the longest delay, memory usage is

  2018. 		automatically reduced to accomodate only the remaining channels used.

  2019. 	</p>

  2020. 	<h3>Hardware</h3>

  2021. 	<p>By default, or when <span class=literal>AUDIO_MEMORY_23LC1024</span> is used (see below),

  2022. 		 a single 23LC1024 RAM chip is used, with these pins:

  2023.     <table class=doc align=center cellpadding=3>

  2024.         <tr class=top><th>Pin</th><th>Signal</th></tr>

  2025.         <tr class=odd><td align=center>6</td><td>CS</td></tr>

  2026.         <tr class=odd><td align=center>7</td><td>MOSI</td></tr>

  2027.         <tr class=odd><td align=center>12</td><td>MISO</td></tr>

  2028.         <tr class=odd><td align=center>14</td><td>SCK</td></tr>

  2029.     </table>

  2030. 	</p>

  2031. 	<p>When <span class=literal>AUDIO_MEMORY_MEMORYBOARD</span> is used, up to six

  2032. 		23LC1024 chips are used.

  2033. 	</p>

  2034. 	<p align=center><img src="img/memoryboard.jpg"><br><small><a href="https://oshpark.com/shared_projects/KZt5PaU7" target="_blank">Memoryboard 4</a></small></p>

  2035. 	<p>

  2036.     <table class=doc align=center cellpadding=3>

  2037.         <tr class=top><th>Pin</th><th>Signal</th></tr>

  2038.         <tr class=odd><td align=center>2</td><td>CS0 (encoded)</td></tr>

  2039.         <tr class=odd><td align=center>3</td><td>CS1 (encoded)</td></tr>

  2040.         <tr class=odd><td align=center>4</td><td>CS2 (encoded)</td></tr>

  2041.         <tr class=odd><td align=center>7</td><td>MOSI</td></tr>

  2042.         <tr class=odd><td align=center>12</td><td>MISO</td></tr>

  2043.         <tr class=odd><td align=center>14</td><td>SCK</td></tr>

  2044.     </table>

  2045. 	</p>

  2046. 	<p>

  2047. 	If fewer than 6 chips are soldered, the optional parameter for maximum delay

  2048. 	must be used.  See below for details.  Each chip provides 1485 ms of delay

  2049. 	memory, so the total of all objects using AUDIO_MEMORY_MEMORYBOARD must not

  2050. 	exceed the amount of memory physically present.

  2051. 	</p>

  2052. 	<h3>Examples</h3>

  2053. 	<p>

  2054. 	<a href="https://www.youtube.com/watch?v=d80d1HWy5_s" target="_blank">Demo Video</a> (YouTube)

  2055. 	</p>

  2056. 	<!-- <p class=exam>File &gt; Examples &gt; Audio &gt; Effects &gt; Delay

  2057. 	</p> -->

  2058. 	<p>

  2059. 	<a href="https://forum.pjrc.com/threads/29276-Limits-of-delay-effect-in-audio-library?p=79436&viewfull=1#post79436" target="_blank">Forum Conversaton</a> (with sample code)

  2060. 	</p>

  2061. 	<h3>Notes</h3>

  2062. 	<p>External RAM allows for longer delays without consuming

  2063. 		limited internal RAM.  However, SPI communication is required,

  2064. 		which consumes much more CPU time.  The

  2065. 		<a href="http://www.pjrc.com/teensy/td_libs_AudioProcessorUsage.html">AudioProcessorUsageMax</a>

  2066. 		function may be used to monitor how much CPU time is consumed.

  2067. 	</p>

  2068. 	<p>You may specify the type of hardware to be used by editing the code.  AUDIO_MEMORY_23LC1024

  2069. 		specifies a single 23LC1024 chip.  AUDIO_MEMORY_MEMORYBOARD allows using up to 6 of these

  2070. 		chips.

  2071. 	</p>

  2072. 	<p class=desc><span class=keyword>AudioEffectDelayExternal</span>  delayExt1(<span class=literal>AUDIO_MEMORY_23LC1024</span>);

  2073. 	</p>

  2074. 	<p>You may also create more than one delay using the same hardware, where the memory is partitioned

  2075. 		by specifying a maximum delay in milliseconds.  This can be useful if you wish to delay both

  2076. 		channels of a stereo signal.

  2077. 

  2078. 	<p class=desc><span class=keyword>AudioEffectDelayExternal</span>  delayExt1(<span class=literal>AUDIO_MEMORY_23LC1024</span>, 700);<br><span class=keyword>AudioEffectDelayExternal</span>  delayExt2(<span class=literal>AUDIO_MEMORY_23LC1024</span>, 700);

  2079. 	</p>

  2080. </script>

  2081. <script type="text/x-red" data-template-name="AudioEffectDelayExternal">

  2082. 	<div class="form-row">

  2083. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2084. 		<input type="text" id="node-input-name" placeholder="Name">

  2085. 	</div>

  2086. </script>

  2087. 

  2088. 

  2089. <script type="text/javascript">

  2090.     RED.nodes.registerType('AudioEffectBitcrusher',{

  2091.     shortName: "bitcrusher",

  2092.         inputs:1,

  2093.         outputs:1,

  2094.         category: 'effect-function',

  2095.         color:"#E6E0F8",

  2096.         icon: "arrow-in.png"

  2097.     });

  2098. </script>

  2099. <script type="text/x-red" data-help-name="AudioEffectBitcrusher">

  2100.     <h3>Summary</h3>

  2101.     <p>Reduce the samplerate and/or bitdepth of a source signal, resulting in

  2102. 		a distorted sound.</p>

  2103.     <h3>Audio Connections</h3>

  2104.     <table class=doc align=center cellpadding=3>

  2105.         <tr class=top><th>Port</th><th>Purpose</th></tr>

  2106.         <tr class=odd><td align=center>In 0</td><td>Signal Input</td></tr>

  2107.         <tr class=odd><td align=center>Out 0</td><td>Signal Output</td></tr>

  2108.     </table>

  2109.     <h3>Parameters</h3>

  2110.     <p class=func><span class=keyword>bits</span>(xcrushBits);</p>

  2111.     <p class=desc>xcrushBits sets the bitdepth, from 1 to 16. A Value of 16

  2112.     does not crush the bitdepth, and is effectively a passthru for this part

  2113.     of the function.</p>

  2114. 

  2115.     <p class=func><span class=keyword>sampleRate</span>(xsampleRate);</p>

  2116. 

  2117.     <p class=desc>xsampleRate sets the frequency, from 1 to 44100Hz, however it

  2118.     works in integer steps so you will only really get a handful of results from

  2119.     the many samplerates you can pass. 44100 is passthru.</p>

  2120. 

  2121.     <p class=desc>set xbitDepth to 16 and xsampleRate to 44100 to pass audio

  2122.     	through without any Bitcrush effect.</p>

  2123.     <h3>Examples</h3>

  2124.     <p class=exam>File &gt; Examples &gt; Audio &gt; Effects &gt; Bitcrusher

  2125.     </p>

  2126.     <h3>Notes</h3>

  2127.     <p>Needs a lot of improvement. Options for anti-aliasing would be nice in

  2128.     the future, but for now, it's rough, it's dirty and it sounds a bit like

  2129.     Nine Inch Nails.

  2130.     </p>

  2131.     <p><a href="http://www.pjrc.com/teensy/td_libs_AudioProcessorUsage.html" target="_blank">AudioNoInterrupts()</a>

  2132.         should be used when changing

  2133.         settings on multiple objects, so all changes always take effect

  2134.         at the same moment.

  2135.     </p>

  2136. </script>

  2137. <script type="text/x-red" data-template-name="AudioEffectBitcrusher">

  2138.     <div class="form-row">

  2139.         <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2140.         <input type="text" id="node-input-name" placeholder="Name">

  2141.     </div>

  2142. </script>

  2143. 

  2144. 

  2145. 

  2146. 

  2147. 

  2148. <script type="text/javascript">

  2149. 	RED.nodes.registerType('AudioFilterBiquad',{

  2150. 	shortName: "biquad",

  2151. 		inputs:1,

  2152. 		outputs:1,

  2153. 		category: 'filter-function',

  2154. 		color:"#E6E0F8",

  2155. 		icon: "arrow-in.png"

  2156. 	});

  2157. </script>

  2158. <script type="text/x-red" data-help-name="AudioFilterBiquad">

  2159. 	<h3>Summary</h3>

  2160. 	<div>

  2161. 	<p>Biquadratic cascaded filter, useful for all sorts of filtering.

  2162. 		Up to 4 stages may be cascaded.

  2163. 	</p>

  2164. 	<p align=center><img src="img/biquad.png"></p>

  2165. 	</div>

  2166. 	<h3>Audio Connections</h3>

  2167. 	<table class=doc align=center cellpadding=3>

  2168. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  2169. 		<tr class=odd><td align=center>In 0</td><td>Signal to be filtered</td></tr>

  2170. 		<tr class=odd><td align=center>Out 0</td><td>Filtered Signal Output</td></tr>

  2171. 	</table>

  2172. 	<h3>Functions</h3>

  2173. 	<p class=func><span class=keyword>setLowpass</span>(stage, frequency, Q);</p>

  2174. 	<p class=desc>Configure one stage of the filter (0 to 3) with low pass

  2175. 		response, with the specified corner frequency and Q shape.  If Q is

  2176. 		higher that 0.7071, be careful of filter gain (see below).

  2177. 	</p>

  2178. 	<p class=func><span class=keyword>setHighpass</span>(stage, frequency, Q);</p>

  2179. 	<p class=desc>Configure one stage of the filter (0 to 3) with high pass

  2180. 		response, with the specified corner frequency and Q shape.  If Q is

  2181. 		higher that 0.7071, be careful of filter gain (see below).

  2182. 	</p>

  2183. 	<p class=func><span class=keyword>setBandpass</span>(stage, frequency, Q);</p>

  2184. 	<p class=desc>Configure one stage of the filter (0 to 3) with band pass

  2185. 		response.  The filter has unity gain at the specified frequency.  Q

  2186. 		controls the width of frequencies allowed to pass.

  2187. 	</p>

  2188. 	<p class=func><span class=keyword>setNotch</span>(stage, frequency, Q);</p>

  2189. 	<p class=desc>Configure one stage of the filter (0 to 3) with band reject (notch)

  2190. 		response.  Q controls the width of rejected frequencies.

  2191. 	</p>

  2192. 	<p class=func><span class=keyword>setCoefficients</span>(stage, array[5]);</p>

  2193. 	<p class=desc>Configure one stage of the filter (0 to 3) with an arbitrary

  2194. 		filter response.  The array of coefficients is in order: B0, B1, B2, A1, A2.

  2195. 		Each coefficient must be less than 2.0 and greater than -2.0.  The array

  2196. 		should be type double.  Alternately, it may be type int, where 1.0 is

  2197. 		represented with 1073741824 (2<sup>30</sup>).

  2198. 	</p>

  2199. 	<h3>Examples</h3>

  2200. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Effects &gt; Filter

  2201. 	</p>

  2202. 	<h3>Notes</h3>

  2203. 	<p>Filters can with gain must have their input signals attenuated, so the

  2204. 		signal does not exceed 1.0.

  2205. 	</p>

  2206. 	<p>This object implements up to 4 cascaded stages.  Unconfigured stages will

  2207. 		not pass any signal.

  2208. 	</p>

  2209. 	<p>Biquad filters with low corner frequency (under about 400 Hz) can run into

  2210. 		trouble with limited numerical precision, causing the filter to perform

  2211. 		poorly.  For very low corner frequency, the State Variable (Chamberlin)

  2212. 		filter should be used.

  2213. 	</p>

  2214. </script>

  2215. <script type="text/x-red" data-template-name="AudioFilterBiquad">

  2216. 	<div class="form-row">

  2217. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2218. 		<input type="text" id="node-input-name" placeholder="Name">

  2219. 	</div>

  2220. </script>

  2221. 

  2222. 

  2223. 

  2224. <script type="text/javascript">

  2225. 	RED.nodes.registerType('AudioFilterFIR',{

  2226. 	shortName: "fir",

  2227. 		inputs:1,

  2228. 		outputs:1,

  2229. 		category: 'filter-function',

  2230. 		color:"#E6E0F8",

  2231. 		icon: "arrow-in.png"

  2232. 	});

  2233. </script>

  2234. <script type="text/x-red" data-help-name="AudioFilterFIR">

  2235. 	<h3>Summary</h3>

  2236. 	<div>

  2237. 	<p>Finite impulse response filter, useful for all sorts of filtering.

  2238. 	</p>

  2239. 	<p align=center><img src="img/fir_filter.png"></p>

  2240. 	</div>

  2241. 	<h3>Audio Connections</h3>

  2242. 	<table class=doc align=center cellpadding=3>

  2243. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  2244. 		<tr class=odd><td align=center>In 0</td><td>Signal to be filtered</td></tr>

  2245. 		<tr class=odd><td align=center>Out 0</td><td>Filtered Signal Output</td></tr>

  2246. 	</table>

  2247. 	<h3>Functions</h3>

  2248. 	<p class=func><span class=keyword>begin</span>(array, length);</p>

  2249. 	<p class=desc>Initialize the filter.  The array must be 16 bit integers (the

  2250. 		filter's impulse response), and

  2251. 		length indicates the number of points in the array.  Array may also be

  2252. 		FIR_PASSTHRU (length = 0), to directly pass the input to output without

  2253. 		filtering.

  2254. 	</p>

  2255. 	<p class=func><span class=keyword>end</span>();</p>

  2256. 	<p class=desc>Turn the filter off.

  2257. 	</p>

  2258. 	<h3>Examples</h3>

  2259. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Effects &gt; Filter_FIR

  2260. 	</p>

  2261. 	<h3>Notes</h3>

  2262. 	<p>FIR filters requires more CPU time than Biquad (IIR), but they can

  2263. 		implement filters with better phase response.

  2264. 	</p>

  2265. 	<p>A 100 point filter requires 9% CPU time on Teensy 3.1.  The maximum

  2266. 		supported filter length is 200 points.

  2267. 	</p>

  2268. 	<p>The free

  2269. 		<a href="http://t-filter.appspot.com/fir/index.html" target="_blank"> TFilter Design Tool</a>

  2270. 		can be used to create the impulse response array.  Be sure to set the sampling

  2271. 		frequency to 44117 HZ (it defaults to only 2000 Hz) and the output type to "int" (16 bit).

  2272. 	</p>

  2273. 	<p>

  2274. 		If you use TFilter Design's "C/C++ array" option, it's output has "int" definition, which

  2275. 		is 32 bits on Teensy 3.1.  Edit "int" to "short" for an array of 16 bit numbers,

  2276. 		and add "const" to avoid consuming extra RAM.

  2277. 	</p>

  2278. </script>

  2279. <script type="text/x-red" data-template-name="AudioFilterFIR">

  2280. 	<div class="form-row">

  2281. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2282. 		<input type="text" id="node-input-name" placeholder="Name">

  2283. 	</div>

  2284. </script>

  2285. 

  2286. 

  2287. 

  2288. <script type="text/javascript">

  2289. 	RED.nodes.registerType('AudioFilterStateVariable',{

  2290. 	shortName: "filter",

  2291. 		inputs:2,

  2292. 		outputs:3,

  2293. 		category: 'filter-function',

  2294. 		color:"#E6E0F8",

  2295. 		icon: "arrow-in.png"

  2296. 	});

  2297. </script>

  2298. <script type="text/x-red" data-help-name="AudioFilterStateVariable">

  2299. 	<h3>Summary</h3>

  2300. 	<p>A State Variable (Chamberlin) Filter with 12 dB/octave roll-off,

  2301. 		adjustable resonance, and optional signal control of corner

  2302. 		frequency.</p>

  2303. 	<h3>Audio Connections</h3>

  2304. 	<table class=doc align=center cellpadding=3>

  2305. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  2306. 		<tr class=odd><td align=center>In 0</td><td>Signal to Filter</td></tr>

  2307. 		<tr class=odd><td align=center>In 1</td><td>Frequency Control</td></tr>

  2308. 		<tr class=odd><td align=center>Out 0</td><td>Low Pass Output</td></tr>

  2309. 		<tr class=odd><td align=center>Out 1</td><td>Band Pass Output</td></tr>

  2310. 		<tr class=odd><td align=center>Out 2</td><td>High Pass Output</td></tr>

  2311. 	</table>

  2312. 	<h3>Functions</h3>

  2313. 	<p class=func><span class=keyword>frequency</span>(freq);</p>

  2314. 	<p class=desc>Set the filter's corner frequency.  When a signal is

  2315. 		connected to the control input, the filter will implement this

  2316. 		frequency when the signal is zero.

  2317. 	</p>

  2318. 	<p class=func><span class=keyword>resonance</span>(Q);</p>

  2319. 	<p class=desc>Set the filter's resonance.  Q ranges from 0.7 to 5.0.

  2320. 		Resonance greater than 0.707 will amplify the signal near the

  2321. 		corner frequency.  You must attenuate the signal before input

  2322. 		to this filter, to prevent clipping.

  2323. 	</p>

  2324. 	<p class=func><span class=keyword>octaveControl</span>(octaves);</p>

  2325. 	<p class=desc>Set how much (in octaves) the control signal can alter

  2326. 		the filter's corner freqency.  Range is 0 to 7 octaves.  For

  2327. 		example, when set to 2.5, a full scale positive signal (1.0) will

  2328. 		shift the filter frequency up 2.5 octaves, and a full scale negative

  2329. 		signal will shift it down 2.5 octaves.

  2330. 	</p>

  2331. 	<!--<h3>Examples</h3>

  2332. 	<p class=exam>File &gt; Examples &gt; Audio &gt; 

  2333. 	</p>-->

  2334. 	<h3>Notes</h3>

  2335. 	<p>

  2336. 		When controlled by a signal, the equation for the filter

  2337. 		frequency is:

  2338. 	</p>

  2339. 	<p>

  2340. 		F = Fcenter * 2^<sup>(signal * octaves)</sup>

  2341. 		<br><small>If anyone knows how to do HTML equations, please

  2342. 		help me improve this.....</small>

  2343. 	</p>

  2344. 	<p>When operating with signal control of corner frequency, this

  2345. 		object uses approximately 4% of the CPU time on Teensy 3.1.

  2346. 	</p>

  2347. </script>

  2348. <script type="text/x-red" data-template-name="AudioFilterFIR">

  2349. 	<div class="form-row">

  2350. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2351. 		<input type="text" id="node-input-name" placeholder="Name">

  2352. 	</div>

  2353. </script>

  2354. 

  2355. 

  2356. 

  2357. 

  2358. <script type="text/javascript">

  2359. 	RED.nodes.registerType('AudioAnalyzePeak',{

  2360. 	shortName: "peak",

  2361. 		inputs:1,

  2362. 		outputs:0,

  2363. 		category: 'analyze-function',

  2364. 		color:"#E6E0F8",

  2365. 		icon: "arrow-in.png"

  2366. 	});

  2367. </script>

  2368. <script type="text/x-red" data-help-name="AudioAnalyzePeak">

  2369. 	<h3>Summary</h3>

  2370. 	<p>Track the signal peak amplitude.  Very useful for simple

  2371. 		audio level response projects, and general troubleshooting.</p>

  2372. 	<h3>Audio Connections</h3>

  2373. 	<table class=doc align=center cellpadding=3>

  2374. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  2375. 		<tr class=odd><td align=center>In 0</td><td>Signal to analyze</td></tr>

  2376. 	</table>

  2377. 	<h3>Functions</h3>

  2378. 	<p class=func><span class=keyword>available</span>();</p>

  2379. 	<p class=desc>Returns true each time new peak data is available.

  2380. 	</p>

  2381. 	<p class=func><span class=keyword>read</span>();</p>

  2382. 	<p class=desc>Read the highest peak value since the last read.

  2383. 		Return is from 0.0 to 1.0.

  2384. 	</p>

  2385. 	<h3>Examples</h3>

  2386. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Analysis &gt; PeakMeterMono

  2387. 	</p>

  2388. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Analysis &gt; PeakMeterStereo

  2389. 	</p>

  2390. 	<h3>Notes</h3>

  2391. 	<p></p>

  2392. </script>

  2393. <script type="text/x-red" data-template-name="AudioAnalyzePeak">

  2394. 	<div class="form-row">

  2395. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2396. 		<input type="text" id="node-input-name" placeholder="Name">

  2397. 	</div>

  2398. </script>

  2399. 

  2400. 

  2401. 

  2402. <script type="text/javascript">

  2403. 	RED.nodes.registerType('AudioAnalyzeFFT256',{

  2404. 	shortName: "fft256",

  2405. 		inputs:1,

  2406. 		outputs:0,

  2407. 		category: 'analyze-function',

  2408. 		color:"#E6E0F8",

  2409. 		icon: "arrow-in.png"

  2410. 	});

  2411. </script>

  2412. <script type="text/x-red" data-help-name="AudioAnalyzeFFT256">

  2413. 	<h3>Summary</h3>

  2414. 	<p>Compute a 256 point Fast Fourier Transform (FFT) frequency analysis,

  2415. 		with real value (magnitude) output.  The frequency resolution is

  2416. 		172 Hz, useful for simple audio visualization.</p>

  2417. 	<h3>Audio Connections</h3>

  2418. 	<table class=doc align=center cellpadding=3>

  2419. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  2420. 		<tr class=odd><td align=center>In 0</td><td>Signal to convert to frequency bins</td></tr>

  2421. 	</table>

  2422. 	<h3>Functions</h3>

  2423. 	<p class=func><span class=keyword>available</span>();</p>

  2424. 	<p class=desc>Returns true each time the FFT analysis produces new output data.

  2425. 	</p>

  2426. 	<p class=func><span class=keyword>read</span>(binNumber);</p>

  2427. 	<p class=desc>Read a single frequency bin, from 0 to 127.  The result is scaled

  2428. 		so 1.0 represents a full scale sine wave.

  2429. 	</p>

  2430. 	<p class=func><span class=keyword>read</span>(firstBin, lastBin);</p>

  2431. 	<p class=desc>Read several frequency bins, returning their sum.  The higher

  2432. 		audio octaves are represented by many bins, which are typically read

  2433. 		as a group for audio visualization.

  2434. 	</p>

  2435. 	<p class=func><span class=keyword>averageTogether</span>(number);</p>

  2436. 	<p class=desc>New data is produced very radidly, approximately 344 times

  2437. 		per second.  Multiple outputs can be averaged together, so available()

  2438. 		returns true at a slower rate.

  2439. 	</p>

  2440. 	<p class=func><span class=keyword>windowFunction</span>(window);</p>

  2441. 	<p class=desc>Set the window function to be used.  AudioWindowHanning256

  2442. 		is the default.  Windowing may be disabled by NULL, but windowing

  2443. 		should be used for all non-periodic (music) signals, and all periodic

  2444. 		signals that are not exact integer division of the sample rate.

  2445. 	</p>

  2446. 

  2447. 	<h3>Examples</h3>

  2448. 	<p class=exam>File &gt; Examples &gt; Audio &gt; MemoryAndCpuUsage

  2449. 	</p>

  2450. 	<h3>Notes</h3>

  2451. 	<p>The raw 16 bit output data bins may be access with myFFT.output[num], where

  2452. 		num is 0 to 127.</p>

  2453. 	<p>TODO: caveats about spectral leakage vs frequency precision for arbitrary signals</p>

  2454. 	<p>Window Types:

  2455. 		<ul>

  2456. 		<li><span class=literal>AudioWindowHanning256</span> (default)</li>

  2457. 		<li><span class=literal>AudioWindowBartlett256</span></li>

  2458. 		<li><span class=literal>AudioWindowBlackman256</span></li>

  2459. 		<li><span class=literal>AudioWindowFlattop256</span></li>

  2460. 		<li><span class=literal>AudioWindowBlackmanHarris256</span></li>

  2461. 		<li><span class=literal>AudioWindowNuttall256</span></li>

  2462. 		<li><span class=literal>AudioWindowBlackmanNuttall256</span></li>

  2463. 		<li><span class=literal>AudioWindowWelch256</span></li>

  2464. 		<li><span class=literal>AudioWindowHamming256</span></li>

  2465. 		<li><span class=literal>AudioWindowCosine256</span></li>

  2466. 		<li><span class=literal>AudioWindowTukey256</span></li>

  2467. 		</ul>

  2468. 	</p>

  2469. </script>

  2470. <script type="text/x-red" data-template-name="AudioAnalyzeFFT256">

  2471. 	<div class="form-row">

  2472. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2473. 		<input type="text" id="node-input-name" placeholder="Name">

  2474. 	</div>

  2475. </script>

  2476. 

  2477. 

  2478. 

  2479. <script type="text/javascript">

  2480. 	RED.nodes.registerType('AudioAnalyzeFFT1024',{

  2481. 	shortName: "fft1024",

  2482. 		inputs:1,

  2483. 		outputs:0,

  2484. 		category: 'analyze-function',

  2485. 		color:"#E6E0F8",

  2486. 		icon: "arrow-in.png"

  2487. 	});

  2488. </script>

  2489. <script type="text/x-red" data-help-name="AudioAnalyzeFFT1024">

  2490. 	<h3>Summary</h3>

  2491. 	<p>Compute a 1024 point Fast Fourier Transform (FFT) frequency analysis,

  2492. 		with real value (magnitude) output.  The frequency resolution is

  2493. 		43 Hz, useful detailed for audio visualization.</p>

  2494. 	<h3>Audio Connections</h3>

  2495. 	<table class=doc align=center cellpadding=3>

  2496. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  2497. 		<tr class=odd><td align=center>In 0</td><td>Signal to convert to frequency bins</td></tr>

  2498. 	</table>

  2499. 	<h3>Functions</h3>

  2500. 	<p class=func><span class=keyword>available</span>();</p>

  2501. 	<p class=desc>Returns true each time the FFT analysis produces new output data.

  2502. 	</p>

  2503. 	<p class=func><span class=keyword>read</span>(binNumber);</p>

  2504. 	<p class=desc>Read a single frequency bin, from 0 to 511.  The result is scaled

  2505. 		so 1.0 represents a full scale sine wave.

  2506. 	</p>

  2507. 	<p class=func><span class=keyword>read</span>(firstBin, lastBin);</p>

  2508. 	<p class=desc>Read several frequency bins, returning their sum.  The higher

  2509. 		audio octaves are represented by many bins, which are typically read

  2510. 		as a group for audio visualization.

  2511. 	</p>

  2512. 	<p class=func><span class=keyword>averageTogether</span>(number);</p>

  2513. 	<p class=desc>This function does nothing.  The 1024 point FFT always

  2514. 		updates at approximately 86 times per second.

  2515. 	</p>

  2516. 	<p class=func><span class=keyword>windowFunction</span>(window);</p>

  2517. 	<p class=desc>Set the window function to be used.  AudioWindowHanning1024

  2518. 		is the default.  Windowing may be disabled by NULL, but windowing

  2519. 		should be used for all non-periodic (music) signals, and all periodic

  2520. 		signals that are not exact integer division of the sample rate.

  2521. 	</p>

  2522. 	<h3>Examples</h3>

  2523. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Analysis &gt; FFT

  2524. 	</p>

  2525. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Analysis &gt; SpectrumAnalyzerBasic

  2526. 	</p>

  2527. 	<h3>Notes</h3>

  2528. 	<p>The raw 16 bit output data bins may be access with myFFT.output[num], where

  2529. 		num is 0 to 511.</p>

  2530. 	<p>TODO: caveats about spectral leakage vs frequency precision for arbitrary signals</p>

  2531. 	<p>Window Types:

  2532. 		<ul>

  2533. 		<li><span class=literal>AudioWindowHanning1024</span> (default)</li>

  2534. 		<li><span class=literal>AudioWindowBartlett1024</span></li>

  2535. 		<li><span class=literal>AudioWindowBlackman1024</span></li>

  2536. 		<li><span class=literal>AudioWindowFlattop1024</span></li>

  2537. 		<li><span class=literal>AudioWindowBlackmanHarris1024</span></li>

  2538. 		<li><span class=literal>AudioWindowNuttall1024</span></li>

  2539. 		<li><span class=literal>AudioWindowBlackmanNuttall1024</span></li>

  2540. 		<li><span class=literal>AudioWindowWelch1024</span></li>

  2541. 		<li><span class=literal>AudioWindowHamming1024</span></li>

  2542. 		<li><span class=literal>AudioWindowCosine1024</span></li>

  2543. 		<li><span class=literal>AudioWindowTukey1024</span></li>

  2544. 		</ul>

  2545. 	</p>

  2546. 	<p>1024 point FFT has a peak CPU usage of approx 52% on Teensy 3.1.

  2547. 		Average usage is much lower.  Future versions might distribute the

  2548. 		load more evenly over time....

  2549. 	</p>

  2550. </script>

  2551. <script type="text/x-red" data-template-name="AudioAnalyzeFFT1024">

  2552. 	<div class="form-row">

  2553. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2554. 		<input type="text" id="node-input-name" placeholder="Name">

  2555. 	</div>

  2556. </script>

  2557. 

  2558. 

  2559. 

  2560. <script type="text/javascript">

  2561. 	RED.nodes.registerType('AudioAnalyzeToneDetect',{

  2562. 	shortName: "tone",

  2563. 		inputs:1,

  2564. 		outputs:0,

  2565. 		category: 'analyze-function',

  2566. 		color:"#E6E0F8",

  2567. 		icon: "arrow-in.png"

  2568. 	});

  2569. </script>

  2570. <script type="text/x-red" data-help-name="AudioAnalyzeToneDetect">

  2571. 	<h3>Summary</h3>

  2572. 	<p>Detect the level of a single tone</p>

  2573. 	<h3>Audio Connections</h3>

  2574. 	<table class=doc align=center cellpadding=3>

  2575. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  2576. 		<tr class=odd><td align=center>In 0</td><td>Signal to analyze</td></tr>

  2577. 	</table>

  2578. 	<h3>Functions</h3>

  2579. 	<p class=func><span class=keyword>frequency</span>(freq);</p>

  2580. 	<p class=desc>Set the frequency to detect.  The default detection time

  2581. 		will be 10 cycles of this frequency.

  2582. 	</p>

  2583. 	<p class=func><span class=keyword>frequency</span>(freq, cycles);</p>

  2584. 	<p class=desc>Set the frequency to detect, and the number of cycles.

  2585. 		Longer detection time (more cycles) will give higher precision,

  2586. 		but of course slower response.

  2587. 	</p>

  2588. 	<p class=func><span class=keyword>available</span>();</p>

  2589. 	<p class=desc>Returns true (non-zero) each time a detection interval

  2590. 		(number of cycles) completed and a new level is detected.

  2591. 	</p>

  2592. 	<p class=func><span class=keyword>read</span>();</p>

  2593. 	<p class=desc>Read the detected signal level.  Range is 0 to 1.0.

  2594. 	</p>

  2595. 	<p class=func><span class=keyword>threshold</span>(level);</p>

  2596. 	<p class=desc>Set a detection threshold, where the bool test operation

  2597. 		will return true if at or above this level, or false when below.

  2598. 	</p>

  2599. 	<p class=func>(bool)</p>

  2600. 	<p class=desc>By testing the object as a boolean value, you can respond

  2601. 		to detection of a tone.

  2602. 	</p>

  2603. 	<h3>Examples</h3>

  2604. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Analysis &gt; DialTone_Serial

  2605. 	</p>

  2606. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Analysis &gt; DialTone_7segment

  2607. 	</p>

  2608. 	<h3>Notes</h3>

  2609. 	<p>Low frequency detection has trouble with numerical precision.

  2610. 		Works really well for all 8 DTMF frequencies, but fails for

  2611. 		detecting "sub audible tones" used in some control applications.</p>

  2612. 	<p>The (bool) test continues to return true until the next detection

  2613. 		interval (the configured number of cycles).  This behavior may

  2614. 		change in future versions, for a single true each time the signal

  2615. 		is detected, and then false for the remainder of that interval.</p>

  2616. </script>

  2617. <script type="text/x-red" data-template-name="AudioAnalyzeToneDetect">

  2618. 	<div class="form-row">

  2619. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2620. 		<input type="text" id="node-input-name" placeholder="Name">

  2621. 	</div>

  2622. </script>

  2623. 

  2624. 

  2625. 

  2626. <script type="text/javascript">

  2627. 	RED.nodes.registerType('AudioAnalyzePrint',{

  2628. 	shortName: "print",

  2629. 		inputs:1,

  2630. 		outputs:0,

  2631. 		category: 'analyze-function',

  2632. 		color:"#E6E0F8",

  2633. 		icon: "arrow-in.png"

  2634. 	});

  2635. </script>

  2636. <script type="text/x-red" data-help-name="AudioAnalyzePrint">

  2637. 	<h3>Summary</h3>

  2638. 	<p>Print raw audio data to the Arduino Serial Monitor.  This

  2639. 		object creates massive output quickly, and should not normally be used.</p>

  2640. 	<h3>Audio Connections</h3>

  2641. 	<table class=doc align=center cellpadding=3>

  2642. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  2643. 		<tr class=odd><td align=center>In 0</td><td>Signal to print</td></tr>

  2644. 	</table>

  2645. 	<h3>Functions</h3>

  2646. 	<p class=func><span class=keyword>name</span>(string);</p>

  2647. 	<p class=desc>blah blah blah blah

  2648. 	</p>

  2649. 	<p class=func><span class=keyword>trigger</span>();</p>

  2650. 	<p class=desc>blah blah blah blah

  2651. 	</p>

  2652. 	<p class=func><span class=keyword>trigger</span>(level, edge);</p>

  2653. 	<p class=desc>blah blah blah blah

  2654. 	</p>

  2655. 	<p class=func><span class=keyword>delay</span>(samples);</p>

  2656. 	<p class=desc>blah blah blah blah

  2657. 	</p>

  2658. 	<p class=func><span class=keyword>length</span>(samples);</p>

  2659. 	<p class=desc>blah blah blah blah

  2660. 	</p>

  2661. 	<!--<h3>Examples</h3>

  2662. 	<p class=exam>File &gt; Examples &gt; Audio &gt; 

  2663. 	</p>-->

  2664. 	<h3>Notes</h3>

  2665. 	<p>This object doesn't work very well and probably should not be used.</p>

  2666. </script>

  2667. <script type="text/x-red" data-template-name="AudioAnalyzePrint">

  2668. 	<div class="form-row">

  2669. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2670. 		<input type="text" id="node-input-name" placeholder="Name">

  2671. 	</div>

  2672. </script>

  2673. 

  2674. 

  2675. 

  2676. <script type="text/javascript">

  2677. 	RED.nodes.registerType('AudioControlSGTL5000',{

  2678. 	shortName: "sgtl5000",

  2679. 		inputs:0,

  2680. 		outputs:0,

  2681. 		category: 'control-function',

  2682. 		color:"#E6E0F8",

  2683. 		icon: "arrow-in.png"

  2684. 	});

  2685. </script>

  2686. <script type="text/x-red" data-help-name="AudioControlSGTL5000">

  2687. 	<h3>Summary</h3>

  2688. 	<p>Control the SGTL5000 chip on the

  2689. 		<a href="http://www.pjrc.com/store/teensy3_audio.html" target="_blank">audio shield</a>.

  2690. 		SGTL5000 is always used in slave mode, where Teensy controls

  2691. 		all I2S timing.

  2692. 	</p>

  2693. 	<p align=center><img src="img/sgtl5000closeup.jpg"></p>

  2694. 	<h3>Audio Connections</h3>

  2695. 	<p>This object has no audio inputs or outputs.  Separate i2s objects

  2696. 		are used to send and receive audio data.  I2S master mode objects

  2697. 		must be used, because this object configures the SGTL5000 in slave

  2698. 		mode, where it depends on Teensy to provide all I2S clocks.

  2699. 		This object controls

  2700. 		how the SGTL5000 will use those I2S audio streams.</p>

  2701. 

  2702. 	<h3>Functions</h3>

  2703. 	<p>These are the most commonly used SGTL5000 functions.</p>

  2704. 	<p class=func><span class=keyword>enable</span>();</p>

  2705. 	<p class=desc>Start the SGTL5000.  This function should be called first.

  2706. 	</p>

  2707. 	<p class=func><span class=keyword>volume</span>(level);</p>

  2708. 	<p class=desc>Set the headphone volume level.  Range is 0 to 1.0, but

  2709. 		0.8 corresponds to the maximum undistorted output for a full scale

  2710. 		signal.  Usually 0.5 is a comfortable listening level.  The line

  2711. 		level outputs are <em>not</em> changed by this function.

  2712. 	</p>

  2713. 	<p class=func><span class=keyword>inputSelect</span>(input);</p>

  2714. 	<p class=desc>Select which input to use: AUDIO_INPUT_LINEIN or AUDIO_INPUT_MIC.

  2715. 	</p>

  2716. 	<p class=func><span class=keyword>micGain</span>(dB);</p>

  2717. 	<p class=desc>When using the microphone input, set the amplifier gain.

  2718. 		The input number is in decibels, from 0 to 63.

  2719. 	</p>

  2720. 

  2721. 	<h3>Signal Levels</h3>

  2722. 

  2723. 	<p>The default signal levels should be used for most applications,

  2724. 		but these functions allow you to customize the analog signals.</p>

  2725. 

  2726. 	<p class=func><span class=keyword>muteHeadphone</span>();</p>

  2727. 	<p class=desc>Silence the headphone output.

  2728. 	</p>

  2729. 	<p class=func><span class=keyword>unmuteHeadphone</span>();</p>

  2730. 	<p class=desc>Turn the headphone output on.

  2731. 	</p>

  2732. 	<p class=func><span class=keyword>muteLineout</span>();</p>

  2733. 	<p class=desc>Silence the line level outputs.

  2734. 	</p>

  2735. 	<p class=func><span class=keyword>unmuteLineout</span>();</p>

  2736. 	<p class=desc>Turn the line level outputs on.

  2737. 	</p>

  2738. 	<p class=func><span class=keyword>lineInLevel</span>(both);</p>

  2739. 	<p class=desc style="padding-bottom:0.2em;">Adjust the sensitivity of the line-level inputs.

  2740. 		Fifteen settings are possible:

  2741. 	</p>

  2742. <pre class="desc">

  2743.  0: 3.12 Volts p-p

  2744.  1: 2.63 Volts p-p

  2745.  2: 2.22 Volts p-p

  2746.  3: 1.87 Volts p-p

  2747.  4: 1.58 Volts p-p

  2748.  5: 1.33 Volts p-p  (default)

  2749.  6: 1.11 Volts p-p

  2750.  7: 0.94 Volts p-p

  2751.  8: 0.79 Volts p-p

  2752.  9: 0.67 Volts p-p

  2753. 10: 0.56 Volts p-p

  2754. 11: 0.48 Volts p-p

  2755. 12: 0.40 Volts p-p

  2756. 13: 0.34 Volts p-p

  2757. 14: 0.29 Volts p-p

  2758. 15: 0.24 Volts p-p

  2759. </pre>

  2760. 	<p class=func><span class=keyword>lineInLevel</span>(left, right);</p>

  2761. 	<p class=desc>Adjust the sensitivity of the line-level inputs, with different

  2762. 		settings for left and right.  The same 15 settings are available.

  2763. 	</p>

  2764. 	<p class=func><span class=keyword>lineOutLevel</span>(both);</p>

  2765. 	<p class=desc style="padding-bottom:0.2em;">Adjust the line level output

  2766. 		voltage range.  The following settings are possible:

  2767. 	</p>

  2768. <pre class="desc">

  2769. 13: 3.16 Volts p-p

  2770. 14: 2.98 Volts p-p

  2771. 15: 2.83 Volts p-p

  2772. 16: 2.67 Volts p-p

  2773. 17: 2.53 Volts p-p

  2774. 18: 2.39 Volts p-p

  2775. 19: 2.26 Volts p-p

  2776. 20: 2.14 Volts p-p

  2777. 21: 2.02 Volts p-p

  2778. 22: 1.91 Volts p-p

  2779. 23: 1.80 Volts p-p

  2780. 24: 1.71 Volts p-p

  2781. 25: 1.62 Volts p-p

  2782. 26: 1.53 Volts p-p

  2783. 27: 1.44 Volts p-p

  2784. 28: 1.37 Volts p-p

  2785. 29: 1.29 Volts p-p  (default)

  2786. 30: 1.22 Volts p-p

  2787. 31: 1.16 Volts p-p

  2788. </pre>

  2789. 	<p class=func><span class=keyword>lineOutLevel</span>(left, right);</p>

  2790. 	<p class=desc>Adjust the line level outout voltage range, with separate

  2791. 		settings for left and right.  The same settings (13 to 31) are available.

  2792. 	</p>

  2793. 

  2794. 

  2795. 	<h3>Signal Conditioning</h3>

  2796. 

  2797. 	<p>Usually these digital signal conditioning features should be left at their

  2798. 		default settings.

  2799. 	</p>

  2800. 

  2801. 	<p class=func><span class=keyword>adcHighPassFilterFreeze</span>();</p>

  2802. 	<p class=desc>By default, the analog input (either line-level inputs or mic)

  2803. 		is high-pass filtered, to remove any DC component.  This function

  2804. 		freezes the filter, so the current DC component is still substracted, but

  2805. 		the filter stops tracking any DC or low frequency changes.

  2806. 	</p>

  2807. 	<p class=func><span class=keyword>adcHighPassFilterDisable</span>();</p>

  2808. 	<p class=desc>Completely disable the analog input filter.  DC and sub-audible

  2809. 		low frequencies are allowed to enter the digital signal.

  2810. 	</p>

  2811. 	<p class=func><span class=keyword>adcHighPassFilterEnable</span>();</p>

  2812. 	<p class=desc>Turn the DC-blocking filter back on, if disabled, or

  2813. 		allows it to resume tracking DC and low frequency changes, if

  2814. 		previously frozen. This is the default setting.

  2815. 	</p>

  2816. 	<p class=func><span class=keyword>dacVolume</span>(both);</p>

  2817. 	<p class=desc>Normally output volume should be used with volume(), which

  2818. 		changes the analog gain in the headphone amplifier.  This function

  2819. 		on the other hand controls digital attenuation before conversion to analog, which

  2820. 		reduces resolution, but allows another fine control of output

  2821. 		signal level.  The ranges is 0 to 1.0, with the default (no digital attenuation)

  2822. 		at 1.0.

  2823. 	</p>

  2824. 	<p  class=desc>dacVolume uses zero-crossing detect to avoid clicks, and ramping is handled by

  2825. 	the chip so that a new volume may be set directly in a single call.

  2826. 	</p>

  2827. 	<p class=func><span class=keyword>dacVolume</span>(left, right);</p>

  2828. 	<p class=desc>Adjust the digital output volume separately on left and

  2829. 		right channels.

  2830. 	</p>

  2831. 

  2832. 

  2833. 	<h3>Audio Processor</h3>

  2834. 

  2835. 	<p>The optional digital audio processor is capable of implementing

  2836. 		one or more of: automatic volume control, surround sound control,

  2837. 		bass enhancement, and tonal adjustments (either a

  2838. 		simple tone control, or a parametric equalizer, or a graphic equalizer),

  2839. 		in that order.

  2840. 	</p>

  2841. 	<p>These signal processing features are implemented in the SGTL5000 chip,

  2842. 		so they do not consume CPU time on Teensy. However, the order of

  2843. 		these processes is fixed in the hardware.

  2844. 	</p>

  2845. 	<p>It is good practice to mute the outputs before enabling or disabling

  2846. 	the Audio Processor, to avoid clicks or thumps.

  2847. 	</p>

  2848. 

  2849. 	<p class=func><span class=keyword>audioPreProcessorEnable</span>();</p>

  2850. 	<p class=desc>Enable the audio processor to pre-process the input

  2851. 		(from either line-level inputs or microphone) before it's sent

  2852. 		to Teensy by I2S.

  2853. 	</p>

  2854. 	<p class=func><span class=keyword>audioPostProcessorEnable</span>();</p>

  2855. 	<p class=desc>Enable the audio processor to post-process Teensy's

  2856. 		I2S output before it's turned into analog signals for the

  2857. 		headphones and/or line level outputs.

  2858. 	</p>

  2859. 	<p class=func><span class=keyword>audioProcessorDisable</span>();</p>

  2860. 	<p class=desc>Disable the audio processor.

  2861. 	</p>

  2862. 	<p class=func><span class=keyword>autoVolumeControl</span>(maxGain, response, hardLimit, threshold, attack, decay);</p>

  2863. 	<p class=desc>Configures the auto volume control, which is implemented as a compressor/expander

  2864. 	or hard limiter. 	<em>maxGain</em> is the maximum gain that can be applied for expanding, and

  2865. 	can take one of three values: 0 (0dB), 1 (6.0dB) and 2 (12dB). Values greater than 2 are treated

  2866. 	as 2. <em>response</em> controls the integration time for the compressor and can take

  2867. 	four values: 0 (0ms), 1 (25ms), 2 (50ms) or 3 (100ms). Larger values average the volume

  2868. 	over a longer time, allowing short-term peaks through.

  2869. 	</p>

  2870. 	<p class=desc>If <em>hardLimit</em> is 0, a 'soft

  2871. 	knee' compressor is used to progressively compress louder values which are near to or above the

  2872. 	threashold (the louder they are, the greater the compression). If it is 1, a hard compressor

  2873. 	is used (all values above the threashold are the same loudness). The <em>threashold</em> is specified

  2874. 	as a float in the range 0dBFS to -96dBFS, where -18dBFS is a typical value.

  2875. 	<em>attack</em> is a float controlling the rate of decrease in gain when the signal is over

  2876. 	threashold, in dB/s. <em>decay</em> controls how fast gain is restored once the level

  2877. 	drops below threashold, again in dB/s. It is typically set to a longer value than attack.

  2878. 	</p>

  2879. 	<p class=func><span class=keyword>autoVolumeEnable</span>();</p>

  2880. 	<p class=desc>Enables auto volume control, using the previously specified settings.

  2881. 	</p>

  2882. 	<p class=func><span class=keyword>autoVolumeDisable</span>();</p>

  2883. 	<p class=desc>Disables auto volume control.

  2884. 	</p>

  2885. 

  2886. 	<p class=func><span class=keyword>surroundSoundEnable</span>();</p>

  2887. 	<p class=desc>Enable virtual surround processing, to give a broader and

  2888. 	deeper stereo image (even with mono input).

  2889. 	</p>

  2890. 	<p class=func><span class=keyword>surroundSoundDisable</span>();</p>

  2891. 	<p class=desc>Disable virtual surround processing. Before disabling, ramp up

  2892. 	the width to maximum to avoid pops.

  2893. 	</p>

  2894. 	<p class=func><span class=keyword>surroundSound</span>(width);</p>

  2895. 	<p class=desc>Configures virtual surround width from 0 (mono) to 7 (widest).

  2896. 	</p>

  2897. 	<p class=func><span class=keyword>surroundSound</span>(width, select);</p>

  2898. 	<p class=desc>Configures virtual surround width from 0 (mono) to 7 (widest).

  2899. 	<em>select</em> may be set to 1 (disable), 2 (mono input) or 3 (stereo input).

  2900. 	</p>

  2901. 

  2902. 	<p class=func><span class=keyword>enhanceBassEnable</span>();</p>

  2903. 	<p class=desc>Enable bass enhancement. A mono, low-pass filtered copy of

  2904. 	the original stereo signal has bass levels boosted and is then mixed back into

  2905. 	the stereo signal, which is then optionally high pass filtered (to remove

  2906. 	inaudible subsonic frequencies).

  2907. 	</p>

  2908. 	<p class=func><span class=keyword>enhanceBassDisable</span>();</p>

  2909. 	<p class=desc>Disable bass enhancement. Before disabling, ramp down the bass

  2910. 	enhancement level to zero.

  2911. 	</p>

  2912. 	<p class=func><span class=keyword>enhanceBass</span>(lr_lev, bass_lev);</p>

  2913. 	<p class=desc>Configures the bass enhancement by setting the levels of the

  2914. 	original stereo signal and the bass-enhanced mono level which will be mixed together.

  2915. 	There is no high-pass filter.

  2916. 	</p>

  2917. 	<p  class=desc>When changing bass level, call this function repeatedly to ramp up or down the bass in

  2918. 	steps of 0.5dB, to avoid pops.

  2919. 	</p>

  2920. 	<p class=func><span class=keyword>enhanceBass</span>(lr_lev, bass_lev, hpf_bypass, cutoff);</p>

  2921. 	<p class=desc>Configures the bass enhancement by setting the levels of the

  2922. 	original stereo signal and the bass-enhanced mono level which will be mixed together.

  2923. 	The high-pass filter may be enabled (0) or bypassed (1). The cutoff frequency is specified

  2924. 	as follows:

  2925. 	</p>

  2926. 	<pre class="desc">

  2927. value  frequency

  2928.  0      80Hz

  2929.  1     100Hz

  2930.  2     125Hz

  2931.  3     150Hz

  2932.  4     175Hz

  2933.  5     200Hz

  2934.  6     225Hz

  2935. </pre>

  2936. 	<p  class=desc>When changing bass level, call this function repeatedly to ramp up or down the bass in

  2937. 	steps of 0.5dB, to avoid pops.

  2938. 	</p>

  2939. 

  2940. 	<p class=func><span class=keyword>eqSelect</span>(n);</p>

  2941. 	<p class=desc>Selects the type of frequency control, where <em>n</em> is

  2942. 	one of</p>

  2943. 	<p class=desc><b>FLAT_FREQUENCY (0)</b><br>

  2944.     Equalizers and tone controls disabled, flat frequency response.</p>

  2945.     <p class=desc><b>PARAMETRIC_EQUALIZER (1)</b><br>

  2946.     Enables the 7-band parametric equalizer, thus disabling the

  2947. 	tone controls and graphic equalizer.</p>

  2948.     <p class=desc><b>TONE_CONTROLS (2)</b><br>

  2949.     Enables bass and treble tone controls, disabling the parametric

  2950. 	equalization and graphic equalizer.</p>

  2951.     <p class=desc><b>GRAPHIC_EQUALIZER (3)</b><br>

  2952.     Enables the five-band graphic equalizer, disabling the parametric

  2953. 	equalization and tone controls.</p>

  2954. 

  2955. 

  2956. 	<p class=func><span class=keyword>eqBands</span>(bass, treble);</p>

  2957. 	<p class=desc>Configures bass and treble tone controls, which are

  2958. 	implemented as one second order low pass filter (bass) in parallel with

  2959. 	one second order high pass filter (treble).

  2960. 	</p>

  2961. 	<p class=desc>When changing bass or treble level, call this function repeatedly to ramp

  2962. 	up or down the level in steps of 0.04 (=0.5dB) or so, to avoid pops.

  2963. 	</p>

  2964. 	<p class=func><span class=keyword>eqBands</span>(bass, mid_bass, midrange, mid_treble, treble);</p>

  2965. 	<p class=desc>Configures the graphic equalizer. It is implemented by five parallel,

  2966. 	second order biquad filters with fixed frequencies of 115Hz, 330Hz, 990Hz, 3kHz,

  2967. 	and 9.9kHz. Each band has a range of adjustment from 1.00 (+12dB) to -1.00 (-11.75dB).

  2968. 	</p>

  2969. 	<p class=func><span class=keyword>eqBand</span>(bandNum, n);</p>

  2970. 	<p class=desc>Configures the gain or cut on one band in the graphic equalizer.

  2971. 	<em>bandnum</em> can range from 1 to 5; <em>n</em> is a float in the range 1.00 to -1.00.

  2972. 	</p>

  2973. 	<p  class=desc>When changing a band, call this function repeatedly to ramp up the gain in steps of 0.5dB,

  2974. 	to avoid pops.

  2975. 	</p>

  2976. 

  2977. 	<p class=func><span class=keyword>eqFilter</span>(filterNum, filterParameters);</p>

  2978. 	<p class=desc>Configurs the parametric equalizer. The number of filters (1 to 7)

  2979. 	is specified along with  a pointer to an array of filter coefficients.

  2980. 	The parametric equalizer is implemented using 7 cascaded, second order bi-quad

  2981. 	filters whose frequencies, gain, and Q may be freely configured, but each filter

  2982. 	can only be specified as a set of filter coefficients.

  2983. 	</p>

  2984. 	<p class=func><span class=keyword>eqFilterCount</span>(n);</p>

  2985. 	<p class=desc>Enables zero or more of the already enabled parametric filters.

  2986. 	</p>

  2987. 

  2988. 	<h3>Examples</h3>

  2989. 	<p>Nearly all of the library's examples use this object.  These

  2990. 		examples demonstrate its special features.

  2991. 	</p>

  2992. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; PassThroughStereo

  2993. 	</p>

  2994. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; SGTL5000 &gt; dap_bass_enhance

  2995. 	</p>

  2996. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; SGTL5000 &gt; dap_avc_agc

  2997. 	</p>

  2998. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; SGTL5000 &gt; balanceDAC

  2999. 	</p>

  3000. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; SGTL5000 &gt; balanceHP

  3001. 	</p>

  3002. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; SGTL5000 &gt; CalcBiquadToneControlDAP

  3003. 	</p>

  3004. 	<h3>Notes</h3>

  3005. 	<p>TODO: add example with rock/classical/speech presets, where rock uses bass boost

  3006. 	and surround enhancement while speech uses bandpass filtering and auto volume control

  3007. 	compression.

  3008. 	</p>

  3009. 	<p>TODO: add example with two analogRead pots for bass and treble to demonstrate ramping.

  3010. 	</p>

  3011. </script>

  3012. <script type="text/x-red" data-template-name="AudioControlSGTL5000">

  3013. 	<div class="form-row">

  3014. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  3015. 		<input type="text" id="node-input-name" placeholder="Name">

  3016. 	</div>

  3017. </script>

  3018. 

  3019. 

  3020. 

  3021. <script type="text/javascript">

  3022. 	RED.nodes.registerType('AudioControlWM8731',{

  3023. 	shortName: "wm8731",

  3024. 		inputs:0,

  3025. 		outputs:0,

  3026. 		category: 'control-function',

  3027. 		color:"#E6E0F8",

  3028. 		icon: "arrow-in.png"

  3029. 	});

  3030. </script>

  3031. <script type="text/x-red" data-help-name="AudioControlWM8731">

  3032. 	<h3>Summary</h3>

  3033. 	<p>Control a WM8731 chip in slave mode, where it receives all clocks from Teensy</p>

  3034. 	<h3>Audio Connections</h3>

  3035. 	<p>This object has no audio inputs or outputs.  Separate i2s objects

  3036. 		are used to send and receive audio data.  I2S master mode objects

  3037. 		must be used, since this control object configures the WM8731 into

  3038. 		slave mode.

  3039. 	</p>

  3040. 	<h3>Functions</h3>

  3041. 	<p class=func><span class=keyword>enable</span>();</p>

  3042. 	<p class=desc>blah blah blah blah

  3043. 	</p>

  3044. 	<p class=func><span class=keyword>disable</span>();</p>

  3045. 	<p class=desc>not implemented

  3046. 	</p>

  3047. 	<p class=func><span class=keyword>volume</span>(level);</p>

  3048. 	<p class=desc>blah blah blah blah

  3049. 	</p>

  3050. 	<p class=func><span class=keyword>inputLevel</span>(level);</p>

  3051. 	<p class=desc>not implemented

  3052. 	</p>

  3053. 	<p class=func><span class=keyword>inputSelect</span>(input);</p>

  3054. 	<p class=desc>not implemented

  3055. 	</p>

  3056. 	<!--<h3>Examples</h3>

  3057. 	<p class=exam>File &gt; Examples &gt; Audio &gt;

  3058. 	</p>-->

  3059. 	<h3>Notes</h3>

  3060. 	<p></p>

  3061. </script>

  3062. <script type="text/x-red" data-template-name="AudioControlWM8731">

  3063. 	<div class="form-row">

  3064. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  3065. 		<input type="text" id="node-input-name" placeholder="Name">

  3066. 	</div>

  3067. </script>

  3068. 

  3069. 

  3070. 

  3071. <script type="text/javascript">

  3072. 	RED.nodes.registerType('AudioControlWM8731master',{

  3073. 	shortName: "wm8731m",

  3074. 		inputs:0,

  3075. 		outputs:0,

  3076. 		category: 'control-function',

  3077. 		color:"#E6E0F8",

  3078. 		icon: "arrow-in.png"

  3079. 	});

  3080. </script>

  3081. <script type="text/x-red" data-help-name="AudioControlWM8731master">

  3082. 	<h3>Summary</h3>

  3083. 	<p>Control a WM8731 chip in master mode, where it controls all I2S timing.</p>

  3084. 	<h3>Audio Connections</h3>

  3085. 	<p>This object has no audio inputs or outputs.  Separate i2s objects

  3086. 		are used to send and receive audio data.  I2S slave mode objects

  3087. 		must be used, since this control object configures the WM8731 into

  3088. 		master mode.

  3089. 	</p>

  3090. 	<h3>Functions</h3>

  3091. 	<p class=func><span class=keyword>enable</span>();</p>

  3092. 	<p class=desc>blah blah blah blah

  3093. 	</p>

  3094. 	<p class=func><span class=keyword>disable</span>();</p>

  3095. 	<p class=desc>not implemented

  3096. 	</p>

  3097. 	<p class=func><span class=keyword>volume</span>(level);</p>

  3098. 	<p class=desc>blah blah blah blah

  3099. 	</p>

  3100. 	<p class=func><span class=keyword>inputLevel</span>(level);</p>

  3101. 	<p class=desc>not implemented

  3102. 	</p>

  3103. 	<p class=func><span class=keyword>inputSelect</span>(input);</p>

  3104. 	<p class=desc>not implemented

  3105. 	</p>

  3106. 	<h3>Examples</h3>

  3107. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; WM8731MikroSine

  3108. 	</p>

  3109. 	<h3>Notes</h3>

  3110. 	<p></p>

  3111. </script>

  3112. <script type="text/x-red" data-template-name="AudioControlWM8731master">

  3113. 	<div class="form-row">

  3114. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  3115. 		<input type="text" id="node-input-name" placeholder="Name">

  3116. 	</div>

  3117. </script>

  3118. 

  3119. 

  3120. 

  3121. 

  3122. 

  3123. </body>

  3124. </html>