RingTonePlayer.h

Go to the documentation of this file.

/****
 * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
 * Created 2015 by Skurydin Alexey
 * http://github.com/SmingHub/Sming
 * All files of the Sming Core are provided under the LGPL v3 license.
 *
 * Player.h - Support for playing simple ring tones
 *
 * RTTTL conversion code based on https://github.com/end2endzone/NonBlockingRTTTL
 *
 * @author Sept 2019 mikee47 <mike@sillyhouse.net>
 *
 ****/

#pragma once

#include <Timer.h>
#include <Delegate.h>
#include <Platform/Timers.h>
#include "RtttlParser.h"

namespace RingTone
{
class Player
{
public:
    using PrepareNoteDelegate = Delegate<void(unsigned frequency)>;
    using CompleteDelegate = Delegate<void()>;
    using PlayNoteDelegate = Delegate<void()>;

    Player() : totalPlayTime(NanoTime::Milliseconds, 0)
    {
    }

    ~Player()
    {
        end();
    }

    void begin(RingTone::Parser* parser);

    void end();

    bool start(unsigned delayMs = 0);

    void stop();

    void resetPlayTime()
    {
        totalPlayTime.time = 0;
        playTime.start();
    }

    bool isStarted()
    {
        return started;
    }

    void onPrepareNote(PrepareNoteDelegate delegate)
    {
        prepareNoteDelegate = delegate;
    }

    void onPlayNote(PlayNoteDelegate delegate)
    {
        playNoteDelegate = delegate;
    }

    void onComplete(CompleteDelegate delegate)
    {
        completeDelegate = delegate;
    }

    const NanoTime::Time<uint32_t> getPlayTime()
    {
        auto time = totalPlayTime;
        if(started) {
            time += playTime.elapsedTime();
        }
        return time;
    }

    unsigned getSpeed() const
    {
        return speed;
    }

    unsigned setSpeed(unsigned speed)
    {
        this->speed = std::min(std::max(speed, 10U), 250U);
        return this->speed;
    }

    unsigned adjustSpeed(int adjust)
    {
        return setSpeed(speed + adjust);
    }

protected:
    virtual void prepareNote(unsigned frequency)
    {
        if(prepareNoteDelegate) {
            prepareNoteDelegate(frequency);
        }
    }

    virtual void playNote()
    {
        if(playNoteDelegate) {
            playNoteDelegate();
        }
    }

    virtual void complete()
    {
        if(completeDelegate) {
            completeDelegate();
        }
    }

private:
    void scaleNote()
    {
        preparedNote.duration = (preparedNote.duration * 100) / speed;
    }

    void playPreparedNote();

private:
    RingTone::Parser* parser = nullptr;
    PrepareNoteDelegate prepareNoteDelegate;
    PlayNoteDelegate playNoteDelegate;
    CompleteDelegate completeDelegate;
    NanoTime::Time<uint32_t> totalPlayTime; 
    OneShotFastMs playTime;
    Timer noteTimer;
    bool started = false;
    uint8_t speed = 100;
    RingTone::NoteDef preparedNote; 
};

} // namespace RingTone