Skip to content

Commit

Permalink
Deploying to doxygen from @ 8089a7b 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@pschatzmann
pschatzmann committed Oct 21, 2023
1 parent d771655 commit c1bdfe8
Show file tree
Hide file tree
Showing 8 changed files with 269 additions and 261 deletions.
61 changes: 33 additions & 28 deletions _communication_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -719,7 +719,7 @@
<div class="line"><a name="l00740"></a><span class="lineno"> 740</span>&#160; <a class="code" href="structaudio__tools_1_1_audio_info.html#a2ae049b225e845689c9bfab94ebbc697">bits_per_sample</a> = 16;</div>
<div class="line"><a name="l00741"></a><span class="lineno"> 741</span>&#160; <a class="code" href="structaudio__tools_1_1_audio_info.html#a178795099d0608972755dfef8d8367e3">channels</a> = 2;</div>
<div class="line"><a name="l00742"></a><span class="lineno"> 742</span>&#160; }</div>
<div class="line"><a name="l00743"></a><span class="lineno"> 743</span>&#160; <span class="keywordtype">int</span> correction_ms = 0;</div>
<div class="line"><a name="l00743"></a><span class="lineno"> 743</span>&#160; <span class="keywordtype">int</span> correction_us = 0;</div>
<div class="line"><a name="l00744"></a><span class="lineno"> 744</span>&#160;};</div>
<div class="line"><a name="l00745"></a><span class="lineno"> 745</span>&#160; </div>
<div class="line"><a name="l00752"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_throttle.html"> 752</a></span>&#160;<span class="keyword">class </span><a class="code" href="classaudio__tools_1_1_throttle.html">Throttle</a> {</div>
Expand All @@ -740,32 +740,38 @@
<div class="line"><a name="l00767"></a><span class="lineno"> 767</span>&#160; <span class="keywordtype">void</span> begin(<a class="code" href="structaudio__tools_1_1_throttle_config.html">ThrottleConfig</a> info) {</div>
<div class="line"><a name="l00768"></a><span class="lineno"> 768</span>&#160; this-&gt;info = info;</div>
<div class="line"><a name="l00769"></a><span class="lineno"> 769</span>&#160; bytesPerSample = info.<a class="code" href="structaudio__tools_1_1_audio_info.html#a2ae049b225e845689c9bfab94ebbc697">bits_per_sample</a> / 8 * info.<a class="code" href="structaudio__tools_1_1_audio_info.html#a178795099d0608972755dfef8d8367e3">channels</a>;</div>
<div class="line"><a name="l00770"></a><span class="lineno"> 770</span>&#160; }</div>
<div class="line"><a name="l00771"></a><span class="lineno"> 771</span>&#160; </div>
<div class="line"><a name="l00772"></a><span class="lineno"> 772</span>&#160; <span class="comment">// starts the timing</span></div>
<div class="line"><a name="l00773"></a><span class="lineno"> 773</span>&#160; <span class="keywordtype">void</span> startDelay() { start_time = <a class="code" href="namespaceaudio__tools.html#a51ca22f5e92260d1d3f69724a51c551a">millis</a>(); }</div>
<div class="line"><a name="l00774"></a><span class="lineno"> 774</span>&#160; </div>
<div class="line"><a name="l00775"></a><span class="lineno"> 775</span>&#160; <span class="comment">// delay</span></div>
<div class="line"><a name="l00776"></a><span class="lineno"> 776</span>&#160; <span class="keywordtype">void</span> delayBytes(<span class="keywordtype">size_t</span> bytes) { delaySamples(bytes / bytesPerSample); }</div>
<div class="line"><a name="l00777"></a><span class="lineno"> 777</span>&#160; </div>
<div class="line"><a name="l00778"></a><span class="lineno"> 778</span>&#160; <span class="comment">// delay</span></div>
<div class="line"><a name="l00779"></a><span class="lineno"> 779</span>&#160; <span class="keywordtype">void</span> delaySamples(<span class="keywordtype">size_t</span> samples) {</div>
<div class="line"><a name="l00780"></a><span class="lineno"> 780</span>&#160; <span class="keywordtype">int</span> durationMsEff = <a class="code" href="namespaceaudio__tools.html#a51ca22f5e92260d1d3f69724a51c551a">millis</a>() - start_time;</div>
<div class="line"><a name="l00781"></a><span class="lineno"> 781</span>&#160; <span class="keywordtype">int</span> durationToBe = (samples * 1000) / info.<a class="code" href="structaudio__tools_1_1_audio_info.html#a527325650d66abd9626499785b3bafd2">sample_rate</a>;</div>
<div class="line"><a name="l00782"></a><span class="lineno"> 782</span>&#160; <span class="keywordtype">int</span> waitMs = durationToBe - durationMsEff + info.correction_ms;</div>
<div class="line"><a name="l00783"></a><span class="lineno"> 783</span>&#160; LOGI(<span class="stringliteral">&quot;wait: %d&quot;</span>, waitMs);</div>
<div class="line"><a name="l00784"></a><span class="lineno"> 784</span>&#160; <span class="keywordflow">if</span> (waitMs &gt; 0) {</div>
<div class="line"><a name="l00785"></a><span class="lineno"> 785</span>&#160; <a class="code" href="namespaceaudio__tools.html#a504241b61d3595ad9356f8fccef71c20">delay</a>(waitMs);</div>
<div class="line"><a name="l00786"></a><span class="lineno"> 786</span>&#160; }</div>
<div class="line"><a name="l00787"></a><span class="lineno"> 787</span>&#160; }</div>
<div class="line"><a name="l00788"></a><span class="lineno"> 788</span>&#160; </div>
<div class="line"><a name="l00789"></a><span class="lineno"> 789</span>&#160; <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00790"></a><span class="lineno"> 790</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> start_time;</div>
<div class="line"><a name="l00791"></a><span class="lineno"> 791</span>&#160; <a class="code" href="structaudio__tools_1_1_throttle_config.html">ThrottleConfig</a> info;</div>
<div class="line"><a name="l00792"></a><span class="lineno"> 792</span>&#160; <span class="keywordtype">int</span> bytesPerSample;</div>
<div class="line"><a name="l00793"></a><span class="lineno"> 793</span>&#160;};</div>
<div class="line"><a name="l00794"></a><span class="lineno"> 794</span>&#160; </div>
<div class="line"><a name="l00795"></a><span class="lineno"> 795</span>&#160;} <span class="comment">// namespace audio_tools</span></div>
<div class="line"><a name="l00770"></a><span class="lineno"> 770</span>&#160; startDelay();</div>
<div class="line"><a name="l00771"></a><span class="lineno"> 771</span>&#160; }</div>
<div class="line"><a name="l00772"></a><span class="lineno"> 772</span>&#160; </div>
<div class="line"><a name="l00773"></a><span class="lineno"> 773</span>&#160; <span class="comment">// starts the timing</span></div>
<div class="line"><a name="l00774"></a><span class="lineno"> 774</span>&#160; <span class="keywordtype">void</span> startDelay() { </div>
<div class="line"><a name="l00775"></a><span class="lineno"> 775</span>&#160; start_time = micros(); </div>
<div class="line"><a name="l00776"></a><span class="lineno"> 776</span>&#160; sum_samples = 0;</div>
<div class="line"><a name="l00777"></a><span class="lineno"> 777</span>&#160; }</div>
<div class="line"><a name="l00778"></a><span class="lineno"> 778</span>&#160; </div>
<div class="line"><a name="l00779"></a><span class="lineno"> 779</span>&#160; <span class="comment">// delay</span></div>
<div class="line"><a name="l00780"></a><span class="lineno"> 780</span>&#160; <span class="keywordtype">void</span> delayBytes(<span class="keywordtype">size_t</span> bytes) { delaySamples(bytes / bytesPerSample); }</div>
<div class="line"><a name="l00781"></a><span class="lineno"> 781</span>&#160; </div>
<div class="line"><a name="l00782"></a><span class="lineno"> 782</span>&#160; <span class="comment">// delay</span></div>
<div class="line"><a name="l00783"></a><span class="lineno"> 783</span>&#160; <span class="keywordtype">void</span> delaySamples(<span class="keywordtype">size_t</span> samples) {</div>
<div class="line"><a name="l00784"></a><span class="lineno"> 784</span>&#160; sum_samples += samples;</div>
<div class="line"><a name="l00785"></a><span class="lineno"> 785</span>&#160; int64_t durationUsEff = micros() - start_time;</div>
<div class="line"><a name="l00786"></a><span class="lineno"> 786</span>&#160; int64_t durationUsToBe = (sum_samples * 1000000) / info.<a class="code" href="structaudio__tools_1_1_audio_info.html#a527325650d66abd9626499785b3bafd2">sample_rate</a>;</div>
<div class="line"><a name="l00787"></a><span class="lineno"> 787</span>&#160; int64_t waitUs = durationUsToBe - durationUsEff + info.correction_us;</div>
<div class="line"><a name="l00788"></a><span class="lineno"> 788</span>&#160; LOGI(<span class="stringliteral">&quot;wait: %d&quot;</span>, waitUs);</div>
<div class="line"><a name="l00789"></a><span class="lineno"> 789</span>&#160; <span class="keywordflow">if</span> (waitUs &gt; 0) {</div>
<div class="line"><a name="l00790"></a><span class="lineno"> 790</span>&#160; delayMicroseconds(waitUs);</div>
<div class="line"><a name="l00791"></a><span class="lineno"> 791</span>&#160; }</div>
<div class="line"><a name="l00792"></a><span class="lineno"> 792</span>&#160; }</div>
<div class="line"><a name="l00793"></a><span class="lineno"> 793</span>&#160; </div>
<div class="line"><a name="l00794"></a><span class="lineno"> 794</span>&#160; <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00795"></a><span class="lineno"> 795</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> start_time;</div>
<div class="line"><a name="l00796"></a><span class="lineno"> 796</span>&#160; uint64_t sum_samples = 0;</div>
<div class="line"><a name="l00797"></a><span class="lineno"> 797</span>&#160; <a class="code" href="structaudio__tools_1_1_throttle_config.html">ThrottleConfig</a> info;</div>
<div class="line"><a name="l00798"></a><span class="lineno"> 798</span>&#160; <span class="keywordtype">int</span> bytesPerSample;</div>
<div class="line"><a name="l00799"></a><span class="lineno"> 799</span>&#160;};</div>
<div class="line"><a name="l00800"></a><span class="lineno"> 800</span>&#160; </div>
<div class="line"><a name="l00801"></a><span class="lineno"> 801</span>&#160;} <span class="comment">// namespace audio_tools</span></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_output_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_output.html">audio_tools::AudioOutput</a></div><div class="ttdoc">Abstract Audio Ouptut class.</div><div class="ttdef"><b>Definition:</b> AudioOutput.h:22</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_stream_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_stream.html">audio_tools::AudioStream</a></div><div class="ttdoc">Base class for all Audio Streams. It support the boolean operator to test if the object is ready with...</div><div class="ttdef"><b>Definition:</b> AudioStreams.h:47</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_sync_reader_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_sync_reader.html">audio_tools::AudioSyncReader</a></div><div class="ttdoc">Receving Audio Data over the wire and requesting for more data when done to synchronize the processin...</div><div class="ttdef"><b>Definition:</b> Communication.h:630</div></div>
Expand Down Expand Up @@ -811,7 +817,6 @@
<div class="ttc" id="aclassaudio__tools_1_1_u_d_p_stream_html_a8b281c48f356477aa8256b9d030e0b2e"><div class="ttname"><a href="classaudio__tools_1_1_u_d_p_stream.html#a8b281c48f356477aa8256b9d030e0b2e">audio_tools::UDPStream::begin</a></div><div class="ttdeci">uint8_t begin(uint16_t port, uint16_t port_ext=0)</div><div class="ttdoc">Starts to receive data from/with the indicated port.</div><div class="ttdef"><b>Definition:</b> Communication.h:443</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> AnalogAudio.h:10</div></div>
<div class="ttc" id="anamespaceaudio__tools_html_a504241b61d3595ad9356f8fccef71c20"><div class="ttname"><a href="namespaceaudio__tools.html#a504241b61d3595ad9356f8fccef71c20">audio_tools::delay</a></div><div class="ttdeci">void delay(uint64_t ms)</div><div class="ttdoc">Waits for the indicated milliseconds.</div><div class="ttdef"><b>Definition:</b> Millis.h:10</div></div>
<div class="ttc" id="anamespaceaudio__tools_html_a51ca22f5e92260d1d3f69724a51c551a"><div class="ttname"><a href="namespaceaudio__tools.html#a51ca22f5e92260d1d3f69724a51c551a">audio_tools::millis</a></div><div class="ttdeci">uint64_t millis()</div><div class="ttdoc">Returns the milliseconds since the start.</div><div class="ttdef"><b>Definition:</b> Millis.h:17</div></div>
<div class="ttc" id="astructaudio__tools_1_1_audio_confirm_data_to_receive_html"><div class="ttname"><a href="structaudio__tools_1_1_audio_confirm_data_to_receive.html">audio_tools::AudioConfirmDataToReceive</a></div><div class="ttdoc">Protocol Record for Request.</div><div class="ttdef"><b>Definition:</b> Communication.h:544</div></div>
<div class="ttc" id="astructaudio__tools_1_1_audio_data_begin_html"><div class="ttname"><a href="structaudio__tools_1_1_audio_data_begin.html">audio_tools::AudioDataBegin</a></div><div class="ttdoc">Protocal Record To Start.</div><div class="ttdef"><b>Definition:</b> Communication.h:529</div></div>
<div class="ttc" id="astructaudio__tools_1_1_audio_data_end_html"><div class="ttname"><a href="structaudio__tools_1_1_audio_data_end.html">audio_tools::AudioDataEnd</a></div><div class="ttdoc">Protocol Record for End.</div><div class="ttdef"><b>Definition:</b> Communication.h:550</div></div>
Expand Down
Loading

0 comments on commit c1bdfe8

Please sign in to comment.