/*
* The ManaPlus Client
* Copyright (C) 2004-2009 The Mana World Development Team
* Copyright (C) 2009-2010 The Mana Developers
* Copyright (C) 2011-2012 The ManaPlus Developers
*
* This file is part of The ManaPlus Client.
*
* 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; either version 2 of the License, or
* any later version.
*
* 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 for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
#include "resources/resourcemanager.h"
#include "animationdelayload.h"
#include "client.h"
#include "configuration.h"
#include "logger.h"
#include "resources/dye.h"
#include "resources/image.h"
#include "resources/imagehelper.h"
#include "resources/imageset.h"
#include "resources/music.h"
#include "resources/soundeffect.h"
#include "resources/spritedef.h"
#include "utils/mkdir.h"
#include "utils/physfsrwops.h"
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include "debug.h"
ResourceManager *ResourceManager::instance = nullptr;
DelayedAnim ResourceManager::mDelayedAnimations;
ResourceManager::ResourceManager() :
mOldestOrphan(0),
mSelectedSkin(""),
mSkinName(""),
mDestruction(0)
{
logger->log1("Initializing resource manager...");
}
ResourceManager::~ResourceManager()
{
mDestruction = true;
mResources.insert(mOrphanedResources.begin(), mOrphanedResources.end());
mResources.insert(mDeletedResources.begin(), mDeletedResources.end());
// Release any remaining spritedefs first because they depend on image sets
ResourceIterator iter = mResources.begin();
#ifdef DEBUG_LEAKS
while (iter != mResources.end())
{
if (iter->second)
{
if (iter->second->getRefCount())
{
logger->log("ResourceLeak: " + iter->second->getIdPath()
+ " (" + toString(iter->second->getRefCount())
+ ")");
}
}
++iter;
}
iter = mResources.begin();
#endif
while (iter != mResources.end())
{
#ifdef DEBUG_LEAKS
if (iter->second && iter->second->getRefCount())
{
++iter;
continue;
}
#endif
if (dynamic_cast(iter->second))
{
cleanUp(iter->second);
const ResourceIterator toErase = iter;
++iter;
mResources.erase(toErase);
}
else
{
++iter;
}
}
// Release any remaining image sets first because they depend on images
iter = mResources.begin();
while (iter != mResources.end())
{
#ifdef DEBUG_LEAKS
if (iter->second && iter->second->getRefCount())
{
++iter;
continue;
}
#endif
if (dynamic_cast(iter->second))
{
cleanUp(iter->second);
const ResourceIterator toErase = iter;
++iter;
mResources.erase(toErase);
}
else
{
++iter;
}
}
// Release remaining resources, logging the number of dangling references.
iter = mResources.begin();
while (iter != mResources.end())
{
#ifdef DEBUG_LEAKS
if (iter->second && iter->second->getRefCount())
{
++iter;
continue;
}
#endif
if (iter->second)
{
cleanUp(iter->second);
const ResourceIterator toErase = iter;
++iter;
mResources.erase(toErase);
}
else
{
++iter;
}
}
clearScheduled();
}
void ResourceManager::cleanUp(Resource *const res)
{
if (!res)
return;
if (res->mRefCount > 0)
{
logger->log("ResourceManager::~ResourceManager() cleaning up %d "
"reference%s to %s",
res->mRefCount,
(res->mRefCount == 1) ? "" : "s",
res->mIdPath.c_str());
}
delete res;
#ifdef DEBUG_LEAKS
cleanOrpahns(true);
#endif
}
bool ResourceManager::cleanOrphans(const bool always)
{
timeval tv;
gettimeofday(&tv, nullptr);
// Delete orphaned resources after 30 seconds.
time_t oldest = tv.tv_sec;
const time_t threshold = oldest - 30;
if (mOrphanedResources.empty() || (!always && mOldestOrphan >= threshold))
return false;
bool status(false);
ResourceIterator iter = mOrphanedResources.begin();
while (iter != mOrphanedResources.end())
{
Resource *res = iter->second;
if (!res)
{
++iter;
continue;
}
const time_t t = res->mTimeStamp;
if (!always && t >= threshold)
{
if (t < oldest)
oldest = t;
++ iter;
}
else
{
#ifdef USE_OPENGL
const Image *const image = dynamic_cast(res);
const std::string src = image->getSource();
if (image && image->getGLImage())
{
logger->log("ResourceManager::release(%s, %u) %s",
res->mIdPath.c_str(), image->getGLImage(), src.c_str());
}
else
{
logger->log("ResourceManager::release(%s) %s",
res->mIdPath.c_str(), src.c_str());
}
#else
logger->log("ResourceManager::release(%s)", res->mIdPath.c_str());
#endif
const ResourceIterator toErase = iter;
++iter;
mOrphanedResources.erase(toErase);
delete res; // delete only after removal from list,
// to avoid issues in recursion
status = true;
}
}
mOldestOrphan = oldest;
return status;
}
bool ResourceManager::setWriteDir(const std::string &path) const
{
return static_cast(PHYSFS_setWriteDir(path.c_str()));
}
bool ResourceManager::addToSearchPath(const std::string &path,
const bool append) const
{
logger->log("Adding to PhysicsFS: %s (%s)", path.c_str(),
append ? "append" : "prepend");
if (!PHYSFS_addToSearchPath(path.c_str(), append ? 1 : 0))
{
logger->log("Error: %s", PHYSFS_getLastError());
return false;
}
return true;
}
bool ResourceManager::removeFromSearchPath(const std::string &path) const
{
logger->log("Removing from PhysicsFS: %s", path.c_str());
if (!PHYSFS_removeFromSearchPath(path.c_str()))
{
logger->log("Error: %s", PHYSFS_getLastError());
return false;
}
return true;
}
void ResourceManager::searchAndAddArchives(const std::string &path,
const std::string &ext,
const bool append) const
{
const char *const dirSep = PHYSFS_getDirSeparator();
char **list = PHYSFS_enumerateFiles(path.c_str());
for (char **i = list; *i; i++)
{
const size_t len = strlen(*i);
if (len > ext.length() && !ext.compare((*i) + (len - ext.length())))
{
std::string file, realPath, archive;
file = path + (*i);
realPath = std::string(PHYSFS_getRealDir(file.c_str()));
archive = realPath + dirSep + file;
addToSearchPath(archive, append);
}
}
PHYSFS_freeList(list);
}
void ResourceManager::searchAndRemoveArchives(const std::string &path,
const std::string &ext) const
{
const char *const dirSep = PHYSFS_getDirSeparator();
char **list = PHYSFS_enumerateFiles(path.c_str());
for (char **i = list; *i; i++)
{
const size_t len = strlen(*i);
if (len > ext.length() && !ext.compare((*i) + (len - ext.length())))
{
std::string file, realPath, archive;
file = path + (*i);
realPath = std::string(PHYSFS_getRealDir(file.c_str()));
archive = realPath + dirSep + file;
removeFromSearchPath(archive);
}
}
PHYSFS_freeList(list);
}
bool ResourceManager::mkdir(const std::string &path) const
{
return static_cast(PHYSFS_mkdir(path.c_str()));
}
bool ResourceManager::exists(const std::string &path) const
{
return PHYSFS_exists(path.c_str());
}
bool ResourceManager::existsLocal(const std::string &path) const
{
bool flg(false);
std::fstream file;
file.open(path.c_str(), std::ios::in);
if (file.is_open())
flg = true;
file.close();
return flg;
}
bool ResourceManager::isDirectory(const std::string &path) const
{
return PHYSFS_isDirectory(path.c_str());
}
std::string ResourceManager::getPath(const std::string &file) const
{
// get the real path to the file
const char *const tmp = PHYSFS_getRealDir(file.c_str());
std::string path;
// if the file is not in the search path, then its nullptr
if (tmp)
{
path = std::string(tmp) + PHYSFS_getDirSeparator() + file;
}
else
{
// if not found in search path return the default path
path = Client::getPackageDirectory() + PHYSFS_getDirSeparator() + file;
}
return path;
}
bool ResourceManager::addResource(const std::string &idPath,
Resource *const resource)
{
if (resource)
{
resource->incRef();
resource->mIdPath = idPath;
mResources[idPath] = resource;
return true;
}
return false;
}
Resource *ResourceManager::getFromCache(const std::string &filename,
const int variant)
{
std::stringstream ss;
ss << filename << "[" << variant << "]";
return getFromCache(ss.str());
}
Resource *ResourceManager::getFromCache(const std::string &idPath)
{
// Check if the id exists, and return the value if it does.
ResourceIterator resIter = mResources.find(idPath);
if (resIter != mResources.end())
{
if (resIter->second)
resIter->second->incRef();
return resIter->second;
}
resIter = mOrphanedResources.find(idPath);
if (resIter != mOrphanedResources.end())
{
Resource *const res = resIter->second;
mResources.insert(*resIter);
mOrphanedResources.erase(resIter);
if (res)
res->incRef();
return res;
}
return nullptr;
}
Resource *ResourceManager::get(const std::string &idPath, const generator fun,
const void *const data)
{
#ifndef DISABLE_RESOURCE_CACHING
Resource *resource = getFromCache(idPath);
if (resource)
return resource;
resource = fun(data);
if (resource)
{
resource->incRef();
resource->mIdPath = idPath;
mResources[idPath] = resource;
cleanOrphans();
}
else
{
logger->log("Error loaging image: " + idPath);
}
#else
Resource *resource = fun(data);
if (!resource)
{
logger->log("Error loaging image: " + idPath);
}
#endif
// Returns nullptr if the object could not be created.
return resource;
}
struct ResourceLoader
{
ResourceManager *manager;
std::string path;
ResourceManager::loader fun;
static Resource *load(const void *const v)
{
if (!v)
return nullptr;
const ResourceLoader *const
rl = static_cast(v);
SDL_RWops *const rw = PHYSFSRWOPS_openRead(rl->path.c_str());
if (!rw)
return nullptr;
Resource *const res = rl->fun(rw);
return res;
}
};
Resource *ResourceManager::load(const std::string &path, const loader fun)
{
ResourceLoader rl = { this, path, fun };
return get(path, ResourceLoader::load, &rl);
}
Music *ResourceManager::getMusic(const std::string &idPath)
{
return static_cast(load(idPath, Music::load));
}
SoundEffect *ResourceManager::getSoundEffect(const std::string &idPath)
{
return static_cast(load(idPath, SoundEffect::load));
}
struct DyedImageLoader
{
ResourceManager *manager;
std::string path;
static Resource *load(const void *const v)
{
if (!v)
return nullptr;
const DyedImageLoader *const rl
= static_cast(v);
if (!rl->manager)
return nullptr;
std::string path = rl->path;
const size_t p = path.find('|');
Dye *d = nullptr;
if (p != std::string::npos)
{
d = new Dye(path.substr(p + 1));
path = path.substr(0, p);
}
SDL_RWops *const rw = PHYSFSRWOPS_openRead(path.c_str());
if (!rw)
{
delete d;
return nullptr;
}
Resource *const res = d ? imageHelper->load(rw, *d)
: imageHelper->load(rw);
delete d;
return res;
}
};
Image *ResourceManager::getImage(const std::string &idPath)
{
DyedImageLoader rl = { this, idPath };
return static_cast(get(idPath, DyedImageLoader::load, &rl));
}
/*
Image *ResourceManager::getSkinImage(const std::string &idPath)
{
if (mSelectedSkin.empty())
return getImage(idPath);
DyedImageLoader rl = { this, mSelectedSkin + idPath };
void *ptr = get(idPath, DyedImageLoader::load, &rl);
if (ptr)
return static_cast(ptr);
else
return getImage(idPath);
}
*/
struct ImageSetLoader
{
ResourceManager *manager;
std::string path;
int w, h;
static Resource *load(const void *const v)
{
if (!v)
return nullptr;
const ImageSetLoader *const
rl = static_cast(v);
if (!rl->manager)
return nullptr;
Image *const img = rl->manager->getImage(rl->path);
if (!img)
return nullptr;
ImageSet *const res = new ImageSet(img, rl->w, rl->h);
img->decRef();
return res;
}
};
ImageSet *ResourceManager::getImageSet(const std::string &imagePath,
const int w, const int h)
{
ImageSetLoader rl = { this, imagePath, w, h };
std::stringstream ss;
ss << imagePath << "[" << w << "x" << h << "]";
return static_cast(get(ss.str(), ImageSetLoader::load, &rl));
}
struct SubImageSetLoader
{
ResourceManager *manager;
Image *parent;
int width, height;
static Resource *load(const void *const v)
{
if (!v)
return nullptr;
const SubImageSetLoader *const
rl = static_cast(v);
if (!rl->manager)
return nullptr;
if (!rl->parent)
return nullptr;
ImageSet *const res = new ImageSet(rl->parent, rl->width, rl->height);
return res;
}
};
ImageSet *ResourceManager::getSubImageSet(Image *const parent,
const int width, const int height)
{
if (!parent)
return nullptr;
const SubImageSetLoader rl = { this, parent, width, height };
std::stringstream ss;
ss << parent->getIdPath() << ", set[" << width << "x" << height << "]";
return static_cast(get(ss.str(), SubImageSetLoader::load, &rl));
}
struct SubImageLoader
{
ResourceManager *manager;
Image *parent;
int x, y;
int width, height;
static Resource *load(const void *const v)
{
if (!v)
return nullptr;
const SubImageLoader *const
rl = static_cast(v);
if (!rl->manager || !rl->parent)
return nullptr;
Image *const res = rl->parent->getSubImage(rl->x, rl->y,
rl->width, rl->height);
return res;
}
};
Image *ResourceManager::getSubImage(Image *const parent,
const int x, const int y,
const int width, const int height)
{
if (!parent)
return nullptr;
const SubImageLoader rl = { this, parent, x, y, width, height};
std::stringstream ss;
ss << parent->getIdPath() << ",[" << x << "," << y << ","
<< width << "x" << height << "]";
return static_cast(get(ss.str(), SubImageLoader::load, &rl));
}
struct SpriteDefLoader
{
std::string path;
int variant;
static Resource *load(const void *const v)
{
if (!v)
return nullptr;
const SpriteDefLoader *const
rl = static_cast(v);
return SpriteDef::load(rl->path, rl->variant);
}
};
SpriteDef *ResourceManager::getSprite(const std::string &path,
const int variant)
{
SpriteDefLoader rl = { path, variant };
std::stringstream ss;
ss << path << "[" << variant << "]";
return static_cast(get(ss.str(), SpriteDefLoader::load, &rl));
}
void ResourceManager::release(Resource *const res)
{
#ifndef DISABLE_RESOURCE_CACHING
if (!res || mDestruction)
return;
ResourceIterator resIter = mDeletedResources.find(res->mIdPath);
if (resIter != mDeletedResources.end() && resIter->second == res)
{
// we found zero counted image in deleted list. deleting it and exit.
mDeletedResources.erase(resIter);
delete res;
return;
}
resIter = mResources.find(res->mIdPath);
// The resource has to exist
assert(resIter != mResources.end() && resIter->second == res);
timeval tv;
gettimeofday(&tv, nullptr);
const time_t timestamp = tv.tv_sec;
res->mTimeStamp = timestamp;
if (mOrphanedResources.empty())
mOldestOrphan = timestamp;
mOrphanedResources.insert(*resIter);
mResources.erase(resIter);
#else
delete res;
#endif
}
void ResourceManager::moveToDeleted(Resource *const res)
{
ResourceIterator resIter = mResources.find(res->mIdPath);
if (resIter != mResources.end() && resIter->second == res)
{
mDeletedResources.insert(*resIter);
mResources.erase(resIter);
}
resIter = mOrphanedResources.find(res->mIdPath);
if (resIter != mOrphanedResources.end() && resIter->second == res)
{
mDeletedResources.insert(*resIter);
mOrphanedResources.erase(resIter);
}
}
ResourceManager *ResourceManager::getInstance()
{
// Create a new instance if necessary.
if (!instance)
instance = new ResourceManager;
return instance;
}
void ResourceManager::deleteInstance()
{
#ifdef DUMP_LEAKED_RESOURCES
if (instance)
{
logger->log("clean orphans start");
while (instance->cleanOrphans(true));
logger->log("clean orphans end");
ResourceIterator iter = instance->mResources.begin();
while (iter != instance->mResources.end())
{
const Resource *const res = iter->second;
if (res)
{
if (res->getRefCount())
{
logger->log("ResourceLeak: " + res->getIdPath()
+ " (" + toString(res->getRefCount()) + ")");
}
}
++iter;
}
}
#endif
delete instance;
instance = nullptr;
}
void *ResourceManager::loadFile(const std::string &fileName, int &fileSize)
{
// Attempt to open the specified file using PhysicsFS
PHYSFS_file *const file = PHYSFS_openRead(fileName.c_str());
// If the handler is an invalid pointer indicate failure
if (!file)
{
logger->log("Warning: Failed to load %s: %s",
fileName.c_str(), PHYSFS_getLastError());
return nullptr;
}
// Log the real dir of the file
logger->log("Loaded %s/%s", PHYSFS_getRealDir(fileName.c_str()),
fileName.c_str());
// Get the size of the file
fileSize = static_cast(PHYSFS_fileLength(file));
// Allocate memory and load the file
void *const buffer = calloc(fileSize, 1);
PHYSFS_read(file, buffer, 1, fileSize);
// Close the file and let the user deallocate the memory
PHYSFS_close(file);
return buffer;
}
bool ResourceManager::copyFile(const std::string &src,
const std::string &dst) const
{
PHYSFS_file *const srcFile = PHYSFS_openRead(src.c_str());
if (!srcFile)
{
logger->log("Read error: %s", PHYSFS_getLastError());
return false;
}
PHYSFS_file *const dstFile = PHYSFS_openWrite(dst.c_str());
if (!dstFile)
{
logger->log("Write error: %s", PHYSFS_getLastError());
PHYSFS_close(srcFile);
return false;
}
const int fileSize = static_cast(PHYSFS_fileLength(srcFile));
void *buf = malloc(fileSize);
PHYSFS_read(srcFile, buf, 1, fileSize);
PHYSFS_write(dstFile, buf, 1, fileSize);
PHYSFS_close(srcFile);
PHYSFS_close(dstFile);
free(buf);
return true;
}
bool ResourceManager::loadTextFile(const std::string &fileName,
StringVect &lines)
{
int contentsLength;
char *fileContents = static_cast(
loadFile(fileName, contentsLength));
if (!fileContents)
{
logger->log("Couldn't load text file: %s", fileName.c_str());
return false;
}
std::istringstream iss(std::string(fileContents, contentsLength));
std::string line;
while (getline(iss, line))
lines.push_back(line);
free(fileContents);
return true;
}
StringVect ResourceManager::loadTextFileLocal(
const std::string &fileName)
{
std::ifstream file;
char line[501];
StringVect lines;
file.open(fileName.c_str(), std::ios::in);
if (!file.is_open())
{
logger->log("Couldn't load text file: %s", fileName.c_str());
return lines;
}
while (file.getline(line, 500))
lines.push_back(line);
return lines;
}
void ResourceManager::saveTextFile(std::string path, std::string name,
std::string text) const
{
if (!mkdir_r(path.c_str()))
{
std::ofstream file;
std::string fileName = path + "/" + name;
file.open(fileName.c_str(), std::ios::out);
if (file.is_open())
file << text << std::endl;
file.close();
}
}
SDL_Surface *ResourceManager::loadSDLSurface(const std::string &filename) const
{
SDL_Surface *surface = nullptr;
if (SDL_RWops *const rw = PHYSFSRWOPS_openRead(filename.c_str()))
surface = IMG_Load_RW(rw, 1);
return surface;
}
void ResourceManager::scheduleDelete(SDL_Surface *const surface)
{
deletedSurfaces.insert(surface);
}
void ResourceManager::clearScheduled()
{
for (std::set::iterator i = deletedSurfaces.begin(),
i_end = deletedSurfaces.end(); i != i_end; ++i)
{
SDL_FreeSurface(*i);
}
deletedSurfaces.clear();
}
struct RescaledLoader
{
ResourceManager *manager;
Image *image;
int width;
int height;
static Resource *load(const void *const v)
{
if (!v)
return nullptr;
const RescaledLoader *const rl
= static_cast(v);
if (!rl->manager || !rl->image)
return nullptr;
Image *const rescaled = rl->image->SDLgetScaledImage(
rl->width, rl->height);
if (!rescaled)
return nullptr;
return rescaled;
}
};
Image *ResourceManager::getRescaled(Image *const image,
const int width, const int height)
{
if (!image)
return nullptr;
std::string idPath = image->getIdPath() + strprintf(
"_rescaled%dx%d", width, height);
const RescaledLoader rl = { this, image, width, height };
Image *const img = static_cast(
get(idPath, RescaledLoader::load, &rl));
return img;
}
void ResourceManager::delayedLoad()
{
static int loadTime = 0;
if (loadTime < cur_time)
{
loadTime = tick_time;
int k = 0;
DelayedAnimIter it = mDelayedAnimations.begin();
DelayedAnimIter it_end = mDelayedAnimations.end();
while (it != it_end && k < 1)
{
(*it)->load();
AnimationDelayLoad *tmp = *it;
it = mDelayedAnimations.erase(it);
delete tmp;
k ++;
}
const int time2 = tick_time;
if (time2 > loadTime)
loadTime = time2 + (time2 - loadTime) * 2 + 10;
else
loadTime = time2 + 3;
}
}
void ResourceManager::removeDelayLoad(const AnimationDelayLoad
*const delayedLoad)
{
for (DelayedAnimIter it = mDelayedAnimations.begin(),
it_end = mDelayedAnimations.end(); it != it_end; ++ it)
{
if (*it == delayedLoad)
{
mDelayedAnimations.erase(it);
return;
}
}
}