UI: Add to Settings > Audio ASIO monitoring

This adds a QToolButton to the Audio Settings on Windows.
This triggers in turn a dedicated settings for the ASIO monitoring
output.
If no ASIO driver is detected in the system, the panel displays an
explanatory message.
The panel allows to:
- select an ASIO monitoring device;
- for each output channel of the ASIO device, one can select any channel
from any of the 6 tracks or from the monitoring mix.

Signed-off-by: pkv <[email protected]>

Author: pkviet

frontend/data/locale/en-US.ini

@@ -1312,6 +1312,8 @@ Basic.Settings.Advanced.Video.HdrNominalPeakLevel="HDR Nominal Peak Level"
 Basic.Settings.Advanced.Audio.MonitoringDevice="Monitoring Device"
 Basic.Settings.Advanced.Audio.MonitoringDevice.Default="Default"
 Basic.Settings.Advanced.Audio.DisableAudioDucking="Disable Windows audio ducking"
+Basic.Settings.Advanced.Audio.AsioMonitoringDevice="ASIO Monitoring Device"
+Basic.Settings.Audio.AsioMonitoring="Setup Panel"
 Basic.Settings.Advanced.StreamDelay="Stream Delay"
 Basic.Settings.Advanced.StreamDelay.Duration="Duration"
 Basic.Settings.Advanced.StreamDelay.Preserve="Preserve cutoff point (increase delay) when reconnecting"

frontend/data/themes/Yami.obt

@@ -1406,6 +1406,12 @@ QPushButton::menu-indicator {
     width: 25px;
 }
 
+QWidget QFormLayout > QToolButton#asioMonitoring {
+  min-width: 0px;
+  max-width: 16777215px;
+  text-align: center;
+}
+
 QToolButton {
     border: 1px solid var(--button_border);
 }

frontend/forms/OBSBasicSettings.ui

@@ -6327,6 +6327,29 @@
                      </property>
                     </widget>
                    </item>
+                   <item row="3" column="0">
+                    <widget class="QLabel" name="asioDeviceLabel">
+                     <property name="text">
+                      <string>Basic.Settings.Advanced.Audio.AsioMonitoringDevice</string>
+                     </property>
+                     <property name="buddy">
+                      <cstring>asioMonitoring</cstring>
+                     </property>
+                    </widget>
+                   </item>
+                   <item row="3" column="1">
+                    <widget class="QToolButton" name="asioMonitoring">
+                     <property name="text">
+                      <string>Basic.Settings.Audio.AsioMonitoring</string>
+                     </property>
+                     <property name="objectName">
+                      <string>asioMonitoring</string>
+                     </property>
+                     <property name="sizePolicy">
+                      <sizepolicy hsizetype="Minimum" vsizetype="Fixed"/>
+                     </property>
+                    </widget>
+                   </item>
                   </layout>
                  </widget>
                 </item>
@@ -8955,6 +8978,7 @@
   <tabstop>meterDecayRate</tabstop>
   <tabstop>peakMeterType</tabstop>
   <tabstop>monitoringDevice</tabstop>
+  <tabstop>asioMonitoring</tabstop>
   <tabstop>disableAudioDucking</tabstop>
   <tabstop>lowLatencyBuffering</tabstop>
   <tabstop>baseResolution</tabstop>

frontend/plugins/asio-output-ui/ASIOSettingsDialog.cpp

@@ -38,22 +38,30 @@ ASIOSettingsDialog::ASIOSettingsDialog(QWidget *parent, obs_output_t *output, OB
 	propertiesView = nullptr;
 }
 
-void ASIOSettingsDialog::ShowHideDialog()
+void ASIOSettingsDialog::ShowHideDialog(bool enabled)
 {
-	SetupPropertiesView();
+	SetupPropertiesView(enabled);
 	setVisible(!isVisible());
 }
 
