Skip to content

Commit 73b636b

Browse files
pschatzmannpschatzmann
committed
Doxygen
1 parent 5687880 commit 73b636b

File tree

129 files changed

+10866
-5
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

129 files changed

+10866
-5
lines changed

‎Doxyfile‎

Lines changed: 2658 additions & 0 deletions
Large diffs are not rendered by default.

‎README.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Arduino MIDI File Parser
2+
3+
A simple MIDI File Parser which is based on the [Midi Parser from Alexandre Bique](https://github.com/abique/midi-parser).
4+
5+
The original library has been converted to a Header Only C++ Library. Unlike the original implementation, we can feed the parser incrementally with data. This is important if you want to use it on a microcontroller that has only a limited amount of RAM.
6+
7+
It can be used as __Arduino or as cmake library__, so you can also compile, run and debug it on a desktop computer.
8+
9+
10+
11+

‎docs/html/MidiFileCommon_8h_source.html‎

Lines changed: 182 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/html/MidiFile_8h.html‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
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>Arduino MIDI File Parser: src/MidiFile.h File Reference</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">Arduino MIDI File Parser
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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
65+
</div>
66+
</div><!-- top -->
67+
<div class="header">
68+
<div class="summary">
69+
<a href="#nested-classes">Classes</a> &#124;
70+
<a href="#define-members">Macros</a> </div>
71+
<div class="headertitle">
72+
<div class="title">MidiFile.h File Reference</div> </div>
73+
</div><!--header-->
74+
<div class="contents">
75+
76+
<p>A simple midi parser based on the following project <a href="https://github.com/abique/midi-parser">https://github.com/abique/midi-parser</a>.
77+
<a href="#details">More...</a></p>
78+
<div class="textblock"><code>#include &lt;math.h&gt;</code><br />
79+
<code>#include &lt;stdio.h&gt;</code><br />
80+
<code>#include &lt;string.h&gt;</code><br />
81+
<code>#include &quot;MidiFileCommon.h&quot;</code><br />
82+
</div><div class="textblock"><div class="dynheader">
83+
Include dependency graph for MidiFile.h:</div>
84+
<div class="dyncontent">
85+
<div class="center"><img src="MidiFile_8h__incl.png" border="0" usemap="#asrc_2MidiFile_8h" alt=""/></div>
86+
<map name="asrc_2MidiFile_8h" id="asrc_2MidiFile_8h">
87+
<area shape="rect" title="A simple midi parser based on the following project https://github.com/abique/midi&#45;parser." alt="" coords="112,5,220,32"/>
88+
<area shape="rect" title=" " alt="" coords="5,80,73,107"/>
89+
<area shape="rect" title=" " alt="" coords="98,80,165,107"/>
90+
<area shape="rect" title=" " alt="" coords="167,229,237,256"/>
91+
<area shape="rect" href="MidiFileCommon_8h_source.html" title=" " alt="" coords="239,80,383,107"/>
92+
<area shape="rect" href="RingBuffer_8h_source.html" title=" " alt="" coords="261,155,362,181"/>
93+
<area shape="rect" title=" " alt="" coords="262,229,345,256"/>
94+
<area shape="rect" title=" " alt="" coords="369,229,440,256"/>
95+
<area shape="rect" title=" " alt="" coords="465,229,539,256"/>
96+
</map>
97+
</div>
98+
</div>
99+
<p><a href="MidiFile_8h_source.html">Go to the source code of this file.</a></p>
100+
<table class="memberdecls">
101+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
102+
Classes</h2></td></tr>
103+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiFile.html">MidiFile</a></td></tr>
104+
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Midi File parser. Provide the data via write: You should try to keep the buffer as full as possible while parsing. You get the next parsing result by calling the <a class="el" href="classMidiFile.html#a32386d225fb6dcff88e34de6e28671da" title="Parse data in order to provide the next midi element.">parse()</a> method. <a href="classMidiFile.html#details">More...</a><br /></td></tr>
105+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
106+
</table><table class="memberdecls">
107+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
108+
Macros</h2></td></tr>
109+
<tr class="memitem:afce312e5393131ab8fe99508b399f1b7"><td class="memItemLeft" align="right" valign="top"><a id="afce312e5393131ab8fe99508b399f1b7"></a>
110+
#define&#160;</td><td class="memItemRight" valign="bottom"><b>MIDI_BUFFER_SIZE</b>&#160;&#160;&#160;1024 * 2</td></tr>
111+
<tr class="separator:afce312e5393131ab8fe99508b399f1b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
112+
<tr class="memitem:a5c6db54ab86a04d43f50ac2f5e69362e"><td class="memItemLeft" align="right" valign="top"><a id="a5c6db54ab86a04d43f50ac2f5e69362e"></a>
113+
#define&#160;</td><td class="memItemRight" valign="bottom"><b>MIDI_MIN_REFILL_SIZE</b>&#160;&#160;&#160;512</td></tr>
114+
<tr class="separator:a5c6db54ab86a04d43f50ac2f5e69362e"><td class="memSeparator" colspan="2">&#160;</td></tr>
115+
</table>
116+
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
117+
<div class="textblock"><p>A simple midi parser based on the following project <a href="https://github.com/abique/midi-parser">https://github.com/abique/midi-parser</a>. </p>
118+
<dl class="section author"><dt>Author</dt><dd>Phil Schatzmann</dd></dl>
119+
<dl class="section version"><dt>Version</dt><dd>0.1 </dd></dl>
120+
<dl class="section date"><dt>Date</dt><dd>2023-02-02</dd></dl>
121+
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (c) 2023 </dd></dl>
122+
</div></div><!-- contents -->
123+
<!-- start footer part -->
124+
<hr class="footer"/><address class="footer"><small>
125+
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
126+
</small></address>
127+
</body>
128+
</html>

‎docs/html/MidiFile_8h__incl.map‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<map id="src/MidiFile.h" name="src/MidiFile.h">
2+
<area shape="rect" id="node1" title="A simple midi parser based on the following project https://github.com/abique/midi&#45;parser." alt="" coords="112,5,220,32"/>
3+
<area shape="rect" id="node2" title=" " alt="" coords="5,80,73,107"/>
4+
<area shape="rect" id="node3" title=" " alt="" coords="98,80,165,107"/>
5+
<area shape="rect" id="node4" title=" " alt="" coords="167,229,237,256"/>
6+
<area shape="rect" id="node5" href="$MidiFileCommon_8h_source.html" title=" " alt="" coords="239,80,383,107"/>
7+
<area shape="rect" id="node6" href="$RingBuffer_8h_source.html" title=" " alt="" coords="261,155,362,181"/>
8+
<area shape="rect" id="node7" title=" " alt="" coords="262,229,345,256"/>
9+
<area shape="rect" id="node8" title=" " alt="" coords="369,229,440,256"/>
10+
<area shape="rect" id="node9" title=" " alt="" coords="465,229,539,256"/>
11+
</map>

‎docs/html/MidiFile_8h__incl.md5‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ecb2a94080044b23a0208ec9244ad246

‎docs/html/MidiFile_8h__incl.png‎

19.6 KB
Loading

0 commit comments

Comments
 (0)