doxygen

Author: pschatzmann

README.md

@@ -16,6 +16,8 @@ The API provides the decoded data to a Arduino Stream or alternatively to a call
 #include "MP3DecoderHelix.h"
 #include "music_mp3.h"
 
+using namespace libhelix;
+
 void dataCallback(MP3FrameInfo &info, int16_t *pwm_buffer, size_t len) {
     for (int i=0; i<len; i+=info.channels){
         for (int j=0;j<info.channels;j++){

docs/html/_common_helix_8h_source.html

@@ -66,10 +66,11 @@
 </div><!--header-->
 <div class="contents">
 <div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
-<table class="directory">
-<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_common_helix.html" target="_self">CommonHelix</a></td><td class="desc">Common Simple Arduino API </td></tr>
-<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_m_p3_decoder_helix.html" target="_self">MP3DecoderHelix</a></td><td class="desc">A simple Arduino API for the libhelix MP3 decoder. The data is provided with the help of <a class="el" href="class_common_helix.html#a2b1f8e8f34ba7701ed1de0bffbcb62f8" title="decodes the next segments from the intput. The data can be provided in one short or in small incremen...">write()</a> calls. The decoded result is available either via a callback method or via an output stream </td></tr>
-<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_range.html" target="_self">Range</a></td><td class="desc"><a class="el" href="struct_range.html" title="Range with a start and an end.">Range</a> with a start and an end </td></tr>
+<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
+<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>libhelix</b></td><td class="desc"></td></tr>
+<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structlibhelix_1_1_range.html" target="_self">Range</a></td><td class="desc"><a class="el" href="structlibhelix_1_1_range.html" title="Range with a start and an end.">Range</a> with a start and an end </td></tr>
+<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibhelix_1_1_common_helix.html" target="_self">CommonHelix</a></td><td class="desc">Common Simple Arduino API </td></tr>
+<tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibhelix_1_1_m_p3_decoder_helix.html" target="_self">MP3DecoderHelix</a></td><td class="desc">A simple Arduino API for the libhelix MP3 decoder. The data is provided with the help of <a class="el" href="classlibhelix_1_1_common_helix.html#a819f83e0c2bdcac195c2170c205bd0f3" title="decodes the next segments from the intput. The data can be provided in one short or in small incremen...">write()</a> calls. The decoded result is available either via a callback method or via an output stream </td></tr>
 </table>
 </div><!-- directory -->
 </div><!-- contents -->

docs/html/_m_p3_decoder_helix_8h_source.html

@@ -69,13 +69,13 @@
 <div class="classindex">
 <dl class="classindex even">
 <dt class="alphachar"><a name="letter_C">C</a></dt>
-<dd><a class="el" href="class_common_helix.html">CommonHelix</a></dd></dl>
+<dd><a class="el" href="classlibhelix_1_1_common_helix.html">CommonHelix</a> (libhelix)</dd></dl>
 <dl class="classindex odd">
 <dt class="alphachar"><a name="letter_M">M</a></dt>
-<dd><a class="el" href="class_m_p3_decoder_helix.html">MP3DecoderHelix</a></dd></dl>
+<dd><a class="el" href="classlibhelix_1_1_m_p3_decoder_helix.html">MP3DecoderHelix</a> (libhelix)</dd></dl>
 <dl class="classindex even">
 <dt class="alphachar"><a name="letter_R">R</a></dt>
-<dd><a class="el" href="struct_range.html">Range</a></dd></dl>
+<dd><a class="el" href="structlibhelix_1_1_range.html">Range</a> (libhelix)</dd></dl>
 </div>
 </div><!-- contents -->
 <!-- start footer part -->

docs/html/annotated.html

@@ -0,0 +1,107 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen 1.9.1"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>Arduino LibHelix: Member List</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+  <td id="projectalign" style="padding-left: 0.5em;">
+   <div id="projectname">Arduino LibHelix
+   </div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.9.1 -->
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
+/* @license-end */
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+$(function() {
+  initMenu('',true,false,'search.php','Search');
+  $(document).ready(function() { init_search(); });
+});
+/* @license-end */</script>
+<div id="main-nav"></div>
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div id="nav-path" class="navpath">
+  <ul>
+<li class="navelem"><b>libhelix</b></li><li class="navelem"><a class="el" href="classlibhelix_1_1_common_helix.html">CommonHelix</a></li>  </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+  <div class="headertitle">
+<div class="title">libhelix::CommonHelix Member List</div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p>This is the complete list of members for <a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a>, including all inherited members.</p>
+<table class="directory">
+  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>active</b> (defined in <a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a>)</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
+  <tr bgcolor="#f0f0f0"><td class="entry"><b>advanceFrameBuffer</b>(int offset) (defined in <a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a>)</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html#a0ffba0347a7739d3c8bd3fd270116525">appendToBuffer</a>(const void *in_ptr, int in_size)</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html#a6b79eddc0f1722010061b3e78dddf444">begin</a>()</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
+  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>buffer_size</b> (defined in <a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a>)</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
+  <tr bgcolor="#f0f0f0"><td class="entry"><b>checkMemory</b>() (defined in <a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a>)</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html#a3871a1bae07be7364d01a8a67271ada0">decode</a>(Range r)=0</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html#a60813d990b6b255e4e95fe797a36540a">end</a>()</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html#a4196bcaf7e85ad7807dea0c671a7647b">findSynchWord</a>(int offset=0)=0</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></td></tr>
+  <tr bgcolor="#f0f0f0"><td class="entry"><b>frame_buffer</b> (defined in <a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a>)</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
+  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>frame_counter</b> (defined in <a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a>)</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html#a40e201771b274b3033b30cec2661d025">frameRange</a>()</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
+  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>in</b> (defined in <a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a>)</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
+  <tr bgcolor="#f0f0f0"><td class="entry"><b>max_frame_size</b> (defined in <a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a>)</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
+  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>max_pwm_size</b> (defined in <a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a>)</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html#a5b0fff8a3e335fe2ae5d7e2ed744cc15">maxFrameSize</a>()=0</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html#af2ad233fe8e092b474676b77f1bffd2a">maxPWMSize</a>()=0</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html#ac9a86287193583640835f7772a047f97">operator bool</a>()</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>out</b> (defined in <a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a>)</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
+  <tr bgcolor="#f0f0f0"><td class="entry"><b>pwm_buffer</b> (defined in <a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a>)</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html#a28a81c90298d1dbc107b2b799ce3fed2">setMaxFrameSize</a>(size_t len)</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html#a822ababebd5f0d6ffe29e1c43b722772">setMaxPWMSize</a>(size_t len)</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html#a33ae215e20b7ece5cadf1a0b7098aff9">synchronizeFrame</a>()</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html#a819f83e0c2bdcac195c2170c205bd0f3">write</a>(const void *in_ptr, size_t in_size)</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html#a2670e75b01b9f43010b31f571112203c">writeFrame</a>(const void *in_ptr, size_t in_size)</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
+  <tr bgcolor="#f0f0f0"><td class="entry"><b>~CommonHelix</b>() (defined in <a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a>)</td><td class="entry"><a class="el" href="classlibhelix_1_1_common_helix.html">libhelix::CommonHelix</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+</table></div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+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
+</small></address>
+</body>
+</html>