mirror of
https://github.com/pschatzmann/arduino-audio-tools.git
synced 2024-09-21 10:27:27 +00:00
191 lines
21 KiB
HTML
191 lines
21 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/AudioBasic/Collections/Allocator.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_66daa4b65a9ea1734b247f7904e7ec97.html">AudioBasic</a></li><li class="navelem"><a class="el" href="dir_1e0d6afe4fdfc3aa347778900b8d9eea.html">Collections</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Allocator.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 <stdlib.h></span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "AudioConfig.h"</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include "AudioTools/AudioLogger.h"</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  </div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="keyword">namespace </span><a class="code" href="namespaceaudio__tools.html">audio_tools</a> {</div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  </div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_allocator.html"> 22</a></span> <span class="keyword">class </span><a class="code" href="classaudio__tools_1_1_allocator.html">Allocator</a> {</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="comment">// creates an object</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keyword">template</span> <<span class="keyword">class</span> T></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  T* create() {</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keywordtype">void</span>* addr = <a class="code" href="classaudio__tools_1_1_allocator.html#a61444acca87cb94cc35f366fa09bcc46">allocate</a>(<span class="keyword">sizeof</span>(T));</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="comment">// call constructor</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  T* ref = <span class="keyword">new</span> (addr) T();</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordflow">return</span> ref;</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  }</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">template</span> <<span class="keyword">class</span> T></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_allocator.html#aee2e256e07f962e2e69cd7a9a54ea2de"> 35</a></span>  <span class="keywordtype">void</span> <a class="code" href="classaudio__tools_1_1_allocator.html#aee2e256e07f962e2e69cd7a9a54ea2de">remove</a>(T* obj) {</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordflow">if</span> (obj == <span class="keyword">nullptr</span>) <span class="keywordflow">return</span>;</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  obj->~T();</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="code" href="classaudio__tools_1_1_allocator.html#a9c3e4072854fea7a8be289d17c6390fc">free</a>((<span class="keywordtype">void</span>*)obj);</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>  </div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">// creates an array of objects</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">template</span> <<span class="keyword">class</span> T></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  T* createArray(<span class="keywordtype">int</span> len) {</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordtype">void</span>* addr = <a class="code" href="classaudio__tools_1_1_allocator.html#a61444acca87cb94cc35f366fa09bcc46">allocate</a>(<span class="keyword">sizeof</span>(T) * len);</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  T* addrT = (T*)addr;</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="comment">// call constructor</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> j = 0; j < len; j++) <span class="keyword">new</span> (addrT+j) T();</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordflow">return</span> (T*)addr;</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  }</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">// deletes an array of objects</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">template</span> <<span class="keyword">class</span> T></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">void</span> removeArray(T* obj, <span class="keywordtype">int</span> len) {</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">if</span> (obj == <span class="keyword">nullptr</span>) <span class="keywordflow">return</span>;</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> j = 0; j < len; j++) {</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  obj[j].~T();</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  }</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="classaudio__tools_1_1_allocator.html#a9c3e4072854fea7a8be289d17c6390fc">free</a>((<span class="keywordtype">void</span>*)obj);</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  }</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_allocator.html#a61444acca87cb94cc35f366fa09bcc46"> 62</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span>* <a class="code" href="classaudio__tools_1_1_allocator.html#a61444acca87cb94cc35f366fa09bcc46">allocate</a>(<span class="keywordtype">size_t</span> size) {</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">void</span>* result = do_allocate(size);</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">if</span> (result == <span class="keyword">nullptr</span>) {</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  LOGE(<span class="stringliteral">"Allocateation failed for %zu bytes"</span>, size);</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="group__basic.html#ga8c528baf37154d347366083f0f816846">stop</a>();</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  } <span class="keywordflow">else</span> {</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  LOGD(<span class="stringliteral">"Allocated %zu"</span>, size);</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  }</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">return</span> result;</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>  </div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_allocator.html#a9c3e4072854fea7a8be289d17c6390fc"> 74</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classaudio__tools_1_1_allocator.html#a9c3e4072854fea7a8be289d17c6390fc">free</a>(<span class="keywordtype">void</span>* memory) {</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">if</span> (memory != <span class="keyword">nullptr</span>) <a class="code" href="classaudio__tools_1_1_allocator.html#a9c3e4072854fea7a8be289d17c6390fc">::free</a>(memory);</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  }</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>  <span class="keyword">protected</span>:</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span>* do_allocate(<span class="keywordtype">size_t</span> size) {</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordflow">return</span> calloc(1, size == 0 ? 1 : size);</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  }</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> };</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  </div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_allocator_ext.html"> 91</a></span> <span class="keyword">class </span><a class="code" href="classaudio__tools_1_1_allocator_ext.html">AllocatorExt</a> : <span class="keyword">public</span> <a class="code" href="classaudio__tools_1_1_allocator.html">Allocator</a> {</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordtype">void</span>* do_allocate(<span class="keywordtype">size_t</span> size) {</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">void</span>* result = <span class="keyword">nullptr</span>;</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordflow">if</span> (size == 0) size = 1;</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor">#if defined(ESP32) && defined(ARDUINO)</span></div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  result = ps_malloc(size);</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordflow">if</span> (result == <span class="keyword">nullptr</span>) result = malloc(size);</div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordflow">if</span> (result == <span class="keyword">nullptr</span>) {</div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  LOGE(<span class="stringliteral">"allocateation failed for %zu bytes"</span>, size);</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <a class="code" href="group__basic.html#ga8c528baf37154d347366083f0f816846">stop</a>();</div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  }</div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="comment">// initialize object</span></div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  memset(result, 0, size);</div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordflow">return</span> result;</div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  }</div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> };</div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  </div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="preprocessor">#if defined(ESP32) && defined(ARDUINO)</span></div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  </div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="keyword">class </span>AllocatorPSRAM : <span class="keyword">public</span> <a class="code" href="classaudio__tools_1_1_allocator.html">Allocator</a> {</div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keywordtype">void</span>* do_allocate(<span class="keywordtype">size_t</span> size) {</div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordflow">if</span> (size == 0) size = 1;</div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordtype">void</span>* result = <span class="keyword">nullptr</span>;</div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  result = ps_calloc(1, size);</div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keywordflow">if</span> (result == <span class="keyword">nullptr</span>) {</div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  LOGE(<span class="stringliteral">"allocateation failed for %zu bytes"</span>, size);</div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <a class="code" href="group__basic.html#ga8c528baf37154d347366083f0f816846">stop</a>();</div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  }</div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordflow">return</span> result;</div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  }</div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> };</div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  </div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  </div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="keyword">static</span> AllocatorExt DefaultAllocator;</div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  </div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> } <span class="comment">// namespace audio_tools</span></div>
|
|
<div class="ttc" id="aclassaudio__tools_1_1_allocator_ext_html"><div class="ttname"><a href="classaudio__tools_1_1_allocator_ext.html">audio_tools::AllocatorExt</a></div><div class="ttdoc">Memory allocateator which uses ps_malloc (on the ESP32) and if this fails it resorts to malloc.</div><div class="ttdef"><b>Definition:</b> Allocator.h:91</div></div>
|
|
<div class="ttc" id="aclassaudio__tools_1_1_allocator_html"><div class="ttname"><a href="classaudio__tools_1_1_allocator.html">audio_tools::Allocator</a></div><div class="ttdoc">Memory allocateator which uses malloc.</div><div class="ttdef"><b>Definition:</b> Allocator.h:22</div></div>
|
|
<div class="ttc" id="aclassaudio__tools_1_1_allocator_html_a61444acca87cb94cc35f366fa09bcc46"><div class="ttname"><a href="classaudio__tools_1_1_allocator.html#a61444acca87cb94cc35f366fa09bcc46">audio_tools::Allocator::allocate</a></div><div class="ttdeci">virtual void * allocate(size_t size)</div><div class="ttdoc">Allocates memory.</div><div class="ttdef"><b>Definition:</b> Allocator.h:62</div></div>
|
|
<div class="ttc" id="aclassaudio__tools_1_1_allocator_html_a9c3e4072854fea7a8be289d17c6390fc"><div class="ttname"><a href="classaudio__tools_1_1_allocator.html#a9c3e4072854fea7a8be289d17c6390fc">audio_tools::Allocator::free</a></div><div class="ttdeci">virtual void free(void *memory)</div><div class="ttdoc">frees memory</div><div class="ttdef"><b>Definition:</b> Allocator.h:74</div></div>
|
|
<div class="ttc" id="aclassaudio__tools_1_1_allocator_html_aee2e256e07f962e2e69cd7a9a54ea2de"><div class="ttname"><a href="classaudio__tools_1_1_allocator.html#aee2e256e07f962e2e69cd7a9a54ea2de">audio_tools::Allocator::remove</a></div><div class="ttdeci">void remove(T *obj)</div><div class="ttdoc">deletes an object</div><div class="ttdef"><b>Definition:</b> Allocator.h:35</div></div>
|
|
<div class="ttc" id="agroup__basic_html_ga8c528baf37154d347366083f0f816846"><div class="ttname"><a href="group__basic.html#ga8c528baf37154d347366083f0f816846">stop</a></div><div class="ttdeci">void stop()</div><div class="ttdoc">Public generic methods.</div><div class="ttdef"><b>Definition:</b> AudioRuntime.h:27</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><!-- 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>
|