Melody.cpp

/*
 * Copyright (C) 2012 Southern Storm Software, Pty Ltd.
 *
 * 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:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * 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.
 */

#include "Melody.h"
#if defined(ARDUINO) && ARDUINO >= 100
#include <Arduino.h>
#else
#include <WProgram.h>
#endif

Melody::Melody(uint8_t pin)
    : _pin(pin)
    , playing(false)
    , _loopCount(0)
    , loopsLeft(0)
    , notes(0)
    , lengths(0)
    , size(0)
    , posn(0)
    , duration(0)
    , startNote(0)
{
}

void Melody::setLoopDuration(unsigned long ms)
{
    unsigned long duration = 0;
    for (unsigned int index = 0; index < size; ++index)
        duration += (1000 / lengths[index]) * 13 / 10;
    _loopCount = (int)(ms / duration);
    if (!_loopCount)
        _loopCount = 1;     // Play the melody at least once.
}

void Melody::play()
{
    stop();
    if (size == 0)
        return;         // No melody to play.
    loopsLeft = _loopCount;
    posn = 0;
    playing = true;
    nextNote();
}

void Melody::playOnce()
{
    stop();
    if (size == 0)
        return;         // No melody to play.
    loopsLeft = 1;
    posn = 0;
    playing = true;
    nextNote();
}

void Melody::stop()
{
    if (!playing)
        return;
    playing = false;
    noTone(_pin);
}

void Melody::setMelody(const int *notes, const uint8_t *lengths, unsigned int size)
{
    stop();
    this->notes = notes;
    this->lengths = lengths;
    this->size = size;
}

void Melody::run()
{
    if (!playing)
        return;
    if ((millis() - startNote) >= duration) {
        noTone(_pin);
        nextNote();
    }
}

void Melody::nextNote()
{
    if (posn >= size) {
        if (loopsLeft != 0 && --loopsLeft <= 0) {
            stop();
            return;
        }
        posn = 0;
    }
    duration = 1000 / lengths[posn];
    if (notes[posn] != NOTE_REST)
        tone(_pin, notes[posn], duration);
    ++posn;
    duration = duration * 13 / 10;      // i.e., duration * 1.3
    startNote = millis();
}