Add option to automatically start the plugin on a given scene

This functionality was lost with the removal of the "Scene trigger" tab.
2026-03-21 17:34:57 -05:00 · 2025-10-18 11:30:22 +02:00 · 2025-10-18 11:30:22 +02:00 · 602675b3b3
commit 602675b3b3
parent 9551519cb9
13 changed files with 197 additions and 44 deletions
--- a/data/locale/de-DE.ini
+++ b/data/locale/de-DE.ini
@ -12,7 +12,7 @@ AdvSceneSwitcher.generalTab.status.onStartup.alwaysStart="Aktiviere den Szenenwe
 AdvSceneSwitcher.generalTab.status.onStartup.doNotStart="Aktiviere den Szenenwechsler nicht"
 AdvSceneSwitcher.generalTab.status.start="Start"
 AdvSceneSwitcher.generalTab.status.stop="Stop"
-AdvSceneSwitcher.generalTab.status.autoStart="Starte auotmatischen den Szenenwechsler beim:"
+AdvSceneSwitcher.generalTab.status.autoStart.startup="Starte auotmatischen den Szenenwechsler beim:"
 AdvSceneSwitcher.generalTab.status.autoStart.never="Niemals"
 AdvSceneSwitcher.generalTab.status.autoStart.recording="Aufnehmen"
 AdvSceneSwitcher.generalTab.status.autoStart.streaming="Streamen"
--- a/data/locale/en-US.ini
+++ b/data/locale/en-US.ini
@ -12,11 +12,12 @@ AdvSceneSwitcher.generalTab.status.onStartup.alwaysStart="Always start the scene
 AdvSceneSwitcher.generalTab.status.onStartup.doNotStart="Do not start the scene switcher"
 AdvSceneSwitcher.generalTab.status.start="Start"
 AdvSceneSwitcher.generalTab.status.stop="Stop"
-AdvSceneSwitcher.generalTab.status.autoStart="Automatically start the scene switcher when:"
+AdvSceneSwitcher.generalTab.status.autoStart.startup="Automatically start the scene switcher when:"
 AdvSceneSwitcher.generalTab.status.autoStart.never="Never"
 AdvSceneSwitcher.generalTab.status.autoStart.recording="Recording"
 AdvSceneSwitcher.generalTab.status.autoStart.streaming="Streaming"
 AdvSceneSwitcher.generalTab.status.autoStart.recordingAndStreaming="Recording or Streaming"
+AdvSceneSwitcher.generalTab.status.autoStart.scene="Automatically start the scene switcher on scene:"
 AdvSceneSwitcher.generalTab.status.checkInterval="Check conditions every"
 AdvSceneSwitcher.generalTab.status.checkIntervalTooLow="⚠️ Conflict with macro \"%1\"!"
 AdvSceneSwitcher.generalTab.status.checkIntervalTooLow.tooltip="Macro \"%1\" won't be able to check its condition at the desired interval of %2.\nEither change the condition check value on the General tab or in the settings of macro \"%3\"."
--- a/data/locale/es-ES.ini
+++ b/data/locale/es-ES.ini
@ -12,7 +12,7 @@ AdvSceneSwitcher.generalTab.status.onStartup.alwaysStart="Siempre iniciar el sel
 AdvSceneSwitcher.generalTab.status.onStartup.doNotStart="No iniciar el selector de escenas"
 AdvSceneSwitcher.generalTab.status.start="Iniciar"
 AdvSceneSwitcher.generalTab.status.stop="Detener"
-AdvSceneSwitcher.generalTab.status.autoStart="Iniciar automáticamente el selector de escenas cuando:"
+AdvSceneSwitcher.generalTab.status.autoStart.startup="Iniciar automáticamente el selector de escenas cuando:"
 AdvSceneSwitcher.generalTab.status.autoStart.never="Nunca"
 AdvSceneSwitcher.generalTab.status.autoStart.recording="Grabando"
 AdvSceneSwitcher.generalTab.status.autoStart.streaming="Emitiendo"
