hyperion.ng/include/effectengine/EffectEngine.h

126 lines
3.0 KiB
C
Raw Normal View History

#pragma once
// Qt includes
#include <QObject>
#include <QString>
#include <QJsonObject>
#include <QJsonValue>
#include <QJsonDocument>
#include <QJsonArray>
// Hyperion includes
#include <hyperion/Hyperion.h>
// Effect engine includes
#include <effectengine/EffectDefinition.h>
#include <effectengine/Effect.h>
#include <effectengine/ActiveEffectDefinition.h>
#include <effectengine/EffectSchema.h>
#include <utils/Logger.h>
2018-12-31 15:48:29 +01:00
// pre-declaration
class Effect;
2018-12-31 15:48:29 +01:00
class EffectFileHandler;
class EffectEngine : public QObject
{
Q_OBJECT
public:
2018-12-31 15:48:29 +01:00
EffectEngine(Hyperion * hyperion);
~EffectEngine() override;
std::list<EffectDefinition> getEffects() const { return _availableEffects; }
std::list<ActiveEffectDefinition> getActiveEffects() const;
2018-12-31 15:48:29 +01:00
///
/// Get available schemas from EffectFileHandler
/// @return all schemas
///
std::list<EffectSchema> getEffectSchemas() const;
2018-12-31 15:48:29 +01:00
///
/// @brief Save an effect with EffectFileHandler
/// @param obj The effect args
/// @return If not empty, it contains the error
2018-12-31 15:48:29 +01:00
///
QString saveEffect(const QJsonObject& obj);
2018-12-31 15:48:29 +01:00
///
/// @brief Delete an effect by name.
/// @param effectName The effect name to delete
/// @return If not empty, it contains the error
2018-12-31 15:48:29 +01:00
///
QString deleteEffect(const QString& effectName);
2018-12-27 23:11:32 +01:00
///
/// @brief Get all init data of the running effects and stop them
///
void cacheRunningEffects();
///
/// @brief Start all cached effects, origin and smooth cfg is default
///
void startCachedEffects();
signals:
/// Emit when the effect list has been updated
void effectListUpdated();
public slots:
/// Run the specified effect on the given priority channel and optionally specify a timeout
int runEffect(const QString &effectName, int priority, int timeout = Effect::ENDLESS, const QString &origin="System");
/// Run the specified effect on the given priority channel and optionally specify a timeout
int runEffect(const QString &effectName
, const QJsonObject &args
, int priority
, int timeout = Effect::ENDLESS
, const QString &pythonScript = ""
, const QString &origin = "System"
, unsigned smoothCfg=0
, const QString &imageData = ""
);
/// Clear any effect running on the provided channel
void channelCleared(int priority);
/// Clear all effects
void allChannelsCleared();
private slots:
void effectFinished();
2018-12-31 15:48:29 +01:00
///
/// @brief is called whenever the EffectFileHandler emits updated effect list
///
void handleUpdatedEffectList();
2018-12-31 15:48:29 +01:00
private:
/// Run the specified effect on the given priority channel and optionally specify a timeout
int runEffectScript(const QString &script
,const QString &name
, const QJsonObject &args
, int priority
, int timeout = Effect::ENDLESS
, const QString &origin="System"
, unsigned smoothCfg=0
, const QString &imageData = ""
);
private:
Hyperion * _hyperion;
std::list<EffectDefinition> _availableEffects;
std::list<Effect *> _activeEffects;
2018-12-27 23:11:32 +01:00
std::list<ActiveEffectDefinition> _cachedActiveEffects;
Logger * _log;
2018-12-31 15:48:29 +01:00
// The global effect file handler
EffectFileHandler* _effectFileHandler;
};