hyperion.ng/include/hyperion/Hyperion.h

#pragma once

// stl includes
#include <list>
#include <map>

// QT includes
#include <QObject>
#include <QTimer>

// hyperion-utils includes
#include <utils/Image.h>
#include <utils/ColorRgb.h>
#include <utils/Logger.h>

// Hyperion includes
#include <hyperion/LedString.h>
#include <hyperion/PriorityMuxer.h>
#include <hyperion/ColorTransform.h>
#include <hyperion/ColorCorrection.h>
#include <hyperion/ColorAdjustment.h>
#include <hyperion/MessageForwarder.h>

// Effect engine includes
#include <effectengine/EffectDefinition.h>
#include <effectengine/ActiveEffectDefinition.h>

// Forward class declaration
class LedDevice;
class ColorTransform;
class EffectEngine;
class HsvTransform;
class HslTransform;
class RgbChannelTransform;
class RgbChannelCorrection;
class RgbChannelAdjustment;
class MultiColorTransform;
class MultiColorCorrection;
class MultiColorAdjustment;
///
/// The main class of Hyperion. This gives other 'users' access to the attached LedDevice through
/// the priority muxer.
///
class Hyperion : public QObject
{
	Q_OBJECT
public:
	///  Type definition of the info structure used by the priority muxer
	typedef PriorityMuxer::InputInfo InputInfo;
	typedef std::map<std::string,int> PriorityRegister;

	///
	/// RGB-Color channel enumeration
	///
	enum RgbChannel
	{
		RED, GREEN, BLUE, INVALID
	};

	///
	/// Enumeration of the possible color (color-channel) transforms
	///
	enum Transform
	{
		SATURATION_GAIN, VALUE_GAIN, THRESHOLD, GAMMA, BLACKLEVEL, WHITELEVEL
	};

	///
	/// Destructor; cleans up resourcess
	///
	~Hyperion();


	static Hyperion* initInstance(const Json::Value& jsonConfig, const std::string configFile);
	static Hyperion* getInstance();

	///
	/// Returns the number of attached leds
	///
	unsigned getLedCount() const;
	
	///
	/// Returns the current priority
	///
	/// @return The current priority
	///
	int getCurrentPriority() const;
	///
	/// Returns a list of active priorities
	///
	/// @return The list with priorities
	///
	QList<int> getActivePriorities() const;

	///
	/// Returns the information of a specific priorrity channel
	///
	/// @param[in] priority  The priority channel
	///
	/// @return The information of the given
	///
	/// @throw std::runtime_error when the priority channel does not exist
	///
	const InputInfo& getPriorityInfo(const int priority) const;

	/// Get the list of available effects
	/// @return The list of available effects
	const std::list<EffectDefinition> &getEffects() const;
	
	/// Get the list of active effects
	/// @return The list of active effects
	const std::list<ActiveEffectDefinition> &getActiveEffects();
	
	/// gets the current json config object
	/// @return json config
	const Json::Value& getJsonConfig() { return _jsonConfig; };

	/// get filename of configfile
	/// @return the current config filename
	std::string getConfigFileName() { return _configFile; };

	/// register a input source to a priority channel
	/// @param name uniq name of input source
	/// @param priority priority channel
	void registerPriority(const std::string name, const int priority);
	
	/// unregister a input source to a priority channel
	/// @param name uniq name of input source
	void unRegisterPriority(const std::string name);
	
	const PriorityRegister& getPriorityRegister() { return _priorityRegister; }
public slots:
	///
	/// Writes a single color to all the leds for the given time and priority
	///
	/// @param[in] priority The priority of the written color
	/// @param[in] ledColor The color to write to the leds
	/// @param[in] timeout_ms The time the leds are set to the given color [ms]
	///
	void setColor(int priority, const ColorRgb &ledColor, const int timeout_ms, bool clearEffects = true);

	///
	/// Writes the given colors to all leds for the given time and priority
	///
	/// @param[in] priority The priority of the written colors
	/// @param[in] ledColors The colors to write to the leds
	/// @param[in] timeout_ms The time the leds are set to the given colors [ms]
	///
	void setColors(int priority, const std::vector<ColorRgb> &ledColors, const int timeout_ms, bool clearEffects = true);

	///
	/// Returns the list with unique transform identifiers
	/// @return The list with transform identifiers
	///
	const std::vector<std::string> & getTransformIds() const;
	
	///
	/// Returns the list with unique correction identifiers
	/// @return The list with correction identifiers
	///
	const std::vector<std::string> & getTemperatureIds() const;
	
	///
	/// Returns the list with unique adjustment identifiers
	/// @return The list with adjustment identifiers
	///
	const std::vector<std::string> & getAdjustmentIds() const;
	
	///
	/// Returns the ColorTransform with the given identifier
	/// @return The transform with the given identifier (or nullptr if the identifier does not exist)
	///
	ColorTransform * getTransform(const std::string& id);
	
	///
	/// Returns the ColorCorrection with the given identifier
	/// @return The correction with the given identifier (or nullptr if the identifier does not exist)
	///
	ColorCorrection * getTemperature(const std::string& id);
	
	///
	/// Returns the ColorAdjustment with the given identifier
	/// @return The adjustment with the given identifier (or nullptr if the identifier does not exist)
	///
	ColorAdjustment * getAdjustment(const std::string& id);
	