--- a/data/locale/fr-FR.ini
+++ b/data/locale/fr-FR.ini
@ -12,7 +12,7 @@ AdvSceneSwitcher.generalTab.status.onStartup.alwaysStart="Toujours démarrer le
 AdvSceneSwitcher.generalTab.status.onStartup.doNotStart="Ne pas démarrer le sélecteur de scène"
 AdvSceneSwitcher.generalTab.status.start="Démarrer"
 AdvSceneSwitcher.generalTab.status.stop="Arrêter"
-AdvSceneSwitcher.generalTab.status.autoStart="Démarrer automatiquement le sélecteur de scène lorsque :"
+AdvSceneSwitcher.generalTab.status.autoStart.startup="Démarrer automatiquement le sélecteur de scène lorsque :"
 AdvSceneSwitcher.generalTab.status.autoStart.never="Jamais"
 AdvSceneSwitcher.generalTab.status.autoStart.recording="Enregistrement"
 AdvSceneSwitcher.generalTab.status.autoStart.streaming="Diffusion en continu"
--- a/data/locale/ja-JP.ini
+++ b/data/locale/ja-JP.ini
@ -12,7 +12,7 @@ AdvSceneSwitcher.generalTab.status.onStartup.alwaysStart="常にシーンスイ
 AdvSceneSwitcher.generalTab.status.onStartup.doNotStart="シーンスイッチャーを起動しない"
 AdvSceneSwitcher.generalTab.status.start="起動する"
 AdvSceneSwitcher.generalTab.status.stop="停止する"
-AdvSceneSwitcher.generalTab.status.autoStart="次の場合にシーンスイッチャーを自動起動する"
+AdvSceneSwitcher.generalTab.status.autoStart.startup="次の場合にシーンスイッチャーを自動起動する"
 AdvSceneSwitcher.generalTab.status.autoStart.never="自動起動しない"
 AdvSceneSwitcher.generalTab.status.autoStart.recording="録画を開始した時"
 AdvSceneSwitcher.generalTab.status.autoStart.streaming="配信を開始した時"
--- a/data/locale/pt-BR.ini
+++ b/data/locale/pt-BR.ini
@ -12,7 +12,7 @@ AdvSceneSwitcher.generalTab.status.onStartup.alwaysStart="Sempre iniciar o switc
 AdvSceneSwitcher.generalTab.status.onStartup.doNotStart="Não iniciar o switcher de cenas"
 AdvSceneSwitcher.generalTab.status.start="Iniciar"
 AdvSceneSwitcher.generalTab.status.stop="Parar"
-AdvSceneSwitcher.generalTab.status.autoStart="Iniciar automaticamente o switcher de cenas quando:"
+AdvSceneSwitcher.generalTab.status.autoStart.startup="Iniciar automaticamente o switcher de cenas quando:"
 AdvSceneSwitcher.generalTab.status.autoStart.never="Nunca"
 AdvSceneSwitcher.generalTab.status.autoStart.recording="Gravando"
 AdvSceneSwitcher.generalTab.status.autoStart.streaming="Transmitindo"
--- a/data/locale/ru-RU.ini
+++ b/data/locale/ru-RU.ini
@ -12,7 +12,7 @@ AdvSceneSwitcher.generalTab.status.onStartup.alwaysStart="Всегда запу
 AdvSceneSwitcher.generalTab.status.onStartup.doNotStart="Не запускать переключатель сцен"
 AdvSceneSwitcher.generalTab.status.start="Старт"
 AdvSceneSwitcher.generalTab.status.stop="Стоп"
-AdvSceneSwitcher.generalTab.status.autoStart="Автоматически запускать переключатель сцен, когда:"
+AdvSceneSwitcher.generalTab.status.autoStart.startup="Автоматически запускать переключатель сцен, когда:"
 AdvSceneSwitcher.generalTab.status.autoStart.never="Никогда"
 AdvSceneSwitcher.generalTab.status.autoStart.recording="Запись"
 AdvSceneSwitcher.generalTab.status.autoStart.streaming="Вещание"
