239 lines
20 KiB
HTML
239 lines
20 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.12"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Arduino MIDI Library: /Users/franky/dev/git/arduino_midi_library/src/MIDI.h File Reference</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);
|
|
</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 MIDI Library
|
|
 <span id="projectnumber">Version 4.3</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.12 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></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('a00002.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="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">MIDI.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>MIDI Library for the Arduino.
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include "<a class="el" href="a00008_source.html">midi_Defs.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="a00023_source.html">midi_Settings.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="a00011_source.html">midi_Message.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="a00005_source.html">MIDI.hpp</a>"</code><br />
|
|
</div>
|
|
<p><a href="a00002_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html">MidiInterface< SerialPort, _Settings ></a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The main class for MIDI handling. It is templated over the type of serial port to provide abstraction from the hardware interface, meaning you can use HardwareSerial, SoftwareSerial or ak47's Uart classes. The only requirement is that the class implements the begin, read, write and available methods. <a href="a00048.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:a658e91a27ea7f4172798d9503508d702"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00002.html#a658e91a27ea7f4172798d9503508d702">encodeSysEx</a> (const <a class="el" href="a00008.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> *inData, <a class="el" href="a00008.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> *outSysEx, unsigned inLenght)</td></tr>
|
|
<tr class="memdesc:a658e91a27ea7f4172798d9503508d702"><td class="mdescLeft"> </td><td class="mdescRight">Encode System Exclusive messages. SysEx messages are encoded to guarantee transmission of data bytes higher than 127 without breaking the MIDI protocol. Use this static method to convert the data you want to send. <a href="#a658e91a27ea7f4172798d9503508d702">More...</a><br /></td></tr>
|
|
<tr class="separator:a658e91a27ea7f4172798d9503508d702"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acd6ba88e8a9b7d47226e1288539758d6"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00002.html#acd6ba88e8a9b7d47226e1288539758d6">decodeSysEx</a> (const <a class="el" href="a00008.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> *inSysEx, <a class="el" href="a00008.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> *outData, unsigned inLenght)</td></tr>
|
|
<tr class="memdesc:acd6ba88e8a9b7d47226e1288539758d6"><td class="mdescLeft"> </td><td class="mdescRight">Decode System Exclusive messages. SysEx messages are encoded to guarantee transmission of data bytes higher than 127 without breaking the MIDI protocol. Use this static method to reassemble your received message. <a href="#acd6ba88e8a9b7d47226e1288539758d6">More...</a><br /></td></tr>
|
|
<tr class="separator:acd6ba88e8a9b7d47226e1288539758d6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>MIDI Library for the Arduino. </p>
|
|
<p>Project Arduino MIDI Library </p><dl class="section version"><dt>Version</dt><dd>4.3 </dd></dl>
|
|
<dl class="section author"><dt>Author</dt><dd>Francois Best </dd></dl>
|
|
<dl class="section date"><dt>Date</dt><dd>24/02/11 MIT - Copyright (c) 2015 Francois Best</dd></dl>
|
|
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
|
|
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
|
|
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. </p>
|
|
|
|
<p>Definition in file <a class="el" href="a00002_source.html">MIDI.h</a>.</p>
|
|
</div><h2 class="groupheader">Function Documentation</h2>
|
|
<a id="acd6ba88e8a9b7d47226e1288539758d6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acd6ba88e8a9b7d47226e1288539758d6">§ </a></span>decodeSysEx()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned decodeSysEx </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="a00008.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> * </td>
|
|
<td class="paramname"><em>inSysEx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00008.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> * </td>
|
|
<td class="paramname"><em>outData</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned </td>
|
|
<td class="paramname"><em>inLength</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Decode System Exclusive messages. SysEx messages are encoded to guarantee transmission of data bytes higher than 127 without breaking the MIDI protocol. Use this static method to reassemble your received message. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">inSysEx</td><td>The SysEx data received from MIDI in. </td></tr>
|
|
<tr><td class="paramname">outData</td><td>The output buffer where to store the decrypted message. </td></tr>
|
|
<tr><td class="paramname">inLength</td><td>The lenght of the input buffer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The lenght of the output buffer. </dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00035.html#afe7c42d0b3ebed55378f19fc25c2c00b" title="Encode System Exclusive messages. SysEx messages are encoded to guarantee transmission of data bytes ...">encodeSysEx</a> </dd>
|
|
<dd>
|
|
getSysExArrayLength Code inspired from Ruin & Wesen's SysEx encoder/decoder - <a href="http://ruinwesen.com">http://ruinwesen.com</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="a00035_source.html#l00083">83</a> of file <a class="el" href="a00035_source.html">MIDI.cpp</a>.</p>
|
|
<div class="fragment"><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> {</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">unsigned</span> count = 0;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <a class="code" href="a00008.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> msbStorage = 0;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <a class="code" href="a00008.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> byteIndex = 0;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> i = 0; i < inLength; ++i)</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>  <span class="keywordflow">if</span> ((i % 8) == 0)</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  {</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  msbStorage = inSysEx[i];</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  byteIndex = 6;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  }</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  {</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">const</span> <a class="code" href="a00008.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> body = inSysEx[i];</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">const</span> <a class="code" href="a00008.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> msb = ((msbStorage >> byteIndex--) & 1) << 7;</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  outData[count++] = msb | body;</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>  }</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordflow">return</span> count;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> }</div><div class="ttc" id="a00008_html_ab8ef12fab634c171394422d0ee8baf94"><div class="ttname"><a href="a00008.html#ab8ef12fab634c171394422d0ee8baf94">byte</a></div><div class="ttdeci">uint8_t byte</div><div class="ttdef"><b>Definition:</b> <a href="a00008_source.html#l00037">midi_Defs.h:37</a></div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a658e91a27ea7f4172798d9503508d702"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a658e91a27ea7f4172798d9503508d702">§ </a></span>encodeSysEx()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned encodeSysEx </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="a00008.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> * </td>
|
|
<td class="paramname"><em>inData</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00008.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> * </td>
|
|
<td class="paramname"><em>outSysEx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned </td>
|
|
<td class="paramname"><em>inLength</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Encode System Exclusive messages. SysEx messages are encoded to guarantee transmission of data bytes higher than 127 without breaking the MIDI protocol. Use this static method to convert the data you want to send. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">inData</td><td>The data to encode. </td></tr>
|
|
<tr><td class="paramname">outSysEx</td><td>The output buffer where to store the encoded message. </td></tr>
|
|
<tr><td class="paramname">inLength</td><td>The lenght of the input buffer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The lenght of the encoded output buffer. </dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00035.html#ae5b3935e2eeca1f7be983da095dcf056" title="Decode System Exclusive messages. SysEx messages are encoded to guarantee transmission of data bytes ...">decodeSysEx</a> Code inspired from Ruin & Wesen's SysEx encoder/decoder - <a href="http://ruinwesen.com">http://ruinwesen.com</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="a00035_source.html#l00046">46</a> of file <a class="el" href="a00035_source.html">MIDI.cpp</a>.</p>
|
|
<div class="fragment"><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="keywordtype">unsigned</span> outLength = 0; <span class="comment">// Num bytes in output array.</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="a00008.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> count = 0; <span class="comment">// Num 7bytes in a block.</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  outSysEx[0] = 0;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> i = 0; i < inLength; ++i)</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">const</span> <a class="code" href="a00008.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> data = inData[i];</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">const</span> <a class="code" href="a00008.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> msb = data >> 7;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">const</span> <a class="code" href="a00008.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> body = data & 0x7f;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  outSysEx[0] |= (msb << (6 - count));</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  outSysEx[1 + count] = body;</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">if</span> (count++ == 6)</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>  outSysEx += 8;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  outLength += 8;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  outSysEx[0] = 0;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  count = 0;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  }</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  }</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordflow">return</span> outLength + count + (count != 0 ? 1 : 0);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> }</div><div class="ttc" id="a00008_html_ab8ef12fab634c171394422d0ee8baf94"><div class="ttname"><a href="a00008.html#ab8ef12fab634c171394422d0ee8baf94">byte</a></div><div class="ttdeci">uint8_t byte</div><div class="ttdef"><b>Definition:</b> <a href="a00008_source.html#l00037">midi_Defs.h:37</a></div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
</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="a00002.html">MIDI.h</a></li>
|
|
<li class="footer">Generated on Wed Nov 2 2016 20:12:21 for Arduino MIDI Library by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.12 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|