Skip to content

Commit 04bec6f

Browse files
pschatzmannpschatzmann
committed
Naming conventions and doxygen
1 parent f4e76fc commit 04bec6f

File tree

85 files changed

+4043
-1132
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+4043
-1132
lines changed

‎docs/html/_snap_client_8h_source.html

Lines changed: 135 additions & 129 deletions
Large diffs are not rendered by default.

‎docs/html/_snap_common_8h_source.html

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -88,31 +88,31 @@
8888
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; }</div>
8989
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;};</div>
9090
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
91-
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="struct_snap_time_points.html"> 30</a></span>&#160;<span class="keyword">struct </span><a class="code" href="struct_snap_time_points.html">SnapTimePoints</a> {</div>
92-
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; uint32_t local_ms = millis();</div>
93-
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; uint32_t server_ms;</div>
94-
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <a class="code" href="struct_snap_time_points.html">SnapTimePoints</a>() = <span class="keywordflow">default</span>;</div>
95-
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <a class="code" href="struct_snap_time_points.html">SnapTimePoints</a>(uint32_t serverMs){</div>
96-
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; server_ms = serverMs;</div>
97-
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; }</div>
98-
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;};</div>
99-
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
91+
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="struct_snap_time_points.html"> 31</a></span>&#160;<span class="keyword">struct </span><a class="code" href="struct_snap_time_points.html">SnapTimePoints</a> {</div>
92+
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; uint32_t local_ms = millis();</div>
93+
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; uint32_t server_ms;</div>
94+
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <a class="code" href="struct_snap_time_points.html">SnapTimePoints</a>() = <span class="keywordflow">default</span>;</div>
95+
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <a class="code" href="struct_snap_time_points.html">SnapTimePoints</a>(uint32_t serverMs){</div>
96+
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; server_ms = serverMs;</div>
97+
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; }</div>
98+
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;};</div>
10099
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
101-
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="keyword">inline</span> <span class="keywordtype">void</span> checkHeap() {</div>
102-
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#if CONFIG_CHECK_HEAP &amp;&amp; defined(ESP32)</span></div>
103-
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; heap_caps_check_integrity_all(<span class="keyword">true</span>);</div>
104-
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#endif</span></div>
105-
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;}</div>
106-
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
107-
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="keyword">inline</span> <span class="keywordtype">void</span> logHeap() {</div>
108-
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#ifdef ESP32</span></div>
109-
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; ESP_LOGD(TAG, <span class="stringliteral">&quot;Free Heap: %d / Free Heap PSRAM %d&quot;</span>, ESP.getFreeHeap(),</div>
110-
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; ESP.getFreePsram());</div>
111-
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="preprocessor">#endif</span></div>
112-
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;}</div>
113-
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
100+
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
101+
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="keyword">inline</span> <span class="keywordtype">void</span> checkHeap() {</div>
102+
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#if CONFIG_CHECK_HEAP &amp;&amp; defined(ESP32)</span></div>
103+
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; heap_caps_check_integrity_all(<span class="keyword">true</span>);</div>
104+
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor">#endif</span></div>
105+
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;}</div>
106+
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
107+
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="keyword">inline</span> <span class="keywordtype">void</span> logHeap() {</div>
108+
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor">#ifdef ESP32</span></div>
109+
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; ESP_LOGD(TAG, <span class="stringliteral">&quot;Free Heap: %d / Free Heap PSRAM %d&quot;</span>, ESP.getFreeHeap(),</div>
110+
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; ESP.getFreePsram());</div>
111+
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="preprocessor">#endif</span></div>
112+
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;}</div>
113+
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
114114
<div class="ttc" id="astruct_snap_audio_header_html"><div class="ttname"><a href="struct_snap_audio_header.html">SnapAudioHeader</a></div><div class="ttdoc">Information about the next bucket.</div><div class="ttdef"><b>Definition:</b> SnapCommon.h:19</div></div>
115-
<div class="ttc" id="astruct_snap_time_points_html"><div class="ttname"><a href="struct_snap_time_points.html">SnapTimePoints</a></div><div class="ttdef"><b>Definition:</b> SnapCommon.h:30</div></div>
115+
<div class="ttc" id="astruct_snap_time_points_html"><div class="ttname"><a href="struct_snap_time_points.html">SnapTimePoints</a></div><div class="ttdoc">Recording of local_ms and server_ms.</div><div class="ttdef"><b>Definition:</b> SnapCommon.h:31</div></div>
116116
</div><!-- fragment --></div><!-- contents -->
117117
<!-- start footer part -->
118118
<hr class="footer"/><address class="footer"><small>

