ir_codec.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2026 M5Stack Technology CO LTD
 *
 * SPDX-License-Identifier: MIT
 */
#ifndef M5_UNIT_INFRARED_IR_CODEC_HPP
#define M5_UNIT_INFRARED_IR_CODEC_HPP
 
#include <M5UnitComponent.hpp>
#include <cstdint>
#include <vector>
 
namespace m5 {
namespace unit {
namespace ir {
 
enum class CodecType : uint8_t {
    NEC = 0,     
    SIRC,        
    RC5,         
    RC6,         
    Panasonic,   
    Mitsubishi,  
    Raw,         
    // Built-in protocol IDs 7..253 are reserved.
    Unknown = 254,  
    Custom  = 255,  
};
 
struct DecodeResult {
    CodecType protocol{CodecType::Unknown};  
    uint16_t address{};                      
    uint16_t command{};                      
    uint64_t raw{};                          
    uint8_t bits{};                          
    bool repeat{};                           
    bool toggle{};                           
};
 
using item_container_type = std::vector<m5::unit::gpio::m5_rmt_item_t>;  
 
class IRCodec {
public:
    explicit IRCodec(const CodecType t) : _type(t)
    {
    }
    virtual ~IRCodec() = default;
 
    CodecType type() const
    {
        return _type;
    }
 
 
    virtual item_container_type encode(uint16_t address, uint16_t command, bool repeat = false) = 0;
 
    virtual uint32_t carrierFrequencyHz() const = 0;
 
    virtual float carrierDuty() const
    {
        return 0.33f;
    }
 
    virtual uint8_t minFrames() const
    {
        return 1;
    }
 
    virtual uint16_t frameGapUs() const
    {
        return 0;
    }
 
 
    virtual bool decode(const m5::unit::gpio::m5_rmt_item_t* items, uint32_t num, DecodeResult& result) = 0;
 
private:
    CodecType _type;
};
 
}  // namespace ir
}  // namespace unit
}  // namespace m5
#endif