taigrr/arduinolibs
1
0
Fork 0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00
Code Issues Projects Releases Wiki Activity
arduinolibs/Melody_8h_source.html
Rhys Weatherley 17f4fb4873 Update docs
2012-06-18 11:03:07 +10:00

240 lines
22 KiB
HTML
Raw Blame History

<!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"/>
<title>ArduinoLibs: Melody.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ArduinoLibs</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</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 id="searchli">
<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&#160;List</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Melody.h</div> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright (C) 2012 Southern Storm Software, Pty Ltd.</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a</span>
<a name="l00005"></a>00005 <span class="comment"> * copy of this software and associated documentation files (the &quot;Software&quot;),</span>
<a name="l00006"></a>00006 <span class="comment"> * to deal in the Software without restriction, including without limitation</span>
<a name="l00007"></a>00007 <span class="comment"> * the rights to use, copy, modify, merge, publish, distribute, sublicense,</span>
<a name="l00008"></a>00008 <span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the</span>
<a name="l00009"></a>00009 <span class="comment"> * Software is furnished to do so, subject to the following conditions:</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * The above copyright notice and this permission notice shall be included</span>
<a name="l00012"></a>00012 <span class="comment"> * in all copies or substantial portions of the Software.</span>
<a name="l00013"></a>00013 <span class="comment"> *</span>
<a name="l00014"></a>00014 <span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS</span>
<a name="l00015"></a>00015 <span class="comment"> * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
<a name="l00016"></a>00016 <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
<a name="l00017"></a>00017 <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
<a name="l00018"></a>00018 <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span>
<a name="l00019"></a>00019 <span class="comment"> * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span>
<a name="l00020"></a>00020 <span class="comment"> * DEALINGS IN THE SOFTWARE.</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef Melody_h</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define Melody_h</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;inttypes.h&gt;</span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="comment">// Note frequencies from http://arduino.cc/en/Tutorial/Tone</span>
<a name="l00029"></a>00029 <span class="preprocessor">#define NOTE_B0 31</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_C1 33</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_CS1 35</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_D1 37</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_DS1 39</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_E1 41</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_F1 44</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_FS1 46</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_G1 49</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_GS1 52</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_A1 55</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_AS1 58</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_B1 62</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_C2 65</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_CS2 69</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_D2 73</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_DS2 78</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_E2 82</span>
<a name="l00047"></a>00047 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_F2 87</span>
<a name="l00048"></a>00048 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_FS2 93</span>
<a name="l00049"></a>00049 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_G2 98</span>
<a name="l00050"></a>00050 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_GS2 104</span>
<a name="l00051"></a>00051 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_A2 110</span>
<a name="l00052"></a>00052 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_AS2 117</span>
<a name="l00053"></a>00053 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_B2 123</span>
<a name="l00054"></a>00054 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_C3 131</span>
<a name="l00055"></a>00055 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_CS3 139</span>
<a name="l00056"></a>00056 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_D3 147</span>
<a name="l00057"></a>00057 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_DS3 156</span>
<a name="l00058"></a>00058 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_E3 165</span>
<a name="l00059"></a>00059 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_F3 175</span>
<a name="l00060"></a>00060 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_FS3 185</span>
<a name="l00061"></a>00061 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_G3 196</span>
<a name="l00062"></a>00062 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_GS3 208</span>
<a name="l00063"></a>00063 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_A3 220</span>
<a name="l00064"></a>00064 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_AS3 233</span>
<a name="l00065"></a>00065 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_B3 247</span>
<a name="l00066"></a>00066 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_C4 262</span>
<a name="l00067"></a>00067 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_CS4 277</span>
<a name="l00068"></a>00068 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_D4 294</span>
<a name="l00069"></a>00069 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_DS4 311</span>
<a name="l00070"></a>00070 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_E4 330</span>
<a name="l00071"></a>00071 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_F4 349</span>
<a name="l00072"></a>00072 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_FS4 370</span>
<a name="l00073"></a>00073 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_G4 392</span>
<a name="l00074"></a>00074 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_GS4 415</span>
<a name="l00075"></a>00075 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_A4 440</span>
<a name="l00076"></a>00076 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_AS4 466</span>
<a name="l00077"></a>00077 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_B4 494</span>
<a name="l00078"></a>00078 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_C5 523</span>
<a name="l00079"></a>00079 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_CS5 554</span>
<a name="l00080"></a>00080 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_D5 587</span>
<a name="l00081"></a>00081 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_DS5 622</span>
<a name="l00082"></a>00082 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_E5 659</span>
<a name="l00083"></a>00083 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_F5 698</span>
<a name="l00084"></a>00084 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_FS5 740</span>
<a name="l00085"></a>00085 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_G5 784</span>
<a name="l00086"></a>00086 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_GS5 831</span>
<a name="l00087"></a>00087 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_A5 880</span>
<a name="l00088"></a>00088 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_AS5 932</span>
<a name="l00089"></a>00089 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_B5 988</span>
<a name="l00090"></a>00090 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_C6 1047</span>
<a name="l00091"></a>00091 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_CS6 1109</span>
<a name="l00092"></a>00092 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_D6 1175</span>
<a name="l00093"></a>00093 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_DS6 1245</span>
<a name="l00094"></a>00094 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_E6 1319</span>
<a name="l00095"></a>00095 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_F6 1397</span>
<a name="l00096"></a>00096 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_FS6 1480</span>
<a name="l00097"></a>00097 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_G6 1568</span>
<a name="l00098"></a>00098 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_GS6 1661</span>
<a name="l00099"></a>00099 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_A6 1760</span>
<a name="l00100"></a>00100 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_AS6 1865</span>
<a name="l00101"></a>00101 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_B6 1976</span>
<a name="l00102"></a>00102 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_C7 2093</span>
<a name="l00103"></a>00103 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_CS7 2217</span>
<a name="l00104"></a>00104 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_D7 2349</span>
<a name="l00105"></a>00105 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_DS7 2489</span>
<a name="l00106"></a>00106 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_E7 2637</span>
<a name="l00107"></a>00107 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_F7 2794</span>
<a name="l00108"></a>00108 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_FS7 2960</span>
<a name="l00109"></a>00109 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_G7 3136</span>
<a name="l00110"></a>00110 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_GS7 3322</span>
<a name="l00111"></a>00111 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_A7 3520</span>
<a name="l00112"></a>00112 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_AS7 3729</span>
<a name="l00113"></a>00113 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_B7 3951</span>
<a name="l00114"></a>00114 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_C8 4186</span>
<a name="l00115"></a>00115 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_CS8 4435</span>
<a name="l00116"></a>00116 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_D8 4699</span>
<a name="l00117"></a>00117 <span class="preprocessor"></span><span class="preprocessor">#define NOTE_DS8 4978</span>
<a name="l00118"></a>00118 <span class="preprocessor"></span>
<a name="l00119"></a>00119 <span class="comment">// Special note value that indicates a rest.</span>
<a name="l00120"></a>00120 <span class="preprocessor">#define NOTE_REST 0</span>
<a name="l00121"></a>00121 <span class="preprocessor"></span>
<a name="l00122"></a><a class="code" href="classMelody.html">00122</a> <span class="keyword">class </span><a class="code" href="classMelody.html" title="Plays a melody on a digital output pin using tone().">Melody</a> {
<a name="l00123"></a>00123 <span class="keyword">public</span>:
<a name="l00124"></a>00124 <a class="code" href="classMelody.html#a9edc4165a49368dd5d78eedf982c38b9" title="Constructs a new melody playing object for pin.">Melody</a>(uint8_t pin);
<a name="l00125"></a>00125
<a name="l00126"></a><a class="code" href="classMelody.html#ad38db3338ed87d72238c0ea9440c633c">00126</a> <span class="keywordtype">bool</span> <a class="code" href="classMelody.html#ad38db3338ed87d72238c0ea9440c633c" title="Returns true if the melody is currently playing; false if not.">isPlaying</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> playing; }
<a name="l00127"></a>00127
<a name="l00128"></a><a class="code" href="classMelody.html#ab78253ae9abc8478b05f415f5d878a60">00128</a> <span class="keywordtype">int</span> <a class="code" href="classMelody.html#ab78253ae9abc8478b05f415f5d878a60" title="Returns the number of times the melody should loop before stopping.">loopCount</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _loopCount; }
<a name="l00129"></a><a class="code" href="classMelody.html#a507097a2e8ff51a5e9157e3a320ae35b">00129</a> <span class="keywordtype">void</span> <a class="code" href="classMelody.html#a507097a2e8ff51a5e9157e3a320ae35b" title="Sets the number of times the melody should loop to count.">setLoopCount</a>(<span class="keywordtype">int</span> count) { _loopCount = count; }
<a name="l00130"></a>00130
<a name="l00131"></a>00131 <span class="keywordtype">void</span> <a class="code" href="classMelody.html#ae88ad06c2acb728f56dd213d5dad6006" title="Sets the maximum number of loops to last no longer than ms milliseconds.">setLoopDuration</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> ms);
<a name="l00132"></a>00132
<a name="l00133"></a>00133 <span class="keywordtype">void</span> <a class="code" href="classMelody.html#a9fd8e0d48833d8da3cd3b3b58408b0b5" title="Starts playing the melody, or restarts it if already playing.">play</a>();
<a name="l00134"></a>00134 <span class="keywordtype">void</span> <a class="code" href="classMelody.html#aecc9185c9cb1246e8a55521b17d72932" title="Plays the melody once and then stops.">playOnce</a>();
<a name="l00135"></a>00135 <span class="keywordtype">void</span> <a class="code" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b" title="Stops playing the melody.">stop</a>();
<a name="l00136"></a>00136
<a name="l00137"></a>00137 <span class="keywordtype">void</span> <a class="code" href="classMelody.html#adb6ad8e8cfe8c9a137e470f4e85c7254" title="Sets the melody to the size elements of notes and lengths.">setMelody</a>(<span class="keyword">const</span> <span class="keywordtype">int</span> *notes, <span class="keyword">const</span> uint8_t *lengths, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size);
<a name="l00138"></a>00138
<a name="l00139"></a>00139 <span class="keywordtype">void</span> <a class="code" href="classMelody.html#ad1103b970be1f59058cc7d927be68955" title="Runs the melody control loop.">run</a>();
<a name="l00140"></a>00140
<a name="l00141"></a>00141 <span class="keyword">private</span>:
<a name="l00142"></a>00142 uint8_t _pin;
<a name="l00143"></a>00143 <span class="keywordtype">bool</span> playing;
<a name="l00144"></a>00144 <span class="keywordtype">int</span> _loopCount;
<a name="l00145"></a>00145 <span class="keywordtype">int</span> loopsLeft;
<a name="l00146"></a>00146 <span class="keyword">const</span> <span class="keywordtype">int</span> *notes;
<a name="l00147"></a>00147 <span class="keyword">const</span> uint8_t *lengths;
<a name="l00148"></a>00148 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size;
<a name="l00149"></a>00149 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> posn;
<a name="l00150"></a>00150 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> duration;
<a name="l00151"></a>00151 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> startNote;
<a name="l00152"></a>00152
<a name="l00153"></a>00153 <span class="keywordtype">void</span> nextNote();
<a name="l00154"></a>00154 };
<a name="l00155"></a>00155
<a name="l00156"></a>00156 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a></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>
<hr class="footer"/><address class="footer"><small>Generated on Mon Jun 18 2012 11:02:52 for ArduinoLibs by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink