TextureCache.h

/*
 *  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.
 */

#pragma once

#include "TextureCacheJob.h"
#include "TextureDatabase.h"
#include "threads/CriticalSection.h"
#include "threads/Event.h"
#include "utils/JobManager.h"

#include <memory>
#include <set>
#include <string>
#include <vector>

class CJob;
class CURL;
class CTexture;

class CTextureCache : public CJobQueue
{
public:
  CTextureCache();
  ~CTextureCache() override;

  void Initialize();

  void Deinitialize();

  std::string CheckCachedImage(const std::string &image, bool &needsRecaching);

  void BackgroundCacheImage(const std::string &image);

  bool StartCacheImage(const std::string& image);

  std::string CacheImage(const std::string& image,
                         std::unique_ptr<CTexture>* texture = nullptr,
                         CTextureDetails* details = nullptr);

  bool CacheImage(const std::string &image, CTextureDetails &details);

  bool HasCachedImage(const std::string &image);

  void ClearCachedImage(const std::string &image, bool deleteSource = false);

  bool ClearCachedImage(int textureID);

  static std::string GetCacheFile(const std::string &url);

  static std::string GetCachedPath(const std::string &file);

  static bool CanCacheImageURL(const CURL &url);

  bool AddCachedTexture(const std::string &image, const CTextureDetails &details);

  bool Export(const std::string &image, const std::string &destination, bool overwrite);
  bool Export(const std::string &image, const std::string &destination); 
private:
  // private construction, and no assignments; use the provided singleton methods
  CTextureCache(const CTextureCache&) = delete;
  CTextureCache const& operator=(CTextureCache const&) = delete;

  bool IsCachedImage(const std::string &image) const;

  std::string GetCachedImage(const std::string &image, CTextureDetails &details, bool trackUsage = false);

  bool GetCachedTexture(const std::string &url, CTextureDetails &details);

  bool ClearCachedTexture(const std::string &url, std::string &cacheFile);
  bool ClearCachedTexture(int textureID, std::string &cacheFile);

  void IncrementUseCount(const CTextureDetails &details);

  bool SetCachedTextureValid(const std::string &url, bool updateable);

  void OnJobComplete(unsigned int jobID, bool success, CJob *job) override;

  void OnCachingComplete(bool success, CTextureCacheJob *job);

  CCriticalSection m_databaseSection;
  CTextureDatabase m_database;
  std::set<std::string> m_processinglist; 
  CCriticalSection     m_processingSection;
  CEvent               m_completeEvent; 
  std::vector<CTextureDetails> m_useCounts; 
  CCriticalSection             m_useCountSection;
};