140 lines
17 KiB
HTML
140 lines
17 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.11"/>
|
|
<title>Arduino MIDI Library: /Users/franky/dev/git/arduino_midi_library/src/midi_UsbTransport.h Source File</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);
|
|
$(window).load(resizeHeight);
|
|
</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>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</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.11 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li><a href="examples.html"><span>Examples</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul>
|
|
</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('a00034_source.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="headertitle">
|
|
<div class="title">midi_UsbTransport.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="a00034.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "<a class="code" href="a00027.html">midi_Defs.h</a>"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "<a class="code" href="a00030.html">midi_RingBuffer.h</a>"</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <MIDIUSB.h></span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <a class="code" href="a00029.html#adf6b690441eb0a31c4abd3bc4fb99673">BEGIN_MIDI_NAMESPACE</a></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">template</span><<span class="keywordtype">unsigned</span> BuffersSize></div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="a00022.html"> 38</a></span> <span class="keyword">class </span><a class="code" href="a00022.html">UsbTransport</a></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">inline</span> <a class="code" href="a00022.html#acb8ca31730e8ea4e9058b17b2f41202b">UsbTransport</a>();</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">inline</span> <a class="code" href="a00022.html#ab74990a39fc08cbe523e6b42a11bbe35">~UsbTransport</a>();</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">public</span>: <span class="comment">// Serial / Stream API required for template compatibility</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="a00022.html#afc6e724fdcc96fb83af0285c5e583741">begin</a>(<span class="keywordtype">unsigned</span> inBaudrate);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <a class="code" href="a00022.html#ad850ea7fa2dfe63ea199bb841c535402">available</a>();</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">inline</span> <a class="code" href="a00027.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> <a class="code" href="a00022.html#a3e2a189763c0075a18761a438f385b05">read</a>();</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="a00022.html#aedfc3deea0759ec00c4baf0dced87672">write</a>(<a class="code" href="a00027.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> inData);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> pollUsbMidi();</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> recomposeAndSendTxPackets();</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> resetTx();</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">static</span> <span class="keyword">inline</span> <a class="code" href="a00027.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> encodePacketHeader(<a class="code" href="a00027.html#a11ff4f08b08691aaf2d8b42b8330b87f">StatusByte</a> inStatusByte);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">int</span> getPacketLength(<span class="keyword">const</span> midiEventPacket_t& inPacket);</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">typedef</span> <a class="code" href="a00018.html">RingBuffer<byte, BuffersSize></a> <a class="code" href="a00018.html">Buffer</a>;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  Buffer mTxBuffer;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  Buffer mRxBuffer;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">union </span>TxPacket</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  {</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="a00027.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> mDataArray[4];</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  midiEventPacket_t mPacket;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  };</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  TxPacket mCurrentTxPacket;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">int</span> mCurrentTxPacketByteIndex;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> };</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <a class="code" href="a00029.html#abf831eff386c2ded4d253fb11321028e">END_MIDI_NAMESPACE</a></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor">#include "<a class="code" href="a00035.html">midi_UsbTransport.hpp</a>"</span></div><div class="ttc" id="a00029_html_abf831eff386c2ded4d253fb11321028e"><div class="ttname"><a href="a00029.html#abf831eff386c2ded4d253fb11321028e">END_MIDI_NAMESPACE</a></div><div class="ttdeci">#define END_MIDI_NAMESPACE</div><div class="ttdef"><b>Definition:</b> <a href="a00029_source.html#l00033">midi_Namespace.h:33</a></div></div>
|
|
<div class="ttc" id="a00022_html"><div class="ttname"><a href="a00022.html">UsbTransport</a></div><div class="ttdef"><b>Definition:</b> <a href="a00034_source.html#l00038">midi_UsbTransport.h:38</a></div></div>
|
|
<div class="ttc" id="a00022_html_a3e2a189763c0075a18761a438f385b05"><div class="ttname"><a href="a00022.html#a3e2a189763c0075a18761a438f385b05">UsbTransport::read</a></div><div class="ttdeci">byte read()</div><div class="ttdef"><b>Definition:</b> <a href="a00035_source.html#l00062">midi_UsbTransport.hpp:62</a></div></div>
|
|
<div class="ttc" id="a00022_html_afc6e724fdcc96fb83af0285c5e583741"><div class="ttname"><a href="a00022.html#afc6e724fdcc96fb83af0285c5e583741">UsbTransport::begin</a></div><div class="ttdeci">void begin(unsigned inBaudrate)</div><div class="ttdef"><b>Definition:</b> <a href="a00035_source.html#l00048">midi_UsbTransport.hpp:48</a></div></div>
|
|
<div class="ttc" id="a00027_html"><div class="ttname"><a href="a00027.html">midi_Defs.h</a></div><div class="ttdoc">MIDI Library for the Arduino - Definitions. </div></div>
|
|
<div class="ttc" id="a00029_html_adf6b690441eb0a31c4abd3bc4fb99673"><div class="ttname"><a href="a00029.html#adf6b690441eb0a31c4abd3bc4fb99673">BEGIN_MIDI_NAMESPACE</a></div><div class="ttdeci">#define BEGIN_MIDI_NAMESPACE</div><div class="ttdef"><b>Definition:</b> <a href="a00029_source.html#l00032">midi_Namespace.h:32</a></div></div>
|
|
<div class="ttc" id="a00030_html"><div class="ttname"><a href="a00030.html">midi_RingBuffer.h</a></div><div class="ttdoc">MIDI Library for Arduino - Ring Buffer. </div></div>
|
|
<div class="ttc" id="a00027_html_ab8ef12fab634c171394422d0ee8baf94"><div class="ttname"><a href="a00027.html#ab8ef12fab634c171394422d0ee8baf94">byte</a></div><div class="ttdeci">uint8_t byte</div><div class="ttdef"><b>Definition:</b> <a href="a00027_source.html#l00037">midi_Defs.h:37</a></div></div>
|
|
<div class="ttc" id="a00035_html"><div class="ttname"><a href="a00035.html">midi_UsbTransport.hpp</a></div><div class="ttdoc">MIDI Library for the Arduino - Transport layer for USB MIDI. </div></div>
|
|
<div class="ttc" id="a00018_html"><div class="ttname"><a href="a00018.html">RingBuffer< byte, BuffersSize ></a></div></div>
|
|
<div class="ttc" id="a00027_html_a11ff4f08b08691aaf2d8b42b8330b87f"><div class="ttname"><a href="a00027.html#a11ff4f08b08691aaf2d8b42b8330b87f">StatusByte</a></div><div class="ttdeci">byte StatusByte</div><div class="ttdef"><b>Definition:</b> <a href="a00027_source.html#l00058">midi_Defs.h:58</a></div></div>
|
|
<div class="ttc" id="a00022_html_ad850ea7fa2dfe63ea199bb841c535402"><div class="ttname"><a href="a00022.html#ad850ea7fa2dfe63ea199bb841c535402">UsbTransport::available</a></div><div class="ttdeci">unsigned available()</div><div class="ttdef"><b>Definition:</b> <a href="a00035_source.html#l00055">midi_UsbTransport.hpp:55</a></div></div>
|
|
<div class="ttc" id="a00022_html_acb8ca31730e8ea4e9058b17b2f41202b"><div class="ttname"><a href="a00022.html#acb8ca31730e8ea4e9058b17b2f41202b">UsbTransport::UsbTransport</a></div><div class="ttdeci">UsbTransport()</div><div class="ttdef"><b>Definition:</b> <a href="a00035_source.html#l00034">midi_UsbTransport.hpp:34</a></div></div>
|
|
<div class="ttc" id="a00022_html_aedfc3deea0759ec00c4baf0dced87672"><div class="ttname"><a href="a00022.html#aedfc3deea0759ec00c4baf0dced87672">UsbTransport::write</a></div><div class="ttdeci">void write(byte inData)</div><div class="ttdef"><b>Definition:</b> <a href="a00035_source.html#l00068">midi_UsbTransport.hpp:68</a></div></div>
|
|
<div class="ttc" id="a00022_html_ab74990a39fc08cbe523e6b42a11bbe35"><div class="ttname"><a href="a00022.html#ab74990a39fc08cbe523e6b42a11bbe35">UsbTransport::~UsbTransport</a></div><div class="ttdeci">~UsbTransport()</div><div class="ttdef"><b>Definition:</b> <a href="a00035_source.html#l00040">midi_UsbTransport.hpp:40</a></div></div>
|
|
</div><!-- fragment --></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="a00034.html">midi_UsbTransport.h</a></li>
|
|
<li class="footer">Generated on Wed Nov 2 2016 19:56:40 for Arduino MIDI Library by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|