Add MIDI device name check

Author: WarmUpTill

data/locale/en-US.ini

@@ -545,7 +545,11 @@ AdvSceneSwitcher.condition.run="Run"
 AdvSceneSwitcher.condition.run.entry="Process exits before timeout of{{timeout}}seconds"
 AdvSceneSwitcher.condition.run.entry.exit="{{checkExitCode}}Check for exit code{{exitCode}}"
 AdvSceneSwitcher.condition.midi="MIDI"
-AdvSceneSwitcher.condition.midi.entry="Mesasge was received from{{device}}which matches:"
+AdvSceneSwitcher.condition.midi.condition.message="MIDI message was received"
+AdvSceneSwitcher.condition.midi.condition.deviceName="MIDI device is connected"
+AdvSceneSwitcher.condition.midi.condition.deviceName.info="On some platforms with certain APIs MIDI devices which were already disconnected might still be reported as connected.\nSo this type of check might not be 100% reliable in all circumstances."
+AdvSceneSwitcher.condition.midi.entry.message="{{conditions}}from{{device}}which matches:"
+AdvSceneSwitcher.condition.midi.entry.deviceName="{{conditions}}{{deviceNames}}{{regex}}{{deviceListInfo}}"
 AdvSceneSwitcher.condition.midi.entry.listen="Set MIDI message selection to messages incoming on selected device:{{listenButton}}"
 AdvSceneSwitcher.condition.display="Display"
 AdvSceneSwitcher.condition.display.type.displayName="Name of connected displays matches"

data/locale/fr-FR.ini

@@ -447,7 +447,6 @@ AdvSceneSwitcher.condition.run="Exécution"
 AdvSceneSwitcher.condition.run.entry="Le processus se termine avant le délai de{{timeout}}secondes"
 AdvSceneSwitcher.condition.run.entry.exit="{{checkExitCode}}Vérifier le code de sortie{{exitCode}}
 AdvSceneSwitcher.condition.midi="MIDI"
-AdvSceneSwitcher.condition.midi.entry="Message reçu depuis{{device}}qui correspond à :"
 AdvSceneSwitcher.condition.midi.entry.listen="Définir la sélection des messages MIDI pour les messages entrants sur l'appareil sélectionné :{{listenButton}}"
 AdvSceneSwitcher.condition.display="Affichage"
 AdvSceneSwitcher.condition.display.type.displayName="Le nom des écrans connectés correspond à"

data/locale/zh-CN.ini

@@ -435,7 +435,6 @@ AdvSceneSwitcher.condition.run="运行"
 AdvSceneSwitcher.condition.run.entry="进程在超时 {{timeout}} 秒之前退出"
 AdvSceneSwitcher.condition.run.entry.exit="{{checkExitCode}}检查退出代码{{exitCode}}"
 AdvSceneSwitcher.condition.midi="MIDI"
-AdvSceneSwitcher.condition.midi.entry="从{{device}} 收到的信息,符合:(从不咕咕的阿坤:这个好像是声卡工作是录音相关的功能,英文太抽象了,我就硬译过来了,如有相关设备,音乐好的,可以根据英文翻译好发给我!)"
 AdvSceneSwitcher.condition.midi.entry.listen="将MIDI信息选择设置为从选定设备上接收的信息: {{listenButton}}"
 AdvSceneSwitcher.condition.display="显示器"
 AdvSceneSwitcher.condition.display.type.displayName="连接的显示器的名称匹配"

plugins/midi/macro-condition-midi.cpp

@@ -12,39 +12,35 @@ bool MacroConditionMidi::_registered = MacroConditionFactory::Register(
 	{MacroConditionMidi::Create, MacroConditionMidiEdit::Create,
 	 "AdvSceneSwitcher.condition.midi"});
 
