squashme: Deprecated source handling, feedback, cleanup

Warchamp7 · Warchamp7 · commit 770713b976ce · 2025-12-17T20:03:40.000-05:00
diff --git a/frontend/data/locale/en-US.ini b/frontend/data/locale/en-US.ini
@@ -644,6 +644,7 @@ Basic.SourceSelect.AddVisible="Make source visible"
 Basic.SourceSelect.NoExisting="No existing %1 sources"
 Basic.SourceSelect.Accessible.SourceName="Source Name"
 Basic.SourceSelect.Accessible.Existing="Add an Existing Source"
+Basic.SourceSelect.Deprecated.Create="This source type is marked as deprecated and does allow creating new sources."
 
 # source box
 Basic.Main.Sources.Visibility="Visibility"
diff --git a/frontend/dialogs/OBSBasicSourceSelect.cpp b/frontend/dialogs/OBSBasicSourceSelect.cpp
@@ -43,37 +43,43 @@ struct AddSourceData {
 };
 
 namespace {
-const char *getSourceDisplayName(QString type)
+QString getSourceDisplayName(QString type)
 {
-	std::string typeId = type.toStdString();
-	const char *unversionedId = typeId.c_str();
+	if (type == "scene") {
+		return QTStr("Basic.Scene");
+	}
+
+	const char *inputChar = obs_get_latest_input_type_id(type.toUtf8().constData());
+	const char *displayChar = obs_source_get_display_name(inputChar);
+	std::string displayId = (displayChar) ? displayChar : "";
 
-	if (strcmp(unversionedId, "scene") == 0) {
-		return Str("Basic.Scene");
+	if (!displayId.empty()) {
+		return QString::fromStdString(displayId);
+	} else {
+		return QString();
 	}
-	const char *id = obs_get_latest_input_type_id(unversionedId);
-	return obs_source_get_display_name(id);
 }
-} // namespace
 
-char *getNewSourceName(const char *name, const char *format)
+std::string getNewSourceName(std::string_view name)
 {
-	struct dstr new_name = {0};
-	int inc = 0;
+	std::string newName(name);
 
-	dstr_copy(&new_name, name);
+	int suffix = 1;
 
 	for (;;) {
-		OBSSourceAutoRelease existing_source = obs_get_source_by_name(new_name.array);
+		OBSSourceAutoRelease existing_source = obs_get_source_by_name(newName.c_str());
 		if (!existing_source) {
 			break;
 		}
 
-		dstr_printf(&new_name, format, name, ++inc + 1);
+		newName = name;
+		newName += " ";
+		newName += std::to_string(suffix);
 	}
 
-	return new_name.array;
+	return newName;
 }
+} // namespace
 
 static void AddSource(void *_data, obs_scene_t *scene)
 {
@@ -111,10 +117,9 @@ static void AddExisting(OBSSource source, bool visible, bool duplicate, obs_tran
 
 	if (duplicate) {
 		OBSSource from = source;
-		char *new_name = getNewSourceName(obs_source_get_name(source), "%s %d");
-		source = obs_source_duplicate(from, new_name, false);
+		std::string new_name = getNewSourceName(obs_source_get_name(source));
+		source = obs_source_duplicate(from, new_name.c_str(), false);
 		obs_source_release(source);
-		bfree(new_name);
 
 		if (!source) {
 			return;
@@ -217,6 +222,8 @@ OBSBasicSourceSelect::OBSBasicSourceSelect(OBSBasic *parent, undo_stack &undo_s)
 		&OBSBasicSourceSelect::checkSourceVisibility);
 
 	ui->createNewFrame->setVisible(false);
+	ui->deprecatedCreateLabel->setVisible(false);
+	ui->deprecatedCreateLabel->setProperty("class", "text-muted");
 
 	getSourceTypes();
 	getSources();
@@ -251,8 +258,8 @@ void OBSBasicSourceSelect::checkSourceVisibility()
 
 	// Allow some room for previous/next rows to make scrolling a bit more seamless
 	QRect scrollAreaRect(QPoint(0, 0), ui->existingScrollArea->size());
-	scrollAreaRect.setTop(scrollAreaRect.top() - Thumbnail::cy);
-	scrollAreaRect.setBottom(scrollAreaRect.bottom() + Thumbnail::cy);
+	scrollAreaRect.setTop(scrollAreaRect.top() - Thumbnail::size.width());
+	scrollAreaRect.setBottom(scrollAreaRect.bottom() + Thumbnail::size.height());
 
 	for (QAbstractButton *button : buttons) {
 		SourceSelectButton *sourceButton = qobject_cast<SourceSelectButton *>(button->parent());
@@ -315,6 +322,10 @@ void OBSBasicSourceSelect::updateExistingSources(int limit)
 			break;
 		}
 
+		if (!source || obs_source_removed(source)) {
+			continue;
+		}
+
 		const char *id = obs_source_get_unversioned_id(source);
 		QString stringId = QString(id);
 
@@ -406,29 +417,50 @@ void OBSBasicSourceSelect::getSourceTypes()
 			continue;
 		}
 
-		QListWidgetItem *newItem = new QListWidgetItem();
+		QListWidgetItem *newItem = new QListWidgetItem(ui->sourceTypeList);
 		newItem->setData(Qt::DisplayRole, name);
 		newItem->setData(UNVERSIONED_ID_ROLE, unversioned_type);
 
-		QIcon icon;
-		icon = main->GetSourceIcon(type);
-		newItem->setIcon(icon);
+		if ((caps & OBS_SOURCE_DEPRECATED) != 0) {
+			newItem->setData(DEPRECATED_ROLE, true);
+		} else {
+			newItem->setData(DEPRECATED_ROLE, false);
 
-		ui->sourceTypeList->addItem(newItem);
+			QIcon icon;
+			icon = main->GetSourceIcon(type);
+			newItem->setIcon(icon);
+		}
 	}
 
-	QListWidgetItem *newItem = new QListWidgetItem();
+	QListWidgetItem *newItem = new QListWidgetItem(ui->sourceTypeList);
 	newItem->setData(Qt::DisplayRole, Str("Basic.Scene"));
 	newItem->setData(UNVERSIONED_ID_ROLE, "scene");
 
 	QIcon icon;
 	icon = main->GetSceneIcon();
 	newItem->setIcon(icon);
 
-	ui->sourceTypeList->addItem(newItem);
-
 	ui->sourceTypeList->sortItems();
 
+	// Shift Deprecated sources to the bottom
+	QList<QListWidgetItem *> deprecatedItems;
+	for (int i = 0; i < ui->sourceTypeList->count(); i++) {
+		QListWidgetItem *item = ui->sourceTypeList->item(i);
+		if (!item) {
+			break;
+		}
+
+		bool isDeprecated = item->data(DEPRECATED_ROLE).toBool();
+		if (isDeprecated) {
+			ui->sourceTypeList->takeItem(i);
+			deprecatedItems.append(item);
+		}
+	}
+
+	for (auto &item : deprecatedItems) {
+		ui->sourceTypeList->addItem(item);
+	}
+
 	QListWidgetItem *allSources = new QListWidgetItem();
 	allSources->setData(Qt::DisplayRole, Str("Basic.SourceSelect.Recent"));
 	allSources->setData(UNVERSIONED_ID_ROLE, QVariant());
@@ -454,26 +486,33 @@ void OBSBasicSourceSelect::setSelectedSourceType(QListWidgetItem *item)
 		delete child;
 	}
 