--- a/data/locale/tr-TR.ini
+++ b/data/locale/tr-TR.ini
@ -12,7 +12,7 @@ AdvSceneSwitcher.generalTab.status.onStartup.alwaysStart="Her zaman sahne deği
 AdvSceneSwitcher.generalTab.status.onStartup.doNotStart="Sahne değiştiriciyi başlatma"
 AdvSceneSwitcher.generalTab.status.start="Başlat"
 AdvSceneSwitcher.generalTab.status.stop="Durdur"
-AdvSceneSwitcher.generalTab.status.autoStart="Aşağıdaki durumlarda sahne değiştiriciyi otomatik olarak başlatın:"
+AdvSceneSwitcher.generalTab.status.autoStart.startup="Aşağıdaki durumlarda sahne değiştiriciyi otomatik olarak başlatın:"
 AdvSceneSwitcher.generalTab.status.autoStart.never="Asla"
 AdvSceneSwitcher.generalTab.status.autoStart.recording="Kayıt"
 AdvSceneSwitcher.generalTab.status.autoStart.streaming="Yayın"
--- a/data/locale/zh-CN.ini
+++ b/data/locale/zh-CN.ini
@ -12,7 +12,7 @@ AdvSceneSwitcher.generalTab.status.onStartup.alwaysStart="总是自动启动"
 AdvSceneSwitcher.generalTab.status.onStartup.doNotStart="不要启动"
 AdvSceneSwitcher.generalTab.status.start="启动"
 AdvSceneSwitcher.generalTab.status.stop="停止"
-AdvSceneSwitcher.generalTab.status.autoStart="在以下情况下自动启动场景切换器:"
+AdvSceneSwitcher.generalTab.status.autoStart.startup="在以下情况下自动启动场景切换器:"
 AdvSceneSwitcher.generalTab.status.autoStart.never="从不"
 AdvSceneSwitcher.generalTab.status.autoStart.recording="录制"
 AdvSceneSwitcher.generalTab.status.autoStart.streaming="直播"
--- a/forms/advanced-scene-switcher.ui
+++ b/forms/advanced-scene-switcher.ui
@ -87,6 +87,40 @@
                    <item row="4" column="1">
                     <widget class="QComboBox" name="autoStartEvent"/>
                    </item>
+                    <item row="4" column="0">
+                     <widget class="QLabel" name="label_10">
+                      <property name="text">
+                       <string>AdvSceneSwitcher.generalTab.status.autoStart.startup</string>
+                      </property>
+                     </widget>
+                    </item>
+                    <item row="0" column="0">
+                     <layout class="QVBoxLayout" name="verticalLayout_33">
+                      <item>
+                       <widget class="QLabel" name="label_4">
+                        <property name="text">
+                         <string>AdvSceneSwitcher.generalTab.status.checkInterval</string>
+                        </property>
+                       </widget>
+                      </item>
+                      <item>
+                       <widget class="QLabel" name="checkIntervalTooLowWarning">
+                        <property name="text">
+                         <string/>
+                        </property>
+                       </widget>
+                      </item>
+                     </layout>
+                    </item>
+                    <item row="3" column="1">
+                     <widget class="QComboBox" name="startupBehavior"/>
+                    </item>
+                    <item row="1" column="1">
+                     <widget class="QWidget" name="placeholder3" native="true"/>
+                    </item>
+                    <item row="1" column="0">
+                     <widget class="QWidget" name="placeholder" native="true"/>
+                    </item>
                    <item row="3" column="0">
                     <widget class="QLabel" name="label_64">
                      <property name="text">
@ -94,16 +128,13 @@
                      </property>
                     </widget>
                    </item>
-                    <item row="3" column="1">
-                     <widget class="QComboBox" name="startupBehavior"/>
+                    <item row="2" column="1">
+                     <widget class="QWidget" name="placeholder2" native="true"/>
                    </item>
