Nelze vybrat více než 25 témat Téma musí začínat písmenem nebo číslem, může obsahovat pomlčky („-“) a může být dlouhé až 35 znaků.

2041 lines
73KB

  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('AudioInputI2S',{
  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="AudioInputI2S">
  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. <p>Only one I2S input and one I2S output object may be used. Master
  49. and slave modes may not be mixed (both must be of the same type).
  50. </p>
  51. <p>I2S master objects can be used together with non-I2S input and output
  52. objects, for simultaneous audio streaming on different hardware.</p>
  53. </script>
  54. <script type="text/x-red" data-template-name="AudioInputI2S">
  55. <div class="form-row">
  56. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  57. <input type="text" id="node-input-name" placeholder="Name">
  58. </div>
  59. </script>
  60. <script type="text/javascript">
  61. RED.nodes.registerType('AudioInputI2Sslave',{
  62. shortName: "i2ss",
  63. inputs:0,
  64. outputs:2,
  65. category: 'input-function',
  66. color:"#E6E0F8",
  67. icon: "arrow-in.png"
  68. });
  69. </script>
  70. <script type="text/x-red" data-help-name="AudioInputI2Sslave">
  71. <h3>Summary</h3>
  72. <p>Receive 16 bit stereo audio from an I2S device using I2S slave mode.</p>
  73. <h3>Audio Connections</h3>
  74. <table class=doc align=center cellpadding=3>
  75. <tr class=top><th>Port</th><th>Purpose</th></tr>
  76. <tr class=odd><td align=center>Out 0</td><td>Left Channel</td></tr>
  77. <tr class=odd><td align=center>Out 1</td><td>Right Channel</td></tr>
  78. </table>
  79. <h3>Functions</h3>
  80. <p>This object has no functions to call from the Arduino sketch. It
  81. simply streams data from the I2S hardware to its 2 output ports.</p>
  82. <h3>Hardware</h3>
  83. <p>The I2S signals are used in "slave" mode, where the I2S device controls
  84. data timing.</p>
  85. <table class=doc align=center cellpadding=3>
  86. <tr class=top><th>Pin</th><th>Signal</th><th>Direction</th></tr>
  87. <tr class=odd><td align=center>9</td><td>BCLK</td><td>Input</td></tr>
  88. <tr class=odd><td align=center>13</td><td>RX</td><td>Input</td></tr>
  89. <tr class=odd><td align=center>23</td><td>LRCLK</td><td>Input</td></tr>
  90. </table>
  91. <h3>Notes</h3>
  92. <p>Slave mode I2S <b>should not used in the same project as ADC, DAC and
  93. PWM</b> signals. Differences in timing between the I2S device and
  94. Teensy's clock can cause occasional audio glitches when I2S slave mode
  95. is used together with other input or output objects based on Teensy's
  96. timing.</p>
  97. <p>Only one I2S input and one I2S output object may be used. Master
  98. and slave modes may not be mixed (both must be of the same type).
  99. </p>
  100. </script>
  101. <script type="text/x-red" data-template-name="AudioInputI2Sslave">
  102. <div class="form-row">
  103. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  104. <input type="text" id="node-input-name" placeholder="Name">
  105. </div>
  106. </script>
  107. <script type="text/javascript">
  108. RED.nodes.registerType('AudioInputADC',{
  109. shortName: "adc",
  110. inputs:0,
  111. outputs:1,
  112. category: 'input-function',
  113. color:"#E6E0F8",
  114. icon: "arrow-in.png"
  115. });
  116. </script>
  117. <script type="text/x-red" data-help-name="AudioInputADC">
  118. <h3>Summary</h3>
  119. <p>Receive audio using the built-in analog to digital converter.</p>
  120. <h3>Audio Connections</h3>
  121. <table class=doc align=center cellpadding=3>
  122. <tr class=top><th>Port</th><th>Purpose</th></tr>
  123. <tr class=odd><td align=center>Out 0</td><td>Audio Channel</td></tr>
  124. </table>
  125. <h3>Parameters</h3>
  126. <table class=doc align=center cellpadding=3>
  127. <tr class=top><th>Name</th><th>Type</th><th>Function</th></tr>
  128. <tr class=odd><td align=center>Pin</td><td>Integer</td><td>Analog Pin To Use</td></tr>
  129. </table>
  130. <p>The pin number should be specified as "A0" to "A20"</p>
  131. <p align=center><img src="adcpins2.jpg"></p>
  132. <p align=center><img src="adcpins1.jpg"></p>
  133. <h3>Functions</h3>
  134. <p>This object has no functions to call from the Arduino sketch. It
  135. simply streams data from the ADC to its output port.</p>
  136. <h3>Hardware</h3>
  137. <p>Signal range is 0 to 1.2V</p>
  138. <p>Need for DC bias, approx 0.6V</p>
  139. <p>TODO: suggested circuity for signal input</p>
  140. <h3>Notes</h3>
  141. <p>Algorithm for automatic DC bias tracking</p>
  142. <p>Noise due to high source impedance</p>
  143. <p>Power Supply rejection issue with simple DC bias</p>
  144. <p>TODO: actual noise measurements with different input circuitry
  145. (it's not nearly as quiet as the audio shield)</p>
  146. </script>
  147. <script type="text/x-red" data-template-name="AudioInputADC">
  148. <div class="form-row">
  149. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  150. <input type="text" id="node-input-name" placeholder="Name">
  151. </div>
  152. </script>
  153. <script type="text/javascript">
  154. RED.nodes.registerType('AudioOutputI2S',{
  155. shortName: "i2s",
  156. inputs:2,
  157. outputs:0,
  158. category: 'output-function',
  159. color:"#E6E0F8",
  160. icon: "arrow-in.png"
  161. });
  162. </script>
  163. <script type="text/x-red" data-help-name="AudioOutputI2S">
  164. <h3>Summary</h3>
  165. <p>Transmit 16 bit stereo audio to the
  166. <a href="http://www.pjrc.com/store/teensy3_audio.html" target="_blank">audio shield</a>
  167. or another I2S device, using I2S master mode.</p>
  168. <p align=center><img src="audioshield_outputs.jpg"></p>
  169. <h3>Audio Connections</h3>
  170. <table class=doc align=center cellpadding=3>
  171. <tr class=top><th>Port</th><th>Purpose</th></tr>
  172. <tr class=odd><td align=center>In 0</td><td>Left Channel</td></tr>
  173. <tr class=odd><td align=center>In 1</td><td>Right Channel</td></tr>
  174. </table>
  175. <h3>Functions</h3>
  176. <p>This object has no functions to call from the Arduino sketch. It
  177. simply streams data from its 2 input ports to the I2S hardware.</p>
  178. <h3>Hardware</h3>
  179. <p align=center><img src="audioshield_backside.jpg"></p>
  180. <p>The I2S signals are used in "master" mode, where Teensy creates
  181. all 3 clock signals and controls all data timing.</p>
  182. <table class=doc align=center cellpadding=3>
  183. <tr class=top><th>Pin</th><th>Signal</th><th>Direction</th></tr>
  184. <tr class=odd><td align=center>9</td><td>BCLK</td><td>Output</td></tr>
  185. <tr class=odd><td align=center>11</td><td>MCLK</td><td>Output</td></tr>
  186. <tr class=odd><td align=center>22</td><td>TX</td><td>Output</td></tr>
  187. <tr class=odd><td align=center>23</td><td>LRCLK</td><td>Output</td></tr>
  188. </table>
  189. <p>Audio from
  190. master mode I2S may be used in the same project as ADC, DAC and
  191. PWM signals, because all remain in sync to Teensy's timing</p>
  192. <h3>Notes</h3>
  193. <p>Normally, this object is used with the Audio Shield, which
  194. is controlled separately by the "sgtl5000" object.</p>
  195. <p>Only one I2S input and one I2S output object may be used. Master
  196. and slave modes may not be mixed (both must be of the same type).
  197. </p>
  198. </script>
  199. <script type="text/x-red" data-template-name="AudioOutputI2S">
  200. <div class="form-row">
  201. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  202. <input type="text" id="node-input-name" placeholder="Name">
  203. </div>
  204. </script>
  205. <script type="text/javascript">
  206. RED.nodes.registerType('AudioOutputI2Sslave',{
  207. shortName: "i2ss",
  208. inputs:2,
  209. outputs:0,
  210. category: 'output-function',
  211. color:"#E6E0F8",
  212. icon: "arrow-in.png"
  213. });
  214. </script>
  215. <script type="text/x-red" data-help-name="AudioOutputI2Sslave">
  216. <h3>Summary</h3>
  217. <p>Transmit 16 bit stereo audio to an I2S device using I2S slave mode.</p>
  218. <h3>Audio Connections</h3>
  219. <table class=doc align=center cellpadding=3>
  220. <tr class=top><th>Port</th><th>Purpose</th></tr>
  221. <tr class=odd><td align=center>In 0</td><td>Left Channel</td></tr>
  222. <tr class=odd><td align=center>In 1</td><td>Right Channel</td></tr>
  223. </table>
  224. <h3>Functions</h3>
  225. <p>This object has no functions to call from the Arduino sketch. It
  226. simply streams data from its 2 input ports to the I2S hardware.</p>
  227. <h3>Hardware</h3>
  228. <p>The I2S signals are used in "slave" mode, where the I2S device controls
  229. data timing.</p>
  230. <table class=doc align=center cellpadding=3>
  231. <tr class=top><th>Pin</th><th>Signal</th><th>Direction</th></tr>
  232. <tr class=odd><td align=center>9</td><td>BCLK</td><td>Input</td></tr>
  233. <tr class=odd><td align=center>22</td><td>TX</td><td>Output</td></tr>
  234. <tr class=odd><td align=center>23</td><td>LRCLK</td><td>Input</td></tr>
  235. </table>
  236. <h3>Notes</h3>
  237. <p>Slave mode I2S <b>should not used in the same project as ADC, DAC and
  238. PWM</b> signals. Differences in timing between the I2S device and
  239. Teensy's clock can cause occasional audio glitches when I2S slave mode
  240. is used together with other input or output objects based on Teensy's
  241. timing.</p>
  242. <p>Only one I2S input and one I2S output object may be used. Master
  243. and slave modes may not be mixed (both must be of the same type).
  244. </p>
  245. </script>
  246. <script type="text/x-red" data-template-name="AudioOutputI2Sslave">
  247. <div class="form-row">
  248. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  249. <input type="text" id="node-input-name" placeholder="Name">
  250. </div>
  251. </script>
  252. <script type="text/javascript">
  253. RED.nodes.registerType('AudioOutputAnalog',{
  254. shortName: "dac",
  255. inputs:1,
  256. outputs:0,
  257. category: 'output-function',
  258. color:"#E6E0F8",
  259. icon: "arrow-in.png"
  260. });
  261. </script>
  262. <script type="text/x-red" data-help-name="AudioOutputAnalog">
  263. <h3>Summary</h3>
  264. <p>Transmit 12 bit audio using Teensy 3.1's built-in digital to analog converter.</p>
  265. <h3>Audio Connections</h3>
  266. <table class=doc align=center cellpadding=3>
  267. <tr class=top><th>Port</th><th>Purpose</th></tr>
  268. <tr class=odd><td align=center>In 0</td><td>Audio Channel</td></tr>
  269. </table>
  270. <h3>Functions</h3>
  271. <p>This object has no functions to call from the Arduino sketch. It
  272. simply streams data from the ADC to its output port.</p>
  273. <h3>Hardware</h3>
  274. <p align=center><img src="dacpin.jpg"></p>
  275. <p>Signal range is 0 to 1.2V</p>
  276. <p>Most applications require at least a 10&micro;F DC-blocking capacitor.</p>
  277. <p>TODO: photo of Teensy 3.1 with 10&micro;F capacitor and 3.5mm jack.</p>
  278. <h3>Notes</h3>
  279. <p>The output rate is 44.1 kHz (no oversampling). Ultrasonic noise present if
  280. not filtered. This may not
  281. be an issue for many uses, but care should be used if amplified and driven
  282. to high power tweeters.</p>
  283. </script>
  284. <script type="text/x-red" data-template-name="AudioOutputAnalog">
  285. <div class="form-row">
  286. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  287. <input type="text" id="node-input-name" placeholder="Name">
  288. </div>
  289. </script>
  290. <script type="text/javascript">
  291. RED.nodes.registerType('AudioOutputPWM',{
  292. shortName: "pwm",
  293. inputs:1,
  294. outputs:0,
  295. category: 'output-function',
  296. color:"#E6E0F8",
  297. icon: "arrow-in.png"
  298. });
  299. </script>
  300. <script type="text/x-red" data-help-name="AudioOutputPWM">
  301. <h3>Summary</h3>
  302. <p>Transmit audio using Teensy 3.1's PWM pins. Two pins are
  303. used for coarse and fine pulses, to be combined by scaled
  304. resistors.</p>
  305. <h3>Audio Connections</h3>
  306. <table class=doc align=center cellpadding=3>
  307. <tr class=top><th>Port</th><th>Purpose</th></tr>
  308. <tr class=odd><td align=center>In 0</td><td>Audio Channel</td></tr>
  309. </table>
  310. <h3>Functions</h3>
  311. <p>This object has no functions to call from the Arduino sketch. It
  312. simply streams data from the its input port to the PWM pins.</p>
  313. <h3>Hardware</h3>
  314. <p>The following circuit is recommended.</p>
  315. <p align=center><img src="pwmdualcircuit.jpg"></p>
  316. <p>Signal range is approx 1.55 Vp-p.</p>
  317. <p>These resistor values assume approx 20 ohms output impedance
  318. on the digital pins. The 127K resistor may be adjusted or
  319. trimmed for variation in output drive and tolerance on the
  320. 475 ohm resistor.</p>
  321. <p>A plastic film (Polypropylene, Polyethylene, Polyester, etc) or
  322. C0G/NPO ceramic capacitor should be used for filtering. Low
  323. quality ceramic (X7R, Y5V, Z5U, etc) can cause signal distortion.</p>
  324. <h3>Notes</h3>
  325. <p>The PWM carrier frequency is 88.2 kHz. The suggested circuit
  326. will only slightly filter the carrier. Extra filtering will be
  327. required for a clean signal without the ultrasonic PWM carrier.
  328. </p>
  329. <p>Analog signals created by filtering PWM waveforms use the digital
  330. power supply as their reference voltage. Any noise on the digital
  331. power line can directly couple to the output signal. The built-in DAC or
  332. <a href="http://www.pjrc.com/store/teensy3_audio.html" target="_blank">audio shield</a>
  333. should be used when higher quality signals are needed.</p>
  334. </script>
  335. <script type="text/x-red" data-template-name="AudioOutputPWM">
  336. <div class="form-row">
  337. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  338. <input type="text" id="node-input-name" placeholder="Name">
  339. </div>
  340. </script>
  341. <script type="text/javascript">
  342. RED.nodes.registerType('AudioMixer4',{
  343. shortName: "mixer",
  344. inputs:4,
  345. outputs:1,
  346. category: 'mixer-function',
  347. color:"#E6E0F8",
  348. icon: "arrow-in.png"
  349. });
  350. </script>
  351. <script type="text/x-red" data-help-name="AudioMixer4">
  352. <h3>Summary</h3>
  353. <p>Combine up to 4 audio signals together, each with adjustable gain.
  354. All channels support signal attenuation or amplification.</p>
  355. <h3>Audio Connections</h3>
  356. <table class=doc align=center cellpadding=3>
  357. <tr class=top><th>Port</th><th>Purpose</th></tr>
  358. <tr class=odd><td align=center>In 0</td><td>Input signal #1</td></tr>
  359. <tr class=odd><td align=center>In 1</td><td>Input signal #2</td></tr>
  360. <tr class=odd><td align=center>In 2</td><td>Input signal #3</td></tr>
  361. <tr class=odd><td align=center>In 3</td><td>Input signal #4</td></tr>
  362. <tr class=odd><td align=center>Out 0</td><td>Sum of all inputs</td></tr>
  363. </table>
  364. <h3>Functions</h3>
  365. <p class=func><span class=keyword>gain</span>(channel, level);</p>
  366. <p class=desc>Adjust the amplification or attenuation. "channel" must
  367. be 0 to 3. "level" may be any floating point number from 0 to 32767.
  368. 1.0 passes the signal through directly. Level of 0 shuts the channel
  369. off completely. Between 0 to 1.0 attenuates the signal, and above
  370. 1.0 amplifies it. All 4 channels have separate settings.
  371. </p>
  372. <h3>Notes</h3>
  373. <p>Signal clipping can occur when any channel has gain greater than 1.0,
  374. or when multiple signals add together to greater than 1.0.</p>
  375. <p>More than 4 channels may be combined by connecting multiple mixers
  376. in tandem. For example, a 16 channel mixer may be built using 5
  377. mixers, where the fifth mixer combines the outputs of the first 4.
  378. </p>
  379. </script>
  380. <script type="text/x-red" data-template-name="AudioMixer4">
  381. <div class="form-row">
  382. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  383. <input type="text" id="node-input-name" placeholder="Name">
  384. </div>
  385. </script>
  386. <script type="text/javascript">
  387. RED.nodes.registerType('AudioPlayMemory',{
  388. shortName: "playMem",
  389. inputs:0,
  390. outputs:1,
  391. category: 'play-function',
  392. color:"#E6E0F8",
  393. icon: "arrow-in.png"
  394. });
  395. </script>
  396. <script type="text/x-red" data-help-name="AudioPlayMemory">
  397. <h3>Summary</h3>
  398. <p>Play a short sound clip, stored directly in memory.
  399. Data files are created with the
  400. <a href="https://github.com/PaulStoffregen/Audio/tree/master/examples/PlayFromSketch/wav2sketch" target="_blank">wav2sketch program</a>,
  401. and copied to the sketch folder to become part of your sketch.</p>
  402. <h3>Audio Connections</h3>
  403. <table class=doc align=center cellpadding=3>
  404. <tr class=top><th>Port</th><th>Purpose</th></tr>
  405. <tr class=odd><td align=center>Out 0</td><td>Sound Output</td></tr>
  406. </table>
  407. <h3>Functions</h3>
  408. <p class=func><span class=keyword>play</span>(data);</p>
  409. <p class=desc>Begin playing a sound clip. If already playing, the
  410. currently playing clip is stopped and this new data begins
  411. playing from the beginning.
  412. </p>
  413. <p class=func><span class=keyword>stop</span>();</p>
  414. <p class=desc>Stop playing. If not playing, this function has no effect.
  415. </p>
  416. <p class=func><span class=keyword>isPlaying</span>();</p>
  417. <p class=desc>Return true (non-zero) if playing, or false (zero)
  418. when not playing.
  419. </p>
  420. <p class=func><span class=keyword>positionMillis</span>();</p>
  421. <p class=desc>While playing, return the current time offset, in
  422. milliseconds. When not playing, the return from this function
  423. is undefined.
  424. </p>
  425. <p class=func><span class=keyword>lengthMillis</span>();</p>
  426. <p class=desc>Return the total length of the current sound clip,
  427. in milliseconds. When not playing, the return from this function
  428. is undefined.
  429. </p>
  430. <h3>Notes</h3>
  431. <p>TODO: supported sample rates: 11.025, 22.05, 44.1</p>
  432. <p>TODO: ulaw vs uncompressed encoding</p>
  433. <p>Polyphonic playback can be built by creating multiple
  434. objects, with their output combined by mixers.</p>
  435. </script>
  436. <script type="text/x-red" data-template-name="AudioPlayMemory">
  437. <div class="form-row">
  438. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  439. <input type="text" id="node-input-name" placeholder="Name">
  440. </div>
  441. </script>
  442. <script type="text/javascript">
  443. RED.nodes.registerType('AudioPlaySdWav',{
  444. shortName: "playWav",
  445. inputs:0,
  446. outputs:2,
  447. category: 'play-function',
  448. color:"#E6E0F8",
  449. icon: "arrow-in.png"
  450. });
  451. </script>
  452. <script type="text/x-red" data-help-name="AudioPlaySdWav">
  453. <h3>Summary</h3>
  454. <p>Play a WAV file, stored on a SD card.</p>
  455. <h3>Audio Connections</h3>
  456. <table class=doc align=center cellpadding=3>
  457. <tr class=top><th>Port</th><th>Purpose</th></tr>
  458. <tr class=odd><td align=center>Out 0</td><td>Left Channel Output</td></tr>
  459. <tr class=odd><td align=center>Out 1</td><td>Right Channel Output</td></tr>
  460. </table>
  461. <h3>Functions</h3>
  462. <p class=func><span class=keyword>play</span>(filename);</p>
  463. <p class=desc>Begin playing a WAV file. If a file is already playing,
  464. it is stopped and this file starts playing from the beginning.
  465. </p>
  466. <p class=func><span class=keyword>stop</span>();</p>
  467. <p class=desc>Stop playing. If not playing, this function has no effect.
  468. </p>
  469. <p class=func><span class=keyword>isPlaying</span>();</p>
  470. <p class=desc>Return true (non-zero) if playing, or false (zero)
  471. when not playing. See the note below about delayed start.
  472. </p>
  473. <p class=func><span class=keyword>positionMillis</span>();</p>
  474. <p class=desc>While playing, return the current time offset, in
  475. milliseconds. When not playing, the return from this function
  476. is undefined.
  477. </p>
  478. <p class=func><span class=keyword>lengthMillis</span>();</p>
  479. <p class=desc>Return the total length of the current sound clip,
  480. in milliseconds. When not playing, the return from this function
  481. is undefined.
  482. </p>
  483. <h3>Notes</h3>
  484. <p>Only 16 bit PCM, 44100 Hz WAV files are supported. When mono
  485. files are played, both output ports transmit a copy of the
  486. single sound. Of course, stereo WAV files play with the left
  487. channel on port 0 and the right channel on port 1.
  488. </p>
  489. <p>A brief delay after calling play() will usually occur before
  490. isPlaying() returns true and positionMillis() returns valid
  491. time offset. WAV files have a header at the beginning of the
  492. file, which the audio library must read and parse before
  493. playing can begin.
  494. </p>
  495. <p>While playing, the audio library accesses the SD card automatically.
  496. If card access is required, you must
  497. <a href="http://www.pjrc.com/teensy/td_libs_AudioProcessorUsage.html" target="_blank">use AudioNoInterrupts()</a>
  498. to prevent the library from accessing the SD card while you use it.
  499. Disabling the audio library interrupt for too long may cause audible
  500. dropouts or glitches.
  501. </p>
  502. </script>
  503. <script type="text/x-red" data-template-name="AudioPlaySdWav">
  504. <div class="form-row">
  505. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  506. <input type="text" id="node-input-name" placeholder="Name">
  507. </div>
  508. </script>
  509. <script type="text/javascript">
  510. RED.nodes.registerType('AudioPlaySdRaw',{
  511. shortName: "playRaw",
  512. inputs:0,
  513. outputs:1,
  514. category: 'play-function',
  515. color:"#E6E0F8",
  516. icon: "arrow-in.png"
  517. });
  518. </script>
  519. <script type="text/x-red" data-help-name="AudioPlaySdRaw">
  520. <h3>Summary</h3>
  521. <p>Play a RAW data file, stored on a SD card. RAW format is simpler
  522. than WAV and begins playing immediately, without parsing WAV file
  523. header info.</p>
  524. <h3>Audio Connections</h3>
  525. <table class=doc align=center cellpadding=3>
  526. <tr class=top><th>Port</th><th>Purpose</th></tr>
  527. <tr class=odd><td align=center>Out 0</td><td>Sound Output</td></tr>
  528. </table>
  529. <h3>Functions</h3>
  530. <p class=func><span class=keyword>play</span>(filename);</p>
  531. <p class=desc>Begin playing a RAW data file. If a file is already playing,
  532. it is stopped and this file starts playing from the beginning.
  533. </p>
  534. <p class=func><span class=keyword>stop</span>();</p>
  535. <p class=desc>Stop playing. If not playing, this function has no effect.
  536. </p>
  537. <p class=func><span class=keyword>isPlaying</span>();</p>
  538. <p class=desc>Return true (non-zero) if playing, or false (zero)
  539. when not playing.
  540. </p>
  541. <p class=func><span class=keyword>positionMillis</span>();</p>
  542. <p class=desc>While playing, return the current time offset, in
  543. milliseconds. When not playing, the return from this function
  544. is undefined.
  545. </p>
  546. <p class=func><span class=keyword>lengthMillis</span>();</p>
  547. <p class=desc>Return the total length of the current sound clip,
  548. in milliseconds. When not playing, the return from this function
  549. is undefined.
  550. </p>
  551. <h3>Notes</h3>
  552. <p>The data file must be RAW 16 bit signed integers in LSB-first format.
  553. </p>
  554. <p>While playing, the audio library accesses the SD card automatically.
  555. If card access is required, you must
  556. <a href="http://www.pjrc.com/teensy/td_libs_AudioProcessorUsage.html" target="_blank">AudioNoInterrupts()</a>
  557. to prevent the library from accessing the SD card while you use it.
  558. Disabling the audio library interrupt for too long may cause audible
  559. dropouts or glitches.
  560. </p>
  561. </script>
  562. <script type="text/x-red" data-template-name="AudioPlaySdRaw">
  563. <div class="form-row">
  564. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  565. <input type="text" id="node-input-name" placeholder="Name">
  566. </div>
  567. </script>
  568. <script type="text/javascript">
  569. RED.nodes.registerType('AudioPlayQueue',{
  570. shortName: "queue",
  571. inputs:0,
  572. outputs:1,
  573. category: 'play-function',
  574. color:"#E6E0F8",
  575. icon: "arrow-in.png"
  576. });
  577. </script>
  578. <script type="text/x-red" data-help-name="AudioPlayQueue">
  579. <h3>Summary</h3>
  580. <p>Play audio data provided by the Arduino sketch. This object provides
  581. functions to allow the sketch code to push data into the audio system.</p>
  582. <h3>Audio Connections</h3>
  583. <table class=doc align=center cellpadding=3>
  584. <tr class=top><th>Port</th><th>Purpose</th></tr>
  585. <tr class=odd><td align=center>Out 0</td><td>Sound Output</td></tr>
  586. </table>
  587. <h3>Functions</h3>
  588. <p class=func><span class=keyword>play</span>(int16);</p>
  589. <p class=desc>not yet implemented
  590. </p>
  591. <p class=func><span class=keyword>play</span>(int16[], length);</p>
  592. <p class=desc>not yet implemented
  593. </p>
  594. <p class=func><span class=keyword>getBuffer</span>();</p>
  595. <p class=desc>Returns a pointer to an array of 128 int16. This buffer
  596. is within the audio library memory pool, providing the most efficient
  597. way to input data to the audio system. The buffer is likely to be
  598. populated by previously used data, so the entire 128 words should be
  599. written before calling playBuffer(). Only a single buffer should be
  600. requested at a time. This function may return NULL if no memory is
  601. available.
  602. </p>
  603. <p class=func><span class=keyword>playBuffer</span>();</p>
  604. <p class=desc>Transmit the buffer previously obtained from getBuffer().
  605. </p>
  606. <h3>Notes</h3>
  607. <p>TODO: many caveats....</p>
  608. <p>
  609. </p>
  610. </script>
  611. <script type="text/x-red" data-template-name="AudioPlayQueue">
  612. <div class="form-row">
  613. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  614. <input type="text" id="node-input-name" placeholder="Name">
  615. </div>
  616. </script>
  617. <script type="text/javascript">
  618. RED.nodes.registerType('AudioSynthWaveformSine',{
  619. shortName: "sine",
  620. inputs:0,
  621. outputs:1,
  622. category: 'synth-function',
  623. color:"#E6E0F8",
  624. icon: "arrow-in.png"
  625. });
  626. </script>
  627. <script type="text/x-red" data-help-name="AudioSynthWaveformSine">
  628. <h3>Summary</h3>
  629. <p>Create a sine wave signal</p>
  630. <h3>Audio Connections</h3>
  631. <table class=doc align=center cellpadding=3>
  632. <tr class=top><th>Port</th><th>Purpose</th></tr>
  633. <tr class=odd><td align=center>Out 0</td><td>Sine Wave Output</td></tr>
  634. </table>
  635. <h3>Functions</h3>
  636. <p class=func><span class=keyword>amplitude</span>(level);</p>
  637. <p class=desc>Set the amplitude, from 0 to 1.0.
  638. </p>
  639. <p class=func><span class=keyword>frequency</span>(freq);</p>
  640. <p class=desc>Set the frequency, from 0 to 22000. Very low values may
  641. be used to create a LFO (Low Frequency Oscillator) for objects
  642. with modulation signal inputs.
  643. </p>
  644. <p class=func><span class=keyword>phase</span>(angle);</p>
  645. <p class=desc>
  646. Cause the generated waveform to jump to a specific point within
  647. its cycle. Angle is from 0 to 360 degrees. When multiple objects
  648. are configured,
  649. <a href="http://www.pjrc.com/teensy/td_libs_AudioProcessorUsage.html" target="_blank">AudioNoInterrupts()</a>
  650. should be used to guarantee all new settings take effect together.
  651. </p>
  652. <h3>Notes</h3>
  653. <p></p>
  654. </script>
  655. <script type="text/x-red" data-template-name="AudioSynthWaveformSine">
  656. <div class="form-row">
  657. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  658. <input type="text" id="node-input-name" placeholder="Name">
  659. </div>
  660. </script>
  661. <script type="text/javascript">
  662. RED.nodes.registerType('AudioSynthWaveformSineModulated',{
  663. shortName: "sine_fm",
  664. inputs:1,
  665. outputs:1,
  666. category: 'synth-function',
  667. color:"#E6E0F8",
  668. icon: "arrow-in.png"
  669. });
  670. </script>
  671. <script type="text/x-red" data-help-name="AudioSynthWaveformSineModulated">
  672. <h3>Summary</h3>
  673. <p>Create a modulated sine wave, using any audio signal to continuously
  674. modulate the sine wave frequency.</p>
  675. <h3>Audio Connections</h3>
  676. <table class=doc align=center cellpadding=3>
  677. <tr class=top><th>Port</th><th>Purpose</th></tr>
  678. <tr class=odd><td align=center>In 0</td><td>Modulation Signal</td></tr>
  679. <tr class=odd><td align=center>Out 0</td><td>Sine Wave Output</td></tr>
  680. </table>
  681. <h3>Functions</h3>
  682. <p class=func><span class=keyword>amplitude</span>(level);</p>
  683. <p class=desc>Set the amplitude, from 0 to 1.0.
  684. </p>
  685. <p class=func><span class=keyword>frequency</span>(freq);</p>
  686. <p class=desc>Set the center frequency, from 0 to 11000. The output will
  687. be this center frequency when the input modulation signal is zero.
  688. Modulation input 1.0 causes the frequency to double, and input -1.0
  689. causes zero Hz (DC) output. For less modulation, attenuate the input
  690. signal (perhaps with a mixer object) before it arrives here.
  691. </p>
  692. <p class=func><span class=keyword>phase</span>(angle);</p>
  693. <p class=desc>
  694. Cause the generated waveform to jump to a specific point within
  695. its cycle. Angle is from 0 to 360 degrees. When multiple objects
  696. are configured,
  697. <a href="http://www.pjrc.com/teensy/td_libs_AudioProcessorUsage.html" target="_blank">AudioNoInterrupts()</a>
  698. should be used to guarantee all new settings take effect together.
  699. </p>
  700. <h3>Notes</h3>
  701. <p></p>
  702. </script>
  703. <script type="text/x-red" data-template-name="AudioSynthWaveformSineModulated">
  704. <div class="form-row">
  705. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  706. <input type="text" id="node-input-name" placeholder="Name">
  707. </div>
  708. </script>
  709. <script type="text/javascript">
  710. RED.nodes.registerType('AudioSynthWaveform',{
  711. shortName: "waveform",
  712. inputs:0,
  713. outputs:1,
  714. category: 'synth-function',
  715. color:"#E6E0F8",
  716. icon: "arrow-in.png"
  717. });
  718. </script>
  719. <script type="text/x-red" data-help-name="AudioSynthWaveform">
  720. <h3>Summary</h3>
  721. <p>Create a waveform: sine, sawtooth, square, or triangle</p>
  722. <h3>Audio Connections</h3>
  723. <table class=doc align=center cellpadding=3>
  724. <tr class=top><th>Port</th><th>Purpose</th></tr>
  725. <tr class=odd><td align=center>Out 0</td><td>Waveform Output</td></tr>
  726. </table>
  727. <h3>Functions</h3>
  728. <p class=func><span class=keyword>begin</span>(waveform);</p>
  729. <p class=desc>Configure the waveform type to create.
  730. </p>
  731. <p class=func><span class=keyword>begin</span>(level, frequency, waveform);</p>
  732. <p class=desc>Output a waveform, and set the amplitude and frequency.
  733. </p>
  734. <p class=func><span class=keyword>frequency</span>(freq);</p>
  735. <p class=desc>Change the frequency.
  736. </p>
  737. <p class=func><span class=keyword>amplitude</span>(level);</p>
  738. <p class=desc>Change the amplitude. Set to 0 to turn the signal off.
  739. </p>
  740. <p class=func><span class=keyword>phase</span>(angle);</p>
  741. <p class=desc>
  742. Cause the generated waveform to jump to a specific point within
  743. its cycle. Angle is from 0 to 360 degrees. When multiple objects
  744. are configured,
  745. <a href="http://www.pjrc.com/teensy/td_libs_AudioProcessorUsage.html" target="_blank">AudioNoInterrupts()</a>
  746. should be used to guarantee all new settings take effect together.
  747. </p>
  748. <p class=func><span class=keyword>arbitraryWaveform</span>(array, maxFreq);</p>
  749. <p class=desc>
  750. Configure the waveform to be used with WAVEFORM_ARBITRARY. Array
  751. must be an array of 256 samples. Currently, the data is used
  752. without any filtering, which can cause aliasing with frequencies
  753. above 172 Hz. For higher frequency output, you must bandwidth
  754. limit your waveform data. Someday, "maxFreq" will be used to
  755. do this automatically.
  756. </p>
  757. <h3>Notes</h3>
  758. <p>Supported Waveforms:<br>
  759. <ul>
  760. <li><span class=literal>WAVEFORM_SINE</span></li>
  761. <li><span class=literal>WAVEFORM_SAWTOOTH</span></li>
  762. <li><span class=literal>WAVEFORM_SQUARE</span></li>
  763. <li><span class=literal>WAVEFORM_TRIANGLE</span></li>
  764. <li><span class=literal>WAVEFORM_ARBITRARY</span></li>
  765. </ul>
  766. </p>
  767. </script>
  768. <script type="text/x-red" data-template-name="AudioSynthWaveform">
  769. <div class="form-row">
  770. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  771. <input type="text" id="node-input-name" placeholder="Name">
  772. </div>
  773. </script>
  774. <script type="text/javascript">
  775. RED.nodes.registerType('AudioSynthToneSweep',{
  776. shortName: "tonesweep",
  777. inputs:0,
  778. outputs:1,
  779. category: 'synth-function',
  780. color:"#E6E0F8",
  781. icon: "arrow-in.png"
  782. });
  783. </script>
  784. <script type="text/x-red" data-help-name="AudioSynthToneSweep">
  785. <h3>Summary</h3>
  786. <p>Create a continuously varying (in frequency) sine wave</p>
  787. <h3>Audio Connections</h3>
  788. <table class=doc align=center cellpadding=3>
  789. <tr class=top><th>Port</th><th>Purpose</th></tr>
  790. <tr class=odd><td align=center>Out 0</td><td>Continuously varying tone</td></tr>
  791. </table>
  792. <h3>Functions</h3>
  793. <p class=func><span class=keyword>play</span>(level, lowFreq, highFreq, time);</p>
  794. <p class=desc>Start generating frequency sweep output. The time is specified
  795. in milliseconds. Level is 0 to 1.0.
  796. </p>
  797. <p class=func><span class=keyword>isPlaying</span>();</p>
  798. <p class=desc>Returns true (non-zero) while the output is active.
  799. </p>
  800. <h3>Notes</h3>
  801. <p>Uses excessive CPU time</p>
  802. </script>
  803. <script type="text/x-red" data-template-name="AudioSynthToneSweep">
  804. <div class="form-row">
  805. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  806. <input type="text" id="node-input-name" placeholder="Name">
  807. </div>
  808. </script>
  809. <script type="text/javascript">
  810. RED.nodes.registerType('AudioSynthWaveformDc',{
  811. shortName: "dc",
  812. inputs:0,
  813. outputs:1,
  814. category: 'synth-function',
  815. color:"#E6E0F8",
  816. icon: "arrow-in.png"
  817. });
  818. </script>
  819. <script type="text/x-red" data-help-name="AudioSynthWaveformDc">
  820. <h3>Summary</h3>
  821. <p>Create constant (DC) signal, useful for control of objects that take
  822. a modulation or control input signal. This constant level can be
  823. used to modify other waveforms using mixer or multiplier objects</p>
  824. <h3>Audio Connections</h3>
  825. <table class=doc align=center cellpadding=3>
  826. <tr class=top><th>Port</th><th>Purpose</th></tr>
  827. <tr class=odd><td align=center>Out 0</td><td>Output constant DC level</td></tr>
  828. </table>
  829. <h3>Functions</h3>
  830. <p class=func><span class=keyword>amplitude</span>(level);</p>
  831. <p class=desc>Set the output. Level is -1.0 to 1.0. The output is
  832. changed immediately.
  833. </p>
  834. <p class=func><span class=keyword>amplitude</span>(level, milliseconds);</p>
  835. <p class=desc>Set the output. Level is -1.0 to 1.0. The output is
  836. gradually changed over a "milliseconds" time period. Any time may
  837. be specified, but periods longer than 1 second may be automatically
  838. shortened for small level changes, due to numerical precision limits.
  839. </p>
  840. <h3>Notes</h3>
  841. <p>Of course, the term "DC", for Direct Current, doesn't properly apply
  842. to a pure digital stream of numerical values. But the term is widely
  843. understood in audio applications, so hopefully it's not too confusing?</p>
  844. </script>
  845. <script type="text/x-red" data-template-name="AudioSynthWaveformDc">
  846. <div class="form-row">
  847. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  848. <input type="text" id="node-input-name" placeholder="Name">
  849. </div>
  850. </script>
  851. <script type="text/javascript">
  852. RED.nodes.registerType('AudioSynthNoiseWhite',{
  853. shortName: "noise",
  854. inputs:0,
  855. outputs:1,
  856. category: 'synth-function',
  857. color:"#E6E0F8",
  858. icon: "arrow-in.png"
  859. });
  860. </script>
  861. <script type="text/x-red" data-help-name="AudioSynthNoiseWhite">
  862. <h3>Summary</h3>
  863. <div>
  864. <p>Create white noise.
  865. </p>
  866. <p align=center><img src="whitenoise.png"></p>
  867. </div>
  868. <h3>Audio Connections</h3>
  869. <table class=doc align=center cellpadding=3>
  870. <tr class=top><th>Port</th><th>Purpose</th></tr>
  871. <tr class=odd><td align=center>Out 0</td><td>White Noise</td></tr>
  872. </table>
  873. <h3>Functions</h3>
  874. <p class=func><span class=keyword>amplitude</span>(level);</p>
  875. <p class=desc>Set the output peak level, from 0 (off) to 1.0.
  876. The default is off. Noise is generated only after setting
  877. to a non-zero level.
  878. </p>
  879. <h3>Notes</h3>
  880. <p>Setting the amplitude to zero causes this object to stop using
  881. CPU time to generate random numbers.
  882. </p>
  883. </script>
  884. <script type="text/x-red" data-template-name="AudioSynthNoiseWhite">
  885. <div class="form-row">
  886. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  887. <input type="text" id="node-input-name" placeholder="Name">
  888. </div>
  889. </script>
  890. <script type="text/javascript">
  891. RED.nodes.registerType('AudioSynthNoisePink',{
  892. shortName: "pink",
  893. inputs:0,
  894. outputs:1,
  895. category: 'synth-function',
  896. color:"#E6E0F8",
  897. icon: "arrow-in.png"
  898. });
  899. </script>
  900. <script type="text/x-red" data-help-name="AudioSynthNoisePink">
  901. <h3>Summary</h3>
  902. <div>
  903. <p>Create pink noise, using Stefan Stenzel's "New Shade Of Pink" algorithm.
  904. </p>
  905. <!--<p align=center><img src="whitenoise.png"></p>-->
  906. </div>
  907. <h3>Audio Connections</h3>
  908. <table class=doc align=center cellpadding=3>
  909. <tr class=top><th>Port</th><th>Purpose</th></tr>
  910. <tr class=odd><td align=center>Out 0</td><td>Pink Noise</td></tr>
  911. </table>
  912. <h3>Functions</h3>
  913. <p class=func><span class=keyword>amplitude</span>(level);</p>
  914. <p class=desc>Set the output peak level, from 0 (off) to 1.0.
  915. The default is off. Noise is generated only after setting
  916. to a non-zero level.
  917. </p>
  918. <h3>Notes</h3>
  919. <p>Setting the amplitude to zero causes this object to stop using
  920. CPU time. CPU usage is approx 3% on Teensy 3.1.
  921. </p>
  922. <p>Stefan Stenzel's
  923. <a href="http://stenzel.waldorfmusic.de/post/pink/" target="_blank">New Shade Of Pink</a>
  924. algorithm. Stefan's terms of use are "Use for any purpose. If used
  925. in a commercial product, you should give me one."
  926. </p>
  927. </script>
  928. <script type="text/x-red" data-template-name="AudioSynthNoisePink">
  929. <div class="form-row">
  930. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  931. <input type="text" id="node-input-name" placeholder="Name">
  932. </div>
  933. </script>
  934. <script type="text/javascript">
  935. RED.nodes.registerType('AudioEffectFade',{
  936. shortName: "fade",
  937. inputs:1,
  938. outputs:1,
  939. category: 'effect-function',
  940. color:"#E6E0F8",
  941. icon: "arrow-in.png"
  942. });
  943. </script>
  944. <script type="text/x-red" data-help-name="AudioEffectFade">
  945. <h3>Summary</h3>
  946. <p>Gradually increase or decrease audio level.</p>
  947. <h3>Audio Connections</h3>
  948. <table class=doc align=center cellpadding=3>
  949. <tr class=top><th>Port</th><th>Purpose</th></tr>
  950. <tr class=odd><td align=center>In 0</td><td>Signal Input</td></tr>
  951. <tr class=odd><td align=center>Out 0</td><td>Signal Output</td></tr>
  952. </table>
  953. <h3>Functions</h3>
  954. <p class=func><span class=keyword>fadeIn</span>(milliseconds);</p>
  955. <p class=desc>Begin increasing the audio level, to reach 1.0 (input passed
  956. directly to the output) after "milliseconds" time.
  957. </p>
  958. <p class=func><span class=keyword>fadeOut</span>(milliseconds);</p>
  959. <p class=desc>Begin decreasing the audio level, to reach 0 (no output)
  960. after "milliseconds" time.
  961. </p>
  962. <h3>Notes</h3>
  963. <p>Cross fading can be built with 2 fade objects fed into a mixer.
  964. When one fade object is off (fully faded out) and the other on
  965. (fully faded in), if both are started at the same moment for the
  966. same time duration, their signal gains always add to 1.0. This
  967. allows 2 fade objects to work together for a smooth transition
  968. between a pair of signals.
  969. </p>
  970. <p><a href="http://www.pjrc.com/teensy/td_libs_AudioProcessorUsage.html" target="_blank">AudioNoInterrupts()</a>
  971. should be used when changing
  972. settings on multiple objects, so all changes always take effect
  973. at the same moment.
  974. </p>
  975. </script>
  976. <script type="text/x-red" data-template-name="AudioEffectFade">
  977. <div class="form-row">
  978. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  979. <input type="text" id="node-input-name" placeholder="Name">
  980. </div>
  981. </script>
  982. <script type="text/javascript">
  983. RED.nodes.registerType('AudioEffectChorus',{
  984. shortName: "chorus",
  985. inputs:2,
  986. outputs:2,
  987. category: 'effect-function',
  988. color:"#E6E0F8",
  989. icon: "arrow-in.png"
  990. });
  991. </script>
  992. <script type="text/x-red" data-help-name="AudioEffectChorus">
  993. <h3>Summary</h3>
  994. <p>description</p>
  995. <h3>Audio Connections</h3>
  996. <table class=doc align=center cellpadding=3>
  997. <tr class=top><th>Port</th><th>Purpose</th></tr>
  998. <tr class=odd><td align=center></td><td></td></tr>
  999. </table>
  1000. <!--<h3>Parameters</h3>
  1001. <table class=doc align=center cellpadding=3>
  1002. <tr class=top><th>Name</th><th>Type</th><th>Function</th></tr>
  1003. <tr class=odd><td align=center></td><td>Integer</td><td></td></tr>
  1004. </table>
  1005. <p>Extra description... Section only present if object has params</p>-->
  1006. <h3>Functions</h3>
  1007. <p class=func><span class=keyword>begin</span>(delayBuffer, length, n_chorus);</p>
  1008. <p class=desc>blah blah blah blah
  1009. </p>
  1010. <p class=func><span class=keyword>stop</span>();</p>
  1011. <p class=desc>blah blah blah blah
  1012. </p>
  1013. <p class=func><span class=keyword>modify</span>(n_chorus);</p>
  1014. <p class=desc>blah blah blah blah
  1015. </p>
  1016. <h3>Notes</h3>
  1017. <p></p>
  1018. </script>
  1019. <script type="text/x-red" data-template-name="AudioEffectChorus">
  1020. <div class="form-row">
  1021. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  1022. <input type="text" id="node-input-name" placeholder="Name">
  1023. </div>
  1024. </script>
  1025. <script type="text/javascript">
  1026. RED.nodes.registerType('AudioEffectFlange',{
  1027. shortName: "flange",
  1028. inputs:2,
  1029. outputs:2,
  1030. category: 'effect-function',
  1031. color:"#E6E0F8",
  1032. icon: "arrow-in.png"
  1033. });
  1034. </script>
  1035. <script type="text/x-red" data-help-name="AudioEffectFlange">
  1036. <h3>Summary</h3>
  1037. <p>description</p>
  1038. <h3>Audio Connections</h3>
  1039. <table class=doc align=center cellpadding=3>
  1040. <tr class=top><th>Port</th><th>Purpose</th></tr>
  1041. <tr class=odd><td align=center></td><td></td></tr>
  1042. </table>
  1043. <!--<h3>Parameters</h3>
  1044. <table class=doc align=center cellpadding=3>
  1045. <tr class=top><th>Name</th><th>Type</th><th>Function</th></tr>
  1046. <tr class=odd><td align=center></td><td>Integer</td><td></td></tr>
  1047. </table>
  1048. <p>Extra description... Section only present if object has params</p>-->
  1049. <h3>Functions</h3>
  1050. <p class=func><span class=keyword>begin</span>(delayBuffer, length, offset, depth, delayRate);</p>
  1051. <p class=desc>blah blah blah blah
  1052. </p>
  1053. <p class=func><span class=keyword>modify</span>(offset, depth, delayRate);</p>
  1054. <p class=desc>blah blah blah blah
  1055. </p>
  1056. <p class=func><span class=keyword>stop</span>();</p>
  1057. <p class=desc>blah blah blah blah
  1058. </p>
  1059. <h3>Notes</h3>
  1060. <p></p>
  1061. </script>
  1062. <script type="text/x-red" data-template-name="AudioEffectFlange">
  1063. <div class="form-row">
  1064. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  1065. <input type="text" id="node-input-name" placeholder="Name">
  1066. </div>
  1067. </script>
  1068. <script type="text/javascript">
  1069. RED.nodes.registerType('AudioEffectEnvelope',{
  1070. shortName: "envelope",
  1071. inputs:1,
  1072. outputs:1,
  1073. category: 'effect-function',
  1074. color:"#E6E0F8",
  1075. icon: "arrow-in.png"
  1076. });
  1077. </script>
  1078. <script type="text/x-red" data-help-name="AudioEffectEnvelope">
  1079. <h3>Summary</h3>
  1080. <div>
  1081. <p>Modify a signal with a DAHDSR (Delay Attack Hold Decay Sustain
  1082. Release) envelope.
  1083. </p>
  1084. <p align=center><img src="dahdsr.png"></p>
  1085. </div>
  1086. <h3>Audio Connections</h3>
  1087. <table class=doc align=center cellpadding=3>
  1088. <tr class=top><th>Port</th><th>Purpose</th></tr>
  1089. <tr class=odd><td align=center>In 0</td><td>Signal Input</td></tr>
  1090. <tr class=odd><td align=center>Out 0</td><td>Signal with Envelope Applied</td></tr>
  1091. </table>
  1092. <h3>Functions</h3>
  1093. <p class=func><span class=keyword>noteOn</span>();</p>
  1094. <p class=desc>Begin the delay to attack, or the attack phase is
  1095. delay is zero.
  1096. </p>
  1097. <p class=func><span class=keyword>noteOff</span>();</p>
  1098. <p class=desc>Begin the release phase.
  1099. </p>
  1100. <p class=func><span class=keyword>delay</span>(milliseconds);</p>
  1101. <p class=desc>Set the delay from noteOn to the attach phase. The
  1102. default is zero, for no delay.
  1103. </p>
  1104. <p class=func><span class=keyword>attack</span>(milliseconds);</p>
  1105. <p class=desc>Set the attack time. The default is 1.5 milliseconds.
  1106. </p>
  1107. <p class=func><span class=keyword>hold</span>(milliseconds);</p>
  1108. <p class=desc>Set the hold time. The default is 0.5 milliseconds.
  1109. </p>
  1110. <p class=func><span class=keyword>decay</span>(milliseconds);</p>
  1111. <p class=desc>Set the decay time. The default is 15 milliseconds.
  1112. </p>
  1113. <p class=func><span class=keyword>sustain</span>(level);</p>
  1114. <p class=desc>Set the sustain level. The range is 0 to 1.0. The
  1115. gain will be maintained at this level after the decay phase,
  1116. until noteOff() is called.
  1117. </p>
  1118. <p class=func><span class=keyword>release</span>(milliseconds);</p>
  1119. <p class=desc>Set the release time. The default is 30 millisecond.
  1120. </p>
  1121. <h3>Notes</h3>
  1122. <p>To achieve the more common ADSR shape, simply
  1123. set delay and hold to zero.</p>
  1124. <p>The recommended range for each of the 5 timing inputs is 0 to 50
  1125. milliseconds. Up to 200 ms can be used, with somewhat reduced
  1126. accuracy</p>
  1127. </script>
  1128. <script type="text/x-red" data-template-name="AudioEffectEnvelope">
  1129. <div class="form-row">
  1130. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  1131. <input type="text" id="node-input-name" placeholder="Name">
  1132. </div>
  1133. </script>
  1134. <script type="text/javascript">
  1135. RED.nodes.registerType('AudioEffectMultiply',{
  1136. shortName: "multiply",
  1137. inputs:2,
  1138. outputs:1,
  1139. category: 'effect-function',
  1140. color:"#E6E0F8",
  1141. icon: "arrow-in.png"
  1142. });
  1143. </script>
  1144. <script type="text/x-red" data-help-name="AudioEffectMultiply">
  1145. <h3>Summary</h3>
  1146. <div>
  1147. <p>Multiply two signals together, useful for amplitude modulation
  1148. or "voltage controlled amplification".
  1149. </p>
  1150. <p align=center><img src="multiply.png"><br><small>56 Hz and 1 kHz sine waves multiplied.</small></p>
  1151. </div>
  1152. <h3>Audio Connections</h3>
  1153. <table class=doc align=center cellpadding=3>
  1154. <tr class=top><th>Port</th><th>Purpose</th></tr>
  1155. <tr class=odd><td align=center>In 0</td><td>Signal Input</td></tr>
  1156. <tr class=odd><td align=center>In 1</td><td>Signal Input</td></tr>
  1157. <tr class=odd><td align=center>Out 0</td><td>Signal with Envelope Applied</td></tr>
  1158. </table>
  1159. <h3>Functions</h3>
  1160. <p>There are no functions to call from the Arduino sketch.
  1161. This object simply multiplies the 2 signals to create
  1162. a continuous output
  1163. </p>
  1164. <h3>Notes</h3>
  1165. <p>
  1166. </p>
  1167. </script>
  1168. <script type="text/x-red" data-template-name="AudioEffectMultiply">
  1169. <div class="form-row">
  1170. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  1171. <input type="text" id="node-input-name" placeholder="Name">
  1172. </div>
  1173. </script>
  1174. <script type="text/javascript">
  1175. RED.nodes.registerType('AudioEffectDelay',{
  1176. shortName: "delay",
  1177. inputs:1,
  1178. outputs:8,
  1179. category: 'effect-function',
  1180. color:"#E6E0F8",
  1181. icon: "arrow-in.png"
  1182. });
  1183. </script>
  1184. <script type="text/x-red" data-help-name="AudioEffectDelay">
  1185. <h3>Summary</h3>
  1186. <div>
  1187. <p>Delay a signal. Up to 8 separate delay taps can be used.</p>
  1188. <p align=center><img src="delay.png"><br><small>1 kHz burst, delayed 5.2 ms.</small></p>
  1189. </div>
  1190. <h3>Audio Connections</h3>
  1191. <table class=doc align=center cellpadding=3>
  1192. <tr class=top><th>Port</th><th>Purpose</th></tr>
  1193. <tr class=odd><td align=center>In 0</td><td>Signal Input</td></tr>
  1194. <tr class=odd><td align=center>Out 0</td><td>Delay Tap #1</td></tr>
  1195. <tr class=odd><td align=center>Out 1</td><td>Delay Tap #2</td></tr>
  1196. <tr class=odd><td align=center>Out 2</td><td>Delay Tap #3</td></tr>
  1197. <tr class=odd><td align=center>Out 3</td><td>Delay Tap #4</td></tr>
  1198. <tr class=odd><td align=center>Out 4</td><td>Delay Tap #5</td></tr>
  1199. <tr class=odd><td align=center>Out 5</td><td>Delay Tap #6</td></tr>
  1200. <tr class=odd><td align=center>Out 6</td><td>Delay Tap #7</td></tr>
  1201. <tr class=odd><td align=center>Out 7</td><td>Delay Tap #8</td></tr>
  1202. </table>
  1203. <h3>Functions</h3>
  1204. <p class=func><span class=keyword>delay</span>(channel, milliseconds);</p>
  1205. <p class=desc>Set output channel (0 to 7) to delay the signals by
  1206. milliseconds. The maximum delay is approx 333 ms. The actual delay
  1207. is rounded to the nearest sample. Each channel can be configured for
  1208. any delay. There is no requirement to configure the "taps" in increasing
  1209. delay order.
  1210. </p>
  1211. <p class=func><span class=keyword>disable</span>(channel);</p>
  1212. <p class=desc>Disable a channel. The output of this channel becomes
  1213. silent. If this channel is the longest delay, memory usage is
  1214. automatically reduced to accomodate only the remaining channels used.
  1215. </p>
  1216. <h3>Notes</h3>
  1217. <p>Memory for the delayed signal is take from the memory pool allocated by
  1218. <a href="http://www.pjrc.com/teensy/td_libs_AudioConnection.html" target="_blank">AudioMemory()</a>.
  1219. Each block allows about 3 milliseconds of delay, so AudioMemory
  1220. should be increased to allow for the longest delay tap.
  1221. </p>
  1222. </script>
  1223. <script type="text/x-red" data-template-name="AudioEffectDelay">
  1224. <div class="form-row">
  1225. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  1226. <input type="text" id="node-input-name" placeholder="Name">
  1227. </div>
  1228. </script>
  1229. <script type="text/javascript">
  1230. RED.nodes.registerType('AudioFilterBiquad',{
  1231. shortName: "biquad",
  1232. inputs:1,
  1233. outputs:1,
  1234. category: 'filter-function',
  1235. color:"#E6E0F8",
  1236. icon: "arrow-in.png"
  1237. });
  1238. </script>
  1239. <script type="text/x-red" data-help-name="AudioFilterBiquad">
  1240. <h3>Summary</h3>
  1241. <p>description</p>
  1242. <h3>Audio Connections</h3>
  1243. <table class=doc align=center cellpadding=3>
  1244. <tr class=top><th>Port</th><th>Purpose</th></tr>
  1245. <tr class=odd><td align=center></td><td></td></tr>
  1246. </table>
  1247. <h3>Parameters</h3>
  1248. <table class=doc align=center cellpadding=3>
  1249. <tr class=top><th>Name</th><th>Type</th><th>Function</th></tr>
  1250. <tr class=odd><td align=center></td><td>Integer</td><td></td></tr>
  1251. </table>
  1252. <p>Extra description... Section only present if object has params</p>
  1253. <h3>Functions</h3>
  1254. <p class=func><span class=keyword>function</span>(parm1, parm2);</p>
  1255. <p class=desc>blah blah blah blah
  1256. </p>
  1257. <h3>Notes</h3>
  1258. <p></p>
  1259. </script>
  1260. <script type="text/x-red" data-template-name="AudioFilterBiquad">
  1261. <div class="form-row">
  1262. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  1263. <input type="text" id="node-input-name" placeholder="Name">
  1264. </div>
  1265. </script>
  1266. <script type="text/javascript">
  1267. RED.nodes.registerType('AudioFilterFIR',{
  1268. shortName: "fir",
  1269. inputs:1,
  1270. outputs:1,
  1271. category: 'filter-function',
  1272. color:"#E6E0F8",
  1273. icon: "arrow-in.png"
  1274. });
  1275. </script>
  1276. <script type="text/x-red" data-help-name="AudioFilterFIR">
  1277. <h3>Summary</h3>
  1278. <p>description</p>
  1279. <h3>Audio Connections</h3>
  1280. <table class=doc align=center cellpadding=3>
  1281. <tr class=top><th>Port</th><th>Purpose</th></tr>
  1282. <tr class=odd><td align=center></td><td></td></tr>
  1283. </table>
  1284. <!--<h3>Parameters</h3>
  1285. <table class=doc align=center cellpadding=3>
  1286. <tr class=top><th>Name</th><th>Type</th><th>Function</th></tr>
  1287. <tr class=odd><td align=center></td><td>Integer</td><td></td></tr>
  1288. </table>
  1289. <p>Extra description... Section only present if object has params</p>-->
  1290. <h3>Functions</h3>
  1291. <p class=func><span class=keyword>function</span>(parm1, parm2);</p>
  1292. <p class=desc>blah blah blah blah
  1293. </p>
  1294. <h3>Notes</h3>
  1295. <p></p>
  1296. </script>
  1297. <script type="text/x-red" data-template-name="AudioFilterFIR">
  1298. <div class="form-row">
  1299. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  1300. <input type="text" id="node-input-name" placeholder="Name">
  1301. </div>
  1302. </script>
  1303. <script type="text/javascript">
  1304. RED.nodes.registerType('AudioFilterStateVariable',{
  1305. shortName: "filter",
  1306. inputs:2,
  1307. outputs:3,
  1308. category: 'filter-function',
  1309. color:"#E6E0F8",
  1310. icon: "arrow-in.png"
  1311. });
  1312. </script>
  1313. <script type="text/x-red" data-help-name="AudioFilterStateVariable">
  1314. <h3>Summary</h3>
  1315. <p>A State Variable (Chamberlin) Filter with 12 dB/octave roll-off,
  1316. adjustable resonance, and optional signal control of corner
  1317. frequency.</p>
  1318. <h3>Audio Connections</h3>
  1319. <table class=doc align=center cellpadding=3>
  1320. <tr class=top><th>Port</th><th>Purpose</th></tr>
  1321. <tr class=odd><td align=center>In 0</td><td>Signal to Filter</td></tr>
  1322. <tr class=odd><td align=center>In 1</td><td>Frequency Control</td></tr>
  1323. <tr class=odd><td align=center>Out 0</td><td>Low Pass Output</td></tr>
  1324. <tr class=odd><td align=center>Out 1</td><td>Band Pass Output</td></tr>
  1325. <tr class=odd><td align=center>Out 2</td><td>High Pass Output</td></tr>
  1326. </table>
  1327. <h3>Functions</h3>
  1328. <p class=func><span class=keyword>frequency</span>(freq);</p>
  1329. <p class=desc>Set the filter's corner frequency. When a signal is
  1330. connected to the control input, the filter will implement this
  1331. frequency when the signal is zero.
  1332. </p>
  1333. <p class=func><span class=keyword>resonance</span>(Q);</p>
  1334. <p class=desc>Set the filter's resonance. Q ranges from 0.7 to 5.0.
  1335. Resonance greater than 0.707 will amplify the signal near the
  1336. corner frequency. You must attenuate the signal before input
  1337. to this filter, to prevent clipping.
  1338. </p>
  1339. <p class=func><span class=keyword>octaveControl</span>(octaves);</p>
  1340. <p class=desc>Set how much (in octaves) the control signal can alter
  1341. the filter's corner freqency. Range is 0 to 7 octaves. For
  1342. example, when set to 2.5, a full scale positive signal (1.0) will
  1343. shift the filter frequency up 2.5 octaves, and a full scale negative
  1344. signal will shift it down 2.5 octaves.
  1345. </p>
  1346. <h3>Notes</h3>
  1347. <p>
  1348. When controlled by a signal, the equation for the filter
  1349. frequency is:
  1350. </p>
  1351. <p>
  1352. F = Fcenter * 2^<sup>(signal * octaves)</sup>
  1353. <br><small>If anyone knows how to do HTML equations, please
  1354. help me improve this.....</small>
  1355. </p>
  1356. <p>When operating with signal control of corner frequency, this
  1357. object uses approximately 4% of the CPU time on Teensy 3.1.
  1358. </p>
  1359. </script>
  1360. <script type="text/x-red" data-template-name="AudioFilterFIR">
  1361. <div class="form-row">
  1362. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  1363. <input type="text" id="node-input-name" placeholder="Name">
  1364. </div>
  1365. </script>
  1366. <script type="text/javascript">
  1367. RED.nodes.registerType('AudioAnalyzePeak',{
  1368. shortName: "peak",
  1369. inputs:1,
  1370. outputs:0,
  1371. category: 'analyze-function',
  1372. color:"#E6E0F8",
  1373. icon: "arrow-in.png"
  1374. });
  1375. </script>
  1376. <script type="text/x-red" data-help-name="AudioAnalyzePeak">
  1377. <h3>Summary</h3>
  1378. <p>description</p>
  1379. <h3>Audio Connections</h3>
  1380. <table class=doc align=center cellpadding=3>
  1381. <tr class=top><th>Port</th><th>Purpose</th></tr>
  1382. <tr class=odd><td align=center></td><td></td></tr>
  1383. </table>
  1384. <!--<h3>Parameters</h3>
  1385. <table class=doc align=center cellpadding=3>
  1386. <tr class=top><th>Name</th><th>Type</th><th>Function</th></tr>
  1387. <tr class=odd><td align=center></td><td>Integer</td><td></td></tr>
  1388. </table>
  1389. <p>Extra description... Section only present if object has params</p>-->
  1390. <h3>Functions</h3>
  1391. <p class=func><span class=keyword>begin</span>(noReset);</p>
  1392. <p class=desc>blah blah blah blah
  1393. </p>
  1394. <p class=func><span class=keyword>stop</span>();</p>
  1395. <p class=desc>blah blah blah blah
  1396. </p>
  1397. <p class=func><span class=keyword>Dpp</span>();</p>
  1398. <p class=desc>blah blah blah blah
  1399. </p>
  1400. <h3>Notes</h3>
  1401. <p></p>
  1402. </script>
  1403. <script type="text/x-red" data-template-name="AudioAnalyzePeak">
  1404. <div class="form-row">
  1405. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  1406. <input type="text" id="node-input-name" placeholder="Name">
  1407. </div>
  1408. </script>
  1409. <script type="text/javascript">
  1410. RED.nodes.registerType('AudioAnalyzeFFT256',{
  1411. shortName: "fft256",
  1412. inputs:1,
  1413. outputs:0,
  1414. category: 'analyze-function',
  1415. color:"#E6E0F8",
  1416. icon: "arrow-in.png"
  1417. });
  1418. </script>
  1419. <script type="text/x-red" data-help-name="AudioAnalyzeFFT256">
  1420. <h3>Summary</h3>
  1421. <p>Compute a 256 point Fast Fourier Transform (FFT) frequency analysis,
  1422. with real value (magnitude) output. The frequency resolution is
  1423. 172 Hz, useful for simple audio visualization.</p>
  1424. <h3>Audio Connections</h3>
  1425. <table class=doc align=center cellpadding=3>
  1426. <tr class=top><th>Port</th><th>Purpose</th></tr>
  1427. <tr class=odd><td align=center>In 0</td><td>Signal to convert to frequency bins</td></tr>
  1428. </table>
  1429. <h3>Functions</h3>
  1430. <p class=func><span class=keyword>available</span>();</p>
  1431. <p class=desc>Returns true each time the FFT analysis produces new output data.
  1432. </p>
  1433. <p class=func><span class=keyword>read</span>(binNumber);</p>
  1434. <p class=desc>Read a single frequency bin, from 0 to 127. The result is scaled
  1435. so 1.0 represents a full scale sine wave.
  1436. </p>
  1437. <p class=func><span class=keyword>read</span>(firstBin, lastBin);</p>
  1438. <p class=desc>Read several frequency bins, returning their sum. The higher
  1439. audio octaves are represented by many bins, which are typically read
  1440. as a group for audio visualization.
  1441. </p>
  1442. <p class=func><span class=keyword>averageTogether</span>(number);</p>
  1443. <p class=desc>New data is produced very radidly, approximately 344 times
  1444. per second. Multiple outputs can be averaged together, so available()
  1445. returns true at a slower rate.
  1446. </p>
  1447. <p class=func><span class=keyword>windowFunction</span>(window);</p>
  1448. <p class=desc>Set the window function to be used. AudioWindowHanning256
  1449. is the default. Windowing may be disabled by NULL, but windowing
  1450. should be used for all non-periodic (music) signals, and all periodic
  1451. signals that are not exact integer division of the sample rate.
  1452. </p>
  1453. <h3>Notes</h3>
  1454. <p>The raw 16 bit output data bins may be access with myFFT.output[num], where
  1455. num is 0 to 127.</p>
  1456. <p>TODO: caveats about spectral leakage vs frequency precision for arbitrary signals</p>
  1457. <p>Window Types:
  1458. <ul>
  1459. <li><span class=literal>AudioWindowHanning256</span> (default)</li>
  1460. <li><span class=literal>AudioWindowBartlett256</span></li>
  1461. <li><span class=literal>AudioWindowBlackman256</span></li>
  1462. <li><span class=literal>AudioWindowFlattop256</span></li>
  1463. <li><span class=literal>AudioWindowBlackmanHarris256</span></li>
  1464. <li><span class=literal>AudioWindowNuttall256</span></li>
  1465. <li><span class=literal>AudioWindowBlackmanNuttall256</span></li>
  1466. <li><span class=literal>AudioWindowWelch256</span></li>
  1467. <li><span class=literal>AudioWindowHamming256</span></li>
  1468. <li><span class=literal>AudioWindowCosine256</span></li>
  1469. <li><span class=literal>AudioWindowTukey256</span></li>
  1470. </ul>
  1471. </p>
  1472. </script>
  1473. <script type="text/x-red" data-template-name="AudioAnalyzeFFT256">
  1474. <div class="form-row">
  1475. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  1476. <input type="text" id="node-input-name" placeholder="Name">
  1477. </div>
  1478. </script>
  1479. <script type="text/javascript">
  1480. RED.nodes.registerType('AudioAnalyzeFFT1024',{
  1481. shortName: "fft1024",
  1482. inputs:1,
  1483. outputs:0,
  1484. category: 'analyze-function',
  1485. color:"#E6E0F8",
  1486. icon: "arrow-in.png"
  1487. });
  1488. </script>
  1489. <script type="text/x-red" data-help-name="AudioAnalyzeFFT1024">
  1490. <h3>Summary</h3>
  1491. <p>Compute a 1024 point Fast Fourier Transform (FFT) frequency analysis,
  1492. with real value (magnitude) output. The frequency resolution is
  1493. 43 Hz, useful detailed for audio visualization.</p>
  1494. <h3>Audio Connections</h3>
  1495. <table class=doc align=center cellpadding=3>
  1496. <tr class=top><th>Port</th><th>Purpose</th></tr>
  1497. <tr class=odd><td align=center>In 0</td><td>Signal to convert to frequency bins</td></tr>
  1498. </table>
  1499. <h3>Functions</h3>
  1500. <p class=func><span class=keyword>available</span>();</p>
  1501. <p class=desc>Returns true each time the FFT analysis produces new output data.
  1502. </p>
  1503. <p class=func><span class=keyword>read</span>(binNumber);</p>
  1504. <p class=desc>Read a single frequency bin, from 0 to 511. The result is scaled
  1505. so 1.0 represents a full scale sine wave.
  1506. </p>
  1507. <p class=func><span class=keyword>read</span>(firstBin, lastBin);</p>
  1508. <p class=desc>Read several frequency bins, returning their sum. The higher
  1509. audio octaves are represented by many bins, which are typically read
  1510. as a group for audio visualization.
  1511. </p>
  1512. <p class=func><span class=keyword>averageTogether</span>(number);</p>
  1513. <p class=desc>This function does nothing. The 1024 point FFT always
  1514. updates at approximately 86 times per second.
  1515. </p>
  1516. <p class=func><span class=keyword>windowFunction</span>(window);</p>
  1517. <p class=desc>Set the window function to be used. AudioWindowHanning1024
  1518. is the default. Windowing may be disabled by NULL, but windowing
  1519. should be used for all non-periodic (music) signals, and all periodic
  1520. signals that are not exact integer division of the sample rate.
  1521. </p>
  1522. <h3>Notes</h3>
  1523. <p>The raw 16 bit output data bins may be access with myFFT.output[num], where
  1524. num is 0 to 511.</p>
  1525. <p>TODO: caveats about spectral leakage vs frequency precision for arbitrary signals</p>
  1526. <p>Window Types:
  1527. <ul>
  1528. <li><span class=literal>AudioWindowHanning1024</span> (default)</li>
  1529. <li><span class=literal>AudioWindowBartlett1024</span></li>
  1530. <li><span class=literal>AudioWindowBlackman1024</span></li>
  1531. <li><span class=literal>AudioWindowFlattop1024</span></li>
  1532. <li><span class=literal>AudioWindowBlackmanHarris1024</span></li>
  1533. <li><span class=literal>AudioWindowNuttall1024</span></li>
  1534. <li><span class=literal>AudioWindowBlackmanNuttall1024</span></li>
  1535. <li><span class=literal>AudioWindowWelch1024</span></li>
  1536. <li><span class=literal>AudioWindowHamming1024</span></li>
  1537. <li><span class=literal>AudioWindowCosine1024</span></li>
  1538. <li><span class=literal>AudioWindowTukey1024</span></li>
  1539. </ul>
  1540. </p>
  1541. <p>1024 point FFT has a peak CPU usage of approx 52% on Teensy 3.1.
  1542. Average usage is much lower. Future versions might distribute the
  1543. load more evenly over time....
  1544. </p>
  1545. </script>
  1546. <script type="text/x-red" data-template-name="AudioAnalyzeFFT1024">
  1547. <div class="form-row">
  1548. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  1549. <input type="text" id="node-input-name" placeholder="Name">
  1550. </div>
  1551. </script>
  1552. <script type="text/javascript">
  1553. RED.nodes.registerType('AudioAnalyzeToneDetect',{
  1554. shortName: "tone",
  1555. inputs:1,
  1556. outputs:0,
  1557. category: 'analyze-function',
  1558. color:"#E6E0F8",
  1559. icon: "arrow-in.png"
  1560. });
  1561. </script>
  1562. <script type="text/x-red" data-help-name="AudioAnalyzeToneDetect">
  1563. <h3>Summary</h3>
  1564. <p>Detect the level of a single tone</p>
  1565. <h3>Audio Connections</h3>
  1566. <table class=doc align=center cellpadding=3>
  1567. <tr class=top><th>Port</th><th>Purpose</th></tr>
  1568. <tr class=odd><td align=center>In 0</td><td>Signal to analyze</td></tr>
  1569. </table>
  1570. <h3>Functions</h3>
  1571. <p class=func><span class=keyword>frequency</span>(freq);</p>
  1572. <p class=desc>Set the frequency to detect. The default detection time
  1573. will be 10 cycles of this frequency.
  1574. </p>
  1575. <p class=func><span class=keyword>frequency</span>(freq, cycles);</p>
  1576. <p class=desc>Set the frequency to detect, and the number of cycles.
  1577. Longer detection time (more cycles) will give higher precision,
  1578. but of course slower response.
  1579. </p>
  1580. <p class=func><span class=keyword>available</span>();</p>
  1581. <p class=desc>Returns true (non-zero) each time a detection interval
  1582. (number of cycles) completed and a new level is detected.
  1583. </p>
  1584. <p class=func><span class=keyword>read</span>();</p>
  1585. <p class=desc>Read the detected signal level. Range is 0 to 1.0.
  1586. </p>
  1587. <p class=func><span class=keyword>threshold</span>(level);</p>
  1588. <p class=desc>Set a detection threshold, where the bool test operation
  1589. will return true if at or above this level, or false when below.
  1590. </p>
  1591. <p class=func>(bool)</p>
  1592. <p class=desc>By testing the object as a boolean value, you can respond
  1593. to detection of a tone.
  1594. </p>
  1595. <h3>Notes</h3>
  1596. <p>Low frequency detection has trouble with numerical precision.
  1597. Works really well for all 8 DTMF frequencies, but fails for
  1598. detecting "sub audible tones" used in some control applications.</p>
  1599. <p>The (bool) test continues to return true until the next detection
  1600. interval (the configured number of cycles). This behavior may
  1601. change in future versions, for a single true each time the signal
  1602. is detected, and then false for the remainder of that interval.</p>
  1603. </script>
  1604. <script type="text/x-red" data-template-name="AudioAnalyzeToneDetect">
  1605. <div class="form-row">
  1606. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  1607. <input type="text" id="node-input-name" placeholder="Name">
  1608. </div>
  1609. </script>
  1610. <script type="text/javascript">
  1611. RED.nodes.registerType('AudioAnalyzePrint',{
  1612. shortName: "print",
  1613. inputs:1,
  1614. outputs:0,
  1615. category: 'analyze-function',
  1616. color:"#E6E0F8",
  1617. icon: "arrow-in.png"
  1618. });
  1619. </script>
  1620. <script type="text/x-red" data-help-name="AudioAnalyzePrint">
  1621. <h3>Summary</h3>
  1622. <p>Print raw audio data to the Arduino Serial Monitor. This
  1623. object creates massive output quickly, and should not normall be used.</p>
  1624. <h3>Audio Connections</h3>
  1625. <table class=doc align=center cellpadding=3>
  1626. <tr class=top><th>Port</th><th>Purpose</th></tr>
  1627. <tr class=odd><td align=center></td><td></td></tr>
  1628. </table>
  1629. <!--<h3>Parameters</h3>
  1630. <table class=doc align=center cellpadding=3>
  1631. <tr class=top><th>Name</th><th>Type</th><th>Function</th></tr>
  1632. <tr class=odd><td align=center></td><td>Integer</td><td></td></tr>
  1633. </table>
  1634. <p>Extra description... Section only present if object has params</p>-->
  1635. <h3>Functions</h3>
  1636. <p class=func><span class=keyword>trigger</span>();</p>
  1637. <p class=desc>blah blah blah blah
  1638. </p>
  1639. <p class=func><span class=keyword>trigger</span>(level, edge);</p>
  1640. <p class=desc>blah blah blah blah
  1641. </p>
  1642. <p class=func><span class=keyword>delay</span>(samples);</p>
  1643. <p class=desc>blah blah blah blah
  1644. </p>
  1645. <p class=func><span class=keyword>length</span>(samples);</p>
  1646. <p class=desc>blah blah blah blah
  1647. </p>
  1648. <h3>Notes</h3>
  1649. <p></p>
  1650. </script>
  1651. <script type="text/x-red" data-template-name="AudioAnalyzePrint">
  1652. <div class="form-row">
  1653. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  1654. <input type="text" id="node-input-name" placeholder="Name">
  1655. </div>
  1656. </script>
  1657. <script type="text/javascript">
  1658. RED.nodes.registerType('AudioControlSGTL5000',{
  1659. shortName: "sgtl5000",
  1660. inputs:0,
  1661. outputs:0,
  1662. category: 'control-function',
  1663. color:"#E6E0F8",
  1664. icon: "arrow-in.png"
  1665. });
  1666. </script>
  1667. <script type="text/x-red" data-help-name="AudioControlSGTL5000">
  1668. <h3>Summary</h3>
  1669. <p>Control the SGTL5000 chip on the audio shield
  1670. <a href="http://www.pjrc.com/store/teensy3_audio.html" target="_blank">audio shield</a>.
  1671. SGTL5000 is always used in slave mode, where Teensy controls
  1672. all I2S timing.
  1673. </p>
  1674. <p align=center><img src="sgtl5000closeup.jpg"></p>
  1675. <h3>Audio Connections</h3>
  1676. <p>This object has no audio inputs or outputs. Separate i2s objects
  1677. are used to send and receive audio data. I2S master mode objects
  1678. must be used, because this object configures the SGTL5000 in slave
  1679. mode, where it depends on Teensy to provide all I2S clocks.
  1680. This object controls
  1681. how the SGTL5000 will use those I2S audio streams.</p>
  1682. <h3>Functions</h3>
  1683. <p>These are the most commonly used SGTL5000 functions.</p>
  1684. <p class=func><span class=keyword>enable</span>();</p>
  1685. <p class=desc>blah blah blah blah
  1686. </p>
  1687. <p class=func><span class=keyword>disable</span>();</p>
  1688. <p class=desc>blah blah blah blah
  1689. </p>
  1690. <p class=func><span class=keyword>volume</span>(level);</p>
  1691. <p class=desc>blah blah blah blah
  1692. </p>
  1693. <p class=func><span class=keyword>inputLevel</span>(level);</p>
  1694. <p class=desc>blah blah blah blah
  1695. </p>
  1696. <p class=func><span class=keyword>muteHeadphone</span>();</p>
  1697. <p class=desc>blah blah blah blah
  1698. </p>
  1699. <p class=func><span class=keyword>unmuteHeadphone</span>();</p>
  1700. <p class=desc>blah blah blah blah
  1701. </p>
  1702. <p class=func><span class=keyword>muteLineout</span>();</p>
  1703. <p class=desc>blah blah blah blah
  1704. </p>
  1705. <p class=func><span class=keyword>unmuteLineout</span>();</p>
  1706. <p class=desc>blah blah blah blah
  1707. </p>
  1708. <p class=func><span class=keyword>inputSelect</span>(input);</p>
  1709. <p class=desc>AUDIO_INPUT_LINEIN or AUDIO_INPUT_MIC
  1710. </p>
  1711. <h3>Signal Adjustment</h3>
  1712. <p>The SGTL5000 supports flexible signal routing (inside the chip) and
  1713. many optional signal conditioning features.</p>
  1714. <p class=func><span class=keyword>route</span>(i2s, dac, dap);</p>
  1715. <p class=desc>blah blah blah blah
  1716. </p>
  1717. <p class=func><span class=keyword>route</span>(i2s, dac, dap, dapmix);</p>
  1718. <p class=desc>blah blah blah blah
  1719. </p>
  1720. <p class=func><span class=keyword>micGain</span>(n);</p>
  1721. <p class=desc>blah blah blah blah
  1722. </p>
  1723. <p class=func><span class=keyword>lineOutLevel</span>(both);</p>
  1724. <p class=desc>blah blah blah blah
  1725. </p>
  1726. <p class=func><span class=keyword>lineOutLevel</span>(left, right);</p>
  1727. <p class=desc>blah blah blah blah
  1728. </p>
  1729. <p class=func><span class=keyword>dacVolume</span>(both);</p>
  1730. <p class=desc>blah blah blah blah
  1731. </p>
  1732. <p class=func><span class=keyword>dacVolume</span>(left, right);</p>
  1733. <p class=desc>blah blah blah blah
  1734. </p>
  1735. <p class=func><span class=keyword>adcHighPassFilterControl</span>(bypass, freeze);</p>
  1736. <p class=desc>blah blah blah blah
  1737. </p>
  1738. <p class=func><span class=keyword>adcHighPassFilterControl</span>(bypass);</p>
  1739. <p class=desc>blah blah blah blah
  1740. </p>
  1741. <p class=func><span class=keyword>audioMixerEnable</span>(n);</p>
  1742. <p class=desc>blah blah blah blah
  1743. </p>
  1744. <h3>Audio Processor</h3>
  1745. <p>An optional digital audio processor, capable of implementing a
  1746. simple equalizer, filtering, bass enhancement and surround sound
  1747. is available. It can process audio input before the SGTL5000
  1748. sends it by I2S to Teensy, or it can process Teensy's I2S output
  1749. before converting the digital data to analog signals.</p>
  1750. <p class=func><span class=keyword>audioProcessorEnable</span>(n);</p>
  1751. <p class=desc>blah blah blah blah
  1752. </p>
  1753. <p class=func><span class=keyword>audioProcessorEnable</span>();</p>
  1754. <p class=desc>blah blah blah blah
  1755. </p>
  1756. <p class=func><span class=keyword>eqFilterCount</span>(n);</p>
  1757. <p class=desc>blah blah blah blah
  1758. </p>
  1759. <p class=func><span class=keyword>eqSelect</span>(n);</p>
  1760. <p class=desc>blah blah blah blah
  1761. </p>
  1762. <p class=func><span class=keyword>eqBand</span>(bandNum, n);</p>
  1763. <p class=desc>blah blah blah blah
  1764. </p>
  1765. <p class=func><span class=keyword>eqBands</span>(bass, mid_bass, midrange, mid_treble, treble);</p>
  1766. <p class=desc>blah blah blah blah
  1767. </p>
  1768. <p class=func><span class=keyword>eqBands</span>(bass, treble);</p>
  1769. <p class=desc>blah blah blah blah
  1770. </p>
  1771. <p class=func><span class=keyword>eqFilter</span>(filterNum, filterParameters);</p>
  1772. <p class=desc>blah blah blah blah
  1773. </p>
  1774. <p class=func><span class=keyword>autoVolumeControl</span>(maxGain, response, hardLimit, threshold, attack, decay);</p>
  1775. <p class=desc>blah blah blah blah
  1776. </p>
  1777. <p class=func><span class=keyword>autoVolumeEnable</span>(n);</p>
  1778. <p class=desc>blah blah blah blah
  1779. </p>
  1780. <p class=func><span class=keyword>autoVolumeEnable</span>();</p>
  1781. <p class=desc>blah blah blah blah
  1782. </p>
  1783. <p class=func><span class=keyword>enhanceBass</span>(lr_lev, bass_lev);</p>
  1784. <p class=desc>blah blah blah blah
  1785. </p>
  1786. <p class=func><span class=keyword>enhanceBass</span>(lr_lev, bass_lev, hpf_bypass, cutoff);</p>
  1787. <p class=desc>blah blah blah blah
  1788. </p>
  1789. <p class=func><span class=keyword>enhanceBassEnable</span>(n);</p>
  1790. <p class=desc>blah blah blah blah
  1791. </p>
  1792. <p class=func><span class=keyword>enhanceBassEnable</span>();</p>
  1793. <p class=desc>blah blah blah blah
  1794. </p>
  1795. <p class=func><span class=keyword>surroundSound</span>(width);</p>
  1796. <p class=desc>blah blah blah blah
  1797. </p>
  1798. <p class=func><span class=keyword>surroundSound</span>(width, select);</p>
  1799. <p class=desc>blah blah blah blah
  1800. </p>
  1801. <p class=func><span class=keyword>surroundSoundEnable</span>(n);</p>
  1802. <p class=desc>blah blah blah blah
  1803. </p>
  1804. <p class=func><span class=keyword>surroundSoundEnable</span>();</p>
  1805. <p class=desc>blah blah blah blah
  1806. </p>
  1807. <p class=func><span class=keyword>killAutomation</span>();</p>
  1808. <p class=desc>blah blah blah blah
  1809. </p>
  1810. <h3>Notes</h3>
  1811. <p>TODO: how does the input AGC work
  1812. </p>
  1813. <p>TODO: document signal routing
  1814. </p>
  1815. <p>TODO: line level output adjust is weird arbitrary integers. Should this be
  1816. made into more sensible numbers, or do we just document the integer-voltage
  1817. measurements that correspond to the audio shield's hardware?
  1818. </p>
  1819. <p>TODO: make some sense out of the terribly complex audio processor features &amp; options!
  1820. </p>
  1821. <p>TODO: can some of these enable functions be eliminated and have those features
  1822. automatically enabled or disabled depending on whether the route() function has
  1823. configured signals to/from them?
  1824. </p>
  1825. </script>
  1826. <script type="text/x-red" data-template-name="AudioControlSGTL5000">
  1827. <div class="form-row">
  1828. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  1829. <input type="text" id="node-input-name" placeholder="Name">
  1830. </div>
  1831. </script>
  1832. <script type="text/javascript">
  1833. RED.nodes.registerType('AudioControlWM8731',{
  1834. shortName: "wm8731",
  1835. inputs:0,
  1836. outputs:0,
  1837. category: 'control-function',
  1838. color:"#E6E0F8",
  1839. icon: "arrow-in.png"
  1840. });
  1841. </script>
  1842. <script type="text/x-red" data-help-name="AudioControlWM8731">
  1843. <h3>Summary</h3>
  1844. <p>Control a WM8731 chip in slave mode, where it receives all clocks from Teensy</p>
  1845. <h3>Audio Connections</h3>
  1846. <p>This object has no audio inputs or outputs. Separate i2s objects
  1847. are used to send and receive audio data. I2S master mode objects
  1848. must be used, since this control object configures the WM8731 into
  1849. slave mode.
  1850. </p>
  1851. <h3>Functions</h3>
  1852. <p class=func><span class=keyword>enable</span>();</p>
  1853. <p class=desc>blah blah blah blah
  1854. </p>
  1855. <p class=func><span class=keyword>disable</span>();</p>
  1856. <p class=desc>not implemented
  1857. </p>
  1858. <p class=func><span class=keyword>volume</span>(level);</p>
  1859. <p class=desc>blah blah blah blah
  1860. </p>
  1861. <p class=func><span class=keyword>inputLevel</span>(level);</p>
  1862. <p class=desc>not implemented
  1863. </p>
  1864. <p class=func><span class=keyword>inputSelect</span>(input);</p>
  1865. <p class=desc>not implemented
  1866. </p>
  1867. <h3>Notes</h3>
  1868. <p></p>
  1869. </script>
  1870. <script type="text/x-red" data-template-name="AudioControlWM8731">
  1871. <div class="form-row">
  1872. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  1873. <input type="text" id="node-input-name" placeholder="Name">
  1874. </div>
  1875. </script>
  1876. <script type="text/javascript">
  1877. RED.nodes.registerType('AudioControlWM8731master',{
  1878. shortName: "wm8731m",
  1879. inputs:0,
  1880. outputs:0,
  1881. category: 'control-function',
  1882. color:"#E6E0F8",
  1883. icon: "arrow-in.png"
  1884. });
  1885. </script>
  1886. <script type="text/x-red" data-help-name="AudioControlWM8731master">
  1887. <h3>Summary</h3>
  1888. <p>Control a WM8731 chip in master mode, where it controls all I2S timing.</p>
  1889. <h3>Audio Connections</h3>
  1890. <p>This object has no audio inputs or outputs. Separate i2s objects
  1891. are used to send and receive audio data. I2S slave mode objects
  1892. must be used, since this control object configures the WM8731 into
  1893. master mode.
  1894. </p>
  1895. <h3>Functions</h3>
  1896. <p class=func><span class=keyword>enable</span>();</p>
  1897. <p class=desc>blah blah blah blah
  1898. </p>
  1899. <p class=func><span class=keyword>disable</span>();</p>
  1900. <p class=desc>not implemented
  1901. </p>
  1902. <p class=func><span class=keyword>volume</span>(level);</p>
  1903. <p class=desc>blah blah blah blah
  1904. </p>
  1905. <p class=func><span class=keyword>inputLevel</span>(level);</p>
  1906. <p class=desc>not implemented
  1907. </p>
  1908. <p class=func><span class=keyword>inputSelect</span>(input);</p>
  1909. <p class=desc>not implemented
  1910. </p>
  1911. <h3>Notes</h3>
  1912. <p></p>
  1913. </script>
  1914. <script type="text/x-red" data-template-name="AudioControlWM8731master">
  1915. <div class="form-row">
  1916. <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  1917. <input type="text" id="node-input-name" placeholder="Name">
  1918. </div>
  1919. </script>