+static const std::map<MacroConditionMidi::Condition, std::string>
+	conditionTypes = {
+		{MacroConditionMidi::Condition::MIDI_MESSAGE,
+		 "AdvSceneSwitcher.condition.midi.condition.message"},
+		{MacroConditionMidi::Condition::MIDI_CONNECTED_DEVICE_NAMES,
+		 "AdvSceneSwitcher.condition.midi.condition.deviceName"},
+};
+
 bool MacroConditionMidi::CheckCondition()
 {
-	if (!_messageBuffer) {
-		return false;
-	}
-
-	const bool macroWasPausedSinceLastCheck =
-		MacroWasPausedSince(GetMacro(), _lastCheck);
-	_lastCheck = std::chrono::high_resolution_clock::now();
-	if (macroWasPausedSinceLastCheck) {
-		_messageBuffer->Clear();
-		return false;
-	}
-
-	while (!_messageBuffer->Empty()) {
-		auto message = _messageBuffer->ConsumeMessage();
-		if (!message) {
-			continue;
-		}
-		if (message->Matches(_message)) {
-			SetVariableValues(*message);
-			return true;
-		}
+	switch (_condition) {
+	case Condition::MIDI_MESSAGE:
+		return CheckMessage();
+	case Condition::MIDI_CONNECTED_DEVICE_NAMES:
+		return CheckConnectedDevcieNames();
+	default:
+		break;
 	}
-
 	return false;
 }
 
 bool MacroConditionMidi::Save(obs_data_t *obj) const
 {
 	MacroCondition::Save(obj);
+	obs_data_set_int(obj, "condition", static_cast<int>(_condition));
 	_message.Save(obj);
 	_device.Save(obj);
+	_deviceName.Save(obj, "deviceName");
+	_regex.Save(obj);
 	return true;
 }
 
@@ -53,7 +49,10 @@ bool MacroConditionMidi::Load(obs_data_t *obj)
 	MacroCondition::Load(obj);
 	_message.Load(obj);
 	_device.Load(obj);
-	_messageBuffer = _device.RegisterForMidiMessages();
+	_deviceName.Load(obj, "deviceName");
+	_regex.Load(obj);
+	SetCondition(
+		static_cast<Condition>(obs_data_get_int(obj, "condition")));
 	return true;
 }
 
@@ -68,9 +67,64 @@ void MacroConditionMidi::SetDevice(const MidiDevice &dev)
 	_messageBuffer = dev.RegisterForMidiMessages();
 }
 