-                    <item row="1" column="0">
-                     <widget class="QWidget" name="placeholder" native="true"/>
-                    </item>
-                    <item row="4" column="0">
-                     <widget class="QLabel" name="label_10">
+                    <item row="6" column="0">
+                     <widget class="QLabel" name="label_13">
                      <property name="text">
-                       <string>AdvSceneSwitcher.generalTab.status.autoStart</string>
+                       <string>AdvSceneSwitcher.generalTab.status.hotkeytips</string>
                      </property>
                     </widget>
                    </item>
@ -130,36 +161,25 @@
                     </widget>
                    </item>
                    <item row="5" column="0">
-                     <widget class="QLabel" name="label_13">
+                     <widget class="QCheckBox" name="autoStartSceneEnable">
                      <property name="text">
-                       <string>AdvSceneSwitcher.generalTab.status.hotkeytips</string>
+                       <string>AdvSceneSwitcher.generalTab.status.autoStart.scene</string>
                      </property>
                     </widget>
                    </item>
-                    <item row="0" column="0">
-                     <layout class="QVBoxLayout" name="verticalLayout_33">
+                    <item row="5" column="1">
+                     <layout class="QHBoxLayout" name="autoStartSceneLayout">
                      <item>
-                       <widget class="QLabel" name="label_4">
-                        <property name="text">
-                         <string>AdvSceneSwitcher.generalTab.status.checkInterval</string>
-                        </property>
-                       </widget>
+                       <widget class="advss::SceneSelectionWidget" name="autoStartScene" native="true"/>
                      </item>
                      <item>
-                       <widget class="QLabel" name="checkIntervalTooLowWarning">
-                        <property name="text">
-                         <string/>
-                        </property>
-                       </widget>
+                       <widget class="advss::VariableLineEdit" name="autoStartSceneName"/>
+                      </item>
+                      <item>
+                       <widget class="advss::RegexConfigWidget" name="autoStartSceneNameRegex" native="true"/>
                      </item>
                     </layout>
                    </item>
-                    <item row="2" column="1">
-                     <widget class="QWidget" name="placeholder2" native="true"/>
-                    </item>
-                    <item row="1" column="1">
-                     <widget class="QWidget" name="placeholder3" native="true"/>
-                    </item>
                   </layout>
                  </item>
                 </layout>
@ -4124,6 +4144,23 @@
   <header>macro-edit.hpp</header>
   <container>1</container>
  </customwidget>
+  <customwidget>
+   <class>advss::SceneSelectionWidget</class>
+   <extends>QWidget</extends>
+   <header>scene-selection.hpp</header>
+   <container>1</container>
+  </customwidget>
+  <customwidget>
+   <class>advss::VariableLineEdit</class>
+   <extends>QLineEdit</extends>
+   <header>variable-line-edit.hpp</header>
+  </customwidget>
+  <customwidget>
+   <class>advss::RegexConfigWidget</class>
+   <extends>QWidget</extends>
+   <header>regex-config.hpp</header>
+   <container>1</container>
+  </customwidget>
 </customwidgets>
 <tabstops>
  <tabstop>tabWidget</tabstop>
@ -4131,6 +4168,10 @@
  <tabstop>checkInterval</tabstop>
  <tabstop>startupBehavior</tabstop>
  <tabstop>autoStartEvent</tabstop>
+  <tabstop>autoStartSceneEnable</tabstop>
+  <tabstop>autoStartScene</tabstop>
+  <tabstop>autoStartSceneName</tabstop>
+  <tabstop>autoStartSceneNameRegex</tabstop>
  <tabstop>logLevel</tabstop>
  <tabstop>saveWindowGeo</tabstop>
  <tabstop>showTrayNotifications</tabstop>
--- a/lib/advanced-scene-switcher.cpp
+++ b/lib/advanced-scene-switcher.cpp
@ -538,6 +538,7 @@ static void handleSceneChange()
 	}

 	switcher->checkDefaultSceneTransitions();
+	switcher->CheckAutoStart();
 }

 static void setLiveTime()
