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.

1338 lines
47KB

  1. <!-- vim: set ts=4: -->
  2. <!-- TODO: generate some or all of this automatically from the C++ source -->
  3. <!-- TODO: add a field for maximum instance count -->
  4. <!-- TODO: add a field for exclusive to other objects (not allowed if they're used) -->
  5. <!-- TODO: add "parameters" fields, to replace the form html stuff -->
  6. <script type="text/javascript">
  7. RED.nodes.registerType('AnalogInputI2S',{
  8. shortName: "i2s",
  9. inputs:0,
  10. outputs:2,
  11. category: 'input-function',
  12. color:"#E6E0F8",
  13. icon: "arrow-in.png"
  14. });
  15. </script>
  16. <script type="text/x-red" data-help-name="AnalogInputI2S">
  17. <h3>Summary</h3>
  18. <p>Receive 16 bit stereo audio from the
  19. <a href="http://www.pjrc.com/store/teensy3_audio.html" target="_blank">audio shield</a>
  20. or another I2S device, using I2S master mode.</p>
  21. <p align=center><img src="audioshield_inputs.jpg"></p>
  22. <h3>Audio Connections</h3>
  23. <table class=doc align=center cellpadding=3>
  24. <tr class=top><th>Port</th><th>Purpose</th></tr>
  25. <tr class=odd><td align=center>Out 0</td><td>Left Channel</td></tr>
  26. <tr class=odd><td align=center>Out 1</td><td>Right Channel</td></tr>
  27. </table>
  28. <h3>Functions</h3>
  29. <p>This object has no functions to call from the Arduino sketch. It
  30. simply streams data from the I2S hardware to its 2 output ports.</p>
  31. <h3>Hardware</h3>
  32. <p align=center><img src="audioshield_backside.jpg"></p>
  33. <p>The I2S signals are used in "master" mode, where Teensy creates
  34. all 3 clock signals and controls all data timing.</p>
  35. <table class=doc align=center cellpadding=3>
  36. <tr class=top><th>Pin</th><th>Signal</th><th>Direction</th></tr>
  37. <tr class=odd><td align=center>9</td><td>BCLK</td><td>Output</td></tr>
  38. <tr class=odd><td align=center>11</td><td>MCLK</td><td>Output</td></tr>
  39. <tr class=odd><td align=center>13</td><td>RX</td><td>Input</td></tr>
  40. <tr class=odd><td align=center>23</td><td>LRCLK</td><td>Output</td></tr>
  41. </table>
  42. <p>Audio from
  43. master mode I2S may be used in the same project as ADC, DAC and
  44. PWM signals, because all remain in sync to Teensy's timing</p>
  45. <h3>Notes</h3>
  46. <p>Normally, this object is used with the Audio Shield, which
  47. is controlled separately by the "sgtl5000" object.</p>
  48. </script>
  49. <script type="text/x-red" data-template-name="AnalogInputI2S">
  50. <div class="form-row">
  51. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  52. <input type="text" id="node-input-name" placeholder="Name">
  53. </div>
  54. </script>
  55. <script type="text/javascript">
  56. RED.nodes.registerType('AnalogInputI2Sslave',{
  57. shortName: "i2ss",
  58. inputs:0,
  59. outputs:2,
  60. category: 'input-function',
  61. color:"#E6E0F8",
  62. icon: "arrow-in.png"
  63. });
  64. </script>
  65. <script type="text/x-red" data-help-name="AnalogInputI2Sslave">
  66. <h3>Summary</h3>
  67. <p>Receive 16 bit stereo audio from an I2S device using I2S slave mode.</p>
  68. <h3>Audio Connections</h3>
  69. <table class=doc align=center cellpadding=3>
  70. <tr class=top><th>Port</th><th>Purpose</th></tr>
  71. <tr class=odd><td align=center>Out 0</td><td>Left Channel</td></tr>
  72. <tr class=odd><td align=center>Out 1</td><td>Right Channel</td></tr>
  73. </table>
  74. <h3>Functions</h3>
  75. <p>This object has no functions to call from the Arduino sketch. It
  76. simply streams data from the I2S hardware to its 2 output ports.</p>
  77. <h3>Hardware</h3>
  78. <p>The I2S signals are used in "slave" mode, where the I2S device controls
  79. data timing.</p>
  80. <table class=doc align=center cellpadding=3>
  81. <tr class=top><th>Pin</th><th>Signal</th><th>Direction</th></tr>
  82. <tr class=odd><td align=center>9</td><td>BCLK</td><td>Input</td></tr>
  83. <tr class=odd><td align=center>13</td><td>RX</td><td>Input</td></tr>
  84. <tr class=odd><td align=center>23</td><td>LRCLK</td><td>Input</td></tr>
  85. </table>
  86. <p>Slave mode I2S <b>should not used in the same project as ADC, DAC and
  87. PWM</b> signals. Differences in timing between the I2S device and
  88. Teensy's clock can cause occasional audio glitches when I2S slave mode
  89. is used together with other input or output objects based on Teensy's
  90. timing.</p>
  91. </script>
  92. <script type="text/x-red" data-template-name="AnalogInputI2Sslave">
  93. <div class="form-row">
  94. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  95. <input type="text" id="node-input-name" placeholder="Name">
  96. </div>
  97. </script>
  98. <script type="text/javascript">
  99. RED.nodes.registerType('AnalogInputADC',{
  100. shortName: "adc",
  101. inputs:0,
  102. outputs:1,
  103. category: 'input-function',
  104. color:"#E6E0F8",
  105. icon: "arrow-in.png"
  106. });
  107. </script>
  108. <script type="text/x-red" data-help-name="AnalogInputADC">
  109. <h3>Summary</h3>
  110. <p>Receive audio using the built-in analog to digital converter.</p>
  111. <h3>Audio Connections</h3>
  112. <table class=doc align=center cellpadding=3>
  113. <tr class=top><th>Port</th><th>Purpose</th></tr>
  114. <tr class=odd><td align=center>Out 0</td><td>Audio Channel</td></tr>
  115. </table>
  116. <h3>Parameters</h3>
  117. <table class=doc align=center cellpadding=3>
  118. <tr class=top><th>Name</th><th>Type</th><th>Function</th></tr>
  119. <tr class=odd><td align=center>Pin</td><td>Integer</td><td>Analog Pin To Use</td></tr>
  120. </table>
  121. <p>The pin number should be specified as "A0" to "A20"</p>
  122. <p align=center><img src="adcpins2.jpg"></p>
  123. <p align=center><img src="adcpins1.jpg"></p>
  124. <h3>Functions</h3>
  125. <p>This object has no functions to call from the Arduino sketch. It
  126. simply streams data from the ADC to its output port.</p>
  127. <h3>Hardware</h3>
  128. <p>Signal range is 0 to 1.2V</p>
  129. <p>Need for DC bias, approx 0.6V</p>
  130. <p>TODO: suggested circuity for signal input</p>
  131. <h3>Notes</h3>
  132. <p>Algorithm for automatic DC bias tracking</p>
  133. <p>Noise due to high source impedance</p>
  134. <p>Power Supply rejection issue with simple DC bias</p>
  135. <p>TODO: actual noise measurements with different input circuitry
  136. (it's not nearly as quiet as the audio shield)</p>
  137. </script>
  138. <script type="text/x-red" data-template-name="AnalogInputADC">
  139. <div class="form-row">
  140. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  141. <input type="text" id="node-input-name" placeholder="Name">
  142. </div>
  143. </script>
  144. <script type="text/javascript">
  145. RED.nodes.registerType('AnalogOutputI2S',{
  146. shortName: "i2s",
  147. inputs:2,
  148. outputs:0,
  149. category: 'output-function',
  150. color:"#E6E0F8",
  151. icon: "arrow-in.png"
  152. });
  153. </script>
  154. <script type="text/x-red" data-help-name="AnalogOutputI2S">
  155. <h3>Summary</h3>
  156. <p>Transmit 16 bit stereo audio to the
  157. <a href="http://www.pjrc.com/store/teensy3_audio.html" target="_blank">audio shield</a>
  158. or another I2S device, using I2S master mode.</p>
  159. <p align=center><img src="audioshield_outputs.jpg"></p>
  160. <h3>Audio Connections</h3>
  161. <table class=doc align=center cellpadding=3>
  162. <tr class=top><th>Port</th><th>Purpose</th></tr>
  163. <tr class=odd><td align=center>In 0</td><td>Left Channel</td></tr>
  164. <tr class=odd><td align=center>In 1</td><td>Right Channel</td></tr>
  165. </table>
  166. <h3>Functions</h3>
  167. <p>This object has no functions to call from the Arduino sketch. It
  168. simply streams data from its 2 input ports to the I2S hardware.</p>
  169. <h3>Hardware</h3>
  170. <p align=center><img src="audioshield_backside.jpg"></p>
  171. <p>The I2S signals are used in "master" mode, where Teensy creates
  172. all 3 clock signals and controls all data timing.</p>
  173. <table class=doc align=center cellpadding=3>
  174. <tr class=top><th>Pin</th><th>Signal</th><th>Direction</th></tr>
  175. <tr class=odd><td align=center>9</td><td>BCLK</td><td>Output</td></tr>
  176. <tr class=odd><td align=center>11</td><td>MCLK</td><td>Output</td></tr>
  177. <tr class=odd><td align=center>22</td><td>TX</td><td>Output</td></tr>
  178. <tr class=odd><td align=center>23</td><td>LRCLK</td><td>Output</td></tr>
  179. </table>
  180. <p>Audio from
  181. master mode I2S may be used in the same project as ADC, DAC and
  182. PWM signals, because all remain in sync to Teensy's timing</p>
  183. <h3>Notes</h3>
  184. <p>Normally, this object is used with the Audio Shield, which
  185. is controlled separately by the "sgtl5000" object.</p>
  186. </script>
  187. <script type="text/x-red" data-template-name="AnalogOutputI2S">
  188. <div class="form-row">
  189. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  190. <input type="text" id="node-input-name" placeholder="Name">
  191. </div>
  192. </script>
  193. <script type="text/javascript">
  194. RED.nodes.registerType('AnalogOutputI2Sslave',{
  195. shortName: "i2ss",
  196. inputs:2,
  197. outputs:0,
  198. category: 'output-function',
  199. color:"#E6E0F8",
  200. icon: "arrow-in.png"
  201. });
  202. </script>
  203. <script type="text/x-red" data-help-name="AnalogOutputI2Sslave">
  204. <h3>Summary</h3>
  205. <p>Transmit 16 bit stereo audio to an I2S device using I2S slave mode.</p>
  206. <h3>Audio Connections</h3>
  207. <table class=doc align=center cellpadding=3>
  208. <tr class=top><th>Port</th><th>Purpose</th></tr>
  209. <tr class=odd><td align=center>In 0</td><td>Left Channel</td></tr>
  210. <tr class=odd><td align=center>In 1</td><td>Right Channel</td></tr>
  211. </table>
  212. <h3>Functions</h3>
  213. <p>This object has no functions to call from the Arduino sketch. It
  214. simply streams data from its 2 input ports to the I2S hardware.</p>
  215. <h3>Hardware</h3>
  216. <p>The I2S signals are used in "slave" mode, where the I2S device controls
  217. data timing.</p>
  218. <table class=doc align=center cellpadding=3>
  219. <tr class=top><th>Pin</th><th>Signal</th><th>Direction</th></tr>
  220. <tr class=odd><td align=center>9</td><td>BCLK</td><td>Input</td></tr>
  221. <tr class=odd><td align=center>22</td><td>TX</td><td>Output</td></tr>
  222. <tr class=odd><td align=center>23</td><td>LRCLK</td><td>Input</td></tr>
  223. </table>
  224. <p>Slave mode I2S <b>should not used in the same project as ADC, DAC and
  225. PWM</b> signals. Differences in timing between the I2S device and
  226. Teensy's clock can cause occasional audio glitches when I2S slave mode
  227. is used together with other input or output objects based on Teensy's
  228. timing.</p>
  229. </script>
  230. <script type="text/x-red" data-template-name="AnalogOutputI2Sslave">
  231. <div class="form-row">
  232. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  233. <input type="text" id="node-input-name" placeholder="Name">
  234. </div>
  235. </script>
  236. <script type="text/javascript">
  237. RED.nodes.registerType('AnalogOutputAnalog',{
  238. shortName: "dac",
  239. inputs:1,
  240. outputs:0,
  241. category: 'output-function',
  242. color:"#E6E0F8",
  243. icon: "arrow-in.png"
  244. });
  245. </script>
  246. <script type="text/x-red" data-help-name="AnalogOutputAnalog">
  247. <h3>Summary</h3>
  248. <p>Transmit 12 bit audio using Teensy 3.1's built-in digital to analog converter.</p>
  249. <h3>Audio Connections</h3>
  250. <table class=doc align=center cellpadding=3>
  251. <tr class=top><th>Port</th><th>Purpose</th></tr>
  252. <tr class=odd><td align=center>In 0</td><td>Audio Channel</td></tr>
  253. </table>
  254. <h3>Functions</h3>
  255. <p>This object has no functions to call from the Arduino sketch. It
  256. simply streams data from the ADC to its output port.</p>
  257. <h3>Hardware</h3>
  258. <p align=center><img src="dacpin.jpg"></p>
  259. <p>Signal range is 0 to 1.2V</p>
  260. <p>Most applications require at least a 10&micro;F DC-blocking capacitor.</p>
  261. <p>TODO: photo of Teensy 3.1 with 10&micro;F capacitor and 3.5mm jack.</p>
  262. <h3>Notes</h3>
  263. <p>The output rate is 44.1 kHz (no oversampling). Ultrasonic noise present if
  264. not filtered. This may not
  265. be an issue for many uses, but care should be used if amplified and driven
  266. to high power tweeters.</p>
  267. </script>
  268. <script type="text/x-red" data-template-name="AnalogOutputAnalog">
  269. <div class="form-row">
  270. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  271. <input type="text" id="node-input-name" placeholder="Name">
  272. </div>
  273. </script>
  274. <script type="text/javascript">
  275. RED.nodes.registerType('AnalogOutputPWM',{
  276. shortName: "pwm",
  277. inputs:1,
  278. outputs:0,
  279. category: 'output-function',
  280. color:"#E6E0F8",
  281. icon: "arrow-in.png"
  282. });
  283. </script>
  284. <script type="text/x-red" data-help-name="AnalogOutputPWM">
  285. <h3>Summary</h3>
  286. <p>Transmit audio using Teensy 3.1's PWM pins. Two pins are
  287. used for coarse and fine pulses, to be combined by scaled
  288. resistors.</p>
  289. <h3>Audio Connections</h3>
  290. <table class=doc align=center cellpadding=3>
  291. <tr class=top><th>Port</th><th>Purpose</th></tr>
  292. <tr class=odd><td align=center>In 0</td><td>Audio Channel</td></tr>
  293. </table>
  294. <h3>Functions</h3>
  295. <p>This object has no functions to call from the Arduino sketch. It
  296. simply streams data from the its input port to the PWM pins.</p>
  297. <h3>Hardware</h3>
  298. <p>The following circuit is recommended.</p>
  299. <p align=center><img src="pwmdualcircuit.jpg"></p>
  300. <p>Signal range is approx 1.55 Vp-p.</p>
  301. <p>These resistor values assume approx 20 ohms output impedance
  302. on the digital pins. The 127K resistor may be adjusted or
  303. trimmed for variation in output drive and tolerance on the
  304. 475 ohm resistor.</p>
  305. <p>A plastic film (Polypropylene, Polyethylene, Polyester, etc) or
  306. C0G/NPO ceramic capacitor should be used for filtering. Low
  307. quality ceramic (X7R, Y5V, Z5U, etc) can cause signal distortion.</p>
  308. <h3>Notes</h3>
  309. <p>The PWM carrier frequency is 88.2 kHz. The suggested circuit
  310. will only slightly filter the carrier. Extra filtering will be
  311. required for a clean signals without the ultrasonic PWM carrier.
  312. </p>
  313. <p>Analog signals created by filtering PWM waveforms use the digital
  314. power supply as their reference voltage. Any noise on the digital
  315. power line can directly couple to the output signal. The built-in DAC or
  316. <a href="http://www.pjrc.com/store/teensy3_audio.html" target="_blank">audio shield</a>
  317. should be used when higher quality signals are needed.</p>
  318. </script>
  319. <script type="text/x-red" data-template-name="AnalogOutputPWM">
  320. <div class="form-row">
  321. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  322. <input type="text" id="node-input-name" placeholder="Name">
  323. </div>
  324. </script>
  325. <script type="text/javascript">
  326. RED.nodes.registerType('AudioMixer4',{
  327. shortName: "mixer",
  328. inputs:4,
  329. outputs:1,
  330. category: 'mixer-function',
  331. color:"#E6E0F8",
  332. icon: "arrow-in.png"
  333. });
  334. </script>
  335. <script type="text/x-red" data-help-name="AudioMixer4">
  336. <h3>Summary</h3>
  337. <p>Combine up to 4 audio signals together, each with adjustable gain.
  338. All channels support signal attenuation or amplification.</p>
  339. <h3>Audio Connections</h3>
  340. <table class=doc align=center cellpadding=3>
  341. <tr class=top><th>Port</th><th>Purpose</th></tr>
  342. <tr class=odd><td align=center>In 0</td><td>Input signal #1</td></tr>
  343. <tr class=odd><td align=center>In 1</td><td>Input signal #2</td></tr>
  344. <tr class=odd><td align=center>In 2</td><td>Input signal #3</td></tr>
  345. <tr class=odd><td align=center>In 3</td><td>Input signal #4</td></tr>
  346. <tr class=odd><td align=center>Out 0</td><td>Sum of all inputs</td></tr>
  347. </table>
  348. <h3>Functions</h3>
  349. <p class=func><span class=keyword>gain</span>(channel, level);</p>
  350. <p class=desc>Adjust the amplification or attenuation. "channel" must
  351. be 0 to 3. "level" may be any floating point number from 0 to 32767.
  352. 1.0 passes the signal through directly. Level of 0 shuts the channel
  353. off completely. Between 0 to 1.0 attenuates the signal, and above
  354. 1.0 amplifies it. All 4 channels have separate settings.
  355. </p>
  356. <h3>Notes</h3>
  357. <p>Signal clipping can occur when any channel has gain greater than 1.0,
  358. or when multiple signals add together to greater than 1.0.</p>
  359. <p>More than 4 channels may be combined by connecting multiple mixers
  360. in tandem. For example, a 16 channel mixer may be built using 5
  361. mixers, where the fifth mixer combines the outputs of the first 4.
  362. </p>
  363. </script>
  364. <script type="text/x-red" data-template-name="AudioMixer4">
  365. <div class="form-row">
  366. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  367. <input type="text" id="node-input-name" placeholder="Name">
  368. </div>
  369. </script>
  370. <script type="text/javascript">
  371. RED.nodes.registerType('AudioPlayMemory',{
  372. shortName: "playMem",
  373. inputs:0,
  374. outputs:1,
  375. category: 'play-function',
  376. color:"#E6E0F8",
  377. icon: "arrow-in.png"
  378. });
  379. </script>
  380. <script type="text/x-red" data-help-name="AudioPlayMemory">
  381. <h3>Summary</h3>
  382. <p>Play a short sound clip, stored directly in memory.
  383. Data files are created with the
  384. <a href="https://github.com/PaulStoffregen/Audio/tree/master/examples/PlayFromSketch/wav2sketch" target="_blank">wav2sketch program</a>,
  385. and copied to the sketch folder to become part of your sketch.</p>
  386. <h3>Audio Connections</h3>
  387. <table class=doc align=center cellpadding=3>
  388. <tr class=top><th>Port</th><th>Purpose</th></tr>
  389. <tr class=odd><td align=center>Out 0</td><td>Sound Output</td></tr>
  390. </table>
  391. <h3>Functions</h3>
  392. <p class=func><span class=keyword>play</span>(data);</p>
  393. <p class=desc>Begin playing a sound clip. If already playing, the
  394. currently playing clip is stopped and this new data begins
  395. playing from the beginning.
  396. </p>
  397. <p class=func><span class=keyword>stop</span>();</p>
  398. <p class=desc>Stop playing. If not playing, this function has no effect.
  399. </p>
  400. <p class=func><span class=keyword>isPlaying</span>();</p>
  401. <p class=desc>Return true (non-zero) if playing, or false (zero)
  402. when not playing.
  403. </p>
  404. <p class=func><span class=keyword>positionMillis</span>();</p>
  405. <p class=desc>While playing, return the current time offset, in
  406. milliseconds. When not playing, the return from this function
  407. is undefined.
  408. </p>
  409. <p class=func><span class=keyword>lengthMillis</span>();</p>
  410. <p class=desc>Return the total length of the current sound clip,
  411. in milliseconds. When not playing, the return from this function
  412. is undefined.
  413. </p>
  414. <h3>Notes</h3>
  415. <p>TODO: supported sample rates: 11.025, 22.05, 44.1</p>
  416. <p>TODO: ulaw vs uncompressed encoding</p>
  417. <p>Polyphonic playback can be built by creating multiple
  418. objects, with their output combined by mixers.</p>
  419. </script>
  420. <script type="text/x-red" data-template-name="AudioPlayMemory">
  421. <div class="form-row">
  422. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  423. <input type="text" id="node-input-name" placeholder="Name">
  424. </div>
  425. </script>
  426. <script type="text/javascript">
  427. RED.nodes.registerType('AudioPlaySdWav',{
  428. shortName: "playWav",
  429. inputs:0,
  430. outputs:2,
  431. category: 'play-function',
  432. color:"#E6E0F8",
  433. icon: "arrow-in.png"
  434. });
  435. </script>
  436. <script type="text/x-red" data-help-name="AudioPlaySdWav">
  437. <h3>Summary</h3>
  438. <p>Play a WAV file, stored on a SD card.</p>
  439. <h3>Audio Connections</h3>
  440. <table class=doc align=center cellpadding=3>
  441. <tr class=top><th>Port</th><th>Purpose</th></tr>
  442. <tr class=odd><td align=center>Out 0</td><td>Left Channel Output</td></tr>
  443. <tr class=odd><td align=center>Out 1</td><td>Right Channel Output</td></tr>
  444. </table>
  445. <h3>Functions</h3>
  446. <p class=func><span class=keyword>play</span>(filename);</p>
  447. <p class=desc>Begin playing a WAV file. If a file is already playing,
  448. it is stopped and this file starts playing from the beginning.
  449. </p>
  450. <p class=func><span class=keyword>stop</span>();</p>
  451. <p class=desc>Stop playing. If not playing, this function has no effect.
  452. </p>
  453. <p class=func><span class=keyword>isPlaying</span>();</p>
  454. <p class=desc>Return true (non-zero) if playing, or false (zero)
  455. when not playing. See the note below about delayed start.
  456. </p>
  457. <p class=func><span class=keyword>positionMillis</span>();</p>
  458. <p class=desc>While playing, return the current time offset, in
  459. milliseconds. When not playing, the return from this function
  460. is undefined.
  461. </p>
  462. <p class=func><span class=keyword>lengthMillis</span>();</p>
  463. <p class=desc>Return the total length of the current sound clip,
  464. in milliseconds. When not playing, the return from this function
  465. is undefined.
  466. </p>
  467. <h3>Notes</h3>
  468. <p>Only 16 bit PCM, 44100 Hz WAV files are supported. When mono
  469. files are played, both output ports transmit a copy of the
  470. single sound. Of course, stereo WAV files play with the left
  471. channel on port 0 and the right channel on port 1.
  472. </p>
  473. <p>A brief delay after calling play() will usually occur before
  474. isPlaying() returns true and positionMillis() returns valid
  475. time offset. WAV files have a header at the beginning of the
  476. file, which the audio library must read and parse before
  477. playing can begin.
  478. </p>
  479. <p>While playing, the audio library accesses the SD card automatically.
  480. If card access is required, you must
  481. <a href="http://www.pjrc.com/teensy/td_libs_AudioProcessorUsage.html" target="_blank">wav2sketch program</a> use AudioNoInterrupts()</a>
  482. to prevent the library from accessing the SD card while you use it.
  483. Disabling the audio library interrupt for too long may cause audible
  484. dropouts or glitches.
  485. </p>
  486. </script>
  487. <script type="text/x-red" data-template-name="AudioPlaySdWav">
  488. <div class="form-row">
  489. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  490. <input type="text" id="node-input-name" placeholder="Name">
  491. </div>
  492. </script>
  493. <script type="text/javascript">
  494. RED.nodes.registerType('AudioPlaySdRaw',{
  495. shortName: "playRaw",
  496. inputs:0,
  497. outputs:1,
  498. category: 'play-function',
  499. color:"#E6E0F8",
  500. icon: "arrow-in.png"
  501. });
  502. </script>
  503. <script type="text/x-red" data-help-name="AudioPlaySdRaw">
  504. <h3>Summary</h3>
  505. <p>Play a RAW data file, stored on a SD card. RAW format is simpler
  506. than WAV and begins playing immediately, without parsing WAV file
  507. header info.</p>
  508. <h3>Audio Connections</h3>
  509. <table class=doc align=center cellpadding=3>
  510. <tr class=top><th>Port</th><th>Purpose</th></tr>
  511. <tr class=odd><td align=center>Out 0</td><td>Sound Output</td></tr>
  512. </table>
  513. <h3>Functions</h3>
  514. <p class=func><span class=keyword>play</span>(filename);</p>
  515. <p class=desc>Begin playing a RAW data file. If a file is already playing,
  516. it is stopped and this file starts playing from the beginning.
  517. </p>
  518. <p class=func><span class=keyword>stop</span>();</p>
  519. <p class=desc>Stop playing. If not playing, this function has no effect.
  520. </p>
  521. <p class=func><span class=keyword>isPlaying</span>();</p>
  522. <p class=desc>Return true (non-zero) if playing, or false (zero)
  523. when not playing.
  524. </p>
  525. <p class=func><span class=keyword>positionMillis</span>();</p>
  526. <p class=desc>While playing, return the current time offset, in
  527. milliseconds. When not playing, the return from this function
  528. is undefined.
  529. </p>
  530. <p class=func><span class=keyword>lengthMillis</span>();</p>
  531. <p class=desc>Return the total length of the current sound clip,
  532. in milliseconds. When not playing, the return from this function
  533. is undefined.
  534. </p>
  535. <h3>Notes</h3>
  536. <p>The data file must be RAW 16 bit signed integers in LSB-first format.
  537. </p>
  538. <p>While playing, the audio library accesses the SD card automatically.
  539. If card access is required, you must
  540. <a href="http://www.pjrc.com/teensy/td_libs_AudioProcessorUsage.html" target="_blank">wav2sketch program</a> use AudioNoInterrupts()</a>
  541. to prevent the library from accessing the SD card while you use it.
  542. Disabling the audio library interrupt for too long may cause audible
  543. dropouts or glitches.
  544. </p>
  545. </script>
  546. <script type="text/x-red" data-template-name="AudioPlaySdRaw">
  547. <div class="form-row">
  548. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  549. <input type="text" id="node-input-name" placeholder="Name">
  550. </div>
  551. </script>
  552. <script type="text/javascript">
  553. RED.nodes.registerType('AudioPlayQueue',{
  554. shortName: "queue",
  555. inputs:0,
  556. outputs:1,
  557. category: 'play-function',
  558. color:"#E6E0F8",
  559. icon: "arrow-in.png"
  560. });
  561. </script>
  562. <script type="text/x-red" data-help-name="AudioPlayQueue">
  563. <h3>Summary</h3>
  564. <p>Play audio data provided by the Arduino sketch. This object provides
  565. functions to allow the sketch code to push data into the audio system.</p>
  566. <h3>Audio Connections</h3>
  567. <table class=doc align=center cellpadding=3>
  568. <tr class=top><th>Port</th><th>Purpose</th></tr>
  569. <tr class=odd><td align=center>Out 0</td><td>Sound Output</td></tr>
  570. </table>
  571. <h3>Functions</h3>
  572. <p class=func><span class=keyword>play</span>(int16);</p>
  573. <p class=desc>not yet implemented
  574. </p>
  575. <p class=func><span class=keyword>play</span>(int16[], length);</p>
  576. <p class=desc>not yet implemented
  577. </p>
  578. <p class=func><span class=keyword>getBuffer</span>();</p>
  579. <p class=desc>Returns a pointer to an array of 128 int16. This buffer
  580. is within the audio library memory pool, providing the most efficient
  581. way to input data to the audio system. The buffer is likely to be
  582. populated by previously used data, so the entire 128 words should be
  583. written before calling playBuffer(). Only a single buffer should be
  584. requested at a time. This function may return NULL if no memory is
  585. available.
  586. </p>
  587. <p class=func><span class=keyword>playBuffer</span>();</p>
  588. <p class=desc>Transmit the buffer previously obtained from getBuffer().
  589. </p>
  590. <h3>Notes</h3>
  591. <p>TODO: many caveats....</p>
  592. <p>
  593. </p>
  594. </script>
  595. <script type="text/x-red" data-template-name="AudioPlayQueue">
  596. <div class="form-row">
  597. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  598. <input type="text" id="node-input-name" placeholder="Name">
  599. </div>
  600. </script>
  601. <script type="text/javascript">
  602. RED.nodes.registerType('AudioSynthWaveformSine',{
  603. shortName: "sine",
  604. inputs:0,
  605. outputs:1,
  606. category: 'synth-function',
  607. color:"#E6E0F8",
  608. icon: "arrow-in.png"
  609. });
  610. </script>
  611. <script type="text/x-red" data-help-name="AudioSynthWaveformSine">
  612. <h3>Summary</h3>
  613. <p>Create a sine wave signal</p>
  614. <h3>Audio Connections</h3>
  615. <table class=doc align=center cellpadding=3>
  616. <tr class=top><th>Port</th><th>Purpose</th></tr>
  617. <tr class=odd><td align=center>Out 0</td><td>Sine Wave Output</td></tr>
  618. </table>
  619. <h3>Functions</h3>
  620. <p class=func><span class=keyword>frequency</span>(freq);</p>
  621. <p class=desc>Set the frequency, from 0 to 22000. Very low values may
  622. be used to create a LFO (Low Frequency Oscillator) for objects
  623. with modulation signal inputs.
  624. </p>
  625. <p class=func><span class=keyword>amplitude</span>(level);</p>
  626. <p class=desc>Set the amplitude, from 0 to 1.0.
  627. </p>
  628. <h3>Notes</h3>
  629. <p></p>
  630. </script>
  631. <script type="text/x-red" data-template-name="AudioSynthWaveformSine">
  632. <div class="form-row">
  633. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  634. <input type="text" id="node-input-name" placeholder="Name">
  635. </div>
  636. </script>
  637. <script type="text/javascript">
  638. RED.nodes.registerType('AudioSynthWaveformSineModulated',{
  639. shortName: "sine_fm",
  640. inputs:1,
  641. outputs:1,
  642. category: 'synth-function',
  643. color:"#E6E0F8",
  644. icon: "arrow-in.png"
  645. });
  646. </script>
  647. <script type="text/x-red" data-help-name="AudioSynthWaveformSineModulated">
  648. <h3>Summary</h3>
  649. <p>Create a modulated sine wave, using any audio signal to continuously
  650. modulate the sine wave frequency.</p>
  651. <h3>Audio Connections</h3>
  652. <table class=doc align=center cellpadding=3>
  653. <tr class=top><th>Port</th><th>Purpose</th></tr>
  654. <tr class=odd><td align=center>In 0</td><td>Modulation Signal</td></tr>
  655. <tr class=odd><td align=center>Out 0</td><td>Sine Wave Output</td></tr>
  656. </table>
  657. <h3>Functions</h3>
  658. <p class=func><span class=keyword>frequency</span>(freq);</p>
  659. <p class=desc>Set the center frequency, from 0 to 11000. The output will
  660. be this center frequency when the input modulation signal is zero.
  661. Modulation input 1.0 causes the frequency to double, and input -1.0
  662. causes zero Hz (DC) output. For less modulation, attenuate the input
  663. signal (perhaps with a mixer object) before it arrives here.
  664. </p>
  665. <p class=func><span class=keyword>amplitude</span>(level);</p>
  666. <p class=desc>Set the amplitude, from 0 to 1.0.
  667. </p>
  668. <h3>Notes</h3>
  669. <p></p>
  670. </script>
  671. <script type="text/x-red" data-template-name="AudioSynthWaveformSineModulated">
  672. <div class="form-row">
  673. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  674. <input type="text" id="node-input-name" placeholder="Name">
  675. </div>
  676. </script>
  677. <script type="text/javascript">
  678. RED.nodes.registerType('AudioSynthWaveform',{
  679. shortName: "waveform",
  680. inputs:0,
  681. outputs:1,
  682. category: 'synth-function',
  683. color:"#E6E0F8",
  684. icon: "arrow-in.png"
  685. });
  686. </script>
  687. <script type="text/x-red" data-help-name="AudioSynthWaveform">
  688. <h3>Summary</h3>
  689. <p>Create a waveform: sine, sawtooth, square, or triangle</p>
  690. <h3>Audio Connections</h3>
  691. <table class=doc align=center cellpadding=3>
  692. <tr class=top><th>Port</th><th>Purpose</th></tr>
  693. <tr class=odd><td align=center>Out 0</td><td>Waveform Output</td></tr>
  694. </table>
  695. <h3>Functions</h3>
  696. <p class=func><span class=keyword>begin</span>(level, frequency, waveform);</p>
  697. <p class=desc>blah blah blah blah
  698. </p>
  699. <p class=func><span class=keyword>frequency</span>(freq);</p>
  700. <p class=desc>blah blah blah blah
  701. </p>
  702. <p class=func><span class=keyword>amplitude</span>(level);</p>
  703. <p class=desc>blah blah blah blah
  704. <h3>Notes</h3>
  705. <p>Supported Waveforms:<br>
  706. <ul>
  707. <li><span class=literal>TONE_TYPE_SINE</span></li>
  708. <li><span class=literal>TONE_TYPE_SAWTOOTH</span></li>
  709. <li><span class=literal>TONE_TYPE_SQUARE</span></li>
  710. <li><span class=literal>TONE_TYPE_TRIANGLE</span></li>
  711. </ul>
  712. </p>
  713. </script>
  714. <script type="text/x-red" data-template-name="AudioSynthWaveform">
  715. <div class="form-row">
  716. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  717. <input type="text" id="node-input-name" placeholder="Name">
  718. </div>
  719. </script>
  720. <script type="text/javascript">
  721. RED.nodes.registerType('AudioSynthToneSweep',{
  722. shortName: "tonesweep",
  723. inputs:0,
  724. outputs:1,
  725. category: 'synth-function',
  726. color:"#E6E0F8",
  727. icon: "arrow-in.png"
  728. });
  729. </script>
  730. <script type="text/x-red" data-help-name="AudioSynthToneSweep">
  731. <h3>Summary</h3>
  732. <p>Create a continuously varying (in frequency) sine wave</p>
  733. <h3>Audio Connections</h3>
  734. <table class=doc align=center cellpadding=3>
  735. <tr class=top><th>Port</th><th>Purpose</th></tr>
  736. <tr class=odd><td align=center>Out 0</td><td>Continuously varying tone</td></tr>
  737. </table>
  738. <!--<h3>Parameters</h3>
  739. <table class=doc align=center cellpadding=3>
  740. <tr class=top><th>Name</th><th>Type</th><th>Function</th></tr>
  741. <tr class=odd><td align=center></td><td>Integer</td><td></td></tr>
  742. </table>
  743. <p>Extra description... Section only present if object has params</p>-->
  744. <h3>Functions</h3>
  745. <p class=func><span class=keyword>play</span>(level, lowFreq, highFreq, time);</p>
  746. <p class=desc>blah blah blah blah
  747. </p>
  748. <p class=func><span class=keyword>isPlaying</span>();</p>
  749. <p class=desc>blah blah blah blah
  750. </p>
  751. <h3>Notes</h3>
  752. <p>Uses excessive CPU time</p>
  753. </script>
  754. <script type="text/x-red" data-template-name="AudioSynthToneSweep">
  755. <div class="form-row">
  756. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  757. <input type="text" id="node-input-name" placeholder="Name">
  758. </div>
  759. </script>
  760. <script type="text/javascript">
  761. RED.nodes.registerType('AudioEffectFade',{
  762. shortName: "fade",
  763. inputs:1,
  764. outputs:1,
  765. category: 'effect-function',
  766. color:"#E6E0F8",
  767. icon: "arrow-in.png"
  768. });
  769. </script>
  770. <script type="text/x-red" data-help-name="AudioEffectFade">
  771. <h3>Summary</h3>
  772. <p>description</p>
  773. <h3>Audio Connections</h3>
  774. <table class=doc align=center cellpadding=3>
  775. <tr class=top><th>Port</th><th>Purpose</th></tr>
  776. <tr class=odd><td align=center></td><td></td></tr>
  777. </table>
  778. <h3>Functions</h3>
  779. <p class=func><span class=keyword>fadeIn</span>(milliseconds);</p>
  780. <p class=desc>blah blah blah blah
  781. </p>
  782. <p class=func><span class=keyword>fadeOut</span>(milliseconds);</p>
  783. <p class=desc>blah blah blah blah
  784. </p>
  785. <h3>Notes</h3>
  786. <p></p>
  787. </script>
  788. <script type="text/x-red" data-template-name="AudioEffectFade">
  789. <div class="form-row">
  790. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  791. <input type="text" id="node-input-name" placeholder="Name">
  792. </div>
  793. </script>
  794. <script type="text/javascript">
  795. RED.nodes.registerType('AudioEffectChorus',{
  796. shortName: "chorus",
  797. inputs:2,
  798. outputs:2,
  799. category: 'effect-function',
  800. color:"#E6E0F8",
  801. icon: "arrow-in.png"
  802. });
  803. </script>
  804. <script type="text/x-red" data-help-name="AudioEffectChorus">
  805. <h3>Summary</h3>
  806. <p>description</p>
  807. <h3>Audio Connections</h3>
  808. <table class=doc align=center cellpadding=3>
  809. <tr class=top><th>Port</th><th>Purpose</th></tr>
  810. <tr class=odd><td align=center></td><td></td></tr>
  811. </table>
  812. <!--<h3>Parameters</h3>
  813. <table class=doc align=center cellpadding=3>
  814. <tr class=top><th>Name</th><th>Type</th><th>Function</th></tr>
  815. <tr class=odd><td align=center></td><td>Integer</td><td></td></tr>
  816. </table>
  817. <p>Extra description... Section only present if object has params</p>-->
  818. <h3>Functions</h3>
  819. <p class=func><span class=keyword>begin</span>(delayBuffer, length, n_chorus);</p>
  820. <p class=desc>blah blah blah blah
  821. </p>
  822. <p class=func><span class=keyword>stop</span>();</p>
  823. <p class=desc>blah blah blah blah
  824. </p>
  825. <p class=func><span class=keyword>modify</span>(n_chorus);</p>
  826. <p class=desc>blah blah blah blah
  827. </p>
  828. <h3>Notes</h3>
  829. <p></p>
  830. </script>
  831. <script type="text/x-red" data-template-name="AudioEffectChorus">
  832. <div class="form-row">
  833. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  834. <input type="text" id="node-input-name" placeholder="Name">
  835. </div>
  836. </script>
  837. <script type="text/javascript">
  838. RED.nodes.registerType('AudioEffectFlange',{
  839. shortName: "flange",
  840. inputs:2,
  841. outputs:2,
  842. category: 'effect-function',
  843. color:"#E6E0F8",
  844. icon: "arrow-in.png"
  845. });
  846. </script>
  847. <script type="text/x-red" data-help-name="AudioEffectFlange">
  848. <h3>Summary</h3>
  849. <p>description</p>
  850. <h3>Audio Connections</h3>
  851. <table class=doc align=center cellpadding=3>
  852. <tr class=top><th>Port</th><th>Purpose</th></tr>
  853. <tr class=odd><td align=center></td><td></td></tr>
  854. </table>
  855. <!--<h3>Parameters</h3>
  856. <table class=doc align=center cellpadding=3>
  857. <tr class=top><th>Name</th><th>Type</th><th>Function</th></tr>
  858. <tr class=odd><td align=center></td><td>Integer</td><td></td></tr>
  859. </table>
  860. <p>Extra description... Section only present if object has params</p>-->
  861. <h3>Functions</h3>
  862. <p class=func><span class=keyword>begin</span>(delayBuffer, length, offset, depth, delayRate);</p>
  863. <p class=desc>blah blah blah blah
  864. </p>
  865. <p class=func><span class=keyword>modify</span>(offset, depth, delayRate);</p>
  866. <p class=desc>blah blah blah blah
  867. </p>
  868. <p class=func><span class=keyword>stop</span>();</p>
  869. <p class=desc>blah blah blah blah
  870. </p>
  871. <h3>Notes</h3>
  872. <p></p>
  873. </script>
  874. <script type="text/x-red" data-template-name="AudioEffectFlange">
  875. <div class="form-row">
  876. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  877. <input type="text" id="node-input-name" placeholder="Name">
  878. </div>
  879. </script>
  880. <script type="text/javascript">
  881. RED.nodes.registerType('AudioFilterBiquad',{
  882. shortName: "biquad",
  883. inputs:1,
  884. outputs:1,
  885. category: 'filter-function',
  886. color:"#E6E0F8",
  887. icon: "arrow-in.png"
  888. });
  889. </script>
  890. <script type="text/x-red" data-help-name="AudioFilterBiquad">
  891. <h3>Summary</h3>
  892. <p>description</p>
  893. <h3>Audio Connections</h3>
  894. <table class=doc align=center cellpadding=3>
  895. <tr class=top><th>Port</th><th>Purpose</th></tr>
  896. <tr class=odd><td align=center></td><td></td></tr>
  897. </table>
  898. <h3>Parameters</h3>
  899. <table class=doc align=center cellpadding=3>
  900. <tr class=top><th>Name</th><th>Type</th><th>Function</th></tr>
  901. <tr class=odd><td align=center></td><td>Integer</td><td></td></tr>
  902. </table>
  903. <p>Extra description... Section only present if object has params</p>
  904. <h3>Functions</h3>
  905. <p class=func><span class=keyword>function</span>(parm1, parm2);</p>
  906. <p class=desc>blah blah blah blah
  907. </p>
  908. <h3>Notes</h3>
  909. <p></p>
  910. </script>
  911. <script type="text/x-red" data-template-name="AudioFilterBiquad">
  912. <div class="form-row">
  913. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  914. <input type="text" id="node-input-name" placeholder="Name">
  915. </div>
  916. </script>
  917. <script type="text/javascript">
  918. RED.nodes.registerType('AudioFilterFIR',{
  919. shortName: "fir",
  920. inputs:1,
  921. outputs:1,
  922. category: 'filter-function',
  923. color:"#E6E0F8",
  924. icon: "arrow-in.png"
  925. });
  926. </script>
  927. <script type="text/x-red" data-help-name="AudioFilterFIR">
  928. <h3>Summary</h3>
  929. <p>description</p>
  930. <h3>Audio Connections</h3>
  931. <table class=doc align=center cellpadding=3>
  932. <tr class=top><th>Port</th><th>Purpose</th></tr>
  933. <tr class=odd><td align=center></td><td></td></tr>
  934. </table>
  935. <!--<h3>Parameters</h3>
  936. <table class=doc align=center cellpadding=3>
  937. <tr class=top><th>Name</th><th>Type</th><th>Function</th></tr>
  938. <tr class=odd><td align=center></td><td>Integer</td><td></td></tr>
  939. </table>
  940. <p>Extra description... Section only present if object has params</p>-->
  941. <h3>Functions</h3>
  942. <p class=func><span class=keyword>function</span>(parm1, parm2);</p>
  943. <p class=desc>blah blah blah blah
  944. </p>
  945. <h3>Notes</h3>
  946. <p></p>
  947. </script>
  948. <script type="text/x-red" data-template-name="AudioFilterFIR">
  949. <div class="form-row">
  950. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  951. <input type="text" id="node-input-name" placeholder="Name">
  952. </div>
  953. </script>
  954. <script type="text/javascript">
  955. RED.nodes.registerType('AudioPeak',{
  956. shortName: "peak",
  957. inputs:1,
  958. outputs:0,
  959. category: 'analyze-function',
  960. color:"#E6E0F8",
  961. icon: "arrow-in.png"
  962. });
  963. </script>
  964. <script type="text/x-red" data-help-name="AudioPeak">
  965. <h3>Summary</h3>
  966. <p>description</p>
  967. <h3>Audio Connections</h3>
  968. <table class=doc align=center cellpadding=3>
  969. <tr class=top><th>Port</th><th>Purpose</th></tr>
  970. <tr class=odd><td align=center></td><td></td></tr>
  971. </table>
  972. <!--<h3>Parameters</h3>
  973. <table class=doc align=center cellpadding=3>
  974. <tr class=top><th>Name</th><th>Type</th><th>Function</th></tr>
  975. <tr class=odd><td align=center></td><td>Integer</td><td></td></tr>
  976. </table>
  977. <p>Extra description... Section only present if object has params</p>-->
  978. <h3>Functions</h3>
  979. <p class=func><span class=keyword>function</span>(parm1, parm2);</p>
  980. <p class=desc>blah blah blah blah
  981. </p>
  982. <h3>Notes</h3>
  983. <p></p>
  984. </script>
  985. <script type="text/x-red" data-template-name="AudioPeak">
  986. <div class="form-row">
  987. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  988. <input type="text" id="node-input-name" placeholder="Name">
  989. </div>
  990. </script>
  991. <script type="text/javascript">
  992. RED.nodes.registerType('AudioAnalyzeFFT256',{
  993. shortName: "fft256",
  994. inputs:1,
  995. outputs:0,
  996. category: 'analyze-function',
  997. color:"#E6E0F8",
  998. icon: "arrow-in.png"
  999. });
  1000. </script>
  1001. <script type="text/x-red" data-help-name="AudioAnalyzeFFT256">
  1002. <h3>Summary</h3>
  1003. <p>Compute a 256 point Fast Fourier Transform (FFT) frequency analysis,
  1004. with real value (magnitude) output, with frequency resolution of
  1005. approx 172 Hz, useful for simple audio visualization.</p>
  1006. <h3>Audio Connections</h3>
  1007. <table class=doc align=center cellpadding=3>
  1008. <tr class=top><th>Port</th><th>Purpose</th></tr>
  1009. <tr class=odd><td align=center>In 0</td><td>Signal to convert to frequency bins</td></tr>
  1010. </table>
  1011. <h3>Parameters</h3>
  1012. <table class=doc align=center cellpadding=3>
  1013. <tr class=top><th>Name</th><th>Type</th><th>Function</th></tr>
  1014. <tr class=odd><td align=center>Num</td><td>Integer</td><td># FFTs to average</td></tr>
  1015. <tr class=odd><td align=center>Window</td><td>Array</td><td>Window method to use</td></tr>
  1016. </table>
  1017. <p>Extra description... Section only present if object has params</p>
  1018. <h3>Functions</h3>
  1019. <p class=func><span class=keyword>available</span>();</p>
  1020. <p class=desc>Returns true each time the FFT analysis produces new output data.
  1021. </p>
  1022. <h3>Notes</h3>
  1023. <p>The raw 16 bit output data bins may be access with myFFT.output[num], where
  1024. num is 0 to 127.</p>
  1025. <p>TODO: caveats about spectral leakage vs frequency precision for arbitrary signals</p>
  1026. <p>Known bug in the library limits to only a single instance of this object.
  1027. This bug will be fixed someday... allowing 2 or more FFTs to run on simultaneously.</p>
  1028. <p>Window Types:
  1029. <ul>
  1030. <li><span class=literal>AudioWindowHanning256</span> (default)</li>
  1031. <li><span class=literal>AudioWindowBartlett256</span></li>
  1032. <li><span class=literal>AudioWindowBlackman256</span></li>
  1033. <li><span class=literal>AudioWindowFlattop256</span></li>
  1034. <li><span class=literal>AudioWindowBlackmanHarris256</span></li>
  1035. <li><span class=literal>AudioWindowNuttall256</span></li>
  1036. <li><span class=literal>AudioWindowBlackmanNuttall256</span></li>
  1037. <li><span class=literal>AudioWindowWelch256</span></li>
  1038. <li><span class=literal>AudioWindowHamming256</span></li>
  1039. <li><span class=literal>AudioWindowCosine256</span></li>
  1040. <li><span class=literal>AudioWindowTukey256</span></li>
  1041. </ul>
  1042. </p>
  1043. </script>
  1044. <script type="text/x-red" data-template-name="AudioAnalyzeFFT256">
  1045. <div class="form-row">
  1046. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  1047. <input type="text" id="node-input-name" placeholder="Name">
  1048. </div>
  1049. </script>
  1050. <script type="text/javascript">
  1051. RED.nodes.registerType('AudioAnalyzeFFT1024',{
  1052. shortName: "fft1024",
  1053. inputs:1,
  1054. outputs:0,
  1055. category: 'analyze-function',
  1056. color:"#E6E0F8",
  1057. icon: "arrow-in.png"
  1058. });
  1059. </script>
  1060. <script type="text/x-red" data-help-name="AudioAnalyzeFFT1024">
  1061. <h3>Summary</h3>
  1062. <p>Compute a 1024 point Fast Fourier Transform (FFT) frequency analysis,
  1063. with real value (magnitude) output, with frequency resolution of
  1064. approx 43 Hz, useful detailed for audio visualization.</p>
  1065. <h3>Audio Connections</h3>
  1066. <table class=doc align=center cellpadding=3>
  1067. <tr class=top><th>Port</th><th>Purpose</th></tr>
  1068. <tr class=odd><td align=center>In 0</td><td>Signal to convert to frequency bins</td></tr>
  1069. </table>
  1070. <h3>Parameters</h3>
  1071. <table class=doc align=center cellpadding=3>
  1072. <tr class=top><th>Name</th><th>Type</th><th>Function</th></tr>
  1073. <tr class=odd><td align=center>Num</td><td>Integer</td><td># FFTs to average</td></tr>
  1074. <tr class=odd><td align=center>Window</td><td>Array</td><td>Window method to use</td></tr>
  1075. </table>
  1076. <p>Extra description... Section only present if object has params</p>
  1077. <h3>Functions</h3>
  1078. <p class=func><span class=keyword>available</span>();</p>
  1079. <p class=desc>Returns true each time the FFT analysis produces new output data.
  1080. </p>
  1081. <h3>Notes</h3>
  1082. <p>1024 point FFT uses approx 50% of the CPU power on Teensy 3.1</p>
  1083. <p>The raw 16 bit output data bins may be access with myFFT.output[num], where
  1084. num is 0 to 511.</p>
  1085. <p>TODO: caveats about spectral leakage vs frequency precision for arbitrary signals</p>
  1086. <p>Known bug in the library limits to only a single instance of this object.
  1087. This bug will be fixed someday... but 2 instances may not run due to CPU limitation</p>
  1088. <p>Window Types:
  1089. <ul>
  1090. <li><span class=literal>AudioWindowHanning1024</span> (default)</li>
  1091. </ul>
  1092. </p>
  1093. </script>
  1094. <script type="text/x-red" data-template-name="AudioAnalyzeFFT1024">
  1095. <div class="form-row">
  1096. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  1097. <input type="text" id="node-input-name" placeholder="Name">
  1098. </div>
  1099. </script>
  1100. <script type="text/javascript">
  1101. RED.nodes.registerType('AudioAnalyzeToneDetect',{
  1102. shortName: "tone",
  1103. inputs:1,
  1104. outputs:0,
  1105. category: 'analyze-function',
  1106. color:"#E6E0F8",
  1107. icon: "arrow-in.png"
  1108. });
  1109. </script>
  1110. <script type="text/x-red" data-help-name="AudioAnalyzeToneDetect">
  1111. <h3>Summary</h3>
  1112. <p>Detect the level of a single tone</p>
  1113. <h3>Audio Connections</h3>
  1114. <table class=doc align=center cellpadding=3>
  1115. <tr class=top><th>Port</th><th>Purpose</th></tr>
  1116. <tr class=odd><td align=center></td><td></td></tr>
  1117. </table>
  1118. <h3>Functions</h3>
  1119. <p class=func><span class=keyword>frequency</span>(freq);</p>
  1120. <p class=desc>blah blah blah blah
  1121. </p>
  1122. <p class=func><span class=keyword>available</span>();</p>
  1123. <p class=desc>blah blah blah blah
  1124. </p>
  1125. <p class=func><span class=keyword>read</span>();</p>
  1126. <p class=desc>blah blah blah blah
  1127. </p>
  1128. <p class=func><span class=keyword>threshold</span>(level);</p>
  1129. <p class=desc>blah blah blah blah
  1130. </p>
  1131. <p class=func>(bool)</p>
  1132. <p class=desc>blah blah blah blah
  1133. </p>
  1134. <h3>Notes</h3>
  1135. <p>Low frequency detection has trouble with numerical precision.
  1136. Works really well for all 8 DTMF frequencies, but fails for
  1137. detecting "sub audible tones" used in some control applications.</p>
  1138. </script>
  1139. <script type="text/x-red" data-template-name="AudioAnalyzeToneDetect">
  1140. <div class="form-row">
  1141. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  1142. <input type="text" id="node-input-name" placeholder="Name">
  1143. </div>
  1144. </script>
  1145. <script type="text/javascript">
  1146. RED.nodes.registerType('AudioAnalyzePrint',{
  1147. shortName: "print",
  1148. inputs:1,
  1149. outputs:0,
  1150. category: 'analyze-function',
  1151. color:"#E6E0F8",
  1152. icon: "arrow-in.png"
  1153. });
  1154. </script>
  1155. <script type="text/x-red" data-help-name="AudioAnalyzePrint">
  1156. <h3>Summary</h3>
  1157. <p>description</p>
  1158. <h3>Audio Connections</h3>
  1159. <table class=doc align=center cellpadding=3>
  1160. <tr class=top><th>Port</th><th>Purpose</th></tr>
  1161. <tr class=odd><td align=center></td><td></td></tr>
  1162. </table>
  1163. <!--<h3>Parameters</h3>
  1164. <table class=doc align=center cellpadding=3>
  1165. <tr class=top><th>Name</th><th>Type</th><th>Function</th></tr>
  1166. <tr class=odd><td align=center></td><td>Integer</td><td></td></tr>
  1167. </table>
  1168. <p>Extra description... Section only present if object has params</p>-->
  1169. <h3>Functions</h3>
  1170. <p class=func><span class=keyword>function</span>(parm1, parm2);</p>
  1171. <p class=desc>blah blah blah blah
  1172. </p>
  1173. <h3>Notes</h3>
  1174. <p></p>
  1175. </script>
  1176. <script type="text/x-red" data-template-name="AudioAnalyzePrint">
  1177. <div class="form-row">
  1178. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  1179. <input type="text" id="node-input-name" placeholder="Name">
  1180. </div>
  1181. </script>
  1182. <script type="text/javascript">
  1183. RED.nodes.registerType('AudioControlSGTL5000',{
  1184. shortName: "sgtl5000",
  1185. inputs:0,
  1186. outputs:0,
  1187. category: 'control-function',
  1188. color:"#E6E0F8",
  1189. icon: "arrow-in.png"
  1190. });
  1191. </script>
  1192. <script type="text/x-red" data-help-name="AudioControlSGTL5000">
  1193. <h3>Summary</h3>
  1194. <p>description</p>
  1195. <h3>Audio Connections</h3>
  1196. <table class=doc align=center cellpadding=3>
  1197. <tr class=top><th>Port</th><th>Purpose</th></tr>
  1198. <tr class=odd><td align=center></td><td></td></tr>
  1199. </table>
  1200. <!--<h3>Parameters</h3>
  1201. <table class=doc align=center cellpadding=3>
  1202. <tr class=top><th>Name</th><th>Type</th><th>Function</th></tr>
  1203. <tr class=odd><td align=center></td><td>Integer</td><td></td></tr>
  1204. </table>
  1205. <p>Extra description... Section only present if object has params</p>-->
  1206. <h3>Functions</h3>
  1207. <p class=func><span class=keyword>function</span>(parm1, parm2);</p>
  1208. <p class=desc>blah blah blah blah
  1209. </p>
  1210. <h3>Notes</h3>
  1211. <p></p>
  1212. </script>
  1213. <script type="text/x-red" data-template-name="AudioControlSGTL5000">
  1214. <div class="form-row">
  1215. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  1216. <input type="text" id="node-input-name" placeholder="Name">
  1217. </div>
  1218. </script>
  1219. <script type="text/javascript">
  1220. RED.nodes.registerType('AudioControlWM8731',{
  1221. shortName: "wm8731",
  1222. inputs:0,
  1223. outputs:0,
  1224. category: 'control-function',
  1225. color:"#E6E0F8",
  1226. icon: "arrow-in.png"
  1227. });
  1228. </script>
  1229. <script type="text/x-red" data-help-name="AudioControlWM8731">
  1230. <h3>Summary</h3>
  1231. <p>description</p>
  1232. <h3>Audio Connections</h3>
  1233. <table class=doc align=center cellpadding=3>
  1234. <tr class=top><th>Port</th><th>Purpose</th></tr>
  1235. <tr class=odd><td align=center></td><td></td></tr>
  1236. </table>
  1237. <!--<h3>Parameters</h3>
  1238. <table class=doc align=center cellpadding=3>
  1239. <tr class=top><th>Name</th><th>Type</th><th>Function</th></tr>
  1240. <tr class=odd><td align=center></td><td>Integer</td><td></td></tr>
  1241. </table>
  1242. <p>Extra description... Section only present if object has params</p>-->
  1243. <h3>Functions</h3>
  1244. <p class=func><span class=keyword>function</span>(parm1, parm2);</p>
  1245. <p class=desc>blah blah blah blah
  1246. </p>
  1247. <h3>Notes</h3>
  1248. <p></p>
  1249. </script>
  1250. <script type="text/x-red" data-template-name="AudioControlWM8731">
  1251. <div class="form-row">
  1252. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  1253. <input type="text" id="node-input-name" placeholder="Name">
  1254. </div>
  1255. </script>