	///
	/// Returns  MessageForwarder Object
	/// @return instance of message forwarder object
	///
	MessageForwarder * getForwarder();

	/// Tell Hyperion that the transforms have changed and the leds need to be updated
	void transformsUpdated();
	
	/// Tell Hyperion that the corrections have changed and the leds need to be updated
	void correctionsUpdated();
	
	/// Tell Hyperion that the corrections have changed and the leds need to be updated
	void temperaturesUpdated();

	/// Tell Hyperion that the corrections have changed and the leds need to be updated
	void adjustmentsUpdated();

	///
	/// Clears the given priority channel. This will switch the led-colors to the colors of the next
	/// lower priority channel (or off if no more channels are set)
	///
	/// @param[in] priority  The priority channel
	///
	void clear(int priority);

	///
	/// Clears all priority channels. This will switch the leds off until a new priority is written.
	///
	void clearall();

	/// Run the specified effect on the given priority channel and optionally specify a timeout
	/// @param effectName Name of the effec to run
	///	@param priority The priority channel of the effect
	/// @param timout The timeout of the effect (after the timout, the effect will be cleared)
	int setEffect(const std::string & effectName, int priority, int timeout = -1);

	/// Run the specified effect on the given priority channel and optionally specify a timeout
	/// @param effectName Name of the effec to run
	/// @param args arguments of the effect script
	///	@param priority The priority channel of the effect
	/// @param timout The timeout of the effect (after the timout, the effect will be cleared)
	int setEffect(const std::string & effectName, const Json::Value & args, int priority, int timeout = -1);

public:
	static Hyperion *_hyperion;

	static ColorOrder createColorOrder(const Json::Value & deviceConfig);
	/**
	 * Construct the 'led-string' with the integration area definition per led and the color
	 * ordering of the RGB channels
	 * @param ledsConfig   The configuration of the led areas
	 * @param deviceOrder  The default RGB channel ordering
	 * @return The constructed ledstring
	 */
	static LedString createLedString(const Json::Value & ledsConfig, const ColorOrder deviceOrder);

	static MultiColorTransform * createLedColorsTransform(const unsigned ledCnt, const Json::Value & colorTransformConfig);
	static MultiColorCorrection * createLedColorsTemperature(const unsigned ledCnt, const Json::Value & colorTemperatureConfig);
	static MultiColorAdjustment * createLedColorsAdjustment(const unsigned ledCnt, const Json::Value & colorAdjustmentConfig);
	static ColorTransform * createColorTransform(const Json::Value & transformConfig);
	static ColorCorrection * createColorCorrection(const Json::Value & correctionConfig);
	static ColorAdjustment * createColorAdjustment(const Json::Value & adjustmentConfig);
	static HsvTransform * createHsvTransform(const Json::Value & hsvConfig);
	static HslTransform * createHslTransform(const Json::Value & hslConfig);
	static RgbChannelTransform * createRgbChannelTransform(const Json::Value& colorConfig);
	static RgbChannelAdjustment * createRgbChannelCorrection(const Json::Value& colorConfig);
	static RgbChannelAdjustment * createRgbChannelAdjustment(const Json::Value& colorConfig, const RgbChannel color);

	static LedDevice * createColorSmoothing(const Json::Value & smoothingConfig, LedDevice * ledDevice);
	static MessageForwarder * createMessageForwarder(const Json::Value & forwarderConfig);
	
signals:
	/// Signal which is emitted when a priority channel is actively cleared
	/// This signal will not be emitted when a priority channel time out
	void channelCleared(int priority);

	/// Signal which is emitted when all priority channels are actively cleared
	/// This signal will not be emitted when a priority channel time out
	void allChannelsCleared();

private slots:
	///
	/// Updates the priority muxer with the current time and (re)writes the led color with applied
	/// transforms.
	///
	void update();

private:
	
	///
	/// Constructs the Hyperion instance based on the given Json configuration
	///
	/// @param[in] jsonConfig The Json configuration
	///
	Hyperion(const Json::Value& jsonConfig, const std::string configFile);

	/// The specifiation of the led frame construction and picture integration
	LedString _ledString;

	/// The priority muxer
	PriorityMuxer _muxer;

	/// The transformation from raw colors to led colors
	MultiColorTransform * _raw2ledTransform;
	
	/// The temperature from raw colors to led colors
	MultiColorCorrection * _raw2ledTemperature;
	
	/// The adjustment from raw colors to led colors
	MultiColorAdjustment * _raw2ledAdjustment;
	
	/// The actual LedDevice
	LedDevice * _device;

	/// Effect engine
	EffectEngine * _effectEngine;
	
	// proto and json Message forwarder
	MessageForwarder * _messageForwarder;

	// json configuration
	const Json::Value& _jsonConfig;

	// the name of config file
	std::string _configFile;

	/// The timer for handling priority channel timeouts
	QTimer _timer;
	
	/// buffer for leds
	std::vector<ColorRgb> _ledBuffer;
	
	/// Logger instance
	Logger * _log;
	
	/// count of hardware leds
	unsigned _hwLedCount;
	
	/// register of input sources and it's prio channel
	PriorityRegister _priorityRegister;
};