--- a/lib/general.cpp
+++ b/lib/general.cpp
@ -3,6 +3,7 @@
 #include "filter-combo-box.hpp"
 #include "layout-helpers.hpp"
 #include "macro.hpp"
+#include "macro-settings.hpp"
 #include "path-helpers.hpp"
 #include "selection-helpers.hpp"
 #include "source-helpers.hpp"
@ -536,8 +537,13 @@ void SwitcherData::SaveGeneralSettings(obs_data_t *obj)
 	obs_data_set_int(obj, "startup_behavior",
 			 static_cast<int>(startupBehavior));

-	obs_data_set_int(obj, "autoStartEvent",
-			 static_cast<int>(autoStartEvent));
+	OBSDataAutoRelease autoStart = obs_data_create();
+	obs_data_set_int(autoStart, "event", static_cast<int>(autoStartEvent));
+	obs_data_set_bool(autoStart, "useAutoStartScene", useAutoStartScene);
+	autoStartScene.Save(autoStart);
+	autoStartSceneName.Save(autoStart, "name");
+	autoStartSceneRegex.Save(autoStart);
+	obs_data_set_obj(obj, "autoStart", autoStart);

 	SaveLogLevel(obj);

@ -595,8 +601,15 @@ void SwitcherData::LoadGeneralSettings(obs_data_t *obj)
 		stop = true;
 	}

-	autoStartEvent =
-		static_cast<AutoStart>(obs_data_get_int(obj, "autoStartEvent"));
+	OBSDataAutoRelease autoStart = obs_data_get_obj(obj, "autoStart");
+	autoStartEvent = static_cast<AutoStart>(
+		obs_data_has_user_value(obj, "autoStart")
+			? obs_data_get_int(autoStart, "event")
+			: obs_data_get_int(obj, "autoStartEvent"));
+	useAutoStartScene = obs_data_get_bool(autoStart, "useAutoStartScene");
+	autoStartScene.Load(autoStart);
+	autoStartSceneName.Load(autoStart, "name");
+	autoStartSceneRegex.Load(autoStart);

 	LoadLogLevel(obj);

@ -687,6 +700,27 @@ void SwitcherData::CheckNoMatchSwitch(bool &match, OBSWeakSource &scene,
 	}
 }

