image_file_cache.hpp

Go to the documentation of this file.

#pragma once

 
#ifdef PULP_HAS_SKIA
 
#include <chrono>
#include <cstddef>
#include <cstdint>
#include <functional>
#include <string>
 
#include "include/core/SkRefCnt.h"
 
class SkImage;
 
namespace pulp::canvas {
 
class ImageFileCache {
public:
    static ImageFileCache& instance();

    sk_sp<SkImage> get_or_build(
        const std::string& path,
        const void* backend_key,
        const std::function<sk_sp<SkImage>()>& build);

    static constexpr std::size_t kDefaultFileByteBudget = 64u * 1024u * 1024u;

    static constexpr std::chrono::milliseconds kFailureRetryDelay{1000};

    static constexpr std::size_t kDefaultInlineByteBudget = 96u * 1024u * 1024u;

    sk_sp<SkImage> get_or_build_inline(const std::string& content_key, const void* backend_key,
                                       std::size_t encoded_size,
                                       const std::function<sk_sp<SkImage>()>& build);
 
    struct Stats {
        std::uint64_t hits = 0;    
        std::uint64_t builds = 0;  
        std::size_t size = 0;      
        std::size_t bytes = 0;     
    };
    Stats stats() const;
 
    struct InlineStats {
        std::uint64_t hits = 0;        
        std::uint64_t builds = 0;      
        std::uint64_t over_budget = 0; 
        std::size_t size = 0;          
        std::size_t bytes = 0;         
    };
    InlineStats inline_stats() const;
    void reset_stats();

    void clear();

    void clear_backend(const void* backend_key);

    void begin_frame(const void* backend_key);

    void set_enabled(bool enabled);
    bool enabled() const;

    void set_capacity(std::size_t capacity);
    std::size_t capacity() const;

    void set_byte_budget(std::size_t bytes);
    std::size_t byte_budget() const;

    void set_inline_byte_budget(std::size_t bytes);
    std::size_t inline_byte_budget() const;

    void set_clock_for_testing(std::function<std::chrono::steady_clock::time_point()> now);
 
  private:
    ImageFileCache() = default;
    struct Impl;
    // Defined in image_file_cache.cpp; stateful members live there to keep this
    // header free of <mutex>/<list>/<unordered_map> and the full SkImage type.
    static Impl& impl();
};
 
}  // namespace pulp::canvas
 
#endif  // PULP_HAS_SKIA