ringbuf-doc.html

<!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 &mdash; 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="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Server Real-Time Interface" href="sri-doc.html" />
    <link rel="prev" title="Welcome to LuckyLoop’s documentation!" href="index.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">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Ringbuffer</a></li>
<li class="toctree-l1"><a class="reference internal" href="sri-doc.html">Server Real-Time Interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="client-doc.html">LuckyClient</a></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> &raquo;</li>
        
      <li>Ringbuffer</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="_sources/ringbuf-doc.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="macro">
<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>
<a class="reference internal" href="#_CPPv47ringbuf" title="ringbuf">ringbuf</a> *<code class="sig-name descname">ringbuf_new</code><span class="sig-paren">(</span>int <em>buffersize</em><span class="sig-paren">)</span><br /></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><a class="reference internal" href="#_CPPv47ringbuf" title="ringbuf">ringbuf</a> *<em>ringbuffer</em><span class="sig-paren">)</span><br /></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><a class="reference internal" href="#_CPPv47ringbuf" title="ringbuf">ringbuf</a> *<em>ringbuffer</em>, double <em>sample</em><span class="sig-paren">)</span><br /></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><a class="reference internal" href="#_CPPv47ringbuf" title="ringbuf">ringbuf</a> *<em>ringbuffer</em>, int <em>chunklen</em>, double *<em>chunk</em><span class="sig-paren">)</span><br /></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><a class="reference internal" href="#_CPPv47ringbuf" title="ringbuf">ringbuf</a> *<em>ringbuffer</em><span class="sig-paren">)</span><br /></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><a class="reference internal" href="#_CPPv47ringbuf" title="ringbuf">ringbuf</a> *<em>ringbuffer</em>, int <em>position</em><span class="sig-paren">)</span><br /></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="class">
<dt>
<em class="property">struct </em><code class="sig-name descname">ringbuf</code><br /></dt>
<dd><em>#include &lt;ringbuf.h&gt;</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="member">
<dt>
double *<code class="sig-name descname">buffer</code><br /></dt>
<dd><p>the dynamically allocated buffer array </p>
</dd></dl>

<dl class="member">
<dt>
int <code class="sig-name descname">buffersize</code><br /></dt>
<dd><p>the size of the buffer in samples </p>
</dd></dl>

<dl class="member">
<dt>
int <code class="sig-name descname">head</code><br /></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-doc.html" class="btn btn-neutral float-right" title="Server Real-Time Interface" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="index.html" class="btn btn-neutral float-left" title="Welcome to LuckyLoop’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; 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>