visus
/
teensy-audio
İzle 1
Yıldızla 0
Çatalla 0
Kod Sorunlar 0 Değişiklik İstekleri 0 Sürümler 0 Wiki Aktivite
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
650 İşlemeler
2 Dallar
Ağaç: d7bc194c25
Dallar Biçim İmleri
${ item.name }
Branş ${ searchTerm } oluştur
'd7bc194c25'den
${ noResults }
teensy-audio/gui/index.html

3939 satır
176KB
Ham Bahset Geçmiş 

  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. -->

  65. 					<!--

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

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

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

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

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

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

  72. 							</li>

  73. 						</ul>

  74. 					</li>

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

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

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

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

  79. 						</ul>

  80. 					</li>

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

  82. -->

  83. 					<!--

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

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

  86. -->

  87. 					<!--

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

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

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

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

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

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

  94. 						</ul>

  95. 					</li>

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

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

  98. 					<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>

  99. 				</ul>

  100. 			</div>

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

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

  103. 				<a id="btn-import" class="btn action-import disabled" href="#"><i id="btn-icn-download" class="icon-download"></i>Import</a>

  104. 			</div>

  105. 		</div>

  106. 	</div>

  107. </div>

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

  109. 	<div id="palette">

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

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

  112. 		</div>

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

  114. 			<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>

  115. 		</div>

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

  117. 

  118. 	<div id="workspace">

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

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

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

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

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

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

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

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

  127. 			</div>

  128. 		</div>

  129. 	</div>

  130. 

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

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

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

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

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

  136. 		</div>

  137. 	</div>

  138. 

  139. 	<div id="sidebar">

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

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

  142. 	</div>

  143. 

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

  145. 

  146. </div>

  147. 

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

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

  150. 

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

  152. <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>

  153. 

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

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

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

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

  158. 		</div>

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

  160. 			The workspace contains some unknown node types:

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

  162. 			Are you sure you want to deploy?

  163. 		</div>

  164. 	</form>

  165. </div>

  166. 

  167. <div id="node-dialog-error-deploy" class="hide">

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

  169. 		<div id="node-dialog-error-deploy-noio" style="text-align: center; padding-top: 10px;">

  170. 			<p>The workspace contains no input/output nodes!</p>

  171. 			<p>You need an input or an output to export the data!</p>

  172. 			<p>Without such a input/output function the exported

  173. 			code will not run properly!</p>

  174. 		</div>

  175. 	</form>

  176. </div>

  177. 

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

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

  180. 	<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>

  181.   </div>

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

  183. 	<table>

  184. 		<tr>

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

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

  187. 		</tr>

  188. 		<tr>

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

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

  191. 		</tr>

  192. 		<tr>

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

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

  195. 		</tr>

  196. 		<tr>

  197. 		  <td></td><td></td>

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

  199. 		</tr>

  200. 		<tr>

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

  202. 		  <td></td><td></td>

  203. 		</tr>

  204. 		<tr>

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

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

  207. 		</tr>

  208. 		<tr>

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

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

  211. 		</tr>

  212. 		<tr>

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

  214. 		</tr>

  215. 		<tr>

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

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

  218. 		</tr>

  219. 	</table>

  220.   </div>

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

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

  223.   </div>

  224. </div>

  225. 

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

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

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

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

  230. 		</div>

  231. 	</form>

  232. </div>

  233. 

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

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

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

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

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

  239. 		</div>

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

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

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

  243. 		</div>

  244. 	</form>

  245. </div>

  246. 

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

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

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

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

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

  252. 			</ul>

  253. 		</div>

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

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

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

  257. 			</div>

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

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

  260. 			</div>

  261. 		</div>

  262. 	</form>

  263. </div>

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

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

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

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

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

  269. 		</div>

  270. 	</form>

  271. </div>

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

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

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

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

  276. 		</div>

  277. 	</form>

  278. </div>

  279. 

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

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

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

  283. 		<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>

  284. 	</div>

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

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

  287. 	</div>

  288. </script>

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

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

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

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

  293. 	</div>

  294. </script>

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

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

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

  298. 		<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. When importing Arduino code, the whole flow will be replaced."></textarea>

  299. 	</div>

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

  301. 		<label for="node-input-arduino" style="font-size: 13px; padding: 2px 0px 0px 4px;">

  302. 			<input style="margin-bottom: 4px; margin-right: 4px;" type="checkbox" id="node-input-arduino" checked="checked" class="input-block-level" />

  303. 				&nbsp;Import copied code from the Arduino IDE

  304. 		</label>

  305. 	</div>

  306. </script>

  307. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  330. 

  331. <!--

  332.  TODO: generate some or all of this automatically from the C++ source

  333. -->

  334. 

  335. <!--

  336.  TODO: add a field for maximum instance count

  337. -->

  338. <!--

  339.  TODO: add a field for exclusive to other objects (not allowed if they're used)

  340. -->

  341. <!--

  342.  TODO: add "parameters" fields, to replace the form html stuff

  343. -->

  344. 

  345. <script  type="text/x-red" data-container-name="NodeDefinitions">

  346. 	{"nodes":[

  347. 		{"type":"AudioInputI2S","data":{"defaults":{"name":{"value":"new"}},"shortName":"i2s","inputs":0,"outputs":2,"category":"input-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  348. 		{"type":"AudioInputI2SQuad","data":{"defaults":{"name":{"value":"new"}},"shortName":"i2s_quad","inputs":0,"outputs":4,"category":"input-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  349. 		{"type":"AudioInputAnalog","data":{"defaults":{"name":{"value":"new"}},"shortName":"adc","inputs":0,"outputs":1,"category":"input-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  350. 		{"type":"AudioInputAnalogStereo","data":{"defaults":{"name":{"value":"new"}},"shortName":"adcs","inputs":0,"outputs":2,"category":"input-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  351. 		{"type":"AudioInputI2Sslave","data":{"defaults":{"name":{"value":"new"}},"shortName":"i2sslave","inputs":0,"outputs":2,"category":"input-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  352. 		{"type":"AudioInputTDM","data":{"defaults":{"name":{"value":"new"}},"shortName":"tdm","inputs":0,"outputs":16,"category":"input-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  353. 		{"type":"AudioInputUSB","data":{"defaults":{"name":{"value":"new"}},"shortName":"usb","inputs":0,"outputs":2,"category":"input-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  354. 		{"type":"AudioOutputI2S","data":{"defaults":{"name":{"value":"new"}},"shortName":"i2s","inputs":2,"outputs":0,"category":"output-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  355. 		{"type":"AudioOutputI2SQuad","data":{"defaults":{"name":{"value":"new"}},"shortName":"i2s_quad","inputs":4,"outputs":0,"category":"output-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  356. 		{"type":"AudioOutputSPDIF","data":{"defaults":{"name":{"value":"new"}},"shortName":"spdif","inputs":2,"outputs":0,"category":"output-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  357. 		{"type":"AudioOutputPT8211","data":{"defaults":{"name":{"value":"new"}},"shortName":"pt8211","inputs":2,"outputs":0,"category":"output-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  358. 		{"type":"AudioOutputAnalog","data":{"defaults":{"name":{"value":"new"}},"shortName":"dac","inputs":1,"outputs":0,"category":"output-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  359. 		{"type":"AudioOutputAnalogStereo","data":{"defaults":{"name":{"value":"new"}},"shortName":"dacs","inputs":2,"outputs":0,"category":"output-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  360. 		{"type":"AudioOutputPWM","data":{"defaults":{"name":{"value":"new"}},"shortName":"pwm","inputs":1,"outputs":0,"category":"output-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  361. 		{"type":"AudioOutputI2Sslave","data":{"defaults":{"name":{"value":"new"}},"shortName":"i2sslave","inputs":2,"outputs":0,"category":"output-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  362. 		{"type":"AudioOutputTDM","data":{"defaults":{"name":{"value":"new"}},"shortName":"tdm","inputs":16,"outputs":0,"category":"output-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  363. 		{"type":"AudioOutputUSB","data":{"defaults":{"name":{"value":"new"}},"shortName":"usb","inputs":2,"outputs":0,"category":"output-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  364. 		{"type":"AudioMixer4","data":{"defaults":{"name":{"value":"new"}},"shortName":"mixer","inputs":4,"outputs":1,"category":"mixer-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  365. 		{"type":"AudioPlayMemory","data":{"defaults":{"name":{"value":"new"}},"shortName":"playMem","inputs":0,"outputs":1,"category":"play-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  366. 		{"type":"AudioPlaySdWav","data":{"defaults":{"name":{"value":"new"}},"shortName":"playSdWav","inputs":0,"outputs":2,"category":"play-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  367. 		{"type":"AudioPlaySdRaw","data":{"defaults":{"name":{"value":"new"}},"shortName":"playSdRaw","inputs":0,"outputs":1,"category":"play-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  368. 		{"type":"AudioPlaySerialflashRaw","data":{"defaults":{"name":{"value":"new"}},"shortName":"playFlashRaw","inputs":0,"outputs":1,"category":"play-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  369. 		{"type":"AudioPlayQueue","data":{"defaults":{"name":{"value":"new"}},"shortName":"queue","inputs":0,"outputs":1,"category":"play-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  370. 		{"type":"AudioRecordQueue","data":{"defaults":{"name":{"value":"new"}},"shortName":"queue","inputs":1,"outputs":0,"category":"record-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  371. 		{"type":"AudioSynthSimpleDrum","data":{"defaults":{"name":{"value":"new"}},"shortName":"drum","inputs":0,"outputs":1,"category":"synth-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  372. 		{"type":"AudioSynthKarplusStrong","data":{"defaults":{"name":{"value":"new"}},"shortName":"string","inputs":0,"outputs":1,"category":"synth-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  373. 		{"type":"AudioSynthWaveformSine","data":{"defaults":{"name":{"value":"new"}},"shortName":"sine","inputs":0,"outputs":1,"category":"synth-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  374. 		{"type":"AudioSynthWaveformSineHires","data":{"defaults":{"name":{"value":"new"}},"shortName":"sine_hires","inputs":0,"outputs":2,"category":"synth-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  375. 		{"type":"AudioSynthWaveformSineModulated","data":{"defaults":{"name":{"value":"new"}},"shortName":"sine_fm","inputs":1,"outputs":1,"category":"synth-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  376. 		{"type":"AudioSynthWaveform","data":{"defaults":{"name":{"value":"new"}},"shortName":"waveform","inputs":0,"outputs":1,"category":"synth-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  377. 		{"type":"AudioSynthWaveformPWM","data":{"defaults":{"name":{"value":"new"}},"shortName":"pwm","inputs":1,"outputs":1,"category":"synth-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  378. 		{"type":"AudioSynthToneSweep","data":{"defaults":{"name":{"value":"new"}},"shortName":"tonesweep","inputs":0,"outputs":1,"category":"synth-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  379. 		{"type":"AudioSynthWaveformDc","data":{"defaults":{"name":{"value":"new"}},"shortName":"dc","inputs":0,"outputs":1,"category":"synth-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  380. 		{"type":"AudioSynthNoiseWhite","data":{"defaults":{"name":{"value":"new"}},"shortName":"noise","inputs":0,"outputs":1,"category":"synth-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  381. 		{"type":"AudioSynthNoisePink","data":{"defaults":{"name":{"value":"new"}},"shortName":"pink","inputs":0,"outputs":1,"category":"synth-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  382. 		{"type":"AudioEffectFade","data":{"defaults":{"name":{"value":"new"}},"shortName":"fade","inputs":1,"outputs":1,"category":"effect-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  383. 		{"type":"AudioEffectChorus","data":{"defaults":{"name":{"value":"new"}},"shortName":"chorus","inputs":1,"outputs":1,"category":"effect-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  384. 		{"type":"AudioEffectFlange","data":{"defaults":{"name":{"value":"new"}},"shortName":"flange","inputs":1,"outputs":1,"category":"effect-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  385. 		{"type":"AudioEffectReverb","data":{"defaults":{"name":{"value":"new"}},"shortName":"reverb","inputs":1,"outputs":1,"category":"effect-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  386. 		{"type":"AudioEffectEnvelope","data":{"defaults":{"name":{"value":"new"}},"shortName":"envelope","inputs":1,"outputs":1,"category":"effect-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  387. 		{"type":"AudioEffectMultiply","data":{"defaults":{"name":{"value":"new"}},"shortName":"multiply","inputs":2,"outputs":1,"category":"effect-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  388. 		{"type":"AudioEffectDelay","data":{"defaults":{"name":{"value":"new"}},"shortName":"delay","inputs":1,"outputs":8,"category":"effect-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  389. 		{"type":"AudioEffectDelayExternal","data":{"defaults":{"name":{"value":"new"}},"shortName":"delayExt","inputs":1,"outputs":8,"category":"effect-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  390. 		{"type":"AudioEffectBitcrusher","data":{"shortName":"bitcrusher","inputs":1,"outputs":1,"category":"effect-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  391. 		{"type":"AudioEffectMidSide","data":{"shortName":"midside","inputs":2,"outputs":2,"category":"effect-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  392. 		{"type":"AudioEffectWaveshaper","data":{"shortName":"waveshape","inputs":1,"outputs":1,"category":"effect-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  393. 		{"type":"AudioFilterBiquad","data":{"defaults":{"name":{"value":"new"}},"shortName":"biquad","inputs":1,"outputs":1,"category":"filter-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  394. 		{"type":"AudioFilterFIR","data":{"defaults":{"name":{"value":"new"}},"shortName":"fir","inputs":1,"outputs":1,"category":"filter-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  395. 		{"type":"AudioFilterStateVariable","data":{"defaults":{"name":{"value":"new"}},"shortName":"filter","inputs":2,"outputs":3,"category":"filter-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  396. 		{"type":"AudioAnalyzePeak","data":{"defaults":{"name":{"value":"new"}},"shortName":"peak","inputs":1,"outputs":0,"category":"analyze-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  397. 		{"type":"AudioAnalyzeRMS","data":{"defaults":{"name":{"value":"new"}},"shortName":"rms","inputs":1,"outputs":0,"category":"analyze-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  398. 		{"type":"AudioAnalyzeFFT256","data":{"defaults":{"name":{"value":"new"}},"shortName":"fft256","inputs":1,"outputs":0,"category":"analyze-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  399. 		{"type":"AudioAnalyzeFFT1024","data":{"defaults":{"name":{"value":"new"}},"shortName":"fft1024","inputs":1,"outputs":0,"category":"analyze-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  400. 		{"type":"AudioAnalyzeToneDetect","data":{"defaults":{"name":{"value":"new"}},"shortName":"tone","inputs":1,"outputs":0,"category":"analyze-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  401. 		{"type":"AudioAnalyzeNoteFrequency","data":{"defaults":{"name":{"value":"new"}},"shortName":"notefreq","inputs":1,"outputs":0,"category":"analyze-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  402. 		{"type":"AudioAnalyzePrint","data":{"defaults":{"name":{"value":"new"}},"shortName":"print","inputs":1,"outputs":0,"category":"analyze-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  403. 		{"type":"AudioControlSGTL5000","data":{"defaults":{"name":{"value":"new"}},"shortName":"sgtl5000","inputs":0,"outputs":0,"category":"control-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  404. 		{"type":"AudioControlAK4558","data":{"defaults":{"name":{"value":"new"}},"shortName":"ak4558","inputs":0,"outputs":0,"category":"control-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  405. 		{"type":"AudioControlCS4272","data":{"defaults":{"name":{"value":"new"}},"shortName":"cs4272","inputs":0,"outputs":0,"category":"control-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  406. 		{"type":"AudioControlWM8731","data":{"defaults":{"name":{"value":"new"}},"shortName":"wm8731","inputs":0,"outputs":0,"category":"control-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  407. 		{"type":"AudioControlWM8731master","data":{"defaults":{"name":{"value":"new"}},"shortName":"wm8731m","inputs":0,"outputs":0,"category":"control-function","color":"#E6E0F8","icon":"arrow-in.png"}},

  408. 		{"type":"AudioControlCS42448","data":{"defaults":{"name":{"value":"new"}},"shortName":"cs42448","inputs":0,"outputs":0,"category":"control-function","color":"#E6E0F8","icon":"arrow-in.png"}}

  409. 	]}

  410. </script>

  411. 

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

  413. 	<h3>Summary</h3>

  414. 	<div class=tooltipinfo>

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

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

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

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

  419. 	</div>

  420. 	<h3>Audio Connections</h3>

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

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

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

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

  425. 	</table>

  426. 	<h3>Functions</h3>

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

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

  429. 	<h3>Hardware</h3>

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

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

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

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

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

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

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

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

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

  439. 	</table>

  440. 	<p>Audio from

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

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

  443. 	<h3>Examples</h3>

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

  445. 	</p>

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

  447. 	</p>

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

  449. 	</p>

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

  451. 	</p>

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

  453. 	</p>

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

  455. 	</p>

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

  457. 	</p>

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

  459. 	</p>

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

  461. 	</p>

  462. 	<h3>Notes</h3>

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

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

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

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

  467. 	</p>

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

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

  470. </script>

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

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

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

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

  475. 	</div>

  476. </script>

  477. 

  478. <script type="text/x-red" data-help-name="AudioInputI2SQuad">

  479. 	<h3>Summary</h3>

  480. 	<div class=tooltipinfo>

  481. 	<p>Receive 16 bit quad (4) channel audio from two

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

  483. 		or another I2S devices, using I2S master mode.</p>

  484. 	<p align=center><img src="img/audioshield_quad_in.jpg"></p>

  485. 	</div>

  486. 	<h3>Audio Connections</h3>

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

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

  489. 		<tr class=odd><td align=center>Out 0</td><td>Channel #1</td></tr>

  490. 		<tr class=odd><td align=center>Out 1</td><td>Channel #2</td></tr>

  491. 		<tr class=odd><td align=center>Out 2</td><td>Channel #3</td></tr>

  492. 		<tr class=odd><td align=center>Out 3</td><td>Channel #4</td></tr>

  493. 	</table>

  494. 	<h3>Functions</h3>

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

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

  497. 	<h3>Hardware</h3>

  498. 	<p>See this Sparkfun blog for <a href="https://www.sparkfun.com/news/2055" target="_blank">how

  499. 		to connect two audio adaptors for 4 channel audio</a>.

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

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

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

  503. 		<tr class=top><th>Teensy<br>3.2 Pin</th><th>Teensy<br>3.5/3.6 Pin</th><th>Signal</th><th>Direction</th></tr>

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

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

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

  507. 		<tr class=odd><td align=center>30</td><td align=center>38</td><td>RX</td><td>Input</td></tr>

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

  509. 	</table>

  510. 	<p>Audio from

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

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

  513. 	<h3>Examples</h3>

  514. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; PassThroughQuad

  515. 	</p>

  516. 	<h3>Notes</h3>

  517. 	<p>Normally, this object is used with two Audio Shield, which

  518. 		are controlled separately by a pair "sgtl5000" object.</p>

  519. </script>

  520. <script type="text/x-red" data-template-name="AudioInputI2SQuad">

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

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

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

  524. 	</div>

  525. </script>

  526. 

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

  528. 	<h3>Summary</h3>

  529. 	<div class=tooltipinfo>

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

  531. 	</div>

  532. 	<h3>Audio Connections</h3>

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

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

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

  536. 	</table>

  537. 	<h3>Functions</h3>

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

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

  540. 	<h3>Hardware</h3>

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

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

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

  544. 	<p>With a <a href="https://forum.pjrc.com/threads/40468-Help-with-Basic-Audio-Lib-results?p=126317&viewfull=1#post126317">small modification</a> Adafruit's <a href="https://www.adafruit.com/products/1063">MAX4466 microphone</a> can be used</p>

  545. 	<p align=center><a href="https://forum.pjrc.com/threads/40468-Help-with-Basic-Audio-Lib-results?p=126317&viewfull=1#post126317"><img src="img/adccircuitmic.jpg" border=0></a></p>

  546. 	<p>Control Voltage (CV) from +5V to -5V can be adapted with a

  547. 		<a href="https://www.dorkbotpdx.org/blog/paul/control_voltage_cv_to_analog_input_pin">simple circuit</a>

  548. 		or better <a href="https://forum.pjrc.com/threads/28423?p=71257&viewfull=1#post71257">opamp-based circuity</a>

  549. 		to Teensy's 0-1.2V analog input range.</p>

  550. 	<h3>Examples</h3>

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

  552. 	</p>

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

  554. 	</p>

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

  556. 	</p>

  557. 	<p class=exam>File &gt; Examples &gt; OctoWS2811 &gt; SpectrumAnalyzer

  558. 	</p>

  559. 	<h3>Notes</h3>

  560. 	<p><b>analogRead() must not be used</b>, because AudioInputAnalog is regularly

  561. 		accessing the ADC hardware.  If both access the hardware at the same

  562. 		moment, analogRead() can end up waiting forever, which effectively

  563. 		crashes your program.

  564. 	</p>

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

  566. 		to the AudioInputAnalog object definition.

  567. 	</p>

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

  569. 	</p>

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

  571. 	</p>

  572. 

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

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

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

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

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

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

  579. </script>

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

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

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

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

  584. 	</div>

  585. </script>

  586. 

  587. <script type="text/x-red" data-help-name="AudioInputAnalogStereo">

  588. 	<h3>Summary</h3>

  589. 	<div class=tooltipinfo>

  590. 	<p>Receive stereo audio using the built-in analog to digital converters.</p>

  591. 	</div>

  592. 	<h3>Audio Connections</h3>

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

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

  595. 		<tr class=odd><td align=center>Out 0</td><td>Audio Channel (Left)</td></tr>

  596. 		<tr class=odd><td align=center>Out 1</td><td>Audio Channel (Right)</td></tr>

  597. 	</table>

  598. 	<h3>Functions</h3>

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

  600. 		simply streams data from both ADCs to its output ports.</p>

  601. 	<h3>Hardware</h3>

  602. 	<p>By default, pins A2 & A3 are used for audio input.  This circuitry is recommended.</p>

  603. 	<p align=center><img src="img/adccircuit2.png"></p>

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

  605. 	<p>Control Voltage (CV) from +5V to -5V can be adapted with a

  606. 		<a href="https://www.dorkbotpdx.org/blog/paul/control_voltage_cv_to_analog_input_pin">simple circuit</a>

  607. 		or better <a href="https://forum.pjrc.com/threads/28423?p=71257&viewfull=1#post71257">opamp-based circuity</a>

  608. 		to Teensy's 0-1.2V analog input range.</p>

  609. 	<h3>Examples</h3>

  610. 	<!--

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

  612. 	</p>

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

  614. 	</p>

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

  616. 	</p>

  617. 	<p class=exam>File &gt; Examples &gt; OctoWS2811 &gt; SpectrumAnalyzer

  618. 	</p>

  619. 	-->

  620. 	<h3>Notes</h3>

  621. 	<p><b>analogRead() must not be used</b>, because AudioInputAnalogStereo is regularly

  622. 		accessing the ADC hardware.  If both access the hardware at the same

  623. 		moment, analogRead() can end up waiting forever, which effectively

  624. 		crashes your program.

  625. 	</p>

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

  627. 		to the AudioInputAnalog object definition.

  628. 	</p>

  629. 	<p>For example:

  630. 	</p>

  631. 	<p class=desc><span class=keyword>AudioInputAnalogStereo</span>  adc1(<span class=literal>A3</span>, <span class=literal>A2</span>);

  632. 	</p>

  633. 	<p>TODO: add info here about which pins work for input 0 and 1.

  634. 	</p>

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

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

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

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

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

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

  641. </script>

  642. <script type="text/x-red" data-template-name="AudioInputAnalogStereo">

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

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

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

  646. 	</div>

  647. </script>

  648. 

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

  650. 	<h3>Summary</h3>

  651. 	<div class=tooltipinfo>

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

  653. 		(where the ADC or codec chip, not Teensy, controls audio timing).</p>

  654. 	</div>

  655. 	<h3>Audio Connections</h3>

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

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

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

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

  660. 	</table>

  661. 	<h3>Functions</h3>

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

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

  664. 	<h3>Hardware</h3>

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

  666. 		data timing.</p>

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

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

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

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

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

  672. 	</table>

  673. 	<!--

  674. <h3>Examples</h3>

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

  676. 	</p>

  677. -->

  678. 	<h3>Notes</h3>

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

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

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

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

  683. 		timing.</p>

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

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

  686. 	</p>

  687. </script>

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

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

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

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

  692. 	</div>

  693. </script>

  694. 

  695. <script type="text/x-red" data-help-name="AudioInputTDM">

  696. 	<h3>Summary</h3>

  697. 	<div class=tooltipinfo>

  698. 	<p>Receive a 256 bit Time Division Multiplexed frame containing

  699. 		many audio channels.</p>

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

  701. 	</div>

  702. 	<h3>Audio Connections</h3>

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

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

  705. 		<tr class=odd><td align=center>Out 0</td><td>Bits 0 to 15</td></tr>

  706. 		<tr class=odd><td align=center>Out 1</td><td>Bits 16 to 31</td></tr>

  707. 		<tr class=odd><td align=center>Out 2</td><td>Bits 32 to 47</td></tr>

  708. 		<tr class=odd><td align=center>Out 3</td><td>Bits 48 to 63</td></tr>

  709. 		<tr class=odd><td align=center>Out 4</td><td>Bits 64 to 79</td></tr>

  710. 		<tr class=odd><td align=center>Out 5</td><td>Bits 80 to 95</td></tr>

  711. 		<tr class=odd><td align=center>Out 6</td><td>Bits 96 to 111</td></tr>

  712. 		<tr class=odd><td align=center>Out 7</td><td>Bits 112 to 127</td></tr>

  713. 		<tr class=odd><td align=center>Out 8</td><td>Bits 128 to 143</td></tr>

  714. 		<tr class=odd><td align=center>Out 9</td><td>Bits 144 to 159</td></tr>

  715. 		<tr class=odd><td align=center>Out 10</td><td>Bits 160 to 175</td></tr>

  716. 		<tr class=odd><td align=center>Out 11</td><td>Bits 176 to 191</td></tr>

  717. 		<tr class=odd><td align=center>Out 12</td><td>Bits 192 to 207</td></tr>

  718. 		<tr class=odd><td align=center>Out 13</td><td>Bits 208 to 223</td></tr>

  719. 		<tr class=odd><td align=center>Out 14</td><td>Bits 224 to 239</td></tr>

  720. 		<tr class=odd><td align=center>Out 15</td><td>Bits 240 to 255</td></tr>

  721. 	</table>

  722. 	<h3>Functions</h3>

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

  724. 		simply streams data from the TDM hardware to its 16 output ports.</p>

  725. 	<h3>Hardware</h3>

  726. 	<p>TDM has been tested with this <a href="https://oshpark.com/shared_projects/2Yj6rFaW">

  727. 		CS42448 Circuit Board</a>.  It may also work with

  728. 		<a href="https://forum.pjrc.com/threads/42894">Invensense ICS-52000 microphones</a>.

  729. 		</p>

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

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

  732. 		<tr class=odd><td align=center>9</td><td>BCLK</td><td>Output, 11.3 MHz</td></tr>

  733. 		<tr class=odd><td align=center>11</td><td>MCLK</td><td>Output, 22.6 MHz</td></tr>

  734. 		<tr class=odd><td align=center>13</td><td>RX</td><td>Input, 11.3 Mbit/sec</td></tr>

  735. 		<tr class=odd><td align=center>23</td><td>FS</td><td>Output</td></tr>

  736. 	</table>

  737. 	<p>Audio from

  738. 		master mode TDM may be used in the same project as ADC, DAC and

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

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

  741. 	<h3>Notes</h3>

  742. 	<p>Only one TDM input and one TDM output object may be used.  The

  743. 		I2S hardware is used by TDM, so TDM objects may not be used

  744. 		together with I2S, SPDIF or PT8211.</p>

  745. 	<p>When used with TDM devices which transmit 32 bit audio, the

  746. 		even numbered channels will contain the useful upper 16

  747. 		bits of audio data.</p>

  748. 	<p>AudioMemory should be at least 16.  Even if most channels are

  749. 		unused, this TDM object will need to allocate 16 blocks of

  750. 		memory.</p>

  751. </script>

  752. <script type="text/x-red" data-template-name="AudioInputTDM">

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

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

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

  756. 	</div>

  757. </script>

  758. 

  759. <script type="text/x-red" data-help-name="AudioInputUSB">

  760. 	<h3>Summary</h3>

  761. 	<div class=tooltipinfo>

  762. 	<p>Receive stereo audio from a PC or Mac.  Teensy appears as a USB

  763. 		sound device.</p>

  764. 	<p align=center><img src="img/usbtype_audio_in.png"></p>

  765. 	</div>

  766. 	<h3>Audio Connections</h3>

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

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

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

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

  771. 	</table>

  772. 	<h3>Functions</h3>

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

  774. 		simply streams data from the USB to its 2 output ports.</p>

  775. 	<!--

  776. 	<h3>Hardware</h3>

  777. 	-->

  778. 	<h3>Examples</h3>

  779. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; PassThroughUSB</p>

  780. 	</p>

  781. 	<h3>Notes</h3>

  782. 	<p>Arduino's <b>Tools &gt; USB Type</b> menu must be set to <b>Audio</b>.

  783. 		</p>

  784. 	<p align=center><img src="img/usbtype_audio.png"></p>

  785. 	<p>USB input &amp; output does not cause the Teensy Audio Library to

  786. 		update.  At least one non-USB input or output object must be

  787. 		present for the entire library to update properly.</p>

  788. 	<p>A known problem exists with USB audio from Macintosh computers.

  789. 		An imperfect <a href="https://forum.pjrc.com/threads/34855-Distorted-audio-when-using-USB-input-on-Teensy-3-1?p=110392&viewfull=1#post110392">workaround

  790. 		can be enabled by editing usb_audio.cpp</a>.

  791. 		Find and uncomment "#define MACOSX_ADAPTIVE_LIMIT".</p>

  792. </script>

  793. <script type="text/x-red" data-template-name="AudioInputUSB">

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

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

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

  797. 	</div>

  798. </script>

  799. 

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

  801. 	<h3>Summary</h3>

  802. 	<div class=tooltipinfo>

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

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

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

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

  807. 	</div>

  808. 	<h3>Audio Connections</h3>

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

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

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

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

  813. 	</table>

  814. 	<h3>Functions</h3>

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

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

  817. 	<h3>Hardware</h3>

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

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

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

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

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

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

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

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

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

  827. 	</table>

  828. 	<p>Audio from

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

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

  831. 	<h3>Examples</h3>

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

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

  834. 	</p>

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

  836. 	</p>

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

  838. 	</p>

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

  840. 	</p>

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

  842. 	</p>

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

  844. 	</p>

  845. 	<h3>Notes</h3>

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

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

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

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

  850. 	</p>

  851. </script>

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

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

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

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

  856. 	</div>

  857. </script>

  858. 

  859. <script type="text/x-red" data-help-name="AudioOutputI2SQuad">

  860. 	<h3>Summary</h3>

  861. 	<div class=tooltipinfo>

  862. 	<p>Transmit quad (4) channel 16 bit audio, using I2S master mode.</p>

  863. 	<p align=center><img src="img/audioshield_quad_out.jpg"></p>

  864. 	</div>

  865. 	<h3>Audio Connections</h3>

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

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

  868. 		<tr class=odd><td align=center>In 0</td><td>Channel #1</td></tr>

  869. 		<tr class=odd><td align=center>In 1</td><td>Channel #2</td></tr>

  870. 		<tr class=odd><td align=center>In 2</td><td>Channel #3</td></tr>

  871. 		<tr class=odd><td align=center>In 3</td><td>Channel #4</td></tr>

  872. 	</table>

  873. 	<h3>Functions</h3>

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

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

  876. 	<h3>Hardware</h3>

  877. 	<p>See this Sparkfun blog for <a href="https://www.sparkfun.com/news/2055" target="_blank">how

  878. 		to connect two audio adaptors for 4 channel audio</a>.  More

  879. 		<a href="https://forum.pjrc.com/threads/29373-Bit-bang-multiple-I2S-inputs-simultaneously?p=79606#post79606" target="_blank">details</a> are also available.

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

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

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

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

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

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

  886. 		<tr class=odd><td align=center>22</td><td>TX (ch 1+2)</td><td>Output</td></tr>

  887. 		<tr class=odd><td align=center>15</td><td>TX (ch 3+4)</td><td>Output</td></tr>

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

  889. 	</table>

  890. 	<p>Audio from

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

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

  893. 	<h3>Examples</h3>

  894. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; PassThroughQuad

  895. 	</p>

  896. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; SGTL5000 &gt; QuadChannelOutput

  897. 	</p>

  898. 	<h3>Notes</h3>

  899. 	<p>Normally, this object is used with two Audio Shields, which

  900. 		are controlled separately by a pair of "sgtl5000" objects.</p>

  901. </script>

  902. <script type="text/x-red" data-template-name="AudioOutputI2SQuad">

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

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

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

  906. 	</div>

  907. </script>

  908. 

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

  910. 	<h3>Summary</h3>

  911. 	<div class=tooltipinfo>

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

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

  914. 	</div>

  915. 	<h3>Audio Connections</h3>

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

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

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

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

  920. 	</table>

  921. 	<h3>Functions</h3>

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

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

  924. 		audio on pin 22.</p>

  925. 	<h3>Hardware</h3>

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

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

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

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

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

  931. 	</table>

  932. 	<p>For optical TOSLINK output, this

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

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

  935. 		at Digikey, 1080-1434-ND.

  936. 		</p>

  937. 	<h3>Examples</h3>

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

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

  940. 		output objects for different hardware types.

  941. 	</p>

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

  943. 	</p>

  944. 	<h3>Credits</h3>

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

  946. 		developed the AudioOutputSPDIF code.  The original

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

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

  949. 	<h3>Notes</h3>

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

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

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

  953. 	</p>

  954. </script>

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

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

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

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

  959. 	</div>

  960. </script>

  961. 

  962. <script type="text/x-red" data-help-name="AudioOutputPT8211">

  963. 	<h3>Summary</h3>

  964. 	<div class=tooltipinfo>

  965. 	<p>Transmit 16 bit stereo audio to a low-cost PT8211 DAC chip.  4X oversampling

  966. 		and filtering are automatically used to improve output quality.</p>

  967. 	<p align=center><img src="img/pt8211.jpg"></p>

  968. 	</div>

  969. 	<h3>Audio Connections</h3>

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

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

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

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

  974. 	</table>

  975. 	<h3>Functions</h3>

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

  977. 		simply streams data from its 2 input ports to a PT8211 chip.  4X

  978. 		oversampling and filtering is automatically used to improve quality.</p>

  979. 	<h3>Hardware</h3>

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

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

  982. 		<tr class=odd><td align=center>9</td><td>BCK</td><td>Output</td></tr>

  983. 		<tr class=odd><td align=center>22</td><td>DIN</td><td>Output</td></tr>

  984. 		<tr class=odd><td align=center>23</td><td>FS</td><td>Output</td></tr>

  985. 	</table>

  986. 	<p>More information can be found in the PT8211 datasheet.

  987. 		</p>

  988. 	<h3>Examples</h3>

  989. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; PT8211Sine

  990. 	</p>

  991. 	<h3>Credits</h3>

  992. 	<p>Frank Boesing and Benjamin developed this PT8211 object.  Details can be

  993. 		found on this

  994. 		<a href="https://forum.pjrc.com/threads/29284-Dual-channel-16bit-dac-PT8211/page3" target="_blank">forum disussion</a>.

  995. 	<h3>Notes</h3>

  996. 	<p>

  997. 	</p>

  998. </script>

  999. <script type="text/x-red" data-template-name="AudioOutputPT8211">

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

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

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

  1003. 	</div>

  1004. </script>

  1005. 

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

  1007. 	<h3>Summary</h3>

  1008. 	<div class=tooltipinfo>

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

  1010. 	<p align=center><img src="img/dac_speaker.jpg"><br>

  1011. 	<small><a href="http://www.pjrc.com/store/prop_shield.html" target="_blank_">Prop Shield with 4&ohm; Speaker</a></small></p>

  1012. 	</div>

  1013. 	<h3>Audio Connections</h3>

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

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

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

  1017. 	</table>

  1018. 	<h3>Functions</h3>

  1019. 	<p class=func><span class=keyword>analogReference</span>(ref);</p>

  1020. 	<p class=desc>Configure output voltage range:<br>

  1021. 	<span class=literal>INTERNAL</span> selects 1.2 volt peak-to-peak output.<br>

  1022. 	<span class=literal>EXTERNAL</span> selects 3.3 volt peak-to-peak output.

  1023. 	</p>

  1024. 	<h3>Hardware</h3>

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

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

  1027. 	<p>The output voltage has DC level.  Some applications require a DC-blocking capacitor.  If unsure, a 10&micro;F is usually a safe value to use.  If an aluminum or tantalum capacitor is used, the positive terminal should connect to Teensy's DAC pin.</p>

  1028. 	<p>The DAC pin is used with the

  1029. 	<a href="http://www.pjrc.com/store/prop_shield.html" target="_blank_">Prop Shield</a>

  1030. 	to drive speakers.</p>

  1031. 	<h3>Examples</h3>

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

  1033. 	</p>

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

  1035. 	</p>

  1036. 	<p class=exam><a href="https://github.com/PaulStoffregen/TouchGuitar" target="_blank">TouchGuitar</a>

  1037. 	</p>

  1038. 	<p class=exam><a href="https://community.arm.com/groups/embedded/blog/2014/05/23/led-video-panel-at-maker-faire-2014" target="_blank">LED Video Board</a>

  1039. 	</p>

  1040. 	<p class=exam>File &gt; Examples &gt; OctoWS2811 &gt; VideoSDcard

  1041. 	</p>

  1042. 	<p class=exam>File &gt; Examples &gt; SerialFlash &gt; MP3Player

  1043. 	</p>

  1044. 	<h3>Notes</h3>

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

  1046. 		not filtered.  This may not

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

  1048. 		to high power tweeters.</p>

  1049. 	<p>When using 3.3V output, the power supply is used for the analog reference.  Noise

  1050. 		present on the 3.3V power can couple to the DAC output signal.

  1051. 	</p>

  1052. </script>

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

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

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

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

  1057. 	</div>

  1058. </script>

  1059. 

  1060. <script type="text/x-red" data-help-name="AudioOutputAnalogStereo">

  1061. 	<h3>Summary</h3>

  1062. 	<div class=tooltipinfo>

  1063. 	<p>Transmit 12 bit stereo audio using Teensy 3.5 or 3.6 built-in digital to analog converters.</p>

  1064. 	<!--<p align=center><img src="img/dac_speaker.jpg"><br>

  1065. 	<small><a href="http://www.pjrc.com/store/prop_shield.html" target="_blank_">Prop Shield with 4&ohm; Speaker</a></small></p>-->

  1066. 	</div>

  1067. 	<h3>Audio Connections</h3>

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

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

  1070. 		<tr class=odd><td align=center>In 0</td><td>Audio Channel (Left)</td></tr>

  1071. 		<tr class=odd><td align=center>In 1</td><td>Audio Channel (Right)</td></tr>

  1072. 	</table>

  1073. 	<h3>Functions</h3>

  1074. 	<p class=func><span class=keyword>analogReference</span>(ref);</p>

  1075. 	<p class=desc>Configure output voltage range:<br>

  1076. 	<span class=literal>INTERNAL</span> selects 1.2 volt peak-to-peak output.<br>

  1077. 	<span class=literal>EXTERNAL</span> selects 3.3 volt peak-to-peak output.

  1078. 	</p>

  1079. 	<h3>Hardware</h3>

  1080. 	<p align=center><img src="img/dacpins.png"></p>

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

  1082. 	<p>The output voltage has DC level.  Some applications require a DC-blocking capacitor.  If unsure, a 10&micro;F is usually a safe value to use.  If an aluminum or tantalum capacitor is used, the positive terminal should connect to Teensy's DAC pin.</p>

  1083. 	<p>The DAC pin is used with the

  1084. 	<a href="http://www.pjrc.com/store/prop_shield.html" target="_blank_">Prop Shield</a>

  1085. 	to drive speakers.</p>

  1086. 	<h3>Examples</h3>

  1087. 	<!--<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; PassThroughMono

  1088. 	</p>

  1089. 	<p class=exam>File &gt; Examples &gt; SerialFlash &gt; MP3Player

  1090. 	</p>-->

  1091. 	<h3>Notes</h3>

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

  1093. 		not filtered.  This may not

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

  1095. 		to high power tweeters.</p>

  1096. 	<p>When using 3.3V output, the power supply is used for the analog reference.  Noise

  1097. 		present on the 3.3V power can couple to the DAC output signal.

  1098. 	</p>

  1099. </script>

  1100. <script type="text/x-red" data-template-name="AudioOutputAnalogStereo">

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

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

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

  1104. 	</div>

  1105. </script>

  1106. 

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

  1108. 	<h3>Summary</h3>

  1109. 	<div class=tooltipinfo>

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

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

  1112. 		resistors.</p>

  1113. 	</div>

  1114. 	<h3>Audio Connections</h3>

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

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

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

  1118. 	</table>

  1119. 	<h3>Functions</h3>

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

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

  1122. 	<h3>Hardware</h3>

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

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

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

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

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

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

  1129. 		475 ohm resistor.</p>

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

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

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

  1133. 	<h3>Examples</h3>

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

  1135. 	</p>

  1136. 	<h3>Notes</h3>

  1137. 	<p>This object only works properly when Tools &gt; CPU_Speed is set to

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

  1139. 		in strange ways.</p>

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

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

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

  1143. 		</p>

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

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

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

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

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

  1149. </script>

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

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

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

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

  1154. 	</div>

  1155. </script>

  1156. 

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

  1158. 	<h3>Summary</h3>

  1159. 	<div class=tooltipinfo>

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

  1161. 		(where the DAC or codec chip, not Teensy, controls audio timing).</p>

  1162. 	</div>

  1163. 	<h3>Audio Connections</h3>

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

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

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

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

  1168. 	</table>

  1169. 	<h3>Functions</h3>

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

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

  1172. 	<h3>Hardware</h3>

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

  1174. 		data timing.</p>

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

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

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

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

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

  1180. 	</table>

  1181. 	<h3>Examples</h3>

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

  1183. 	</p>

  1184. 	<h3>Notes</h3>

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

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

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

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

  1189. 		timing.</p>

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

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

  1192. 	</p>

  1193. </script>

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

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

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

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

  1198. 	</div>

  1199. </script>

  1200. 

  1201. <script type="text/x-red" data-help-name="AudioOutputTDM">

  1202. 	<h3>Summary</h3>

  1203. 	<div class=tooltipinfo>

  1204. 	<p>Transmit a 256 bit Time Division Multiplexed frame containing

  1205. 		many audio channels.</p>

  1206. 	<p align=center><img src="img/tdm.jpg"></p>

  1207. 	</div>

  1208. 	<h3>Audio Connections</h3>

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

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

  1211. 		<tr class=odd><td align=center>In 0</td><td>Bits 0 to 15</td></tr>

  1212. 		<tr class=odd><td align=center>In 1</td><td>Bits 16 to 31</td></tr>

  1213. 		<tr class=odd><td align=center>In 2</td><td>Bits 32 to 47</td></tr>

  1214. 		<tr class=odd><td align=center>In 3</td><td>Bits 48 to 63</td></tr>

  1215. 		<tr class=odd><td align=center>In 4</td><td>Bits 64 to 79</td></tr>

  1216. 		<tr class=odd><td align=center>In 5</td><td>Bits 80 to 95</td></tr>

  1217. 		<tr class=odd><td align=center>In 6</td><td>Bits 96 to 111</td></tr>

  1218. 		<tr class=odd><td align=center>In 7</td><td>Bits 112 to 127</td></tr>

  1219. 		<tr class=odd><td align=center>In 8</td><td>Bits 128 to 143</td></tr>

  1220. 		<tr class=odd><td align=center>In 9</td><td>Bits 144 to 159</td></tr>

  1221. 		<tr class=odd><td align=center>In 10</td><td>Bits 160 to 175</td></tr>

  1222. 		<tr class=odd><td align=center>In 11</td><td>Bits 176 to 191</td></tr>

  1223. 		<tr class=odd><td align=center>In 12</td><td>Bits 192 to 207</td></tr>

  1224. 		<tr class=odd><td align=center>In 13</td><td>Bits 208 to 223</td></tr>

  1225. 		<tr class=odd><td align=center>In 14</td><td>Bits 224 to 239</td></tr>

  1226. 		<tr class=odd><td align=center>In 15</td><td>Bits 240 to 255</td></tr>

  1227. 	</table>

  1228. 	<h3>Functions</h3>

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

  1230. 		simply streams data from its 16 input ports to the TDM hardware.</p>

  1231. 	<h3>Hardware</h3>

  1232. 	<p>TDM has been tested with this <a href="https://oshpark.com/shared_projects/2Yj6rFaW">

  1233. 		CS42448 Circuit Board</a>.

  1234. 		</p>

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

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

  1237. 		<tr class=odd><td align=center>9</td><td>BCLK</td><td>Output, 11.3 MHz</td></tr>

  1238. 		<tr class=odd><td align=center>11</td><td>MCLK</td><td>Output, 22.6 MHz</td></tr>

  1239. 		<tr class=odd><td align=center>22</td><td>TX</td><td>Input, 11.3 Mbit/sec</td></tr>

  1240. 		<tr class=odd><td align=center>23</td><td>WS</td><td>Output</td></tr>

  1241. 	</table>

  1242. 	<p>Audio from

  1243. 		master mode TDM may be used in the same project as ADC, DAC and

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

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

  1246. 	<h3>Notes</h3>

  1247. 	<p>Only one TDM input and one TDM output object may be used.  The

  1248. 		I2S hardware is used by TDM, so TDM objects may not be used

  1249. 		together with I2S, SPDIF or PT8211.</p>

  1250. 	<p>When used with TDM devices which receive 32 bit audio, the

  1251. 		even numbered channels are used for the top 16 bits.</p>

  1252. </script>

  1253. <script type="text/x-red" data-template-name="AudioOutputTDM">

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

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

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

  1257. 	</div>

  1258. </script>

  1259. 

  1260. <script type="text/x-red" data-help-name="AudioOutputUSB">

  1261. 	<h3>Summary</h3>

  1262. 	<div class=tooltipinfo>

  1263. 	<p>Send stereo audio to a PC or Mac.  Teensy appears as a USB

  1264. 		sound device.</p>

  1265. 	<p align=center><img src="img/usbtype_audio_out.png"></p>

  1266. 	</div>

  1267. 	<h3>Audio Connections</h3>

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

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

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

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

  1272. 	</table>

  1273. 	<h3>Functions</h3>

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

  1275. 		simply streams from it's 2 input ports to the USB.</p>

  1276. 	<!--

  1277. 	<h3>Hardware</h3>

  1278. 	-->

  1279. 	<h3>Examples</h3>

  1280. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; WavFilePlayerUSB</p>

  1281. 	</p>

  1282. 	<h3>Notes</h3>

  1283. 	<p>Arduino's <b>Tools &gt; USB Type</b> menu must be set to <b>Audio</b>.

  1284. 		</p>

  1285. 	<p align=center><img src="img/usbtype_audio.png"></p>

  1286. 	<p>USB input &amp; output does not cause the Teensy Audio Library to

  1287. 		update.  At least one non-USB input or output object must be

  1288. 		present for the entire library to update properly.</p>

  1289. 	<p>A known problem exists with USB audio from Macintosh computers.

  1290. 		An imperfect <a href="https://forum.pjrc.com/threads/34855-Distorted-audio-when-using-USB-input-on-Teensy-3-1?p=110392&viewfull=1#post110392">workaround

  1291. 		can be enabled by editing usb_audio.cpp</a>.

  1292. 		Find and uncomment "#define MACOSX_ADAPTIVE_LIMIT".</p>

  1293. </script>

  1294. <script type="text/x-red" data-template-name="AudioOutputUSB">

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

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

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

  1298. 	</div>

  1299. </script>

  1300. 

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

  1302. 	<h3>Summary</h3>

  1303. 	<div class=tooltipinfo>

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

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

  1306. 	</div>

  1307. 	<h3>Audio Connections</h3>

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

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

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

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

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

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

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

  1315. 	</table>

  1316. 	<h3>Functions</h3>

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

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

  1319. 		be 0 to 3.  "level" may be any floating point number from 0 to 32767.0.

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

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

  1322. 		1.0 amplifies it.  Negative numbers may also be used, to invert the

  1323. 		signal.  All 4 channels have separate gain settings.

  1324. 	</p>

  1325. 	<h3>Examples</h3>

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

  1327. 	</p>

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

  1329. 	</p>

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

  1331. 	</p>

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

  1333. 	</p>

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

  1335. 	</p>

  1336. 	<h3>Notes</h3>

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

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

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

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

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

  1342. 	</p>

  1343. </script>

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

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

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

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

  1348. 	</div>

  1349. </script>

  1350. 

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

  1352. 	<h3>Summary</h3>

  1353. 	<div class=tooltipinfo>

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

  1355. 		Data files are created with the

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

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

  1358. 	</div>

  1359. 	<h3>Audio Connections</h3>

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

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

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

  1363. 	</table>

  1364. 	<h3>Functions</h3>

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

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

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

  1368. 		playing from the beginning.

  1369. 	</p>

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

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

  1372. 	</p>

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

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

  1375. 		when not playing.

  1376. 	</p>

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

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

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

  1380. 		is undefined.

  1381. 	</p>

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

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

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

  1385. 		is undefined.

  1386. 	</p>

  1387. 	<h3>Examples</h3>

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

  1389. 	</p>

  1390. 	<h3>Notes</h3>

  1391. 	<p><a href="https://forum.pjrc.com/threads/42401-Instructions-or-tutorials-for-using-wav2sketch?p=135069&viewfull=1#post135069">Step by step instructions for wav2sketch</a>

  1392. 		running in Terminal on Macintosh.</p>

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

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

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

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

  1397. </script>

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

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

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

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

  1402. 	</div>

  1403. </script>

  1404. 

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

  1406. 	<h3>Summary</h3>

  1407. 	<div class=tooltipinfo>

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

  1409. 	</div>

  1410. 	<h3>Audio Connections</h3>

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

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

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

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

  1415. 	</table>

  1416. 	<h3>Functions</h3>

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

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

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

  1420. 	</p>

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

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

  1423. 	</p>

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

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

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

  1427. 	</p>

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

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

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

  1431. 		is undefined.

  1432. 	</p>

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

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

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

  1436. 		is undefined.

  1437. 	</p>

  1438. 	<h3>Examples</h3>

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

  1440. 	</p>

  1441. 	<h3>Notes</h3>

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

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

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

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

  1446. 	</p>

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

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

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

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

  1451. 		playing can begin.

  1452. 	</p>

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

  1454. 		If card access is required, you must

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

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

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

  1458. 		dropouts or glitches.

  1459. 	</p>

  1460. 	<p>An experimental SD library optimization exists, which can remove these

  1461. 		SD library restrictions.  It also allows reliable playback of more

  1462. 		files at the same time.  To enable this special code, find and edit

  1463. 		the SD_t3.h file within your Arduino folder.  See the comments within

  1464. 		that file for details.

  1465. 	</p>

  1466. 

  1467. </script>

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

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

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

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

  1472. 	</div>

  1473. </script>

  1474. 

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

  1476. 	<h3>Summary</h3>

  1477. 	<div class=tooltipinfo>

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

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

  1480. 		header info.</p>

  1481. 	</div>

  1482. 	<h3>Audio Connections</h3>

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

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

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

  1486. 	</table>

  1487. 	<h3>Functions</h3>

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

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

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

  1491. 	</p>

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

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

  1494. 	</p>

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

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

  1497. 		when not playing.

  1498. 	</p>

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

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

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

  1502. 		is undefined.

  1503. 	</p>

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

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

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

  1507. 		is undefined.

  1508. 	</p>

  1509. 	<h3>Examples</h3>

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

  1511. 	</p>

  1512. 	<h3>Notes</h3>

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

  1514. 	</p>

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

  1516. 		If card access is required, you must

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

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

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

  1520. 		dropouts or glitches.

  1521. 	</p>

  1522. </script>

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

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

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

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

  1527. 	</div>

  1528. </script>

  1529. 

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

  1531. 	<h3>Summary</h3>

  1532. 	<div class=tooltipinfo>

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

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

  1535. 		played simultaneously by copies of this object.

  1536. 		</p>

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

  1538. 	</div>

  1539. 	<h3>Audio Connections</h3>

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

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

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

  1543. 	</table>

  1544. 	<h3>Functions</h3>

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

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

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

  1548. 	</p>

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

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

  1551. 	</p>

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

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

  1554. 		when not playing.

  1555. 	</p>

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

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

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

  1559. 		is undefined.

  1560. 	</p>

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

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

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

  1564. 		is undefined.

  1565. 	</p>

  1566. 	<h3>Examples</h3>

  1567. 	<!--

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

  1569. -->

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

  1571. 	</p>

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

  1573. 	</p>

  1574. 	<h3>Notes</h3>

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

  1576. 	</p>

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

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

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

  1580. 	</p>

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

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

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

  1584. </script>

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

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

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

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

  1589. 	</div>

  1590. </script>

  1591. 

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

  1593. 	<h3>Summary</h3>

  1594. 	<div class=tooltipinfo>

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

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

  1597. 	</div>

  1598. 	<h3>Audio Connections</h3>

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

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

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

  1602. 	</table>

  1603. 	<h3>Functions</h3>

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

  1605. 	<p class=desc>not yet implemented

  1606. 	</p>

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

  1608. 	<p class=desc>not yet implemented

  1609. 	</p>

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

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

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

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

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

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

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

  1617. 		available.

  1618. 	</p>

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

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

  1621. 	</p>

  1622. 	<h3>Examples</h3>

  1623. 		<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>

  1624. 		</p>

  1625. 	<!--

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

  1627. 	</p>

  1628. -->

  1629. 	<h3>Notes</h3>

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

  1631. 	<p>

  1632. 	</p>

  1633. </script>

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

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

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

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

  1638. 	</div>

  1639. </script>

  1640. 

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

  1642. 	<h3>Summary</h3>

  1643. 	<div class=tooltipinfo>

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

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

  1646. 	</div>

  1647. 	<h3>Audio Connections</h3>

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

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

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

  1651. 	</table>

  1652. 	<h3>Functions</h3>

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

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

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

  1656. 		to prevent the queue from filling up.

  1657. 	</p>

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

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

  1660. 	</p>

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

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

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

  1664. 		are available.

  1665. 	</p>

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

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

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

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

  1670. 		the audio library.

  1671. 	</p>

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

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

  1674. 	</p>

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

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

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

  1678. 	</p>

  1679. 	<h3>Examples</h3>

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

  1681. 	</p>

  1682. 	<h3>Notes</h3>

  1683. 	<p>

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

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

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

  1687. 

  1688. The actual packets are taken

  1689. 		from the pool created by AudioMemory().

  1690. 	</p>

  1691. </script>

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

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

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

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

  1696. 	</div>

  1697. </script>

  1698. 

  1699. <script type="text/x-red" data-help-name="AudioSynthSimpleDrum">

  1700. 	<h3>Summary</h3>

  1701. 	<div class=tooltipinfo>

  1702. 	<p>Generate a synthesised drum sound.  Also useful for laser pistol and bursting

  1703. 		bubble sound effects.</p>

  1704. 	</div>

  1705. 	<h3>Audio Connections</h3>

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

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

  1708. 		<tr class=odd><td align=center>Out 0</td><td>Drum Tone Output</td></tr>

  1709. 	</table>

  1710. 	<h3>Functions</h3>

  1711. 	<p class=func><span class=keyword>noteOn</span>();</p>

  1712. 	<p class=desc>Trigger the drum.

  1713. 	</p>

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

  1715. 	<p class=desc>Set the base frequency of the drum.

  1716. 	</p>

  1717. 	<p class=func><span class=keyword>length</span>(milliseconds);</p>

  1718. 	<p class=desc>Set the duration of the envelope, in milliseconds.

  1719. 	</p>

  1720. 	<p class=func><span class=keyword>secondMix</span>(level);</p>

  1721. 	<p class=desc>Emulates a two-headed tom, by adding a second sine wave that is

  1722. 	harmonized a perfect fifth above

  1723. 	the base frequency.  Using this involves a slight CPU penalty.

  1724. 	</p>

  1725. 	<p class=func><span class=keyword>pitchMod</span>(depth);</p>

  1726. 	<p class=desc>Set the depth of envelope of the pitch, by a maximum of two octaves.

  1727. 	Default is 0.5, with no modulation.  Values above 0.5 cause the pitch to sweep

  1728. 	downwards, values lower than 0.5 cause the pitch to sweep upwards.

  1729. 	</p>

  1730. 	<h3>Examples</h3>

  1731. 	<p class=exam>File &gt; Examples &gt; Synthesis &gt; SimpleDrum

  1732. 	</p>

  1733. 	<h3>Notes</h3>

  1734. 	<p></p>

  1735. </script>

  1736. <script type="text/x-red" data-template-name="AudioSynthSimpleDrum">

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

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

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

  1740. 	</div>

  1741. </script>

  1742. 

  1743. <script type="text/x-red" data-help-name="AudioSynthKarplusStrong">

  1744. 	<h3>Summary</h3>

  1745. 	<div class=tooltipinfo>

  1746. 	<p>Synthesize a plucked string sound, such as a guitar string.

  1747. 		</p>

  1748. 	<p align=center><img src="img/touchguitar.jpg"></p>

  1749. 	</div>

  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>Out 0</td><td>Sound Output</td></tr>

  1754. 	</table>

  1755. 	<h3>Functions</h3>

  1756. 	<p class=func><span class=keyword>noteOn</span>(frequency, velocity);</p>

  1757. 	<p class=desc>Begin a new string note.  Velocity can be from 0 to 1.0,

  1758. 		indicating how hard the string is plucked.

  1759. 	</p>

  1760. 	<p class=func><span class=keyword>noteOff</span>(velocity);</p>

  1761. 	<p class=desc>Stop the sound output.

  1762. 	</p>

  1763. 	<h3>Examples</h3>

  1764. 	<p class=exam>File &gt; Examples &gt; Synthesis &gt; Guitar

  1765. 	</p>

  1766. 	<p class=exam><a href="https://github.com/PaulStoffregen/TouchGuitar" target="_blank">TouchGuitar</a>

  1767. 	</p>

  1768. 	<h3>Notes</h3>

  1769. 	<p></p>

  1770. </script>

  1771. <script type="text/x-red" data-template-name="AudioSynthSimpleDrum">

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

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

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

  1775. 	</div>

  1776. </script>

  1777. 

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

  1779. 	<h3>Summary</h3>

  1780. 	<div class=tooltipinfo>

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

  1782. 	</div>

  1783. 	<h3>Audio Connections</h3>

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

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

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

  1787. 	</table>

  1788. 	<h3>Functions</h3>

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

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

  1791. 	</p>

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

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

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

  1795. 		with modulation signal inputs.

  1796. 	</p>

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

  1798. 	<p class=desc>

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

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

  1801. 		are configured,

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

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

  1804. 	</p>

  1805. 	<h3>Examples</h3>

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

  1807. 	</p>

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

  1809. 	</p>

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

  1811. 	</p>

  1812. 	<h3>Notes</h3>

  1813. 	<p></p>

  1814. </script>

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

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

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

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

  1819. 	</div>

  1820. </script>

  1821. 

  1822. <script type="text/x-red" data-help-name="AudioSynthWaveformSineHires">

  1823. 	<h3>Summary</h3>

  1824. 	<div class=tooltipinfo>

  1825. 	<p>Create a highly precise, low distortion sine wave signal.

  1826. 		Mainly useful for codec &amp; analog circuitry testing.</p>

  1827. 	</div>

  1828. 	<h3>Audio Connections</h3>

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

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

  1831. 		<tr class=odd><td align=center>Out 0</td><td>Sine Wave, upper bits</td></tr>

  1832. 		<tr class=odd><td align=center>Out 1</td><td>Sine Wave, lower bits</td></tr>

  1833. 	</table>

  1834. 	<h3>Functions</h3>

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

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

  1837. 	</p>

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

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

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

  1841. 		with modulation signal inputs.

  1842. 	</p>

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

  1844. 	<p class=desc>

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

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

  1847. 		are configured,

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

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

  1850. 	</p>

  1851. 	<h3>Notes</h3>

  1852. 	<p>An 11th order Taylor series approximation is used to generate

  1853. 		a very accurate sine wave.  At least the upper 25 bits are believe

  1854. 		to be perfect.  This is mainly intended for testing 24 bit codec chips!</p>

  1855. </script>

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

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

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

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

  1860. 	</div>

  1861. </script>

  1862. 

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

  1864. 	<h3>Summary</h3>

  1865. 	<div class=tooltipinfo>

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

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

  1868. 	</div>

  1869. 	<h3>Audio Connections</h3>

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

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

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

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

  1874. 	</table>

  1875. 	<h3>Functions</h3>

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

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

  1878. 	</p>

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

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

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

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

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

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

  1885. 	</p>

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

  1887. 	<p class=desc>

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

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

  1890. 		are configured,

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

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

  1893. 	</p>

  1894. 	<!--

  1895. <h3>Examples</h3>

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

  1897. 	</p>

  1898. -->

  1899. 	<h3>Notes</h3>

  1900. 	<p></p>

  1901. </script>

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

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

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

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

  1906. 	</div>

  1907. </script>

  1908. 

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

  1910. 	<h3>Summary</h3>

  1911. 	<div class=tooltipinfo>

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

  1913. 	</div>

  1914. 	<h3>Audio Connections</h3>

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

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

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

  1918. 	</table>

  1919. 	<h3>Functions</h3>

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

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

  1922. 	</p>

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

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

  1925. 	</p>

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

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

  1928. 	</p>

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

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

  1931. 	</p>

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

  1933. 	<p class=desc>

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

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

  1936. 		are configured,

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

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

  1939. 	</p>

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

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

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

  1943. 	<p class=desc>

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

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

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

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

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

  1949. 		do this automatically.

  1950. 	</p>

  1951. 	<h3>Examples</h3>

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

  1953. 	</p>

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

  1955. 	</p>

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

  1957. 	</p>

  1958. 	<h3>Notes</h3>

  1959. 	<p>Supported Waveforms:<br>

  1960. 		<ul>

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

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

  1963. 		<li><span class=literal>WAVEFORM_SAWTOOTH_REVERSE</span></li>

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

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

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

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

  1968. 		<li><span class=literal>WAVEFORM_SAMPLE_HOLD</span></li>

  1969. 		</ul>

  1970. 	</p>

  1971. </script>

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

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

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

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

  1976. 	</div>

  1977. </script>

  1978. 

  1979. <script type="text/x-red" data-help-name="AudioSynthWaveformPWM">

  1980. 	<h3>Summary</h3>

  1981. 	<div class=tooltipinfo>

  1982. 	<p>Create a Pulse Width Modulated waveform, with an audio signal

  1983. 		controlling the pulse width duty cycle.</p>

  1984. 	<p align=center><img src="img/pwm.png"></p>

  1985. 	</div>

  1986. 	<h3>Audio Connections</h3>

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

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

  1989. 		<tr class=odd><td align=center>In 0</td><td>Control Signal Output</td></tr>

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

  1991. 	</table>

  1992. 	<p>The duty cycle is 50% when the control waveform is zero.

  1993. 		As the control input causes a linear changes in PWM duty

  1994. 		cycle, from nearly 0 to 100% over -1.0 to +1.0 range.

  1995. 		See the notes below for minimum and maximum limitations.

  1996. 	</p>

  1997. 	<h3>Functions</h3>

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

  1999. 	<p class=desc>Change the frequency.

  2000. 	</p>

  2001. 	<p class=func><span class=keyword>amplitude</span>(level);</p>

  2002. 	<p class=desc>Change the amplitude.  Set to 0 to turn the signal off.

  2003. 	</p>

  2004. 	<h3>Examples</h3>

  2005. 	<p class=exam>TODO, examples needed

  2006. 	</p>

  2007. 	<h3>Notes</h3>

  2008. 	<p>The maximum duty cycle is 65536 samples high followed by

  2009. 		one sample low (99.9985%) and the minimum duty cycle is

  2010. 		1 sample high followed by 65536 samples low (0.00153%).

  2011. 	</p>

  2012. </script>

  2013. <script type="text/x-red" data-template-name="AudioSynthWaveformPWM">

  2014. 	<div class="form-row">

  2015. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2016. 		<input type="text" id="node-input-name" placeholder="Name">

  2017. 	</div>

  2018. </script>

  2019. 

  2020. <script type="text/x-red" data-help-name="AudioSynthToneSweep">

  2021. 	<h3>Summary</h3>

  2022. 	<div class=tooltipinfo>

  2023. 	<p>Create a continuously varying (in frequency) sine wave</p>

  2024. 	</div>

  2025. 	<h3>Audio Connections</h3>

  2026. 	<table class=doc align=center cellpadding=3>

  2027. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  2028. 		<tr class=odd><td align=center>Out 0</td><td>Continuously varying tone</td></tr>

  2029. 	</table>

  2030. 	<h3>Functions</h3>

  2031. 	<p class=func><span class=keyword>play</span>(level, lowFreq, highFreq, time);</p>

  2032. 	<p class=desc>Start generating frequency sweep output.  The time is specified

  2033. 		in milliseconds.  Level is 0 to 1.0.

  2034. 	</p>

  2035. 	<p class=func><span class=keyword>isPlaying</span>();</p>

  2036. 	<p class=desc>Returns true (non-zero) while the output is active.

  2037. 	</p>

  2038. 	<h3>Examples</h3>

  2039. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; ToneSweep

  2040. 	</p>

  2041. 	<h3>Notes</h3>

  2042. 	<p>Uses excessive CPU time</p>

  2043. </script>

  2044. <script type="text/x-red" data-template-name="AudioSynthToneSweep">

  2045. 	<div class="form-row">

  2046. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2047. 		<input type="text" id="node-input-name" placeholder="Name">

  2048. 	</div>

  2049. </script>

  2050. 

  2051. <script type="text/x-red" data-help-name="AudioSynthWaveformDc">

  2052. 	<h3>Summary</h3>

  2053. 	<div class=tooltipinfo>

  2054. 	<p>Create constant (DC) signal, useful for control of objects that take

  2055. 		a modulation or control input signal.  This constant level can be

  2056. 		used to modify other waveforms using mixer or multiplier objects</p>

  2057. 	</div>

  2058. 	<h3>Audio Connections</h3>

  2059. 	<table class=doc align=center cellpadding=3>

  2060. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  2061. 		<tr class=odd><td align=center>Out 0</td><td>Output constant DC level</td></tr>

  2062. 	</table>

  2063. 	<h3>Functions</h3>

  2064. 	<p class=func><span class=keyword>amplitude</span>(level);</p>

  2065. 	<p class=desc>Set the output.  Level is -1.0 to 1.0.  The output is

  2066. 		changed immediately.

  2067. 	</p>

  2068. 	<p class=func><span class=keyword>amplitude</span>(level, milliseconds);</p>

  2069. 	<p class=desc>Set the output.  Level is -1.0 to 1.0.  The output is

  2070. 		gradually changed over a "milliseconds" time period.  Any time may

  2071. 		be specified, but periods longer than 1 second may be automatically

  2072. 		shortened for small level changes, due to numerical precision limits.

  2073. 	</p>

  2074. 	<p class=func><span class=keyword>read</span>();</p>

  2075. 	<p class=desc>Read the current level.  Returns -1.0 to 1.0.  This can be

  2076. 		useful for monitoring the amplitude after configuring a slow change.

  2077. 	</p>

  2078. 	<!--

  2079. <h3>Examples</h3>

  2080. 	<p class=exam>File &gt; Examples &gt; Audio &gt;

  2081. 	</p>

  2082. -->

  2083. 	<h3>Notes</h3>

  2084. 	<p>Of course, the term "DC", for Direct Current, doesn't properly apply

  2085. 		to a pure digital stream of numerical values.  But the term is widely

  2086. 		understood in audio applications, so hopefully it's not too confusing?</p>

  2087. </script>

  2088. <script type="text/x-red" data-template-name="AudioSynthWaveformDc">

  2089. 	<div class="form-row">

  2090. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2091. 		<input type="text" id="node-input-name" placeholder="Name">

  2092. 	</div>

  2093. </script>

  2094. 

  2095. <script type="text/x-red" data-help-name="AudioSynthNoiseWhite">

  2096. 	<h3>Summary</h3>

  2097. 	<div class=tooltipinfo>

  2098. 	<p>Create white noise.

  2099. 		</p>

  2100. 	<p align=center><img src="img/whitenoise.png"></p>

  2101. 	</div>

  2102. 	<h3>Audio Connections</h3>

  2103. 	<table class=doc align=center cellpadding=3>

  2104. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  2105. 		<tr class=odd><td align=center>Out 0</td><td>White Noise</td></tr>

  2106. 	</table>

  2107. 	<h3>Functions</h3>

  2108. 	<p class=func><span class=keyword>amplitude</span>(level);</p>

  2109. 	<p class=desc>Set the output peak level, from 0 (off) to 1.0.

  2110. 		The default is off.  Noise is generated only after setting

  2111. 		to a non-zero level.

  2112. 	</p>

  2113. 	<h3>Examples</h3>

  2114. 	<p class=exam>File &gt; Examples &gt; Audio &gt;

  2115. 	</p>

  2116. 	<h3>Notes</h3>

  2117. 	<p>Setting the amplitude to zero causes this object to stop using

  2118. 		CPU time to generate random numbers.

  2119. 	</p>

  2120. </script>

  2121. <script type="text/x-red" data-template-name="AudioSynthNoiseWhite">

  2122. 	<div class="form-row">

  2123. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2124. 		<input type="text" id="node-input-name" placeholder="Name">

  2125. 	</div>

  2126. </script>

  2127. 

  2128. <script type="text/x-red" data-help-name="AudioSynthNoisePink">

  2129. 	<h3>Summary</h3>

  2130. 	<div class=tooltipinfo>

  2131. 	<p>Create pink noise, using Stefan Stenzel's "New Shade Of Pink" algorithm.

  2132. 		</p>

  2133. 	<!--

  2134. <p align=center><img src="img/whitenoise.png"></p>

  2135. -->

  2136. 	</div>

  2137. 	<h3>Audio Connections</h3>

  2138. 	<table class=doc align=center cellpadding=3>

  2139. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  2140. 		<tr class=odd><td align=center>Out 0</td><td>Pink Noise</td></tr>

  2141. 	</table>

  2142. 	<h3>Functions</h3>

  2143. 	<p class=func><span class=keyword>amplitude</span>(level);</p>

  2144. 	<p class=desc>Set the output peak level, from 0 (off) to 1.0.

  2145. 		The default is off.  Noise is generated only after setting

  2146. 		to a non-zero level.

  2147. 	</p>

  2148. 	<h3>Examples</h3>

  2149. 	<p class=exam>File &gt; Examples &gt; Audio &gt; MemoryAndCpuUsage

  2150. 	</p>

  2151. 	<h3>Notes</h3>

  2152. 	<p>Setting the amplitude to zero causes this object to stop using

  2153. 		CPU time.  CPU usage is approx 3% on Teensy 3.1.

  2154. 	</p>

  2155. 	<p>Stefan Stenzel's

  2156. 		<a href="http://stenzel.waldorfmusic.de/post/pink/" target="_blank">New Shade Of Pink</a>

  2157. 		algorithm.  Stefan's terms of use are "Use for any purpose. If used

  2158. 		in a commercial product, you should give me one."

  2159. 	</p>

  2160. </script>

  2161. <script type="text/x-red" data-template-name="AudioSynthNoisePink">

  2162. 	<div class="form-row">

  2163. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2164. 		<input type="text" id="node-input-name" placeholder="Name">

  2165. 	</div>

  2166. </script>

  2167. 

  2168. <script type="text/x-red" data-help-name="AudioEffectFade">

  2169. 	<h3>Summary</h3>

  2170. 	<div class=tooltipinfo>

  2171. 	<p>Gradually increase or decrease audio level.</p>

  2172. 	</div>

  2173. 	<h3>Audio Connections</h3>

  2174. 	<table class=doc align=center cellpadding=3>

  2175. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  2176. 		<tr class=odd><td align=center>In 0</td><td>Signal Input</td></tr>

  2177. 		<tr class=odd><td align=center>Out 0</td><td>Signal Output</td></tr>

  2178. 	</table>

  2179. 	<h3>Functions</h3>

  2180. 	<p class=func><span class=keyword>fadeIn</span>(milliseconds);</p>

  2181. 	<p class=desc>Begin increasing the audio level, to reach 1.0 (input passed

  2182. 		directly to the output) after "milliseconds" time.

  2183. 	</p>

  2184. 	<p class=func><span class=keyword>fadeOut</span>(milliseconds);</p>

  2185. 	<p class=desc>Begin decreasing the audio level, to reach 0 (no output)

  2186. 		after "milliseconds" time.

  2187. 	</p>

  2188. 	<!--

  2189. <h3>Examples</h3>

  2190. 	<p class=exam>File &gt; Examples &gt; Audio &gt;

  2191. 	</p>

  2192. -->

  2193. 	<h3>Notes</h3>

  2194. 	<p>Cross fading can be built with 2 fade objects fed into a mixer.

  2195. 		When one fade object is off (fully faded out) and the other on

  2196. 		(fully faded in), if both are started at the same moment for the

  2197. 		same time duration, their signal gains always add to 1.0.  This

  2198. 		allows 2 fade objects to work together for a smooth transition

  2199. 		between a pair of signals.

  2200. 	</p>

  2201. 	<p><a href="http://www.pjrc.com/teensy/td_libs_AudioProcessorUsage.html" target="_blank">AudioNoInterrupts()</a>

  2202. 		should be used when changing

  2203. 		settings on multiple objects, so all changes always take effect

  2204. 		at the same moment.

  2205. 	</p>

  2206. </script>

  2207. <script type="text/x-red" data-template-name="AudioEffectFade">

  2208. 	<div class="form-row">

  2209. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2210. 		<input type="text" id="node-input-name" placeholder="Name">

  2211. 	</div>

  2212. </script>

  2213. 

  2214. <script type="text/x-red" data-help-name="AudioEffectChorus">

  2215. <h3>Summary</h3>

  2216. 	<div class=tooltipinfo>

  2217. 	<p>The chorus effect simulates the richness of several nearly-identical

  2218. 	sound sources (like the way a choir sounds different to a single singer).

  2219. 	It does this by sampling from a delay line, so each voice is actually

  2220. 	the same but at a slightly different point in time. This is a type of

  2221. 	comb filtering.</p>

  2222. 	</div>

  2223. 	<p>Chorus combines one or more samples ranging from the most recent

  2224. 	sample back to about 50ms ago. The additional samples are evenly spread

  2225. 	through the supplied delay line, and there is no modulation.</p>

  2226. 	<p>If the number of voices is specified as 2, then the

  2227. 	effect combines the current sample and the oldest sample (the last one

  2228. 	in the delay line). If the number of voices is 3 then the effect combines

  2229. 	the most recent sample, the oldest sample and the sample in the middle of

  2230. 	the delay line.</p>

  2231. 	<p>For two voices the effect can be represented as:<br/>

  2232. 	result = (sample(0) + sample(dt))/2<br/>

  2233. 	where sample(0) represents the current sample and sample(dt)

  2234. 	is the sample in the delay line from dt milliseconds ago.</p>

  2235. 	<h3>Audio Connections</h3>

  2236. 	<table class=doc align=center cellpadding=3>

  2237. 		<tr class="top"><th>Port</th><th>Purpose</th></tr>

  2238. 		<tr class="odd"><td align="center">In 0</td><td>Signal Input</td></tr>

  2239. 		<tr class="odd"><td align="center">Out 0</td><td>Chorused Output</td></tr>

  2240. 	</table>

  2241. 	<h3>Functions</h3>

  2242. 	<p class=func><span class=keyword>begin</span>(delayBuffer, length, n_chorus);</p>

  2243. 	<p class=desc>Create a chorus by specifying the address of the delayline, the

  2244. 	total number of samples in the delay line (often done as an integer multiple of

  2245. 	AUDIO_BLOCK_SAMPLES) and the number of voices in the chorus <em>including</em>

  2246. 	the original voice (so, 2 and up to get a chorus effect, although you can

  2247. 	specify 1 if you want).

  2248. 	</p>

  2249. 	<p class=func><span class=keyword>modify</span>(n_chorus);</p>

  2250. 	<p class=desc>Alters the number of voices in a running chorus (previously started with begin).

  2251. 	</p>

  2252. 	<h3>Examples</h3>

  2253. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Effects &gt; Chorus

  2254. 	</p>

  2255. 	<h3>Notes</h3>

  2256. 	<p>The longer the length of the chorus, the more memory blocks are used.</p>

  2257. </script>

  2258. <script type="text/x-red" data-template-name="AudioEffectChorus">

  2259. 	<div class="form-row">

  2260. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2261. 		<input type="text" id="node-input-name" placeholder="Name">

  2262. 	</div>

  2263. </script>

  2264. 

  2265. <script type="text/x-red" data-help-name="AudioEffectFlange">

  2266. <h3>Summary</h3>

  2267. 	<div class=tooltipinfo>

  2268. 	<p>Originally, flanging was produced by playing the same signal on two synchronized

  2269. 	reel-to-reel tape recorders and making one of the reels slow down and speed up by

  2270. 	pressing on the flange of the reel (hence the name). This is a type of

  2271. 	comb filtering, and produces a harmonically-related series of peaks and notches

  2272. 	in the audio spectrum.</p>

  2273. 	</div>

  2274. 	<p>This flanger uses a delay line, combining the original voice with only one sample from the delay

  2275. 	line, but the position of that sample varies sinusoidally.</p>

  2276. 	<p>The effect can be represented as:<br>

  2277. 	result = sample(0) + sample(dt + depth*sin(2*PI*Fe))</p>

  2278. 	<p>The value of the sine function is always a number from -1 to +1 and

  2279. 	so the result of depth*(sin(Fe)) is always a number from -depth to +depth.

  2280. 	Thus, the delayed sample will be selected from the range (dt-depth) to

  2281. 	(dt+depth). This selection will vary at whatever rate is specified as the

  2282. 	frequency of the effect, Fe. Typically a low frequency (a few Hertz) is used.

  2283. 	<h3>Audio Connections</h3>

  2284. 	<table class=doc align=center cellpadding=3>

  2285. 		<tr class="top"><th>Port</th><th>Purpose</th></tr>

  2286. 		<tr class="odd"><td align="center">In 0</td><td>Signal Input</td></tr>

  2287. 		<tr class="odd"><td align="center">Out 0</td><td>Flanged Output</td></tr>

  2288. 	</table>

  2289. 	<h3>Functions</h3>

  2290. 	<p class=func><span class=keyword>begin</span>(delayBuffer, length, offset, depth, delayRate);</p>

  2291. 	<p class=desc>Create a flanger by specifying the address of the delayline, the

  2292. 	total number of samples in the delay line (often done as an integer multiple of

  2293. 	AUDIO_BLOCK_SAMPLES), the offset (how far back the flanged sample is from the original voice),

  2294. 	the modulation depth (larger values give a greater variation) and the modulation

  2295. 	frequency, in Hertz.

  2296. 	</p>

  2297. 	<p class=func><span class=keyword>voices</span>(offset, depth, delayRate);</p>

  2298. 	<p class=desc>Alters the parameters in a running flanger (previously started with begin).

  2299. 	</p>

  2300. 

  2301. 	<h3>Examples</h3>

  2302. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Effects &gt; Flange

  2303. 	</p>

  2304. 	<h3>Notes</h3>

  2305. 	<p>The longer the length of the delay buffer, the more memory blocks are used.</p>

  2306. 	<p>Try these settings:<br>

  2307. #define FLANGE_DELAY_LENGTH (2*AUDIO_BLOCK_SAMPLES)<br>

  2308. and<br>

  2309. int s_idx = 2*FLANGE_DELAY_LENGTH/4;<br>

  2310. int s_depth = FLANGE_DELAY_LENGTH/4;<br>

  2311. double s_freq = 3;</p>

  2312. <p>The flange effect can also produce a chorus-like effect if a longer

  2313. delay line is used with a slower modulation rate, for example try:<br>

  2314. #define FLANGE_DELAY_LENGTH (12*AUDIO_BLOCK_SAMPLES)<br>

  2315. and<br>

  2316. int s_idx = 3*FLANGE_DELAY_LENGTH/4;<br>

  2317. int s_depth = FLANGE_DELAY_LENGTH/8;<br>

  2318. double s_freq = .0625;</p>

  2319. </script>

  2320. <script type="text/x-red" data-template-name="AudioEffectFlange">

  2321. 	<div class="form-row">

  2322. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2323. 		<input type="text" id="node-input-name" placeholder="Name">

  2324. 	</div>

  2325. </script>

  2326. 

  2327. <script type="text/x-red" data-help-name="AudioEffectReverb">

  2328. <h3>Summary</h3>

  2329. 	<div class=tooltipinfo>

  2330. 	<p>Reverb with adjustable reverberation time.  Contributed by Joao Rossi FIlho.

  2331. 	</p>

  2332. 	</div>

  2333. 	<h3>Audio Connections</h3>

  2334. 	<table class=doc align=center cellpadding=3>

  2335. 		<tr class="top"><th>Port</th><th>Purpose</th></tr>

  2336. 		<tr class="odd"><td align="center">In 0</td><td>Input</td></tr>

  2337. 		<tr class="odd"><td align="center">Out 0</td><td>Output</td></tr>

  2338. 	</table>

  2339. 	<h3>Functions</h3>

  2340. 	<p class=func><span class=keyword>reverbTime</span>(seconds);</p>

  2341. 	<p class=desc>Sets the amount of reverberation time.

  2342. 	</p>

  2343. 

  2344. 	<h3>Examples</h3>

  2345. 	<p><a href="https://twitter.com/joaorossifilho/status/779737126841753601">Video Demo</a>

  2346. 	</p>

  2347. 	<!--<p class=exam>File &gt; Examples &gt; Audio &gt; Effects &gt; Flange

  2348. 	</p>-->

  2349. 	<h3>Notes</h3>

  2350. 	<p>This effect may have distortion problems with the input signal is more than 0.5.</p>

  2351. </script>

  2352. <script type="text/x-red" data-template-name="AudioEffectReverb">

  2353. 	<div class="form-row">

  2354. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2355. 		<input type="text" id="node-input-name" placeholder="Name">

  2356. 	</div>

  2357. </script>

  2358. 

  2359. <script type="text/x-red" data-help-name="AudioEffectEnvelope">

  2360. 	<h3>Summary</h3>

  2361. 	<div class=tooltipinfo>

  2362. 	<p>Modify a signal with a DAHDSR (Delay Attack Hold Decay Sustain

  2363. 		Release) envelope.

  2364. 	</p>

  2365. 	<p align=center><img src="img/dahdsr.png"></p>

  2366. 	</div>

  2367. 	<h3>Audio Connections</h3>

  2368. 	<table class=doc align=center cellpadding=3>

  2369. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  2370. 		<tr class=odd><td align=center>In 0</td><td>Signal Input</td></tr>

  2371. 		<tr class=odd><td align=center>Out 0</td><td>Signal with Envelope Applied</td></tr>

  2372. 	</table>

  2373. 	<h3>Functions</h3>

  2374. 	<p class=func><span class=keyword>noteOn</span>();</p>

  2375. 	<p class=desc>Begin the delay to attack, or the attack phase is

  2376. 		delay is zero.

  2377. 	</p>

  2378. 	<p class=func><span class=keyword>noteOff</span>();</p>

  2379. 	<p class=desc>Begin the release phase.

  2380. 	</p>

  2381. 	<p class=func><span class=keyword>delay</span>(milliseconds);</p>

  2382. 	<p class=desc>Set the delay from noteOn to the attach phase.  The

  2383. 		default is zero, for no delay.

  2384. 	</p>

  2385. 	<p class=func><span class=keyword>attack</span>(milliseconds);</p>

  2386. 	<p class=desc>Set the attack time.  The default is 10.5 milliseconds.

  2387. 	</p>

  2388. 	<p class=func><span class=keyword>hold</span>(milliseconds);</p>

  2389. 	<p class=desc>Set the hold time.  The default is 2.5 milliseconds.

  2390. 	</p>

  2391. 	<p class=func><span class=keyword>decay</span>(milliseconds);</p>

  2392. 	<p class=desc>Set the decay time.  The default is 35 milliseconds.

  2393. 	</p>

  2394. 	<p class=func><span class=keyword>sustain</span>(level);</p>

  2395. 	<p class=desc>Set the sustain level.  The range is 0 to 1.0.  The

  2396. 		gain will be maintained at this level after the decay phase,

  2397. 		until noteOff() is called.

  2398. 	</p>

  2399. 	<p class=func><span class=keyword>release</span>(milliseconds);</p>

  2400. 	<p class=desc>Set the release time.  The default is 300 millisecond.

  2401. 	</p>

  2402. 	<p class=func><span class=keyword>releaseNoteOn</span>(milliseconds);</p>

  2403. 	<p class=desc>Set a quick release time to be used when a new note is

  2404. 		started while the envelop is in any state passing the signal.

  2405. 		This will add latency before your new attack phase begins, so

  2406. 		short times are recommended.  Zero may be used to completely

  2407. 		disable this feature (never extra latency).  Longer times help

  2408. 		reduce clicks or pops.  The default is 5 millisecond.

  2409. 	</p>

  2410. 	<h3>Examples</h3>

  2411. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Synthesis &gt; PlaySynthMusic

  2412. 	</p>

  2413. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Synthesis &gt; pulseWidth

  2414. 	</p>

  2415. 	<p class=exam>File &gt; Examples &gt; Audio &gt; MemoryAndCpuUsage

  2416. 	</p>

  2417. 	<h3>Notes</h3>

  2418. 	<p>To achieve the more common ADSR shape, simply

  2419.         set delay and hold to zero.</p>

  2420. 	<p>The recommended range for each of the 5 timing inputs is 0 to 50

  2421. 		milliseconds.  Up to 200 ms can be used, with somewhat reduced

  2422. 		accuracy</p>

  2423. </script>

  2424. <script type="text/x-red" data-template-name="AudioEffectEnvelope">

  2425. 	<div class="form-row">

  2426. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2427. 		<input type="text" id="node-input-name" placeholder="Name">

  2428. 	</div>

  2429. </script>

  2430. 

  2431. <script type="text/x-red" data-help-name="AudioEffectMultiply">

  2432. 	<h3>Summary</h3>

  2433. 	<div class=tooltipinfo>

  2434. 	<p>Multiply two signals together, useful for amplitude modulation

  2435. 		or "voltage controlled amplification".

  2436. 	</p>

  2437. 	<p align=center><img src="img/multiply.png"><br><small>56 Hz and 1 kHz sine waves multiplied.</small></p>

  2438. 	</div>

  2439. 	<h3>Audio Connections</h3>

  2440. 	<table class=doc align=center cellpadding=3>

  2441. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  2442. 		<tr class=odd><td align=center>In 0</td><td>Signal Input</td></tr>

  2443. 		<tr class=odd><td align=center>In 1</td><td>Signal Input</td></tr>

  2444. 		<tr class=odd><td align=center>Out 0</td><td>Signal with Envelope Applied</td></tr>

  2445. 	</table>

  2446. 	<h3>Functions</h3>

  2447. 	<p>There are no functions to call from the Arduino sketch.

  2448. 		This object simply multiplies the 2 signals to create

  2449. 		a continuous output

  2450. 	</p>

  2451. 	<!--

  2452. <h3>Examples</h3>

  2453. 	<p class=exam>File &gt; Examples &gt; Audio &gt;

  2454. 	</p>

  2455. -->

  2456. 	<h3>Notes</h3>

  2457. 	<p>

  2458.     </p>

  2459. </script>

  2460. <script type="text/x-red" data-template-name="AudioEffectMultiply">

  2461. 	<div class="form-row">

  2462. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2463. 		<input type="text" id="node-input-name" placeholder="Name">

  2464. 	</div>

  2465. </script>

  2466. 

  2467. <script type="text/x-red" data-help-name="AudioEffectDelay">

  2468. 	<h3>Summary</h3>

  2469. 	<div class=tooltipinfo>

  2470. 	<p>Delay a signal.  Up to 8 separate delay taps can be used.</p>

  2471. 	<p align=center><img src="img/delay.png"><br><small>1 kHz burst, delayed 5.2 ms.</small></p>

  2472. 	</div>

  2473. 	<h3>Audio Connections</h3>

  2474. 	<table class=doc align=center cellpadding=3>

  2475. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  2476. 		<tr class=odd><td align=center>In 0</td><td>Signal Input</td></tr>

  2477. 		<tr class=odd><td align=center>Out 0</td><td>Delay Tap #1</td></tr>

  2478. 		<tr class=odd><td align=center>Out 1</td><td>Delay Tap #2</td></tr>

  2479. 		<tr class=odd><td align=center>Out 2</td><td>Delay Tap #3</td></tr>

  2480. 		<tr class=odd><td align=center>Out 3</td><td>Delay Tap #4</td></tr>

  2481. 		<tr class=odd><td align=center>Out 4</td><td>Delay Tap #5</td></tr>

  2482. 		<tr class=odd><td align=center>Out 5</td><td>Delay Tap #6</td></tr>

  2483. 		<tr class=odd><td align=center>Out 6</td><td>Delay Tap #7</td></tr>

  2484. 		<tr class=odd><td align=center>Out 7</td><td>Delay Tap #8</td></tr>

  2485. 	</table>

  2486. 	<h3>Functions</h3>

  2487. 	<p class=func><span class=keyword>delay</span>(channel, milliseconds);</p>

  2488. 	<p class=desc>Set output channel (0 to 7) to delay the signals by

  2489. 		milliseconds.  The maximum delay is approx 425 ms.  The actual delay

  2490. 		is rounded to the nearest sample.  Each channel can be configured for

  2491. 		any delay.  There is no requirement to configure the "taps" in increasing

  2492. 		delay order.

  2493. 	</p>

  2494. 	<p class=func><span class=keyword>disable</span>(channel);</p>

  2495. 	<p class=desc>Disable a channel.  The output of this channel becomes

  2496. 		silent.  If this channel is the longest delay, memory usage is

  2497. 		automatically reduced to accomodate only the remaining channels used.

  2498. 	</p>

  2499. 	<h3>Examples</h3>

  2500. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Effects &gt; Delay

  2501. 	</p>

  2502. 	<h3>Notes</h3>

  2503. 	<p>Memory for the delayed signal is take from the memory pool allocated by

  2504. 		<a href="http://www.pjrc.com/teensy/td_libs_AudioConnection.html" target="_blank">AudioMemory()</a>.

  2505. 		Each block allows about 3 milliseconds of delay, so AudioMemory

  2506. 		should be increased to allow for the longest delay tap.

  2507. 	</p>

  2508. </script>

  2509. <script type="text/x-red" data-template-name="AudioEffectDelay">

  2510. 	<div class="form-row">

  2511. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2512. 		<input type="text" id="node-input-name" placeholder="Name">

  2513. 	</div>

  2514. </script>

  2515. 

  2516. <script type="text/x-red" data-help-name="AudioEffectDelayExternal">

  2517. 	<h3>Summary</h3>

  2518. 	<div class=tooltipinfo>

  2519. 	<p>Delay a signal, using external memory for longer delay times!  Up to 8 separate delay taps can be used.</p>

  2520. 	<p align=center><img src="img/delay.png"><br><small>1 kHz burst, delayed 5.2 ms.</small></p>

  2521. 	</div>

  2522. 	<h3>Audio Connections</h3>

  2523. 	<table class=doc align=center cellpadding=3>

  2524. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  2525. 		<tr class=odd><td align=center>In 0</td><td>Signal Input</td></tr>

  2526. 		<tr class=odd><td align=center>Out 0</td><td>Delay Tap #1</td></tr>

  2527. 		<tr class=odd><td align=center>Out 1</td><td>Delay Tap #2</td></tr>

  2528. 		<tr class=odd><td align=center>Out 2</td><td>Delay Tap #3</td></tr>

  2529. 		<tr class=odd><td align=center>Out 3</td><td>Delay Tap #4</td></tr>

  2530. 		<tr class=odd><td align=center>Out 4</td><td>Delay Tap #5</td></tr>

  2531. 		<tr class=odd><td align=center>Out 5</td><td>Delay Tap #6</td></tr>

  2532. 		<tr class=odd><td align=center>Out 6</td><td>Delay Tap #7</td></tr>

  2533. 		<tr class=odd><td align=center>Out 7</td><td>Delay Tap #8</td></tr>

  2534. 	</table>

  2535. 	<h3>Functions</h3>

  2536. 	<p class=func><span class=keyword>delay</span>(channel, milliseconds);</p>

  2537. 	<p class=desc>Set output channel (0 to 7) to delay the signals by

  2538. 		milliseconds.  The maximum delay is approx 1.5 seconds for each 23LC1024 chip.

  2539. 		The actual delay

  2540. 		is rounded to the nearest sample.  Each channel can be configured for

  2541. 		any delay.  There is no requirement to configure the "taps" in increasing

  2542. 		delay order.

  2543. 	</p>

  2544. 	<p class=func><span class=keyword>disable</span>(channel);</p>

  2545. 	<p class=desc>Disable a channel.  The output of this channel becomes

  2546. 		silent.  If this channel is the longest delay, memory usage is

  2547. 		automatically reduced to accomodate only the remaining channels used.

  2548. 	</p>

  2549. 	<h3>Hardware</h3>

  2550. 	<p>By default, or when <span class=literal>AUDIO_MEMORY_23LC1024</span> is used (see below),

  2551. 		 a single 23LC1024 RAM chip is used, with these pins:

  2552.     <table class=doc align=center cellpadding=3>

  2553.         <tr class=top><th>Pin</th><th>Signal</th></tr>

  2554.         <tr class=odd><td align=center>6</td><td>CS</td></tr>

  2555.         <tr class=odd><td align=center>7</td><td>MOSI</td></tr>

  2556.         <tr class=odd><td align=center>12</td><td>MISO</td></tr>

  2557.         <tr class=odd><td align=center>14</td><td>SCK</td></tr>

  2558.     </table>

  2559. 	</p>

  2560. 	<p>When <span class=literal>AUDIO_MEMORY_CY15B104</span> is used, a single

  2561. 		CY15B104 FRAM chip is used, with these pins:

  2562.     <table class=doc align=center cellpadding=3>

  2563.         <tr class=top><th>Pin</th><th>Signal</th></tr>

  2564.         <tr class=odd><td align=center>6</td><td>CS</td></tr>

  2565.         <tr class=odd><td align=center>7</td><td>SI</td></tr>

  2566.         <tr class=odd><td align=center>12</td><td>SO</td></tr>

  2567.         <tr class=odd><td align=center>14</td><td>SCK</td></tr>

  2568.     </table>

  2569. 	</p>

  2570. 	<p>When <span class=literal>AUDIO_MEMORY_MEMORYBOARD</span> is used, up to six

  2571. 		23LC1024 chips are used.

  2572. 	</p>

  2573. 	<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>

  2574. 	<p>

  2575.     <table class=doc align=center cellpadding=3>

  2576.         <tr class=top><th>Pin</th><th>Signal</th></tr>

  2577.         <tr class=odd><td align=center>2</td><td>CS0 (encoded)</td></tr>

  2578.         <tr class=odd><td align=center>3</td><td>CS1 (encoded)</td></tr>

  2579.         <tr class=odd><td align=center>4</td><td>CS2 (encoded)</td></tr>

  2580.         <tr class=odd><td align=center>7</td><td>MOSI</td></tr>

  2581.         <tr class=odd><td align=center>12</td><td>MISO</td></tr>

  2582.         <tr class=odd><td align=center>14</td><td>SCK</td></tr>

  2583.     </table>

  2584. 	</p>

  2585. 	<p>

  2586. 	If fewer than 6 chips are soldered, the optional parameter for maximum delay

  2587. 	must be used.  See below for details.  Each chip provides 1485 ms of delay

  2588. 	memory, so the total of all objects using AUDIO_MEMORY_MEMORYBOARD must not

  2589. 	exceed the amount of memory physically present.

  2590. 	</p>

  2591. 	<h3>Examples</h3>

  2592. 	<p>

  2593. 	<a href="https://www.youtube.com/watch?v=d80d1HWy5_s" target="_blank">Demo Video</a> (YouTube)

  2594. 	</p>

  2595. 	<!--

  2596.  <p class=exam>File &gt; Examples &gt; Audio &gt; Effects &gt; Delay

  2597. 	</p>

  2598. -->

  2599. 	<p>

  2600. 	<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)

  2601. 	</p>

  2602. 	<h3>Notes</h3>

  2603. 	<p>External RAM allows for longer delays without consuming

  2604. 		limited internal RAM.  However, SPI communication is required,

  2605. 		which consumes much more CPU time.  The

  2606. 		<a href="http://www.pjrc.com/teensy/td_libs_AudioProcessorUsage.html">AudioProcessorUsageMax</a>

  2607. 		function may be used to monitor how much CPU time is consumed.

  2608. 	</p>

  2609. 	<p>You may specify the type of hardware to be used by editing the code.  AUDIO_MEMORY_23LC1024

  2610. 		specifies a single 23LC1024 chip.  AUDIO_MEMORY_MEMORYBOARD allows using up to 6 of these

  2611. 		chips.

  2612. 	</p>

  2613. 	<p class=desc><span class=keyword>AudioEffectDelayExternal</span>  delayExt1(<span class=literal>AUDIO_MEMORY_23LC1024</span>);

  2614. 	</p>

  2615. 	<p>You may also create more than one delay using the same hardware, where the memory is partitioned

  2616. 		by specifying a maximum delay in milliseconds.  This can be useful if you wish to delay both

  2617. 		channels of a stereo signal.

  2618. 

  2619. 	<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);

  2620. 	</p>

  2621. 	<p>When using CY15B104, you

  2622. 		<a href="https://forum.pjrc.com/threads/45872-Memory-Chip-for-Audio-Adaptor-Board?p=151839&viewfull=1#post151839">may need to add a capacitor between 3.3V & GND</a>

  2623. 		to make the chip work.

  2624. 	</p>

  2625. </script>

  2626. <script type="text/x-red" data-template-name="AudioEffectDelayExternal">

  2627. 	<div class="form-row">

  2628. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2629. 		<input type="text" id="node-input-name" placeholder="Name">

  2630. 	</div>

  2631. </script>

  2632. 

  2633. <script type="text/x-red" data-help-name="AudioEffectBitcrusher">

  2634.     <h3>Summary</h3>

  2635. 	<div class=tooltipinfo>

  2636.     <p>Reduce the samplerate and/or bitdepth of a source signal, resulting in

  2637. 		a distorted sound.</p>

  2638. 	</div>

  2639.     <h3>Audio Connections</h3>

  2640.     <table class=doc align=center cellpadding=3>

  2641.         <tr class=top><th>Port</th><th>Purpose</th></tr>

  2642.         <tr class=odd><td align=center>In 0</td><td>Signal Input</td></tr>

  2643.         <tr class=odd><td align=center>Out 0</td><td>Signal Output</td></tr>

  2644.     </table>

  2645.     <h3>Functions</h3>

  2646.     <p class=func><span class=keyword>bits</span>(xcrushBits);</p>

  2647.     <p class=desc>xcrushBits sets the bitdepth, from 1 to 16. A Value of 16

  2648.     does not crush the bitdepth, and is effectively a passthru for this part

  2649.     of the function.</p>

  2650. 

  2651.     <p class=func><span class=keyword>sampleRate</span>(xsampleRate);</p>

  2652. 

  2653.     <p class=desc>xsampleRate sets the frequency, from 1 to 44100Hz, however it

  2654.     works in integer steps so you will only really get a handful of results from

  2655.     the many samplerates you can pass. 44100 is passthru.</p>

  2656. 

  2657.     <p class=desc>set xbitDepth to 16 and xsampleRate to 44100 to pass audio

  2658.     	through without any Bitcrush effect.</p>

  2659.     <h3>Examples</h3>

  2660.     <p class=exam>File &gt; Examples &gt; Audio &gt; Effects &gt; Bitcrusher

  2661.     </p>

  2662.     <h3>Notes</h3>

  2663.     <p>Needs a lot of improvement. Options for anti-aliasing would be nice in

  2664.     the future, but for now, it's rough, it's dirty and it sounds a bit like

  2665.     Nine Inch Nails.

  2666.     </p>

  2667.     <p><a href="http://www.pjrc.com/teensy/td_libs_AudioProcessorUsage.html" target="_blank">AudioNoInterrupts()</a>

  2668.         should be used when changing

  2669.         settings on multiple objects, so all changes always take effect

  2670.         at the same moment.

  2671.     </p>

  2672. </script>

  2673. <script type="text/x-red" data-template-name="AudioEffectBitcrusher">

  2674.     <div class="form-row">

  2675.         <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2676.         <input type="text" id="node-input-name" placeholder="Name">

  2677.     </div>

  2678. </script>

  2679. 

  2680. <script type="text/x-red" data-help-name="AudioEffectMidSide">

  2681. 	<h3>Summary</h3>

  2682. 	<div class=tooltipinfo>

  2683. 	<p>Convert stereo signals to/from Mid-Side format.

  2684. 		Mid-Side encoding can be used to increase stereo width, make the lower

  2685. 		frequencies mono (to please your sub), or as the basis of audio compression.</p>

  2686. 	</div>

  2687. 	<h3>Audio Connections</h3>

  2688. 	<table class=doc align=center cellpadding=3>

  2689. 		<tr class=top><th>Port</th><th>While<br>Encoding</th><th>While<br>Decoding</th></tr>

  2690. 		<tr class=odd><td align=center>In 0</td><td>Left Input</td><td>Mid Output</td></tr>

  2691. 		<tr class=odd><td align=center>In 1</td><td>Right Input</td><td>Side Output</td></tr>

  2692. 		<tr class=odd><td align=center>Out 0</td><td>Mid Input</td><td>Left Output</td></tr>

  2693. 		<tr class=odd><td align=center>Out 1</td><td>Side Input</td><td>Right Output</td></tr>

  2694. 	</table>

  2695. 	<h3>Functions</h3>

  2696. 	<p class=func><span class=keyword>encode</span>();</p>

  2697. 	<p class=desc>Configure this object to encode from stereo to Mid-Side format.</p>

  2698. 	<p class=func><span class=keyword>decode</span>();</p>

  2699. 	<p class=desc>Configure this object to decode from Mid-Side format back to stereo signals.</p>

  2700. 

  2701. 	<h3>Examples</h3>

  2702. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Effects &gt; Mid_Side</p>

  2703. 	<h3>Notes</h3>

  2704. 	<p>Many interesting stereo effects can be achieved by manipulating Mid-Side signals.</p>

  2705. 	<p>Normally a pair of these objects are used, one to encode, then additional

  2706. 		gain/attenuation or effects applied to the Mid-Side signals, and finally

  2707. 		decoding back to stereo signals</p>

  2708. 	<p>To prevent saturation, halving is done in the encoding, that is:</p>

  2709. 	<p>Mid = (left+right)/2</p>

  2710. 	<p>Side = (left-right)/2</p>

  2711. 	<p>And to decode:</p>

  2712. 	<p>Left = Mid+Side</p>

  2713. 	<p>Right = Mid-Side</p>

  2714. </script>

  2715. <script type="text/x-red" data-template-name="AudioEffectMidSide">

  2716.     <div class="form-row">

  2717.         <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2718.         <input type="text" id="node-input-name" placeholder="Name">

  2719.     </div>

  2720. </script>

  2721. 

  2722. <script type="text/x-red" data-help-name="AudioEffectWaveshaper">

  2723. 	<h3>Summary</h3>

  2724. 	<div class=tooltipinfo>

  2725. 	<p>Modify the waveform shape of a signal.</p>

  2726. 	<p align=center><img src="img/waveshaper.png"></p>

  2727. 	<p>Useful for overdrive, distortion, fuzz,

  2728. 		clipping, expo converters, phase inversion, waveform modification &amp; adjustments.

  2729. 	</p>

  2730. 	</div>

  2731. 	<h3>Audio Connections</h3>

  2732. 	<table class=doc align=center cellpadding=3>

  2733. 		<tr class=top><th>Port</th><th>Signal</th></tr>

  2734. 		<tr class=odd><td align=center>In 0</td><td>Original Input Signal</td></tr>

  2735. 		<tr class=odd><td align=center>Out 0</td><td>Shaped Output</td></tr>

  2736. 	</table>

  2737. 	<h3>Functions</h3>

  2738. 	<p class=func><span class=keyword>shape</span>(array, length);</p>

  2739. 	<p class=desc>Configure the waveform shape.  Array is a list of float

  2740. 		numbers, given in order.  The first number maps to input -1.0.  The

  2741. 		last maps to input +1.0.  The numbers represent the desired output

  2742. 		level at each of these input levels.  Length must be 2, 3, 5, 9, 17,

  2743. 		33, 65, 129, 257, 513, 1025, 2049, 4097, 8193, 16385, or 32769.

  2744. 		</p>

  2745. 

  2746. 	<h3>Examples</h3>

  2747. 	<p class=exam>TODO: example needed</p>

  2748. 	<!--<p class=exam>File &gt; Examples &gt; Audio &gt; Effects &gt; Mid_Side</p>-->

  2749. 	<h3>Notes</h3>

  2750. 	<p><a href="https://github.com/dxinteractive/TeensyAudioWaveshaper">More information</a>

  2751. 		</p>

  2752. </script>

  2753. <script type="text/x-red" data-template-name="AudioEffectWaveshaper">

  2754.     <div class="form-row">

  2755.         <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2756.         <input type="text" id="node-input-name" placeholder="Name">

  2757.     </div>

  2758. </script>

  2759. 

  2760. <script type="text/x-red" data-help-name="AudioFilterBiquad">

  2761. 	<h3>Summary</h3>

  2762. 	<div class=tooltipinfo>

  2763. 	<p>Biquadratic cascaded filter, useful for all sorts of filtering.

  2764. 		Up to 4 stages may be cascaded.

  2765. 	</p>

  2766. 	<p align=center><img src="img/biquad.png"></p>

  2767. 	</div>

  2768. 	<h3>Audio Connections</h3>

  2769. 	<table class=doc align=center cellpadding=3>

  2770. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  2771. 		<tr class=odd><td align=center>In 0</td><td>Signal to be filtered</td></tr>

  2772. 		<tr class=odd><td align=center>Out 0</td><td>Filtered Signal Output</td></tr>

  2773. 	</table>

  2774. 	<h3>Functions</h3>

  2775. 	<p class=func><span class=keyword>setLowpass</span>(stage, frequency, Q);</p>

  2776. 	<p class=desc>Configure one stage of the filter (0 to 3) with low pass

  2777. 		response, with the specified corner frequency and Q shape.  If Q is

  2778. 		higher that 0.7071, be careful of filter gain (see below).

  2779. 	</p>

  2780. 	<p class=func><span class=keyword>setHighpass</span>(stage, frequency, Q);</p>

  2781. 	<p class=desc>Configure one stage of the filter (0 to 3) with high pass

  2782. 		response, with the specified corner frequency and Q shape.  If Q is

  2783. 		higher that 0.7071, be careful of filter gain (see below).

  2784. 	</p>

  2785. 	<p class=func><span class=keyword>setBandpass</span>(stage, frequency, Q);</p>

  2786. 	<p class=desc>Configure one stage of the filter (0 to 3) with band pass

  2787. 		response.  The filter has unity gain at the specified frequency.  Q

  2788. 		controls the width of frequencies allowed to pass.

  2789. 	</p>

  2790. 	<p class=func><span class=keyword>setNotch</span>(stage, frequency, Q);</p>

  2791. 	<p class=desc>Configure one stage of the filter (0 to 3) with band reject (notch)

  2792. 		response.  Q controls the width of rejected frequencies.

  2793. 	</p>

  2794. 	<p class=func><span class=keyword>setLowShelf</span>(stage, frequency, gain, slope);</p>

  2795. 	<p class=desc>Configure one stage of the filter (0 to 3) with low shelf response.

  2796. 		A low shelf filter attenuates or amplifies signals below the specified frequency.

  2797. 		Frequency controls the slope midpoint, gain is in dB and can be both

  2798. 		positive or negative. The slope parameter controls steepness of gain transition.

  2799. 		A slope of 1 yields maximum steepness without overshoot,

  2800. 		lower values yield a less steep slope. See the picture below for a visualization

  2801. 		of the slope parameter's effect.

  2802. 		Be careful with positive gains and slopes higher than 1 as they introduce gain

  2803. 		(see warning below).

  2804. 	</p>

  2805. 	</p>

  2806. 	<p class=func><span class=keyword>setHighShelf</span>(stage, frequency, gain, slope);</p>

  2807. 	<p class=desc>Configure one stage of the filter (0 to 3) with high shelf response.

  2808. 		A high shelf filter attenuates or amplifies signals above the specified frequency.

  2809. 		Frequency controls the slope midpoint, gain is in dB and can be both

  2810. 		positive or negative. The slope parameter controls steepness of gain transition.

  2811. 		A slope of 1 yields maximum steepness without overshoot,

  2812. 		lower values yield a less steep slope. See the picture below for a visualization

  2813. 		of the slope parameter's effect.

  2814. 		Be careful with positive gains and slopes higher than 1 as they introduce gain

  2815. 		(see warning below).

  2816. 	</p>

  2817. 	<p align=center><img src="img/shelf_filter.png"></p>

  2818. 	<p class=func><span class=keyword>setCoefficients</span>(stage, array[5]);</p>

  2819. 	<p class=desc>Configure one stage of the filter (0 to 3) with an arbitrary

  2820. 		filter response.  The array of coefficients is in order: B0, B1, B2, A1, A2.

  2821. 		Each coefficient must be less than 2.0 and greater than -2.0.  The array

  2822. 		should be type double.  Alternately, it may be type int, where 1.0 is

  2823. 		represented with 1073741824 (2<sup>30</sup>).

  2824. 	</p>

  2825. 	<h3>Examples</h3>

  2826. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Effects &gt; Filter

  2827. 	</p>

  2828. 	<h3>Notes</h3>

  2829. 	<p>Filters can with gain must have their input signals attenuated, so the

  2830. 		signal does not exceed 1.0.

  2831. 	</p>

  2832. 	<p>This object implements up to 4 cascaded stages.  Unconfigured stages will

  2833. 		not pass any signal.

  2834. 	</p>

  2835. 	<p>Biquad filters with low corner frequency (under about 400 Hz) can run into

  2836. 		trouble with limited numerical precision, causing the filter to perform

  2837. 		poorly.  For very low corner frequency, the State Variable (Chamberlin)

  2838. 		filter should be used.

  2839. 	</p>

  2840. </script>

  2841. <script type="text/x-red" data-template-name="AudioFilterBiquad">

  2842. 	<div class="form-row">

  2843. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2844. 		<input type="text" id="node-input-name" placeholder="Name">

  2845. 	</div>

  2846. </script>

  2847. 

  2848. <script type="text/x-red" data-help-name="AudioFilterFIR">

  2849. 	<h3>Summary</h3>

  2850. 	<div class=tooltipinfo>

  2851. 	<p>Finite impulse response filter, useful for all sorts of filtering.

  2852. 	</p>

  2853. 	<p align=center><img src="img/fir_filter.png"></p>

  2854. 	</div>

  2855. 	<h3>Audio Connections</h3>

  2856. 	<table class=doc align=center cellpadding=3>

  2857. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  2858. 		<tr class=odd><td align=center>In 0</td><td>Signal to be filtered</td></tr>

  2859. 		<tr class=odd><td align=center>Out 0</td><td>Filtered Signal Output</td></tr>

  2860. 	</table>

  2861. 	<h3>Functions</h3>

  2862. 	<p class=func><span class=keyword>begin</span>(array, length);</p>

  2863. 	<p class=desc>Initialize the filter.  The array must be 16 bit integers (the

  2864. 		filter's impulse response), and

  2865. 		length indicates the number of points in the array.  Array may also be

  2866. 		FIR_PASSTHRU (length = 0), to directly pass the input to output without

  2867. 		filtering.

  2868. 	</p>

  2869. 	<p class=func><span class=keyword>end</span>();</p>

  2870. 	<p class=desc>Turn the filter off.

  2871. 	</p>

  2872. 	<h3>Examples</h3>

  2873. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Effects &gt; Filter_FIR

  2874. 	</p>

  2875. 	<h3>Known Issues</h3>

  2876. 	<p>Your filter's impulse response array must have an even length.  If you have

  2877. 		add odd number of taps, you must add an extra zero to increase the length

  2878. 		to an even number.

  2879. 	</p>

  2880. 	<p>The minimum number of taps is 4.  If you use less, add extra zeros to increase

  2881. 		the length to 4.

  2882. 	</p>

  2883. 	<p>The impulse response must be given in reverse order.  Many filters have

  2884. 		symetrical impluse response, making this a non-issue.  If your filter has

  2885. 		a non-symetrical response, make sure the data is in reverse time order.

  2886. 	</p>

  2887. 	<h3>Notes</h3>

  2888. 	<p>FIR filters requires more CPU time than Biquad (IIR), but they can

  2889. 		implement filters with better phase response.

  2890. 	</p>

  2891. 	<p>A 100 point filter requires 9% CPU time on Teensy 3.1.  The maximum

  2892. 		supported filter length is 200 points.

  2893. 	</p>

  2894. 	<p>The free

  2895. 		<a href="http://t-filter.engineerjs.com/" target="_blank"> TFilter Design Tool</a>

  2896. 		can be used to create the impulse response array.  Be sure to set the sampling

  2897. 		frequency to 44117 HZ (it defaults to only 2000 Hz) and the output type to "int" (16 bit).

  2898. 	</p>

  2899. 	<p>

  2900. 		If you use TFilter Design's "C/C++ array" option, it's output has "int" definition, which

  2901. 		is 32 bits on Teensy 3.1.  Edit "int" to "short" for an array of 16 bit numbers,

  2902. 		and add "const" to avoid consuming extra RAM.

  2903. 	</p>

  2904. </script>

  2905. <script type="text/x-red" data-template-name="AudioFilterFIR">

  2906. 	<div class="form-row">

  2907. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2908. 		<input type="text" id="node-input-name" placeholder="Name">

  2909. 	</div>

  2910. </script>

  2911. 

  2912. <script type="text/x-red" data-help-name="AudioFilterStateVariable">

  2913. 	<h3>Summary</h3>

  2914. 	<div class=tooltipinfo>

  2915. 	<p>A State Variable (Chamberlin) Filter with 12 dB/octave roll-off,

  2916. 		adjustable resonance, and optional signal control of corner

  2917. 		frequency.</p>

  2918. 	</div>

  2919. 	<h3>Audio Connections</h3>

  2920. 	<table class=doc align=center cellpadding=3>

  2921. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  2922. 		<tr class=odd><td align=center>In 0</td><td>Signal to Filter</td></tr>

  2923. 		<tr class=odd><td align=center>In 1</td><td>Frequency Control</td></tr>

  2924. 		<tr class=odd><td align=center>Out 0</td><td>Low Pass Output</td></tr>

  2925. 		<tr class=odd><td align=center>Out 1</td><td>Band Pass Output</td></tr>

  2926. 		<tr class=odd><td align=center>Out 2</td><td>High Pass Output</td></tr>

  2927. 	</table>

  2928. 	<h3>Functions</h3>

  2929. 	<p class=func><span class=keyword>frequency</span>(freq);</p>

  2930. 	<p class=desc>Set the filter's corner frequency.  When a signal is

  2931. 		connected to the control input, the filter will implement this

  2932. 		frequency when the signal is zero.

  2933. 	</p>

  2934. 	<p class=func><span class=keyword>resonance</span>(Q);</p>

  2935. 	<p class=desc>Set the filter's resonance.  Q ranges from 0.7 to 5.0.

  2936. 		Resonance greater than 0.707 will amplify the signal near the

  2937. 		corner frequency.  You must attenuate the signal before input

  2938. 		to this filter, to prevent clipping.

  2939. 	</p>

  2940. 	<p class=func><span class=keyword>octaveControl</span>(octaves);</p>

  2941. 	<p class=desc>Set how much (in octaves) the control signal can alter

  2942. 		the filter's corner freqency.  Range is 0 to 7 octaves.  For

  2943. 		example, when set to 2.5, a full scale positive signal (1.0) will

  2944. 		shift the filter frequency up 2.5 octaves, and a full scale negative

  2945. 		signal will shift it down 2.5 octaves.

  2946. 	</p>

  2947. 	<!--

  2948. <h3>Examples</h3>

  2949. 	<p class=exam>File &gt; Examples &gt; Audio &gt;

  2950. 	</p>

  2951. -->

  2952. 	<h3>Notes</h3>

  2953. 	<p>

  2954. 		When controlled by a signal, the equation for the filter

  2955. 		frequency is:

  2956. 	</p>

  2957. 	<p>

  2958. 		F = Fcenter * 2^<sup>(signal * octaves)</sup>

  2959. 		<br><small>If anyone knows how to do HTML equations, please

  2960. 		help me improve this.....</small>

  2961. 	</p>

  2962. 	<p>When operating with signal control of corner frequency, this

  2963. 		object uses approximately 4% of the CPU time on Teensy 3.1.

  2964. 	</p>

  2965. </script>

  2966. <script type="text/x-red" data-template-name="AudioFilterStateVariable">

  2967. 	<div class="form-row">

  2968. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  2969. 		<input type="text" id="node-input-name" placeholder="Name">

  2970. 	</div>

  2971. </script>

  2972. 

  2973. <script type="text/x-red" data-help-name="AudioAnalyzePeak">

  2974. 	<h3>Summary</h3>

  2975. 	<div class=tooltipinfo>

  2976. 	<p>Track the signal peak amplitude.  Very useful for simple

  2977. 		audio level response projects, and general troubleshooting.</p>

  2978. 	</div>

  2979. 	<h3>Audio Connections</h3>

  2980. 	<table class=doc align=center cellpadding=3>

  2981. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  2982. 		<tr class=odd><td align=center>In 0</td><td>Signal to analyze</td></tr>

  2983. 	</table>

  2984. 	<h3>Functions</h3>

  2985. 	<p class=func><span class=keyword>available</span>();</p>

  2986. 	<p class=desc>Returns true each time new peak data is available.

  2987. 	</p>

  2988. 	<p class=func><span class=keyword>read</span>();</p>

  2989. 	<p class=desc>Read the highest peak amplitude value since the last read.

  2990. 		Return is from 0.0 to 1.0.

  2991. 	</p>

  2992. 	<p class=func><span class=keyword>readPeakToPeak</span>();</p>

  2993. 	<p class=desc>Read the highest peak-to-peak amplitude since the last read.

  2994. 		Return is from 0.0 to 2.0.

  2995. 	</p>

  2996. 	<h3>Examples</h3>

  2997. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Analysis &gt; PeakMeterMono

  2998. 	</p>

  2999. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Analysis &gt; PeakMeterStereo

  3000. 	</p>

  3001. 	<h3>Notes</h3>

  3002. 	<p></p>

  3003. </script>

  3004. <script type="text/x-red" data-template-name="AudioAnalyzePeak">

  3005. 	<div class="form-row">

  3006. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  3007. 		<input type="text" id="node-input-name" placeholder="Name">

  3008. 	</div>

  3009. </script>

  3010. 

  3011. <script type="text/x-red" data-help-name="AudioAnalyzeRMS">

  3012. 	<h3>Summary</h3>

  3013. 	<div class=tooltipinfo>

  3014. 	<p>Track the signal RMS amplitude.  Useful for

  3015. 		audio level response projects, and general troubleshooting.</p>

  3016. 	</div>

  3017. 	<h3>Audio Connections</h3>

  3018. 	<table class=doc align=center cellpadding=3>

  3019. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  3020. 		<tr class=odd><td align=center>In 0</td><td>Signal to analyze</td></tr>

  3021. 	</table>

  3022. 	<h3>Functions</h3>

  3023. 	<p class=func><span class=keyword>available</span>();</p>

  3024. 	<p class=desc>Returns true if new RMS data is available.

  3025. 	</p>

  3026. 	<p class=func><span class=keyword>read</span>();</p>

  3027. 	<p class=desc>Read the new RMS value.

  3028. 		Return is from 0.0 to 1.0.

  3029. 	</p>

  3030. 	<h3>Examples</h3>

  3031. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Analysis &gt; PeakAndRMSMeterStereo</p>

  3032. 	</p>

  3033. 	<h3>Notes</h3>

  3034. 	<p></p>

  3035. </script>

  3036. <script type="text/x-red" data-template-name="AudioAnalyzeRMS">

  3037. 	<div class="form-row">

  3038. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  3039. 		<input type="text" id="node-input-name" placeholder="Name">

  3040. 	</div>

  3041. </script>

  3042. 

  3043. <script type="text/x-red" data-help-name="AudioAnalyzeFFT256">

  3044. 	<h3>Summary</h3>

  3045. 	<div class=tooltipinfo>

  3046. 	<p>Compute a 256 point Fast Fourier Transform (FFT) frequency analysis,

  3047. 		with real value (magnitude) output.  The frequency resolution is

  3048. 		172 Hz, useful for simple audio visualization.</p>

  3049. 	</div>

  3050. 	<h3>Audio Connections</h3>

  3051. 	<table class=doc align=center cellpadding=3>

  3052. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  3053. 		<tr class=odd><td align=center>In 0</td><td>Signal to convert to frequency bins</td></tr>

  3054. 	</table>

  3055. 	<h3>Functions</h3>

  3056. 	<p class=func><span class=keyword>available</span>();</p>

  3057. 	<p class=desc>Returns true each time the FFT analysis produces new output data.

  3058. 	</p>

  3059. 	<p class=func><span class=keyword>read</span>(binNumber);</p>

  3060. 	<p class=desc>Read a single frequency bin, from 0 to 127.  The result is scaled

  3061. 		so 1.0 represents a full scale sine wave.

  3062. 	</p>

  3063. 	<p class=func><span class=keyword>read</span>(firstBin, lastBin);</p>

  3064. 	<p class=desc>Read several frequency bins, returning their sum.  The higher

  3065. 		audio octaves are represented by many bins, which are typically read

  3066. 		as a group for audio visualization.

  3067. 	</p>

  3068. 	<p class=func><span class=keyword>averageTogether</span>(number);</p>

  3069. 	<p class=desc>New data is produced very radidly, approximately 344 times

  3070. 		per second.  Multiple outputs can be averaged together, so available()

  3071. 		returns true at a slower rate.

  3072. 	</p>

  3073. 	<p class=func><span class=keyword>windowFunction</span>(window);</p>

  3074. 	<p class=desc>Set the window function to be used.  AudioWindowHanning256

  3075. 		is the default.  Windowing may be disabled by NULL, but windowing

  3076. 		should be used for all non-periodic (music) signals, and all periodic

  3077. 		signals that are not exact integer division of the sample rate.

  3078. 	</p>

  3079. 

  3080. 	<h3>Examples</h3>

  3081. 	<p class=exam>File &gt; Examples &gt; Audio &gt; MemoryAndCpuUsage

  3082. 	</p>

  3083. 	<h3>Notes</h3>

  3084. 	<p>The raw 16 bit output data bins may be access with myFFT.output[num], where

  3085. 		num is 0 to 127.</p>

  3086. 	<p>TODO: caveats about spectral leakage vs frequency precision for arbitrary signals</p>

  3087. 	<p>Window Types:

  3088. 		<ul>

  3089. 		<li><span class=literal>AudioWindowHanning256</span> (default)</li>

  3090. 		<li><span class=literal>AudioWindowBartlett256</span></li>

  3091. 		<li><span class=literal>AudioWindowBlackman256</span></li>

  3092. 		<li><span class=literal>AudioWindowFlattop256</span></li>

  3093. 		<li><span class=literal>AudioWindowBlackmanHarris256</span></li>

  3094. 		<li><span class=literal>AudioWindowNuttall256</span></li>

  3095. 		<li><span class=literal>AudioWindowBlackmanNuttall256</span></li>

  3096. 		<li><span class=literal>AudioWindowWelch256</span></li>

  3097. 		<li><span class=literal>AudioWindowHamming256</span></li>

  3098. 		<li><span class=literal>AudioWindowCosine256</span></li>

  3099. 		<li><span class=literal>AudioWindowTukey256</span></li>

  3100. 		</ul>

  3101. 	</p>

  3102. </script>

  3103. <script type="text/x-red" data-template-name="AudioAnalyzeFFT256">

  3104. 	<div class="form-row">

  3105. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  3106. 		<input type="text" id="node-input-name" placeholder="Name">

  3107. 	</div>

  3108. </script>

  3109. 

  3110. <script type="text/x-red" data-help-name="AudioAnalyzeFFT1024">

  3111. 	<h3>Summary</h3>

  3112. 	<div class=tooltipinfo>

  3113. 	<p>Compute a 1024 point Fast Fourier Transform (FFT) frequency analysis,

  3114. 		with real value (magnitude) output.  The frequency resolution is

  3115. 		43 Hz, useful detailed for audio visualization.</p>

  3116. 	</div>

  3117. 	<h3>Audio Connections</h3>

  3118. 	<table class=doc align=center cellpadding=3>

  3119. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  3120. 		<tr class=odd><td align=center>In 0</td><td>Signal to convert to frequency bins</td></tr>

  3121. 	</table>

  3122. 	<h3>Functions</h3>

  3123. 	<p class=func><span class=keyword>available</span>();</p>

  3124. 	<p class=desc>Returns true each time the FFT analysis produces new output data.

  3125. 	</p>

  3126. 	<p class=func><span class=keyword>read</span>(binNumber);</p>

  3127. 	<p class=desc>Read a single frequency bin, from 0 to 511.  The result is scaled

  3128. 		so 1.0 represents a full scale sine wave.

  3129. 	</p>

  3130. 	<p class=func><span class=keyword>read</span>(firstBin, lastBin);</p>

  3131. 	<p class=desc>Read several frequency bins, returning their sum.  The higher

  3132. 		audio octaves are represented by many bins, which are typically read

  3133. 		as a group for audio visualization.

  3134. 	</p>

  3135. 	<p class=func><span class=keyword>averageTogether</span>(number);</p>

  3136. 	<p class=desc>This function does nothing.  The 1024 point FFT always

  3137. 		updates at approximately 86 times per second.

  3138. 	</p>

  3139. 	<p class=func><span class=keyword>windowFunction</span>(window);</p>

  3140. 	<p class=desc>Set the window function to be used.  AudioWindowHanning1024

  3141. 		is the default.  Windowing may be disabled by NULL, but windowing

  3142. 		should be used for all non-periodic (music) signals, and all periodic

  3143. 		signals that are not exact integer division of the sample rate.

  3144. 	</p>

  3145. 	<h3>Examples</h3>

  3146. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Analysis &gt; FFT

  3147. 	</p>

  3148. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Analysis &gt; SpectrumAnalyzerBasic

  3149. 	</p>

  3150. 	<h3>Notes</h3>

  3151. 	<p>The raw 16 bit output data bins may be access with myFFT.output[num], where

  3152. 		num is 0 to 511.</p>

  3153. 	<p>TODO: caveats about spectral leakage vs frequency precision for arbitrary signals</p>

  3154. 	<p>Window Types:

  3155. 		<ul>

  3156. 		<li><span class=literal>AudioWindowHanning1024</span> (default)</li>

  3157. 		<li><span class=literal>AudioWindowBartlett1024</span></li>

  3158. 		<li><span class=literal>AudioWindowBlackman1024</span></li>

  3159. 		<li><span class=literal>AudioWindowFlattop1024</span></li>

  3160. 		<li><span class=literal>AudioWindowBlackmanHarris1024</span></li>

  3161. 		<li><span class=literal>AudioWindowNuttall1024</span></li>

  3162. 		<li><span class=literal>AudioWindowBlackmanNuttall1024</span></li>

  3163. 		<li><span class=literal>AudioWindowWelch1024</span></li>

  3164. 		<li><span class=literal>AudioWindowHamming1024</span></li>

  3165. 		<li><span class=literal>AudioWindowCosine1024</span></li>

  3166. 		<li><span class=literal>AudioWindowTukey1024</span></li>

  3167. 		</ul>

  3168. 	</p>

  3169. 	<p>1024 point FFT has a peak CPU usage of approx 52% on Teensy 3.1.

  3170. 		Average usage is much lower.  Future versions might distribute the

  3171. 		load more evenly over time....

  3172. 	</p>

  3173. </script>

  3174. <script type="text/x-red" data-template-name="AudioAnalyzeFFT1024">

  3175. 	<div class="form-row">

  3176. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  3177. 		<input type="text" id="node-input-name" placeholder="Name">

  3178. 	</div>

  3179. </script>

  3180. 

  3181. <script type="text/x-red" data-help-name="AudioAnalyzeToneDetect">

  3182. 	<h3>Summary</h3>

  3183. 	<div class=tooltipinfo>

  3184. 	<p>Detect the level of a single tone</p>

  3185. 	</div>

  3186. 	<h3>Audio Connections</h3>

  3187. 	<table class=doc align=center cellpadding=3>

  3188. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  3189. 		<tr class=odd><td align=center>In 0</td><td>Signal to analyze</td></tr>

  3190. 	</table>

  3191. 	<h3>Functions</h3>

  3192. 	<p class=func><span class=keyword>frequency</span>(freq);</p>

  3193. 	<p class=desc>Set the frequency to detect.  The default detection time

  3194. 		will be 10 cycles of this frequency.

  3195. 	</p>

  3196. 	<p class=func><span class=keyword>frequency</span>(freq, cycles);</p>

  3197. 	<p class=desc>Set the frequency to detect, and the number of cycles.

  3198. 		Longer detection time (more cycles) will give higher precision,

  3199. 		but of course slower response.

  3200. 	</p>

  3201. 	<p class=func><span class=keyword>available</span>();</p>

  3202. 	<p class=desc>Returns true (non-zero) each time a detection interval

  3203. 		(number of cycles) completed and a new level is detected.

  3204. 	</p>

  3205. 	<p class=func><span class=keyword>read</span>();</p>

  3206. 	<p class=desc>Read the detected signal level.  Range is 0 to 1.0.

  3207. 	</p>

  3208. 	<p class=func><span class=keyword>threshold</span>(level);</p>

  3209. 	<p class=desc>Set a detection threshold, where the bool test operation

  3210. 		will return true if at or above this level, or false when below.

  3211. 	</p>

  3212. 	<p class=func>(bool)</p>

  3213. 	<p class=desc>By testing the object as a boolean value, you can respond

  3214. 		to detection of a tone.

  3215. 	</p>

  3216. 	<h3>Examples</h3>

  3217. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Analysis &gt; DialTone_Serial

  3218. 	</p>

  3219. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Analysis &gt; DialTone_7segment

  3220. 	</p>

  3221. 	<h3>Notes</h3>

  3222. 	<p>Low frequency detection has trouble with numerical precision.

  3223. 		Works really well for all 8 DTMF frequencies, but fails for

  3224. 		detecting "sub audible tones" used in some control applications.</p>

  3225. 	<p>The (bool) test continues to return true until the next detection

  3226. 		interval (the configured number of cycles).  This behavior may

  3227. 		change in future versions, for a single true each time the signal

  3228. 		is detected, and then false for the remainder of that interval.</p>

  3229. </script>

  3230. <script type="text/x-red" data-template-name="AudioAnalyzeToneDetect">

  3231. 	<div class="form-row">

  3232. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  3233. 		<input type="text" id="node-input-name" placeholder="Name">

  3234. 	</div>

  3235. </script>

  3236. 

  3237. <script type="text/x-red" data-help-name="AudioAnalyzeNoteFrequency">

  3238. 	<h3>Summary</h3>

  3239. 	<div class=tooltipinfo>

  3240. 	<p>Detect with fairly good accuracy the fundamental frequency f<sub>o</sub>

  3241. 		of musical notes, such as electric guitar and bass.</p>

  3242. 	</div>

  3243.     <p>Written By Collin Duffy</p>

  3244. 	<h3>Audio Connections</h3>

  3245. 	<table class=doc align=center cellpadding=3>

  3246. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  3247. 		<tr class=odd><td align=center>In 0</td><td>Signal to analyze</td></tr>

  3248. 	</table>

  3249. 	<h3>Functions</h3>

  3250. 	<p class=func><span class=keyword>begin</span>(threshold);</p>

  3251. 	<p class=desc>Initialize and start detecting frequencies,

  3252. 		with an initial threshold (the amount of allowed uncertainty).

  3253. 	</p>

  3254. 	<p class=func><span class=keyword>available</span>();</p>

  3255. 	<p class=desc>Returns true (non-zero) when a valid

  3256. 		frequency is detected.

  3257. 	</p>

  3258. 	<p class=func><span class=keyword>read</span>();</p>

  3259. 	<p class=desc>Read the detected frequency.

  3260. 	</p>

  3261. 	<p class=func><span class=keyword>probability</span>();</p>

  3262. 	<p class=desc>Return the level of certainty, betweeo 0 to 1.0.

  3263. 	</p>

  3264. 	<p class=func><span class=keyword>threshold</span>(level);</p>

  3265. 	<p class=desc>Set the detection threshold, the amount of allowed uncertainty.

  3266. 	</p>

  3267. 	<h3>Examples</h3>

  3268. 	<p class=exam>File &gt; Examples &gt; Audio &gt; Analysis &gt; NoteFrequency

  3269. 	</p>

  3270. 	<h3>Notes</h3>

  3271. 	<p>The <a href="http://recherche.ircam.fr/equipes/pcm/cheveign/pss/2002_JASA_YIN.pdf">YIN algorithm</a> (PDF)

  3272. 		is used to detect frequencies, with many optimizations for

  3273. 		frequencies between 29-400Hz.  This algorithm can be somewhat

  3274. 		memory and processor hungry but will allow you to detect with

  3275. 		fairly good accuracy the fundamental frequencies from

  3276. 		electric guitars and basses.</p>

  3277. 	<p>Within the code, AUDIO_GUITARTUNER_BLOCKS

  3278. 		may be edited to control low frequency range.  The default

  3279. 		(24) allows measurement down to 29.14 Hz, or B(flat)0.</p>

  3280. 	<p>TODO: The usable upper range of this object is not well known.

  3281. 		Duff says "it should be good up to 1000Hz", but may have trouble

  3282. 		at 4 kHz.  Please <a href="https://forum.pjrc.com/threads/32252-Different-Range-FFT-Algorithm/page2">post feedback here</a>, ideally with audio clips for the NoteFrequency example.</p>

  3283. 	<p>This object was contributed by Collin Duffy from his

  3284. 		<a href="https://github.com/duff2013/AudioTuner">AudioTuner project</a>.

  3285. 		Additional details and documentation may be found there.</p>

  3286. </script>

  3287. <script type="text/x-red" data-template-name="AudioAnalyzeNoteFrequency">

  3288. 	<div class="form-row">

  3289. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  3290. 		<input type="text" id="node-input-name" placeholder="Name">

  3291. 	</div>

  3292. </script>

  3293. 

  3294. <script type="text/x-red" data-help-name="AudioAnalyzePrint">

  3295. 	<h3>Summary</h3>

  3296. 	<div class=tooltipinfo>

  3297. 	<p>Print raw audio data to the Arduino Serial Monitor.  This

  3298. 		object creates massive output quickly, and should not normally be used.</p>

  3299. 	</div>

  3300. 	<h3>Audio Connections</h3>

  3301. 	<table class=doc align=center cellpadding=3>

  3302. 		<tr class=top><th>Port</th><th>Purpose</th></tr>

  3303. 		<tr class=odd><td align=center>In 0</td><td>Signal to print</td></tr>

  3304. 	</table>

  3305. 	<h3>Functions</h3>

  3306. 	<p class=func><span class=keyword>name</span>(string);</p>

  3307. 	<p class=desc>blah blah blah blah

  3308. 	</p>

  3309. 	<p class=func><span class=keyword>trigger</span>();</p>

  3310. 	<p class=desc>blah blah blah blah

  3311. 	</p>

  3312. 	<p class=func><span class=keyword>trigger</span>(level, edge);</p>

  3313. 	<p class=desc>blah blah blah blah

  3314. 	</p>

  3315. 	<p class=func><span class=keyword>delay</span>(samples);</p>

  3316. 	<p class=desc>blah blah blah blah

  3317. 	</p>

  3318. 	<p class=func><span class=keyword>length</span>(samples);</p>

  3319. 	<p class=desc>blah blah blah blah

  3320. 	</p>

  3321. 	<!--

  3322. <h3>Examples</h3>

  3323. 	<p class=exam>File &gt; Examples &gt; Audio &gt;

  3324. 	</p>

  3325. -->

  3326. 	<h3>Notes</h3>

  3327. 	<p>This object doesn't work very well and probably should not be used.</p>

  3328. </script>

  3329. <script type="text/x-red" data-template-name="AudioAnalyzePrint">

  3330. 	<div class="form-row">

  3331. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  3332. 		<input type="text" id="node-input-name" placeholder="Name">

  3333. 	</div>

  3334. </script>

  3335. 

  3336. <script type="text/x-red" data-help-name="AudioControlSGTL5000">

  3337. 	<h3>Summary</h3>

  3338. 	<div class=tooltipinfo>

  3339. 	<p>Control the SGTL5000 chip on the

  3340. 		<a href="http://www.pjrc.com/store/teensy3_audio.html" target="_blank">audio shield</a>.

  3341. 		SGTL5000 is always used in slave mode, where Teensy controls

  3342. 		all I2S timing.

  3343. 	</p>

  3344. 	<p align=center><img src="img/sgtl5000closeup.jpg"></p>

  3345. 	</div>

  3346. 	<h3>Audio Connections</h3>

  3347. 	<p>This object has no audio inputs or outputs.  Separate i2s objects

  3348. 		are used to send and receive audio data.  I2S master mode objects

  3349. 		must be used, because this object configures the SGTL5000 in slave

  3350. 		mode, where it depends on Teensy to provide all I2S clocks.

  3351. 		This object controls

  3352. 		how the SGTL5000 will use those I2S audio streams.</p>

  3353. 

  3354. 	<h3>Functions</h3>

  3355. 	<p>These are the most commonly used SGTL5000 functions.</p>

  3356. 	<p class=func><span class=keyword>enable</span>();</p>

  3357. 	<p class=desc>Start the SGTL5000.  This function should be called first.

  3358. 	</p>

  3359. 	<p class=func><span class=keyword>volume</span>(level);</p>

  3360. 	<p class=desc>Set the headphone volume level.  Range is 0 to 1.0, but

  3361. 		0.8 corresponds to the maximum undistorted output for a full scale

  3362. 		signal.  Usually 0.5 is a comfortable listening level.  The line

  3363. 		level outputs are <em>not</em> changed by this function.

  3364. 	</p>

  3365. 	<p class=func><span class=keyword>inputSelect</span>(input);</p>

  3366. 	<p class=desc>Select which input to use: AUDIO_INPUT_LINEIN or AUDIO_INPUT_MIC.

  3367. 	</p>

  3368. 	<p class=func><span class=keyword>micGain</span>(dB);</p>

  3369. 	<p class=desc>When using the microphone input, set the amplifier gain.

  3370. 		The input number is in decibels, from 0 to 63.

  3371. 	</p>

  3372. 

  3373. 	<h3>Signal Levels</h3>

  3374. 

  3375. 	<p>The default signal levels should be used for most applications,

  3376. 		but these functions allow you to customize the analog signals.</p>

  3377. 

  3378. 	<p class=func><span class=keyword>muteHeadphone</span>();</p>

  3379. 	<p class=desc>Silence the headphone output.

  3380. 	</p>

  3381. 	<p class=func><span class=keyword>unmuteHeadphone</span>();</p>

  3382. 	<p class=desc>Turn the headphone output on.

  3383. 	</p>

  3384. 	<p class=func><span class=keyword>muteLineout</span>();</p>

  3385. 	<p class=desc>Silence the line level outputs.

  3386. 	</p>

  3387. 	<p class=func><span class=keyword>unmuteLineout</span>();</p>

  3388. 	<p class=desc>Turn the line level outputs on.

  3389. 	</p>

  3390. 	<p class=func><span class=keyword>lineInLevel</span>(both);</p>

  3391. 	<p class=desc style="padding-bottom:0.2em;">Adjust the sensitivity of the line-level inputs.

  3392. 		Fifteen settings are possible:

  3393. 	</p>

  3394. <pre class="desc">

  3395.  0: 3.12 Volts p-p

  3396.  1: 2.63 Volts p-p

  3397.  2: 2.22 Volts p-p

  3398.  3: 1.87 Volts p-p

  3399.  4: 1.58 Volts p-p

  3400.  5: 1.33 Volts p-p  (default)

  3401.  6: 1.11 Volts p-p

  3402.  7: 0.94 Volts p-p

  3403.  8: 0.79 Volts p-p

  3404.  9: 0.67 Volts p-p

  3405. 10: 0.56 Volts p-p

  3406. 11: 0.48 Volts p-p

  3407. 12: 0.40 Volts p-p

  3408. 13: 0.34 Volts p-p

  3409. 14: 0.29 Volts p-p

  3410. 15: 0.24 Volts p-p

  3411. </pre>

  3412. 	<p class=func><span class=keyword>lineInLevel</span>(left, right);</p>

  3413. 	<p class=desc>Adjust the sensitivity of the line-level inputs, with different

  3414. 		settings for left and right.  The same 15 settings are available.

  3415. 	</p>

  3416. 	<p class=func><span class=keyword>lineOutLevel</span>(both);</p>

  3417. 	<p class=desc style="padding-bottom:0.2em;">Adjust the line level output

  3418. 		voltage range.  The following settings are possible:

  3419. 	</p>

  3420. <pre class="desc">

  3421. 13: 3.16 Volts p-p

  3422. 14: 2.98 Volts p-p

  3423. 15: 2.83 Volts p-p

  3424. 16: 2.67 Volts p-p

  3425. 17: 2.53 Volts p-p

  3426. 18: 2.39 Volts p-p

  3427. 19: 2.26 Volts p-p

  3428. 20: 2.14 Volts p-p

  3429. 21: 2.02 Volts p-p

  3430. 22: 1.91 Volts p-p

  3431. 23: 1.80 Volts p-p

  3432. 24: 1.71 Volts p-p

  3433. 25: 1.62 Volts p-p

  3434. 26: 1.53 Volts p-p

  3435. 27: 1.44 Volts p-p

  3436. 28: 1.37 Volts p-p

  3437. 29: 1.29 Volts p-p  (default)

  3438. 30: 1.22 Volts p-p

  3439. 31: 1.16 Volts p-p

  3440. </pre>

  3441. 	<p class=func><span class=keyword>lineOutLevel</span>(left, right);</p>

  3442. 	<p class=desc>Adjust the line level outout voltage range, with separate

  3443. 		settings for left and right.  The same settings (13 to 31) are available.

  3444. 	</p>

  3445. 

  3446. 

  3447. 	<h3>Signal Conditioning</h3>

  3448. 

  3449. 	<p>Usually these digital signal conditioning features should be left at their

  3450. 		default settings.

  3451. 	</p>

  3452. 

  3453. 	<p class=func><span class=keyword>adcHighPassFilterFreeze</span>();</p>

  3454. 	<p class=desc>By default, the analog input (either line-level inputs or mic)

  3455. 		is high-pass filtered, to remove any DC component.  This function

  3456. 		freezes the filter, so the current DC component is still substracted, but

  3457. 		the filter stops tracking any DC or low frequency changes.

  3458. 	</p>

  3459. 	<p class=func><span class=keyword>adcHighPassFilterDisable</span>();</p>

  3460. 	<p class=desc>Completely disable the analog input filter.  DC and sub-audible

  3461. 		low frequencies are allowed to enter the digital signal.  This

  3462. 		<a href="http://openaudio.blogspot.com/2017/03/teensy-audio-board-self-noise.html">may

  3463. 		reduce noise</a> in some cases.

  3464. 	</p>

  3465. 	<p class=func><span class=keyword>adcHighPassFilterEnable</span>();</p>

  3466. 	<p class=desc>Turn the DC-blocking filter back on, if disabled, or

  3467. 		allows it to resume tracking DC and low frequency changes, if

  3468. 		previously frozen. This is the default setting.

  3469. 	</p>

  3470. 	<p class=func><span class=keyword>dacVolume</span>(both);</p>

  3471. 	<p class=desc>Normally output volume should be used with volume(), which

  3472. 		changes the analog gain in the headphone amplifier.  This function

  3473. 		on the other hand controls digital attenuation before conversion to analog, which

  3474. 		reduces resolution, but allows another fine control of output

  3475. 		signal level.  The ranges is 0 to 1.0, with the default (no digital attenuation)

  3476. 		at 1.0.

  3477. 	</p>

  3478. 	<p  class=desc>dacVolume uses zero-crossing detect to avoid clicks, and graceful

  3479. 		ramping is handled by the chip so that a new volume may be set directly in

  3480. 		a single call.

  3481. 	</p>

  3482. 	<p class=func><span class=keyword>dacVolume</span>(left, right);</p>

  3483. 	<p class=desc>Adjust the digital output volume separately on left and

  3484. 		right channels.

  3485. 	</p>

  3486. 	<p class=func><span class=keyword>dacVolumeRamp</span>();</p>

  3487. 	<p class=desc>Enable graceful volume ramping.  The dacVolume adjusts gradually using

  3488. 		an exponential curve.  Pops or loud clicks are avoided when making large

  3489. 		changes in volume level.

  3490. 	</p>

  3491. 	<p class=func><span class=keyword>dacVolumeRampLinear</span>();</p>

  3492. 	<p class=desc>Enable faster volume ramping.  A slight click may be heard during a

  3493. 		large volume change.

  3494. 	</p>

  3495. 	<p class=func><span class=keyword>dacVolumeRampDisable</span>();</p>

  3496. 	<p class=desc>Do not use any gradual ramping.  The zero cross feature still helps

  3497. 		for small changes, but large volume changes may produce a pop or click.

  3498. 	</p>

  3499. 

  3500. 	<h3>Audio Processor</h3>

  3501. 

  3502. 	<p>The optional digital audio processor is capable of implementing

  3503. 		one or more of: automatic volume control, surround sound control,

  3504. 		bass enhancement, and tonal adjustments (either a

  3505. 		simple tone control, or a parametric equalizer, or a graphic equalizer),

  3506. 		in that order.

  3507. 	</p>

  3508. 	<p>These signal processing features are implemented in the SGTL5000 chip,

  3509. 		so they do not consume CPU time on Teensy. However, the order of

  3510. 		these processes is fixed in the hardware.

  3511. 	</p>

  3512. 	<p>It is good practice to mute the outputs before enabling or disabling

  3513. 	the Audio Processor, to avoid clicks or thumps.

  3514. 	</p>

  3515. 

  3516. 	<p class=func><span class=keyword>audioPreProcessorEnable</span>();</p>

  3517. 	<p class=desc>Enable the audio processor to pre-process the input

  3518. 		(from either line-level inputs or microphone) before it's sent

  3519. 		to Teensy by I2S.

  3520. 	</p>

  3521. 	<p class=func><span class=keyword>audioPostProcessorEnable</span>();</p>

  3522. 	<p class=desc>Enable the audio processor to post-process Teensy's

  3523. 		I2S output before it's turned into analog signals for the

  3524. 		headphones and/or line level outputs.

  3525. 	</p>

  3526. 	<p class=func><span class=keyword>audioProcessorDisable</span>();</p>

  3527. 	<p class=desc>Disable the audio processor.

  3528. 	</p>

  3529. 	<p class=func><span class=keyword>autoVolumeControl</span>(maxGain, response, hardLimit, threshold, attack, decay);</p>

  3530. 	<p class=desc>Configures the auto volume control, which is implemented as a compressor/expander

  3531. 	or hard limiter. 	<em>maxGain</em> is the maximum gain that can be applied for expanding, and

  3532. 	can take one of three values: 0 (0dB), 1 (6.0dB) and 2 (12dB). Values greater than 2 are treated

  3533. 	as 2. <em>response</em> controls the integration time for the compressor and can take

  3534. 	four values: 0 (0ms), 1 (25ms), 2 (50ms) or 3 (100ms). Larger values average the volume

  3535. 	over a longer time, allowing short-term peaks through.

  3536. 	</p>

  3537. 	<p class=desc>If <em>hardLimit</em> is 0, a 'soft

  3538. 	knee' compressor is used to progressively compress louder values which are near to or above the

  3539. 	threashold (the louder they are, the greater the compression). If it is 1, a hard compressor

  3540. 	is used (all values above the threashold are the same loudness). The <em>threashold</em> is specified

  3541. 	as a float in the range 0dBFS to -96dBFS, where -18dBFS is a typical value.

  3542. 	<em>attack</em> is a float controlling the rate of decrease in gain when the signal is over

  3543. 	threashold, in dB/s. <em>decay</em> controls how fast gain is restored once the level

  3544. 	drops below threashold, again in dB/s. It is typically set to a longer value than attack.

  3545. 	</p>

  3546. 	<p class=func><span class=keyword>autoVolumeEnable</span>();</p>

  3547. 	<p class=desc>Enables auto volume control, using the previously specified settings.

  3548. 	</p>

  3549. 	<p class=func><span class=keyword>autoVolumeDisable</span>();</p>

  3550. 	<p class=desc>Disables auto volume control.

  3551. 	</p>

  3552. 

  3553. 	<p class=func><span class=keyword>surroundSoundEnable</span>();</p>

  3554. 	<p class=desc>Enable virtual surround processing, to give a broader and

  3555. 	deeper stereo image (even with mono input).

  3556. 	</p>

  3557. 	<p class=func><span class=keyword>surroundSoundDisable</span>();</p>

  3558. 	<p class=desc>Disable virtual surround processing. Before disabling, ramp up

  3559. 	the width to maximum to avoid pops.

  3560. 	</p>

  3561. 	<p class=func><span class=keyword>surroundSound</span>(width);</p>

  3562. 	<p class=desc>Configures virtual surround width from 0 (mono) to 7 (widest).

  3563. 	</p>

  3564. 	<p class=func><span class=keyword>surroundSound</span>(width, select);</p>

  3565. 	<p class=desc>Configures virtual surround width from 0 (mono) to 7 (widest).

  3566. 	<em>select</em> may be set to 1 (disable), 2 (mono input) or 3 (stereo input).

  3567. 	</p>

  3568. 

  3569. 	<p class=func><span class=keyword>enhanceBassEnable</span>();</p>

  3570. 	<p class=desc>Enable bass enhancement. A mono, low-pass filtered copy of

  3571. 	the original stereo signal has bass levels boosted and is then mixed back into

  3572. 	the stereo signal, which is then optionally high pass filtered (to remove

  3573. 	inaudible subsonic frequencies).

  3574. 	</p>

  3575. 	<p class=func><span class=keyword>enhanceBassDisable</span>();</p>

  3576. 	<p class=desc>Disable bass enhancement. Before disabling, ramp down the bass

  3577. 	enhancement level to zero.

  3578. 	</p>

  3579. 	<p class=func><span class=keyword>enhanceBass</span>(lr_lev, bass_lev);</p>

  3580. 	<p class=desc>Configures the bass enhancement by setting the levels of the

  3581. 	original stereo signal and the bass-enhanced mono level which will be mixed together.

  3582. 	There is no high-pass filter.

  3583. 	</p>

  3584. 	<p  class=desc>When changing bass level, call this function repeatedly to ramp up or down the bass in

  3585. 	steps of 0.5dB, to avoid pops.

  3586. 	</p>

  3587. 	<p class=func><span class=keyword>enhanceBass</span>(lr_lev, bass_lev, hpf_bypass, cutoff);</p>

  3588. 	<p class=desc>Configures the bass enhancement by setting the levels of the

  3589. 	original stereo signal and the bass-enhanced mono level which will be mixed together.

  3590. 	The high-pass filter may be enabled (0) or bypassed (1). The cutoff frequency is specified

  3591. 	as follows:

  3592. 	</p>

  3593. 	<pre class="desc">

  3594. value  frequency

  3595.  0      80Hz

  3596.  1     100Hz

  3597.  2     125Hz

  3598.  3     150Hz

  3599.  4     175Hz

  3600.  5     200Hz

  3601.  6     225Hz

  3602. </pre>

  3603. 	<p  class=desc>When changing bass level, call this function repeatedly to ramp up or down the bass in

  3604. 	steps of 0.5dB, to avoid pops.

  3605. 	</p>

  3606. 

  3607. 	<p class=func><span class=keyword>eqSelect</span>(n);</p>

  3608. 	<p class=desc>Selects the type of frequency control, where <em>n</em> is

  3609. 	one of</p>

  3610. 	<p class=desc><b>FLAT_FREQUENCY (0)</b><br>

  3611.     Equalizers and tone controls disabled, flat frequency response.</p>

  3612.     <p class=desc><b>PARAMETRIC_EQUALIZER (1)</b><br>

  3613.     Enables the 7-band parametric equalizer, thus disabling the

  3614. 	tone controls and graphic equalizer.</p>

  3615.     <p class=desc><b>TONE_CONTROLS (2)</b><br>

  3616.     Enables bass and treble tone controls, disabling the parametric

  3617. 	equalization and graphic equalizer.</p>

  3618.     <p class=desc><b>GRAPHIC_EQUALIZER (3)</b><br>

  3619.     Enables the five-band graphic equalizer, disabling the parametric

  3620. 	equalization and tone controls.</p>

  3621. 

  3622. 

  3623. 	<p class=func><span class=keyword>eqBands</span>(bass, treble);</p>

  3624. 	<p class=desc>Configures bass and treble tone controls, which are

  3625. 	implemented as one second order low pass filter (bass) in parallel with

  3626. 	one second order high pass filter (treble).

  3627. 	</p>

  3628. 	<p class=desc>When changing bass or treble level, call this function repeatedly to ramp

  3629. 	up or down the level in steps of 0.04 (=0.5dB) or so, to avoid pops.

  3630. 	</p>

  3631. 	<p class=func><span class=keyword>eqBands</span>(bass, mid_bass, midrange, mid_treble, treble);</p>

  3632. 	<p class=desc>Configures the graphic equalizer. It is implemented by five parallel,

  3633. 	second order biquad filters with fixed frequencies of 115Hz, 330Hz, 990Hz, 3kHz,

  3634. 	and 9.9kHz. Each band has a range of adjustment from 1.00 (+12dB) to -1.00 (-11.75dB).

  3635. 	</p>

  3636. 	<p class=func><span class=keyword>eqBand</span>(bandNum, n);</p>

  3637. 	<p class=desc>Configures the gain or cut on one band in the graphic equalizer.

  3638. 	<em>bandnum</em> can range from 1 to 5; <em>n</em> is a float in the range 1.00 to -1.00.

  3639. 	</p>

  3640. 	<p  class=desc>When changing a band, call this function repeatedly to ramp up the gain in steps of 0.5dB,

  3641. 	to avoid pops.

  3642. 	</p>

  3643. 

  3644. 	<p class=func><span class=keyword>eqFilter</span>(filterNum, filterParameters);</p>

  3645. 	<p class=desc>Configurs the parametric equalizer. The number of filters (1 to 7)

  3646. 	is specified along with  a pointer to an array of filter coefficients.

  3647. 	The parametric equalizer is implemented using 7 cascaded, second order bi-quad

  3648. 	filters whose frequencies, gain, and Q may be freely configured, but each filter

  3649. 	can only be specified as a set of filter coefficients.

  3650. 	</p>

  3651. 	<p class=func><span class=keyword>eqFilterCount</span>(n);</p>

  3652. 	<p class=desc>Enables zero or more of the already enabled parametric filters.

  3653. 	</p>

  3654. 

  3655. 	<h3>Examples</h3>

  3656. 	<p>Nearly all of the library's examples use this object.  These

  3657. 		examples demonstrate its special features.

  3658. 	</p>

  3659. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; PassThroughStereo

  3660. 	</p>

  3661. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; SGTL5000 &gt; dap_bass_enhance

  3662. 	</p>

  3663. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; SGTL5000 &gt; dap_avc_agc

  3664. 	</p>

  3665. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; SGTL5000 &gt; balanceDAC

  3666. 	</p>

  3667. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; SGTL5000 &gt; balanceHP

  3668. 	</p>

  3669. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; SGTL5000 &gt; CalcBiquadToneControlDAP

  3670. 	</p>

  3671. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; SGTL5000 &gt; VolumeRamp

  3672. 	</p>

  3673. 	<h3>Notes</h3>

  3674. 	<p>TODO: add example with rock/classical/speech presets, where rock uses bass boost

  3675. 	and surround enhancement while speech uses bandpass filtering and auto volume control

  3676. 	compression.

  3677. 	</p>

  3678. 	<p>TODO: add example with two analogRead pots for bass and treble to demonstrate ramping.

  3679. 	</p>

  3680. </script>

  3681. <script type="text/x-red" data-template-name="AudioControlSGTL5000">

  3682. 	<div class="form-row">

  3683. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  3684. 		<input type="text" id="node-input-name" placeholder="Name">

  3685. 	</div>

  3686. </script>

  3687. 

  3688. <script type="text/x-red" data-help-name="AudioControlWM8731">

  3689. 	<h3>Summary</h3>

  3690. 	<div class=tooltipinfo>

  3691. 	<p>Control a WM8731 chip in slave mode, where it receives all clocks from Teensy</p>

  3692. 	</div>

  3693. 	<h3>Audio Connections</h3>

  3694. 	<p>This object has no audio inputs or outputs.  Separate i2s objects

  3695. 		are used to send and receive audio data.  I2S master mode objects

  3696. 		must be used, since this control object configures the WM8731 into

  3697. 		slave mode.

  3698. 	</p>

  3699. 	<h3>Functions</h3>

  3700. 	<p class=func><span class=keyword>enable</span>();</p>

  3701. 	<p class=desc>blah blah blah blah

  3702. 	</p>

  3703. 	<p class=func><span class=keyword>disable</span>();</p>

  3704. 	<p class=desc>not implemented

  3705. 	</p>

  3706. 	<p class=func><span class=keyword>volume</span>(level);</p>

  3707. 	<p class=desc>blah blah blah blah

  3708. 	</p>

  3709. 	<p class=func><span class=keyword>inputLevel</span>(level);</p>

  3710. 	<p class=desc>not implemented

  3711. 	</p>

  3712. 	<p class=func><span class=keyword>inputSelect</span>(input);</p>

  3713. 	<p class=desc>not implemented

  3714. 	</p>

  3715. 	<!--

  3716. <h3>Examples</h3>

  3717. 	<p class=exam>File &gt; Examples &gt; Audio &gt;

  3718. 	</p>

  3719. -->

  3720. 	<h3>Notes</h3>

  3721. 	<p></p>

  3722. </script>

  3723. <script type="text/x-red" data-template-name="AudioControlWM8731">

  3724. 	<div class="form-row">

  3725. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  3726. 		<input type="text" id="node-input-name" placeholder="Name">

  3727. 	</div>

  3728. </script>

  3729. 

  3730. <script type="text/x-red" data-help-name="AudioControlWM8731master">

  3731. 	<h3>Summary</h3>

  3732. 	<div class=tooltipinfo>

  3733. 	<p>Control a WM8731 chip in master mode, where it controls all I2S timing.</p>

  3734. 	</div>

  3735. 	<h3>Audio Connections</h3>

  3736. 	<p>This object has no audio inputs or outputs.  Separate i2s objects

  3737. 		are used to send and receive audio data.  I2S slave mode objects

  3738. 		must be used, since this control object configures the WM8731 into

  3739. 		master mode.

  3740. 	</p>

  3741. 	<h3>Functions</h3>

  3742. 	<p class=func><span class=keyword>enable</span>();</p>

  3743. 	<p class=desc>blah blah blah blah

  3744. 	</p>

  3745. 	<p class=func><span class=keyword>disable</span>();</p>

  3746. 	<p class=desc>not implemented

  3747. 	</p>

  3748. 	<p class=func><span class=keyword>volume</span>(level);</p>

  3749. 	<p class=desc>blah blah blah blah

  3750. 	</p>

  3751. 	<p class=func><span class=keyword>inputLevel</span>(level);</p>

  3752. 	<p class=desc>not implemented

  3753. 	</p>

  3754. 	<p class=func><span class=keyword>inputSelect</span>(input);</p>

  3755. 	<p class=desc>not implemented

  3756. 	</p>

  3757. 	<h3>Examples</h3>

  3758. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; WM8731MikroSine

  3759. 	</p>

  3760. 	<h3>Notes</h3>

  3761. 	<p></p>

  3762. </script>

  3763. <script type="text/x-red" data-template-name="AudioControlWM8731master">

  3764. 	<div class="form-row">

  3765. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  3766. 		<input type="text" id="node-input-name" placeholder="Name">

  3767. 	</div>

  3768. </script>

  3769. 

  3770. <script type="text/x-red" data-help-name="AudioControlAK4558">

  3771. 	<h3>Summary</h3>

  3772. 	<div class=tooltipinfo>

  3773. 	<p>Control the AK4558 chip on the <a href="https://hackaday.io/project/8567-hifi-audio-codec-module" target="_blank">HiFi Audio CODEC Module</a>

  3774. 	in slave mode, where the Teensy controls all I2S timing.</p>

  3775. 	</div>

  3776. 	<h3>Audio Connections</h3>

  3777. 	<p>This object has no audio inputs or outputs.  Separate I2S objects

  3778. 		are used to send and receive audio data.

  3779. 	</p>

  3780. 	<h3>Functions</h3>

  3781. 	<p class=func><span class=keyword>enable</span>();</p>

  3782. 	<p class=desc>Enables the CODEC to work with 44.1 KHz - 16 bit data. This function does not enable the ADC/DAC modules.

  3783. 	</p>

  3784. 	<p class=func><span class=keyword>enableIn</span>();</p>

  3785. 	<p class=desc>Enables the ADC module.

  3786. 	</p>

  3787. 	<p class=func><span class=keyword>enableOut</span>();</p>

  3788. 	<p class=desc>Enables the DAC module.

  3789. 	</p>

  3790. 	<p class=func><span class=keyword>disable</span>();</p>

  3791. 	<p class=desc>Disables the ADC and the DAC modules.

  3792. 	</p>

  3793. 	<p class=func><span class=keyword>disableIn</span>();</p>

  3794. 	<p class=desc>Disable the ADC module.

  3795. 	</p>

  3796. 	<p class=func><span class=keyword>disableOut</span>();</p>

  3797. 	<p class=desc>Disable the DAC module.

  3798. 	</p>

  3799. 	<p class=func><span class=keyword>volume</span>(level);</p>

  3800. 	<p class=desc>Accepts a float in range 0.0-1.0 and sets the line output volume accordingly.

  3801. 	</p>

  3802. 	<p class=func><span class=keyword>volumeLeft</span>(level);</p>

  3803. 	<p class=desc>Accepts a float in range 0.0-1.0 and sets the left line output volume accordingly.

  3804. 	</p>

  3805. 	<p class=func><span class=keyword>volumeRight</span>(level);</p>

  3806. 	<p class=desc>Accepts a float in range 0.0-1.0 and sets the right line output volume accordingly.

  3807. 	</p>

  3808. 	<p class=func><span class=keyword>inputLevel</span>(level);</p>

  3809. 	<p class=desc>NOT SUPPORTED BY THE AK4558

  3810. 	</p>

  3811. 	<p class=func><span class=keyword>inputSelect</span>(input);</p>

  3812. 	<p class=desc>not implemented yet

  3813. 	</p>

  3814. 	<h3>Examples</h3>

  3815. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; AK4558 &gt; PassthroughTest

  3816. 	</p>

  3817. 	<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; AK4558 &gt; SineOutTest

  3818. 	</p>

  3819. 	<h3>Notes</h3>

  3820. 	<p>TODO: Implement inputSelect() function to enable mono left, mono right, stereo operation.</p>

  3821. 	<p>TODO: Implement ADC and DAC filters control.</p>

  3822. 	<p>TODO: Implement DAC level attenuator attack rate modifier.</p>

  3823. </script>

  3824. <script type="text/x-red" data-template-name="AudioControlAK4558">

  3825. 	<div class="form-row">

  3826. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  3827. 		<input type="text" id="node-input-name" placeholder="Name">

  3828. 	</div>

  3829. </script>

  3830. 

  3831. <script type="text/x-red" data-help-name="AudioControlCS4272">

  3832. 	<h3>Summary</h3>

  3833. 	<div class=tooltipinfo>

  3834. 	<p>Control the CS4272 chip on the <a href="https://hackaday.io/project/5912-teensy-super-audio-board" target="_blank">Super Audio Board</a>.

  3835. 	</p>

  3836. 	<p>TODO: does this control object put the CS4272 into I2S master or slave mode</p>

  3837. 	</div>

  3838. 	<h3>Audio Connections</h3>

  3839. 	<p>This object has no audio inputs or outputs.  Separate I2S objects

  3840. 		are used to send and receive audio data.

  3841. 	</p>

  3842. 	<h3>Functions</h3>

  3843. 	<p class=func><span class=keyword>enable</span>();</p>

  3844. 	<p class=desc>Enables the CODEC to work with 44.1 KHz - 16 bit data. This function does not enable the ADC/DAC modules.

  3845. 	</p>

  3846. 	<p class=func><span class=keyword>volume</span>(vol);</p>

  3847. 	<p class=desc>Set the volume level. Range is 0 to 1.0.

  3848. 	</p>

  3849. 	<p class=func><span class=keyword>volume</span>(left, right);</p>

  3850. 	<p class=desc>Set the volume level. Range is 0 to 1.0.

  3851. 	</p>

  3852. 	<p class=func><span class=keyword>dacVolume</span>(vol);</p>

  3853. 	<p class=desc>Set the volume level. Range is 0 to 1.0.  TODO: what's the

  3854. 		distinction between volume() and dacVolume()?

  3855. 	</p>

  3856. 	<p class=func><span class=keyword>dacVolume</span>(left, right);</p>

  3857. 	<p class=desc>Set the volume level. Range is 0 to 1.0.

  3858. 	</p>

  3859. 

  3860. 	<p class=func><span class=keyword>muteOutput</span>();</p>

  3861. 	<p class=desc>TODO: description

  3862. 	</p>

  3863. 	<p class=func><span class=keyword>unmuteOutput</span>();</p>

  3864. 	<p class=desc>TODO: description

  3865. 	</p>

  3866. 	<p class=func><span class=keyword>muteInput</span>();</p>

  3867. 	<p class=desc>TODO: description

  3868. 	</p>

  3869. 	<p class=func><span class=keyword>unmuteInput</span>();</p>

  3870. 	<p class=desc>TODO: description

  3871. 	</p>

  3872. 	<p class=func><span class=keyword>enableDither</span>();</p>

  3873. 	<p class=desc>TODO: description

  3874. 	</p>

  3875. 	<p class=func><span class=keyword>disableDither</span>();</p>

  3876. 	<p class=desc>TODO: description

  3877. 	</p>

  3878. 

  3879. 	<h3>Hardware</h3>

  3880. 	<p>Pin 2 must be connected to the CS4272 reset.  SDA &amp; SCL are used for all control.

  3881. 	</p>

  3882. 

  3883. 	<h3>Notes</h3>

  3884. </script>

  3885. <script type="text/x-red" data-template-name="AudioControlCS4272">

  3886. 	<div class="form-row">

  3887. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  3888. 		<input type="text" id="node-input-name" placeholder="Name">

  3889. 	</div>

  3890. </script>

  3891. 

  3892. <script type="text/x-red" data-help-name="AudioControlCS42448">

  3893. 	<h3>Summary</h3>

  3894. 	<div class=tooltipinfo>

  3895. 	<p>Control the CS42448 chip in TDM mode, for 6 inputs and 8 outputs.

  3896. 	</p>

  3897. 	<p align=center><img src="img/cs42448.jpg"></p>

  3898. 	</div>

  3899. 	</div>

  3900. 	<h3>Audio Connections</h3>

  3901. 	<p>This object has no audio inputs or outputs.  Separate TDM objects

  3902. 		are used to send and receive audio data.

  3903. 	</p>

  3904. 	<h3>Functions</h3>

  3905. 	<p class=func><span class=keyword>enable</span>();</p>

  3906. 	<p class=desc>Enables the CS42448 to work in TDM mode.

  3907. 	</p>

  3908. 	<p class=func><span class=keyword>volume</span>(level);</p>

  3909. 	<p class=desc>Set the volume level for all output channels. Range is 0 to 1.0.

  3910. 	</p>

  3911. 	<p class=func><span class=keyword>volume</span>(channel, level);</p>

  3912. 	<p class=desc>Set the volume level for a single output. Channel is 1 to 8.  Range is 0 to 1.0.

  3913. 	</p>

  3914. 	<p class=func><span class=keyword>inputLevel</span>(level);</p>

  3915. 	<p class=desc>Set the input gain level for all input channels. Range is 0 to 15.85.

  3916. 	</p>

  3917. 	<p class=func><span class=keyword>inputLevel</span>(channel, level);</p>

  3918. 	<p class=desc>Set the input gain level for a single input. Channel is 1 to 6. Range is 0 to 15.85.

  3919. 	</p>

  3920. 	<h3>Hardware</h3>

  3921. 	<p>Tested with this <a href="https://oshpark.com/shared_projects/2Yj6rFaW">

  3922. 		CS42448 Circuit Board</a>.

  3923. 	</p>

  3924. 	<p align=center><img src="img/tdm.jpg"></p>

  3925. 	</div>

  3926. 	<h3>Notes</h3>

  3927. </script>

  3928. <script type="text/x-red" data-template-name="AudioControlCS42448">

  3929. 	<div class="form-row">

  3930. 		<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>

  3931. 		<input type="text" id="node-input-name" placeholder="Name">

  3932. 	</div>

  3933. </script>

  3934. 

  3935. 

  3936. 

  3937. </body>

  3938. </html>