Adaptitions for kWin support on Flatpak

data/locale/en-US.ini

@@ -973,7 +973,6 @@ AdvSceneSwitcher.action.playAudio.monitorUnavailable="Audio monitoring not avail
 AdvSceneSwitcher.action.playAudio.tracks="Tracks"
 AdvSceneSwitcher.action.playAudio.layout.startOffset="{{useStartOffset}}Start at{{startOffset}}"
 AdvSceneSwitcher.action.playAudio.layout.playbackDuration="{{useDuration}}Play for{{playbackDuration}}(0 = until end)"
-AdvSceneSwitcher.action.playAudio.mono="Mono"
 AdvSceneSwitcher.action.recording="Recording"
 AdvSceneSwitcher.action.recording.type.stop="Stop recording"
 AdvSceneSwitcher.action.recording.type.start="Start recording"
@@ -3108,3 +3107,4 @@ AdvSceneSwitcher.sceneGroupTab.defaultname="Scene Group %1"
 AdvSceneSwitcher.sceneGroupTab.exists="Scene Group or Scene name exists already"
 AdvSceneSwitcher.sceneGroupTab.help="Scene Groups can be selected as a target just like a regular scene.\n\nAs the name suggests a scene group is a collection of multiple scenes.\nThe scene group will advance through the list of its assigned scenes depending on the configured settings, which can be found on the right side.\n\nYou can configure the scene group to advance to the next scene in the list:\nAfter a number of times the scene group is selected as a target.\nAfter a certain amount of time has passed.\nOr randomly.\n\nFor example, a scene group containing the scenes ...\nScene 1\nScene 2\nScene 3 \n... will activate \"Scene 1\" the first time it is selected as a target.\nThe second time it will activate \"Scene 2\".\nThe remaining times \"Scene 3\" will be activated.\n\nClick the highlighted plus symbol below to add a new scene group."
 AdvSceneSwitcher.sceneGroupTab.scenes.help="Select the scene group you want to modify on the left.\n\nSelect a scene to add to this scene group by selecting the scene above and clicking the plus symbol below.\n\nA scene can be added multiple times to the same scene group."
+AdvSceneSwitcher.kwin.flatpakPermissionWarning="Window detection via KWin is unavailable.\nThe OBS Studio Flatpak requires additional permissions to enable this feature.\nSee the Advanced Scene Switcher wiki for details."

lib/linux/advanced-scene-switcher-nix.cpp

@@ -1,5 +1,9 @@
 #include "platform-funcs.hpp"
+
 #include "log-helper.hpp"
+#include "obs-module-helper.hpp"
+#include "plugin-state-helpers.hpp"
+#include "ui-helpers.hpp"
 
 #include <X11/Xlib.h>
 #include <X11/Xatom.h>
@@ -628,27 +632,39 @@ int ignoreXerror(Display *d, XErrorEvent *e)
 	return 0;
 }
 
+static void handleKWinInitFailure(bool kwinAvailable)
+{
+	blog(LOG_INFO, "not using KWin compat");
+	const bool onKDE = qEnvironmentVariable("XDG_CURRENT_DESKTOP")
+		.contains("KDE", Qt::CaseInsensitive);
+	const bool inFlatpak = qEnvironmentVariableIsSet("FLATPAK_ID");
+	if (!kwinAvailable && onKDE && inFlatpak)
+		AddFinishedLoadingStep([]() {
+			DisplayTrayMessage(
+				obs_module_text("AdvSceneSwitcher.pluginName"),
+				obs_module_text("AdvSceneSwitcher.kwin.flatpakPermissionWarning"));
+		});
+}
+
 void PlatformInit()
 {
+	const bool kwinAvailable = isKWinAvailable();
+	KWin = kwinAvailable && registerKWinDBusListener(&notifier) &&
+	       startKWinScript(KWinScriptObjectPath);
+	if (KWin)
+		blog(LOG_INFO, "using KWin compat");
+	else
+		handleKWinInitFailure(kwinAvailable);
+
+	initProcps();
+	initProc2();
+
 	auto display = disp();
 	if (!display) {
 		return;
 	}
 
-	KWin = isKWinAvailable();
-	if (!(KWin && startKWinScript(KWinScriptObjectPath) &&
-	      registerKWinDBusListener(&notifier))) {
-		// something bad happened while trying to initialize
-		// the KWin script/dbus so disable it
-		KWin = false;
-		blog(LOG_INFO, "not using KWin compat");
-	} else {
-		blog(LOG_INFO, "using KWin compat");
-	}
-
 	initXss();
-	initProcps();
-	initProc2();
 	XSetErrorHandler(ignoreXerror);
 }
 

lib/linux/kwin-helpers.cpp

