Add audio tab (#36)

* add volumemeter widget * add audio tab UI * add checkAudioSwitch functionality * use constexpr instead of preprocessing
2026-09-08 09:36:07 -05:00 · 2020-09-21 00:52:42 +02:00
parent 3fd3801e56
commit 8d023ee385
16 changed files with 2087 additions and 92 deletions
--- a/src/headers/advanced-scene-switcher.hpp
+++ b/src/headers/advanced-scene-switcher.hpp
@@ -10,6 +10,7 @@
 #include "ui_advanced-scene-switcher.h"
 #endif
 #include "switcher-data-structs.hpp"
+#include "volume-control.hpp"

 class QCloseEvent;

@@ -21,6 +22,7 @@ class SceneSwitcher : public QDialog {

 public:
 	std::unique_ptr<Ui_SceneSwitcher> ui;
+	VolControl *volMeter = nullptr;
 	bool loading = true;

 	SceneSwitcher(QWidget *parent);
@@ -43,12 +45,14 @@ public:
 	int IgnoreIdleWindowsFindByData(const QString &window);
 	int randomFindByData(const QString &scene);
 	int timeFindByData(const timeTrigger &trigger, const QTime &time);
+	int audioFindByData(const QString &source, const int &volume);

 	void UpdateNonMatchingScene(const QString &name);
 	void UpdateAutoStopScene(const QString &name);
 	void UpdateAutoStartScene(const QString &name);
 	void UpdateIdleDataTransition(const QString &name);
 	void UpdateIdleDataScene(const QString &name);
+	void SetAudioVolumeMeter(const QString &name);

 	void loadUI();
 	void populateSceneSelection(QComboBox *sel, bool addPrevious);
@@ -66,6 +70,7 @@ public:
 	void setupMediaTab();
 	void setupFileTab();
 	void setupTimeTab();
+	void setupAudioTab();
 	void setTabOrder();

 public slots:
@@ -175,6 +180,13 @@ public slots:
 	void on_timeUp_clicked();
 	void on_timeDown_clicked();

+	void on_audioAdd_clicked();
+	void on_audioRemove_clicked();
+	void on_audioUp_clicked();
+	void on_audioDown_clicked();
+	void on_audioSwitches_currentRowChanged(int idx);
+	void on_audioSources_currentTextChanged(const QString &text);
+
 	void on_priorityUp_clicked();
 	void on_priorityDown_clicked();
 	void on_threadPriority_currentTextChanged(const QString &text);
@@ -182,6 +194,8 @@ public slots:
 	void updateScreenRegionCursorPos();

 	void on_close_clicked();
+
+private:
 };

 /********************************************************************************
@@ -234,9 +248,9 @@ void switchScene(OBSWeakSource &scene, OBSWeakSource &transition,
 * Hotkey helper
 ********************************************************************************/

-#define TOGGLE_HOTKEY_PATH "hotkey_toggle.txt"
-#define STOP_HOTKEY_PATH "hotkey_stop.txt"
-#define START_HOTKEY_PATH "hotkey_start.txt"
+constexpr auto toggle_hotkey_path = "hotkey_toggle.txt";
+constexpr auto stop_hotkey_path = "hotkey_stop.txt";
+constexpr auto start_hotkey_path = "hotkey_start.txt";

 void stopHotkeyFunc(void *data, obs_hotkey_id id, obs_hotkey_t *hotkey,
 		    bool pressed);
--- a/src/headers/switcher-data-structs.hpp
+++ b/src/headers/switcher-data-structs.hpp
@@ -11,29 +11,31 @@
 #include <curl/curl.h>
 #include "utility.hpp"

-#define DEFAULT_INTERVAL 300
+constexpr auto default_interval = 300;

-#define DEFAULT_IDLE_TIME 60
+constexpr auto default_idle_time = 60;

-#define PREVIOUS_SCENE_NAME "Previous Scene"
+constexpr auto previous_scene_name = "Previous Scene";

-#define READ_FILE_FUNC 0
-#define ROUND_TRIP_FUNC 1
-#define IDLE_FUNC 2
-#define EXE_FUNC 3
-#define SCREEN_REGION_FUNC 4
-#define WINDOW_TITLE_FUNC 5
-#define MEDIA_FUNC 6
-#define TIME_FUNC 7
+constexpr auto read_file_func = 0;
+constexpr auto round_trip_func = 1;
+constexpr auto idle_func = 2;
+constexpr auto exe_func = 3;
+constexpr auto screen_region_func = 4;
+constexpr auto window_title_func = 5;
+constexpr auto media_func = 6;
+constexpr auto time_func = 7;
+constexpr auto audio_func = 8;

-#define DEFAULT_PRIORITY_0 READ_FILE_FUNC
-#define DEFAULT_PRIORITY_1 ROUND_TRIP_FUNC
-#define DEFAULT_PRIORITY_2 IDLE_FUNC
-#define DEFAULT_PRIORITY_3 EXE_FUNC
-#define DEFAULT_PRIORITY_4 SCREEN_REGION_FUNC
-#define DEFAULT_PRIORITY_5 WINDOW_TITLE_FUNC
-#define DEFAULT_PRIORITY_6 MEDIA_FUNC
-#define DEFAULT_PRIORITY_7 TIME_FUNC
+constexpr auto default_priority_0 = read_file_func;
+constexpr auto default_priority_1 = round_trip_func;
+constexpr auto default_priority_2 = idle_func;
+constexpr auto default_priority_3 = exe_func;
+constexpr auto default_priority_4 = screen_region_func;
+constexpr auto default_priority_5 = window_title_func;
+constexpr auto default_priority_6 = media_func;
+constexpr auto default_priority_7 = time_func;
+constexpr auto default_priority_8 = audio_func;

 /********************************************************************************
 * Data structs for each scene switching method
@@ -199,7 +201,7 @@ struct FileIOData {

 struct IdleData {
 	bool idleEnable = false;
-	int time = DEFAULT_IDLE_TIME;
+	int time = default_idle_time;
 	OBSWeakSource scene;
 	OBSWeakSource transition;
 	bool usePreviousScene;
@@ -238,7 +240,6 @@ struct TimeSwitch {
 	OBSWeakSource transition;
 	timeTrigger trigger;
 	QTime time;
-	bool matched;
 	bool usePreviousScene;
 	std::string timeSwitchStr;

@@ -255,6 +256,107 @@ struct TimeSwitch {
 	}
 };

+struct AudioSwitch {
+	OBSWeakSource scene;
+	OBSWeakSource audioSource;
+	OBSWeakSource transition;
+	int volumeThreshold;
+	float peak;
+	bool usePreviousScene;
+	obs_volmeter_t *volmeter;
+	std::string audioSwitchStr;
+
+	static void setVolumeLevel(void *data,
+				   const float magnitude[MAX_AUDIO_CHANNELS],
+				   const float peak[MAX_AUDIO_CHANNELS],
+				   const float inputPeak[MAX_AUDIO_CHANNELS])
+	{
+		UNUSED_PARAMETER(magnitude);
+		UNUSED_PARAMETER(inputPeak);
+		AudioSwitch *s = static_cast<AudioSwitch *>(data);
+
+		s->peak = peak[0];
+		for (int i = 1; i < MAX_AUDIO_CHANNELS; i++)
+			if (peak[i] > s->peak)
+				s->peak = peak[i];
+	}
+
+	inline AudioSwitch(OBSWeakSource scene_, OBSWeakSource transition_,
+			   OBSWeakSource audioSource_, int volumeThreshold_,
+			   bool usePreviousScene_, std::string audioSwitchStr_)
+		: scene(scene_),
+		  transition(transition_),
+		  audioSource(audioSource_),
+		  volumeThreshold(volumeThreshold_),
+		  usePreviousScene(usePreviousScene_),
+		  audioSwitchStr(audioSwitchStr_)
+	{
+		volmeter = obs_volmeter_create(OBS_FADER_LOG);
+		obs_volmeter_add_callback(volmeter, setVolumeLevel, this);
+		obs_source_t *as = obs_weak_source_get_source(audioSource);
+		if (!obs_volmeter_attach_source(volmeter, as)) {
+			const char *name = obs_source_get_name(as);
+			blog(LOG_WARNING,
+			     "failed to attach volmeter to source %s", name);
+		}
+		obs_source_release(as);
+	}
+
+	AudioSwitch(const AudioSwitch &other)
+		: scene(other.scene),
+		  transition(other.transition),
+		  audioSource(other.audioSource),
+		  volumeThreshold(other.volumeThreshold),
+		  usePreviousScene(other.usePreviousScene),
+		  audioSwitchStr(other.audioSwitchStr)
+	{
+		volmeter = obs_volmeter_create(OBS_FADER_LOG);
+		obs_volmeter_add_callback(volmeter, setVolumeLevel, this);
+		obs_source_t *as =
+			obs_weak_source_get_source(other.audioSource);
+		if (!obs_volmeter_attach_source(volmeter, as)) {
+			const char *name = obs_source_get_name(as);
+			blog(LOG_WARNING,
+			     "failed to attach volmeter to source %s", name);
+		}
+		obs_source_release(as);
+	}
+
+	AudioSwitch(AudioSwitch &&other)
+		: scene(other.scene),
+		  transition(other.transition),
+		  audioSource(other.audioSource),
+		  volumeThreshold(other.volumeThreshold),
+		  usePreviousScene(other.usePreviousScene),
+		  audioSwitchStr(other.audioSwitchStr),
+		  volmeter(other.volmeter)
+	{
+		other.volmeter = nullptr;
+	}
+
+	inline ~AudioSwitch()
+	{
+		obs_volmeter_remove_callback(volmeter, setVolumeLevel, this);
+		obs_volmeter_destroy(volmeter);
+	}
+
+	AudioSwitch &operator=(const AudioSwitch &other)
+	{
+		return *this = AudioSwitch(other);
+	}
+
+	AudioSwitch &operator=(AudioSwitch &&other) noexcept
+	{
+		if (this == &other) {
+			return *this;
+		}
+		obs_volmeter_destroy(volmeter);
+		volmeter = other.volmeter;
+		other.volmeter = nullptr;
+		return *this;
+	}
+};
+
 typedef enum { NO_SWITCH = 0, SWITCH = 1, RANDOM_SWITCH = 2 } NoMatch;
 typedef enum { PERSIST = 0, START = 1, STOP = 2 } StartupBehavior;
 typedef enum {
@@ -280,7 +382,7 @@ struct SwitcherData {
 	bool verbose = false;
 	bool tansitionOverrideOverride = false;

-	int interval = DEFAULT_INTERVAL;
+	int interval = default_interval;

 	obs_source_t *waitScene = NULL; //scene during which wait started
 	OBSWeakSource previousScene = NULL;
@@ -330,10 +432,12 @@ struct SwitcherData {
 	std::vector<TimeSwitch> timeSwitches;
 	QDateTime liveTime;

+	std::vector<AudioSwitch> audioSwitches;
+
 	std::vector<int> functionNamesByPriority = std::vector<int>{
-		DEFAULT_PRIORITY_0, DEFAULT_PRIORITY_1, DEFAULT_PRIORITY_2,
-		DEFAULT_PRIORITY_3, DEFAULT_PRIORITY_4, DEFAULT_PRIORITY_5,
-		DEFAULT_PRIORITY_6, DEFAULT_PRIORITY_7};
+		default_priority_0, default_priority_1, default_priority_2,
+		default_priority_3, default_priority_4, default_priority_5,
+		default_priority_6, default_priority_7, default_priority_8};

 	struct ThreadPrio {
 		std::string name;
@@ -396,6 +500,8 @@ struct SwitcherData {
 			      OBSWeakSource &transition);
 	void checkTimeSwitch(bool &match, OBSWeakSource &scene,
 			     OBSWeakSource &transition);
+	void checkAudioSwitch(bool &match, OBSWeakSource &scene,
+			      OBSWeakSource &transition);

 	void saveWindowTitleSwitches(obs_data_t *obj);
 	void saveScreenRegionSwitches(obs_data_t *obj);
@@ -408,6 +514,7 @@ struct SwitcherData {
 	void saveFileSwitches(obs_data_t *obj);
 	void saveMediaSwitches(obs_data_t *obj);
 	void saveTimeSwitches(obs_data_t *obj);
+	void saveAudioSwitches(obs_data_t *obj);
 	void saveGeneralSettings(obs_data_t *obj);

 	void loadWindowTitleSwitches(obs_data_t *obj);
@@ -421,6 +528,7 @@ struct SwitcherData {
 	void loadFileSwitches(obs_data_t *obj);
 	void loadMediaSwitches(obs_data_t *obj);
 	void loadTimeSwitches(obs_data_t *obj);
+	void loadAudioSwitches(obs_data_t *obj);
 	void loadGeneralSettings(obs_data_t *obj);

 	void Prune()
@@ -531,6 +639,15 @@ struct SwitcherData {
 				mediaSwitches.erase(mediaSwitches.begin() +
 						    i--);
 		}
+
+		for (size_t i = 0; i < audioSwitches.size(); i++) {
+			AudioSwitch &s = audioSwitches[i];
+			if ((!s.usePreviousScene &&
+			     !WeakSourceValid(s.scene)) ||
+			    !WeakSourceValid(s.transition))
+				audioSwitches.erase(audioSwitches.begin() +
+						    i--);
+		}
 	}
 	inline ~SwitcherData() { Stop(); }
 };
--- a/src/headers/utility.hpp
+++ b/src/headers/utility.hpp
@@ -224,6 +224,19 @@ static inline QString MakeTimeSwitchName(const QString &scene,
 	return switchName;
 }

+static inline QString MakeAudioSwitchName(const QString &scene,
+					  const QString &transition,
+					  const QString &audioSrouce,
+					  const int &volume)
+{
+	QString switchName = QStringLiteral("When volume of ") + audioSrouce +
+			     QStringLiteral(" is above ") +
+			     QString::number(volume) +
+			     QStringLiteral("% switch to ") + scene +
+			     QStringLiteral(" using ") + transition;
+	return switchName;
+}
+
 static inline std::string GetWeakSourceName(obs_weak_source_t *weak_source)
 {
 	std::string name;
--- a/src/headers/volume-control.hpp
+++ b/src/headers/volume-control.hpp
@@ -0,0 +1,245 @@
+#pragma once
+
+#include <obs.hpp>
+#include <QWidget>
+#include <QPaintEvent>
+#include <QSharedPointer>
+#include <QTimer>
+#include <QMutex>
+#include <QList>
+
+class QPushButton;
+class VolumeMeterTimer;
+
+class VolumeMeter : public QWidget {
+	Q_OBJECT
+	Q_PROPERTY(QColor backgroundNominalColor READ getBackgroundNominalColor
+			   WRITE setBackgroundNominalColor DESIGNABLE true)
+	Q_PROPERTY(QColor backgroundWarningColor READ getBackgroundWarningColor
+			   WRITE setBackgroundWarningColor DESIGNABLE true)
+	Q_PROPERTY(QColor backgroundErrorColor READ getBackgroundErrorColor
+			   WRITE setBackgroundErrorColor DESIGNABLE true)
+	Q_PROPERTY(QColor foregroundNominalColor READ getForegroundNominalColor
+			   WRITE setForegroundNominalColor DESIGNABLE true)
+	Q_PROPERTY(QColor foregroundWarningColor READ getForegroundWarningColor
+			   WRITE setForegroundWarningColor DESIGNABLE true)
+	Q_PROPERTY(QColor foregroundErrorColor READ getForegroundErrorColor
+			   WRITE setForegroundErrorColor DESIGNABLE true)
+	Q_PROPERTY(QColor clipColor READ getClipColor WRITE setClipColor
+			   DESIGNABLE true)
+	Q_PROPERTY(QColor magnitudeColor READ getMagnitudeColor WRITE
+			   setMagnitudeColor DESIGNABLE true)
+	Q_PROPERTY(QColor majorTickColor READ getMajorTickColor WRITE
+			   setMajorTickColor DESIGNABLE true)
+	Q_PROPERTY(QColor minorTickColor READ getMinorTickColor WRITE
+			   setMinorTickColor DESIGNABLE true)
+
+	// Levels are denoted in dBFS.
+	Q_PROPERTY(qreal minimumLevel READ getMinimumLevel WRITE setMinimumLevel
+			   DESIGNABLE true)
+	Q_PROPERTY(qreal warningLevel READ getWarningLevel WRITE setWarningLevel
+			   DESIGNABLE true)
+	Q_PROPERTY(qreal errorLevel READ getErrorLevel WRITE setErrorLevel
+			   DESIGNABLE true)
+	Q_PROPERTY(qreal clipLevel READ getClipLevel WRITE setClipLevel
+			   DESIGNABLE true)
+	Q_PROPERTY(qreal minimumInputLevel READ getMinimumInputLevel WRITE
+			   setMinimumInputLevel DESIGNABLE true)
+
+	// Rates are denoted in dB/second.
+	Q_PROPERTY(qreal peakDecayRate READ getPeakDecayRate WRITE
+			   setPeakDecayRate DESIGNABLE true)
+
+	// Time in seconds for the VU meter to integrate over.
+	Q_PROPERTY(
+		qreal magnitudeIntegrationTime READ getMagnitudeIntegrationTime
+			WRITE setMagnitudeIntegrationTime DESIGNABLE true)
+
+	// Duration is denoted in seconds.
+	Q_PROPERTY(qreal peakHoldDuration READ getPeakHoldDuration WRITE
+			   setPeakHoldDuration DESIGNABLE true)
+	Q_PROPERTY(qreal inputPeakHoldDuration READ getInputPeakHoldDuration
+			   WRITE setInputPeakHoldDuration DESIGNABLE true)
+
+private slots:
+	void ClipEnding();
+
+private:
+	obs_volmeter_t *obs_volmeter;
+	static QWeakPointer<VolumeMeterTimer> updateTimer;
+	QSharedPointer<VolumeMeterTimer> updateTimerRef;
+
+	inline void resetLevels();
+	inline void handleChannelCofigurationChange();
+	inline bool detectIdle(uint64_t ts);
+	inline void calculateBallistics(uint64_t ts,
+					qreal timeSinceLastRedraw = 0.0);
+	inline void calculateBallisticsForChannel(int channelNr, uint64_t ts,
+						  qreal timeSinceLastRedraw);
+
+	void paintInputMeter(QPainter &painter, int x, int y, int width,
+			     int height, float peakHold);
+	void paintHMeter(QPainter &painter, int x, int y, int width, int height,
+			 float magnitude, float peak, float peakHold);
+	void paintHTicks(QPainter &painter, int x, int y, int width,
+			 int height);
+	void paintVMeter(QPainter &painter, int x, int y, int width, int height,
+			 float magnitude, float peak, float peakHold);
+	void paintVTicks(QPainter &painter, int x, int y, int height);
+
+	QMutex dataMutex;
+
+	uint64_t currentLastUpdateTime = 0;
+	float currentMagnitude[MAX_AUDIO_CHANNELS];
+	float currentPeak[MAX_AUDIO_CHANNELS];
+	float currentInputPeak[MAX_AUDIO_CHANNELS];
+
+	QPixmap *tickPaintCache = nullptr;
+	int displayNrAudioChannels = 0;
+	float displayMagnitude[MAX_AUDIO_CHANNELS];
+	float displayPeak[MAX_AUDIO_CHANNELS];
+	float displayPeakHold[MAX_AUDIO_CHANNELS];
+	uint64_t displayPeakHoldLastUpdateTime[MAX_AUDIO_CHANNELS];
+	float displayInputPeakHold[MAX_AUDIO_CHANNELS];
+	uint64_t displayInputPeakHoldLastUpdateTime[MAX_AUDIO_CHANNELS];
+
+	QFont tickFont;
+	QColor backgroundNominalColor;
+	QColor backgroundWarningColor;
+	QColor backgroundErrorColor;
+	QColor foregroundNominalColor;
+	QColor foregroundWarningColor;
+	QColor foregroundErrorColor;
+	QColor clipColor;
+	QColor magnitudeColor;
+	QColor majorTickColor;
+	QColor minorTickColor;
+	qreal minimumLevel;
+	qreal warningLevel;
+	qreal errorLevel;
+	qreal clipLevel;
+	qreal minimumInputLevel;
+	qreal peakDecayRate;
+	qreal magnitudeIntegrationTime;
+	qreal peakHoldDuration;
+	qreal inputPeakHoldDuration;
+
+	uint64_t lastRedrawTime = 0;
+	int channels = 0;
+	bool clipping = false;
+	bool vertical;
+
+public:
+	explicit VolumeMeter(QWidget *parent = nullptr,
+			     obs_volmeter_t *obs_volmeter = nullptr,
+			     bool vertical = false);
+	~VolumeMeter();
+
+	void setLevels(const float magnitude[MAX_AUDIO_CHANNELS],
+		       const float peak[MAX_AUDIO_CHANNELS],
+		       const float inputPeak[MAX_AUDIO_CHANNELS]);
+
+	QColor getBackgroundNominalColor() const;
+	void setBackgroundNominalColor(QColor c);
+	QColor getBackgroundWarningColor() const;
+	void setBackgroundWarningColor(QColor c);
+	QColor getBackgroundErrorColor() const;
+	void setBackgroundErrorColor(QColor c);
+	QColor getForegroundNominalColor() const;
+	void setForegroundNominalColor(QColor c);
+	QColor getForegroundWarningColor() const;
+	void setForegroundWarningColor(QColor c);
+	QColor getForegroundErrorColor() const;
+	void setForegroundErrorColor(QColor c);
+	QColor getClipColor() const;
+	void setClipColor(QColor c);
+	QColor getMagnitudeColor() const;
+	void setMagnitudeColor(QColor c);
+	QColor getMajorTickColor() const;
+	void setMajorTickColor(QColor c);
+	QColor getMinorTickColor() const;
+	void setMinorTickColor(QColor c);
+	qreal getMinimumLevel() const;
+	void setMinimumLevel(qreal v);
+	qreal getWarningLevel() const;
+	void setWarningLevel(qreal v);
+	qreal getErrorLevel() const;
+	void setErrorLevel(qreal v);
+	qreal getClipLevel() const;
+	void setClipLevel(qreal v);
+	qreal getMinimumInputLevel() const;
+	void setMinimumInputLevel(qreal v);
+	qreal getPeakDecayRate() const;
+	void setPeakDecayRate(qreal v);
+	qreal getMagnitudeIntegrationTime() const;
+	void setMagnitudeIntegrationTime(qreal v);
+	qreal getPeakHoldDuration() const;
+	void setPeakHoldDuration(qreal v);
+	qreal getInputPeakHoldDuration() const;
+	void setInputPeakHoldDuration(qreal v);
+	void setPeakMeterType(enum obs_peak_meter_type peakMeterType);
+	virtual void mousePressEvent(QMouseEvent *event) override;
+
+protected:
+	void paintEvent(QPaintEvent *event) override;
+};
+
+class VolumeMeterTimer : public QTimer {
+	Q_OBJECT
+
+public:
+	inline VolumeMeterTimer() : QTimer() {}
+
+	void AddVolControl(VolumeMeter *meter);
+	void RemoveVolControl(VolumeMeter *meter);
+
+protected:
+	void timerEvent(QTimerEvent *event) override;
+	QList<VolumeMeter *> volumeMeters;
+};
+
+class QLabel;
+class QSlider;
+class MuteCheckBox;
+
+class VolControl : public QWidget {
+	Q_OBJECT
+
+private:
+	OBSSource source;
+	QLabel *nameLabel;
+	QLabel *volLabel;
+	VolumeMeter *volMeter;
+	QSlider *slider;
+	float levelTotal;
+	float levelCount;
+	obs_fader_t *obs_fader;
+	obs_volmeter_t *obs_volmeter;
+	bool vertical;
+
+	static void OBSVolumeChanged(void *param, float db);
+	static void OBSVolumeLevel(void *data,
+				   const float magnitude[MAX_AUDIO_CHANNELS],
+				   const float peak[MAX_AUDIO_CHANNELS],
+				   const float inputPeak[MAX_AUDIO_CHANNELS]);
+
+private slots:
+	void SliderChanged(int vol);
+	void updateText();
+
+public:
+	explicit VolControl(OBSSource source, bool vertical = false);
+	~VolControl();
+
+	inline obs_source_t *GetSource() const { return source; }
+
+	QString GetName() const;
+	void SetName(const QString &newName);
+
+	void SetMeterDecayRate(qreal q);
+	void setPeakMeterType(enum obs_peak_meter_type peakMeterType);
+
+	void EnableSlider(bool enable);
+
+	QSlider *GetSlider() const;
+};