Qt: Add Custom background support

Author: kamfretoz

pcsx2-qt/GameList/GameListWidget.cpp

@@ -12,16 +12,20 @@
 
 #include "common/Assertions.h"
 #include "common/Console.h"
+#include "common/Path.h"
 #include "common/StringUtil.h"
 
 #include "fmt/format.h"
 
 #include <QtCore/QSortFilterProxyModel>
+#include <QtCore/QDir>
+#include <QtCore/QString>
 #include <QtGui/QPainter>
 #include <QtGui/QPixmap>
 #include <QtGui/QPixmapCache>
 #include <QtGui/QWheelEvent>
 #include <QtWidgets/QApplication>
+#include <QtWidgets/QFileDialog>
 #include <QtWidgets/QHeaderView>
 #include <QtWidgets/QMenu>
 #include <QtWidgets/QScrollBar>
@@ -280,6 +284,92 @@ void GameListWidget::initialize()
 
 	updateToolbar();
 	resizeTableViewColumnsToFit();
+	setCustomBackground(false);
+}
+
+static void resizeAndPadImage(QImage* image, int expected_width, int expected_height, bool fill_with_top_left)
+{
+	const qreal dpr = image->devicePixelRatio();
+	const int dpr_expected_width = static_cast<int>(static_cast<qreal>(expected_width) * dpr);
+	const int dpr_expected_height = static_cast<int>(static_cast<qreal>(expected_height) * dpr);
+	if (image->width() == dpr_expected_width && image->height() == dpr_expected_height)
+		return;
+
+	if ((static_cast<float>(image->width()) / static_cast<float>(image->height())) >=
+		(static_cast<float>(dpr_expected_width) / static_cast<float>(dpr_expected_height)))
+	{
+		*image = image->scaledToWidth(dpr_expected_width, Qt::SmoothTransformation);
+	}
+	else
+	{
+		*image = image->scaledToHeight(dpr_expected_height, Qt::SmoothTransformation);
+	}
+
+	if (image->width() == dpr_expected_width && image->height() == dpr_expected_height)
+		return;
+
+	int xoffs = 0;
+	int yoffs = 0;
+	const int image_width = image->width();
+	const int image_height = image->height();
+	if (image_width < dpr_expected_width)
+		xoffs = static_cast<int>(static_cast<qreal>((dpr_expected_width - image_width) / 2) / dpr);
+	if (image_height < dpr_expected_height)
+		yoffs = static_cast<int>(static_cast<qreal>((dpr_expected_height - image_height) / 2) / dpr);
+
+	QImage padded_image(dpr_expected_width, dpr_expected_height, QImage::Format_ARGB32);
+	padded_image.setDevicePixelRatio(dpr);
+	if (fill_with_top_left)
+		padded_image.fill(image->pixel(0, 0));
+	else
+		padded_image.fill(Qt::transparent);
+
+	QPainter painter;
+	if (painter.begin(&padded_image))
+	{
+		painter.setCompositionMode(QPainter::CompositionMode_Source);
+		painter.drawImage(xoffs, yoffs, *image);
+		painter.end();
+	}
+
+	*image = std::move(padded_image);
+}
+
+void GameListWidget::setCustomBackground(bool reload)
+{
+	std::string path = Host::GetBaseStringSettingValue("UI", "GameListBackgroundPath");
+	if (path.empty())
+		return;
+
+	if (!Path::IsAbsolute(path))
+		path = Path::Combine(EmuFolders::DataRoot, path);
+
+	if (reload)
+	{
+		m_background_image = QImage();
+		if (!path.empty() && m_background_image.load(path.c_str()))
+			m_background_image.setDevicePixelRatio(devicePixelRatio());
+	}
+
+	if (m_background_image.isNull() || path.empty())
+	{
+		m_ui.stack->setPalette(QApplication::palette());
+		m_table_view->setAlternatingRowColors(true);
+		return;
+	}
+
+	int widget_width = m_ui.stack->width();
+	int widget_height = m_ui.stack->height();
+
+	resizeAndPadImage(&m_background_image, widget_width, widget_height, false);
+
+	if (widget_width != m_ui.stack->width() || widget_height != m_ui.stack->height())
+		return;
+
+	m_table_view->setAlternatingRowColors(false);
+	QPalette new_palette(m_ui.stack->palette());
+	new_palette.setBrush(QPalette::Base, QPixmap::fromImage(m_background_image));
+	m_ui.stack->setPalette(new_palette);
 }
 
 bool GameListWidget::isShowingGameList() const
@@ -467,6 +557,28 @@ void GameListWidget::refreshGridCovers()
 	m_model->refreshCovers();
 }
 