-void ASIOSettingsDialog::SetupPropertiesView()
+void ASIOSettingsDialog::SetupPropertiesView(bool enabled)
 {
 	if (propertiesView)
 		delete propertiesView;
 
 	propertiesView = new OBSPropertiesView(settings_, "asio_output",
 					       (PropertiesReloadCallback)obs_get_output_properties, 170);
 
-	ui->propertiesLayout->addWidget(propertiesView);
-	currentDeviceName = g_currentDeviceName;
+	if (enabled) {
+		ui->propertiesLayout->addWidget(propertiesView);
+		currentDeviceName = g_currentDeviceName;
+	} else {
+		QLabel *noAsioLabel = new QLabel(obs_module_text("AsioOutput.Disabled"), this);
+		noAsioLabel->setWordWrap(true);
+		noAsioLabel->setAlignment(Qt::AlignCenter);
+		ui->propertiesLayout->addWidget(noAsioLabel);
+		adjustSize();
+	}
 
 	connect(propertiesView, &OBSPropertiesView::Changed, this, &ASIOSettingsDialog::PropertiesChanged);
 }

frontend/plugins/asio-output-ui/ASIOSettingsDialog.h

@@ -31,6 +31,7 @@
 #include <QDialog>
 #include <QAction>
 #include <QMainWindow>
+#include <QLabel>
 
 #include "./forms/ui_output.h"
 
@@ -42,8 +43,8 @@ class ASIOSettingsDialog : public QDialog {
 public:
 	explicit ASIOSettingsDialog(QWidget *parent = 0, obs_output_t *output = nullptr, OBSData settings = nullptr);
 	std::unique_ptr<Ui_Output> ui;
-	void ShowHideDialog();
-	void SetupPropertiesView();
+	void ShowHideDialog(bool enabled);
+	void SetupPropertiesView(bool enabled);
 	void SaveSettings();
 	OBSData settings_;
 	obs_output_t *output_;

frontend/plugins/asio-output-ui/asio-ui-main.cpp

@@ -20,6 +20,8 @@
 #include <obs-frontend-api.h>
 #include <QMainWindow>
 #include <QAction>
+#include <QScreen>
+
 #include <util/util.hpp>
 #include <util/platform.h>
 #include "ASIOSettingsDialog.h"
@@ -86,21 +88,49 @@ void output_start()
 	}
 }
 
+void callback()
+{
+	QMainWindow *mainWindow = (QMainWindow *)obs_frontend_get_main_window();
+	QWidget *obsSettingsDialog = nullptr;
+	const auto topLevels = QApplication::topLevelWidgets();
+	for (QWidget *widget : topLevels) {
+		if (widget->isVisible() && QString(widget->metaObject()->className()).contains("OBSBasicSettings")) {
+			obsSettingsDialog = widget;
+			break;
+		}
+	}
+	if (!settingsDialog_) {
+		if (!obsSettingsDialog)
+			settingsDialog_ = new ASIOSettingsDialog(mainWindow, context.output, context.settings);
+		else
+			settingsDialog_ = new ASIOSettingsDialog(obsSettingsDialog, context.output, context.settings);
+		settingsDialog_->setAttribute(Qt::WA_DeleteOnClose);
+		QObject::connect(settingsDialog_, &QObject::destroyed, []() { settingsDialog_ = nullptr; });
+	}
+
+	settingsDialog_->ShowHideDialog(context.enabled);
+	if (obsSettingsDialog) {
+		QRect settingsRect = obsSettingsDialog->geometry();
+		QRect asioRect = settingsDialog_->geometry();
+		QPoint newPos(settingsRect.right() + 100, settingsRect.top());
+		QScreen *screen = obsSettingsDialog->screen();
+		QRect desktopRect = screen->availableGeometry();
+		if (newPos.x() + asioRect.width() > desktopRect.right())
+			newPos.setX(desktopRect.right() - asioRect.width());
+		settingsDialog_->move(newPos);
+	}
+}
+
 void addOutputUI(void)
 {
 	QAction *action = (QAction *)obs_frontend_add_tools_menu_qaction(obs_module_text("AsioOutput.Menu"));
-
-	QMainWindow *mainWindow = (QMainWindow *)obs_frontend_get_main_window();
+	action->setObjectName("asioOutputSetupAction");
 
 	obs_frontend_push_ui_translation(obs_module_get_string);
-	settingsDialog_ = new ASIOSettingsDialog(mainWindow, context.output, context.settings);
 	obs_frontend_pop_ui_translation();
-
-	auto cb = []() {
-		settingsDialog_->ShowHideDialog();
-	};
-
-	action->connect(action, &QAction::triggered, cb);
+	// the UI is added through the callback, which is triggered in OBS Audio Settings
+	action->connect(action, &QAction::triggered, callback);
+	action->setVisible(false);
 }
 
 static void OBSEvent(enum obs_frontend_event event, void *)
