Cache games without banners

Games without banners were not cached before, because a banner could
become available at any time, making the cache outdated without it
becoming invalidated. Instead of not caching anything, this change makes
Dolphin check for a banner every time a cache that lacks a banner is read.
This is faster than reading all metadata, because reading a Wii banner
only reads from the game's save file, not the volume and its filesystem.

The cache revision is incremented, because otherwise banners will be
missing if a cache without a banner is created in the new version and
the user switches to an old version and creates a savefile.

Source/Core/DolphinQt/GameList/GameFile.cpp

@@ -24,7 +24,7 @@
 #include "DolphinQt/GameList/GameFile.h"
 #include "DolphinQt/Utils/Utils.h"
 
-static const u32 CACHE_REVISION = 0x00A;
+static const u32 CACHE_REVISION = 0x00B; // Last changed in PR 2598
 static const u32 DATASTREAM_REVISION = 15; // Introduced in Qt 5.2
 
 static QMap<DiscIO::IVolume::ELanguage, QString> ConvertLocalizedStrings(std::map<DiscIO::IVolume::ELanguage, std::string> strings)
@@ -74,6 +74,20 @@ GameFile::GameFile(const QString& fileName)
 	if (LoadFromCache())
 	{
 		m_valid = true;
+
+		// Wii banners can only be read if there is a savefile,
+		// so sometimes caches don't contain banners. Let's check
+		// if a banner has become available after the cache was made.
+		if (m_banner.isNull())
+		{
+			std::unique_ptr<DiscIO::IVolume> volume(DiscIO::CreateVolumeFromFilename(fileName.toStdString()));
+			if (volume != nullptr)
+			{
+				ReadBanner(*volume);
+				if (!m_banner.isNull())
+					SaveToCache();
+			}
+		}
 	}
 	else
 	{
@@ -100,24 +114,10 @@ GameFile::GameFile(const QString& fileName)
 			QFileInfo info(m_file_name);
 			m_folder_name = info.absoluteDir().dirName();
 
-			int width, height;
+			ReadBanner(*volume);
-			std::vector<u32> buffer = volume->GetBanner(&width, &height);
-			QImage banner(width, height, QImage::Format_RGB888);
-			for (int i = 0; i < width * height; i++)
-			{
-				int x = i % width, y = i / width;
-				banner.setPixel(x, y, qRgb((buffer[i] & 0xFF0000) >> 16,
-						        (buffer[i] & 0x00FF00) >>  8,
-						        (buffer[i] & 0x0000FF) >>  0));
-			}
 
 			m_valid = true;
-
+			SaveToCache();
-			if (!banner.isNull())
-			{
-				m_banner = QPixmap::fromImage(banner);
-				SaveToCache();
-			}
 		}
 	}
 
@@ -238,6 +238,23 @@ QString GameFile::CreateCacheFilename()
 	return fullname;
 }
 
+void GameFile::ReadBanner(const DiscIO::IVolume& volume)
+{
+	int width, height;
+	std::vector<u32> buffer = volume.GetBanner(&width, &height);
+	QImage banner(width, height, QImage::Format_RGB888);
+	for (int i = 0; i < width * height; i++)
+	{
+		int x = i % width, y = i / width;
+		banner.setPixel(x, y, qRgb((buffer[i] & 0xFF0000) >> 16,
+		                           (buffer[i] & 0x00FF00) >> 8,
+		                           (buffer[i] & 0x0000FF) >> 0));
+	}
+
+	if (!banner.isNull())
+		m_banner = QPixmap::fromImage(banner);
+}
+
 QString GameFile::GetDescription(DiscIO::IVolume::ELanguage language) const
 {
 	return GetLanguageString(language, m_descriptions);

Source/Core/DolphinQt/GameList/GameFile.h

@@ -79,4 +79,6 @@ private:
 	void SaveToCache();
 
 	QString CreateCacheFilename();
+
+	void ReadBanner(const DiscIO::IVolume& volume);
 };

Source/Core/DolphinWX/ISOFile.cpp

@@ -34,7 +34,7 @@
 #include "DolphinWX/ISOFile.h"
 #include "DolphinWX/WxUtils.h"
 
-static const u32 CACHE_REVISION = 0x124;
+static const u32 CACHE_REVISION = 0x125; // Last changed in PR 2598
 
 #define DVD_BANNER_WIDTH 96
 #define DVD_BANNER_HEIGHT 32
@@ -74,6 +74,20 @@ GameListItem::GameListItem(const std::string& _rFileName)
 	if (LoadFromCache())
 	{
 		m_Valid = true;
+
+		// Wii banners can only be read if there is a savefile,
+		// so sometimes caches don't contain banners. Let's check
+		// if a banner has become available after the cache was made.
+		if (m_pImage.empty())
+		{
+			std::unique_ptr<DiscIO::IVolume> volume(DiscIO::CreateVolumeFromFilename(_rFileName));
+			if (volume != nullptr)
+			{
+				ReadBanner(*volume);
+				if (!m_pImage.empty())
+					SaveToCache();
+			}
+		}
 	}
 	else
 	{
@@ -96,25 +110,12 @@ GameListItem::GameListItem(const std::string& _rFileName)
 			m_disc_number = pVolume->GetDiscNumber();
 			m_Revision = pVolume->GetRevision();
 
-			std::vector<u32> Buffer = pVolume->GetBanner(&m_ImageWidth, &m_ImageHeight);
+			ReadBanner(*pVolume);
-			u32* pData = Buffer.data();
-			m_pImage.resize(m_ImageWidth * m_ImageHeight * 3);
-
-			for (int i = 0; i < m_ImageWidth * m_ImageHeight; i++)
-			{
-				m_pImage[i * 3 + 0] = (pData[i] & 0xFF0000) >> 16;
-				m_pImage[i * 3 + 1] = (pData[i] & 0x00FF00) >> 8;
-				m_pImage[i * 3 + 2] = (pData[i] & 0x0000FF) >> 0;
-			}
 
 			delete pVolume;
 
 			m_Valid = true;
-
+			SaveToCache();
-			// Create a cache file only if we have an image.
-			// Wii ISOs create their images after you have generated the first savegame
-			if (!m_pImage.empty())
-				SaveToCache();
 		}
 	}
 
@@ -201,6 +202,20 @@ std::string GameListItem::CreateCacheFilename()
 	return fullname;
 }
 
+void GameListItem::ReadBanner(const DiscIO::IVolume& volume)
+{
+	std::vector<u32> Buffer = volume.GetBanner(&m_ImageWidth, &m_ImageHeight);
+	u32* pData = Buffer.data();
+	m_pImage.resize(m_ImageWidth * m_ImageHeight * 3);
+
+	for (int i = 0; i < m_ImageWidth * m_ImageHeight; i++)
+	{
+		m_pImage[i * 3 + 0] = (pData[i] & 0xFF0000) >> 16;
+		m_pImage[i * 3 + 1] = (pData[i] & 0x00FF00) >> 8;
+		m_pImage[i * 3 + 2] = (pData[i] & 0x0000FF) >> 0;
+	}
+}
+
 std::string GameListItem::GetDescription(DiscIO::IVolume::ELanguage language) const
 {
 	return GetLanguageString(language, m_descriptions);

Source/Core/DolphinWX/ISOFile.h

@@ -81,4 +81,6 @@ private:
 	void SaveToCache();
 
 	std::string CreateCacheFilename();
+
+	void ReadBanner(const DiscIO::IVolume& volume);
 };