+void GameListWidget::onViewSetGameListBackgroundTriggered()
+{
+	const QString path = QDir::toNativeSeparators(
+		QFileDialog::getOpenFileName(this, tr("Select Background Image"), QString(), tr("Supported Image Types (*.jpg *.jpeg *.png *.webp)")));
+	if (path.isEmpty())
+		return;
+
+	std::string relative_path = Path::MakeRelative(QDir::toNativeSeparators(path).toStdString(), EmuFolders::DataRoot);
+	Host::SetBaseStringSettingValue("UI", "GameListBackgroundPath", relative_path.c_str());
+	Host::CommitBaseSettingChanges();
+	setCustomBackground(true);
+}
+
+void GameListWidget::onViewClearGameListBackgroundTriggered()
+{
+	Host::RemoveBaseSettingValue("UI", "GameListBackgroundPath");
+	Host::CommitBaseSettingChanges();
+	updateToolbar();
+	resizeTableViewColumnsToFit();
+	setCustomBackground(true);
+}
+
 void GameListWidget::showGameList()
 {
 	if (m_ui.stack->currentIndex() == 0 || m_model->rowCount() == 0)
@@ -545,6 +657,7 @@ void GameListWidget::resizeEvent(QResizeEvent* event)
 	QWidget::resizeEvent(event);
 	resizeTableViewColumnsToFit();
 	m_model->updateCacheSize(width(), height());
+	setCustomBackground(true);
 }
 
 void GameListWidget::resizeTableViewColumnsToFit()

pcsx2-qt/GameList/GameListWidget.h

@@ -48,6 +48,7 @@ class GameListWidget : public QWidget
 	void refresh(bool invalidate_cache);
 	void cancelRefresh();
 	void reloadThemeSpecificImages();
+	void setCustomBackground(bool reload);
 
 	bool isShowingGameList() const;
 	bool isShowingGameGrid() const;
@@ -90,6 +91,8 @@ public Q_SLOTS:
 	void gridZoomOut();
 	void gridIntScale(int int_scale);
 	void refreshGridCovers();
+	void onViewSetGameListBackgroundTriggered();
+	void onViewClearGameListBackgroundTriggered();
 
 protected:
 	void resizeEvent(QResizeEvent* event);
@@ -114,4 +117,6 @@ public Q_SLOTS:
 	Ui::EmptyGameListWidget m_empty_ui;
 
 	GameListRefreshThread* m_refresh_thread = nullptr;
+
+	QImage m_background_image;
 };

pcsx2-qt/MainWindow.cpp

@@ -385,6 +385,8 @@ void MainWindow::connectSignals()
 			m_game_list_widget->gridZoomOut();
 	});
 	connect(m_ui.actionGridViewRefreshCovers, &QAction::triggered, m_game_list_widget, &GameListWidget::refreshGridCovers);
+	connect(m_ui.actionSetGameListBackground, &QAction::triggered, m_game_list_widget, &GameListWidget::onViewSetGameListBackgroundTriggered);
+	connect(m_ui.actionClearGameListBackground, &QAction::triggered, m_game_list_widget, &GameListWidget::onViewClearGameListBackgroundTriggered);
 	connect(m_game_list_widget, &GameListWidget::layoutChange, this, [this]() {
 		QSignalBlocker sb(m_ui.actionGridViewShowTitles);
 		m_ui.actionGridViewShowTitles->setChecked(m_game_list_widget->getShowGridCoverTitles());

pcsx2-qt/MainWindow.ui

@@ -31,7 +31,7 @@
      <x>0</x>
      <y>0</y>
      <width>1050</width>
-     <height>27</height>
+     <height>28</height>
     </rect>
    </property>
    <widget class="QMenu" name="menuSystem">
@@ -176,6 +176,9 @@
     <addaction name="actionGridViewZoomIn"/>
     <addaction name="actionGridViewZoomOut"/>
     <addaction name="actionGridViewRefreshCovers"/>
+    <addaction name="separator"/>
+    <addaction name="actionSetGameListBackground"/>
+    <addaction name="actionClearGameListBackground"/>
    </widget>
    <widget class="QMenu" name="menuTools">
     <property name="title">
@@ -1056,6 +1059,22 @@
     <string>Edit &amp;Patches...</string>
    </property>
   </action>
+  <action name="actionSetGameListBackground">
+   <property name="text">
+    <string>Set Custom Background</string>
+   </property>
+   <property name="icon">
+    <iconset theme="artboard-2-line"/>
+   </property>
+  </action>
+  <action name="actionClearGameListBackground">
+   <property name="text">
+    <string>Clear Custom Background</string>
+   </property>
+   <property name="icon">
+    <iconset theme="trash-fill"/>
+   </property>
+  </action>
  </widget>
  <resources>
   <include location="resources/resources.qrc"/>