codec_rtttl.h

// Copyright 2025 The Aerospace Corporation.
// This file is a part of SatCat5, licensed under CERN-OHL-W v2 or later.
// Ring Tone Text Transfer Language (RTTTL) interpreter
 
#pragma once
 
#include <satcat5/log.h>
#include <satcat5/pkt_buffer.h>
#include <satcat5/polling.h>
 
// Default buffer size for a queued song.
#ifndef SATCAT5_RTTTL_BUFFER
#define SATCAT5_RTTTL_BUFFER 256
#endif
 
namespace satcat5 {
    namespace io {
        class RtttlDecoder : public satcat5::io::EventListener {
        public:
            constexpr RtttlDecoder(satcat5::io::Writeable* spkr, u64 refclk_hz)
                : m_spkr(spkr)
                , m_scale((1ull << 48) / refclk_hz)
                , m_duration(0)
                , m_octave(0)
                , m_whole_note(0)
                , m_queue(m_raw, sizeof(m_raw), 0)
                , m_raw{}
                {} // Nothing else to initialize
 
            inline void flush()
                { m_queue.clear(); }
 
            bool play(const char* src);
 
            bool play(satcat5::io::Readable* src);
 
        protected:
            void data_rcvd(satcat5::io::Readable* src) override;
            bool read_note(satcat5::io::Readable* src);
 
            satcat5::io::Writeable* const m_spkr;   
            const u64 m_scale;                      
            u32 m_duration;                         
            u32 m_octave;                           
            u32 m_whole_note;                       
            satcat5::io::PacketBuffer m_queue;      
            u8 m_raw[SATCAT5_RTTTL_BUFFER];         
        };
 
        constexpr char RTTTL_BEETHOVEN[] =
            "5thSymph:d=16,o=5,b=100:"\
            "g,g,g,4d#,4p,f,f,f,4d,4p,g,g,g,d#,g#,g#,g#,g,d#6,d#6,d#6,4c6,8p";
 
        constexpr char RTTTL_HAUNTED[] =
            "HauntHouse: d=4,o=5,b=108: 2a4, 2e, 2d#, 2b4, 2a4, 2c, 2d, 2a#4, 2e.";
 
        constexpr char RTTTL_NOKIA[] =
            "Nokia:d=4,o=5,b=225:8e6,8d6,f#,g#,8c#6,8b,d,e,8b,8a,c#,e,2a";
 
        constexpr char RTTTL_RICK[] =
            "Rick:d=8,o=4,b=225:g,a,c5,a,4e5,p,4e5,p,4.d5,4.p,g,a,c5,a,"\
            "4d5,p,4d5,p,4c5,b,4.a,g,a,c5,a,2c5,4d5,4b,4a,4.g,2d5,2.c5";
 
        constexpr char RTTTL_STARTUP[] =
            "Circles:d=16,o=6,b=180:a,a5,c,e,8a";
    }
 
    namespace log {
        class ToBeep
            : public satcat5::log::EventHandler
            , protected satcat5::poll::Timer {
        public:
            explicit ToBeep(satcat5::io::RtttlDecoder* codec);
 
            void log_event(s8 priority, unsigned nbytes, const char* msg) override;
 
            inline void set_cooldown(unsigned msec) { m_cooldown = msec; }
 
        protected:
            void timer_event() override {}
 
            // Internal state.
            satcat5::io::RtttlDecoder* const m_codec;
            unsigned m_cooldown;
            bool m_enable;
        };
    }
}