-	QVariant data = item->data(UNVERSIONED_ID_ROLE);
+	QVariant unversionedIdData = item->data(UNVERSIONED_ID_ROLE);
+	QVariant deprecatedData = item->data(DEPRECATED_ROLE);
 
-	if (data.isNull()) {
+	if (unversionedIdData.isNull()) {
 		setSelectedSource(nullptr);
 		sourceTypeId.clear();
 		ui->createNewFrame->setVisible(false);
 		updateExistingSources(16);
 		return;
 	}
 
-	QString type = data.toString();
+	QString type = unversionedIdData.toString();
 	if (type.compare(sourceTypeId) == 0) {
 		return;
 	}
 
 	ui->createNewFrame->setVisible(true);
 
+	bool isDeprecatedType = deprecatedData.toBool();
+	ui->newSourceName->setVisible(!isDeprecatedType);
+	ui->createNewSource->setVisible(!isDeprecatedType);
+
+	ui->deprecatedCreateLabel->setVisible(isDeprecatedType);
+
 	sourceTypeId = type;
 
-	QString placeHolderText{QT_UTF8(getSourceDisplayName(sourceTypeId))};
+	QString placeHolderText{getSourceDisplayName(sourceTypeId)};
 
 	QString text{placeHolderText};
 	int i = 2;
diff --git a/frontend/dialogs/OBSBasicSourceSelect.hpp b/frontend/dialogs/OBSBasicSourceSelect.hpp
@@ -30,6 +30,7 @@
 #include <QDialog>
 
 constexpr int UNVERSIONED_ID_ROLE = Qt::UserRole + 1;
+constexpr int DEPRECATED_ROLE = Qt::UserRole + 2;
 
 class OBSBasicSourceSelect : public QDialog {
 	Q_OBJECT
diff --git a/frontend/forms/OBSBasicSourceSelect.ui b/frontend/forms/OBSBasicSourceSelect.ui
@@ -492,6 +492,22 @@
                  </property>
                 </widget>
                </item>
+               <item>
+                <widget class="QLabel" name="deprecatedCreateLabel">
+                 <property name="frameShape">
+                  <enum>QFrame::NoFrame</enum>
+                 </property>
+                 <property name="frameShadow">
+                  <enum>QFrame::Plain</enum>
+                 </property>
+                 <property name="lineWidth">
+                  <number>0</number>
+                 </property>
+                 <property name="text">
+                  <string>Basic.SourceSelect.Deprecated.Create</string>
+                 </property>
+                </widget>
+               </item>
                <item>
                 <widget class="QFrame" name="frame">
                  <property name="frameShape">
diff --git a/frontend/utility/ThumbnailManager.cpp b/frontend/utility/ThumbnailManager.cpp
@@ -129,7 +129,7 @@ bool ThumbnailManager::updatePixmap(std::shared_ptr<ThumbnailItem> &sharedPointe
 
 		auto obj = new ScreenshotObj(source);
 		obj->setSaveToFile(false);
-		obj->setSize(Thumbnail::cx, Thumbnail::cy);
+		obj->setSize(Thumbnail::size);
 
 		connect(obj, &ScreenshotObj::imageReady, item, &ThumbnailItem::imageUpdated);
 	}
@@ -225,7 +225,7 @@ void ThumbnailManager::preloadThumbnail(OBSSource source, QObject *object, std::
 
 		auto obj = new ScreenshotObj(source);
 		obj->setSaveToFile(false);
-		obj->setSize(Thumbnail::cx, Thumbnail::cy);
+		obj->setSize(Thumbnail::size);
 
 		QPointer<QObject> safeObject = qobject_cast<QObject *>(object);
 		connect(obj, &ScreenshotObj::imageReady, this, [=](QImage image) {
diff --git a/frontend/utility/ThumbnailManager.hpp b/frontend/utility/ThumbnailManager.hpp
@@ -67,8 +67,7 @@ private slots:
 
 	inline QPixmap getPixmap() const { return item->pixmap; }
 
-	static constexpr int cx = 320;
-	static constexpr int cy = 180;
+	static constexpr QSize size = {320, 180};
 
 signals:
 	void updateThumbnail(QPixmap pixmap);
diff --git a/frontend/widgets/OBSBasic_SceneItems.cpp b/frontend/widgets/OBSBasic_SceneItems.cpp
@@ -35,6 +35,29 @@
 
 using namespace std;
 
+namespace {
+std::string getNewSourceName(std::string_view name)
+{
+	std::string newName(name);
+
+	int suffix = 1;
+
+	for (;;) {
+		OBSSourceAutoRelease existing_source = obs_get_source_by_name(newName.c_str());
+		if (!existing_source) {
+			break;
+		}
+
+		newName = name;
+		newName += " (";
+		newName += std::to_string(suffix);
+		newName += ")";
+	}
+
+	return newName;
+}
+} // namespace
+
 static inline bool HasAudioDevices(const char *source_id)
 {
 	const char *output_id = source_id;
@@ -330,8 +353,6 @@ void OBSBasic::SourceRenamed(void *data, calldata_t *params)
 	blog(LOG_INFO, "Source '%s' renamed to '%s'", prevName, newName);
 }
 
-extern char *getNewSourceName(const char *name, const char *format);
-
 void OBSBasic::ResetAudioDevice(const char *sourceId, const char *deviceId, const char *deviceDesc, int channel)
 {
 	bool disable = deviceId && strcmp(deviceId, "disabled") == 0;
@@ -352,11 +373,11 @@ void OBSBasic::ResetAudioDevice(const char *sourceId, const char *deviceId, cons
 		}
 
 	} else if (!disable) {
-		BPtr<char> name = getNewSourceName(deviceDesc, "%s (%d)");
+		std::string name = getNewSourceName(deviceDesc);
 
 		settings = obs_data_create();
 		obs_data_set_string(settings, "device_id", deviceId);
-		source = obs_source_create(sourceId, name, settings, nullptr);
+		source = obs_source_create(sourceId, name.c_str(), settings, nullptr);
 
 		obs_set_output_source(channel, source);
 	}
