-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathringbuf.html
More file actions
339 lines (216 loc) · 11 KB
/
ringbuf.html
File metadata and controls
339 lines (216 loc) · 11 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Ringbuffer — LuckyLoop 0.1.0 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="libsri.so" href="sri.html" />
<link rel="prev" title="Architecture" href="architecture.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> LuckyLoop
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">LuckyClient:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">LuckyClient</a></li>
</ul>
<p class="caption"><span class="caption-text">LuckyLoop:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="architecture.html">Architecture</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="architecture.html#elements">Elements</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Ringbuffer</a></li>
<li class="toctree-l2"><a class="reference internal" href="sri.html">libsri.so</a></li>
<li class="toctree-l2"><a class="reference internal" href="server.html">LuckyServer</a></li>
<li class="toctree-l2"><a class="reference internal" href="goertzel.html">Goertzel</a></li>
<li class="toctree-l2"><a class="reference internal" href="client.html">LuckyClient</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">LuckyLoop</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li><a href="architecture.html">Architecture</a> »</li>
<li>Ringbuffer</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/ringbuf.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="ringbuffer">
<h1>Ringbuffer<a class="headerlink" href="#ringbuffer" title="Permalink to this headline">¶</a></h1>
<p>Implements a ringbuffer to maintain past samples in memory for real-time DSP</p>
<p>One of the main goals of the LuckyLoop real-time-process is to calculate phase and power of a specific frequency for a specific channel. To calculate phase and power, we need more than a current sample. To achieve this, data is collected by one of EtherCat slave devices and continually read in the EtherCat main process into a ringbuffer. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Defines</p>
<dl class="define">
<dt>
<code class="sig-name descname">BUFFERSIZE</code></dt>
<dd><p>a sensible default for the buffersize (512) </p>
</dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Functions</p>
<dl class="function">
<dt>
ringbuf* <code class="sig-name descname">ringbuf_new</code><span class="sig-paren">(</span>int<em> buffersize</em><span class="sig-paren">)</span></dt>
<dd><p>creates a new buffer, returns a pointer to it <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>a new ringbuf </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">buffersize</span></code>: the size of the ringbuf in samples </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<dt>
void <code class="sig-name descname">ringbuf_destroy</code><span class="sig-paren">(</span>ringbuf *<em> ringbuffer</em><span class="sig-paren">)</span></dt>
<dd><p>destroy a ringbuf and free the allocated memory <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">ringbuffer</span></code>: the ringbuf to be destroyed </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<dt>
int <code class="sig-name descname">write_to_buffer</code><span class="sig-paren">(</span>ringbuf *<em> ringbuffer</em>, double<em> sample</em><span class="sig-paren">)</span></dt>
<dd><p>writes a new sample into the ringbuff <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">ringbuffer</span></code>: the ringbuffer to be written into </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sample</span></code>: a double value written into the the head of the buffer </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<dt>
int <code class="sig-name descname">write_array_to_buffer</code><span class="sig-paren">(</span>ringbuf *<em> ringbuffer</em>, int<em> chunklen</em>, double *<em> chunk</em><span class="sig-paren">)</span></dt>
<dd><p>write an array of samples into the ringbuf <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>int will return 2 if the array is larger than the buffersize, suggesting an overflow </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">chunk</span></code>: the array of samples to write into the buffer </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">chunklen</span></code>: the size of the array in samples </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ringbuffer</span></code>: the ringbuffer to be written into The last value in the array will be the newest in the ringbuffer </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<dt>
void <code class="sig-name descname">print_rbuf</code><span class="sig-paren">(</span>ringbuf *<em> ringbuffer</em><span class="sig-paren">)</span></dt>
<dd><p>print the whole buffer in circular fashion starting at the current head <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">ringbuffer</span></code>: the ringbuffer to print </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<dt>
double <code class="sig-name descname">read_ringbuf_pos</code><span class="sig-paren">(</span>ringbuf *<em> ringbuffer</em>, int<em> position</em><span class="sig-paren">)</span></dt>
<dd><p>return a sample relative to the current head <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">ringbuffer</span></code>: the ringbuffer to read from </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">position</span></code>: int the newest value is at 0, the oldest at buffersize-1 </p></li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
</div>
<dl class="struct">
<dt>
<em class="property">struct </em><code class="sig-name descname">ringbuf</code></dt>
<dd><em>#include <ringbuf.h></em><p>A structure to represent a ringbuffer </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Members</p>
<dl class="variable">
<dt>
double* <code class="sig-name descname">buffer</code></dt>
<dd><p>the dynamically allocated buffer array </p>
</dd></dl>
<dl class="variable">
<dt>
int <code class="sig-name descname">buffersize</code></dt>
<dd><p>the size of the buffer in samples </p>
</dd></dl>
<dl class="variable">
<dt>
int <code class="sig-name descname">head</code></dt>
<dd><p>the current position of the buffer </p>
</dd></dl>
</div>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="sri.html" class="btn btn-neutral float-right" title="libsri.so" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="architecture.html" class="btn btn-neutral float-left" title="Architecture" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2020, Translational Neurosurgery
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>