ppsspp/Core/TextureReplacer.cpp
2016-05-01 00:30:44 -07:00

311 lines
9.3 KiB
C++

// Copyright (c) 2016- PPSSPP Project.
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, version 2.0 or later versions.
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License 2.0 for more details.
// A copy of the GPL 2.0 should have been included with the program.
// If not, see http://www.gnu.org/licenses/
// Official git repository and contact information can be found at
// https://github.com/hrydgard/ppsspp and http://www.ppsspp.org/.
#ifndef USING_QT_UI
#include <libpng17/png.h>
#endif
#include "ext/xxhash.h"
#include "file/ini_file.h"
#include "Common/ColorConv.h"
#include "Common/FileUtil.h"
#include "Core/Config.h"
#include "Core/System.h"
#include "Core/TextureReplacer.h"
#include "Core/ELF/ParamSFO.h"
#include "GPU/Common/TextureDecoder.h"
static const std::string INI_FILENAME = "textures.ini";
static const int VERSION = 1;
TextureReplacer::TextureReplacer() : enabled_(false) {
}
TextureReplacer::~TextureReplacer() {
}
void TextureReplacer::Init() {
NotifyConfigChanged();
}
void TextureReplacer::NotifyConfigChanged() {
gameID_ = g_paramSFO.GetValueString("DISC_ID");
enabled_ = !gameID_.empty() && (g_Config.bReplaceTextures || g_Config.bSaveNewTextures);
if (enabled_) {
basePath_ = GetSysDirectory(DIRECTORY_TEXTURES) + gameID_ + "/";
// If we're saving, auto-create the directory.
if (g_Config.bSaveNewTextures && !File::Exists(basePath_)) {
File::CreateFullPath(basePath_);
}
enabled_ = File::Exists(basePath_) && File::IsDirectory(basePath_);
}
if (enabled_) {
enabled_ = LoadIni();
}
}
bool TextureReplacer::LoadIni() {
// TODO: Use crc32c?
hash_ = ReplacedTextureHash::QUICK;
aliases_.clear();
hashranges_.clear();
if (File::Exists(basePath_ + INI_FILENAME)) {
IniFile ini;
ini.LoadFromVFS(basePath_ + INI_FILENAME);
auto options = ini.GetOrCreateSection("options");
std::string hash;
options->Get("hash", &hash, "");
// TODO: crc32c.
if (hash == "quick") {
hash_ = ReplacedTextureHash::QUICK;
} else {
ERROR_LOG(G3D, "Unsupported hash type: %s", hash.c_str());
return false;
}
int version = 0;
if (options->Get("version", &version, 0) && version > VERSION) {
ERROR_LOG(G3D, "Unsupported texture replacement version %d, trying anyway", version);
}
std::vector<std::string> hashNames;
if (ini.GetKeys("hashes", hashNames)) {
auto hashes = ini.GetOrCreateSection("hashes");
// Format: hashname = filename.png
for (std::string hashName : hashNames) {
hashes->Get(hashName.c_str(), &aliases_[hashName], "");
}
}
std::vector<std::string> hashrangeKeys;
if (ini.GetKeys("hashranges", hashrangeKeys)) {
auto hashranges = ini.GetOrCreateSection("hashranges");
// Format: addr,w,h = newW,newH
for (std::string key : hashrangeKeys) {
std::string value;
if (hashranges->Get(key.c_str(), &value, "")) {
ParseHashRange(key, value);
}
}
}
}
// The ini doesn't have to exist for it to be valid.
return true;
}
void TextureReplacer::ParseHashRange(const std::string &key, const std::string &value) {
std::vector<std::string> keyParts;
SplitString(key, ',', keyParts);
std::vector<std::string> valueParts;
SplitString(value, ',', valueParts);
if (keyParts.size() != 3 || valueParts.size() != 2) {
ERROR_LOG(G3D, "Ignoring invalid hashrange %s = %s, expecting addr,w,h = w,h", key.c_str(), value.c_str());
return;
}
u32 addr;
u32 fromW;
u32 fromH;
if (!TryParse(keyParts[0], &addr) || !TryParse(keyParts[1], &fromW) || !TryParse(keyParts[2], &fromH)) {
ERROR_LOG(G3D, "Ignoring invalid hashrange %s = %s, key format is 0x12345678,512,512", key.c_str(), value.c_str());
return;
}
u32 toW;
u32 toH;
if (!TryParse(valueParts[0], &toW) || !TryParse(valueParts[1], &toH)) {
ERROR_LOG(G3D, "Ignoring invalid hashrange %s = %s, value format is 512,512", key.c_str(), value.c_str());
return;
}
const u64 rangeKey = ((u64)addr << 32) | (fromW << 16) | fromH;
hashranges_[rangeKey] = WidthHeightPair(toW, toH);
}
u32 TextureReplacer::ComputeHash(u32 addr, int bufw, int w, int h, GETextureFormat fmt, u16 maxSeenV) {
_dbg_assert_msg_(G3D, enabled_, "Replacement not enabled");
if (!LookupHashRange(addr, w, h)) {
// There wasn't any hash range, let's fall back to maxSeenV logic.
if (h == 512 && maxSeenV < 512 && maxSeenV != 0) {
h = (int)maxSeenV;
}
}
// TODO: In order to have the most stable hash possible, skip space between w/bufw?
// TODO: Use hash based on ini file, or always crc32c, or etc.
const u32 sizeInRAM = (textureBitsPerPixel[fmt] * bufw * h) / 8;
const u32 *checkp = (const u32 *)Memory::GetPointer(addr);
switch (hash_) {
case ReplacedTextureHash::QUICK:
return StableQuickTexHash(checkp, sizeInRAM);
default:
return 0;
}
}
ReplacedTexture TextureReplacer::FindReplacement(u64 cachekey, u32 hash, int w, int h) {
_assert_msg_(G3D, enabled_, "Replacement not enabled");
ReplacedTexture result;
result.alphaStatus_ = ReplacedTextureAlpha::UNKNOWN;
// Only actually replace if we're replacing. We might just be saving.
if (g_Config.bReplaceTextures) {
std::string hashfile = LookupHashFile(cachekey, hash, 0);
const std::string filename = basePath_ + hashfile;
if (!hashfile.empty() && File::Exists(filename)) {
// TODO: Count levels that exist, etc.
// TODO: Use w/h to determine actual size based on hash range (png may be smaller)?
}
}
return result;
}
#ifndef USING_QT_UI
static bool WriteTextureToPNG(png_imagep image, const std::string &filename, int convert_to_8bit, const void *buffer, png_int_32 row_stride, const void *colormap) {
FILE *fp = File::OpenCFile(filename, "wb");
if (!fp) {
ERROR_LOG(COMMON, "Unable to open texture file for writing.");
return false;
}
if (png_image_write_to_stdio(image, fp, convert_to_8bit, buffer, row_stride, colormap)) {
if (fclose(fp) != 0) {
ERROR_LOG(COMMON, "Texture file write failed.");
return false;
}
return true;
} else {
ERROR_LOG(COMMON, "Texture PNG encode failed.");
fclose(fp);
remove(filename.c_str());
return false;
}
}
#endif
void TextureReplacer::NotifyTextureDecoded(u64 cachekey, u32 hash, u32 addr, const void *data, int pitch, int level, int w, int h, ReplacedTextureFormat fmt) {
_assert_msg_(G3D, enabled_, "Replacement not enabled");
if (!g_Config.bSaveNewTextures) {
// Ignore.
return;
}
std::string hashfile = LookupHashFile(cachekey, hash, level);
const std::string filename = basePath_ + hashfile;
// If it's empty, it's an ignored hash, we intentionally don't save.
if (hashfile.empty() || File::Exists(filename)) {
// If it exists, must've been decoded and saved as a new texture already.
return;
}
// Only save the hashed portion of the PNG.
LookupHashRange(addr, w, h);
#ifdef USING_QT_UI
ERROR_LOG(G3D, "Replacement texture saving not implemented for Qt");
#else
if (fmt != ReplacedTextureFormat::F_8888) {
saveBuf.resize((pitch * h) / sizeof(u16));
switch (fmt) {
case ReplacedTextureFormat::F_5650:
ConvertRGBA565ToRGBA8888(saveBuf.data(), (const u16 *)data, (pitch * h) / sizeof(u16));
break;
case ReplacedTextureFormat::F_5551:
ConvertRGBA5551ToRGBA8888(saveBuf.data(), (const u16 *)data, (pitch * h) / sizeof(u16));
break;
case ReplacedTextureFormat::F_4444:
ConvertRGBA4444ToRGBA8888(saveBuf.data(), (const u16 *)data, (pitch * h) / sizeof(u16));
break;
case ReplacedTextureFormat::F_8888_BGRA:
ConvertBGRA8888ToRGBA8888(saveBuf.data(), (const u32 *)data, (pitch * h) / sizeof(u32));
break;
}
data = saveBuf.data();
}
png_image png;
memset(&png, 0, sizeof(png));
png.version = PNG_IMAGE_VERSION;
png.format = PNG_FORMAT_RGBA;
png.width = w;
png.height = h;
bool success = WriteTextureToPNG(&png, filename, 0, data, pitch, nullptr);
png_image_free(&png);
if (png.warning_or_error >= 2) {
ERROR_LOG(COMMON, "Saving screenshot to PNG produced errors.");
} else if (success) {
NOTICE_LOG(G3D, "Saving texture for replacement: %08x / %dx%d", hash, w, h);
}
#endif
}
std::string TextureReplacer::LookupHashFile(u64 cachekey, u32 hash, int level) {
const std::string hashname = HashName(cachekey, hash, level);
auto alias = aliases_.find(hashname);
if (alias != aliases_.end()) {
// Note: this will be blank if explicitly ignored.
return alias->second;
}
return hashname + ".png";
}
std::string TextureReplacer::HashName(u64 cachekey, u32 hash, int level) {
char hashname[16 + 8 + 1 + 11 + 1] = {};
if (level > 0) {
snprintf(hashname, sizeof(hashname), "%016llx%08x_%d.png", cachekey, hash, level);
} else {
snprintf(hashname, sizeof(hashname), "%016llx%08x.png", cachekey, hash);
}
return hashname;
}
bool TextureReplacer::LookupHashRange(u32 addr, int &w, int &h) {
const u64 rangeKey = ((u64)addr << 32) | (w << 16) | h;
auto range = hashranges_.find(rangeKey);
if (range != hashranges_.end()) {
const WidthHeightPair &wh = range->second;
w = wh.first;
h = wh.second;
return true;
}
return false;
}
void ReplacedTexture::Load(int level, void *out, int rowPitch) {
_assert_msg_(G3D, (size_t)level < levels_.size(), "Invalid miplevel");
_assert_msg_(G3D, out != nullptr && rowPitch > 0, "Invalid out/pitch");
// TODO
}