WarmUpTill · WarmUpTill · Mar 2, 2024 · Feb 27, 2024 · Mar 2, 2024 · Mar 2, 2024
diff --git a/BUILDING.md b/BUILDING.md
@@ -4,11 +4,13 @@ You have the option to ...
 - either add the plugin to the OBS source tree directly and build the plugin while building OBS itself. (**in tree**)
 - or you can move the sources of this plugin outside of the OBS source tree and build it separately from OBS. (**out of tree**)
 
-As both methods require you to have a working [OBS Studio development environment](https://obsproject.com/wiki/Building-OBS-Studio) and [CMake](https://cmake.org/download/) it is recommended to build the plugin in tree as it is easier to set up and will enable straightforward debugging.
+Both methods require [CMake](https://cmake.org/download/).
 
-The plugin can be compiled for OBS 25 and above, although using the latest version of OBS is recommended to support all features.
+The plugin can be compiled for OBS 27 and above, although using the latest version of OBS is recommended to support all features.
 
 ## Compiling in tree (recommended for development)
+This section assumes that you have a working [OBS Studio development environment](https://obsproject.com/wiki/Building-OBS-Studio).  
+
 Add the "SceneSwitcher" source directory to your obs-studio source directory under obs-studio/UI/frontend-plugins/:
 ```
 cd obs-studio/UI/frontend-plugins/
@@ -46,12 +48,12 @@ cmake -DOpenCV_DIR="C:/Users/BuildUser/Documents/OBS/opencv/build/" -DLeptonica_
 First you will need to clone the plugin sources by running the following command:
 ```
 git clone --recursive https://github.com/WarmUpTill/SceneSwitcher.git
-cd SceneSwitcher
 ```
 
-Next you will need [CMake](https://cmake.org/download/) and run the command with suitable arguments for your particular platform.   
+Next you will need [CMake](https://cmake.org/download/) and run it with suitable arguments for your particular platform.   
 For example, on Windows you might want to run this command:
 ```
+cd SceneSwitcher
 cmake --preset windows-x64
 ```
 Next, you can build the plugin and install the files into a folder named release using the following commands:
@@ -72,7 +74,7 @@ cd SceneSwitcher
 cmake -DOpenCV_DIR="C:/Users/BuildUser/Documents/OBS/opencv/build/" -DLeptonica_DIR="C:/Users/BuildUser/Documents/OBS/leptonica/build" -DTesseract_DIR="C:/Users/BuildUser/Documents/OBS/tesseract/build/lib/cmake/tesseract" --preset windows-x64
 ```
 
-You can rely on the CI scripts to build the dependencies for you, although it is not guaranteed that they will work in every environment:
+You can rely on the CI scripts to build the dependencies for you, although it is not guaranteed that they will function in every environment:
 
 | Platform      | Command |
 | ----------- | ----------- |
@@ -83,10 +85,10 @@ You can rely on the CI scripts to build the dependencies for you, although it is
 
 # Contributing
 
-Contributions to the plugin are always welcome and if you need any assistance do not hesitate to reach out.
+Contributions to the plugin are always welcome and if you need any assistance do not hesitate to reach out!
 
 If you would like to expand upon the macro system by adding a new condition or action type have a look at the examples in `plugins/base`.  
-In general changes in the `lib/legacy` folder should be avoided.  
+In general changes in the `lib/legacy` folder should be avoided, if possible.  
 
 ## Macro condition
 Macro conditions should inherit from the `MacroCondition` class and must implement the following functions:
@@ -97,12 +99,12 @@ public:
     MacroConditionExample(Macro *m) : MacroCondition(m) {}
     // This function should perform the condition check
     bool CheckCondition();
-    // This function should store the required condition data to "obj"
+    // This function should store the required condition data to "data"
     // For example called on OBS shutdown
-    bool Save(obs_data_t *obj);
-    // This function should load the condition data from "obj"
+    bool Save(obs_data_t *data);
+    // This function should load the condition data from "data"
     // For example called on OBS startup
-    bool Load(obs_data_t *obj);
+    bool Load(obs_data_t *data);
     // This function should return a unique id for this condition type
     // The _id is defined below
     std::string GetId() { return _id; };
@@ -120,7 +122,7 @@ private:
     static const std::string _id;
 };
 ```
-When defining the widget used to control the settings of the condition type, it is important to add a static `Create()` method.  
+When defining the widget used to control the settings of the condition type, a static `Create()` method is required.  
 It will be called whenever a new condition MacroConditionExample is created. (See `MacroConditionFactory::Register()`)  
 ```
 class MacroConditionExampleEdit : public QWidget {
@@ -151,7 +153,7 @@ bool MacroConditionExample::_registered = MacroConditionFactory::Register(
     MacroConditionExample::id,                  // Unique string identifying this condition type
     {
         MacroConditionExample::Create,          // Function called to create the object performing the condition
-        MacroConditionExampleEdit::Create,      // Function called to create the widget configure the condition
+        MacroConditionExampleEdit::Create,      // Function called to create the widget to configure the settings
         "AdvSceneSwitcher.condition.example",   // User facing name of the condition type (will be translated)
         true                                    // Condition type supports duration modifiers (default true)
     }
@@ -167,16 +169,18 @@ The differences are highlighted in the comments below.
 class MacroActionExample : public MacroAction {
 public:
     MacroActionExample(Macro *m) : MacroAction(m) {}
+    static std::shared_ptr<MacroAction> Create(Macro *m);
+    // Used to create a copy of the action (used for action queues)
+    std::shared_ptr<MacroAction> Copy() const;
     // This function should perform the action
     // If false is returned the macro will aborted
     bool PerformAction();
-    bool Save(obs_data_t *obj);
-    bool Load(obs_data_t *obj);
+    bool Save(obs_data_t *data);
+    bool Load(obs_data_t *data);
     std::string GetId() { return _id; };
-    static std::shared_ptr<MacroAction> Create(Macro *m)
-    {
-        return std::make_shared<MacroActionExample>(m);
-    }
+    // Optional: 
+    // Might be called when action is inserted to action queue
+    void ResolveVariablesToFixedValues();
 
 private:
     static bool _registered;
@@ -207,11 +211,11 @@ MacroActionFactory::Register(
     MacroActionExample::id,                 // Unique string identifying this action type
     {
         MacroActionExample::Create,         // Function called to create the object performing the action
-        MacroActionExampleEdit::Create,     // Function called to create the widget configure the action
+        MacroActionExampleEdit::Create,     // Function called to create the widget to configure the settings
         "AdvSceneSwitcher.action.example"   // User facing name of the action type
     }
 );
 ```
 ## External dependencies
-If your intention is to add macro functionality which depends on external libraries, which is likely not to exist on all user setups, have a look at the folders in the `plugins/` directory, which are not named base.  
-For example `plugins/video` will only be loaded if the `OpenCV` dependencies are met.
+If your intention is to add macro functionality which depends on external libraries, which might not exist on all user environments, have a look at the folders in the `plugins/` directory, which are not named `base`. 
+For example, `plugins/video` will only be loaded if the `OpenCV` dependencies are met.
diff --git a/data/locale/en-US.ini b/data/locale/en-US.ini
@@ -26,6 +26,10 @@ AdvSceneSwitcher.generalTab.generalBehavior.onNoMet.switchToRandom="Switch to an
 AdvSceneSwitcher.generalTab.generalBehavior.onNoMet.switchTo="Switch to:"
 AdvSceneSwitcher.generalTab.generalBehavior.cooldown="After performing actions skip performing actions for"
 AdvSceneSwitcher.generalTab.generalBehavior.cooldownHint="During this time potential matches will be ignored!"
+AdvSceneSwitcher.generalTab.generalBehavior.logLevel="Log level:"
+AdvSceneSwitcher.generalTab.generalBehavior.logLevel.default="Default"
+AdvSceneSwitcher.generalTab.generalBehavior.logLevel.printActions="Log performed actions"
+AdvSceneSwitcher.generalTab.generalBehavior.logLevel.verbose="Verbose logging"
 AdvSceneSwitcher.generalTab.generalBehavior.verboseLogging="Enable verbose logging"
 AdvSceneSwitcher.generalTab.generalBehavior.saveWindowGeo="Save window position and size"
 AdvSceneSwitcher.generalTab.generalBehavior.showTrayNotifications="Show system tray notifications"
@@ -968,6 +972,9 @@ AdvSceneSwitcher.action.window.type.maximizeWindow="Maximize window"
 AdvSceneSwitcher.action.window.type.minimizeWindow="Minimize window"
 AdvSceneSwitcher.action.window.type.closeWindow="Close window"
 AdvSceneSwitcher.action.window.entry="{{actions}}{{windows}}{{regex}}"
+AdvSceneSwitcher.action.log="Log"
+AdvSceneSwitcher.action.log.placeholder="My log message!"
+AdvSceneSwitcher.action.log.entry="Write to OBS log:{{logMessage}}"
 
 ; Hotkey
 AdvSceneSwitcher.hotkey.startSwitcherHotkey="Start the Advanced Scene Switcher"
@@ -1040,6 +1047,7 @@ AdvSceneSwitcher.actionQueues.configure="Configure action queue settings"
 AdvSceneSwitcher.actionQueues.invalid="Invalid action queue selection"
 AdvSceneSwitcher.actionQueues.name="Name:"
 AdvSceneSwitcher.actionQueues.runOnStartup="Run action queue when starting the plugin"
+AdvSceneSwitcher.actionQueues.resolveVariablesOnAdd="Resolve variables when action is inserted into the queue"
 AdvSceneSwitcher.actionQueues.running="Queue is running"
 AdvSceneSwitcher.actionQueues.stopped="Queue is stopped"
 AdvSceneSwitcher.actionQueues.start="Start action queue"

diff --git a/forms/advanced-scene-switcher.ui b/forms/advanced-scene-switcher.ui
@@ -163,12 +163,31 @@
                   <item>
                    <layout class="QHBoxLayout" name="horizontalLayout_52">
                     <item>
-                     <widget class="QCheckBox" name="verboseLogging">
+                     <widget class="QLabel" name="label_21">
                       <property name="text">
-                       <string>AdvSceneSwitcher.generalTab.generalBehavior.verboseLogging</string>
+                       <string>AdvSceneSwitcher.generalTab.generalBehavior.logLevel</string>
                       </property>
                      </widget>
                     </item>
+                    <item>
+                     <widget class="QComboBox" name="logLevel">
+                      <item>
+                       <property name="text">
+                        <string>AdvSceneSwitcher.generalTab.generalBehavior.logLevel.default</string>
+                       </property>
+                      </item>
+                      <item>
+                       <property name="text">
+                        <string>AdvSceneSwitcher.generalTab.generalBehavior.logLevel.printActions</string>
+                       </property>
+                      </item>
+                      <item>
+                       <property name="text">
+                        <string>AdvSceneSwitcher.generalTab.generalBehavior.logLevel.verbose</string>
+                       </property>
+                      </item>
+                     </widget>
+                    </item>
                     <item>
                      <spacer name="horizontalSpacer_49">
                       <property name="orientation">
@@ -5078,7 +5097,7 @@
   <tabstop>checkInterval</tabstop>
   <tabstop>startupBehavior</tabstop>
   <tabstop>autoStartEvent</tabstop>
-  <tabstop>verboseLogging</tabstop>
+  <tabstop>logLevel</tabstop>
   <tabstop>saveWindowGeo</tabstop>
   <tabstop>showTrayNotifications</tabstop>
   <tabstop>uiHintsDisable</tabstop>

diff --git a/lib/advanced-scene-switcher.hpp b/lib/advanced-scene-switcher.hpp
@@ -55,14 +55,14 @@ public slots:
 	void NoMatchDelayDurationChanged(const Duration &);
 	void CooldownDurationChanged(const Duration &);
 	void on_startupBehavior_currentIndexChanged(int index);
+	void on_logLevel_currentIndexChanged(int index);
 	void on_autoStartEvent_currentIndexChanged(int index);
 	void on_noMatchSwitchScene_currentTextChanged(const QString &text);
 	void on_checkInterval_valueChanged(int value);
 	void on_tabMoved(int from, int to);
 	void on_tabWidget_currentChanged(int index);
 	void on_exportSettings_clicked();
 	void on_importSettings_clicked();
-	void on_verboseLogging_stateChanged(int state);
 	void on_saveWindowGeo_stateChanged(int state);
 	void on_showTrayNotifications_stateChanged(int state);
 	void on_uiHintsDisable_stateChanged(int state);

diff --git a/lib/general.cpp b/lib/general.cpp
@@ -112,6 +112,14 @@ void AdvSceneSwitcher::on_startupBehavior_currentIndexChanged(int index)
 		static_cast<SwitcherData::StartupBehavior>(index);
 }
 
+void AdvSceneSwitcher::on_logLevel_currentIndexChanged(int value)
+{
+	if (loading) {
+		return;
+	}
+	switcher->logLevel = static_cast<SwitcherData::LogLevel>(value);
+}
+
 void AdvSceneSwitcher::on_autoStartEvent_currentIndexChanged(int index)
 {
 	if (loading) {
@@ -157,15 +165,6 @@ void AdvSceneSwitcher::closeEvent(QCloseEvent *)
 	obs_frontend_save();
 }
 
-void AdvSceneSwitcher::on_verboseLogging_stateChanged(int state)
-{
-	if (loading) {
-		return;
-	}
-
-	switcher->verbose = state;
-}
-
 void AdvSceneSwitcher::on_saveWindowGeo_stateChanged(int state)
 {
 	if (loading) {
@@ -598,7 +597,7 @@ void SwitcherData::SaveGeneralSettings(obs_data_t *obj)
 	obs_data_set_int(obj, "autoStartEvent",
 			 static_cast<int>(autoStartEvent));
 
-	obs_data_set_bool(obj, "verbose", verbose);
+	obs_data_set_int(obj, "logLevel", static_cast<int>(logLevel));
 	obs_data_set_bool(obj, "showSystemTrayNotifications",
 			  showSystemTrayNotifications);
 	obs_data_set_bool(obj, "disableHints", disableHints);
@@ -649,7 +648,7 @@ void SwitcherData::LoadGeneralSettings(obs_data_t *obj)
 	autoStartEvent =
 		static_cast<AutoStart>(obs_data_get_int(obj, "autoStartEvent"));
 
-	verbose = obs_data_get_bool(obj, "verbose");
+	logLevel = static_cast<LogLevel>(obs_data_get_int(obj, "logLevel"));
 	showSystemTrayNotifications =
 		obs_data_get_bool(obj, "showSystemTrayNotifications");
 	disableHints = obs_data_get_bool(obj, "disableHints");
@@ -940,7 +939,8 @@ void AdvSceneSwitcher::SetupGeneralTab()
 			 SIGNAL(DurationChanged(const Duration &)), this,
 			 SLOT(CooldownDurationChanged(const Duration &)));
 
-	ui->verboseLogging->setChecked(switcher->verbose);
+	ui->logLevel->setCurrentIndex(static_cast<int>(switcher->logLevel));
+
 	ui->saveWindowGeo->setChecked(switcher->saveWindowGeo);
 	ui->showTrayNotifications->setChecked(
 		switcher->showSystemTrayNotifications);

diff --git a/lib/legacy/switch-audio.cpp b/lib/legacy/switch-audio.cpp
@@ -104,7 +104,7 @@ void SwitcherData::checkAudioSwitchFallback(OBSWeakSource &scene,
 		scene = audioFallback.getScene();
 		transition = audioFallback.transition;
 
-		if (verbose) {
+		if (VerboseLoggingEnabled()) {
 			audioFallback.logMatch();
 		}
 	}
@@ -165,7 +165,7 @@ bool SwitcherData::checkAudioSwitch(OBSWeakSource &scene,
 			transition = s.transition;
 			match = true;
 
-			if (verbose) {
+			if (VerboseLoggingEnabled()) {
 				s.logMatch();
 			}
 

diff --git a/lib/legacy/switch-executable.cpp b/lib/legacy/switch-executable.cpp
@@ -119,7 +119,7 @@ bool SwitcherData::checkExeSwitch(OBSWeakSource &scene,
 			scene = s.getScene();
 			transition = s.transition;
 
-			if (verbose) {
+			if (VerboseLoggingEnabled()) {
 				s.logMatch();
 			}
 			break;

diff --git a/lib/legacy/switch-file.cpp b/lib/legacy/switch-file.cpp
@@ -274,7 +274,7 @@ bool SwitcherData::checkFileContent(OBSWeakSource &scene,
 			transition = s.transition;
 			match = true;
 
-			if (verbose) {
+			if (VerboseLoggingEnabled()) {
 				s.logMatch();
 			}
 			break;

diff --git a/lib/legacy/switch-idle.cpp b/lib/legacy/switch-idle.cpp
@@ -53,7 +53,7 @@ bool SwitcherData::checkIdleSwitch(OBSWeakSource &scene,
 		match = true;
 		idleData.alreadySwitched = true;
 
-		if (verbose) {
+		if (VerboseLoggingEnabled()) {
 			idleData.logMatch();
 		}
 	} else {

diff --git a/lib/legacy/switch-media.cpp b/lib/legacy/switch-media.cpp
@@ -193,7 +193,7 @@ bool SwitcherData::checkMediaSwitch(OBSWeakSource &scene,
 			scene = mediaSwitch.getScene();
 			transition = mediaSwitch.transition;
 
-			if (verbose) {
+			if (VerboseLoggingEnabled()) {
 				mediaSwitch.logMatch();
 			}
 		}

diff --git a/lib/legacy/switch-network.cpp b/lib/legacy/switch-network.cpp
@@ -253,7 +253,7 @@ void WSServer::sendMessage(SceneSwitchInfo sceneSwitch, bool preview)
 		}
 	}
 
-	if (switcher->verbose) {
+	if (VerboseLoggingEnabled()) {
 		blog(LOG_INFO, "server sent message:\n%s", message.c_str());
 	}
 }
@@ -305,7 +305,7 @@ std::string processMessage(std::string payload)
 	std::string ret = "message ok";
 
 	auto transition = GetWeakTransitionByName(transitionName.c_str());
-	if (switcher->verbose && !transition) {
+	if (VerboseLoggingEnabled() && !transition) {
 		ret += " - ignoring invalid transition: '" + transitionName +
 		       "'";
 	}
@@ -481,7 +481,7 @@ void WSClient::onMessage(connection_hdl hdl, client::message_ptr message)
 		     errorCodeMessage.c_str());
 	}
 
-	if (switcher->verbose) {
+	if (VerboseLoggingEnabled()) {
 		blog(LOG_INFO, "client sent message:\n%s", response.c_str());
 	}
 }

diff --git a/lib/legacy/switch-random.cpp b/lib/legacy/switch-random.cpp
@@ -76,7 +76,7 @@ bool SwitcherData::checkRandom(OBSWeakSource &scene, OBSWeakSource &transition,
 		lastRandomScene = r.scene;
 		lastRandomSceneGroup = r.group;
 
-		if (verbose) {
+		if (VerboseLoggingEnabled()) {
 			r.logMatch();
 		}
 		break;

diff --git a/lib/legacy/switch-screen-region.cpp b/lib/legacy/switch-screen-region.cpp
@@ -183,7 +183,7 @@ bool SwitcherData::checkScreenRegionSwitch(OBSWeakSource &scene,
 				transition = s.transition;
 				minRegionSize = regionSize;
 
-				if (verbose) {
+				if (VerboseLoggingEnabled()) {
 					s.logMatch();
 				}
 				break;

diff --git a/lib/legacy/switch-sequence.cpp b/lib/legacy/switch-sequence.cpp
@@ -225,13 +225,13 @@ bool SwitcherData::checkSceneSequence(OBSWeakSource &scene,
 				scene = s.getScene();
 				transition = s.transition;
 				setPrevSceneAfterLinger = s.usePreviousScene;
-				if (verbose) {
+				if (VerboseLoggingEnabled()) {
 					s.logMatch();
 				}
 			}
 
 			s.advanceActiveSequence();
-			if (verbose) {
+			if (VerboseLoggingEnabled()) {
 				s.logAdvanceSequence();
 			}
 

diff --git a/lib/legacy/switch-time.cpp b/lib/legacy/switch-time.cpp
@@ -142,7 +142,7 @@ bool SwitcherData::checkTimeSwitch(OBSWeakSource &scene,
 			transition = s.transition;
 			match = true;
 
-			if (verbose) {
+			if (VerboseLoggingEnabled()) {
 				s.logMatch();
 			}
 			break;