#include "macro.hpp" #include "macro-action-factory.hpp" #include "macro-condition-factory.hpp" #include "macro-dock.hpp" #include "macro-helpers.hpp" #include "plugin-state-helpers.hpp" #include "splitter-helpers.hpp" #include "sync-helpers.hpp" #include #include #undef max #include #include #include #include #include #if LIBOBS_API_VER < MAKE_SEMANTIC_VERSION(30, 0, 0) #include namespace { struct DockMapEntry { QAction *action = nullptr; QWidget *dock = nullptr; }; } // namespace static std::unordered_map dockIds; static std::mutex dockMutex; static bool obs_frontend_add_dock_by_id(const char *id, const char *title, QWidget *widget) { std::lock_guard lock(dockMutex); if (dockIds.count(id) > 0) { return false; } widget->setObjectName(id); auto dock = new QDockWidget(); dock->setWindowTitle(title); dock->setWidget(widget); dock->setFloating(true); dock->setVisible(false); dock->setFeatures(QDockWidget::DockWidgetClosable | QDockWidget::DockWidgetMovable | QDockWidget::DockWidgetFloatable); auto action = static_cast(obs_frontend_add_dock(dock)); if (!action) { return false; } dockIds[id] = {action, dock}; return true; } static void obs_frontend_remove_dock(const char *id) { std::lock_guard lock(dockMutex); auto it = dockIds.find(id); if (it == dockIds.end()) { return; } it->second.action->deleteLater(); it->second.dock->deleteLater(); dockIds.erase(it); } #endif namespace advss { static std::deque> macros; Macro::Macro(const std::string &name, const bool addHotkey) { SetName(name); if (addHotkey) { SetupHotkeys(); } _registerHotkeys = addHotkey; } Macro::~Macro() { _die = true; Stop(); ClearHotkeys(); // Keep the dock widgets in case of shutdown so they can be restored by // OBS on startup if (!OBSIsShuttingDown()) { RemoveDock(); } } std::shared_ptr Macro::CreateGroup(const std::string &name, std::vector> &children) { auto group = std::make_shared(name, false); for (auto &c : children) { c->SetParent(group); } group->_isGroup = true; group->_groupSize = children.size(); return group; } void Macro::RemoveGroup(std::shared_ptr group) { auto it = std::find(macros.begin(), macros.end(), group); if (it == macros.end()) { return; } auto size = group->GroupSize(); for (uint32_t i = 1; i <= size; i++) { auto m = std::next(it, i); (*m)->SetParent(nullptr); } macros.erase(it); } void Macro::PrepareMoveToGroup(Macro *group, std::shared_ptr item) { for (const auto &m : macros) { if (m.get() == group) { PrepareMoveToGroup(m, item); return; } } PrepareMoveToGroup(std::shared_ptr(), item); } void Macro::PrepareMoveToGroup(std::shared_ptr group, std::shared_ptr item) { if (!item) { return; } // Potentially remove from old group auto oldGroup = item->Parent(); if (oldGroup) { oldGroup->_groupSize--; } item->SetParent(group); if (group) { group->_groupSize++; } } static bool checkCondition(const std::shared_ptr &condition) { using namespace std::chrono_literals; static constexpr auto perfLogThreshold = 300ms; const auto startTime = std::chrono::high_resolution_clock::now(); const bool conditionMatched = condition->CheckCondition(); const auto endTime = std::chrono::high_resolution_clock::now(); const auto timeSpent = endTime - startTime; if (timeSpent >= perfLogThreshold) { const long int ms = std::chrono::duration_cast( timeSpent) .count(); blog(LOG_WARNING, "spent %ld ms in %s condition check of macro '%s'!", ms, condition->GetId().c_str(), condition->GetMacro()->Name().c_str()); } return conditionMatched; } bool Macro::CeckMatch(bool ignorePause) { if (_isGroup) { return false; } _matched = false; for (auto &condition : _conditions) { if (_paused && !ignorePause) { vblog(LOG_INFO, "Macro %s is paused", _name.c_str()); return false; } bool conditionMatched = checkCondition(condition); conditionMatched = condition->CheckDurationModifier(conditionMatched); const auto logicType = condition->GetLogicType(); if (logicType == Logic::Type::NONE) { vblog(LOG_INFO, "ignoring condition '%s' for '%s'", condition->GetId().c_str(), _name.c_str()); continue; } vblog(LOG_INFO, "condition %s returned %d", condition->GetId().c_str(), conditionMatched); const bool isNegativeLogicType = Logic::IsNegationType(logicType); if ((conditionMatched && !isNegativeLogicType) || (!conditionMatched && isNegativeLogicType)) { condition->EnableHighlight(); } _matched = Logic::ApplyConditionLogic( logicType, _matched, conditionMatched, _name.c_str()); } vblog(LOG_INFO, "Macro %s returned %d", _name.c_str(), _matched); _conditionSateChanged = _lastMatched != _matched; if (!_conditionSateChanged && _performActionsOnChange) { _onPreventedActionExecution = true; } _lastMatched = _matched; _lastCheckTime = std::chrono::high_resolution_clock::now(); return _matched; } bool Macro::PerformActions(bool match, bool forceParallel, bool ignorePause) { if (!_done) { vblog(LOG_INFO, "Macro %s already running", _name.c_str()); if (!_stopActionsIfNotDone) { return !forceParallel; } Stop(); vblog(LOG_INFO, "Stopped macro %s actions to rerun them", _name.c_str()); } std::function runFunc = match ? std::bind(&Macro::RunActions, this, std::placeholders::_1) : std::bind(&Macro::RunElseActions, this, std::placeholders::_1); _stop = false; _done = false; bool ret = true; if (_runInParallel || forceParallel) { if (_backgroundThread.joinable()) { _backgroundThread.join(); } _backgroundThread = std::thread( [this, runFunc, ignorePause] { runFunc(ignorePause); }); } else { ret = runFunc(ignorePause); } _lastExecutionTime = std::chrono::high_resolution_clock::now(); auto group = _parent.lock(); if (group) { group->_lastExecutionTime = _lastExecutionTime; } if (_runCount != std::numeric_limits::max()) { _runCount++; } return ret; } bool Macro::WasExecutedSince( const std::chrono::high_resolution_clock::time_point &time) const { return _lastExecutionTime > time; } bool Macro::ShouldRunActions() const { const bool hasActionsToExecute = !_paused && (_matched || _elseActions.size() > 0) && (!_performActionsOnChange || _conditionSateChanged); if (VerboseLoggingEnabled() && _performActionsOnChange && !_conditionSateChanged) { if (_matched && _actions.size() > 0) { blog(LOG_INFO, "skip actions for Macro %s (on change)", _name.c_str()); } if (!_matched && _elseActions.size() > 0) { blog(LOG_INFO, "skip else actions for Macro %s (on change)", _name.c_str()); } } return hasActionsToExecute; } int64_t Macro::MsSinceLastCheck() const { if (_lastCheckTime.time_since_epoch().count() == 0) { return 0; } const auto timePassed = std::chrono::high_resolution_clock::now() - _lastCheckTime; return std::chrono::duration_cast(timePassed) .count() + 1; } void Macro::SetName(const std::string &name) { const bool nameChanged = _name == name; _name = name; SetHotkeysDesc(); if (nameChanged) { _dockId = GenerateDockId(); } EnableDock(_registerDock); } void Macro::ResetTimers() { for (auto &c : _conditions) { c->ResetDuration(); } _lastCheckTime = {}; _lastExecutionTime = {}; } bool Macro::RunActionsHelper( const std::deque> &actionsToRun, bool ignorePause) { // Create copy of action list as elements might be removed, inserted, or // reordered while actions are currently being executed. auto actions = actionsToRun; bool actionsExecutedSuccessfully = true; for (auto &action : actions) { if (action->Enabled()) { action->LogAction(); actionsExecutedSuccessfully = actionsExecutedSuccessfully && action->PerformAction(); } else { vblog(LOG_INFO, "skipping disabled action %s", action->GetId().c_str()); } if (!actionsExecutedSuccessfully || (_paused && !ignorePause) || _stop || _die) { break; } if (action->Enabled()) { action->EnableHighlight(); } } _done = true; return actionsExecutedSuccessfully; } bool Macro::RunActions(bool ignorePause) { vblog(LOG_INFO, "running actions of %s", _name.c_str()); return RunActionsHelper(_actions, ignorePause); } bool Macro::RunElseActions(bool ignorePause) { vblog(LOG_INFO, "running else actions of %s", _name.c_str()); return RunActionsHelper(_elseActions, ignorePause); } bool Macro::WasPausedSince( const std::chrono::high_resolution_clock::time_point &time) const { return _lastUnpauseTime > time; } void Macro::SetMatchOnChange(bool onChange) { _performActionsOnChange = onChange; } void Macro::SetStopActionsIfNotDone(bool stopActionsIfNotDone) { _stopActionsIfNotDone = stopActionsIfNotDone; } void Macro::SetPaused(bool pause) { if (_paused && !pause) { _lastUnpauseTime = std::chrono::high_resolution_clock::now(); ResetTimers(); } _paused = pause; } void Macro::AddHelperThread(std::thread &&newThread) { for (unsigned int i = 0; i < _helperThreads.size(); i++) { if (!_helperThreads[i].joinable()) { _helperThreads[i] = std::move(newThread); return; } } _helperThreads.push_back(std::move(newThread)); } void Macro::Stop() { _stop = true; GetMacroWaitCV().notify_all(); for (auto &t : _helperThreads) { if (t.joinable()) { t.join(); } } if (_backgroundThread.joinable()) { _backgroundThread.join(); } } MacroInputVariables Macro::GetInputVariables() const { return _inputVariables; } void Macro::SetInputVariables(const MacroInputVariables &inputVariables) { _inputVariables = inputVariables; } std::vector Macro::GetTempVars(MacroSegment *filter) const { std::vector res; auto addTempVars = [&res](const std::deque> &segments) { for (const auto &s : segments) { const auto &tempVars = s->_tempVariables; res.insert(res.end(), tempVars.begin(), tempVars.end()); } }; addTempVars({_conditions.begin(), _conditions.end()}); addTempVars({_actions.begin(), _actions.end()}); addTempVars({_elseActions.begin(), _elseActions.end()}); if (!filter) { return res; } auto isCondition = [this](const MacroSegment *segment) -> bool { return std::find_if(_conditions.begin(), _conditions.end(), [segment]( const std::shared_ptr &ptr) { return ptr.get() == segment; }) != _conditions.end(); }; auto isAction = [this](MacroSegment *segment) -> bool { return std::find_if(_actions.begin(), _actions.end(), [segment]( const std::shared_ptr &ptr) { return ptr.get() == segment; }) != _actions.end(); }; auto isElseAction = [this](MacroSegment *segment) -> bool { return std::find_if(_elseActions.begin(), _elseActions.end(), [segment]( const std::shared_ptr &ptr) { return ptr.get() == segment; }) != _elseActions.end(); }; const int filterIndex = filter->GetIndex(); // Remove all actions and else actions and conditions after filterIndex if (isCondition(filter)) { for (auto it = res.begin(); it != res.end();) { auto segment = it->Segment().lock().get(); if (isCondition(segment) && segment->GetIndex() >= filterIndex) { it = res.erase(it); continue; } if (isAction(segment) || isElseAction(segment)) { it = res.erase(it); continue; } ++it; } return res; } // Remove all else actions and actions after filterIndex if (isAction(filter)) { for (auto it = res.begin(); it != res.end();) { auto segment = it->Segment().lock().get(); if (isAction(segment) && segment->GetIndex() >= filterIndex) { it = res.erase(it); continue; } if (isElseAction(segment)) { it = res.erase(it); continue; } ++it; } return res; } // Remove all actions and elseActions after filterIndex for (auto it = res.begin(); it != res.end();) { auto segment = it->Segment().lock().get(); if (isElseAction(segment) && segment->GetIndex() >= filterIndex) { it = res.erase(it); continue; } if (isAction(segment)) { it = res.erase(it); continue; } ++it; } return res; } std::optional Macro::GetTempVar(const MacroSegment *segment, const std::string &id) const { if (!segment) { return {}; } return segment->GetTempVar(id); } void Macro::InvalidateTempVarValues() const { auto invalidateHelper = [](const std::deque> &segments) { for (const auto &s : segments) { s->InvalidateTempVarValues(); } }; invalidateHelper({_conditions.begin(), _conditions.end()}); invalidateHelper({_actions.begin(), _actions.end()}); invalidateHelper({_elseActions.begin(), _elseActions.end()}); } std::deque> &Macro::Conditions() { return _conditions; } std::deque> &Macro::Actions() { return _actions; } std::deque> &Macro::ElseActions() { return _elseActions; } static void updateIndicesHelper(std::deque> &list) { int idx = 0; for (auto segment : list) { segment->SetIndex(idx); idx++; } } void Macro::UpdateActionIndices() { std::deque> list(_actions.begin(), _actions.end()); updateIndicesHelper(list); } void Macro::UpdateElseActionIndices() { std::deque> list(_elseActions.begin(), _elseActions.end()); updateIndicesHelper(list); } void Macro::UpdateConditionIndices() { std::deque> list(_conditions.begin(), _conditions.end()); updateIndicesHelper(list); } std::shared_ptr Macro::Parent() const { return _parent.lock(); } bool Macro::Save(obs_data_t *obj, bool saveForCopy) const { if (!saveForCopy) { obs_data_set_string(obj, "name", _name.c_str()); } obs_data_set_bool(obj, "pause", _paused); obs_data_set_bool(obj, "parallel", _runInParallel); obs_data_set_bool(obj, "onChange", _performActionsOnChange); obs_data_set_bool(obj, "skipExecOnStart", _skipExecOnStart); obs_data_set_bool(obj, "stopActionsIfNotDone", _stopActionsIfNotDone); obs_data_set_bool(obj, "group", _isGroup); if (_isGroup) { OBSDataAutoRelease groupData = obs_data_create(); obs_data_set_bool(groupData, "collapsed", _isCollapsed); obs_data_set_int(groupData, "size", _groupSize); obs_data_set_obj(obj, "groupData", groupData); return true; } SaveDockSettings(obj, saveForCopy); SaveSplitterPos(_actionConditionSplitterPosition, obj, "macroActionConditionSplitterPosition"); SaveSplitterPos(_elseActionSplitterPosition, obj, "macroElseActionSplitterPosition"); obs_data_set_bool(obj, "registerHotkeys", _registerHotkeys); OBSDataArrayAutoRelease pauseHotkey = obs_hotkey_save(_pauseHotkey); obs_data_set_array(obj, "pauseHotkey", pauseHotkey); OBSDataArrayAutoRelease unpauseHotkey = obs_hotkey_save(_unpauseHotkey); obs_data_set_array(obj, "unpauseHotkey", unpauseHotkey); OBSDataArrayAutoRelease togglePauseHotkey = obs_hotkey_save(_togglePauseHotkey); obs_data_set_array(obj, "togglePauseHotkey", togglePauseHotkey); OBSDataArrayAutoRelease conditions = obs_data_array_create(); for (auto &c : _conditions) { OBSDataAutoRelease arrayObj = obs_data_create(); c->Save(arrayObj); obs_data_array_push_back(conditions, arrayObj); } obs_data_set_array(obj, "conditions", conditions); OBSDataArrayAutoRelease actions = obs_data_array_create(); for (auto &a : _actions) { OBSDataAutoRelease arrayObj = obs_data_create(); a->Save(arrayObj); obs_data_array_push_back(actions, arrayObj); } obs_data_set_array(obj, "actions", actions); OBSDataArrayAutoRelease elseActions = obs_data_array_create(); for (auto &a : _elseActions) { OBSDataAutoRelease arrayObj = obs_data_create(); a->Save(arrayObj); obs_data_array_push_back(elseActions, arrayObj); } obs_data_set_array(obj, "elseActions", elseActions); _inputVariables.Save(obj); return true; } bool Macro::Load(obs_data_t *obj) { _name = obs_data_get_string(obj, "name"); _paused = obs_data_get_bool(obj, "pause"); _runInParallel = obs_data_get_bool(obj, "parallel"); _performActionsOnChange = obs_data_get_bool(obj, "onChange"); _skipExecOnStart = obs_data_get_bool(obj, "skipExecOnStart"); _stopActionsIfNotDone = obs_data_get_bool(obj, "stopActionsIfNotDone"); _isGroup = obs_data_get_bool(obj, "group"); if (_isGroup) { OBSDataAutoRelease groupData = obs_data_get_obj(obj, "groupData"); _isCollapsed = obs_data_get_bool(groupData, "collapsed"); _groupSize = obs_data_get_int(groupData, "size"); return true; } LoadDockSettings(obj); LoadSplitterPos(_actionConditionSplitterPosition, obj, "macroActionConditionSplitterPosition"); LoadSplitterPos(_elseActionSplitterPosition, obj, "macroElseActionSplitterPosition"); obs_data_set_default_bool(obj, "registerHotkeys", true); _registerHotkeys = obs_data_get_bool(obj, "registerHotkeys"); if (_registerHotkeys) { SetupHotkeys(); } OBSDataArrayAutoRelease pauseHotkey = obs_data_get_array(obj, "pauseHotkey"); obs_hotkey_load(_pauseHotkey, pauseHotkey); OBSDataArrayAutoRelease unpauseHotkey = obs_data_get_array(obj, "unpauseHotkey"); obs_hotkey_load(_unpauseHotkey, unpauseHotkey); OBSDataArrayAutoRelease togglePauseHotkey = obs_data_get_array(obj, "togglePauseHotkey"); obs_hotkey_load(_togglePauseHotkey, togglePauseHotkey); SetHotkeysDesc(); bool root = true; OBSDataArrayAutoRelease conditions = obs_data_get_array(obj, "conditions"); size_t count = obs_data_array_count(conditions); for (size_t i = 0; i < count; i++) { OBSDataAutoRelease arrayObj = obs_data_array_item(conditions, i); std::string id = obs_data_get_string(arrayObj, "id"); auto newEntry = MacroConditionFactory::Create(id, this); if (newEntry) { _conditions.emplace_back(newEntry); auto c = _conditions.back().get(); c->Load(arrayObj); c->ValidateLogicSelection(root, Name().c_str()); } else { blog(LOG_WARNING, "discarding condition entry with unknown id (%s) for macro %s", id.c_str(), _name.c_str()); } root = false; } UpdateConditionIndices(); OBSDataArrayAutoRelease actions = obs_data_get_array(obj, "actions"); count = obs_data_array_count(actions); for (size_t i = 0; i < count; i++) { OBSDataAutoRelease array_obj = obs_data_array_item(actions, i); std::string id = obs_data_get_string(array_obj, "id"); auto newEntry = MacroActionFactory::Create(id, this); 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()); } } UpdateActionIndices(); OBSDataArrayAutoRelease elseActions = obs_data_get_array(obj, "elseActions"); count = obs_data_array_count(elseActions); for (size_t i = 0; i < count; i++) { OBSDataAutoRelease array_obj = obs_data_array_item(elseActions, i); std::string id = obs_data_get_string(array_obj, "id"); auto newEntry = MacroActionFactory::Create(id, this); if (newEntry) { _elseActions.emplace_back(newEntry); _elseActions.back()->Load(array_obj); } else { blog(LOG_WARNING, "discarding elseAction entry with unknown id (%s) for macro %s", id.c_str(), _name.c_str()); } } UpdateElseActionIndices(); _inputVariables.Load(obj); return true; } bool Macro::PostLoad() { for (auto &c : _conditions) { c->PostLoad(); } for (auto &a : _actions) { a->PostLoad(); } for (auto &a : _elseActions) { a->PostLoad(); } return true; } bool Macro::SwitchesScene() const { for (const auto &a : _actions) { if (a->GetId() == GetSceneSwitchActionId()) { return true; } } for (const auto &a : _elseActions) { if (a->GetId() == GetSceneSwitchActionId()) { return true; } } return false; } const QList &Macro::GetActionConditionSplitterPosition() const { return _actionConditionSplitterPosition; } void Macro::SetActionConditionSplitterPosition(const QList sizes) { _actionConditionSplitterPosition = sizes; } const QList &Macro::GetElseActionSplitterPosition() const { return _elseActionSplitterPosition; } void Macro::SetElseActionSplitterPosition(const QList sizes) { _elseActionSplitterPosition = sizes; } bool Macro::HasValidSplitterPositions() const { return !_actionConditionSplitterPosition.empty() && !_elseActionSplitterPosition.empty(); } bool Macro::OnChangePreventedActionsRecently() { if (_onPreventedActionExecution) { _onPreventedActionExecution = false; return _matched ? _actions.size() > 0 : _elseActions.size() > 0; } return false; } void Macro::ResetUIHelpers() { _onPreventedActionExecution = false; for (auto c : _conditions) { c->GetHighlightAndReset(); } for (auto a : _actions) { a->GetHighlightAndReset(); } } void Macro::EnablePauseHotkeys(bool value) { if (_registerHotkeys == value) { return; } if (_registerHotkeys) { ClearHotkeys(); } else { SetupHotkeys(); } _registerHotkeys = value; } bool Macro::PauseHotkeysEnabled() const { return _registerHotkeys; } void Macro::SaveDockSettings(obs_data_t *obj, bool saveForCopy) const { auto dockSettings = obs_data_create(); obs_data_set_bool(dockSettings, "register", _registerDock); obs_data_set_bool(dockSettings, "hasRunButton", _dockHasRunButton); obs_data_set_bool(dockSettings, "hasPauseButton", _dockHasPauseButton); obs_data_set_bool(dockSettings, "hasStatusLabel", _dockHasStatusLabel); obs_data_set_bool(dockSettings, "highlightIfConditionsTrue", _dockHighlight); _runButtonText.Save(dockSettings, "runButtonText"); _pauseButtonText.Save(dockSettings, "pauseButtonText"); _unpauseButtonText.Save(dockSettings, "unpauseButtonText"); _conditionsTrueStatusText.Save(dockSettings, "conditionsTrueStatusText"); _conditionsFalseStatusText.Save(dockSettings, "conditionsFalseStatusText"); if (saveForCopy) { auto uuid = GenerateDockId(); obs_data_set_string(dockSettings, "dockId", uuid.c_str()); } else { obs_data_set_string(dockSettings, "dockId", _dockId.c_str()); } obs_data_set_int(dockSettings, "version", 1); obs_data_set_obj(obj, "dockSettings", dockSettings); obs_data_release(dockSettings); } void Macro::LoadDockSettings(obs_data_t *obj) { auto dockSettings = obs_data_get_obj(obj, "dockSettings"); if (!dockSettings) { // TODO: Remove this fallback _dockHasRunButton = obs_data_get_bool(obj, "dockHasRunButton"); _dockHasPauseButton = obs_data_get_bool(obj, "dockHasPauseButton"); EnableDock(obs_data_get_bool(obj, "registerDock")); return; } if (!obs_data_has_user_value(dockSettings, "version")) { _dockId = std::string("ADVSS-") + _name; } else { _dockId = obs_data_get_string(dockSettings, "dockId"); } const bool dockEnabled = obs_data_get_bool(dockSettings, "register"); // TODO: remove these default settings in a future version obs_data_set_default_string( dockSettings, "runButtonText", obs_module_text("AdvSceneSwitcher.macroDock.run")); obs_data_set_default_string( dockSettings, "pauseButtonText", obs_module_text("AdvSceneSwitcher.macroDock.pause")); obs_data_set_default_string( dockSettings, "unpauseButtonText", obs_module_text("AdvSceneSwitcher.macroDock.unpause")); _runButtonText.Load(dockSettings, "runButtonText"); _pauseButtonText.Load(dockSettings, "pauseButtonText"); _unpauseButtonText.Load(dockSettings, "unpauseButtonText"); _conditionsTrueStatusText.Load(dockSettings, "conditionsTrueStatusText"); _conditionsFalseStatusText.Load(dockSettings, "conditionsFalseStatusText"); if (dockEnabled) { _dockHasRunButton = obs_data_get_bool(dockSettings, "hasRunButton"); _dockHasPauseButton = obs_data_get_bool(dockSettings, "hasPauseButton"); _dockHasStatusLabel = obs_data_get_bool(dockSettings, "hasStatusLabel"); _dockHighlight = obs_data_get_bool(dockSettings, "highlightIfConditionsTrue"); } EnableDock(dockEnabled); obs_data_release(dockSettings); } void Macro::EnableDock(bool value) { // Reset dock regardless RemoveDock(); if (!value) { _registerDock = value; return; } _dock = new MacroDock(GetWeakMacroByName(_name.c_str()), _runButtonText, _pauseButtonText, _unpauseButtonText, _conditionsTrueStatusText, _conditionsFalseStatusText, _dockHighlight); if (!obs_frontend_add_dock_by_id(_dockId.c_str(), _name.c_str(), _dock)) { blog(LOG_INFO, "failed to add macro dock for macro %s", _name.c_str()); _dock->deleteLater(); _dock = nullptr; _registerDock = false; return; } _registerDock = value; } void Macro::SetDockHasRunButton(bool value) { _dockHasRunButton = value; if (!_dock) { return; } _dock->ShowRunButton(value); } void Macro::SetDockHasPauseButton(bool value) { _dockHasPauseButton = value; if (!_dock) { return; } _dock->ShowPauseButton(value); } void Macro::SetDockHasStatusLabel(bool value) { _dockHasStatusLabel = value; if (!_dock) { return; } _dock->ShowStatusLabel(value); } void Macro::SetHighlightEnable(bool value) { _dockHighlight = value; if (!_dock) { return; } _dock->EnableHighlight(value); } void Macro::SetRunButtonText(const std::string &text) { _runButtonText = text; if (!_dock) { return; } _dock->SetRunButtonText(text); } void Macro::SetPauseButtonText(const std::string &text) { _pauseButtonText = text; if (!_dock) { return; } _dock->SetPauseButtonText(text); } void Macro::SetUnpauseButtonText(const std::string &text) { _unpauseButtonText = text; if (!_dock) { return; } _dock->SetUnpauseButtonText(text); } void Macro::SetConditionsTrueStatusText(const std::string &text) { _conditionsTrueStatusText = text; if (!_dock) { return; } _dock->SetConditionsTrueText(text); } StringVariable Macro::ConditionsTrueStatusText() const { return _conditionsTrueStatusText; } void Macro::SetConditionsFalseStatusText(const std::string &text) { _conditionsFalseStatusText = text; if (!_dock) { return; } _dock->SetConditionsFalseText(text); } StringVariable Macro::ConditionsFalseStatusText() const { return _conditionsFalseStatusText; } void Macro::RemoveDock() { obs_frontend_remove_dock(_dockId.c_str()); _dock = nullptr; } std::string Macro::GenerateDockId() { #if LIBOBS_API_VER > MAKE_SEMANTIC_VERSION(30, 0, 0) auto uuid = os_generate_uuid(); auto id = std::string("advss-macro-dock-") + std::string(uuid); bfree(uuid); return id; #else static std::atomic_int16_t idCounter = 0; return std::to_string(++idCounter); #endif } static void pauseCB(void *data, obs_hotkey_id, obs_hotkey_t *, bool pressed) { if (pressed) { auto m = static_cast(data); m->SetPaused(true); } } static void unpauseCB(void *data, obs_hotkey_id, obs_hotkey_t *, bool pressed) { if (pressed) { auto m = static_cast(data); m->SetPaused(false); } } static void togglePauseCB(void *data, obs_hotkey_id, obs_hotkey_t *, bool pressed) { if (pressed) { auto m = static_cast(data); m->SetPaused(!m->Paused()); } } static int macroHotkeyID = 0; static obs_hotkey_id registerHotkeyHelper(const std::string prefix, const char *formatModuleText, Macro *macro, obs_hotkey_func func) { macroHotkeyID++; std::string hotkeyName = prefix + std::to_string(macroHotkeyID); QString format{obs_module_text(formatModuleText)}; QString hotkeyDesc = format.arg(QString::fromStdString(macro->Name())); return obs_hotkey_register_frontend(hotkeyName.c_str(), hotkeyDesc.toStdString().c_str(), func, macro); } void Macro::SetupHotkeys() { if (_pauseHotkey != OBS_INVALID_HOTKEY_ID || _unpauseHotkey != OBS_INVALID_HOTKEY_ID || _togglePauseHotkey != OBS_INVALID_HOTKEY_ID) { ClearHotkeys(); } _pauseHotkey = registerHotkeyHelper( "macro_pause_hotkey_", "AdvSceneSwitcher.hotkey.macro.pause", this, pauseCB); _unpauseHotkey = registerHotkeyHelper( "macro_unpause_hotkey_", "AdvSceneSwitcher.hotkey.macro.unpause", this, unpauseCB); _togglePauseHotkey = registerHotkeyHelper( "macro_toggle_pause_hotkey_", "AdvSceneSwitcher.hotkey.macro.togglePause", this, togglePauseCB); } void Macro::ClearHotkeys() const { obs_hotkey_unregister(_pauseHotkey); obs_hotkey_unregister(_unpauseHotkey); obs_hotkey_unregister(_togglePauseHotkey); } void setHotkeyDescriptionHelper(const char *formatModuleText, const std::string name, const obs_hotkey_id id) { QString format{obs_module_text(formatModuleText)}; QString hotkeyDesc = format.arg(QString::fromStdString(name)); obs_hotkey_set_description(id, hotkeyDesc.toStdString().c_str()); } void Macro::SetHotkeysDesc() const { setHotkeyDescriptionHelper("AdvSceneSwitcher.hotkey.macro.pause", _name, _pauseHotkey); setHotkeyDescriptionHelper("AdvSceneSwitcher.hotkey.macro.unpause", _name, _unpauseHotkey); setHotkeyDescriptionHelper("AdvSceneSwitcher.hotkey.macro.togglePause", _name, _togglePauseHotkey); } void SaveMacros(obs_data_t *obj) { obs_data_array_t *macroArray = obs_data_array_create(); for (const 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 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(std::make_shared()); macros.back()->Load(array_obj); obs_data_release(array_obj); } obs_data_array_release(macroArray); int groupCount = 0; std::shared_ptr group; std::vector> invalidGroups; for (const auto &m : macros) { if (groupCount && m->IsGroup()) { blog(LOG_ERROR, "nested group detected - will delete \"%s\"", m->Name().c_str()); invalidGroups.emplace_back(m); continue; } if (groupCount) { m->SetParent(group); groupCount--; } if (m->IsGroup()) { groupCount = m->GroupSize(); group = m; } m->PostLoad(); } if (groupCount) { blog(LOG_ERROR, "invalid group size detected - will delete \"%s\"", group->Name().c_str()); invalidGroups.emplace_back(group); } for (auto &m : invalidGroups) { auto it = std::find(macros.begin(), macros.end(), m); if (it == macros.end()) { continue; } macros.erase(it); } } std::deque> &GetMacros() { return macros; } bool CheckMacros() { bool matchFound = false; for (const auto &m : macros) { if (m->CeckMatch() || m->ElseActions().size() > 0) { matchFound = true; // This has to be performed here for now as actions are // not performed immediately after checking conditions. if (m->SwitchesScene()) { SetMacroSwitchedScene(true); } } } return matchFound; } bool RunMacros() { // Create copy of macro list as elements might be removed, inserted, or // reordered while macros are currently being executed. // For example, this can happen if a macro is performing a wait action, // as the main lock will be unlocked during this time. auto runPhaseMacros = macros; // Avoid deadlocks when opening settings window and calling frontend // API functions at the same time. // // If the timing is just right, the frontend API call will call // QMetaObject::invokeMethod(...) with Qt::BlockingQueuedConnection // while holding the main switcher mutex. // But this invokeMethod call itself will be blocked as it is waiting // the constructor of AdvSceneSwitcher() to complete. // The constructor of AdvSceneSwitcher() cannot continue however as it // cannot lock the main switcher mutex. auto lock = GetLoopLock(); if (lock) { lock->unlock(); } for (auto &m : runPhaseMacros) { if (!m || !m->ShouldRunActions()) { continue; } if (IsFirstInterval() && m->SkipExecOnStart()) { blog(LOG_INFO, "skip execution of macro \"%s\" at startup", m->Name().c_str()); continue; } vblog(LOG_INFO, "running macro: %s", m->Name().c_str()); if (!m->PerformActions(m->Matched())) { blog(LOG_WARNING, "abort macro: %s", m->Name().c_str()); } } if (lock) { lock->lock(); } return true; } void StopAllMacros() { for (const auto &m : macros) { m->Stop(); } } Macro *GetMacroByName(const char *name) { for (const auto &m : macros) { if (m->Name() == name) { return m.get(); } } return nullptr; } Macro *GetMacroByQString(const QString &name) { return GetMacroByName(name.toUtf8().constData()); } std::weak_ptr GetWeakMacroByName(const char *name) { for (const auto &m : macros) { if (m->Name() == name) { return m; } } return {}; } void InvalidateMacroTempVarValues() { for (const auto &m : macros) { m->InvalidateTempVarValues(); } } } // namespace advss