+void MacroConditionMidi::SetCondition(Condition condition)
+{
+	_condition = condition;
+	if (_condition == Condition::MIDI_MESSAGE) {
+		_messageBuffer = _device.RegisterForMidiMessages();
+	}
+	SetupTempVars();
+}
+
+bool MacroConditionMidi::CheckMessage()
+{
+	if (!_messageBuffer) {
+		return false;
+	}
+
+	const bool macroWasPausedSinceLastCheck =
+		MacroWasPausedSince(GetMacro(), _lastCheck);
+	_lastCheck = std::chrono::high_resolution_clock::now();
+	if (macroWasPausedSinceLastCheck) {
+		_messageBuffer->Clear();
+		return false;
+	}
+
+	while (!_messageBuffer->Empty()) {
+		auto message = _messageBuffer->ConsumeMessage();
+		if (!message) {
+			continue;
+		}
+		if (message->Matches(_message)) {
+			SetVariableValues(*message);
+			return true;
+		}
+	}
+
+	return false;
+}
+
+bool MacroConditionMidi::CheckConnectedDevcieNames()
+{
+	auto deviceNames = GetDeviceNames();
+	if (!_regex.Enabled()) {
+		return std::find(deviceNames.begin(), deviceNames.end(),
+				 std::string(_deviceName)) != deviceNames.end();
+	}
+	for (const auto &deviceName : deviceNames) {
+		if (_regex.Matches(deviceName, _deviceName)) {
+			return true;
+		}
+	}
+	return false;
+}
+
 void MacroConditionMidi::SetupTempVars()
 {
 	MacroCondition::SetupTempVars();
+	if (_condition == Condition::MIDI_CONNECTED_DEVICE_NAMES) {
+		return;
+	}
 	AddTempvar("type",
 		   obs_module_text("AdvSceneSwitcher.tempVar.midi.type"));
 	AddTempvar("channel",
@@ -98,16 +152,45 @@ void MacroConditionMidi::SetVariableValues(const MidiMessage &m)
 	SetTempVarValue("value2", std::to_string(m.Value()));
 }
 
+static void populateConditionSelection(QComboBox *list)
+{
+	for (const auto &[_, name] : conditionTypes) {
+		list->addItem(obs_module_text(name.c_str()));
+	}
+}
+
 MacroConditionMidiEdit::MacroConditionMidiEdit(
 	QWidget *parent, std::shared_ptr<MacroConditionMidi> entryData)
 	: QWidget(parent),
+	  _conditions(new QComboBox()),
 	  _devices(new MidiDeviceSelection(this, MidiDeviceType::INPUT)),
 	  _message(new MidiMessageSelection(this)),
 	  _resetMidiDevices(new QPushButton(
 		  obs_module_text("AdvSceneSwitcher.midi.resetDevices"))),
 	  _listen(new QPushButton(
-		  obs_module_text("AdvSceneSwitcher.midi.startListen")))
+		  obs_module_text("AdvSceneSwitcher.midi.startListen"))),
+	  _deviceNames(new QComboBox()),
+	  _regex(new RegexConfigWidget()),
+	  _deviceListInfo(new QLabel()),
+	  _listenLayout(new QHBoxLayout()),
+	  _entryLayout(new QHBoxLayout())
 {
+	_deviceNames->addItems(GetDeviceNamesAsQStringList());
+	_deviceNames->setEditable(true);
+
+	QString path = GetThemeTypeName() == "Light"
+			       ? ":/res/images/help.svg"
+			       : ":/res/images/help_light.svg";
+	QIcon icon(path);
+	QPixmap pixmap = icon.pixmap(QSize(16, 16));
+	_deviceListInfo->setPixmap(pixmap);
+	_deviceListInfo->setToolTip(obs_module_text(
+		"AdvSceneSwitcher.condition.midi.condition.deviceName.info"));
+
+	populateConditionSelection(_conditions);
+
+	QWidget::connect(_conditions, SIGNAL(currentIndexChanged(int)), this,
+			 SLOT(ConditionChanged(int)));
 	QWidget::connect(_devices,
 			 SIGNAL(DeviceSelectionChanged(const MidiDevice &)),
 			 this,
@@ -121,19 +204,21 @@ MacroConditionMidiEdit::MacroConditionMidiEdit(
 			 SLOT(ToggleListen()));
 	QWidget::connect(&_listenTimer, SIGNAL(timeout()), this,
 			 SLOT(SetMessageSelectionToLastReceived()));
+	QWidget::connect(_deviceNames,
+			 SIGNAL(currentTextChanged(const QString &)), this,
+			 SLOT(DeviceNameChanged(const QString &)));
+	QWidget::connect(_regex,
+			 SIGNAL(RegexConfigChanged(const RegexConfig &)), this,
+			 SLOT(RegexChanged(const RegexConfig &)));
 
-	auto entryLayout = new QHBoxLayout;
-	PlaceWidgets(obs_module_text("AdvSceneSwitcher.condition.midi.entry"),
-		     entryLayout, {{"{{device}}", _devices}});
-	auto listenLayout = new QHBoxLayout;
 	PlaceWidgets(
 		obs_module_text("AdvSceneSwitcher.condition.midi.entry.listen"),
-		listenLayout, {{"{{listenButton}}", _listen}});
+		_listenLayout, {{"{{listenButton}}", _listen}});
 
 	auto mainLayout = new QVBoxLayout;
-	mainLayout->addLayout(entryLayout);
+	mainLayout->addLayout(_entryLayout);
 	mainLayout->addWidget(_message);
-	mainLayout->addLayout(listenLayout);
+	mainLayout->addLayout(_listenLayout);
 	mainLayout->addWidget(_resetMidiDevices);
 	setLayout(mainLayout);
 
@@ -155,11 +240,14 @@ void MacroConditionMidiEdit::UpdateEntryData()
 		return;
 	}
 
