134 lines
22 KiB
HTML
134 lines
22 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
|
<title>Arduino MIDI Library: /Users/franky/dev/git/arduino_midi_library/src/midi_RingBuffer.hpp Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Arduino MIDI Library
|
|
 <span id="projectnumber">Version 4.3</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li><a href="examples.html"><span>Examples</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('a00031_source.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">midi_RingBuffer.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="a00031.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <a class="code" href="a00029.html#adf6b690441eb0a31c4abd3bc4fb99673">BEGIN_MIDI_NAMESPACE</a></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">template</span><<span class="keyword">typename</span> DataType, <span class="keywordtype">int</span> Size></div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="a00018.html#a936bb7222ba5a8bc0eb44eeb7cf73526"> 34</a></span> <a class="code" href="a00018.html#a936bb7222ba5a8bc0eb44eeb7cf73526">RingBuffer<DataType, Size>::RingBuffer</a>()</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  : mWriteHead(mData)</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  , mReadHead(mData)</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  memset(mData, DataType(0), Size * <span class="keyword">sizeof</span>(DataType));</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> }</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">template</span><<span class="keyword">typename</span> DataType, <span class="keywordtype">int</span> Size></div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="a00018.html#a17bea25e902a63200fda2fdcc9623a8f"> 42</a></span> <a class="code" href="a00018.html#a17bea25e902a63200fda2fdcc9623a8f">RingBuffer<DataType, Size>::~RingBuffer</a>()</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> {</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> }</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">// -----------------------------------------------------------------------------</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">template</span><<span class="keyword">typename</span> DataType, <span class="keywordtype">int</span> Size></div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="a00018.html#a0b1b3ca5f78a359c282dd4c80f14e70e"> 49</a></span> <span class="keywordtype">int</span> <a class="code" href="a00018.html#a0b1b3ca5f78a359c282dd4c80f14e70e">RingBuffer<DataType, Size>::getLength</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword"></span>{</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordflow">if</span> (mReadHead == mWriteHead)</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  {</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">return</span> 0;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  }</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordflow">else</span> <span class="keywordflow">if</span> (mWriteHead > mReadHead)</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  {</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordflow">return</span> int(mWriteHead - mReadHead);</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  }</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  {</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordflow">return</span> int(mWriteHead - mData) + Size - int(mReadHead - mData);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  }</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> }</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">template</span><<span class="keyword">typename</span> DataType, <span class="keywordtype">int</span> Size></div><div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="a00018.html#adbe20267bdb2e0119e2c70a439582e6b"> 66</a></span> <span class="keywordtype">bool</span> <a class="code" href="a00018.html#adbe20267bdb2e0119e2c70a439582e6b">RingBuffer<DataType, Size>::isEmpty</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keyword"></span>{</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordflow">return</span> mReadHead == mWriteHead;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> }</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">// -----------------------------------------------------------------------------</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keyword">template</span><<span class="keyword">typename</span> DataType, <span class="keywordtype">int</span> Size></div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="a00018.html#a1de8ffd41505b8d915f4c850d7c76b6f"> 74</a></span> <span class="keywordtype">void</span> <a class="code" href="a00018.html#a1de8ffd41505b8d915f4c850d7c76b6f">RingBuffer<DataType, Size>::write</a>(DataType inData)</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> {</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  *mWriteHead++ = inData;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordflow">if</span> (mWriteHead >= mData + Size)</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  {</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  mWriteHead = mData;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  }</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> }</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="keyword">template</span><<span class="keyword">typename</span> DataType, <span class="keywordtype">int</span> Size></div><div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="a00018.html#aaefc2cdb26ae1ca740cdda9257a52c0d"> 84</a></span> <span class="keywordtype">void</span> <a class="code" href="a00018.html#a1de8ffd41505b8d915f4c850d7c76b6f">RingBuffer<DataType, Size>::write</a>(<span class="keyword">const</span> DataType* inData, <span class="keywordtype">int</span> inSize)</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> {</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < inSize; ++i)</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  {</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="a00018.html#a1de8ffd41505b8d915f4c850d7c76b6f">write</a>(inData[i]);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  }</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> }</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="keyword">template</span><<span class="keyword">typename</span> DataType, <span class="keywordtype">int</span> Size></div><div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="a00018.html#a88d68cb12b382c21d35fd419d0feed1b"> 93</a></span> <span class="keywordtype">void</span> <a class="code" href="a00018.html#a88d68cb12b382c21d35fd419d0feed1b">RingBuffer<DataType, Size>::clear</a>()</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> {</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  memset(mData, DataType(0), Size * <span class="keyword">sizeof</span>(DataType));</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  mReadHead = mData;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  mWriteHead = mData;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> }</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment">// -----------------------------------------------------------------------------</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="keyword">template</span><<span class="keyword">typename</span> DataType, <span class="keywordtype">int</span> Size></div><div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="a00018.html#a9f6ccc4d0e05b60f223c8b7a8b88c76d"> 103</a></span> DataType <a class="code" href="a00018.html#a9f6ccc4d0e05b60f223c8b7a8b88c76d">RingBuffer<DataType, Size>::read</a>()</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> {</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">const</span> DataType data = *mReadHead++;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordflow">if</span> (mReadHead >= mData + Size)</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  {</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  mReadHead = mData;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  }</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordflow">return</span> data;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> }</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="keyword">template</span><<span class="keyword">typename</span> DataType, <span class="keywordtype">int</span> Size></div><div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="a00018.html#a45a44b6d35dd92cc37ddfb2f9888e4f4"> 114</a></span> <span class="keywordtype">void</span> <a class="code" href="a00018.html#a9f6ccc4d0e05b60f223c8b7a8b88c76d">RingBuffer<DataType, Size>::read</a>(DataType* outData, <span class="keywordtype">int</span> inSize)</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> {</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < inSize; ++i)</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  {</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  outData[i] = <a class="code" href="a00018.html#a9f6ccc4d0e05b60f223c8b7a8b88c76d">read</a>();</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  }</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> }</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <a class="code" href="a00029.html#abf831eff386c2ded4d253fb11321028e">END_MIDI_NAMESPACE</a></div><div class="ttc" id="a00029_html_abf831eff386c2ded4d253fb11321028e"><div class="ttname"><a href="a00029.html#abf831eff386c2ded4d253fb11321028e">END_MIDI_NAMESPACE</a></div><div class="ttdeci">#define END_MIDI_NAMESPACE</div><div class="ttdef"><b>Definition:</b> <a href="a00029_source.html#l00033">midi_Namespace.h:33</a></div></div>
|
|
<div class="ttc" id="a00018_html_adbe20267bdb2e0119e2c70a439582e6b"><div class="ttname"><a href="a00018.html#adbe20267bdb2e0119e2c70a439582e6b">RingBuffer::isEmpty</a></div><div class="ttdeci">bool isEmpty() const </div><div class="ttdef"><b>Definition:</b> <a href="a00031_source.html#l00066">midi_RingBuffer.hpp:66</a></div></div>
|
|
<div class="ttc" id="a00018_html_a88d68cb12b382c21d35fd419d0feed1b"><div class="ttname"><a href="a00018.html#a88d68cb12b382c21d35fd419d0feed1b">RingBuffer::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdef"><b>Definition:</b> <a href="a00031_source.html#l00093">midi_RingBuffer.hpp:93</a></div></div>
|
|
<div class="ttc" id="a00029_html_adf6b690441eb0a31c4abd3bc4fb99673"><div class="ttname"><a href="a00029.html#adf6b690441eb0a31c4abd3bc4fb99673">BEGIN_MIDI_NAMESPACE</a></div><div class="ttdeci">#define BEGIN_MIDI_NAMESPACE</div><div class="ttdef"><b>Definition:</b> <a href="a00029_source.html#l00032">midi_Namespace.h:32</a></div></div>
|
|
<div class="ttc" id="a00018_html_a9f6ccc4d0e05b60f223c8b7a8b88c76d"><div class="ttname"><a href="a00018.html#a9f6ccc4d0e05b60f223c8b7a8b88c76d">RingBuffer::read</a></div><div class="ttdeci">DataType read()</div><div class="ttdef"><b>Definition:</b> <a href="a00031_source.html#l00103">midi_RingBuffer.hpp:103</a></div></div>
|
|
<div class="ttc" id="a00018_html_a1de8ffd41505b8d915f4c850d7c76b6f"><div class="ttname"><a href="a00018.html#a1de8ffd41505b8d915f4c850d7c76b6f">RingBuffer::write</a></div><div class="ttdeci">void write(DataType inData)</div><div class="ttdef"><b>Definition:</b> <a href="a00031_source.html#l00074">midi_RingBuffer.hpp:74</a></div></div>
|
|
<div class="ttc" id="a00018_html_a17bea25e902a63200fda2fdcc9623a8f"><div class="ttname"><a href="a00018.html#a17bea25e902a63200fda2fdcc9623a8f">RingBuffer::~RingBuffer</a></div><div class="ttdeci">~RingBuffer()</div><div class="ttdef"><b>Definition:</b> <a href="a00031_source.html#l00042">midi_RingBuffer.hpp:42</a></div></div>
|
|
<div class="ttc" id="a00018_html_a936bb7222ba5a8bc0eb44eeb7cf73526"><div class="ttname"><a href="a00018.html#a936bb7222ba5a8bc0eb44eeb7cf73526">RingBuffer::RingBuffer</a></div><div class="ttdeci">RingBuffer()</div><div class="ttdef"><b>Definition:</b> <a href="a00031_source.html#l00034">midi_RingBuffer.hpp:34</a></div></div>
|
|
<div class="ttc" id="a00018_html_a0b1b3ca5f78a359c282dd4c80f14e70e"><div class="ttname"><a href="a00018.html#a0b1b3ca5f78a359c282dd4c80f14e70e">RingBuffer::getLength</a></div><div class="ttdeci">int getLength() const </div><div class="ttdef"><b>Definition:</b> <a href="a00031_source.html#l00049">midi_RingBuffer.hpp:49</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_645b81139e363ce037e25dbaed8c5263.html">franky</a></li><li class="navelem"><a class="el" href="dir_24ed65e94774636179756562244c7302.html">dev</a></li><li class="navelem"><a class="el" href="dir_8e174b5f2a67f3e976f171aae2086cba.html">git</a></li><li class="navelem"><a class="el" href="dir_09481f2e998cf47f01eea124dd549c96.html">arduino_midi_library</a></li><li class="navelem"><a class="el" href="dir_4f69b3b5f50f765bf848b47dadc3c85f.html">src</a></li><li class="navelem"><a class="el" href="a00031.html">midi_RingBuffer.hpp</a></li>
|
|
<li class="footer">Generated on Wed Nov 2 2016 19:56:40 for Arduino MIDI Library by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|