#include "headers/macro.hpp" #include "headers/macro-action-edit.hpp" #include "headers/macro-condition-edit.hpp" #include "headers/macro-action-scene-switch.hpp" #include "headers/advanced-scene-switcher.hpp" #include #undef max #include #include constexpr int perfLogThreshold = 300; const std::map MacroCondition::logicTypes = { {LogicType::NONE, {"AdvSceneSwitcher.logic.none"}}, {LogicType::AND, {"AdvSceneSwitcher.logic.and"}}, {LogicType::OR, {"AdvSceneSwitcher.logic.or"}}, {LogicType::AND_NOT, {"AdvSceneSwitcher.logic.andNot"}}, {LogicType::OR_NOT, {"AdvSceneSwitcher.logic.orNot"}}, {LogicType::ROOT_NONE, {"AdvSceneSwitcher.logic.rootNone"}}, {LogicType::ROOT_NOT, {"AdvSceneSwitcher.logic.not"}}, }; Macro::Macro(const std::string &name) { SetupHotkeys(); SetName(name); } Macro::~Macro() { ClearHotkeys(); } bool Macro::CeckMatch() { _matched = false; for (auto &c : _conditions) { auto startTime = std::chrono::high_resolution_clock::now(); bool cond = c->CheckCondition(); auto endTime = std::chrono::high_resolution_clock::now(); auto ms = std::chrono::duration_cast( endTime - startTime); if (ms.count() >= perfLogThreshold) { blog(LOG_WARNING, "spent %ld ms in %s condition check of macro '%s'!", ms.count(), c->GetId().c_str(), Name().c_str()); } if (!cond) { c->ResetDuration(); } cond = cond && c->DurationReached(); switch (c->GetLogicType()) { case LogicType::NONE: vblog(LOG_INFO, "ignoring condition check 'none' for '%s'", _name.c_str()); continue; break; case LogicType::AND: _matched = _matched && cond; break; case LogicType::OR: _matched = _matched || cond; break; case LogicType::AND_NOT: _matched = _matched && !cond; break; case LogicType::OR_NOT: _matched = _matched || !cond; break; case LogicType::ROOT_NONE: _matched = cond; break; case LogicType::ROOT_NOT: _matched = !cond; break; default: blog(LOG_WARNING, "ignoring unknown condition check for '%s'", _name.c_str()); break; } vblog(LOG_INFO, "condition %s returned %d", c->GetId().c_str(), cond); } vblog(LOG_INFO, "Macro %s returned %d", _name.c_str(), _matched); // Condition checks shall still be run even if macro is paused. // Otherwise conditions might behave in unexpected ways when resuming. // // For example, audio could immediately match after unpause, when it // matched before it was paused due to timers not being updated. if (_paused) { vblog(LOG_INFO, "Macro %s is paused", _name.c_str()); _matched = false; return false; } return _matched; } bool Macro::PerformAction() { bool ret = true; for (auto &a : _actions) { a->LogAction(); ret = ret && a->PerformAction(); if (!ret) { return false; } } if (_count != std::numeric_limits::max()) { _count++; } return ret; } void Macro::SetName(const std::string &name) { _name = name; SetHotkeysDesc(); } void Macro::UpdateActionIndices() { int idx = 0; for (auto a : _actions) { a->SetIndex(idx); idx++; } } void Macro::UpdateConditionIndices() { int idx = 0; for (auto c : _conditions) { c->SetIndex(idx); idx++; } } bool Macro::Save(obs_data_t *obj) { obs_data_set_string(obj, "name", _name.c_str()); obs_data_set_bool(obj, "pause", _paused); obs_data_array_t *pauseHotkey = obs_hotkey_save(_pauseHotkey); obs_data_set_array(obj, "pauseHotkey", pauseHotkey); obs_data_array_release(pauseHotkey); obs_data_array_t *unpauseHotkey = obs_hotkey_save(_unpauseHotkey); obs_data_set_array(obj, "unpauseHotkey", unpauseHotkey); obs_data_array_release(unpauseHotkey); obs_data_array_t *conditions = obs_data_array_create(); for (auto &c : _conditions) { obs_data_t *array_obj = obs_data_create(); c->Save(array_obj); obs_data_array_push_back(conditions, array_obj); obs_data_release(array_obj); } obs_data_set_array(obj, "conditions", conditions); obs_data_array_release(conditions); obs_data_array_t *actions = obs_data_array_create(); for (auto &a : _actions) { obs_data_t *array_obj = obs_data_create(); a->Save(array_obj); obs_data_array_push_back(actions, array_obj); obs_data_release(array_obj); } obs_data_set_array(obj, "actions", actions); obs_data_array_release(actions); return true; } bool isValidLogic(LogicType t, bool root) { bool isRoot = isRootLogicType(t); if (!isRoot == root) { return false; } if (isRoot) { if (t >= LogicType::ROOT_LAST) { return false; } } else if (t >= LogicType::LAST) { return false; } return true; } void setValidLogic(MacroCondition *c, bool root, std::string name) { if (isValidLogic(c->GetLogicType(), root)) { return; } if (root) { c->SetLogicType(LogicType::ROOT_NONE); blog(LOG_WARNING, "setting invalid logic selection to 'if' for macro %s", name.c_str()); } else { c->SetLogicType(LogicType::NONE); blog(LOG_WARNING, "setting invalid logic selection to 'ignore' for macro %s", name.c_str()); } } bool Macro::Load(obs_data_t *obj) { _name = obs_data_get_string(obj, "name"); _paused = obs_data_get_bool(obj, "pause"); obs_data_array_t *pauseHotkey = obs_data_get_array(obj, "pauseHotkey"); obs_hotkey_load(_pauseHotkey, pauseHotkey); obs_data_array_release(pauseHotkey); obs_data_array_t *unpauseHotkey = obs_data_get_array(obj, "unpauseHotkey"); obs_hotkey_load(_unpauseHotkey, unpauseHotkey); obs_data_array_release(unpauseHotkey); SetHotkeysDesc(); bool root = true; obs_data_array_t *conditions = obs_data_get_array(obj, "conditions"); size_t count = obs_data_array_count(conditions); for (size_t i = 0; i < count; i++) { obs_data_t *array_obj = obs_data_array_item(conditions, i); std::string id = obs_data_get_string(array_obj, "id"); auto newEntry = MacroConditionFactory::Create(id); if (newEntry) { _conditions.emplace_back(newEntry); auto c = _conditions.back().get(); c->Load(array_obj); setValidLogic(c, root, _name); } else { blog(LOG_WARNING, "discarding condition entry with unknown id (%s) for macro %s", id.c_str(), _name.c_str()); } obs_data_release(array_obj); root = false; } obs_data_array_release(conditions); UpdateConditionIndices(); obs_data_array_t *actions = obs_data_get_array(obj, "actions"); count = obs_data_array_count(actions); for (size_t i = 0; i < count; i++) { obs_data_t *array_obj = obs_data_array_item(actions, i); std::string id = obs_data_get_string(array_obj, "id"); auto newEntry = MacroActionFactory::Create(id); if (newEntry) { _actions.emplace_back(newEntry); _actions.back()->Load(array_obj); } else { blog(LOG_WARNING, "discarding action entry with unknown id (%s) for macro %s", id.c_str(), _name.c_str()); } obs_data_release(array_obj); } obs_data_array_release(actions); UpdateActionIndices(); return true; } void Macro::ResolveMacroRef() { for (auto &c : _conditions) { MacroRefCondition *ref = dynamic_cast(c.get()); if (ref) { ref->_macro.UpdateRef(); } } for (auto &a : _actions) { MacroRefAction *ref = dynamic_cast(a.get()); if (ref) { ref->_macro.UpdateRef(); } } } bool Macro::SwitchesScene() { MacroActionSwitchScene temp; auto sceneSwitchId = temp.GetId(); for (auto &a : _actions) { if (a->GetId() == sceneSwitchId) { return true; } } return false; } static void pauseCB(void *data, obs_hotkey_id id, obs_hotkey_t *hotkey, bool pressed) { UNUSED_PARAMETER(id); UNUSED_PARAMETER(data); UNUSED_PARAMETER(hotkey); if (pressed) { auto m = static_cast(data); m->SetPaused(true); } } static void unpauseCB(void *data, obs_hotkey_id id, obs_hotkey_t *hotkey, bool pressed) { UNUSED_PARAMETER(id); UNUSED_PARAMETER(data); UNUSED_PARAMETER(hotkey); if (pressed) { auto m = static_cast(data); m->SetPaused(false); } } static int macroHotkeyID = 0; void Macro::SetupHotkeys() { if (_pauseHotkey != OBS_INVALID_HOTKEY_ID || _unpauseHotkey != OBS_INVALID_HOTKEY_ID) { ClearHotkeys(); } macroHotkeyID++; std::string hotkeyName = "macro_pause_hotkey_" + std::to_string(macroHotkeyID); QString format{obs_module_text("AdvSceneSwitcher.hotkey.macro.pause")}; QString hotkeyDesc = format.arg(QString::fromStdString(_name)); _pauseHotkey = obs_hotkey_register_frontend( hotkeyName.c_str(), hotkeyDesc.toStdString().c_str(), pauseCB, this); macroHotkeyID++; hotkeyName = "macro_pause_hotkey_" + _name; format = {obs_module_text("AdvSceneSwitcher.hotkey.macro.unpause")}; hotkeyDesc = format.arg(QString::fromStdString(_name)); _unpauseHotkey = obs_hotkey_register_frontend( hotkeyName.c_str(), hotkeyDesc.toStdString().c_str(), unpauseCB, this); } void Macro::ClearHotkeys() { obs_hotkey_unregister(_pauseHotkey); obs_hotkey_unregister(_unpauseHotkey); } void Macro::SetHotkeysDesc() { QString format{obs_module_text("AdvSceneSwitcher.hotkey.macro.pause")}; QString hotkeyDesc = format.arg(QString::fromStdString(_name)); obs_hotkey_set_description(_pauseHotkey, hotkeyDesc.toStdString().c_str()); format = {obs_module_text("AdvSceneSwitcher.hotkey.macro.unpause")}; hotkeyDesc = format.arg(QString::fromStdString(_name)); obs_hotkey_set_description(_unpauseHotkey, hotkeyDesc.toStdString().c_str()); } bool MacroCondition::Save(obs_data_t *obj) { MacroSegment::Save(obj); obs_data_set_string(obj, "id", GetId().c_str()); obs_data_set_int(obj, "logic", static_cast(_logic)); _duration.Save(obj); return true; } bool MacroCondition::Load(obs_data_t *obj) { MacroSegment::Load(obj); _logic = static_cast(obs_data_get_int(obj, "logic")); _duration.Load(obj); return true; } void MacroCondition::SetDurationConstraint(const DurationConstraint &dur) { _duration = dur; } void MacroCondition::SetDurationCondition(DurationCondition cond) { _duration.SetCondition(cond); } void MacroCondition::SetDurationUnit(DurationUnit u) { _duration.SetUnit(u); } void MacroCondition::SetDuration(double seconds) { _duration.SetValue(seconds); } bool MacroAction::Save(obs_data_t *obj) { MacroSegment::Save(obj); obs_data_set_string(obj, "id", GetId().c_str()); return true; } bool MacroAction::Load(obs_data_t *obj) { MacroSegment::Load(obj); return true; } void MacroAction::LogAction() { vblog(LOG_INFO, "performed action %s", GetId().c_str()); } void SwitcherData::saveMacros(obs_data_t *obj) { obs_data_array_t *macroArray = obs_data_array_create(); for (auto &m : macros) { obs_data_t *array_obj = obs_data_create(); m.Save(array_obj); obs_data_array_push_back(macroArray, array_obj); obs_data_release(array_obj); } obs_data_set_array(obj, "macros", macroArray); obs_data_array_release(macroArray); } void SwitcherData::loadMacros(obs_data_t *obj) { macros.clear(); obs_data_array_t *macroArray = obs_data_get_array(obj, "macros"); size_t count = obs_data_array_count(macroArray); for (size_t i = 0; i < count; i++) { obs_data_t *array_obj = obs_data_array_item(macroArray, i); macros.emplace_back(); macros.back().Load(array_obj); obs_data_release(array_obj); } obs_data_array_release(macroArray); for (auto &m : macros) { m.ResolveMacroRef(); } } bool SwitcherData::checkMacros() { bool ret = false; for (auto &m : macros) { if (m.CeckMatch()) { ret = true; // This has to be performed here for now as actions are // not performed immediately after checking conditions. if (m.SwitchesScene()) { switcher->macroSceneSwitched = true; } } } return ret; } bool SwitcherData::runMacros() { for (auto m : macros) { if (m.Matched()) { vblog(LOG_INFO, "running macro: %s", m.Name().c_str()); if (!m.PerformAction()) { blog(LOG_WARNING, "abort macro: %s", m.Name().c_str()); return false; } } } return true; } Macro *GetMacroByName(const char *name) { for (auto &m : switcher->macros) { if (m.Name() == name) { return &m; } } return nullptr; } Macro *GetMacroByQString(const QString &name) { return GetMacroByName(name.toUtf8().constData()); } MacroRef::MacroRef(std::string name) : _name(name) { UpdateRef(); } void MacroRef::UpdateRef() { _ref = GetMacroByName(_name.c_str()); } void MacroRef::UpdateRef(std::string newName) { _name = newName; UpdateRef(); } void MacroRef::UpdateRef(QString newName) { _name = newName.toStdString(); UpdateRef(); } void MacroRef::Save(obs_data_t *obj) { if (_ref) { obs_data_set_string(obj, "macro", _ref->Name().c_str()); } } void MacroRef::Load(obs_data_t *obj) { _name = obs_data_get_string(obj, "macro"); UpdateRef(); } Macro *MacroRef::get() { return _ref; } Macro *MacroRef::operator->() { return _ref; } void MacroRefCondition::ResolveMacroRef() { _macro.UpdateRef(); } void MacroRefAction::ResolveMacroRef() { _macro.UpdateRef(); }