// Copyright 2008 Dolphin Emulator Project // Licensed under GPLv2+ // Refer to the license.txt file included. #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "Common/ChunkFile.h" #include "Common/CommonPaths.h" #include "Common/CommonTypes.h" #include "Common/FileUtil.h" #include "Common/Hash.h" #include "Common/IniFile.h" #include "Common/StringUtil.h" #include "Core/ConfigManager.h" #include "Core/Boot/Boot.h" #include "DiscIO/Volume.h" #include "DiscIO/VolumeCreator.h" #include "DolphinWX/ISOFile.h" #include "DolphinWX/WxUtils.h" static const u32 CACHE_REVISION = 0x126; // Last changed in PR 3097 #define DVD_BANNER_WIDTH 96 #define DVD_BANNER_HEIGHT 32 static std::string GetLanguageString(DiscIO::IVolume::ELanguage language, std::map strings) { auto end = strings.end(); auto it = strings.find(language); if (it != end) return it->second; // English tends to be a good fallback when the requested language isn't available if (language != DiscIO::IVolume::ELanguage::LANGUAGE_ENGLISH) { it = strings.find(DiscIO::IVolume::ELanguage::LANGUAGE_ENGLISH); if (it != end) return it->second; } // If English isn't available either, just pick something if (!strings.empty()) return strings.cbegin()->second; return ""; } GameListItem::GameListItem(const std::string& _rFileName, const std::unordered_map& custom_titles) : m_FileName(_rFileName) , m_emu_state(0) , m_FileSize(0) , m_Country(DiscIO::IVolume::COUNTRY_UNKNOWN) , m_Revision(0) , m_Valid(false) , m_ImageWidth(0) , m_ImageHeight(0) , m_disc_number(0) , m_has_custom_name(false) { 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 volume(DiscIO::CreateVolumeFromFilename(_rFileName)); if (volume != nullptr) { ReadVolumeBanner(*volume); if (!m_pImage.empty()) SaveToCache(); } } } else { std::unique_ptr volume(DiscIO::CreateVolumeFromFilename(_rFileName)); if (volume != nullptr) { m_Platform = volume->GetVolumeType(); m_names = volume->GetNames(true); m_descriptions = volume->GetDescriptions(); m_company = volume->GetCompany(); m_Country = volume->GetCountry(); m_blob_type = volume->GetBlobType(); m_FileSize = volume->GetRawSize(); m_VolumeSize = volume->GetSize(); m_UniqueID = volume->GetUniqueID(); m_disc_number = volume->GetDiscNumber(); m_Revision = volume->GetRevision(); ReadVolumeBanner(*volume); m_Valid = true; SaveToCache(); } } if (m_company.empty() && m_UniqueID.size() >= 6) m_company = DiscIO::GetCompanyFromID(m_UniqueID.substr(4, 2)); if (IsValid()) { IniFile ini = SConfig::LoadGameIni(m_UniqueID, m_Revision); ini.GetIfExists("EmuState", "EmulationStateId", &m_emu_state); ini.GetIfExists("EmuState", "EmulationIssues", &m_issues); m_has_custom_name = ini.GetIfExists("EmuState", "Title", &m_custom_name); if (!m_has_custom_name) { std::string game_id = m_UniqueID; // Ignore publisher ID for WAD files if (m_Platform == DiscIO::IVolume::WII_WAD && game_id.size() > 4) game_id.erase(4); auto end = custom_titles.end(); auto it = custom_titles.find(game_id); if (it != end) { m_custom_name = it->second; m_has_custom_name = true; } } } if (!IsValid() && IsElfOrDol()) { m_Valid = true; m_FileSize = File::GetSize(_rFileName); m_Platform = DiscIO::IVolume::ELF_DOL; m_blob_type = DiscIO::BlobType::DIRECTORY; } std::string path, name; SplitPath(m_FileName, &path, &name, nullptr); // A bit like the Homebrew Channel icon, except there can be multiple files in a folder with their own icons. // Useful for those who don't want to have a Homebrew Channel-style folder structure. if (ReadPNGBanner(path + name + ".png")) return; // Homebrew Channel icon. Typical for DOLs and ELFs, but can be also used with volumes. if (ReadPNGBanner(path + "icon.png")) return; // Volume banner. Typical for everything that isn't a DOL or ELF. if (!m_pImage.empty()) { wxImage image(m_ImageWidth, m_ImageHeight, &m_pImage[0], true); m_Bitmap = ScaleBanner(&image); return; } // Fallback in case no banner is available. ReadPNGBanner(File::GetSysDirectory() + RESOURCES_DIR + DIR_SEP + "nobanner.png"); } GameListItem::~GameListItem() { } bool GameListItem::LoadFromCache() { return CChunkFileReader::Load(CreateCacheFilename(), CACHE_REVISION, *this); } void GameListItem::SaveToCache() { if (!File::IsDirectory(File::GetUserPath(D_CACHE_IDX))) File::CreateDir(File::GetUserPath(D_CACHE_IDX)); CChunkFileReader::Save(CreateCacheFilename(), CACHE_REVISION, *this); } void GameListItem::DoState(PointerWrap &p) { p.Do(m_names); p.Do(m_descriptions); p.Do(m_company); p.Do(m_UniqueID); p.Do(m_FileSize); p.Do(m_VolumeSize); p.Do(m_Country); p.Do(m_blob_type); p.Do(m_pImage); p.Do(m_ImageWidth); p.Do(m_ImageHeight); p.Do(m_Platform); p.Do(m_disc_number); p.Do(m_Revision); } bool GameListItem::IsElfOrDol() const { if (m_FileName.size() < 4) return false; std::string name_end = m_FileName.substr(m_FileName.size() - 4); std::transform(name_end.begin(), name_end.end(), name_end.begin(), ::tolower); return name_end == ".elf" || name_end == ".dol"; } std::string GameListItem::CreateCacheFilename() const { std::string Filename, LegalPathname, extension; SplitPath(m_FileName, &LegalPathname, &Filename, &extension); if (Filename.empty()) return Filename; // Disc Drive // Filename.extension_HashOfFolderPath_Size.cache // Append hash to prevent ISO name-clashing in different folders. Filename.append(StringFromFormat("%s_%x_%" PRIx64 ".cache", extension.c_str(), HashFletcher((const u8 *)LegalPathname.c_str(), LegalPathname.size()), File::GetSize(m_FileName))); std::string fullname(File::GetUserPath(D_CACHE_IDX)); fullname += Filename; return fullname; } // Outputs to m_pImage void GameListItem::ReadVolumeBanner(const DiscIO::IVolume& volume) { std::vector 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; } } // Outputs to m_Bitmap bool GameListItem::ReadPNGBanner(const std::string& path) { if (!File::Exists(path)) return false; wxImage image; image.LoadFile(StrToWxStr(path), wxBITMAP_TYPE_PNG); m_Bitmap = ScaleBanner(&image); return true; } wxBitmap GameListItem::ScaleBanner(wxImage* image) { double scale = wxTheApp->GetTopWindow()->GetContentScaleFactor(); // Note: This uses nearest neighbor, which subjectively looks a lot // better for GC banners than smooth scaling. // TODO: Make scaling less bad for Homebrew Channel banners. image->Rescale(DVD_BANNER_WIDTH * scale, DVD_BANNER_HEIGHT * scale); #ifdef __APPLE__ return wxBitmap(*image, -1, scale); #else return wxBitmap(*image, -1); #endif } std::string GameListItem::GetDescription(DiscIO::IVolume::ELanguage language) const { return GetLanguageString(language, m_descriptions); } std::string GameListItem::GetDescription() const { bool wii = m_Platform != DiscIO::IVolume::GAMECUBE_DISC; return GetDescription(SConfig::GetInstance().GetCurrentLanguage(wii)); } std::string GameListItem::GetName(DiscIO::IVolume::ELanguage language) const { return GetLanguageString(language, m_names); } std::string GameListItem::GetName() const { if (m_has_custom_name) return m_custom_name; bool wii = m_Platform != DiscIO::IVolume::GAMECUBE_DISC; std::string name = GetName(SConfig::GetInstance().GetCurrentLanguage(wii)); if (!name.empty()) return name; // No usable name, return filename (better than nothing) std::string ext; SplitPath(GetFileName(), nullptr, &name, &ext); return name + ext; } std::vector GameListItem::GetLanguages() const { std::vector languages; for (std::pair name : m_names) languages.push_back(name.first); return languages; } const std::string GameListItem::GetWiiFSPath() const { std::unique_ptr iso(DiscIO::CreateVolumeFromFilename(m_FileName)); std::string ret; if (iso == nullptr) return ret; if (iso->GetVolumeType() != DiscIO::IVolume::GAMECUBE_DISC) { u64 title_id = 0; iso->GetTitleID(&title_id); const std::string path = StringFromFormat("%s/title/%08x/%08x/data/", File::GetUserPath(D_WIIROOT_IDX).c_str(), (u32)(title_id >> 32), (u32)title_id); if (!File::Exists(path)) File::CreateFullPath(path); if (path[0] == '.') ret = WxStrToStr(wxGetCwd()) + path.substr(strlen(ROOT_DIR)); else ret = path; } return ret; }