@@ -131,10 +161,15 @@ void obs_module_unload(void)
 	if (output_running)
 		output_stop();
 
-	obs_output_release(context.output);
-	context.output = nullptr;
-	obs_data_release(context.settings);
-	context.settings = nullptr;
+	if (context.output) {
+		obs_output_release(context.output);
+		context.output = nullptr;
+	}
+
+	if (context.settings) {
+		obs_data_release(context.settings);
+		context.settings = nullptr;
+	}
 	obs_frontend_remove_event_callback(OBSEvent, nullptr);
 }
 
@@ -144,8 +179,11 @@ void obs_module_post_load(void)
 		return;
 
 	context.settings = load_settings();
+
 	obs_output_t *const output = obs_output_create("asio_output", "asio_output", context.settings, NULL);
+
 	if (output != nullptr) {
+		context.enabled = true;
 		context.output = output;
 
 		if (!context.settings) {
@@ -156,5 +194,7 @@ void obs_module_post_load(void)
 		obs_frontend_add_event_callback(OBSEvent, nullptr);
 	} else {
 		blog(LOG_INFO, "Failed to create ASIO output");
+		// we add the UI even if there is no output to display a text saying ASIO is disabled
+		addOutputUI();
 	}
 }

frontend/plugins/asio-output-ui/data/locale/en-US.ini

@@ -1 +1,2 @@
-AsioOutput.Menu="ASIO Output"
+AsioOutput.Menu="ASIO Output"
+AsioOutput.Disabled="No ASIO audio driver was detected in your system. ASIO monitoring is disabled."

frontend/settings/OBSBasicSettings.cpp

@@ -719,6 +719,14 @@ OBSBasicSettings::OBSBasicSettings(QWidget *parent)
 	if (obs_audio_monitoring_available())
 		FillAudioMonitoringDevices();
 
+#ifdef _WIN32
+	connect(ui->asioMonitoring, &QPushButton::clicked, this, &OBSBasicSettings::AsioMonitoringShow);
+	ui->asioMonitoring->setSizePolicy(QSizePolicy::Minimum, QSizePolicy::Fixed);
+	ui->formLayout_56->setAlignment(ui->asioMonitoring, Qt::AlignLeft);
+#else
+	ui->asioMonitoring->hide();
+	ui->asioDeviceLabel->hide();
+#endif
 	connect(ui->channelSetup, &QComboBox::currentIndexChanged, this, &OBSBasicSettings::SurroundWarning);
 	connect(ui->channelSetup, &QComboBox::currentIndexChanged, this, &OBSBasicSettings::SpeakerLayoutChanged);
 	connect(ui->lowLatencyBuffering, &QCheckBox::clicked, this, &OBSBasicSettings::LowLatencyBufferingChanged);
@@ -5288,6 +5296,23 @@ void OBSBasicSettings::SimpleRecordingEncoderChanged()
 	ui->simpleOutInfoLayout->addWidget(simpleOutRecWarning);
 }
 
+#ifdef _WIN32
+void OBSBasicSettings::AsioMonitoringShow()
+{
+	QList<QAction *> actions = main->ui->menuTools->actions();
+	QAction *asioAction = nullptr;
+	for (QAction *action : actions) {
+		if (action->objectName() == "asioOutputSetupAction") {
+			asioAction = action;
+			break;
+		}
+	}
+	if (asioAction) {
+		asioAction->trigger();
+	}
+}
+#endif
+
 void OBSBasicSettings::SurroundWarning(int idx)
 {
 	if (idx == lastChannelSetupIdx || idx == -1)

frontend/settings/OBSBasicSettings.hpp

@@ -396,6 +396,9 @@ private slots:
 	void AudioChanged();
 	void AudioChangedRestart();
 	void ReloadAudioSources();
+#ifdef _WIN32
+	void AsioMonitoringShow();
+#endif
 	void SurroundWarning(int idx);
 	void SpeakerLayoutChanged(int idx);
 	void LowLatencyBufferingChanged(bool checked);