+void SwitcherData::CheckAutoStart()
+{
+	if (!useAutoStartScene) {
+		return;
+	}
+
+	bool shouldStartPlugin = false;
+	if (autoStartSceneRegex.Enabled()) {
+		const auto currentSceneName = GetWeakSourceName(currentScene);
+		shouldStartPlugin = autoStartSceneRegex.Matches(
+			currentSceneName, autoStartSceneName);
+	} else {
+		shouldStartPlugin = autoStartScene.GetScene(false) ==
+				    currentScene;
+	}
+
+	if (shouldStartPlugin) {
+		Start();
+	}
+}
+
 void SwitcherData::checkSwitchCooldown(bool &match)
 {
 	if (!match || !enableCooldown) {
@ -829,7 +863,7 @@ static void setupGeneralTabInactiveWarning(QTabWidget *tabs)
 	inactiveTimer->start();
 }

-void advss::AdvSceneSwitcher::SetCheckIntervalTooLowVisibility() const
+void AdvSceneSwitcher::SetCheckIntervalTooLowVisibility() const
 {
 	auto macro = GetMacroWithInvalidConditionInterval();
 	if (!macro) {
@ -918,6 +952,75 @@ void AdvSceneSwitcher::SetupGeneralTab()
 	populateAutoStartEventSelection(ui->autoStartEvent);
 	ui->autoStartEvent->setCurrentIndex(
 		static_cast<int>(switcher->autoStartEvent));
+	ui->autoStartSceneEnable->setChecked(switcher->useAutoStartScene);
+	ui->autoStartScene->SetScene(switcher->autoStartScene);
+	ui->autoStartScene->LockToMainCanvas();
+	ui->autoStartSceneName->setText(switcher->autoStartSceneName);
+	ui->autoStartSceneNameRegex->SetRegexConfig(
+		switcher->autoStartSceneRegex);
+
+	const auto setupAutoStartSceneLayoutVisibility = [this](bool useRegex) {
+		ui->autoStartSceneName->setVisible(useRegex);
+		ui->autoStartScene->setVisible(!useRegex);
+		if (useRegex) {
+			RemoveStretchIfPresent(ui->autoStartSceneLayout);
+		} else {
+			AddStretchIfNecessary(ui->autoStartSceneLayout);
+		}
+	};
+	setupAutoStartSceneLayoutVisibility(
+		switcher->autoStartSceneRegex.Enabled());
+
+	const auto setupAutoStartSceneWidgetState =
+		[this](bool useAutoStartScene) {
+			ui->autoStartScene->setEnabled(useAutoStartScene);
+			ui->autoStartSceneName->setEnabled(useAutoStartScene);
+			ui->autoStartSceneNameRegex->setEnabled(
+				useAutoStartScene);
+		};
+	setupAutoStartSceneWidgetState(switcher->useAutoStartScene);
+
+	connect(ui->autoStartSceneEnable, &QCheckBox::stateChanged, this,
+		[this, setupAutoStartSceneWidgetState](int enabled) {
+			if (loading) {
+				return;
+			}
+			std::lock_guard<std::mutex> lock(switcher->m);
+			switcher->useAutoStartScene = enabled;
+			setupAutoStartSceneWidgetState(enabled);
+		});
+
+	connect(ui->autoStartScene, &SceneSelectionWidget::SceneChanged, this,
+		[this](const SceneSelection &scene) {
+			if (loading) {
+				return;
+			}
+			std::lock_guard<std::mutex> lock(switcher->m);
+			switcher->autoStartScene = scene;
+			switcher->CheckAutoStart();
+		});
+	connect(ui->autoStartSceneName, &VariableLineEdit::editingFinished,
+		this, [this]() {
+			if (loading) {
+				return;
+			}
+			std::lock_guard<std::mutex> lock(switcher->m);
+			switcher->autoStartSceneName =
+				ui->autoStartSceneName->text().toStdString();
+			switcher->CheckAutoStart();
+		});
+	connect(ui->autoStartSceneNameRegex,
+		&RegexConfigWidget::RegexConfigChanged, this,
+		[this, setupAutoStartSceneLayoutVisibility](
+			const RegexConfig &regex) {
+			if (loading) {
+				return;
+			}
+			std::lock_guard<std::mutex> lock(switcher->m);
+			switcher->autoStartSceneRegex = regex;
+			setupAutoStartSceneLayoutVisibility(regex.Enabled());
+			switcher->CheckAutoStart();
+		});

 	// Set up status control
 	auto statusControl = new StatusControl(this, true);
--- a/lib/switcher-data.hpp
+++ b/lib/switcher-data.hpp
@ -14,10 +14,12 @@
 #include "switch-sequence.hpp"
 #include "switch-video.hpp"

-#include "macro-settings.hpp"
 #include "duration-control.hpp"
-#include "priority-helper.hpp"
 #include "plugin-state-helpers.hpp"
+#include "priority-helper.hpp"
+#include "regex-config.hpp"
+#include "scene-selection.hpp"
+#include "variable-string.hpp"

 #include <condition_variable>
 #include <vector>
@ -62,6 +64,7 @@ public:
 			   bool &macroMatch);
 	void CheckNoMatchSwitch(bool &match, OBSWeakSource &scene,
 				OBSWeakSource &transition, int &sleep);
+	void CheckAutoStart();

 	/* --- Start of saving / loading section --- */

@ -118,6 +121,10 @@ public:
 		RECORINDG_OR_STREAMING
 	};
 	AutoStart autoStartEvent = AutoStart::NEVER;
+	bool useAutoStartScene = false;
+	SceneSelection autoStartScene;
+	StringVariable autoStartSceneName;
+	RegexConfig autoStartSceneRegex;
 	bool enableCooldown = false;
 	Duration cooldown;
 	bool showSystemTrayNotifications = false;