InputMgr.hpp

Go to the documentation of this file.

#pragma once
/*
* InputMgr.hpp - Input Management class
*
* Project: ESPixelStick - An ESP8266 / ESP32 and E1.31 based pixel driver
* Copyright (c) 2021, 2025 Shelby Merrick
* http://www.forkineye.com
*
*  This program is provided free for you to use in any way that you wish,
*  subject to the laws and regulations where you are using it.  Due diligence
*  is strongly suggested before using this code.  Please give credit where due.
*
*  The Author makes no warranty of any kind, express or implied, with regard
*  to this program or the documentation contained in this document.  The
*  Author shall not be liable in any event for incidental or consequential
*  damages in connection with, or arising out of, the furnishing, performance
*  or use of these programs.
*
*   This is a factory class used to manage the input channels. It creates and deletes
*   the input channel functionality as needed to support any new configurations
*   that get sent from from the WebPage.
*
*/
 
#include "ESPixelStick.h"
#include "FileMgr.hpp"
#include "output/OutputMgr.hpp"
#include "externalInput.h"
#include <TimeLib.h>
#include <Ticker.h>
 
class c_InputCommon; 
 
class c_InputMgr
{
public:
    // handles to determine which input channel we are dealing with
    // Channel 1 = primary / show input; Channel 2 = service input
    enum e_InputChannelIds
    {
        InputPrimaryChannelId = 0,
        InputSecondaryChannelId = 1,
        InputChannelId_End,
        InputChannelId_Start = InputPrimaryChannelId,
        InputChannelId_ALL = InputChannelId_End,
        EffectsChannel = InputSecondaryChannelId
    };
 
    c_InputMgr ();
    virtual ~c_InputMgr ();
 
    void Begin                (uint32_t BufferSize);
    void LoadConfig           ();
    void ScheduleLoadConfig   () {ConfigLoadNeeded = now();}
    void GetConfig            (byte * Response, uint32_t maxlen);
    void GetStatus            (JsonObject & jsonStatus);
    void SetConfig            (const char * NewConfig);
    void SetConfig            (ArduinoJson::JsonDocument & NewConfig);
    void Process              ();
    void SetBufferInfo        (uint32_t BufferSize);
    void SetOperationalState  (bool Active);
    void NetworkStateChanged  (bool IsConnected);
    void DeleteConfig         () { FileMgr.DeleteFlashFile (ConfigFileName); }
    bool GetNetworkState      () { return IsConnected; }
    void GetDriverName        (String & Name) { Name = "InputMgr"; }
    void RestartBlankTimer    (e_InputChannelIds Selector) { BlankEndTime[int(Selector)].StartTimer(config.BlankDelay * 1000, false); }
    bool BlankTimerHasExpired (e_InputChannelIds Selector) { return (BlankEndTime[int(Selector)].IsExpired()); }
    void ProcessButtonActions (c_ExternalInput::InputValue_t value);
    bool RemotePlayEnabled    (void);
 
    enum e_InputType
    {
        InputType_E1_31 = 0,
        InputType_Effects,
        InputType_MQTT,
        InputType_Alexa,
        InputType_DDP,
#ifdef SUPPORT_FPP
        InputType_FPP,
#endif // def SUPPORT_FPP
        InputType_Artnet,
        InputType_Disabled,
        InputType_End,
        InputType_Start = InputType_E1_31,
        InputType_Default = InputType_Disabled,
    };
 
private:
 
    void InstantiateNewInputChannel (e_InputChannelIds InputChannelId, e_InputType NewChannelType, bool StartDriver = true);
    void CreateNewConfig ();
    struct DriverInfo_t
    {
        uint32_t DriverId = 0;
        c_InputCommon * pInputChannelDriver = nullptr; 
    };
 
    #define NO_CONFIG_NEEDED time_t(-1)
    #define INPUTMGR_TASK_PRIORITY 5
 
    DriverInfo_t    InputChannelDrivers[InputChannelId_End]; 
    uint32_t        InputDataBufferSize = 0;
    bool            HasBeenInitialized  = false;
    c_ExternalInput ExternalInput;
    bool            EffectEngineIsConfiguredToRun[InputChannelId_End];
    bool            IsConnected         = false;
    bool            configInProgress    = false;
    time_t          ConfigLoadNeeded    = NO_CONFIG_NEEDED;
    bool            PauseProcessing     = false;
 
    // configuration parameter names for the channel manager within the config file
#   define IM_EffectsControlButtonName F ("ecb")
 
    bool ProcessJsonConfig           (JsonObject & jsonConfig);
    void CreateJsonConfig            (JsonObject & jsonConfig);
    bool ProcessJsonChannelConfig    (JsonObject & jsonConfig, uint32_t ChannelIndex);
    bool InputTypeIsAllowedOnChannel (e_InputType type, e_InputChannelIds ChannelId);
    bool FindJsonChannelConfig       (JsonObject& jsonConfig, e_InputChannelIds ChanId, JsonObject& ChanConfig);
 
    String ConfigFileName;
    String InputRebootReason = emptyString;
    bool   RebootNeeded = false;
 
    FastTimer BlankEndTime[InputChannelId_End];
 
#   define    FPP_TICKER_PERIOD_MS 25
    Ticker    MsTicker;
    uint32_t  LastTickerTimeStampMS = 0;
 
}; // c_InputMgr
 
extern c_InputMgr InputMgr;