@@ -5,6 +5,7 @@
 #include <QDir>
 #include <QFile>
 #include <QFileDevice>
+#include <QStandardPaths>
 #include <QTextStream>
 #include <QtDBus/QDBusConnectionInterface>
 #include <QtDBus/QDBusInterface>
@@ -97,11 +98,13 @@ bool isKWinAvailable()
 bool startKWinScript(QString &scriptObjectPath)
 {
 	const QString scriptPath =
-		"/tmp/AdvancedSceneSwitcher/KWinFocusNotifier.js";
+		QStandardPaths::writableLocation(
+			QStandardPaths::RuntimeLocation) +
+		"/AdvancedSceneSwitcher/KWinFocusNotifier.js";
 
 	const QString script =
-		R"(var adss = "com.github.AdvancedSceneSwitcher";
-var adssPath = "/com/github/AdvancedSceneSwitcher";
+		R"(var adss = "com.obsproject.Studio.Plugin.SceneSwitcher";
+var adssPath = "/com/obsproject/Studio/Plugin/SceneSwitcher";
 
 function trackWindow(window) {
     var id = window.internalId.toString();
@@ -129,7 +132,8 @@ workspace.windowActivated.connect(function(client) {
 }))";
 
 	if (const QDir dir; !dir.mkpath(QFileInfo(scriptPath).absolutePath())) {
-		blog(LOG_ERROR, "error creating /tmp/AdvancedSceneSwitcher");
+		blog(LOG_ERROR,
+		     "error creating KWinFocusNotifier script directory");
 		return false;
 	}
 
@@ -198,8 +202,8 @@ bool stopKWinScript(const QString &scriptObjectPath)
 
 bool registerKWinDBusListener(FocusNotifier *notifier)
 {
-	static const QString serviceName = "com.github.AdvancedSceneSwitcher";
-	static const QString objectPath = "/com/github/AdvancedSceneSwitcher";
+	static const QString serviceName = "com.obsproject.Studio.Plugin.SceneSwitcher";
+	static const QString objectPath = "/com/obsproject/Studio/Plugin/SceneSwitcher";
 	auto bus = QDBusConnection::sessionBus();
 
 	if (bus.objectRegisteredAt(objectPath)) {

lib/linux/kwin-helpers.h

@@ -12,7 +12,7 @@ namespace advss {
 
 class FocusNotifier final : public QObject {
 	Q_OBJECT
-	Q_CLASSINFO("D-Bus Interface", "com.github.AdvancedSceneSwitcher")
+	Q_CLASSINFO("D-Bus Interface", "com.obsproject.Studio.Plugin.SceneSwitcher")
 
 	static std::mutex _mutex;
 	static int activePID;

plugins/base/macro-action-play-audio.cpp

@@ -2,64 +2,18 @@
 #include "audio-helpers.hpp"
 #include "layout-helpers.hpp"
 #include "macro-helpers.hpp"
-#include "plugin-state-helpers.hpp"
 #include "sync-helpers.hpp"
 
-#include <obs-frontend-api.h>
-
 #include <chrono>
-#include <mutex>
-#include <set>
 #include <QFileInfo>
 #include <QLabel>
 
 namespace advss {
 
+// Use a high output channel index that is unlikely to be claimed by OBS or
+// other plugins. OBS supports channels 0-63; channel 0 is the main scene.
 static constexpr uint32_t kPlaybackOutputChannel = 63;
 
-// Tracks rawSource handles held by background cleanup threads so they can be
-// stopped early when OBS begins shutdown, before audio is freed.
-static std::mutex g_activeSourcesMutex;
-static std::set<obs_source_t *> g_activeSources;
-
-static void registerActiveSource(obs_source_t *source)
-{
-	std::lock_guard<std::mutex> lock(g_activeSourcesMutex);
-	g_activeSources.insert(source);
-}
-
-static void unregisterActiveSource(obs_source_t *source)
-{
-	std::lock_guard<std::mutex> lock(g_activeSourcesMutex);
-	g_activeSources.erase(source);
-}
-
-static void stopAllActiveSources()
-{
-	std::lock_guard<std::mutex> lock(g_activeSourcesMutex);
-	for (auto *source : g_activeSources) {
-		obs_source_media_stop(source);
-	}
-}
-
-static void handleObsEvent(enum obs_frontend_event event, void *)
-{
-	if (event == OBS_FRONTEND_EVENT_SCRIPTING_SHUTDOWN ||
-	    event == OBS_FRONTEND_EVENT_EXIT) {
-		stopAllActiveSources();
-	}
-}
-
-static bool setup()
-{
-	AddPluginPostLoadStep([]() {
-		obs_frontend_add_event_callback(handleObsEvent, nullptr);
-	});
-	return true;
-}
-
-static bool setupDone = setup();
-
 const std::string MacroActionPlayAudio::id = "play_audio";
 
 bool MacroActionPlayAudio::_registered = MacroActionFactory::Register(
@@ -69,7 +23,6 @@ bool MacroActionPlayAudio::_registered = MacroActionFactory::Register(
 
 static void deactivatePlayback(obs_source_t *source, bool wantsOutput)
 {
-	obs_source_media_stop(source);
 	if (wantsOutput) {
 		obs_set_output_source(kPlaybackOutputChannel, nullptr);
 	} else {
@@ -85,7 +38,8 @@ static void waitForPlaybackToEnd(Macro *macro, obs_source_t *source,
 	std::unique_lock<std::mutex> lock(*GetMutex());
 	SetMacroAbortWait(false);
 
-	// Poll until the source starts playing or the macro is stopped.
+	// The media source needs time to open and decode before reaching
+	// PLAYING state. Poll until it starts (or the macro is stopped).
 	while (!MacroWaitShouldAbort() && !MacroIsStopped(macro)) {
 		if (obs_source_media_get_state(source) ==
 		    OBS_MEDIA_STATE_PLAYING) {
@@ -94,8 +48,9 @@ static void waitForPlaybackToEnd(Macro *macro, obs_source_t *source,
 		GetMacroWaitCV().wait_for(lock, 10ms);
 	}
 
-	// Wait for playback to end. Two consecutive non-playing samples are
-	// required to avoid false positives on brief state transitions.
+	// Now wait for playback to end. Require two consecutive non-playing
+	// samples to avoid false positives on brief state transitions.
+	// If maxMs > 0, also stop once that many milliseconds have elapsed.
 	const auto playbackStart = std::chrono::steady_clock::now();
 	static const int kStopThreshold = 2;
 	int stoppedCount = 0;
@@ -140,6 +95,7 @@ bool MacroActionPlayAudio::PerformAction()
 	obs_data_set_string(settings, "local_file", path.c_str());
 	obs_data_set_bool(settings, "is_local_file", true);
 	obs_data_set_bool(settings, "looping", false);
+	// Disable automatic restart on activate so we control start explicitly.
 	obs_data_set_bool(settings, "restart_on_activate", false);
 	obs_data_set_bool(settings, "close_when_inactive", true);
 
@@ -157,11 +113,10 @@ bool MacroActionPlayAudio::PerformAction()
 		DecibelToPercent(static_cast<float>(_volumeDB.GetValue()));
 	obs_source_set_volume(source, vol);
 	obs_source_set_monitoring_type(source, _monitorType);
-	if (_mono) {
-		obs_source_set_flags(source, OBS_SOURCE_FLAG_FORCE_MONO);
-	}
 
-	// Fall back to monitor-only if all output tracks are deselected.
+	// Fall back to monitor-only if all output tracks are deselected —
+	// there is no point routing through the output channel if the mixer
+	// mask would silence every track.
 	const bool wantsOutput =
 		(_monitorType != OBS_MONITORING_TYPE_MONITOR_ONLY) &&
 		(_audioMixers != 0);
@@ -173,8 +128,10 @@ bool MacroActionPlayAudio::PerformAction()
 
 	if (wantsOutput) {
 		obs_source_set_audio_mixers(source, _audioMixers);
-		// Route through a private scene positioned off-screen so the
-		// audio mixes into the output without video appearing on screen.
+		// Route through a private scene so we can position the scene
+		// item far off-screen. This keeps the item "visible" (so audio
+		// is still mixed) while ensuring its video never intersects the
+		// output frame.
 		OBSSceneAutoRelease audioScene =
 			obs_scene_create_private("advss_audio_scene");
 		obs_sceneitem_t *item = obs_scene_add(audioScene, source);
@@ -184,7 +141,8 @@ bool MacroActionPlayAudio::PerformAction()
 		}
 		obs_set_output_source(kPlaybackOutputChannel,
 				      obs_scene_get_source(audioScene));
-		// audioScene is released here; the output channel keeps the scene alive.
+		// audioScene released here; the output channel holds the
+		// remaining reference and keeps the scene alive.
 	} else {
 		obs_source_set_audio_mixers(source, 0);
 		obs_source_inc_active(source);
@@ -209,15 +167,15 @@ bool MacroActionPlayAudio::PerformAction()
 		return true;
 	}
 
-	// Keep the source alive until playback ends via a background thread.
+	// Keep the source alive in a background thread that cleans up
+	// once playback finishes. Grab an extra strong reference so the
+	// source survives beyond this stack frame.
 	auto rawSource = obs_source_get_ref(source);
-	registerActiveSource(rawSource);
 	auto macro = GetMacro();
 
 	std::thread cleanupThread([rawSource, wantsOutput, macro, maxMs]() {
 		waitForPlaybackToEnd(macro, rawSource, maxMs);
 		deactivatePlayback(rawSource, wantsOutput);
-		unregisterActiveSource(rawSource);
 		obs_source_release(rawSource);
 	});
 	AddMacroHelperThread(macro, std::move(cleanupThread));
@@ -246,7 +204,6 @@ bool MacroActionPlayAudio::Save(obs_data_t *obj) const
 	obs_data_set_bool(obj, "useDuration", _useDuration);
 	_playbackDuration.Save(obj, "playbackDuration");
 	obs_data_set_bool(obj, "waitForCompletion", _waitForCompletion);
-	obs_data_set_bool(obj, "mono", _mono);
 	return true;
 }
 
@@ -264,7 +221,6 @@ bool MacroActionPlayAudio::Load(obs_data_t *obj)
 	_useDuration = obs_data_get_bool(obj, "useDuration");
 	_playbackDuration.Load(obj, "playbackDuration");
 	_waitForCompletion = obs_data_get_bool(obj, "waitForCompletion");
-	_mono = obs_data_get_bool(obj, "mono");
 	return true;
 }
 
@@ -306,9 +262,7 @@ MacroActionPlayAudioEdit::MacroActionPlayAudioEdit(
 	  _useDuration(new QCheckBox(this)),
 	  _playbackDuration(new DurationSelection(this, true, 0.0)),
 	  _waitForCompletion(new QCheckBox(
-		  obs_module_text("AdvSceneSwitcher.action.playAudio.wait"))),
-	  _mono(new QCheckBox(
-		  obs_module_text("AdvSceneSwitcher.action.playAudio.mono")))
+		  obs_module_text("AdvSceneSwitcher.action.playAudio.wait")))
 {
 	_volumeDB->setMinimum(-100.0);
 	_volumeDB->setMaximum(0.0);
@@ -349,8 +303,6 @@ MacroActionPlayAudioEdit::MacroActionPlayAudioEdit(
 			 SLOT(PlaybackDurationChanged(const Duration &)));
 	QWidget::connect(_waitForCompletion, SIGNAL(stateChanged(int)), this,
 			 SLOT(WaitChanged(int)));
-	QWidget::connect(_mono, SIGNAL(stateChanged(int)), this,
-			 SLOT(MonoChanged(int)));
 
 	auto tracksLayout = new QHBoxLayout;
 	tracksLayout->setContentsMargins(0, 0, 0, 0);
@@ -394,7 +346,6 @@ MacroActionPlayAudioEdit::MacroActionPlayAudioEdit(
 	mainLayout->addLayout(startOffsetLayout);
 	mainLayout->addLayout(playbackDurationLayout);
 	mainLayout->addWidget(_waitForCompletion);
-	mainLayout->addWidget(_mono);
 	setLayout(mainLayout);
 
 	_entryData = entryData;
@@ -424,7 +375,6 @@ void MacroActionPlayAudioEdit::UpdateEntryData()
 	_playbackDuration->SetDuration(_entryData->_playbackDuration);
 	_playbackDuration->setEnabled(_entryData->_useDuration);
 	_waitForCompletion->setChecked(_entryData->_waitForCompletion);
-	_mono->setChecked(_entryData->_mono);
 }
 
 void MacroActionPlayAudioEdit::FilePathChanged(const QString &path)
@@ -493,10 +443,4 @@ void MacroActionPlayAudioEdit::WaitChanged(int value)
 	_entryData->_waitForCompletion = value;
 }
 
-void MacroActionPlayAudioEdit::MonoChanged(int value)
-{
-	GUARD_LOADING_AND_LOCK();
-	_entryData->_mono = value;
-}
-
 } // namespace advss

plugins/base/macro-action-play-audio.hpp

@@ -37,7 +37,6 @@ public:
 	bool _useDuration = false;
 	Duration _playbackDuration;
 	bool _waitForCompletion = false;
-	bool _mono = false;
 
 	static bool _registered;
 	static const std::string id;
@@ -69,7 +68,6 @@ private slots:
 	void UseDurationChanged(int);
 	void PlaybackDurationChanged(const Duration &);
 	void WaitChanged(int value);
-	void MonoChanged(int value);
 
 signals:
 	void HeaderInfoChanged(const QString &);
@@ -85,7 +83,6 @@ private:
 	QCheckBox *_useDuration;
 	DurationSelection *_playbackDuration;
 	QCheckBox *_waitForCompletion;
-	QCheckBox *_mono;
 
 	std::shared_ptr<MacroActionPlayAudio> _entryData;
 	bool _loading = true;