Skip to content

Commit

Permalink
Deploying to doxygen from @ e9d6580 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@pschatzmann
pschatzmann committed Oct 25, 2023
1 parent 7208a42 commit fb64fbf
Show file tree
Hide file tree
Showing 2 changed files with 313 additions and 308 deletions.
72 changes: 38 additions & 34 deletions _i2_s_config_std_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -122,40 +122,44 @@
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordtype">int</span> buffer_count = I2S_BUFFER_COUNT;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordtype">int</span> buffer_size = I2S_BUFFER_SIZE;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="preprocessor">#if defined(USE_ALT_PIN_SUPPORT)</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordtype">bool</span> is_arduino_pin_numbers = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordtype">void</span> logInfo(<span class="keyword">const</span> <span class="keywordtype">char</span>* source=<span class="keyword">nullptr</span>) {</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; AudioInfo::logInfo(source);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; LOGI(<span class="stringliteral">&quot;rx/tx mode: %s&quot;</span>, <a class="code" href="namespaceaudio__tools.html#ad79aae4ad20c15c6daa69209dc3d0535">RxTxModeNames</a>[<a class="code" href="classaudio__tools_1_1_i2_s_config_std.html#a31a454d24fb1f4d74779a0ff668d54cc">rx_tx_mode</a>]);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="comment">//LOGI(&quot;port_no: %d&quot;, port_no);</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; LOGI(<span class="stringliteral">&quot;is_master: %s&quot;</span>, is_master ? <span class="stringliteral">&quot;Master&quot;</span>:<span class="stringliteral">&quot;Slave&quot;</span>);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; LOGI(<span class="stringliteral">&quot;sample rate: %d&quot;</span>, <a class="code" href="structaudio__tools_1_1_audio_info.html#a527325650d66abd9626499785b3bafd2">sample_rate</a>);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; LOGI(<span class="stringliteral">&quot;bits per sample: %d&quot;</span>, <a class="code" href="structaudio__tools_1_1_audio_info.html#a2ae049b225e845689c9bfab94ebbc697">bits_per_sample</a>);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; LOGI(<span class="stringliteral">&quot;number of channels: %d&quot;</span>, <a class="code" href="structaudio__tools_1_1_audio_info.html#a178795099d0608972755dfef8d8367e3">channels</a>);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; LOGI(<span class="stringliteral">&quot;i2s_format: %s&quot;</span>, i2s_formats[i2s_format]); </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; LOGI(<span class="stringliteral">&quot;buffer_count:%d&quot;</span>,buffer_count);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; LOGI(<span class="stringliteral">&quot;buffer_size:%d&quot;</span>,buffer_size);</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keywordflow">if</span> (pin_mck!=-1)</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; LOGI(<span class="stringliteral">&quot;pin_mck: %d&quot;</span>, pin_mck);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordflow">if</span> (pin_bck!=-1)</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; LOGI(<span class="stringliteral">&quot;pin_bck: %d&quot;</span>, pin_bck);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keywordflow">if</span> (pin_ws!=-1)</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; LOGI(<span class="stringliteral">&quot;pin_ws: %d&quot;</span>, pin_ws);</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keywordflow">if</span> (pin_data!=-1)</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; LOGI(<span class="stringliteral">&quot;pin_data: %d&quot;</span>, pin_data);</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keywordflow">if</span> (pin_data_rx!=-1 &amp;&amp; <a class="code" href="classaudio__tools_1_1_i2_s_config_std.html#a31a454d24fb1f4d74779a0ff668d54cc">rx_tx_mode</a>==RXTX_MODE){</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; LOGI(<span class="stringliteral">&quot;pin_data_rx: %d&quot;</span>, pin_data_rx);</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; }</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; }</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;};</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;<span class="keyword">using</span> I2SConfig = I2SConfigStd;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;}</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="preprocessor">#if defined(RP2040_HOWER)</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordtype">int</span> mck_multiplier = 64;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="preprocessor">#if defined(USE_ALT_PIN_SUPPORT)</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordtype">bool</span> is_arduino_pin_numbers = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keywordtype">void</span> logInfo(<span class="keyword">const</span> <span class="keywordtype">char</span>* source=<span class="keyword">nullptr</span>) {</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; AudioInfo::logInfo(source);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; LOGI(<span class="stringliteral">&quot;rx/tx mode: %s&quot;</span>, <a class="code" href="namespaceaudio__tools.html#ad79aae4ad20c15c6daa69209dc3d0535">RxTxModeNames</a>[<a class="code" href="classaudio__tools_1_1_i2_s_config_std.html#a31a454d24fb1f4d74779a0ff668d54cc">rx_tx_mode</a>]);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="comment">//LOGI(&quot;port_no: %d&quot;, port_no);</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; LOGI(<span class="stringliteral">&quot;is_master: %s&quot;</span>, is_master ? <span class="stringliteral">&quot;Master&quot;</span>:<span class="stringliteral">&quot;Slave&quot;</span>);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; LOGI(<span class="stringliteral">&quot;sample rate: %d&quot;</span>, <a class="code" href="structaudio__tools_1_1_audio_info.html#a527325650d66abd9626499785b3bafd2">sample_rate</a>);</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; LOGI(<span class="stringliteral">&quot;bits per sample: %d&quot;</span>, <a class="code" href="structaudio__tools_1_1_audio_info.html#a2ae049b225e845689c9bfab94ebbc697">bits_per_sample</a>);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; LOGI(<span class="stringliteral">&quot;number of channels: %d&quot;</span>, <a class="code" href="structaudio__tools_1_1_audio_info.html#a178795099d0608972755dfef8d8367e3">channels</a>);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; LOGI(<span class="stringliteral">&quot;i2s_format: %s&quot;</span>, i2s_formats[i2s_format]); </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; LOGI(<span class="stringliteral">&quot;buffer_count:%d&quot;</span>,buffer_count);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; LOGI(<span class="stringliteral">&quot;buffer_size:%d&quot;</span>,buffer_size);</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keywordflow">if</span> (pin_mck!=-1)</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; LOGI(<span class="stringliteral">&quot;pin_mck: %d&quot;</span>, pin_mck);</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keywordflow">if</span> (pin_bck!=-1)</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; LOGI(<span class="stringliteral">&quot;pin_bck: %d&quot;</span>, pin_bck);</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordflow">if</span> (pin_ws!=-1)</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; LOGI(<span class="stringliteral">&quot;pin_ws: %d&quot;</span>, pin_ws);</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keywordflow">if</span> (pin_data!=-1)</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; LOGI(<span class="stringliteral">&quot;pin_data: %d&quot;</span>, pin_data);</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keywordflow">if</span> (pin_data_rx!=-1 &amp;&amp; <a class="code" href="classaudio__tools_1_1_i2_s_config_std.html#a31a454d24fb1f4d74779a0ff668d54cc">rx_tx_mode</a>==RXTX_MODE){</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; LOGI(<span class="stringliteral">&quot;pin_data_rx: %d&quot;</span>, pin_data_rx);</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; }</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; }</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;};</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;<span class="keyword">using</span> I2SConfig = I2SConfigStd;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;}</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; </div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_config_std_html"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_config_std.html">audio_tools::I2SConfigStd</a></div><div class="ttdoc">Configuration for i2s.</div><div class="ttdef"><b>Definition:</b> I2SConfigStd.h:17</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_config_std_html_a31a454d24fb1f4d74779a0ff668d54cc"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_config_std.html#a31a454d24fb1f4d74779a0ff668d54cc">audio_tools::I2SConfigStd::rx_tx_mode</a></div><div class="ttdeci">RxTxMode rx_tx_mode</div><div class="ttdoc">public settings</div><div class="ttdef"><b>Definition:</b> I2SConfigStd.h:50</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_i2_s_config_std_html_a577a9f36faaa2baa2fca03a05c4a384f"><div class="ttname"><a href="classaudio__tools_1_1_i2_s_config_std.html#a577a9f36faaa2baa2fca03a05c4a384f">audio_tools::I2SConfigStd::I2SConfigStd</a></div><div class="ttdeci">I2SConfigStd(const I2SConfigStd &amp;cfg)=default</div><div class="ttdoc">Default Copy Constructor.</div></div>
Expand Down
Loading

0 comments on commit fb64fbf

Please sign in to comment.