mirror of
https://github.com/pschatzmann/arduino-audio-tools.git
synced 2024-09-21 10:27:27 +00:00
166 lines
18 KiB
HTML
166 lines
18 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>arduino-audio-tools: src/AudioAnalog/AnalogConfigStd.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">arduino-audio-tools
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_e17dc613c942c72183ae804ec7e3c7c5.html">AudioAnalog</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">AnalogConfigStd.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#include "AudioConfig.h"</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor">#include "AudioTools/AudioTypes.h"</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>  </div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#ifndef PIN_ANALOG_START</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor"># define PIN_ANALOG_START -1</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  </div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#ifndef ANALOG_BUFFERS</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor"># define ANALOG_BUFFERS 10</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  </div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#ifndef ANALOG_MAX_OUT_CHANNELS</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor"># define ANALOG_MAX_OUT_CHANNELS 10</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  </div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">namespace </span><a class="code" href="namespaceaudio__tools.html">audio_tools</a> {</div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">class </span>AnalogAudioArduino;</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_analog_config_std.html"> 29</a></span> <span class="keyword">class </span><a class="code" href="classaudio__tools_1_1_analog_config_std.html">AnalogConfigStd</a> : <span class="keyword">public</span> <a class="code" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> {</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classaudio__tools_1_1_analog_audio_arduino.html">AnalogAudioArduino</a>;</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordtype">int</span> buffer_count = ANALOG_BUFFERS;</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordtype">int</span> buffer_size = ANALOG_BUFFER_SIZE;</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <a class="code" href="group__basic.html#ga8cbd91a8bac9b5ab425112be1620eb49">RxTxMode</a> rx_tx_mode = RX_MODE;</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordtype">bool</span> is_blocking_write = <span class="keyword">true</span>;</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordtype">bool</span> is_auto_center_read = <span class="keyword">true</span>;</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordtype">int</span> max_sample_rate = ANALOG_MAX_SAMPLE_RATE;</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">int</span> start_pin = PIN_ANALOG_START;</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="classaudio__tools_1_1_analog_config_std.html">AnalogConfigStd</a>() = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="classaudio__tools_1_1_analog_config_std.html">AnalogConfigStd</a>(<a class="code" href="group__basic.html#ga8cbd91a8bac9b5ab425112be1620eb49">RxTxMode</a> rxtxMode) : <a class="code" href="structaudio__tools_1_1_audio_info.html#aed5ea168bca8ad2991118811c4c83c6d">AudioInfo</a>() {</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  rx_tx_mode = rxtxMode;</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  }</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T, <span class="keywordtype">int</span> N></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_analog_config_std.html#afa02591016f150d10c49a84fcfc27fb0"> 47</a></span>  <span class="keywordtype">void</span> <a class="code" href="classaudio__tools_1_1_analog_config_std.html#afa02591016f150d10c49a84fcfc27fb0">setPins</a>(T (&a)[N]) {</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  pins_data.clear();</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  pins_data.resize(N);</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < N; ++i) {</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  pins_data[i] = a[i]; <span class="comment">// reset all elements</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  }</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  }</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// /// Defines the pins and the corresponding number of channels (=number of</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// /// pins)</span></div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// void setPins(Pins &pins) {</span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">// pins_data.clear();</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">// for (int i = 0; i < pins.size(); i++) {</span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">// pins_data.push_back(pins[i]);</span></div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">// }</span></div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="comment">// }</span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_analog_config_std.html#a442c670f12c972b1701609070f85ea94"> 65</a></span>  <a class="code" href="classaudio__tools_1_1_vector.html">Pins</a> &<a class="code" href="classaudio__tools_1_1_analog_config_std.html#a442c670f12c972b1701609070f85ea94">pins</a>() {</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">if</span> (pins_data.size() == 0 && start_pin >= 0) {</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  pins_data.resize(<a class="code" href="structaudio__tools_1_1_audio_info.html#a1ac7822956f57069d76da865d6b33c55">channels</a>);</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> j = 0; j < <a class="code" href="structaudio__tools_1_1_audio_info.html#a1ac7822956f57069d76da865d6b33c55">channels</a>; j++) {</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  pins_data[j] = start_pin + j;</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  }</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  }</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">return</span> pins_data;</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  }</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">protected</span>:</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <a class="code" href="classaudio__tools_1_1_vector.html">Pins</a> pins_data{0};</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  </div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> };</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor">#ifndef ANALOG_CONFIG</span></div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor">#define ANALOG_CONFIG</span></div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="keyword">using</span> AnalogConfig = AnalogConfigStd;</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> } <span class="comment">// ns</span></div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor">#</span><span class="comment">//endif</span></div>
|
|
<div class="ttc" id="aclassaudio__tools_1_1_analog_audio_arduino_html"><div class="ttname"><a href="classaudio__tools_1_1_analog_audio_arduino.html">audio_tools::AnalogAudioArduino</a></div><div class="ttdoc">Analog Data IO using a timer and the Arduino analogRead() method and writing using analogWrite();.</div><div class="ttdef"><b>Definition:</b> AnalogAudioArduino.h:22</div></div>
|
|
<div class="ttc" id="aclassaudio__tools_1_1_analog_config_std_html"><div class="ttname"><a href="classaudio__tools_1_1_analog_config_std.html">audio_tools::AnalogConfigStd</a></div><div class="ttdoc">Generic ADC and DAC configuration.</div><div class="ttdef"><b>Definition:</b> AnalogConfigStd.h:29</div></div>
|
|
<div class="ttc" id="aclassaudio__tools_1_1_analog_config_std_html_a442c670f12c972b1701609070f85ea94"><div class="ttname"><a href="classaudio__tools_1_1_analog_config_std.html#a442c670f12c972b1701609070f85ea94">audio_tools::AnalogConfigStd::pins</a></div><div class="ttdeci">Pins & pins()</div><div class="ttdoc">Determines the pins (for all channels)</div><div class="ttdef"><b>Definition:</b> AnalogConfigStd.h:65</div></div>
|
|
<div class="ttc" id="aclassaudio__tools_1_1_analog_config_std_html_afa02591016f150d10c49a84fcfc27fb0"><div class="ttname"><a href="classaudio__tools_1_1_analog_config_std.html#afa02591016f150d10c49a84fcfc27fb0">audio_tools::AnalogConfigStd::setPins</a></div><div class="ttdeci">void setPins(T(&a)[N])</div><div class="ttdoc">support assignament of int array</div><div class="ttdef"><b>Definition:</b> AnalogConfigStd.h:47</div></div>
|
|
<div class="ttc" id="aclassaudio__tools_1_1_vector_html"><div class="ttname"><a href="classaudio__tools_1_1_vector.html">audio_tools::Vector< int ></a></div></div>
|
|
<div class="ttc" id="agroup__basic_html_ga8cbd91a8bac9b5ab425112be1620eb49"><div class="ttname"><a href="group__basic.html#ga8cbd91a8bac9b5ab425112be1620eb49">audio_tools::RxTxMode</a></div><div class="ttdeci">RxTxMode</div><div class="ttdoc">The Microcontroller is the Audio Source (TX_MODE) or Audio Sink (RX_MODE). RXTX_MODE is Source and Si...</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:26</div></div>
|
|
<div class="ttc" id="anamespaceaudio__tools_html"><div class="ttname"><a href="namespaceaudio__tools.html">audio_tools</a></div><div class="ttdoc">Generic Implementation of sound input and output for desktop environments using portaudio.</div><div class="ttdef"><b>Definition:</b> AnalogAudioArduino.h:12</div></div>
|
|
<div class="ttc" id="astructaudio__tools_1_1_audio_info_html"><div class="ttname"><a href="structaudio__tools_1_1_audio_info.html">audio_tools::AudioInfo</a></div><div class="ttdoc">Basic Audio information which drives e.g. I2S.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:50</div></div>
|
|
<div class="ttc" id="astructaudio__tools_1_1_audio_info_html_a1ac7822956f57069d76da865d6b33c55"><div class="ttname"><a href="structaudio__tools_1_1_audio_info.html#a1ac7822956f57069d76da865d6b33c55">audio_tools::AudioInfo::channels</a></div><div class="ttdeci">uint16_t channels</div><div class="ttdoc">Number of channels: 2=stereo, 1=mono.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:55</div></div>
|
|
<div class="ttc" id="astructaudio__tools_1_1_audio_info_html_aed5ea168bca8ad2991118811c4c83c6d"><div class="ttname"><a href="structaudio__tools_1_1_audio_info.html#aed5ea168bca8ad2991118811c4c83c6d">audio_tools::AudioInfo::AudioInfo</a></div><div class="ttdeci">AudioInfo()=default</div><div class="ttdoc">Default constructor.</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|