DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF
1
0
Fork 0
Code Releases 0 Activity
DISTRHO Plugin Framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
417 Commits
7 Branches
91MB
Branch: gh-pages
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'gh-pages'
${ noResults }
DPF/RingBuffer_8hpp_source.html

916 lines
125KB
Raw Permalink Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  2. <html xmlns="http://www.w3.org/1999/xhtml">

  3. <head>

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>

  6. <meta name="generator" content="Doxygen 1.9.1"/>

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>

  8. <title>DISTRHO Plugin Framework: distrho/extra/RingBuffer.hpp Source File</title>

  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  10. <script type="text/javascript" src="jquery.js"></script>

  11. <script type="text/javascript" src="dynsections.js"></script>

  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  13. <script type="text/javascript" src="search/searchdata.js"></script>

  14. <script type="text/javascript" src="search/search.js"></script>

  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  16. </head>

  17. <body>

  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  19. <div id="titlearea">

  20. <table cellspacing="0" cellpadding="0">

  21.  <tbody>

  22.  <tr style="height: 56px;">

  23.   <td id="projectalign" style="padding-left: 0.5em;">

  24.    <div id="projectname">DISTRHO Plugin Framework

  25.    </div>

  26.   </td>

  27.  </tr>

  28.  </tbody>

  29. </table>

  30. </div>

  31. <!-- end header part -->

  32. <!-- Generated by Doxygen 1.9.1 -->

  33. <script type="text/javascript">

  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  35. var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');

  36. /* @license-end */

  37. </script>

  38. <script type="text/javascript" src="menudata.js"></script>

  39. <script type="text/javascript" src="menu.js"></script>

  40. <script type="text/javascript">

  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  42. $(function() {

  43.   initMenu('',true,false,'search.php','Search');

  44.   $(document).ready(function() { init_search(); });

  45. });

  46. /* @license-end */</script>

  47. <div id="main-nav"></div>

  48. <!-- window showing the filter options -->

  49. <div id="MSearchSelectWindow"

  50.      onmouseover="return searchBox.OnSearchSelectShow()"

  51.      onmouseout="return searchBox.OnSearchSelectHide()"

  52.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  53. </div>

  54. 

  55. <!-- iframe showing the search results (closed by default) -->

  56. <div id="MSearchResultsWindow">

  57. <iframe src="javascript:void(0)" frameborder="0" 

  58.         name="MSearchResults" id="MSearchResults">

  59. </iframe>

  60. </div>

  61. 

  62. <div id="nav-path" class="navpath">

  63.   <ul>

  64. <li class="navelem"><a class="el" href="dir_37257469cca17bab24b582e18a78eb75.html">distrho</a></li><li class="navelem"><a class="el" href="dir_b1be46be7d80596b116b2b4ac973f2f0.html">extra</a></li>  </ul>

  65. </div>

  66. </div><!-- top -->

  67. <div class="header">

  68.   <div class="headertitle">

  69. <div class="title">RingBuffer.hpp</div>  </div>

  70. </div><!--header-->

  71. <div class="contents">

  72. <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>

  73. <div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * DISTRHO Plugin Framework (DPF)</span></div>

  74. <div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * Copyright (C) 2012-2021 Filipe Coelho &lt;falktx@falktx.com&gt;</span></div>

  75. <div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div>

  76. <div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * Permission to use, copy, modify, and/or distribute this software for any purpose with</span></div>

  77. <div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * or without fee is hereby granted, provided that the above copyright notice and this</span></div>

  78. <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * permission notice appear in all copies.</span></div>

  79. <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div>

  80. <div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD</span></div>

  81. <div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN</span></div>

  82. <div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL</span></div>

  83. <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER</span></div>

  84. <div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN</span></div>

  85. <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>

  86. <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> */</span></div>

  87. <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160; </div>

  88. <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#ifndef DISTRHO_RING_BUFFER_HPP_INCLUDED</span></div>

  89. <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#define DISTRHO_RING_BUFFER_HPP_INCLUDED</span></div>

  90. <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160; </div>

  91. <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &quot;../DistrhoUtils.hpp&quot;</span></div>

  92. <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160; </div>

  93. <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<a class="code" href="group__NamespaceMacros.html#gac4cb97c393d20c28ba19365d844341cd">START_NAMESPACE_DISTRHO</a></div>

  94. <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160; </div>

  95. <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment">// -----------------------------------------------------------------------</span></div>

  96. <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment">// Buffer structs</span></div>

  97. <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"></span> </div>

  98. <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment">/**</span></div>

  99. <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment">   Base structure for all RingBuffer containers.</span></div>

  100. <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment">   This struct details the data model used in DPF&#39;s RingBuffer class.</span></div>

  101. <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment"></span> </div>

  102. <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment">   DPF RingBuffer uses a struct just like this one to store positions, buffer data, size, etc.</span></div>

  103. <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment">   The RingBuffer itself takes ownership of this struct and uses it to store any needed data.</span></div>

  104. <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment">   This allows to dynamically change the way its ring buffer is allocated, simply by changing the template type.</span></div>

  105. <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment">   For example, `RingBufferControl&lt;HeapBuffer&gt;` will create a ring buffer with heap memory, which can be of any size.</span></div>

  106. <div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment">   In the same vein, `RingBufferControl&lt;SmallStackBuffer&gt;` will create a ring buffer with stack memory,</span></div>

  107. <div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="comment">   directly tied to the RingBufferControl it belongs to.</span></div>

  108. <div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment"></span> </div>

  109. <div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment">   The main idea behind this model is to allow RingBufferControl over memory created elsewhere,</span></div>

  110. <div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="comment">   for example shared memory area.</span></div>

  111. <div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="comment">   One can create/place the Buffer struct in shared memory, and point RingBufferControl to it,</span></div>

  112. <div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment">   thus avoiding the pitfalls of sharing access to a non trivially-copyable/POD C++ class.</span></div>

  113. <div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment"></span> </div>

  114. <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment">   Unlike other ring buffers, an extra variable is used to track pending writes.</span></div>

  115. <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="comment">   This is so we can write a few bytes at a time and later mark the whole operation as complete,</span></div>

  116. <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment">   thus avoiding the issue of reading data too early from the other side.</span></div>

  117. <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment">   For example, write the size of some data first, and then the actual data.</span></div>

  118. <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment">   The reading side will only see data available once size + data is completely written and &quot;committed&quot;.</span></div>

  119. <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment"> */</span></div>

  120. <div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structHeapBuffer.html">   49</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structHeapBuffer.html">HeapBuffer</a> {<span class="comment"></span></div>

  121. <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment">   /**</span></div>

  122. <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment">      Size of the buffer, allocated in @a buf.</span></div>

  123. <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="comment">      If the size is fixed (stack buffer), this variable can be static.</span></div>

  124. <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="comment">    */</span></div>

  125. <div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structHeapBuffer.html#a582e7b5aa4a85814f291d002abb49599">   54</a></span>&#160;    uint32_t <a class="code" href="structHeapBuffer.html#a582e7b5aa4a85814f291d002abb49599">size</a>;</div>

  126. <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="comment"></span> </div>

  127. <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment">   /**</span></div>

  128. <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment">      Current writing position, headmost position of the buffer.</span></div>

  129. <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment">      Increments when writing.</span></div>

  130. <div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment">    */</span></div>

  131. <div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="structHeapBuffer.html#a55b0dceb6b878021d8fe1353096e757b">   60</a></span>&#160;    uint32_t <a class="code" href="structHeapBuffer.html#a55b0dceb6b878021d8fe1353096e757b">head</a>;</div>

  132. <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment"></span> </div>

  133. <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment">   /**</span></div>

  134. <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment">      Current reading position, last used position of the buffer.</span></div>

  135. <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="comment">      Increments when reading.</span></div>

  136. <div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment">      head == tail means empty buffer.</span></div>

  137. <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment">    */</span></div>

  138. <div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="structHeapBuffer.html#abd05cbae44531a412352ed52c8a50aec">   67</a></span>&#160;    uint32_t <a class="code" href="structHeapBuffer.html#abd05cbae44531a412352ed52c8a50aec">tail</a>;</div>

  139. <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="comment"></span> </div>

  140. <div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;<span class="comment">   /**</span></div>

  141. <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="comment">      Temporary position of head until a commitWrite() is called.</span></div>

  142. <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="comment">      If buffer writing fails, wrtn will be back to head position thus ignoring the last operation(s).</span></div>

  143. <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="comment">      If buffer writing succeeds, head will be set to this variable.</span></div>

  144. <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="comment">    */</span></div>

  145. <div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="structHeapBuffer.html#a4d330b5567a46f6b6972f5174b262292">   74</a></span>&#160;    uint32_t <a class="code" href="structHeapBuffer.html#a4d330b5567a46f6b6972f5174b262292">wrtn</a>;</div>

  146. <div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="comment"></span> </div>

  147. <div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="comment">   /**</span></div>

  148. <div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="comment">      Boolean used to check if a write operation failed.</span></div>

  149. <div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="comment">      This ensures we don&#39;t get incomplete writes.</span></div>

  150. <div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="comment">    */</span></div>

  151. <div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="structHeapBuffer.html#a0cd85f596b680b57cc6669de7cf7ed27">   80</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="structHeapBuffer.html#a0cd85f596b680b57cc6669de7cf7ed27">invalidateCommit</a>;</div>

  152. <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment"></span> </div>

  153. <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="comment">   /**</span></div>

  154. <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="comment">      Pointer to buffer data.</span></div>

  155. <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="comment">      This can be either stack or heap data, depending on the usecase.</span></div>

  156. <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="comment">    */</span></div>

  157. <div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="structHeapBuffer.html#afbaf206237e4898a306025676dce0987">   86</a></span>&#160;    uint8_t* <a class="code" href="structHeapBuffer.html#afbaf206237e4898a306025676dce0987">buf</a>;</div>

  158. <div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;};</div>

  159. <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="comment"></span> </div>

  160. <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment">/**</span></div>

  161. <div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="comment">   RingBufferControl compatible struct with a relatively small stack size (4k bytes).</span></div>

  162. <div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="comment">   @see HeapBuffer</span></div>

  163. <div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="comment">*/</span></div>

  164. <div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="structSmallStackBuffer.html">   93</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structSmallStackBuffer.html">SmallStackBuffer</a> {</div>

  165. <div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;    <span class="keyword">static</span> <span class="keyword">const</span> uint32_t size = 4096;</div>

  166. <div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;    uint32_t head, tail, wrtn;</div>

  167. <div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;    <span class="keywordtype">bool</span>     invalidateCommit;</div>

  168. <div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;    uint8_t  buf[size];</div>

  169. <div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;};</div>

  170. <div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="comment"></span> </div>

  171. <div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="comment">/**</span></div>

  172. <div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<span class="comment">   RingBufferControl compatible struct with a relatively big stack size (16k bytes).</span></div>

  173. <div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="comment">   @see HeapBuffer</span></div>

  174. <div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<span class="comment">*/</span></div>

  175. <div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="structBigStackBuffer.html">  104</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structBigStackBuffer.html">BigStackBuffer</a> {</div>

  176. <div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;    <span class="keyword">static</span> <span class="keyword">const</span> uint32_t size = 16384;</div>

  177. <div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;    uint32_t head, tail, wrtn;</div>

  178. <div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;    <span class="keywordtype">bool</span>     invalidateCommit;</div>

  179. <div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;    uint8_t  buf[size];</div>

  180. <div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;};</div>

  181. <div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="comment"></span> </div>

  182. <div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;<span class="comment">/**</span></div>

  183. <div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="comment">   RingBufferControl compatible struct with a huge stack size (64k bytes).</span></div>

  184. <div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;<span class="comment">   @see HeapBuffer</span></div>

  185. <div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="comment">*/</span></div>

  186. <div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="structHugeStackBuffer.html">  115</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structHugeStackBuffer.html">HugeStackBuffer</a> {</div>

  187. <div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;    <span class="keyword">static</span> <span class="keyword">const</span> uint32_t size = 65536;</div>

  188. <div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;    uint32_t head, tail, wrtn;</div>

  189. <div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;    <span class="keywordtype">bool</span>     invalidateCommit;</div>

  190. <div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;    uint8_t  buf[size];</div>

  191. <div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;};</div>

  192. <div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160; </div>

  193. <div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="preprocessor">#ifdef DISTRHO_PROPER_CPP11_SUPPORT</span></div>

  194. <div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;<span class="preprocessor"># define HeapBuffer_INIT  {0, 0, 0, 0, false, nullptr}</span></div>

  195. <div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="preprocessor"># define StackBuffer_INIT {0, 0, 0, false, {0}}</span></div>

  196. <div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;<span class="preprocessor">#else</span></div>

  197. <div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<span class="preprocessor"># define HeapBuffer_INIT</span></div>

  198. <div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;<span class="preprocessor"># define StackBuffer_INIT</span></div>

  199. <div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<span class="preprocessor">#endif</span></div>

  200. <div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160; </div>

  201. <div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="comment">// -----------------------------------------------------------------------</span></div>

  202. <div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;<span class="comment">// RingBufferControl templated class</span></div>

  203. <div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="comment"></span> </div>

  204. <div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="comment">/**</span></div>

  205. <div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;<span class="comment">   DPF built-in RingBuffer class.</span></div>

  206. <div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="comment">   RingBufferControl takes one buffer struct to take control over, and operates over it.</span></div>

  207. <div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment"></span> </div>

  208. <div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="comment">   This is meant for single-writer, single-reader type of control.</span></div>

  209. <div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;<span class="comment">   Writing and reading is wait and lock-free.</span></div>

  210. <div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;<span class="comment"></span> </div>

  211. <div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;<span class="comment">   Typically usage involves:</span></div>

  212. <div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;<span class="comment">   ```</span></div>

  213. <div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;<span class="comment">   // definition</span></div>

  214. <div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<span class="comment">   HeapRingBuffer myHeapBuffer; // or RingBufferControl&lt;HeapBuffer&gt; class for more control</span></div>

  215. <div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;<span class="comment"></span> </div>

  216. <div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="comment">   // construction, only needed for heap buffers</span></div>

  217. <div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="comment">   myHeapBuffer.createBuffer(8192);</span></div>

  218. <div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;<span class="comment"></span> </div>

  219. <div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="comment">   // writing data</span></div>

  220. <div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;<span class="comment">   myHeapBuffer.writeUInt(size);</span></div>

  221. <div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;<span class="comment">   myHeapBuffer.writeCustomData(someOtherData, size);</span></div>

  222. <div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;<span class="comment">   myHeapBuffer.commitWrite();</span></div>

  223. <div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;<span class="comment"></span> </div>

  224. <div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;<span class="comment">   // reading data</span></div>

  225. <div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;<span class="comment">   if (myHeapBuffer.isDataAvailableForReading())</span></div>

  226. <div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;<span class="comment">   {</span></div>

  227. <div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;<span class="comment">      uint32_t size;</span></div>

  228. <div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;<span class="comment">      if (myHeapBuffer.readUInt(size) &amp;&amp; readCustomData(&amp;anotherData, size))</span></div>

  229. <div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;<span class="comment">      {</span></div>

  230. <div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;<span class="comment">          // do something with &quot;anotherData&quot;</span></div>

  231. <div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;<span class="comment">      }</span></div>

  232. <div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;<span class="comment">   }</span></div>

  233. <div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;<span class="comment">   ```</span></div>

  234. <div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;<span class="comment"></span> </div>

  235. <div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;<span class="comment">   @see HeapBuffer</span></div>

  236. <div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;<span class="comment"> */</span></div>

  237. <div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> BufferStruct&gt;</div>

  238. <div class="line"><a name="l00167"></a><span class="lineno"><a class="line" href="classRingBufferControl.html">  167</a></span>&#160;<span class="keyword">class </span><a class="code" href="classRingBufferControl.html">RingBufferControl</a></div>

  239. <div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;{</div>

  240. <div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;<span class="keyword">public</span>:</div>

  241. <div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;    <span class="comment">/*</span></div>

  242. <div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;<span class="comment">     * Constructor for uninitialised ring buffer.</span></div>

  243. <div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;<span class="comment">     * A call to setRingBuffer is required to tied this control to a ring buffer struct;</span></div>

  244. <div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;<span class="comment">     *</span></div>

  245. <div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;<span class="comment">     */</span></div>

  246. <div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;    <a class="code" href="classRingBufferControl.html">RingBufferControl</a>() noexcept</div>

  247. <div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;        : buffer(<span class="keyword">nullptr</span>),</div>

  248. <div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;          errorReading(<span class="keyword">false</span>),</div>

  249. <div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;          errorWriting(<span class="keyword">false</span>) {}</div>

  250. <div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160; </div>

  251. <div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;    <span class="comment">/*</span></div>

  252. <div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;<span class="comment">     * Destructor.</span></div>

  253. <div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;<span class="comment">     */</span></div>

  254. <div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;    <span class="keyword">virtual</span> ~<a class="code" href="classRingBufferControl.html">RingBufferControl</a>() noexcept {}</div>

  255. <div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160; </div>

  256. <div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;    <span class="comment">// -------------------------------------------------------------------</span></div>

  257. <div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;    <span class="comment">// check operations</span></div>

  258. <div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160; </div>

  259. <div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;    <span class="comment">/*</span></div>

  260. <div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;<span class="comment">     * Check if there is any data available for reading, regardless of size.</span></div>

  261. <div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;<span class="comment">     */</span></div>

  262. <div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;    <span class="keywordtype">bool</span> isDataAvailableForReading() <span class="keyword">const</span> noexcept;</div>

  263. <div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160; </div>

  264. <div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;    <span class="comment">/*</span></div>

  265. <div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;<span class="comment">     * Check if ring buffer is empty (that is, there is nothing to read).</span></div>

  266. <div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;<span class="comment">     */</span></div>

  267. <div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;    <span class="keywordtype">bool</span> isEmpty() <span class="keyword">const</span> noexcept</div>

  268. <div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;    {</div>

  269. <div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;        DISTRHO_SAFE_ASSERT_RETURN(buffer != <span class="keyword">nullptr</span>, <span class="keyword">false</span>);</div>

  270. <div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160; </div>

  271. <div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;        <span class="keywordflow">return</span> (buffer-&gt;buf == <span class="keyword">nullptr</span> || buffer-&gt;head == buffer-&gt;tail);</div>

  272. <div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;    }</div>

  273. <div class="line"><a name="l00202"></a><span class="lineno">  202</span>&#160; </div>

  274. <div class="line"><a name="l00203"></a><span class="lineno">  203</span>&#160;    <span class="comment">/*</span></div>

  275. <div class="line"><a name="l00204"></a><span class="lineno">  204</span>&#160;<span class="comment">     * Get the full ringbuffer size.</span></div>

  276. <div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;<span class="comment">     */</span></div>

  277. <div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;    uint32_t getSize() <span class="keyword">const</span> noexcept</div>

  278. <div class="line"><a name="l00207"></a><span class="lineno">  207</span>&#160;    {</div>

  279. <div class="line"><a name="l00208"></a><span class="lineno">  208</span>&#160;        <span class="keywordflow">return</span> buffer != <span class="keyword">nullptr</span> ? buffer-&gt;size : 0;</div>

  280. <div class="line"><a name="l00209"></a><span class="lineno">  209</span>&#160;    }</div>

  281. <div class="line"><a name="l00210"></a><span class="lineno">  210</span>&#160; </div>

  282. <div class="line"><a name="l00211"></a><span class="lineno">  211</span>&#160;    <span class="comment">/*</span></div>

  283. <div class="line"><a name="l00212"></a><span class="lineno">  212</span>&#160;<span class="comment">     * Get the size of the data available to read.</span></div>

  284. <div class="line"><a name="l00213"></a><span class="lineno">  213</span>&#160;<span class="comment">     */</span></div>

  285. <div class="line"><a name="l00214"></a><span class="lineno">  214</span>&#160;    uint32_t getReadableDataSize() <span class="keyword">const</span> noexcept</div>

  286. <div class="line"><a name="l00215"></a><span class="lineno">  215</span>&#160;    {</div>

  287. <div class="line"><a name="l00216"></a><span class="lineno">  216</span>&#160;        DISTRHO_SAFE_ASSERT_RETURN(buffer != <span class="keyword">nullptr</span>, 0);</div>

  288. <div class="line"><a name="l00217"></a><span class="lineno">  217</span>&#160; </div>

  289. <div class="line"><a name="l00218"></a><span class="lineno">  218</span>&#160;        <span class="keyword">const</span> uint32_t wrap = buffer-&gt;head &gt;= buffer-&gt;tail ? 0 : buffer-&gt;size;</div>

  290. <div class="line"><a name="l00219"></a><span class="lineno">  219</span>&#160; </div>

  291. <div class="line"><a name="l00220"></a><span class="lineno">  220</span>&#160;        <span class="keywordflow">return</span> wrap + buffer-&gt;head - buffer-&gt;tail;</div>

  292. <div class="line"><a name="l00221"></a><span class="lineno">  221</span>&#160;    }</div>

  293. <div class="line"><a name="l00222"></a><span class="lineno">  222</span>&#160; </div>

  294. <div class="line"><a name="l00223"></a><span class="lineno">  223</span>&#160;    <span class="comment">/*</span></div>

  295. <div class="line"><a name="l00224"></a><span class="lineno">  224</span>&#160;<span class="comment">     * Get the size of the data available to write.</span></div>

  296. <div class="line"><a name="l00225"></a><span class="lineno">  225</span>&#160;<span class="comment">     */</span></div>

  297. <div class="line"><a name="l00226"></a><span class="lineno">  226</span>&#160;    uint32_t getWritableDataSize() <span class="keyword">const</span> noexcept</div>

  298. <div class="line"><a name="l00227"></a><span class="lineno">  227</span>&#160;    {</div>

  299. <div class="line"><a name="l00228"></a><span class="lineno">  228</span>&#160;        DISTRHO_SAFE_ASSERT_RETURN(buffer != <span class="keyword">nullptr</span>, 0);</div>

  300. <div class="line"><a name="l00229"></a><span class="lineno">  229</span>&#160; </div>

  301. <div class="line"><a name="l00230"></a><span class="lineno">  230</span>&#160;        <span class="keyword">const</span> uint32_t wrap = buffer-&gt;tail &gt; buffer-&gt;wrtn ? 0 : buffer-&gt;size;</div>

  302. <div class="line"><a name="l00231"></a><span class="lineno">  231</span>&#160; </div>

  303. <div class="line"><a name="l00232"></a><span class="lineno">  232</span>&#160;        <span class="keywordflow">return</span> wrap + buffer-&gt;tail - buffer-&gt;wrtn - 1;</div>

  304. <div class="line"><a name="l00233"></a><span class="lineno">  233</span>&#160;    }</div>

  305. <div class="line"><a name="l00234"></a><span class="lineno">  234</span>&#160; </div>

  306. <div class="line"><a name="l00235"></a><span class="lineno">  235</span>&#160;    <span class="comment">// -------------------------------------------------------------------</span></div>

  307. <div class="line"><a name="l00236"></a><span class="lineno">  236</span>&#160;    <span class="comment">// clear/reset operations</span></div>

  308. <div class="line"><a name="l00237"></a><span class="lineno">  237</span>&#160; </div>

  309. <div class="line"><a name="l00238"></a><span class="lineno">  238</span>&#160;    <span class="comment">/*</span></div>

  310. <div class="line"><a name="l00239"></a><span class="lineno">  239</span>&#160;<span class="comment">     * Clear the entire ring buffer data, marking the buffer as empty.</span></div>

  311. <div class="line"><a name="l00240"></a><span class="lineno">  240</span>&#160;<span class="comment">     * Requires a buffer struct tied to this class.</span></div>

  312. <div class="line"><a name="l00241"></a><span class="lineno">  241</span>&#160;<span class="comment">     */</span></div>

  313. <div class="line"><a name="l00242"></a><span class="lineno">  242</span>&#160;    <span class="keywordtype">void</span> clearData() noexcept</div>

  314. <div class="line"><a name="l00243"></a><span class="lineno">  243</span>&#160;    {</div>

  315. <div class="line"><a name="l00244"></a><span class="lineno">  244</span>&#160;        DISTRHO_SAFE_ASSERT_RETURN(buffer != <span class="keyword">nullptr</span>,);</div>

  316. <div class="line"><a name="l00245"></a><span class="lineno">  245</span>&#160; </div>

  317. <div class="line"><a name="l00246"></a><span class="lineno">  246</span>&#160;        buffer-&gt;head = 0;</div>

  318. <div class="line"><a name="l00247"></a><span class="lineno">  247</span>&#160;        buffer-&gt;tail = 0;</div>

  319. <div class="line"><a name="l00248"></a><span class="lineno">  248</span>&#160;        buffer-&gt;wrtn = 0;</div>

  320. <div class="line"><a name="l00249"></a><span class="lineno">  249</span>&#160;        buffer-&gt;invalidateCommit = <span class="keyword">false</span>;</div>

  321. <div class="line"><a name="l00250"></a><span class="lineno">  250</span>&#160; </div>

  322. <div class="line"><a name="l00251"></a><span class="lineno">  251</span>&#160;        std::memset(buffer-&gt;buf, 0, buffer-&gt;size);</div>

  323. <div class="line"><a name="l00252"></a><span class="lineno">  252</span>&#160;    }</div>

  324. <div class="line"><a name="l00253"></a><span class="lineno">  253</span>&#160; </div>

  325. <div class="line"><a name="l00254"></a><span class="lineno">  254</span>&#160;    <span class="comment">/*</span></div>

  326. <div class="line"><a name="l00255"></a><span class="lineno">  255</span>&#160;<span class="comment">     * Reset the ring buffer read and write positions, marking the buffer as empty.</span></div>

  327. <div class="line"><a name="l00256"></a><span class="lineno">  256</span>&#160;<span class="comment">     * Requires a buffer struct tied to this class.</span></div>

  328. <div class="line"><a name="l00257"></a><span class="lineno">  257</span>&#160;<span class="comment">     */</span></div>

  329. <div class="line"><a name="l00258"></a><span class="lineno">  258</span>&#160;    <span class="keywordtype">void</span> flush() noexcept</div>

  330. <div class="line"><a name="l00259"></a><span class="lineno">  259</span>&#160;    {</div>

  331. <div class="line"><a name="l00260"></a><span class="lineno">  260</span>&#160;        DISTRHO_SAFE_ASSERT_RETURN(buffer != <span class="keyword">nullptr</span>,);</div>

  332. <div class="line"><a name="l00261"></a><span class="lineno">  261</span>&#160; </div>

  333. <div class="line"><a name="l00262"></a><span class="lineno">  262</span>&#160;        buffer-&gt;head = buffer-&gt;tail = buffer-&gt;wrtn = 0;</div>

  334. <div class="line"><a name="l00263"></a><span class="lineno">  263</span>&#160;        buffer-&gt;invalidateCommit = <span class="keyword">false</span>;</div>

  335. <div class="line"><a name="l00264"></a><span class="lineno">  264</span>&#160; </div>

  336. <div class="line"><a name="l00265"></a><span class="lineno">  265</span>&#160;        errorWriting = <span class="keyword">false</span>;</div>

  337. <div class="line"><a name="l00266"></a><span class="lineno">  266</span>&#160;    }</div>

  338. <div class="line"><a name="l00267"></a><span class="lineno">  267</span>&#160; </div>

  339. <div class="line"><a name="l00268"></a><span class="lineno">  268</span>&#160;    <span class="comment">// -------------------------------------------------------------------</span></div>

  340. <div class="line"><a name="l00269"></a><span class="lineno">  269</span>&#160;    <span class="comment">// read operations</span></div>

  341. <div class="line"><a name="l00270"></a><span class="lineno">  270</span>&#160; </div>

  342. <div class="line"><a name="l00271"></a><span class="lineno">  271</span>&#160;    <span class="comment">/*</span></div>

  343. <div class="line"><a name="l00272"></a><span class="lineno">  272</span>&#160;<span class="comment">     * Read a single boolean value.</span></div>

  344. <div class="line"><a name="l00273"></a><span class="lineno">  273</span>&#160;<span class="comment">     * Returns false if reading fails.</span></div>

  345. <div class="line"><a name="l00274"></a><span class="lineno">  274</span>&#160;<span class="comment">     */</span></div>

  346. <div class="line"><a name="l00275"></a><span class="lineno">  275</span>&#160;    <span class="keywordtype">bool</span> readBool() noexcept</div>

  347. <div class="line"><a name="l00276"></a><span class="lineno">  276</span>&#160;    {</div>

  348. <div class="line"><a name="l00277"></a><span class="lineno">  277</span>&#160;        <span class="keywordtype">bool</span> b = <span class="keyword">false</span>;</div>

  349. <div class="line"><a name="l00278"></a><span class="lineno">  278</span>&#160;        <span class="keywordflow">return</span> tryRead(&amp;b, <span class="keyword">sizeof</span>(<span class="keywordtype">bool</span>)) ? b : <span class="keyword">false</span>;</div>

  350. <div class="line"><a name="l00279"></a><span class="lineno">  279</span>&#160;    }</div>

  351. <div class="line"><a name="l00280"></a><span class="lineno">  280</span>&#160; </div>

  352. <div class="line"><a name="l00281"></a><span class="lineno">  281</span>&#160;    <span class="comment">/*</span></div>

  353. <div class="line"><a name="l00282"></a><span class="lineno">  282</span>&#160;<span class="comment">     * Read a single 8-bit byte.</span></div>

  354. <div class="line"><a name="l00283"></a><span class="lineno">  283</span>&#160;<span class="comment">     * Returns 0 if reading fails.</span></div>

  355. <div class="line"><a name="l00284"></a><span class="lineno">  284</span>&#160;<span class="comment">     */</span></div>

  356. <div class="line"><a name="l00285"></a><span class="lineno">  285</span>&#160;    uint8_t readByte() noexcept</div>

  357. <div class="line"><a name="l00286"></a><span class="lineno">  286</span>&#160;    {</div>

  358. <div class="line"><a name="l00287"></a><span class="lineno">  287</span>&#160;        uint8_t B = 0;</div>

  359. <div class="line"><a name="l00288"></a><span class="lineno">  288</span>&#160;        <span class="keywordflow">return</span> tryRead(&amp;B, <span class="keyword">sizeof</span>(uint8_t)) ? B : 0;</div>

  360. <div class="line"><a name="l00289"></a><span class="lineno">  289</span>&#160;    }</div>

  361. <div class="line"><a name="l00290"></a><span class="lineno">  290</span>&#160; </div>

  362. <div class="line"><a name="l00291"></a><span class="lineno">  291</span>&#160;    <span class="comment">/*</span></div>

  363. <div class="line"><a name="l00292"></a><span class="lineno">  292</span>&#160;<span class="comment">     * Read a short 16-bit integer.</span></div>

  364. <div class="line"><a name="l00293"></a><span class="lineno">  293</span>&#160;<span class="comment">     * Returns 0 if reading fails.</span></div>

  365. <div class="line"><a name="l00294"></a><span class="lineno">  294</span>&#160;<span class="comment">     */</span></div>

  366. <div class="line"><a name="l00295"></a><span class="lineno">  295</span>&#160;    int16_t readShort() noexcept</div>

  367. <div class="line"><a name="l00296"></a><span class="lineno">  296</span>&#160;    {</div>

  368. <div class="line"><a name="l00297"></a><span class="lineno">  297</span>&#160;        int16_t s = 0;</div>

  369. <div class="line"><a name="l00298"></a><span class="lineno">  298</span>&#160;        <span class="keywordflow">return</span> tryRead(&amp;s, <span class="keyword">sizeof</span>(int16_t)) ? s : 0;</div>

  370. <div class="line"><a name="l00299"></a><span class="lineno">  299</span>&#160;    }</div>

  371. <div class="line"><a name="l00300"></a><span class="lineno">  300</span>&#160; </div>

  372. <div class="line"><a name="l00301"></a><span class="lineno">  301</span>&#160;    <span class="comment">/*</span></div>

  373. <div class="line"><a name="l00302"></a><span class="lineno">  302</span>&#160;<span class="comment">     * Read a short unsigned 16-bit integer.</span></div>

  374. <div class="line"><a name="l00303"></a><span class="lineno">  303</span>&#160;<span class="comment">     * Returns 0 if reading fails.</span></div>

  375. <div class="line"><a name="l00304"></a><span class="lineno">  304</span>&#160;<span class="comment">     */</span></div>

  376. <div class="line"><a name="l00305"></a><span class="lineno">  305</span>&#160;    uint16_t readUShort() noexcept</div>

  377. <div class="line"><a name="l00306"></a><span class="lineno">  306</span>&#160;    {</div>

  378. <div class="line"><a name="l00307"></a><span class="lineno">  307</span>&#160;        uint16_t us = 0;</div>

  379. <div class="line"><a name="l00308"></a><span class="lineno">  308</span>&#160;        <span class="keywordflow">return</span> tryRead(&amp;us, <span class="keyword">sizeof</span>(uint16_t)) ? us : 0;</div>

  380. <div class="line"><a name="l00309"></a><span class="lineno">  309</span>&#160;    }</div>

  381. <div class="line"><a name="l00310"></a><span class="lineno">  310</span>&#160; </div>

  382. <div class="line"><a name="l00311"></a><span class="lineno">  311</span>&#160;    <span class="comment">/*</span></div>

  383. <div class="line"><a name="l00312"></a><span class="lineno">  312</span>&#160;<span class="comment">     * Read a regular 32-bit integer.</span></div>

  384. <div class="line"><a name="l00313"></a><span class="lineno">  313</span>&#160;<span class="comment">     * Returns 0 if reading fails.</span></div>

  385. <div class="line"><a name="l00314"></a><span class="lineno">  314</span>&#160;<span class="comment">     */</span></div>

  386. <div class="line"><a name="l00315"></a><span class="lineno">  315</span>&#160;    int32_t readInt() noexcept</div>

  387. <div class="line"><a name="l00316"></a><span class="lineno">  316</span>&#160;    {</div>

  388. <div class="line"><a name="l00317"></a><span class="lineno">  317</span>&#160;        int32_t i = 0;</div>

  389. <div class="line"><a name="l00318"></a><span class="lineno">  318</span>&#160;        <span class="keywordflow">return</span> tryRead(&amp;i, <span class="keyword">sizeof</span>(int32_t)) ? i : 0;</div>

  390. <div class="line"><a name="l00319"></a><span class="lineno">  319</span>&#160;    }</div>

  391. <div class="line"><a name="l00320"></a><span class="lineno">  320</span>&#160; </div>

  392. <div class="line"><a name="l00321"></a><span class="lineno">  321</span>&#160;    <span class="comment">/*</span></div>

  393. <div class="line"><a name="l00322"></a><span class="lineno">  322</span>&#160;<span class="comment">     * Read an unsigned 32-bit integer.</span></div>

  394. <div class="line"><a name="l00323"></a><span class="lineno">  323</span>&#160;<span class="comment">     * Returns 0 if reading fails.</span></div>

  395. <div class="line"><a name="l00324"></a><span class="lineno">  324</span>&#160;<span class="comment">     */</span></div>

  396. <div class="line"><a name="l00325"></a><span class="lineno">  325</span>&#160;    uint32_t readUInt() noexcept</div>

  397. <div class="line"><a name="l00326"></a><span class="lineno">  326</span>&#160;    {</div>

  398. <div class="line"><a name="l00327"></a><span class="lineno">  327</span>&#160;        uint32_t ui = 0;</div>

  399. <div class="line"><a name="l00328"></a><span class="lineno">  328</span>&#160;        <span class="keywordflow">return</span> tryRead(&amp;ui, <span class="keyword">sizeof</span>(int32_t)) ? ui : 0;</div>

  400. <div class="line"><a name="l00329"></a><span class="lineno">  329</span>&#160;    }</div>

  401. <div class="line"><a name="l00330"></a><span class="lineno">  330</span>&#160; </div>

  402. <div class="line"><a name="l00331"></a><span class="lineno">  331</span>&#160;    <span class="comment">/*</span></div>

  403. <div class="line"><a name="l00332"></a><span class="lineno">  332</span>&#160;<span class="comment">     * Read a long 64-bit integer.</span></div>

  404. <div class="line"><a name="l00333"></a><span class="lineno">  333</span>&#160;<span class="comment">     * Returns 0 if reading fails.</span></div>

  405. <div class="line"><a name="l00334"></a><span class="lineno">  334</span>&#160;<span class="comment">     */</span></div>

  406. <div class="line"><a name="l00335"></a><span class="lineno">  335</span>&#160;    int64_t readLong() noexcept</div>

  407. <div class="line"><a name="l00336"></a><span class="lineno">  336</span>&#160;    {</div>

  408. <div class="line"><a name="l00337"></a><span class="lineno">  337</span>&#160;        int64_t l = 0;</div>

  409. <div class="line"><a name="l00338"></a><span class="lineno">  338</span>&#160;        <span class="keywordflow">return</span> tryRead(&amp;l, <span class="keyword">sizeof</span>(int64_t)) ? l : 0;</div>

  410. <div class="line"><a name="l00339"></a><span class="lineno">  339</span>&#160;    }</div>

  411. <div class="line"><a name="l00340"></a><span class="lineno">  340</span>&#160; </div>

  412. <div class="line"><a name="l00341"></a><span class="lineno">  341</span>&#160;    <span class="comment">/*</span></div>

  413. <div class="line"><a name="l00342"></a><span class="lineno">  342</span>&#160;<span class="comment">     * Read a long unsigned 64-bit integer.</span></div>

  414. <div class="line"><a name="l00343"></a><span class="lineno">  343</span>&#160;<span class="comment">     * Returns 0 if reading fails.</span></div>

  415. <div class="line"><a name="l00344"></a><span class="lineno">  344</span>&#160;<span class="comment">     */</span></div>

  416. <div class="line"><a name="l00345"></a><span class="lineno">  345</span>&#160;    uint64_t readULong() noexcept</div>

  417. <div class="line"><a name="l00346"></a><span class="lineno">  346</span>&#160;    {</div>

  418. <div class="line"><a name="l00347"></a><span class="lineno">  347</span>&#160;        uint64_t ul = 0;</div>

  419. <div class="line"><a name="l00348"></a><span class="lineno">  348</span>&#160;        <span class="keywordflow">return</span> tryRead(&amp;ul, <span class="keyword">sizeof</span>(int64_t)) ? ul : 0;</div>

  420. <div class="line"><a name="l00349"></a><span class="lineno">  349</span>&#160;    }</div>

  421. <div class="line"><a name="l00350"></a><span class="lineno">  350</span>&#160; </div>

  422. <div class="line"><a name="l00351"></a><span class="lineno">  351</span>&#160;    <span class="comment">/*</span></div>

  423. <div class="line"><a name="l00352"></a><span class="lineno">  352</span>&#160;<span class="comment">     * Read a single-precision floating point number.</span></div>

  424. <div class="line"><a name="l00353"></a><span class="lineno">  353</span>&#160;<span class="comment">     * Returns 0 if reading fails.</span></div>

  425. <div class="line"><a name="l00354"></a><span class="lineno">  354</span>&#160;<span class="comment">     */</span></div>

  426. <div class="line"><a name="l00355"></a><span class="lineno">  355</span>&#160;    <span class="keywordtype">float</span> readFloat() noexcept</div>

  427. <div class="line"><a name="l00356"></a><span class="lineno">  356</span>&#160;    {</div>

  428. <div class="line"><a name="l00357"></a><span class="lineno">  357</span>&#160;        <span class="keywordtype">float</span> f = 0.0f;</div>

  429. <div class="line"><a name="l00358"></a><span class="lineno">  358</span>&#160;        <span class="keywordflow">return</span> tryRead(&amp;f, <span class="keyword">sizeof</span>(<span class="keywordtype">float</span>)) ? f : 0.0f;</div>

  430. <div class="line"><a name="l00359"></a><span class="lineno">  359</span>&#160;    }</div>

  431. <div class="line"><a name="l00360"></a><span class="lineno">  360</span>&#160; </div>

  432. <div class="line"><a name="l00361"></a><span class="lineno">  361</span>&#160;    <span class="comment">/*</span></div>

  433. <div class="line"><a name="l00362"></a><span class="lineno">  362</span>&#160;<span class="comment">     * Read a double-precision floating point number.</span></div>

  434. <div class="line"><a name="l00363"></a><span class="lineno">  363</span>&#160;<span class="comment">     * Returns 0 if reading fails.</span></div>

  435. <div class="line"><a name="l00364"></a><span class="lineno">  364</span>&#160;<span class="comment">     */</span></div>

  436. <div class="line"><a name="l00365"></a><span class="lineno">  365</span>&#160;    <span class="keywordtype">double</span> readDouble() noexcept</div>

  437. <div class="line"><a name="l00366"></a><span class="lineno">  366</span>&#160;    {</div>

  438. <div class="line"><a name="l00367"></a><span class="lineno">  367</span>&#160;        <span class="keywordtype">double</span> d = 0.0;</div>

  439. <div class="line"><a name="l00368"></a><span class="lineno">  368</span>&#160;        <span class="keywordflow">return</span> tryRead(&amp;d, <span class="keyword">sizeof</span>(<span class="keywordtype">double</span>)) ? d : 0.0;</div>

  440. <div class="line"><a name="l00369"></a><span class="lineno">  369</span>&#160;    }</div>

  441. <div class="line"><a name="l00370"></a><span class="lineno">  370</span>&#160;<span class="comment"></span> </div>

  442. <div class="line"><a name="l00371"></a><span class="lineno">  371</span>&#160;<span class="comment">    /*!</span></div>

  443. <div class="line"><a name="l00372"></a><span class="lineno">  372</span>&#160;<span class="comment">     * Read an arbitrary amount of data, specified by @a size.</span></div>

  444. <div class="line"><a name="l00373"></a><span class="lineno">  373</span>&#160;<span class="comment">     * data pointer must be non-null, and size &gt; 0.</span></div>

  445. <div class="line"><a name="l00374"></a><span class="lineno">  374</span>&#160;<span class="comment">     *</span></div>

  446. <div class="line"><a name="l00375"></a><span class="lineno">  375</span>&#160;<span class="comment">     * Returns true if reading succeeds.</span></div>

  447. <div class="line"><a name="l00376"></a><span class="lineno">  376</span>&#160;<span class="comment">     * In case of failure, @a data pointer is automatically cleared by @a size bytes.</span></div>

  448. <div class="line"><a name="l00377"></a><span class="lineno">  377</span>&#160;<span class="comment">     */</span></div>

  449. <div class="line"><a name="l00378"></a><span class="lineno"><a class="line" href="classRingBufferControl.html#aafdb126b2885c507cec852bc63fd6cb8">  378</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classRingBufferControl.html#aafdb126b2885c507cec852bc63fd6cb8">readCustomData</a>(<span class="keywordtype">void</span>* <span class="keyword">const</span> data, <span class="keyword">const</span> uint32_t size) noexcept</div>

  450. <div class="line"><a name="l00379"></a><span class="lineno">  379</span>&#160;    {</div>

  451. <div class="line"><a name="l00380"></a><span class="lineno">  380</span>&#160;        DISTRHO_SAFE_ASSERT_RETURN(data != <span class="keyword">nullptr</span>, <span class="keyword">false</span>);</div>

  452. <div class="line"><a name="l00381"></a><span class="lineno">  381</span>&#160;        DISTRHO_SAFE_ASSERT_RETURN(size &gt; 0, <span class="keyword">false</span>);</div>

  453. <div class="line"><a name="l00382"></a><span class="lineno">  382</span>&#160; </div>

  454. <div class="line"><a name="l00383"></a><span class="lineno">  383</span>&#160;        <span class="keywordflow">if</span> (tryRead(data, size))</div>

  455. <div class="line"><a name="l00384"></a><span class="lineno">  384</span>&#160;            <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>

  456. <div class="line"><a name="l00385"></a><span class="lineno">  385</span>&#160; </div>

  457. <div class="line"><a name="l00386"></a><span class="lineno">  386</span>&#160;        std::memset(data, 0, size);</div>

  458. <div class="line"><a name="l00387"></a><span class="lineno">  387</span>&#160;        <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>

  459. <div class="line"><a name="l00388"></a><span class="lineno">  388</span>&#160;    }</div>

  460. <div class="line"><a name="l00389"></a><span class="lineno">  389</span>&#160;<span class="comment"></span> </div>

  461. <div class="line"><a name="l00390"></a><span class="lineno">  390</span>&#160;<span class="comment">    /*!</span></div>

  462. <div class="line"><a name="l00391"></a><span class="lineno">  391</span>&#160;<span class="comment">     * Read a custom data type specified by the template typename used,</span></div>

  463. <div class="line"><a name="l00392"></a><span class="lineno">  392</span>&#160;<span class="comment">     * with size being automatically deduced by the compiler (through the use of sizeof).</span></div>

  464. <div class="line"><a name="l00393"></a><span class="lineno">  393</span>&#160;<span class="comment">     *</span></div>

  465. <div class="line"><a name="l00394"></a><span class="lineno">  394</span>&#160;<span class="comment">     * Returns true if reading succeeds.</span></div>

  466. <div class="line"><a name="l00395"></a><span class="lineno">  395</span>&#160;<span class="comment">     * In case of failure, @a type value is automatically cleared by its deduced size.</span></div>

  467. <div class="line"><a name="l00396"></a><span class="lineno">  396</span>&#160;<span class="comment">     */</span></div>

  468. <div class="line"><a name="l00397"></a><span class="lineno">  397</span>&#160;    <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>

  469. <div class="line"><a name="l00398"></a><span class="lineno"><a class="line" href="classRingBufferControl.html#aaaf4efe13ec2555c390047f545d2660d">  398</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classRingBufferControl.html#aaaf4efe13ec2555c390047f545d2660d">readCustomType</a>(T&amp; type) noexcept</div>

  470. <div class="line"><a name="l00399"></a><span class="lineno">  399</span>&#160;    {</div>

  471. <div class="line"><a name="l00400"></a><span class="lineno">  400</span>&#160;        <span class="keywordflow">if</span> (tryRead(&amp;type, <span class="keyword">sizeof</span>(T)))</div>

  472. <div class="line"><a name="l00401"></a><span class="lineno">  401</span>&#160;            <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>

  473. <div class="line"><a name="l00402"></a><span class="lineno">  402</span>&#160; </div>

  474. <div class="line"><a name="l00403"></a><span class="lineno">  403</span>&#160;        std::memset(&amp;type, 0, <span class="keyword">sizeof</span>(T));</div>

  475. <div class="line"><a name="l00404"></a><span class="lineno">  404</span>&#160;        <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>

  476. <div class="line"><a name="l00405"></a><span class="lineno">  405</span>&#160;    }</div>

  477. <div class="line"><a name="l00406"></a><span class="lineno">  406</span>&#160; </div>

  478. <div class="line"><a name="l00407"></a><span class="lineno">  407</span>&#160;    <span class="comment">// -------------------------------------------------------------------</span></div>

  479. <div class="line"><a name="l00408"></a><span class="lineno">  408</span>&#160;    <span class="comment">// write operations</span></div>

  480. <div class="line"><a name="l00409"></a><span class="lineno">  409</span>&#160; </div>

  481. <div class="line"><a name="l00410"></a><span class="lineno">  410</span>&#160;    <span class="comment">/*</span></div>

  482. <div class="line"><a name="l00411"></a><span class="lineno">  411</span>&#160;<span class="comment">     * Write a single boolean value.</span></div>

  483. <div class="line"><a name="l00412"></a><span class="lineno">  412</span>&#160;<span class="comment">     */</span></div>

  484. <div class="line"><a name="l00413"></a><span class="lineno">  413</span>&#160;    <span class="keywordtype">bool</span> writeBool(<span class="keyword">const</span> <span class="keywordtype">bool</span> value) noexcept</div>

  485. <div class="line"><a name="l00414"></a><span class="lineno">  414</span>&#160;    {</div>

  486. <div class="line"><a name="l00415"></a><span class="lineno">  415</span>&#160;        <span class="keywordflow">return</span> tryWrite(&amp;value, <span class="keyword">sizeof</span>(<span class="keywordtype">bool</span>));</div>

  487. <div class="line"><a name="l00416"></a><span class="lineno">  416</span>&#160;    }</div>

  488. <div class="line"><a name="l00417"></a><span class="lineno">  417</span>&#160; </div>

  489. <div class="line"><a name="l00418"></a><span class="lineno">  418</span>&#160;    <span class="comment">/*</span></div>

  490. <div class="line"><a name="l00419"></a><span class="lineno">  419</span>&#160;<span class="comment">     * Write a single 8-bit byte.</span></div>

  491. <div class="line"><a name="l00420"></a><span class="lineno">  420</span>&#160;<span class="comment">     */</span></div>

  492. <div class="line"><a name="l00421"></a><span class="lineno">  421</span>&#160;    <span class="keywordtype">bool</span> writeByte(<span class="keyword">const</span> uint8_t value) noexcept</div>

  493. <div class="line"><a name="l00422"></a><span class="lineno">  422</span>&#160;    {</div>

  494. <div class="line"><a name="l00423"></a><span class="lineno">  423</span>&#160;        <span class="keywordflow">return</span> tryWrite(&amp;value, <span class="keyword">sizeof</span>(uint8_t));</div>

  495. <div class="line"><a name="l00424"></a><span class="lineno">  424</span>&#160;    }</div>

  496. <div class="line"><a name="l00425"></a><span class="lineno">  425</span>&#160; </div>

  497. <div class="line"><a name="l00426"></a><span class="lineno">  426</span>&#160;    <span class="comment">/*</span></div>

  498. <div class="line"><a name="l00427"></a><span class="lineno">  427</span>&#160;<span class="comment">     * Write a short 16-bit integer.</span></div>

  499. <div class="line"><a name="l00428"></a><span class="lineno">  428</span>&#160;<span class="comment">     */</span></div>

  500. <div class="line"><a name="l00429"></a><span class="lineno">  429</span>&#160;    <span class="keywordtype">bool</span> writeShort(<span class="keyword">const</span> int16_t value) noexcept</div>

  501. <div class="line"><a name="l00430"></a><span class="lineno">  430</span>&#160;    {</div>

  502. <div class="line"><a name="l00431"></a><span class="lineno">  431</span>&#160;        <span class="keywordflow">return</span> tryWrite(&amp;value, <span class="keyword">sizeof</span>(int16_t));</div>

  503. <div class="line"><a name="l00432"></a><span class="lineno">  432</span>&#160;    }</div>

  504. <div class="line"><a name="l00433"></a><span class="lineno">  433</span>&#160; </div>

  505. <div class="line"><a name="l00434"></a><span class="lineno">  434</span>&#160;    <span class="comment">/*</span></div>

  506. <div class="line"><a name="l00435"></a><span class="lineno">  435</span>&#160;<span class="comment">     * Write a short unsigned 16-bit integer.</span></div>

  507. <div class="line"><a name="l00436"></a><span class="lineno">  436</span>&#160;<span class="comment">     */</span></div>

  508. <div class="line"><a name="l00437"></a><span class="lineno">  437</span>&#160;    <span class="keywordtype">bool</span> writeUShort(<span class="keyword">const</span> uint16_t value) noexcept</div>

  509. <div class="line"><a name="l00438"></a><span class="lineno">  438</span>&#160;    {</div>

  510. <div class="line"><a name="l00439"></a><span class="lineno">  439</span>&#160;        <span class="keywordflow">return</span> tryWrite(&amp;value, <span class="keyword">sizeof</span>(uint16_t));</div>

  511. <div class="line"><a name="l00440"></a><span class="lineno">  440</span>&#160;    }</div>

  512. <div class="line"><a name="l00441"></a><span class="lineno">  441</span>&#160; </div>

  513. <div class="line"><a name="l00442"></a><span class="lineno">  442</span>&#160;    <span class="comment">/*</span></div>

  514. <div class="line"><a name="l00443"></a><span class="lineno">  443</span>&#160;<span class="comment">     * Write a regular 32-bit integer.</span></div>

  515. <div class="line"><a name="l00444"></a><span class="lineno">  444</span>&#160;<span class="comment">     */</span></div>

  516. <div class="line"><a name="l00445"></a><span class="lineno">  445</span>&#160;    <span class="keywordtype">bool</span> writeInt(<span class="keyword">const</span> int32_t value) noexcept</div>

  517. <div class="line"><a name="l00446"></a><span class="lineno">  446</span>&#160;    {</div>

  518. <div class="line"><a name="l00447"></a><span class="lineno">  447</span>&#160;        <span class="keywordflow">return</span> tryWrite(&amp;value, <span class="keyword">sizeof</span>(int32_t));</div>

  519. <div class="line"><a name="l00448"></a><span class="lineno">  448</span>&#160;    }</div>

  520. <div class="line"><a name="l00449"></a><span class="lineno">  449</span>&#160; </div>

  521. <div class="line"><a name="l00450"></a><span class="lineno">  450</span>&#160;    <span class="comment">/*</span></div>

  522. <div class="line"><a name="l00451"></a><span class="lineno">  451</span>&#160;<span class="comment">     * Write an unsigned 32-bit integer.</span></div>

  523. <div class="line"><a name="l00452"></a><span class="lineno">  452</span>&#160;<span class="comment">     */</span></div>

  524. <div class="line"><a name="l00453"></a><span class="lineno">  453</span>&#160;    <span class="keywordtype">bool</span> writeUInt(<span class="keyword">const</span> uint32_t value) noexcept</div>

  525. <div class="line"><a name="l00454"></a><span class="lineno">  454</span>&#160;    {</div>

  526. <div class="line"><a name="l00455"></a><span class="lineno">  455</span>&#160;        <span class="keywordflow">return</span> tryWrite(&amp;value, <span class="keyword">sizeof</span>(uint32_t));</div>

  527. <div class="line"><a name="l00456"></a><span class="lineno">  456</span>&#160;    }</div>

  528. <div class="line"><a name="l00457"></a><span class="lineno">  457</span>&#160; </div>

  529. <div class="line"><a name="l00458"></a><span class="lineno">  458</span>&#160;    <span class="comment">/*</span></div>

  530. <div class="line"><a name="l00459"></a><span class="lineno">  459</span>&#160;<span class="comment">     * Write a long 64-bit integer.</span></div>

  531. <div class="line"><a name="l00460"></a><span class="lineno">  460</span>&#160;<span class="comment">     */</span></div>

  532. <div class="line"><a name="l00461"></a><span class="lineno">  461</span>&#160;    <span class="keywordtype">bool</span> writeLong(<span class="keyword">const</span> int64_t value) noexcept</div>

  533. <div class="line"><a name="l00462"></a><span class="lineno">  462</span>&#160;    {</div>

  534. <div class="line"><a name="l00463"></a><span class="lineno">  463</span>&#160;        <span class="keywordflow">return</span> tryWrite(&amp;value, <span class="keyword">sizeof</span>(int64_t));</div>

  535. <div class="line"><a name="l00464"></a><span class="lineno">  464</span>&#160;    }</div>

  536. <div class="line"><a name="l00465"></a><span class="lineno">  465</span>&#160; </div>

  537. <div class="line"><a name="l00466"></a><span class="lineno">  466</span>&#160;    <span class="comment">/*</span></div>

  538. <div class="line"><a name="l00467"></a><span class="lineno">  467</span>&#160;<span class="comment">     * Write a long unsigned 64-bit integer.</span></div>

  539. <div class="line"><a name="l00468"></a><span class="lineno">  468</span>&#160;<span class="comment">     */</span></div>

  540. <div class="line"><a name="l00469"></a><span class="lineno">  469</span>&#160;    <span class="keywordtype">bool</span> writeULong(<span class="keyword">const</span> uint64_t value) noexcept</div>

  541. <div class="line"><a name="l00470"></a><span class="lineno">  470</span>&#160;    {</div>

  542. <div class="line"><a name="l00471"></a><span class="lineno">  471</span>&#160;        <span class="keywordflow">return</span> tryWrite(&amp;value, <span class="keyword">sizeof</span>(uint64_t));</div>

  543. <div class="line"><a name="l00472"></a><span class="lineno">  472</span>&#160;    }</div>

  544. <div class="line"><a name="l00473"></a><span class="lineno">  473</span>&#160; </div>

  545. <div class="line"><a name="l00474"></a><span class="lineno">  474</span>&#160;    <span class="comment">/*</span></div>

  546. <div class="line"><a name="l00475"></a><span class="lineno">  475</span>&#160;<span class="comment">     * Write a single-precision floating point number.</span></div>

  547. <div class="line"><a name="l00476"></a><span class="lineno">  476</span>&#160;<span class="comment">     */</span></div>

  548. <div class="line"><a name="l00477"></a><span class="lineno">  477</span>&#160;    <span class="keywordtype">bool</span> writeFloat(<span class="keyword">const</span> <span class="keywordtype">float</span> value) noexcept</div>

  549. <div class="line"><a name="l00478"></a><span class="lineno">  478</span>&#160;    {</div>

  550. <div class="line"><a name="l00479"></a><span class="lineno">  479</span>&#160;        <span class="keywordflow">return</span> tryWrite(&amp;value, <span class="keyword">sizeof</span>(<span class="keywordtype">float</span>));</div>

  551. <div class="line"><a name="l00480"></a><span class="lineno">  480</span>&#160;    }</div>

  552. <div class="line"><a name="l00481"></a><span class="lineno">  481</span>&#160; </div>

  553. <div class="line"><a name="l00482"></a><span class="lineno">  482</span>&#160;    <span class="comment">/*</span></div>

  554. <div class="line"><a name="l00483"></a><span class="lineno">  483</span>&#160;<span class="comment">     * Write a double-precision floating point number.</span></div>

  555. <div class="line"><a name="l00484"></a><span class="lineno">  484</span>&#160;<span class="comment">     */</span></div>

  556. <div class="line"><a name="l00485"></a><span class="lineno">  485</span>&#160;    <span class="keywordtype">bool</span> writeDouble(<span class="keyword">const</span> <span class="keywordtype">double</span> value) noexcept</div>

  557. <div class="line"><a name="l00486"></a><span class="lineno">  486</span>&#160;    {</div>

  558. <div class="line"><a name="l00487"></a><span class="lineno">  487</span>&#160;        <span class="keywordflow">return</span> tryWrite(&amp;value, <span class="keyword">sizeof</span>(<span class="keywordtype">double</span>));</div>

  559. <div class="line"><a name="l00488"></a><span class="lineno">  488</span>&#160;    }</div>

  560. <div class="line"><a name="l00489"></a><span class="lineno">  489</span>&#160;<span class="comment"></span> </div>

  561. <div class="line"><a name="l00490"></a><span class="lineno">  490</span>&#160;<span class="comment">    /*!</span></div>

  562. <div class="line"><a name="l00491"></a><span class="lineno">  491</span>&#160;<span class="comment">     * Write an arbitrary amount of data, specified by @a size.</span></div>

  563. <div class="line"><a name="l00492"></a><span class="lineno">  492</span>&#160;<span class="comment">     * data pointer must be non-null, and size &gt; 0.</span></div>

  564. <div class="line"><a name="l00493"></a><span class="lineno">  493</span>&#160;<span class="comment">     */</span></div>

  565. <div class="line"><a name="l00494"></a><span class="lineno"><a class="line" href="classRingBufferControl.html#a72e173dcae573f6e2e8ac4cfeb8aa96b">  494</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classRingBufferControl.html#a72e173dcae573f6e2e8ac4cfeb8aa96b">writeCustomData</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* <span class="keyword">const</span> data, <span class="keyword">const</span> uint32_t size) noexcept</div>

  566. <div class="line"><a name="l00495"></a><span class="lineno">  495</span>&#160;    {</div>

  567. <div class="line"><a name="l00496"></a><span class="lineno">  496</span>&#160;        DISTRHO_SAFE_ASSERT_RETURN(data != <span class="keyword">nullptr</span>, <span class="keyword">false</span>);</div>

  568. <div class="line"><a name="l00497"></a><span class="lineno">  497</span>&#160;        DISTRHO_SAFE_ASSERT_RETURN(size &gt; 0, <span class="keyword">false</span>);</div>

  569. <div class="line"><a name="l00498"></a><span class="lineno">  498</span>&#160; </div>

  570. <div class="line"><a name="l00499"></a><span class="lineno">  499</span>&#160;        <span class="keywordflow">return</span> tryWrite(data, size);</div>

  571. <div class="line"><a name="l00500"></a><span class="lineno">  500</span>&#160;    }</div>

  572. <div class="line"><a name="l00501"></a><span class="lineno">  501</span>&#160;<span class="comment"></span> </div>

  573. <div class="line"><a name="l00502"></a><span class="lineno">  502</span>&#160;<span class="comment">    /*!</span></div>

  574. <div class="line"><a name="l00503"></a><span class="lineno">  503</span>&#160;<span class="comment">     * Write a custom data type specified by the template typename used,</span></div>

  575. <div class="line"><a name="l00504"></a><span class="lineno">  504</span>&#160;<span class="comment">     * with size being automatically deduced by the compiler (through the use of sizeof).</span></div>

  576. <div class="line"><a name="l00505"></a><span class="lineno">  505</span>&#160;<span class="comment">     */</span></div>

  577. <div class="line"><a name="l00506"></a><span class="lineno">  506</span>&#160;    <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>

  578. <div class="line"><a name="l00507"></a><span class="lineno"><a class="line" href="classRingBufferControl.html#a3e9c1857e11f0d9efcc2944d6000504b">  507</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classRingBufferControl.html#a3e9c1857e11f0d9efcc2944d6000504b">writeCustomType</a>(<span class="keyword">const</span> T&amp; type) noexcept</div>

  579. <div class="line"><a name="l00508"></a><span class="lineno">  508</span>&#160;    {</div>

  580. <div class="line"><a name="l00509"></a><span class="lineno">  509</span>&#160;        <span class="keywordflow">return</span> tryWrite(&amp;type, <span class="keyword">sizeof</span>(T));</div>

  581. <div class="line"><a name="l00510"></a><span class="lineno">  510</span>&#160;    }</div>

  582. <div class="line"><a name="l00511"></a><span class="lineno">  511</span>&#160; </div>

  583. <div class="line"><a name="l00512"></a><span class="lineno">  512</span>&#160;    <span class="comment">// -------------------------------------------------------------------</span></div>

  584. <div class="line"><a name="l00513"></a><span class="lineno">  513</span>&#160;<span class="comment"></span> </div>

  585. <div class="line"><a name="l00514"></a><span class="lineno">  514</span>&#160;<span class="comment">    /*!</span></div>

  586. <div class="line"><a name="l00515"></a><span class="lineno">  515</span>&#160;<span class="comment">     * Commit all previous write operations to the ringbuffer.</span></div>

  587. <div class="line"><a name="l00516"></a><span class="lineno">  516</span>&#160;<span class="comment">     * If a write operation has previously failed, this will reset/invalidate the previous write attempts.</span></div>

  588. <div class="line"><a name="l00517"></a><span class="lineno">  517</span>&#160;<span class="comment">     */</span></div>

  589. <div class="line"><a name="l00518"></a><span class="lineno"><a class="line" href="classRingBufferControl.html#afe0c53d2591eb265d657c1cab6800036">  518</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classRingBufferControl.html#afe0c53d2591eb265d657c1cab6800036">commitWrite</a>() noexcept</div>

  590. <div class="line"><a name="l00519"></a><span class="lineno">  519</span>&#160;    {</div>

  591. <div class="line"><a name="l00520"></a><span class="lineno">  520</span>&#160;        DISTRHO_SAFE_ASSERT_RETURN(buffer != <span class="keyword">nullptr</span>, <span class="keyword">false</span>);</div>

  592. <div class="line"><a name="l00521"></a><span class="lineno">  521</span>&#160; </div>

  593. <div class="line"><a name="l00522"></a><span class="lineno">  522</span>&#160;        <span class="keywordflow">if</span> (buffer-&gt;invalidateCommit)</div>

  594. <div class="line"><a name="l00523"></a><span class="lineno">  523</span>&#160;        {</div>

  595. <div class="line"><a name="l00524"></a><span class="lineno">  524</span>&#160;            buffer-&gt;wrtn = buffer-&gt;head;</div>

  596. <div class="line"><a name="l00525"></a><span class="lineno">  525</span>&#160;            buffer-&gt;invalidateCommit = <span class="keyword">false</span>;</div>

  597. <div class="line"><a name="l00526"></a><span class="lineno">  526</span>&#160;            <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>

  598. <div class="line"><a name="l00527"></a><span class="lineno">  527</span>&#160;        }</div>

  599. <div class="line"><a name="l00528"></a><span class="lineno">  528</span>&#160; </div>

  600. <div class="line"><a name="l00529"></a><span class="lineno">  529</span>&#160;        <span class="comment">// nothing to commit?</span></div>

  601. <div class="line"><a name="l00530"></a><span class="lineno">  530</span>&#160;        DISTRHO_SAFE_ASSERT_RETURN(buffer-&gt;head != buffer-&gt;wrtn, <span class="keyword">false</span>);</div>

  602. <div class="line"><a name="l00531"></a><span class="lineno">  531</span>&#160; </div>

  603. <div class="line"><a name="l00532"></a><span class="lineno">  532</span>&#160;        <span class="comment">// all ok</span></div>

  604. <div class="line"><a name="l00533"></a><span class="lineno">  533</span>&#160;        buffer-&gt;head = buffer-&gt;wrtn;</div>

  605. <div class="line"><a name="l00534"></a><span class="lineno">  534</span>&#160;        errorWriting = <span class="keyword">false</span>;</div>

  606. <div class="line"><a name="l00535"></a><span class="lineno">  535</span>&#160;        <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>

  607. <div class="line"><a name="l00536"></a><span class="lineno">  536</span>&#160;    }</div>

  608. <div class="line"><a name="l00537"></a><span class="lineno">  537</span>&#160; </div>

  609. <div class="line"><a name="l00538"></a><span class="lineno">  538</span>&#160;    <span class="comment">// -------------------------------------------------------------------</span></div>

  610. <div class="line"><a name="l00539"></a><span class="lineno">  539</span>&#160; </div>

  611. <div class="line"><a name="l00540"></a><span class="lineno">  540</span>&#160;    <span class="comment">/*</span></div>

  612. <div class="line"><a name="l00541"></a><span class="lineno">  541</span>&#160;<span class="comment">     * Tie this ring buffer control to a ring buffer struct, optionally clearing its data.</span></div>

  613. <div class="line"><a name="l00542"></a><span class="lineno">  542</span>&#160;<span class="comment">     */</span></div>

  614. <div class="line"><a name="l00543"></a><span class="lineno">  543</span>&#160;    <span class="keywordtype">void</span> setRingBuffer(BufferStruct* <span class="keyword">const</span> ringBuf, <span class="keyword">const</span> <span class="keywordtype">bool</span> clearRingBufferData) noexcept</div>

  615. <div class="line"><a name="l00544"></a><span class="lineno">  544</span>&#160;    {</div>

  616. <div class="line"><a name="l00545"></a><span class="lineno">  545</span>&#160;        DISTRHO_SAFE_ASSERT_RETURN(buffer != ringBuf,);</div>

  617. <div class="line"><a name="l00546"></a><span class="lineno">  546</span>&#160; </div>

  618. <div class="line"><a name="l00547"></a><span class="lineno">  547</span>&#160;        buffer = ringBuf;</div>

  619. <div class="line"><a name="l00548"></a><span class="lineno">  548</span>&#160; </div>

  620. <div class="line"><a name="l00549"></a><span class="lineno">  549</span>&#160;        <span class="keywordflow">if</span> (clearRingBufferData &amp;&amp; ringBuf != <span class="keyword">nullptr</span>)</div>

  621. <div class="line"><a name="l00550"></a><span class="lineno">  550</span>&#160;            clearData();</div>

  622. <div class="line"><a name="l00551"></a><span class="lineno">  551</span>&#160;    }</div>

  623. <div class="line"><a name="l00552"></a><span class="lineno">  552</span>&#160; </div>

  624. <div class="line"><a name="l00553"></a><span class="lineno">  553</span>&#160;    <span class="comment">// -------------------------------------------------------------------</span></div>

  625. <div class="line"><a name="l00554"></a><span class="lineno">  554</span>&#160; </div>

  626. <div class="line"><a name="l00555"></a><span class="lineno">  555</span>&#160;<span class="keyword">protected</span>:<span class="comment"></span></div>

  627. <div class="line"><a name="l00556"></a><span class="lineno">  556</span>&#160;<span class="comment">    /** @internal try reading from the buffer, can fail. */</span></div>

  628. <div class="line"><a name="l00557"></a><span class="lineno">  557</span>&#160;    <span class="keywordtype">bool</span> tryRead(<span class="keywordtype">void</span>* <span class="keyword">const</span> buf, <span class="keyword">const</span> uint32_t size) noexcept</div>

  629. <div class="line"><a name="l00558"></a><span class="lineno">  558</span>&#160;    {</div>

  630. <div class="line"><a name="l00559"></a><span class="lineno">  559</span>&#160;        DISTRHO_SAFE_ASSERT_RETURN(buffer != <span class="keyword">nullptr</span>, <span class="keyword">false</span>);</div>

  631. <div class="line"><a name="l00560"></a><span class="lineno">  560</span>&#160;<span class="preprocessor">       #if defined(__clang__)</span></div>

  632. <div class="line"><a name="l00561"></a><span class="lineno">  561</span>&#160;<span class="preprocessor">        #pragma clang diagnostic push</span></div>

  633. <div class="line"><a name="l00562"></a><span class="lineno">  562</span>&#160;<span class="preprocessor">        #pragma clang diagnostic ignored &quot;-Wtautological-pointer-compare&quot;</span></div>

  634. <div class="line"><a name="l00563"></a><span class="lineno">  563</span>&#160;<span class="preprocessor">       #endif</span></div>

  635. <div class="line"><a name="l00564"></a><span class="lineno">  564</span>&#160;        DISTRHO_SAFE_ASSERT_RETURN(buffer-&gt;buf != <span class="keyword">nullptr</span>, <span class="keyword">false</span>);</div>

  636. <div class="line"><a name="l00565"></a><span class="lineno">  565</span>&#160;<span class="preprocessor">       #if defined(__clang__)</span></div>

  637. <div class="line"><a name="l00566"></a><span class="lineno">  566</span>&#160;<span class="preprocessor">        #pragma clang diagnostic pop</span></div>

  638. <div class="line"><a name="l00567"></a><span class="lineno">  567</span>&#160;<span class="preprocessor">       #endif</span></div>

  639. <div class="line"><a name="l00568"></a><span class="lineno">  568</span>&#160;        DISTRHO_SAFE_ASSERT_RETURN(buf != <span class="keyword">nullptr</span>, <span class="keyword">false</span>);</div>

  640. <div class="line"><a name="l00569"></a><span class="lineno">  569</span>&#160;        DISTRHO_SAFE_ASSERT_RETURN(size &gt; 0, <span class="keyword">false</span>);</div>

  641. <div class="line"><a name="l00570"></a><span class="lineno">  570</span>&#160;        DISTRHO_SAFE_ASSERT_RETURN(size &lt; buffer-&gt;size, <span class="keyword">false</span>);</div>

  642. <div class="line"><a name="l00571"></a><span class="lineno">  571</span>&#160; </div>

  643. <div class="line"><a name="l00572"></a><span class="lineno">  572</span>&#160;        <span class="comment">// empty</span></div>

  644. <div class="line"><a name="l00573"></a><span class="lineno">  573</span>&#160;        <span class="keywordflow">if</span> (buffer-&gt;head == buffer-&gt;tail)</div>

  645. <div class="line"><a name="l00574"></a><span class="lineno">  574</span>&#160;            <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>

  646. <div class="line"><a name="l00575"></a><span class="lineno">  575</span>&#160; </div>

  647. <div class="line"><a name="l00576"></a><span class="lineno">  576</span>&#160;        uint8_t* <span class="keyword">const</span> bytebuf = <span class="keyword">static_cast&lt;</span>uint8_t*<span class="keyword">&gt;</span>(buf);</div>

  648. <div class="line"><a name="l00577"></a><span class="lineno">  577</span>&#160; </div>

  649. <div class="line"><a name="l00578"></a><span class="lineno">  578</span>&#160;        <span class="keyword">const</span> uint32_t head = buffer-&gt;head;</div>

  650. <div class="line"><a name="l00579"></a><span class="lineno">  579</span>&#160;        <span class="keyword">const</span> uint32_t tail = buffer-&gt;tail;</div>

  651. <div class="line"><a name="l00580"></a><span class="lineno">  580</span>&#160;        <span class="keyword">const</span> uint32_t wrap = head &gt; tail ? 0 : buffer-&gt;size;</div>

  652. <div class="line"><a name="l00581"></a><span class="lineno">  581</span>&#160; </div>

  653. <div class="line"><a name="l00582"></a><span class="lineno">  582</span>&#160;        <span class="keywordflow">if</span> (size &gt; wrap + head - tail)</div>

  654. <div class="line"><a name="l00583"></a><span class="lineno">  583</span>&#160;        {</div>

  655. <div class="line"><a name="l00584"></a><span class="lineno">  584</span>&#160;            <span class="keywordflow">if</span> (! errorReading)</div>

  656. <div class="line"><a name="l00585"></a><span class="lineno">  585</span>&#160;            {</div>

  657. <div class="line"><a name="l00586"></a><span class="lineno">  586</span>&#160;                errorReading = <span class="keyword">true</span>;</div>

  658. <div class="line"><a name="l00587"></a><span class="lineno">  587</span>&#160;                <a class="code" href="group__StringPrintFunctions.html#ga9861b6a26e43554680f50623196dde7b">d_stderr2</a>(<span class="stringliteral">&quot;RingBuffer::tryRead(%p, %lu): failed, not enough space&quot;</span>, buf, (ulong)size);</div>

  659. <div class="line"><a name="l00588"></a><span class="lineno">  588</span>&#160;            }</div>

  660. <div class="line"><a name="l00589"></a><span class="lineno">  589</span>&#160;            <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>

  661. <div class="line"><a name="l00590"></a><span class="lineno">  590</span>&#160;        }</div>

  662. <div class="line"><a name="l00591"></a><span class="lineno">  591</span>&#160; </div>

  663. <div class="line"><a name="l00592"></a><span class="lineno">  592</span>&#160;        uint32_t readto = tail + size;</div>

  664. <div class="line"><a name="l00593"></a><span class="lineno">  593</span>&#160; </div>

  665. <div class="line"><a name="l00594"></a><span class="lineno">  594</span>&#160;        <span class="keywordflow">if</span> (readto &gt; buffer-&gt;size)</div>

  666. <div class="line"><a name="l00595"></a><span class="lineno">  595</span>&#160;        {</div>

  667. <div class="line"><a name="l00596"></a><span class="lineno">  596</span>&#160;            readto -= buffer-&gt;size;</div>

  668. <div class="line"><a name="l00597"></a><span class="lineno">  597</span>&#160; </div>

  669. <div class="line"><a name="l00598"></a><span class="lineno">  598</span>&#160;            <span class="keywordflow">if</span> (size == 1)</div>

  670. <div class="line"><a name="l00599"></a><span class="lineno">  599</span>&#160;            {</div>

  671. <div class="line"><a name="l00600"></a><span class="lineno">  600</span>&#160;                std::memcpy(bytebuf, buffer-&gt;buf + tail, 1);</div>

  672. <div class="line"><a name="l00601"></a><span class="lineno">  601</span>&#160;            }</div>

  673. <div class="line"><a name="l00602"></a><span class="lineno">  602</span>&#160;            <span class="keywordflow">else</span></div>

  674. <div class="line"><a name="l00603"></a><span class="lineno">  603</span>&#160;            {</div>

  675. <div class="line"><a name="l00604"></a><span class="lineno">  604</span>&#160;                <span class="keyword">const</span> uint32_t firstpart(buffer-&gt;size - tail);</div>

  676. <div class="line"><a name="l00605"></a><span class="lineno">  605</span>&#160;                std::memcpy(bytebuf, buffer-&gt;buf + tail, firstpart);</div>

  677. <div class="line"><a name="l00606"></a><span class="lineno">  606</span>&#160;                std::memcpy(bytebuf + firstpart, buffer-&gt;buf, readto);</div>

  678. <div class="line"><a name="l00607"></a><span class="lineno">  607</span>&#160;            }</div>

  679. <div class="line"><a name="l00608"></a><span class="lineno">  608</span>&#160;        }</div>

  680. <div class="line"><a name="l00609"></a><span class="lineno">  609</span>&#160;        <span class="keywordflow">else</span></div>

  681. <div class="line"><a name="l00610"></a><span class="lineno">  610</span>&#160;        {</div>

  682. <div class="line"><a name="l00611"></a><span class="lineno">  611</span>&#160;            std::memcpy(bytebuf, buffer-&gt;buf + tail, size);</div>

  683. <div class="line"><a name="l00612"></a><span class="lineno">  612</span>&#160; </div>

  684. <div class="line"><a name="l00613"></a><span class="lineno">  613</span>&#160;            <span class="keywordflow">if</span> (readto == buffer-&gt;size)</div>

  685. <div class="line"><a name="l00614"></a><span class="lineno">  614</span>&#160;                readto = 0;</div>

  686. <div class="line"><a name="l00615"></a><span class="lineno">  615</span>&#160;        }</div>

  687. <div class="line"><a name="l00616"></a><span class="lineno">  616</span>&#160; </div>

  688. <div class="line"><a name="l00617"></a><span class="lineno">  617</span>&#160;        buffer-&gt;tail = readto;</div>

  689. <div class="line"><a name="l00618"></a><span class="lineno">  618</span>&#160;        errorReading = <span class="keyword">false</span>;</div>

  690. <div class="line"><a name="l00619"></a><span class="lineno">  619</span>&#160;        <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>

  691. <div class="line"><a name="l00620"></a><span class="lineno">  620</span>&#160;    }</div>

  692. <div class="line"><a name="l00621"></a><span class="lineno">  621</span>&#160;<span class="comment"></span> </div>

  693. <div class="line"><a name="l00622"></a><span class="lineno">  622</span>&#160;<span class="comment">    /** @internal try writing to the buffer, can fail. */</span></div>

  694. <div class="line"><a name="l00623"></a><span class="lineno">  623</span>&#160;    <span class="keywordtype">bool</span> tryWrite(<span class="keyword">const</span> <span class="keywordtype">void</span>* <span class="keyword">const</span> buf, <span class="keyword">const</span> uint32_t size) noexcept</div>

  695. <div class="line"><a name="l00624"></a><span class="lineno">  624</span>&#160;    {</div>

  696. <div class="line"><a name="l00625"></a><span class="lineno">  625</span>&#160;        DISTRHO_SAFE_ASSERT_RETURN(buffer != <span class="keyword">nullptr</span>, <span class="keyword">false</span>);</div>

  697. <div class="line"><a name="l00626"></a><span class="lineno">  626</span>&#160;        DISTRHO_SAFE_ASSERT_RETURN(buf != <span class="keyword">nullptr</span>, <span class="keyword">false</span>);</div>

  698. <div class="line"><a name="l00627"></a><span class="lineno">  627</span>&#160;        DISTRHO_SAFE_ASSERT_RETURN(size &gt; 0, <span class="keyword">false</span>);</div>

  699. <div class="line"><a name="l00628"></a><span class="lineno">  628</span>&#160;        DISTRHO_SAFE_ASSERT_UINT2_RETURN(size &lt; buffer-&gt;size, size, buffer-&gt;size, <span class="keyword">false</span>);</div>

  700. <div class="line"><a name="l00629"></a><span class="lineno">  629</span>&#160; </div>

  701. <div class="line"><a name="l00630"></a><span class="lineno">  630</span>&#160;        <span class="keyword">const</span> uint8_t* <span class="keyword">const</span> bytebuf = <span class="keyword">static_cast&lt;</span><span class="keyword">const </span>uint8_t*<span class="keyword">&gt;</span>(buf);</div>

  702. <div class="line"><a name="l00631"></a><span class="lineno">  631</span>&#160; </div>

  703. <div class="line"><a name="l00632"></a><span class="lineno">  632</span>&#160;        <span class="keyword">const</span> uint32_t tail = buffer-&gt;tail;</div>

  704. <div class="line"><a name="l00633"></a><span class="lineno">  633</span>&#160;        <span class="keyword">const</span> uint32_t wrtn = buffer-&gt;wrtn;</div>

  705. <div class="line"><a name="l00634"></a><span class="lineno">  634</span>&#160;        <span class="keyword">const</span> uint32_t wrap = tail &gt; wrtn ? 0 : buffer-&gt;size;</div>

  706. <div class="line"><a name="l00635"></a><span class="lineno">  635</span>&#160; </div>

  707. <div class="line"><a name="l00636"></a><span class="lineno">  636</span>&#160;        <span class="keywordflow">if</span> (size &gt;= wrap + tail - wrtn)</div>

  708. <div class="line"><a name="l00637"></a><span class="lineno">  637</span>&#160;        {</div>

  709. <div class="line"><a name="l00638"></a><span class="lineno">  638</span>&#160;            <span class="keywordflow">if</span> (! errorWriting)</div>

  710. <div class="line"><a name="l00639"></a><span class="lineno">  639</span>&#160;            {</div>

  711. <div class="line"><a name="l00640"></a><span class="lineno">  640</span>&#160;                errorWriting = <span class="keyword">true</span>;</div>

  712. <div class="line"><a name="l00641"></a><span class="lineno">  641</span>&#160;                <a class="code" href="group__StringPrintFunctions.html#ga9861b6a26e43554680f50623196dde7b">d_stderr2</a>(<span class="stringliteral">&quot;RingBuffer::tryWrite(%p, %lu): failed, not enough space&quot;</span>, buf, (ulong)size);</div>

  713. <div class="line"><a name="l00642"></a><span class="lineno">  642</span>&#160;            }</div>

  714. <div class="line"><a name="l00643"></a><span class="lineno">  643</span>&#160;            buffer-&gt;invalidateCommit = <span class="keyword">true</span>;</div>

  715. <div class="line"><a name="l00644"></a><span class="lineno">  644</span>&#160;            <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>

  716. <div class="line"><a name="l00645"></a><span class="lineno">  645</span>&#160;        }</div>

  717. <div class="line"><a name="l00646"></a><span class="lineno">  646</span>&#160; </div>

  718. <div class="line"><a name="l00647"></a><span class="lineno">  647</span>&#160;        uint32_t writeto = wrtn + size;</div>

  719. <div class="line"><a name="l00648"></a><span class="lineno">  648</span>&#160; </div>

  720. <div class="line"><a name="l00649"></a><span class="lineno">  649</span>&#160;        <span class="keywordflow">if</span> (writeto &gt; buffer-&gt;size)</div>

  721. <div class="line"><a name="l00650"></a><span class="lineno">  650</span>&#160;        {</div>

  722. <div class="line"><a name="l00651"></a><span class="lineno">  651</span>&#160;            writeto -= buffer-&gt;size;</div>

  723. <div class="line"><a name="l00652"></a><span class="lineno">  652</span>&#160; </div>

  724. <div class="line"><a name="l00653"></a><span class="lineno">  653</span>&#160;            <span class="keywordflow">if</span> (size == 1)</div>

  725. <div class="line"><a name="l00654"></a><span class="lineno">  654</span>&#160;            {</div>

  726. <div class="line"><a name="l00655"></a><span class="lineno">  655</span>&#160;                std::memcpy(buffer-&gt;buf, bytebuf, 1);</div>

  727. <div class="line"><a name="l00656"></a><span class="lineno">  656</span>&#160;            }</div>

  728. <div class="line"><a name="l00657"></a><span class="lineno">  657</span>&#160;            <span class="keywordflow">else</span></div>

  729. <div class="line"><a name="l00658"></a><span class="lineno">  658</span>&#160;            {</div>

  730. <div class="line"><a name="l00659"></a><span class="lineno">  659</span>&#160;                <span class="keyword">const</span> uint32_t firstpart(buffer-&gt;size - wrtn);</div>

  731. <div class="line"><a name="l00660"></a><span class="lineno">  660</span>&#160;                std::memcpy(buffer-&gt;buf + wrtn, bytebuf, firstpart);</div>

  732. <div class="line"><a name="l00661"></a><span class="lineno">  661</span>&#160;                std::memcpy(buffer-&gt;buf, bytebuf + firstpart, writeto);</div>

  733. <div class="line"><a name="l00662"></a><span class="lineno">  662</span>&#160;            }</div>

  734. <div class="line"><a name="l00663"></a><span class="lineno">  663</span>&#160;        }</div>

  735. <div class="line"><a name="l00664"></a><span class="lineno">  664</span>&#160;        <span class="keywordflow">else</span></div>

  736. <div class="line"><a name="l00665"></a><span class="lineno">  665</span>&#160;        {</div>

  737. <div class="line"><a name="l00666"></a><span class="lineno">  666</span>&#160;            std::memcpy(buffer-&gt;buf + wrtn, bytebuf, size);</div>

  738. <div class="line"><a name="l00667"></a><span class="lineno">  667</span>&#160; </div>

  739. <div class="line"><a name="l00668"></a><span class="lineno">  668</span>&#160;            <span class="keywordflow">if</span> (writeto == buffer-&gt;size)</div>

  740. <div class="line"><a name="l00669"></a><span class="lineno">  669</span>&#160;                writeto = 0;</div>

  741. <div class="line"><a name="l00670"></a><span class="lineno">  670</span>&#160;        }</div>

  742. <div class="line"><a name="l00671"></a><span class="lineno">  671</span>&#160; </div>

  743. <div class="line"><a name="l00672"></a><span class="lineno">  672</span>&#160;        buffer-&gt;wrtn = writeto;</div>

  744. <div class="line"><a name="l00673"></a><span class="lineno">  673</span>&#160;        <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>

  745. <div class="line"><a name="l00674"></a><span class="lineno">  674</span>&#160;    }</div>

  746. <div class="line"><a name="l00675"></a><span class="lineno">  675</span>&#160; </div>

  747. <div class="line"><a name="l00676"></a><span class="lineno">  676</span>&#160;<span class="keyword">private</span>:<span class="comment"></span></div>

  748. <div class="line"><a name="l00677"></a><span class="lineno">  677</span>&#160;<span class="comment">    /** Buffer struct pointer. */</span></div>

  749. <div class="line"><a name="l00678"></a><span class="lineno">  678</span>&#160;    BufferStruct* buffer;</div>

  750. <div class="line"><a name="l00679"></a><span class="lineno">  679</span>&#160;<span class="comment"></span> </div>

  751. <div class="line"><a name="l00680"></a><span class="lineno">  680</span>&#160;<span class="comment">    /** Whether read errors have been printed to terminal. */</span></div>

  752. <div class="line"><a name="l00681"></a><span class="lineno">  681</span>&#160;    <span class="keywordtype">bool</span> errorReading;</div>

  753. <div class="line"><a name="l00682"></a><span class="lineno">  682</span>&#160;<span class="comment"></span> </div>

  754. <div class="line"><a name="l00683"></a><span class="lineno">  683</span>&#160;<span class="comment">    /** Whether write errors have been printed to terminal. */</span></div>

  755. <div class="line"><a name="l00684"></a><span class="lineno">  684</span>&#160;    <span class="keywordtype">bool</span> errorWriting;</div>

  756. <div class="line"><a name="l00685"></a><span class="lineno">  685</span>&#160; </div>

  757. <div class="line"><a name="l00686"></a><span class="lineno">  686</span>&#160;    DISTRHO_PREVENT_VIRTUAL_HEAP_ALLOCATION</div>

  758. <div class="line"><a name="l00687"></a><span class="lineno">  687</span>&#160;    DISTRHO_DECLARE_NON_COPYABLE(<a class="code" href="classRingBufferControl.html">RingBufferControl</a>)</div>

  759. <div class="line"><a name="l00688"></a><span class="lineno">  688</span>&#160;};</div>

  760. <div class="line"><a name="l00689"></a><span class="lineno">  689</span>&#160; </div>

  761. <div class="line"><a name="l00690"></a><span class="lineno">  690</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> BufferStruct&gt;</div>

  762. <div class="line"><a name="l00691"></a><span class="lineno">  691</span>&#160;<span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classRingBufferControl.html">RingBufferControl&lt;BufferStruct&gt;::isDataAvailableForReading</a>() const noexcept</div>

  763. <div class="line"><a name="l00692"></a><span class="lineno">  692</span>&#160;{</div>

  764. <div class="line"><a name="l00693"></a><span class="lineno">  693</span>&#160;    <span class="keywordflow">return</span> (buffer != <span class="keyword">nullptr</span> &amp;&amp; buffer-&gt;head != buffer-&gt;tail);</div>

  765. <div class="line"><a name="l00694"></a><span class="lineno">  694</span>&#160;}</div>

  766. <div class="line"><a name="l00695"></a><span class="lineno">  695</span>&#160; </div>

  767. <div class="line"><a name="l00696"></a><span class="lineno">  696</span>&#160;<span class="keyword">template</span> &lt;&gt;</div>

  768. <div class="line"><a name="l00697"></a><span class="lineno">  697</span>&#160;<span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classRingBufferControl.html">RingBufferControl&lt;HeapBuffer&gt;::isDataAvailableForReading</a>() const noexcept</div>

  769. <div class="line"><a name="l00698"></a><span class="lineno">  698</span>&#160;{</div>

  770. <div class="line"><a name="l00699"></a><span class="lineno">  699</span>&#160;    <span class="keywordflow">return</span> (buffer != <span class="keyword">nullptr</span> &amp;&amp; buffer-&gt;buf != <span class="keyword">nullptr</span> &amp;&amp; buffer-&gt;head != buffer-&gt;tail);</div>

  771. <div class="line"><a name="l00700"></a><span class="lineno">  700</span>&#160;}</div>

  772. <div class="line"><a name="l00701"></a><span class="lineno">  701</span>&#160; </div>

  773. <div class="line"><a name="l00702"></a><span class="lineno">  702</span>&#160;<span class="comment">// -----------------------------------------------------------------------</span></div>

  774. <div class="line"><a name="l00703"></a><span class="lineno">  703</span>&#160;<span class="comment">// RingBuffer using heap space</span></div>

  775. <div class="line"><a name="l00704"></a><span class="lineno">  704</span>&#160;<span class="comment"></span> </div>

  776. <div class="line"><a name="l00705"></a><span class="lineno">  705</span>&#160;<span class="comment">/**</span></div>

  777. <div class="line"><a name="l00706"></a><span class="lineno">  706</span>&#160;<span class="comment">   RingBufferControl with a heap buffer.</span></div>

  778. <div class="line"><a name="l00707"></a><span class="lineno">  707</span>&#160;<span class="comment">   This is a convenience class that provides a method for creating and destroying the heap data.</span></div>

  779. <div class="line"><a name="l00708"></a><span class="lineno">  708</span>&#160;<span class="comment">   Requires the use of createBuffer(uint32_t) to make the ring buffer usable.</span></div>

  780. <div class="line"><a name="l00709"></a><span class="lineno">  709</span>&#160;<span class="comment">*/</span></div>

  781. <div class="line"><a name="l00710"></a><span class="lineno"><a class="line" href="classHeapRingBuffer.html">  710</a></span>&#160;<span class="keyword">class </span><a class="code" href="classHeapRingBuffer.html">HeapRingBuffer</a> : <span class="keyword">public</span> <a class="code" href="classRingBufferControl.html">RingBufferControl</a>&lt;HeapBuffer&gt;</div>

  782. <div class="line"><a name="l00711"></a><span class="lineno">  711</span>&#160;{</div>

  783. <div class="line"><a name="l00712"></a><span class="lineno">  712</span>&#160;<span class="keyword">public</span>:<span class="comment"></span></div>

  784. <div class="line"><a name="l00713"></a><span class="lineno">  713</span>&#160;<span class="comment">    /** Constructor. */</span></div>

  785. <div class="line"><a name="l00714"></a><span class="lineno"><a class="line" href="classHeapRingBuffer.html#a6a3c03b584b5b20ad2829e26f5e6ed0e">  714</a></span>&#160;    <a class="code" href="classHeapRingBuffer.html#a6a3c03b584b5b20ad2829e26f5e6ed0e">HeapRingBuffer</a>() noexcept</div>

  786. <div class="line"><a name="l00715"></a><span class="lineno">  715</span>&#160;        : heapBuffer(HeapBuffer_INIT)</div>

  787. <div class="line"><a name="l00716"></a><span class="lineno">  716</span>&#160;    {</div>

  788. <div class="line"><a name="l00717"></a><span class="lineno">  717</span>&#160;<span class="preprocessor">#ifndef DISTRHO_PROPER_CPP11_SUPPORT</span></div>

  789. <div class="line"><a name="l00718"></a><span class="lineno">  718</span>&#160;        std::memset(&amp;heapBuffer, 0, <span class="keyword">sizeof</span>(heapBuffer));</div>

  790. <div class="line"><a name="l00719"></a><span class="lineno">  719</span>&#160;<span class="preprocessor">#endif</span></div>

  791. <div class="line"><a name="l00720"></a><span class="lineno">  720</span>&#160;    }</div>

  792. <div class="line"><a name="l00721"></a><span class="lineno">  721</span>&#160;<span class="comment"></span> </div>

  793. <div class="line"><a name="l00722"></a><span class="lineno">  722</span>&#160;<span class="comment">    /** Destructor. */</span></div>

  794. <div class="line"><a name="l00723"></a><span class="lineno"><a class="line" href="classHeapRingBuffer.html#ae2e25c610073d35998efd7106b5eb8a0">  723</a></span>&#160;    <a class="code" href="classHeapRingBuffer.html#ae2e25c610073d35998efd7106b5eb8a0">~HeapRingBuffer</a>() noexcept<span class="keyword"> override</span></div>

  795. <div class="line"><a name="l00724"></a><span class="lineno">  724</span>&#160;<span class="keyword">    </span>{</div>

  796. <div class="line"><a name="l00725"></a><span class="lineno">  725</span>&#160;        <span class="keywordflow">if</span> (heapBuffer.<a class="code" href="structHeapBuffer.html#afbaf206237e4898a306025676dce0987">buf</a> == <span class="keyword">nullptr</span>)</div>

  797. <div class="line"><a name="l00726"></a><span class="lineno">  726</span>&#160;            <span class="keywordflow">return</span>;</div>

  798. <div class="line"><a name="l00727"></a><span class="lineno">  727</span>&#160; </div>

  799. <div class="line"><a name="l00728"></a><span class="lineno">  728</span>&#160;        <span class="keyword">delete</span>[] heapBuffer.<a class="code" href="structHeapBuffer.html#afbaf206237e4898a306025676dce0987">buf</a>;</div>

  800. <div class="line"><a name="l00729"></a><span class="lineno">  729</span>&#160;        heapBuffer.<a class="code" href="structHeapBuffer.html#afbaf206237e4898a306025676dce0987">buf</a> = <span class="keyword">nullptr</span>;</div>

  801. <div class="line"><a name="l00730"></a><span class="lineno">  730</span>&#160;    }</div>

  802. <div class="line"><a name="l00731"></a><span class="lineno">  731</span>&#160;<span class="comment"></span> </div>

  803. <div class="line"><a name="l00732"></a><span class="lineno">  732</span>&#160;<span class="comment">    /** Create a buffer of the specified size. */</span></div>

  804. <div class="line"><a name="l00733"></a><span class="lineno"><a class="line" href="classHeapRingBuffer.html#ab7d60a3acc757e88e1c7254626ce9709">  733</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classHeapRingBuffer.html#ab7d60a3acc757e88e1c7254626ce9709">createBuffer</a>(<span class="keyword">const</span> uint32_t size) noexcept</div>

  805. <div class="line"><a name="l00734"></a><span class="lineno">  734</span>&#160;    {</div>

  806. <div class="line"><a name="l00735"></a><span class="lineno">  735</span>&#160;        DISTRHO_SAFE_ASSERT_RETURN(heapBuffer.<a class="code" href="structHeapBuffer.html#afbaf206237e4898a306025676dce0987">buf</a> == <span class="keyword">nullptr</span>, <span class="keyword">false</span>);</div>

  807. <div class="line"><a name="l00736"></a><span class="lineno">  736</span>&#160;        DISTRHO_SAFE_ASSERT_RETURN(size &gt; 0,  <span class="keyword">false</span>);</div>

  808. <div class="line"><a name="l00737"></a><span class="lineno">  737</span>&#160; </div>

  809. <div class="line"><a name="l00738"></a><span class="lineno">  738</span>&#160;        <span class="keyword">const</span> uint32_t p2size = <a class="code" href="group__MathFunctions.html#gaded8dbdc7ff99c70e7361b3f1a32b584">d_nextPowerOf2</a>(size);</div>

  810. <div class="line"><a name="l00739"></a><span class="lineno">  739</span>&#160; </div>

  811. <div class="line"><a name="l00740"></a><span class="lineno">  740</span>&#160;        <span class="keywordflow">try</span> {</div>

  812. <div class="line"><a name="l00741"></a><span class="lineno">  741</span>&#160;            heapBuffer.<a class="code" href="structHeapBuffer.html#afbaf206237e4898a306025676dce0987">buf</a> = <span class="keyword">new</span> uint8_t[p2size];</div>

  813. <div class="line"><a name="l00742"></a><span class="lineno">  742</span>&#160;        } DISTRHO_SAFE_EXCEPTION_RETURN(<span class="stringliteral">&quot;HeapRingBuffer::createBuffer&quot;</span>, <span class="keyword">false</span>);</div>

  814. <div class="line"><a name="l00743"></a><span class="lineno">  743</span>&#160; </div>

  815. <div class="line"><a name="l00744"></a><span class="lineno">  744</span>&#160;        heapBuffer.<a class="code" href="structHeapBuffer.html#a582e7b5aa4a85814f291d002abb49599">size</a> = p2size;</div>

  816. <div class="line"><a name="l00745"></a><span class="lineno">  745</span>&#160;        setRingBuffer(&amp;heapBuffer, <span class="keyword">true</span>);</div>

  817. <div class="line"><a name="l00746"></a><span class="lineno">  746</span>&#160;        <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>

  818. <div class="line"><a name="l00747"></a><span class="lineno">  747</span>&#160;    }</div>

  819. <div class="line"><a name="l00748"></a><span class="lineno">  748</span>&#160;<span class="comment"></span> </div>

  820. <div class="line"><a name="l00749"></a><span class="lineno">  749</span>&#160;<span class="comment">    /** Delete the previously allocated buffer. */</span></div>

  821. <div class="line"><a name="l00750"></a><span class="lineno"><a class="line" href="classHeapRingBuffer.html#a940bc4c023a53a0d511d6f99186d8224">  750</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classHeapRingBuffer.html#a940bc4c023a53a0d511d6f99186d8224">deleteBuffer</a>() noexcept</div>

  822. <div class="line"><a name="l00751"></a><span class="lineno">  751</span>&#160;    {</div>

  823. <div class="line"><a name="l00752"></a><span class="lineno">  752</span>&#160;        DISTRHO_SAFE_ASSERT_RETURN(heapBuffer.<a class="code" href="structHeapBuffer.html#afbaf206237e4898a306025676dce0987">buf</a> != <span class="keyword">nullptr</span>,);</div>

  824. <div class="line"><a name="l00753"></a><span class="lineno">  753</span>&#160; </div>

  825. <div class="line"><a name="l00754"></a><span class="lineno">  754</span>&#160;        setRingBuffer(<span class="keyword">nullptr</span>, <span class="keyword">false</span>);</div>

  826. <div class="line"><a name="l00755"></a><span class="lineno">  755</span>&#160; </div>

  827. <div class="line"><a name="l00756"></a><span class="lineno">  756</span>&#160;        <span class="keyword">delete</span>[] heapBuffer.<a class="code" href="structHeapBuffer.html#afbaf206237e4898a306025676dce0987">buf</a>;</div>

  828. <div class="line"><a name="l00757"></a><span class="lineno">  757</span>&#160;        heapBuffer.<a class="code" href="structHeapBuffer.html#afbaf206237e4898a306025676dce0987">buf</a>  = <span class="keyword">nullptr</span>;</div>

  829. <div class="line"><a name="l00758"></a><span class="lineno">  758</span>&#160;        heapBuffer.<a class="code" href="structHeapBuffer.html#a582e7b5aa4a85814f291d002abb49599">size</a> = 0;</div>

  830. <div class="line"><a name="l00759"></a><span class="lineno">  759</span>&#160;    }</div>

  831. <div class="line"><a name="l00760"></a><span class="lineno">  760</span>&#160; </div>

  832. <div class="line"><a name="l00761"></a><span class="lineno">  761</span>&#160;    <span class="keywordtype">void</span> copyFromAndClearOther(<a class="code" href="classHeapRingBuffer.html">HeapRingBuffer</a>&amp; other)</div>

  833. <div class="line"><a name="l00762"></a><span class="lineno">  762</span>&#160;    {</div>

  834. <div class="line"><a name="l00763"></a><span class="lineno">  763</span>&#160;        DISTRHO_SAFE_ASSERT_RETURN(other.heapBuffer.<a class="code" href="structHeapBuffer.html#a582e7b5aa4a85814f291d002abb49599">size</a> == heapBuffer.<a class="code" href="structHeapBuffer.html#a582e7b5aa4a85814f291d002abb49599">size</a>,);</div>

  835. <div class="line"><a name="l00764"></a><span class="lineno">  764</span>&#160; </div>

  836. <div class="line"><a name="l00765"></a><span class="lineno">  765</span>&#160;        std::memcpy(&amp;heapBuffer, &amp;other.heapBuffer, <span class="keyword">sizeof</span>(<a class="code" href="structHeapBuffer.html">HeapBuffer</a>) - <span class="keyword">sizeof</span>(uint8_t*));</div>

  837. <div class="line"><a name="l00766"></a><span class="lineno">  766</span>&#160;        std::memcpy(heapBuffer.<a class="code" href="structHeapBuffer.html#afbaf206237e4898a306025676dce0987">buf</a>, other.heapBuffer.<a class="code" href="structHeapBuffer.html#afbaf206237e4898a306025676dce0987">buf</a>, <span class="keyword">sizeof</span>(uint8_t) * heapBuffer.<a class="code" href="structHeapBuffer.html#a582e7b5aa4a85814f291d002abb49599">size</a>);</div>

  838. <div class="line"><a name="l00767"></a><span class="lineno">  767</span>&#160;        other.clearData();</div>

  839. <div class="line"><a name="l00768"></a><span class="lineno">  768</span>&#160;    }</div>

  840. <div class="line"><a name="l00769"></a><span class="lineno">  769</span>&#160; </div>

  841. <div class="line"><a name="l00770"></a><span class="lineno">  770</span>&#160;<span class="keyword">private</span>:<span class="comment"></span></div>

  842. <div class="line"><a name="l00771"></a><span class="lineno">  771</span>&#160;<span class="comment">    /** The heap buffer used for this class. */</span></div>

  843. <div class="line"><a name="l00772"></a><span class="lineno">  772</span>&#160;    <a class="code" href="structHeapBuffer.html">HeapBuffer</a> heapBuffer;</div>

  844. <div class="line"><a name="l00773"></a><span class="lineno">  773</span>&#160; </div>

  845. <div class="line"><a name="l00774"></a><span class="lineno">  774</span>&#160;    DISTRHO_PREVENT_VIRTUAL_HEAP_ALLOCATION</div>

  846. <div class="line"><a name="l00775"></a><span class="lineno">  775</span>&#160;    DISTRHO_DECLARE_NON_COPYABLE(<a class="code" href="classHeapRingBuffer.html">HeapRingBuffer</a>)</div>

  847. <div class="line"><a name="l00776"></a><span class="lineno">  776</span>&#160;};</div>

  848. <div class="line"><a name="l00777"></a><span class="lineno">  777</span>&#160; </div>

  849. <div class="line"><a name="l00778"></a><span class="lineno">  778</span>&#160;<span class="comment">// -----------------------------------------------------------------------</span></div>

  850. <div class="line"><a name="l00779"></a><span class="lineno">  779</span>&#160;<span class="comment">// RingBuffer using small stack space</span></div>

  851. <div class="line"><a name="l00780"></a><span class="lineno">  780</span>&#160;<span class="comment"></span> </div>

  852. <div class="line"><a name="l00781"></a><span class="lineno">  781</span>&#160;<span class="comment">/**</span></div>

  853. <div class="line"><a name="l00782"></a><span class="lineno">  782</span>&#160;<span class="comment">   RingBufferControl with an included small stack buffer.</span></div>

  854. <div class="line"><a name="l00783"></a><span class="lineno">  783</span>&#160;<span class="comment">   No setup is necessary, this class is usable as-is.</span></div>

  855. <div class="line"><a name="l00784"></a><span class="lineno">  784</span>&#160;<span class="comment">*/</span></div>

  856. <div class="line"><a name="l00785"></a><span class="lineno"><a class="line" href="classSmallStackRingBuffer.html">  785</a></span>&#160;<span class="keyword">class </span><a class="code" href="classSmallStackRingBuffer.html">SmallStackRingBuffer</a> : <span class="keyword">public</span> <a class="code" href="classRingBufferControl.html">RingBufferControl</a>&lt;SmallStackBuffer&gt;</div>

  857. <div class="line"><a name="l00786"></a><span class="lineno">  786</span>&#160;{</div>

  858. <div class="line"><a name="l00787"></a><span class="lineno">  787</span>&#160;<span class="keyword">public</span>:<span class="comment"></span></div>

  859. <div class="line"><a name="l00788"></a><span class="lineno">  788</span>&#160;<span class="comment">    /** Constructor. */</span></div>

  860. <div class="line"><a name="l00789"></a><span class="lineno"><a class="line" href="classSmallStackRingBuffer.html#aceb7e429507b28dd56e837f23b623987">  789</a></span>&#160;    <a class="code" href="classSmallStackRingBuffer.html#aceb7e429507b28dd56e837f23b623987">SmallStackRingBuffer</a>() noexcept</div>

  861. <div class="line"><a name="l00790"></a><span class="lineno">  790</span>&#160;        : stackBuffer(StackBuffer_INIT)</div>

  862. <div class="line"><a name="l00791"></a><span class="lineno">  791</span>&#160;    {</div>

  863. <div class="line"><a name="l00792"></a><span class="lineno">  792</span>&#160;<span class="preprocessor">#ifndef DISTRHO_PROPER_CPP11_SUPPORT</span></div>

  864. <div class="line"><a name="l00793"></a><span class="lineno">  793</span>&#160;        std::memset(&amp;stackBuffer, 0, <span class="keyword">sizeof</span>(stackBuffer));</div>

  865. <div class="line"><a name="l00794"></a><span class="lineno">  794</span>&#160;<span class="preprocessor">#endif</span></div>

  866. <div class="line"><a name="l00795"></a><span class="lineno">  795</span>&#160;        setRingBuffer(&amp;stackBuffer, <span class="keyword">true</span>);</div>

  867. <div class="line"><a name="l00796"></a><span class="lineno">  796</span>&#160;    }</div>

  868. <div class="line"><a name="l00797"></a><span class="lineno">  797</span>&#160; </div>

  869. <div class="line"><a name="l00798"></a><span class="lineno">  798</span>&#160;<span class="keyword">private</span>:<span class="comment"></span></div>

  870. <div class="line"><a name="l00799"></a><span class="lineno">  799</span>&#160;<span class="comment">    /** The small stack buffer used for this class. */</span></div>

  871. <div class="line"><a name="l00800"></a><span class="lineno">  800</span>&#160;    <a class="code" href="structSmallStackBuffer.html">SmallStackBuffer</a> stackBuffer;</div>

  872. <div class="line"><a name="l00801"></a><span class="lineno">  801</span>&#160; </div>

  873. <div class="line"><a name="l00802"></a><span class="lineno">  802</span>&#160;    DISTRHO_PREVENT_VIRTUAL_HEAP_ALLOCATION</div>

  874. <div class="line"><a name="l00803"></a><span class="lineno">  803</span>&#160;    DISTRHO_DECLARE_NON_COPYABLE(<a class="code" href="classSmallStackRingBuffer.html">SmallStackRingBuffer</a>)</div>

  875. <div class="line"><a name="l00804"></a><span class="lineno">  804</span>&#160;};</div>

  876. <div class="line"><a name="l00805"></a><span class="lineno">  805</span>&#160; </div>

  877. <div class="line"><a name="l00806"></a><span class="lineno">  806</span>&#160;<span class="comment">// -----------------------------------------------------------------------</span></div>

  878. <div class="line"><a name="l00807"></a><span class="lineno">  807</span>&#160; </div>

  879. <div class="line"><a name="l00808"></a><span class="lineno">  808</span>&#160;<a class="code" href="group__NamespaceMacros.html#ga3ff541a449593e069a29e92d21e38ef3">END_NAMESPACE_DISTRHO</a></div>

  880. <div class="line"><a name="l00809"></a><span class="lineno">  809</span>&#160; </div>

  881. <div class="line"><a name="l00810"></a><span class="lineno">  810</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// DISTRHO_RING_BUFFER_HPP_INCLUDED</span></div>

  882. <div class="ttc" id="aclassHeapRingBuffer_html"><div class="ttname"><a href="classHeapRingBuffer.html">HeapRingBuffer</a></div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:711</div></div>

  883. <div class="ttc" id="aclassHeapRingBuffer_html_a6a3c03b584b5b20ad2829e26f5e6ed0e"><div class="ttname"><a href="classHeapRingBuffer.html#a6a3c03b584b5b20ad2829e26f5e6ed0e">HeapRingBuffer::HeapRingBuffer</a></div><div class="ttdeci">HeapRingBuffer() noexcept</div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:714</div></div>

  884. <div class="ttc" id="aclassHeapRingBuffer_html_a940bc4c023a53a0d511d6f99186d8224"><div class="ttname"><a href="classHeapRingBuffer.html#a940bc4c023a53a0d511d6f99186d8224">HeapRingBuffer::deleteBuffer</a></div><div class="ttdeci">void deleteBuffer() noexcept</div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:750</div></div>

  885. <div class="ttc" id="aclassHeapRingBuffer_html_ab7d60a3acc757e88e1c7254626ce9709"><div class="ttname"><a href="classHeapRingBuffer.html#ab7d60a3acc757e88e1c7254626ce9709">HeapRingBuffer::createBuffer</a></div><div class="ttdeci">bool createBuffer(const uint32_t size) noexcept</div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:733</div></div>

  886. <div class="ttc" id="aclassHeapRingBuffer_html_ae2e25c610073d35998efd7106b5eb8a0"><div class="ttname"><a href="classHeapRingBuffer.html#ae2e25c610073d35998efd7106b5eb8a0">HeapRingBuffer::~HeapRingBuffer</a></div><div class="ttdeci">~HeapRingBuffer() noexcept override</div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:723</div></div>

  887. <div class="ttc" id="aclassRingBufferControl_html"><div class="ttname"><a href="classRingBufferControl.html">RingBufferControl</a></div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:168</div></div>

  888. <div class="ttc" id="aclassRingBufferControl_html_a3e9c1857e11f0d9efcc2944d6000504b"><div class="ttname"><a href="classRingBufferControl.html#a3e9c1857e11f0d9efcc2944d6000504b">RingBufferControl::writeCustomType</a></div><div class="ttdeci">bool writeCustomType(const T &amp;type) noexcept</div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:507</div></div>

  889. <div class="ttc" id="aclassRingBufferControl_html_a72e173dcae573f6e2e8ac4cfeb8aa96b"><div class="ttname"><a href="classRingBufferControl.html#a72e173dcae573f6e2e8ac4cfeb8aa96b">RingBufferControl::writeCustomData</a></div><div class="ttdeci">bool writeCustomData(const void *const data, const uint32_t size) noexcept</div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:494</div></div>

  890. <div class="ttc" id="aclassRingBufferControl_html_aaaf4efe13ec2555c390047f545d2660d"><div class="ttname"><a href="classRingBufferControl.html#aaaf4efe13ec2555c390047f545d2660d">RingBufferControl::readCustomType</a></div><div class="ttdeci">bool readCustomType(T &amp;type) noexcept</div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:398</div></div>

  891. <div class="ttc" id="aclassRingBufferControl_html_aafdb126b2885c507cec852bc63fd6cb8"><div class="ttname"><a href="classRingBufferControl.html#aafdb126b2885c507cec852bc63fd6cb8">RingBufferControl::readCustomData</a></div><div class="ttdeci">bool readCustomData(void *const data, const uint32_t size) noexcept</div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:378</div></div>

  892. <div class="ttc" id="aclassRingBufferControl_html_afe0c53d2591eb265d657c1cab6800036"><div class="ttname"><a href="classRingBufferControl.html#afe0c53d2591eb265d657c1cab6800036">RingBufferControl::commitWrite</a></div><div class="ttdeci">bool commitWrite() noexcept</div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:518</div></div>

  893. <div class="ttc" id="aclassSmallStackRingBuffer_html"><div class="ttname"><a href="classSmallStackRingBuffer.html">SmallStackRingBuffer</a></div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:786</div></div>

  894. <div class="ttc" id="aclassSmallStackRingBuffer_html_aceb7e429507b28dd56e837f23b623987"><div class="ttname"><a href="classSmallStackRingBuffer.html#aceb7e429507b28dd56e837f23b623987">SmallStackRingBuffer::SmallStackRingBuffer</a></div><div class="ttdeci">SmallStackRingBuffer() noexcept</div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:789</div></div>

  895. <div class="ttc" id="agroup__MathFunctions_html_gaded8dbdc7ff99c70e7361b3f1a32b584"><div class="ttname"><a href="group__MathFunctions.html#gaded8dbdc7ff99c70e7361b3f1a32b584">d_nextPowerOf2</a></div><div class="ttdeci">static uint32_t d_nextPowerOf2(uint32_t size) noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoUtils.hpp:308</div></div>

  896. <div class="ttc" id="agroup__NamespaceMacros_html_ga3ff541a449593e069a29e92d21e38ef3"><div class="ttname"><a href="group__NamespaceMacros.html#ga3ff541a449593e069a29e92d21e38ef3">END_NAMESPACE_DISTRHO</a></div><div class="ttdeci">#define END_NAMESPACE_DISTRHO</div><div class="ttdef"><b>Definition:</b> DistrhoInfo.hpp:949</div></div>

  897. <div class="ttc" id="agroup__NamespaceMacros_html_gac4cb97c393d20c28ba19365d844341cd"><div class="ttname"><a href="group__NamespaceMacros.html#gac4cb97c393d20c28ba19365d844341cd">START_NAMESPACE_DISTRHO</a></div><div class="ttdeci">#define START_NAMESPACE_DISTRHO</div><div class="ttdef"><b>Definition:</b> DistrhoInfo.hpp:943</div></div>

  898. <div class="ttc" id="agroup__StringPrintFunctions_html_ga9861b6a26e43554680f50623196dde7b"><div class="ttname"><a href="group__StringPrintFunctions.html#ga9861b6a26e43554680f50623196dde7b">d_stderr2</a></div><div class="ttdeci">static void d_stderr2(const char *const fmt,...) noexcept</div><div class="ttdef"><b>Definition:</b> DistrhoUtils.hpp:171</div></div>

  899. <div class="ttc" id="astructBigStackBuffer_html"><div class="ttname"><a href="structBigStackBuffer.html">BigStackBuffer</a></div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:104</div></div>

  900. <div class="ttc" id="astructHeapBuffer_html"><div class="ttname"><a href="structHeapBuffer.html">HeapBuffer</a></div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:49</div></div>

  901. <div class="ttc" id="astructHeapBuffer_html_a0cd85f596b680b57cc6669de7cf7ed27"><div class="ttname"><a href="structHeapBuffer.html#a0cd85f596b680b57cc6669de7cf7ed27">HeapBuffer::invalidateCommit</a></div><div class="ttdeci">bool invalidateCommit</div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:80</div></div>

  902. <div class="ttc" id="astructHeapBuffer_html_a4d330b5567a46f6b6972f5174b262292"><div class="ttname"><a href="structHeapBuffer.html#a4d330b5567a46f6b6972f5174b262292">HeapBuffer::wrtn</a></div><div class="ttdeci">uint32_t wrtn</div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:74</div></div>

  903. <div class="ttc" id="astructHeapBuffer_html_a55b0dceb6b878021d8fe1353096e757b"><div class="ttname"><a href="structHeapBuffer.html#a55b0dceb6b878021d8fe1353096e757b">HeapBuffer::head</a></div><div class="ttdeci">uint32_t head</div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:60</div></div>

  904. <div class="ttc" id="astructHeapBuffer_html_a582e7b5aa4a85814f291d002abb49599"><div class="ttname"><a href="structHeapBuffer.html#a582e7b5aa4a85814f291d002abb49599">HeapBuffer::size</a></div><div class="ttdeci">uint32_t size</div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:54</div></div>

  905. <div class="ttc" id="astructHeapBuffer_html_abd05cbae44531a412352ed52c8a50aec"><div class="ttname"><a href="structHeapBuffer.html#abd05cbae44531a412352ed52c8a50aec">HeapBuffer::tail</a></div><div class="ttdeci">uint32_t tail</div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:67</div></div>

  906. <div class="ttc" id="astructHeapBuffer_html_afbaf206237e4898a306025676dce0987"><div class="ttname"><a href="structHeapBuffer.html#afbaf206237e4898a306025676dce0987">HeapBuffer::buf</a></div><div class="ttdeci">uint8_t * buf</div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:86</div></div>

  907. <div class="ttc" id="astructHugeStackBuffer_html"><div class="ttname"><a href="structHugeStackBuffer.html">HugeStackBuffer</a></div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:115</div></div>

  908. <div class="ttc" id="astructSmallStackBuffer_html"><div class="ttname"><a href="structSmallStackBuffer.html">SmallStackBuffer</a></div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:93</div></div>

  909. </div><!-- fragment --></div><!-- contents -->

  910. <!-- start footer part -->

  911. <hr class="footer"/><address class="footer"><small>

  912. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1

  913. </small></address>

  914. </body>

  915. </html>