RingTone.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.
 *
 * Parser.h - Common definitions for playing ringtones
 *
 * @author Sept 2019 mikee47 <mike@sillyhouse.net>
 *
 ****/

#pragma once

#include <cstdint>
#include <cmath>

namespace RingTone
{
enum class Note {
    MUTE,
    C,
    C_Sharp,
    D_Flat = C_Sharp,
    D,
    D_Sharp,
    E_Flat = D_Sharp,
    E,
    F,
    F_Sharp,
    G,
    G_Sharp,
    A_Flat = G_Sharp,
    A,
    A_Sharp,
    B_Flat = A_Sharp,
    B,
};

struct NoteDef {
    uint16_t frequency;
    uint16_t duration;
};

static unsigned noteFrequencyA4 = 440;

static constexpr float frequencyRoot = pow(2, 1.0 / 12);

template <unsigned octave, unsigned note> static constexpr unsigned calculateFrequency()
{
    return round(noteFrequencyA4 * pow(frequencyRoot, (octave - 4) * 12 + (note - 1)));
}

unsigned charToNoteValue(char c);

unsigned getNoteFrequency(unsigned octave, unsigned note);

unsigned getClosestNote(unsigned frequency, unsigned& octave);

const char* getNoteName(unsigned noteValue);

class Parser
{
public:
    virtual ~Parser()
    {
    }

    virtual bool readNextNote(NoteDef& note) = 0;
};

} // namespace RingTone