mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
Update docs
This commit is contained in:
Rhys Weatherley
@@ -2,29 +2,37 @@
|
||||
<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"/>
|
||||
<title>ArduinoLibs: Melody.cpp 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="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"/>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
||||
</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">
|
||||
<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 style="padding-left: 0.5em;">
|
||||
<div id="projectname">ArduinoLibs</div>
|
||||
<div id="projectname">ArduinoLibs
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.1.2 -->
|
||||
<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>
|
||||
@@ -32,7 +40,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
<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">
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
@@ -55,136 +63,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
<li><a href="files.html"><span>File List</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">Melody.cpp</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 "Software"),</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 "AS IS", 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">#include "Melody.h"</span>
|
||||
<a name="l00024"></a>00024 <span class="preprocessor">#if defined(ARDUINO) && ARDUINO >= 100</span>
|
||||
<a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#include <Arduino.h></span>
|
||||
<a name="l00026"></a>00026 <span class="preprocessor">#else</span>
|
||||
<a name="l00027"></a>00027 <span class="preprocessor"></span><span class="preprocessor">#include <WProgram.h></span>
|
||||
<a name="l00028"></a>00028 <span class="preprocessor">#endif</span>
|
||||
<a name="l00029"></a>00029 <span class="preprocessor"></span>
|
||||
<a name="l00085"></a><a class="code" href="classMelody.html#a9edc4165a49368dd5d78eedf982c38b9">00085</a> <a class="code" href="classMelody.html#a9edc4165a49368dd5d78eedf982c38b9" title="Constructs a new melody playing object for pin.">Melody::Melody</a>(uint8_t pin)
|
||||
<a name="l00086"></a>00086 : _pin(pin)
|
||||
<a name="l00087"></a>00087 , playing(false)
|
||||
<a name="l00088"></a>00088 , _loopCount(0)
|
||||
<a name="l00089"></a>00089 , loopsLeft(0)
|
||||
<a name="l00090"></a>00090 , notes(0)
|
||||
<a name="l00091"></a>00091 , lengths(0)
|
||||
<a name="l00092"></a>00092 , size(0)
|
||||
<a name="l00093"></a>00093 , posn(0)
|
||||
<a name="l00094"></a>00094 , duration(0)
|
||||
<a name="l00095"></a>00095 , startNote(0)
|
||||
<a name="l00096"></a>00096 {
|
||||
<a name="l00097"></a>00097 }
|
||||
<a name="l00098"></a>00098
|
||||
<a name="l00131"></a><a class="code" href="classMelody.html#ae88ad06c2acb728f56dd213d5dad6006">00131</a> <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.">Melody::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">unsigned</span> <span class="keywordtype">long</span> duration = 0;
|
||||
<a name="l00134"></a>00134 <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> index = 0; index < size; ++index)
|
||||
<a name="l00135"></a>00135 duration += (1000 / lengths[index]) * 13 / 10;
|
||||
<a name="l00136"></a>00136 _loopCount = (int)(ms / duration);
|
||||
<a name="l00137"></a>00137 <span class="keywordflow">if</span> (!_loopCount)
|
||||
<a name="l00138"></a>00138 _loopCount = 1; <span class="comment">// Play the melody at least once.</span>
|
||||
<a name="l00139"></a>00139 }
|
||||
<a name="l00140"></a>00140
|
||||
<a name="l00146"></a><a class="code" href="classMelody.html#a9fd8e0d48833d8da3cd3b3b58408b0b5">00146</a> <span class="keywordtype">void</span> <a class="code" href="classMelody.html#a9fd8e0d48833d8da3cd3b3b58408b0b5" title="Starts playing the melody, or restarts it if already playing.">Melody::play</a>()
|
||||
<a name="l00147"></a>00147 {
|
||||
<a name="l00148"></a>00148 <a class="code" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b" title="Stops playing the melody.">stop</a>();
|
||||
<a name="l00149"></a>00149 <span class="keywordflow">if</span> (size == 0)
|
||||
<a name="l00150"></a>00150 <span class="keywordflow">return</span>; <span class="comment">// No melody to play.</span>
|
||||
<a name="l00151"></a>00151 loopsLeft = _loopCount;
|
||||
<a name="l00152"></a>00152 posn = 0;
|
||||
<a name="l00153"></a>00153 playing = <span class="keyword">true</span>;
|
||||
<a name="l00154"></a>00154 nextNote();
|
||||
<a name="l00155"></a>00155 }
|
||||
<a name="l00156"></a>00156
|
||||
<a name="l00162"></a><a class="code" href="classMelody.html#aecc9185c9cb1246e8a55521b17d72932">00162</a> <span class="keywordtype">void</span> <a class="code" href="classMelody.html#aecc9185c9cb1246e8a55521b17d72932" title="Plays the melody once and then stops.">Melody::playOnce</a>()
|
||||
<a name="l00163"></a>00163 {
|
||||
<a name="l00164"></a>00164 <a class="code" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b" title="Stops playing the melody.">stop</a>();
|
||||
<a name="l00165"></a>00165 <span class="keywordflow">if</span> (size == 0)
|
||||
<a name="l00166"></a>00166 <span class="keywordflow">return</span>; <span class="comment">// No melody to play.</span>
|
||||
<a name="l00167"></a>00167 loopsLeft = 1;
|
||||
<a name="l00168"></a>00168 posn = 0;
|
||||
<a name="l00169"></a>00169 playing = <span class="keyword">true</span>;
|
||||
<a name="l00170"></a>00170 nextNote();
|
||||
<a name="l00171"></a>00171 }
|
||||
<a name="l00172"></a>00172
|
||||
<a name="l00178"></a><a class="code" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b">00178</a> <span class="keywordtype">void</span> <a class="code" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b" title="Stops playing the melody.">Melody::stop</a>()
|
||||
<a name="l00179"></a>00179 {
|
||||
<a name="l00180"></a>00180 <span class="keywordflow">if</span> (!playing)
|
||||
<a name="l00181"></a>00181 <span class="keywordflow">return</span>;
|
||||
<a name="l00182"></a>00182 playing = <span class="keyword">false</span>;
|
||||
<a name="l00183"></a>00183 noTone(_pin);
|
||||
<a name="l00184"></a>00184 }
|
||||
<a name="l00185"></a>00185
|
||||
<a name="l00199"></a><a class="code" href="classMelody.html#adb6ad8e8cfe8c9a137e470f4e85c7254">00199</a> <span class="keywordtype">void</span> <a class="code" href="classMelody.html#adb6ad8e8cfe8c9a137e470f4e85c7254" title="Sets the melody to the size elements of notes and lengths.">Melody::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="l00200"></a>00200 {
|
||||
<a name="l00201"></a>00201 <a class="code" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b" title="Stops playing the melody.">stop</a>();
|
||||
<a name="l00202"></a>00202 this->notes = notes;
|
||||
<a name="l00203"></a>00203 this->lengths = lengths;
|
||||
<a name="l00204"></a>00204 this->size = size;
|
||||
<a name="l00205"></a>00205 }
|
||||
<a name="l00206"></a>00206
|
||||
<a name="l00214"></a><a class="code" href="classMelody.html#ad1103b970be1f59058cc7d927be68955">00214</a> <span class="keywordtype">void</span> <a class="code" href="classMelody.html#ad1103b970be1f59058cc7d927be68955" title="Runs the melody control loop.">Melody::run</a>()
|
||||
<a name="l00215"></a>00215 {
|
||||
<a name="l00216"></a>00216 <span class="keywordflow">if</span> (!playing)
|
||||
<a name="l00217"></a>00217 <span class="keywordflow">return</span>;
|
||||
<a name="l00218"></a>00218 <span class="keywordflow">if</span> ((millis() - startNote) >= duration) {
|
||||
<a name="l00219"></a>00219 noTone(_pin);
|
||||
<a name="l00220"></a>00220 nextNote();
|
||||
<a name="l00221"></a>00221 }
|
||||
<a name="l00222"></a>00222 }
|
||||
<a name="l00223"></a>00223
|
||||
<a name="l00224"></a>00224 <span class="keywordtype">void</span> Melody::nextNote()
|
||||
<a name="l00225"></a>00225 {
|
||||
<a name="l00226"></a>00226 <span class="keywordflow">if</span> (posn >= size) {
|
||||
<a name="l00227"></a>00227 <span class="keywordflow">if</span> (loopsLeft != 0 && --loopsLeft <= 0) {
|
||||
<a name="l00228"></a>00228 <a class="code" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b" title="Stops playing the melody.">stop</a>();
|
||||
<a name="l00229"></a>00229 <span class="keywordflow">return</span>;
|
||||
<a name="l00230"></a>00230 }
|
||||
<a name="l00231"></a>00231 posn = 0;
|
||||
<a name="l00232"></a>00232 }
|
||||
<a name="l00233"></a>00233 duration = 1000 / lengths[posn];
|
||||
<a name="l00234"></a>00234 <span class="keywordflow">if</span> (notes[posn] != NOTE_REST)
|
||||
<a name="l00235"></a>00235 tone(_pin, notes[posn], duration);
|
||||
<a name="l00236"></a>00236 ++posn;
|
||||
<a name="l00237"></a>00237 duration = duration * 13 / 10; <span class="comment">// i.e., duration * 1.3</span>
|
||||
<a name="l00238"></a>00238 startNote = millis();
|
||||
<a name="l00239"></a>00239 }
|
||||
</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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a></div>
|
||||
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
@@ -193,8 +77,139 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
<hr class="footer"/><address class="footer"><small>Generated on Mon Jun 18 2012 11:02:52 for ArduinoLibs by 
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
|
||||
<div id="nav-path" class="navpath">
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="dir_bc0718b08fb2015b8e59c47b2805f60c.html">libraries</a></li><li class="navelem"><a class="el" href="dir_be059bf9978ae156837504b1b8a7568c.html">Melody</a></li> </ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">Melody.cpp</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
|
||||
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (C) 2012 Southern Storm Software, Pty Ltd.</span></div>
|
||||
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div>
|
||||
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a</span></div>
|
||||
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * copy of this software and associated documentation files (the "Software"),</span></div>
|
||||
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * to deal in the Software without restriction, including without limitation</span></div>
|
||||
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * the rights to use, copy, modify, merge, publish, distribute, sublicense,</span></div>
|
||||
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the</span></div>
|
||||
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Software is furnished to do so, subject to the following conditions:</span></div>
|
||||
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
|
||||
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * The above copyright notice and this permission notice shall be included</span></div>
|
||||
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * in all copies or substantial portions of the Software.</span></div>
|
||||
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div>
|
||||
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS</span></div>
|
||||
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
|
||||
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div>
|
||||
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
|
||||
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span></div>
|
||||
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span></div>
|
||||
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * DEALINGS IN THE SOFTWARE.</span></div>
|
||||
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div>
|
||||
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div>
|
||||
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "Melody.h"</span></div>
|
||||
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#if defined(ARDUINO) && ARDUINO >= 100</span></div>
|
||||
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span><span class="preprocessor">#include <Arduino.h></span></div>
|
||||
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#else</span></div>
|
||||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor"></span><span class="preprocessor">#include <WProgram.h></span></div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#endif</span></div>
|
||||
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor"></span></div>
|
||||
<div class="line"><a name="l00085"></a><span class="lineno"><a class="code" href="classMelody.html#a9edc4165a49368dd5d78eedf982c38b9"> 85</a></span> <a class="code" href="classMelody.html#a9edc4165a49368dd5d78eedf982c38b9" title="Constructs a new melody playing object for pin.">Melody::Melody</a>(uint8_t pin)</div>
|
||||
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  : _pin(pin)</div>
|
||||
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  , playing(false)</div>
|
||||
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  , _loopCount(0)</div>
|
||||
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  , loopsLeft(0)</div>
|
||||
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  , notes(0)</div>
|
||||
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  , lengths(0)</div>
|
||||
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  , size(0)</div>
|
||||
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  , posn(0)</div>
|
||||
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  , duration(0)</div>
|
||||
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  , startNote(0)</div>
|
||||
<div class="line"><a name="l00096"></a><span class="lineno"> 96</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> </div>
|
||||
<div class="line"><a name="l00131"></a><span class="lineno"><a class="code" href="classMelody.html#ae88ad06c2acb728f56dd213d5dad6006"> 131</a></span> <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.">Melody::setLoopDuration</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> ms)</div>
|
||||
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> {</div>
|
||||
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> duration = 0;</div>
|
||||
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> index = 0; index < size; ++index)</div>
|
||||
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  duration += (1000 / lengths[index]) * 13 / 10;</div>
|
||||
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  _loopCount = (int)(ms / duration);</div>
|
||||
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordflow">if</span> (!_loopCount)</div>
|
||||
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  _loopCount = 1; <span class="comment">// Play the melody at least once.</span></div>
|
||||
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> }</div>
|
||||
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div>
|
||||
<div class="line"><a name="l00146"></a><span class="lineno"><a class="code" href="classMelody.html#a9fd8e0d48833d8da3cd3b3b58408b0b5"> 146</a></span> <span class="keywordtype">void</span> <a class="code" href="classMelody.html#a9fd8e0d48833d8da3cd3b3b58408b0b5" title="Starts playing the melody, or restarts it if already playing.">Melody::play</a>()</div>
|
||||
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> {</div>
|
||||
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <a class="code" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b" title="Stops playing the melody.">stop</a>();</div>
|
||||
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keywordflow">if</span> (size == 0)</div>
|
||||
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keywordflow">return</span>; <span class="comment">// No melody to play.</span></div>
|
||||
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  loopsLeft = _loopCount;</div>
|
||||
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  posn = 0;</div>
|
||||
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  playing = <span class="keyword">true</span>;</div>
|
||||
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  nextNote();</div>
|
||||
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> }</div>
|
||||
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div>
|
||||
<div class="line"><a name="l00162"></a><span class="lineno"><a class="code" href="classMelody.html#aecc9185c9cb1246e8a55521b17d72932"> 162</a></span> <span class="keywordtype">void</span> <a class="code" href="classMelody.html#aecc9185c9cb1246e8a55521b17d72932" title="Plays the melody once and then stops.">Melody::playOnce</a>()</div>
|
||||
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> {</div>
|
||||
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <a class="code" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b" title="Stops playing the melody.">stop</a>();</div>
|
||||
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="keywordflow">if</span> (size == 0)</div>
|
||||
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keywordflow">return</span>; <span class="comment">// No melody to play.</span></div>
|
||||
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  loopsLeft = 1;</div>
|
||||
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  posn = 0;</div>
|
||||
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  playing = <span class="keyword">true</span>;</div>
|
||||
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  nextNote();</div>
|
||||
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> }</div>
|
||||
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div>
|
||||
<div class="line"><a name="l00178"></a><span class="lineno"><a class="code" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b"> 178</a></span> <span class="keywordtype">void</span> <a class="code" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b" title="Stops playing the melody.">Melody::stop</a>()</div>
|
||||
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> {</div>
|
||||
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <span class="keywordflow">if</span> (!playing)</div>
|
||||
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  <span class="keywordflow">return</span>;</div>
|
||||
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  playing = <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  noTone(_pin);</div>
|
||||
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> }</div>
|
||||
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div>
|
||||
<div class="line"><a name="l00199"></a><span class="lineno"><a class="code" href="classMelody.html#adb6ad8e8cfe8c9a137e470f4e85c7254"> 199</a></span> <span class="keywordtype">void</span> <a class="code" href="classMelody.html#adb6ad8e8cfe8c9a137e470f4e85c7254" title="Sets the melody to the size elements of notes and lengths.">Melody::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)</div>
|
||||
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> {</div>
|
||||
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  <a class="code" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b" title="Stops playing the melody.">stop</a>();</div>
|
||||
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  this->notes = notes;</div>
|
||||
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  this->lengths = lengths;</div>
|
||||
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  this->size = size;</div>
|
||||
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> }</div>
|
||||
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> </div>
|
||||
<div class="line"><a name="l00214"></a><span class="lineno"><a class="code" href="classMelody.html#ad1103b970be1f59058cc7d927be68955"> 214</a></span> <span class="keywordtype">void</span> <a class="code" href="classMelody.html#ad1103b970be1f59058cc7d927be68955" title="Runs the melody control loop.">Melody::run</a>()</div>
|
||||
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> {</div>
|
||||
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  <span class="keywordflow">if</span> (!playing)</div>
|
||||
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  <span class="keywordflow">return</span>;</div>
|
||||
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  <span class="keywordflow">if</span> ((millis() - startNote) >= duration) {</div>
|
||||
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  noTone(_pin);</div>
|
||||
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  nextNote();</div>
|
||||
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  }</div>
|
||||
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> }</div>
|
||||
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> </div>
|
||||
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="keywordtype">void</span> Melody::nextNote()</div>
|
||||
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span> {</div>
|
||||
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  <span class="keywordflow">if</span> (posn >= size) {</div>
|
||||
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <span class="keywordflow">if</span> (loopsLeft != 0 && --loopsLeft <= 0) {</div>
|
||||
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  <a class="code" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b" title="Stops playing the melody.">stop</a>();</div>
|
||||
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  <span class="keywordflow">return</span>;</div>
|
||||
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  }</div>
|
||||
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  posn = 0;</div>
|
||||
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  }</div>
|
||||
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  duration = 1000 / lengths[posn];</div>
|
||||
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  <span class="keywordflow">if</span> (notes[posn] != NOTE_REST)</div>
|
||||
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  tone(_pin, notes[posn], duration);</div>
|
||||
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  ++posn;</div>
|
||||
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  duration = duration * 13 / 10; <span class="comment">// i.e., duration * 1.3</span></div>
|
||||
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  startNote = millis();</div>
|
||||
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span> }</div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated on Sun Sep 29 2013 09:30:46 for ArduinoLibs by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.1.2
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user