+	_conditions->setCurrentIndex(
+		static_cast<int>(_entryData->GetCondition()));
 	_message->SetMessage(_entryData->_message);
 	_devices->SetDevice(_entryData->GetDevice());
-
-	adjustSize();
-	updateGeometry();
+	_deviceNames->setCurrentText(QString::fromStdString(
+		_entryData->_deviceName.UnresolvedValue()));
+	_regex->SetRegexConfig(_entryData->_regex);
+	SetWidgetVisibility();
 }
 
 void MacroConditionMidiEdit::DeviceSelectionChanged(const MidiDevice &device)
@@ -211,6 +299,46 @@ void MacroConditionMidiEdit::EnableListening(bool enable)
 	}
 }
 
+void MacroConditionMidiEdit::SetWidgetVisibility()
+{
+	_entryLayout->removeWidget(_conditions);
+	_entryLayout->removeWidget(_devices);
+	_entryLayout->removeWidget(_deviceNames);
+	_entryLayout->removeWidget(_regex);
+
+	ClearLayout(_entryLayout);
+
+	std::unordered_map<std::string, QWidget *> widgetPlaceholders = {
+		{"{{conditions}}", _conditions},
+		{"{{device}}", _devices},
+		{"{{deviceNames}}", _deviceNames},
+		{"{{regex}}", _regex},
+		{"{{deviceListInfo}}", _deviceListInfo},
+	};
+
+	const bool isMessageCheck = _entryData->GetCondition() ==
+				    MacroConditionMidi::Condition::MIDI_MESSAGE;
+
+	auto layoutString =
+		isMessageCheck
+			? "AdvSceneSwitcher.condition.midi.entry.message"
+			: "AdvSceneSwitcher.condition.midi.entry.deviceName";
+
+	PlaceWidgets(obs_module_text(layoutString), _entryLayout,
+		     widgetPlaceholders);
+
+	SetLayoutVisible(_listenLayout, isMessageCheck);
+	_devices->setVisible(isMessageCheck);
+	_message->setVisible(isMessageCheck);
+	_resetMidiDevices->setVisible(isMessageCheck);
+	_deviceNames->setVisible(!isMessageCheck);
+	_regex->setVisible(!isMessageCheck);
+	_deviceListInfo->setVisible(!isMessageCheck);
+
+	adjustSize();
+	updateGeometry();
+}
+
 void MacroConditionMidiEdit::ToggleListen()
 {
 	if (!_entryData) {
@@ -249,4 +377,39 @@ void MacroConditionMidiEdit::SetMessageSelectionToLastReceived()
 	_entryData->_message = *message;
 }
 
+void MacroConditionMidiEdit::ConditionChanged(int value)
+{
+	if (_loading || !_entryData) {
+		return;
+	}
+
+	auto lock = LockContext();
+	_entryData->SetCondition(
+		static_cast<MacroConditionMidi::Condition>(value));
+	SetWidgetVisibility();
+}
+
+void MacroConditionMidiEdit::DeviceNameChanged(const QString &deviceName)
+{
+	if (_loading || !_entryData) {
+		return;
+	}
+
+	auto lock = LockContext();
+	_entryData->_deviceName = deviceName.toStdString();
+}
+
+void MacroConditionMidiEdit::RegexChanged(const RegexConfig &conf)
+{
+	if (_loading || !_entryData) {
+		return;
+	}
+
+	auto lock = LockContext();
+	_entryData->_regex = conf;
+
+	adjustSize();
+	updateGeometry();
+}
+
 } // namespace advss