‎docs/html/_snap_output_8h_source.html

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -237,13 +237,13 @@
237237
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160; </div>
238238
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; <span class="keywordflow">if</span> (!is_sync_started) {</div>
239239
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160; </div>
240-
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; ts.begin(audio_info.sample_rate);</div>
240+
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; ts.<a class="code" href="class_snap_time_sync.html#a4574307f85a0f36e8f25910d3361f84e">begin</a>(audio_info.sample_rate);</div>
241241
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160; </div>
242242
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160; <span class="comment">// start audio when first package in the future becomes valid</span></div>
243243
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160; result = synchronizeOnStart(delay_ms);</div>
244244
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160; } <span class="keywordflow">else</span> {</div>
245245
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160; </div>
246-
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160; <span class="keywordflow">if</span> (ts.isSync()) {</div>
246+
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160; <span class="keywordflow">if</span> (ts.<a class="code" href="class_snap_time_sync.html#ae361c9a0939daff16cd8652325124905">isSync</a>()) {</div>
247247
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160; <span class="comment">// update speed</span></div>
248248
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160; <span class="keywordtype">float</span> current_factor = <a class="code" href="class_snap_output.html#a6f02241f9435b0062580626d1894a573">playbackFactor</a>();</div>
249249
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160; <span class="keywordtype">float</span> new_factor = p_snap_time_sync-&gt;<a class="code" href="class_snap_time_sync.html#a47e677c2396350208f1a2499fced812a">getFactor</a>();</div>
@@ -301,12 +301,14 @@
301301
<div class="ttc" id="aclass_snap_output_html_aac98818fc690c70b6413fc52fc6b82f7"><div class="ttname"><a href="class_snap_output.html#aac98818fc690c70b6413fc52fc6b82f7">SnapOutput::synchronizePlayback</a></div><div class="ttdeci">bool synchronizePlayback()</div><div class="ttdef"><b>Definition:</b> SnapOutput.h:188</div></div>
302302
<div class="ttc" id="aclass_snap_output_html_ad703cdbab7c0a7f312178595a1fb2f58"><div class="ttname"><a href="class_snap_output.html#ad703cdbab7c0a7f312178595a1fb2f58">SnapOutput::setSnapTimeSync</a></div><div class="ttdeci">void setSnapTimeSync(SnapTimeSync &amp;timeSync)</div><div class="ttdoc">Defines the time synchronization logic.</div><div class="ttdef"><b>Definition:</b> SnapOutput.h:132</div></div>
303303
<div class="ttc" id="aclass_snap_output_html_af8e0a63ec718201627220299012e654f"><div class="ttname"><a href="class_snap_output.html#af8e0a63ec718201627220299012e654f">SnapOutput::end</a></div><div class="ttdeci">virtual void end(void)</div><div class="ttdoc">Ends the processing and releases the memory.</div><div class="ttdef"><b>Definition:</b> SnapOutput.h:57</div></div>
304-
<div class="ttc" id="aclass_snap_time_html"><div class="ttname"><a href="class_snap_time.html">SnapTime</a></div><div class="ttdoc">We use the the sys/time functions to represent the server time. The local time will be measured with ...</div><div class="ttdef"><b>Definition:</b> SnapTime.h:15</div></div>
305-
<div class="ttc" id="aclass_snap_time_html_a2d46ea8f99a7fe6583f6d72a5f9c9afa"><div class="ttname"><a href="class_snap_time.html#a2d46ea8f99a7fe6583f6d72a5f9c9afa">SnapTime::serverMillis</a></div><div class="ttdeci">uint32_t serverMillis()</div><div class="ttdoc">Provides the current server time in ms.</div><div class="ttdef"><b>Definition:</b> SnapTime.h:56</div></div>
306-
<div class="ttc" id="aclass_snap_time_sync_dynamic_html"><div class="ttname"><a href="class_snap_time_sync_dynamic.html">SnapTimeSyncDynamic</a></div><div class="ttdoc">Dynamically adjusts the effective playback sample rate based on the differences of the local and serv...</div><div class="ttdef"><b>Definition:</b> SnapTimeSync.h:88</div></div>
307-
<div class="ttc" id="aclass_snap_time_sync_html"><div class="ttname"><a href="class_snap_time_sync.html">SnapTimeSync</a></div><div class="ttdoc">Abstract (Common) Time Synchronization Logic.</div><div class="ttdef"><b>Definition:</b> SnapTimeSync.h:13</div></div>
304+
<div class="ttc" id="aclass_snap_time_html"><div class="ttname"><a href="class_snap_time.html">SnapTime</a></div><div class="ttdoc">The the sys/time functions are used to represent the server time. The local time will be measured wit...</div><div class="ttdef"><b>Definition:</b> SnapTime.h:16</div></div>
305+
<div class="ttc" id="aclass_snap_time_html_a2d46ea8f99a7fe6583f6d72a5f9c9afa"><div class="ttname"><a href="class_snap_time.html#a2d46ea8f99a7fe6583f6d72a5f9c9afa">SnapTime::serverMillis</a></div><div class="ttdeci">uint32_t serverMillis()</div><div class="ttdoc">Provides the current server time in ms.</div><div class="ttdef"><b>Definition:</b> SnapTime.h:36</div></div>
306+
<div class="ttc" id="aclass_snap_time_sync_dynamic_html"><div class="ttname"><a href="class_snap_time_sync_dynamic.html">SnapTimeSyncDynamic</a></div><div class="ttdoc">Dynamically adjusts the effective playback sample rate based on the differences of the local and serv...</div><div class="ttdef"><b>Definition:</b> SnapTimeSync.h:83</div></div>
307+
<div class="ttc" id="aclass_snap_time_sync_html"><div class="ttname"><a href="class_snap_time_sync.html">SnapTimeSync</a></div><div class="ttdoc">Abstract (Common) Time Synchronization Logic which consists of the startup synchronization and the lo...</div><div class="ttdef"><b>Definition:</b> SnapTimeSync.h:15</div></div>
308+
<div class="ttc" id="aclass_snap_time_sync_html_a4574307f85a0f36e8f25910d3361f84e"><div class="ttname"><a href="class_snap_time_sync.html#a4574307f85a0f36e8f25910d3361f84e">SnapTimeSync::begin</a></div><div class="ttdeci">void begin(int rate)</div><div class="ttdoc">Starts the processing.</div><div class="ttdef"><b>Definition:</b> SnapTimeSync.h:23</div></div>
308309
<div class="ttc" id="aclass_snap_time_sync_html_a47e677c2396350208f1a2499fced812a"><div class="ttname"><a href="class_snap_time_sync.html#a47e677c2396350208f1a2499fced812a">SnapTimeSync::getFactor</a></div><div class="ttdeci">virtual float getFactor()=0</div></div>
309-
<div class="ttc" id="aclass_snap_time_sync_html_a8a84aacea77de2dfdc9827cb7f71c735"><div class="ttname"><a href="class_snap_time_sync.html#a8a84aacea77de2dfdc9827cb7f71c735">SnapTimeSync::getStartDelay</a></div><div class="ttdeci">int getStartDelay()</div><div class="ttdef"><b>Definition:</b> SnapTimeSync.h:61</div></div>
310+
<div class="ttc" id="aclass_snap_time_sync_html_a8a84aacea77de2dfdc9827cb7f71c735"><div class="ttname"><a href="class_snap_time_sync.html#a8a84aacea77de2dfdc9827cb7f71c735">SnapTimeSync::getStartDelay</a></div><div class="ttdeci">int getStartDelay()</div><div class="ttdef"><b>Definition:</b> SnapTimeSync.h:57</div></div>
311+
<div class="ttc" id="aclass_snap_time_sync_html_ae361c9a0939daff16cd8652325124905"><div class="ttname"><a href="class_snap_time_sync.html#ae361c9a0939daff16cd8652325124905">SnapTimeSync::isSync</a></div><div class="ttdeci">bool isSync()</div><div class="ttdoc">Returns true if a synchronization (update of the sampling rate) is needed.</div><div class="ttdef"><b>Definition:</b> SnapTimeSync.h:35</div></div>
310312
<div class="ttc" id="astruct_snap_audio_header_html"><div class="ttname"><a href="struct_snap_audio_header.html">SnapAudioHeader</a></div><div class="ttdoc">Information about the next bucket.</div><div class="ttdef"><b>Definition:</b> SnapCommon.h:19</div></div>
311313
</div><!-- fragment --></div><!-- contents -->
312314
<!-- start footer part -->

0 commit comments

Comments
 (0)