1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
|
/*
* Copyright (C) 2005-2018 Team Kodi
* This file is part of Kodi - https://kodi.tv
*
* SPDX-License-Identifier: GPL-2.0-or-later
* See LICENSES/README.md for more information.
*/
#include "GUILargeTextureManager.h"
#include "ServiceBroker.h"
#include "TextureCache.h"
#include "commons/ilog.h"
#include "guilib/GUIComponent.h"
#include "guilib/Texture.h"
#include "utils/JobManager.h"
#include "utils/TimeUtils.h"
#include "utils/log.h"
#include "windowing/GraphicContext.h"
#include "windowing/WinSystem.h"
#include <cassert>
#include <chrono>
#include <exception>
#include <mutex>
CImageLoader::CImageLoader(const std::string& path, const bool useCache)
: m_path(path), m_texture(nullptr)
{
m_use_cache = useCache;
}
CImageLoader::~CImageLoader() = default;
bool CImageLoader::DoWork()
{
bool needsChecking = false;
std::string loadPath;
std::string texturePath = CServiceBroker::GetGUI()->GetTextureManager().GetTexturePath(m_path);
if (texturePath.empty())
return false;
if (m_use_cache)
loadPath = CServiceBroker::GetTextureCache()->CheckCachedImage(texturePath, needsChecking);
else
loadPath = texturePath;
if (!loadPath.empty())
{
// direct route - load the image
auto start = std::chrono::steady_clock::now();
m_texture =
CTexture::LoadFromFile(loadPath, CServiceBroker::GetWinSystem()->GetGfxContext().GetWidth(),
CServiceBroker::GetWinSystem()->GetGfxContext().GetHeight());
auto end = std::chrono::steady_clock::now();
auto duration = std::chrono::duration_cast<std::chrono::milliseconds>(end - start);
if (duration.count() > 100)
CLog::Log(LOGDEBUG, "{} - took {} ms to load {}", __FUNCTION__, duration.count(), loadPath);
if (m_texture)
{
if (needsChecking)
CServiceBroker::GetTextureCache()->BackgroundCacheImage(texturePath);
return true;
}
// Fallthrough on failure:
CLog::Log(LOGERROR, "{} - Direct texture file loading failed for {}", __FUNCTION__, loadPath);
}
if (!m_use_cache)
return false; // We're done
// not in our texture cache or it failed to load from it, so try and load directly and then cache the result
CServiceBroker::GetTextureCache()->CacheImage(texturePath, &m_texture);
return (m_texture != NULL);
}
CGUILargeTextureManager::CLargeTexture::CLargeTexture(const std::string &path):
m_path(path)
{
m_refCount = 1;
m_timeToDelete = 0;
}
CGUILargeTextureManager::CLargeTexture::~CLargeTexture()
{
assert(m_refCount == 0);
m_texture.Free();
}
void CGUILargeTextureManager::CLargeTexture::AddRef()
{
m_refCount++;
}
bool CGUILargeTextureManager::CLargeTexture::DecrRef(bool deleteImmediately)
{
assert(m_refCount);
m_refCount--;
if (m_refCount == 0)
{
if (deleteImmediately)
delete this;
else
m_timeToDelete = CTimeUtils::GetFrameTime() + TIME_TO_DELETE;
return true;
}
return false;
}
bool CGUILargeTextureManager::CLargeTexture::DeleteIfRequired(bool deleteImmediately)
{
if (m_refCount == 0 && (deleteImmediately || m_timeToDelete < CTimeUtils::GetFrameTime()))
{
delete this;
return true;
}
return false;
}
void CGUILargeTextureManager::CLargeTexture::SetTexture(std::unique_ptr<CTexture> texture)
{
assert(!m_texture.size());
if (texture)
{
const auto width = texture->GetWidth();
const auto height = texture->GetHeight();
m_texture.Set(std::move(texture), width, height);
}
}
CGUILargeTextureManager::CGUILargeTextureManager() = default;
CGUILargeTextureManager::~CGUILargeTextureManager() = default;
void CGUILargeTextureManager::CleanupUnusedImages(bool immediately)
{
std::unique_lock<CCriticalSection> lock(m_listSection);
// check for items to remove from allocated list, and remove
listIterator it = m_allocated.begin();
while (it != m_allocated.end())
{
CLargeTexture *image = *it;
if (image->DeleteIfRequired(immediately))
it = m_allocated.erase(it);
else
++it;
}
}
// if available, increment reference count, and return the image.
// else, add to the queue list if appropriate.
bool CGUILargeTextureManager::GetImage(const std::string &path, CTextureArray &texture, bool firstRequest, const bool useCache)
{
std::unique_lock<CCriticalSection> lock(m_listSection);
for (listIterator it = m_allocated.begin(); it != m_allocated.end(); ++it)
{
CLargeTexture *image = *it;
if (image->GetPath() == path)
{
if (firstRequest)
image->AddRef();
texture = image->GetTexture();
return texture.size() > 0;
}
}
if (firstRequest)
QueueImage(path, useCache);
return true;
}
void CGUILargeTextureManager::ReleaseImage(const std::string &path, bool immediately)
{
std::unique_lock<CCriticalSection> lock(m_listSection);
for (listIterator it = m_allocated.begin(); it != m_allocated.end(); ++it)
{
CLargeTexture *image = *it;
if (image->GetPath() == path)
{
if (image->DecrRef(immediately) && immediately)
m_allocated.erase(it);
return;
}
}
for (queueIterator it = m_queued.begin(); it != m_queued.end(); ++it)
{
unsigned int id = it->first;
CLargeTexture *image = it->second;
if (image->GetPath() == path && image->DecrRef(true))
{
// cancel this job
CServiceBroker::GetJobManager()->CancelJob(id);
m_queued.erase(it);
return;
}
}
}
// queue the image, and start the background loader if necessary
void CGUILargeTextureManager::QueueImage(const std::string &path, bool useCache)
{
if (path.empty())
return;
std::unique_lock<CCriticalSection> lock(m_listSection);
for (queueIterator it = m_queued.begin(); it != m_queued.end(); ++it)
{
CLargeTexture *image = it->second;
if (image->GetPath() == path)
{
image->AddRef();
return; // already queued
}
}
// queue the item
CLargeTexture *image = new CLargeTexture(path);
unsigned int jobID = CServiceBroker::GetJobManager()->AddJob(new CImageLoader(path, useCache),
this, CJob::PRIORITY_NORMAL);
m_queued.emplace_back(jobID, image);
}
void CGUILargeTextureManager::OnJobComplete(unsigned int jobID, bool success, CJob *job)
{
// see if we still have this job id
std::unique_lock<CCriticalSection> lock(m_listSection);
for (queueIterator it = m_queued.begin(); it != m_queued.end(); ++it)
{
if (it->first == jobID)
{ // found our job
CImageLoader *loader = static_cast<CImageLoader*>(job);
CLargeTexture *image = it->second;
image->SetTexture(std::move(loader->m_texture));
loader->m_texture = NULL; // we want to keep the texture, and jobs are auto-deleted.
m_queued.erase(it);
m_allocated.push_back(image);
return;
}
}
}
|