#include <cstdlib>
#include <memory.h>
#include <mutex>
#include "MEM_CacheLimiterC-Api.h"
#include "MEM_guardedalloc.h"
#include "BLI_ghash.h"
#include "BLI_mempool.h"
#include "BLI_string.h"
#include "IMB_moviecache.hh"
#include "IMB_imbuf.hh"
#include "IMB_imbuf_types.hh"

Classes
struct	MovieCache
struct	MovieCacheKey
struct	MovieCacheItem

Macros
#define	PRINT(format, ...)

Functions
static uint	moviecache_hashhash (const void *keyv)
static bool	moviecache_hashcmp (const void av, const void bv)
static void	moviecache_keyfree (void *val)
static void	moviecache_valfree (void *val)
static void	check_unused_keys (MovieCache *cache)
static int	compare_int (const void av, const void bv)
static void	moviecache_destructor (void *p)
static size_t	get_size_in_memory (ImBuf *ibuf)
static size_t	get_item_size (void *p)
static int	get_item_priority (void *item_v, int default_priority)
static bool	get_item_destroyable (void *item_v)
void	IMB_moviecache_init ()
void	IMB_moviecache_destruct ()
MovieCache *	IMB_moviecache_create (const char *name, int keysize, GHashHashFP hashfp, GHashCmpFP cmpfp)
void	IMB_moviecache_set_getdata_callback (MovieCache *cache, MovieCacheGetKeyDataFP getdatafp)
void	IMB_moviecache_set_priority_callback (MovieCache *cache, MovieCacheGetPriorityDataFP getprioritydatafp, MovieCacheGetItemPriorityFP getitempriorityfp, MovieCachePriorityDeleterFP prioritydeleterfp)
static void	do_moviecache_put (MovieCache cache, void userkey, ImBuf *ibuf, bool need_lock)
void	IMB_moviecache_put (MovieCache cache, void userkey, ImBuf *ibuf)
bool	IMB_moviecache_put_if_possible (MovieCache cache, void userkey, ImBuf *ibuf)
void	IMB_moviecache_remove (MovieCache cache, void userkey)
ImBuf *	IMB_moviecache_get (MovieCache cache, void userkey, bool *r_is_cached_empty)
bool	IMB_moviecache_has_frame (MovieCache cache, void userkey)
void	IMB_moviecache_free (MovieCache *cache)
void	IMB_moviecache_cleanup (MovieCache cache, bool(cleanup_check_cb)(ImBuf ibuf, void userkey, void userdata), void *userdata)
void	IMB_moviecache_get_cache_segments (MovieCache cache, int proxy, int render_flags, int r_totseg, int **r_points)
MovieCacheIter *	IMB_moviecacheIter_new (MovieCache *cache)
void	IMB_moviecacheIter_free (MovieCacheIter *iter)
bool	IMB_moviecacheIter_done (MovieCacheIter *iter)
void	IMB_moviecacheIter_step (MovieCacheIter *iter)
ImBuf *	IMB_moviecacheIter_getImBuf (MovieCacheIter *iter)
void *	IMB_moviecacheIter_getUserKey (MovieCacheIter *iter)

Variables
static MEM_CacheLimiterC *	limitor = nullptr
static std::recursive_mutex	limitor_lock

Macro Definition Documentation

◆ PRINT

#define PRINT	(		format,
			... )

Definition at line 34 of file moviecache.cc.

Referenced by check_unused_keys(), do_moviecache_put(), get_item_priority(), IMB_moviecache_cleanup(), IMB_moviecache_create(), IMB_moviecache_free(), moviecache_destructor(), moviecache_valfree(), print_help(), wm_handlers_do_keymap_with_gizmo_handler(), and wm_handlers_do_keymap_with_keymap_handler().

Function Documentation

◆ check_unused_keys()

void check_unused_keys ( MovieCache * cache )

static

Definition at line 131 of file moviecache.cc.

References MovieCacheItem::added_empty, BLI_ghash_remove(), BLI_ghashIterator_done(), BLI_ghashIterator_getKey(), BLI_ghashIterator_getValue(), BLI_ghashIterator_init(), BLI_ghashIterator_step(), check_unused_keys(), MovieCache::hash, MovieCacheItem::ibuf, moviecache_keyfree(), moviecache_valfree(), MovieCache::name, and PRINT.

Referenced by check_unused_keys(), do_moviecache_put(), IMB_moviecache_cleanup(), and IMB_moviecacheIter_new().

◆ compare_int()

int compare_int	(	const void *	av,
		const void *	bv )

static

Definition at line 161 of file moviecache.cc.

References b, and compare_int().

Referenced by compare_int(), and IMB_moviecache_get_cache_segments().

◆ do_moviecache_put()

void do_moviecache_put	(	MovieCache *	cache,
		void *	userkey,
		ImBuf *	ibuf,
		bool	need_lock )

static

Definition at line 308 of file moviecache.cc.

References MovieCacheItem::added_empty, BLI_ghash_reinsert(), BLI_mempool_alloc(), MovieCacheItem::c_handle, MovieCacheItem::cache_owner, MovieCacheKey::cache_owner, check_unused_keys(), do_moviecache_put(), MovieCache::getprioritydatafp, MovieCache::hash, MovieCacheItem::ibuf, IMB_moviecache_init(), IMB_refImBuf(), MovieCache::items_pool, MovieCache::keys_pool, MovieCache::keysize, MovieCache::last_userkey, limitor, limitor_lock, MEM_CacheLimiter_enforce_limits(), MEM_CacheLimiter_insert(), MEM_CacheLimiter_ref(), MEM_CacheLimiter_unref(), MEM_SAFE_FREE, moviecache_keyfree(), moviecache_valfree(), MovieCache::name, MovieCache::points, PRINT, MovieCacheItem::priority_data, MovieCacheKey::userkey, and MovieCache::userkeys_pool.

Referenced by do_moviecache_put(), IMB_moviecache_put(), and IMB_moviecache_put_if_possible().

◆ get_item_destroyable()

bool get_item_destroyable ( void * item_v )

static

Definition at line 231 of file moviecache.cc.

References get_item_destroyable(), IB_BITMAPDIRTY, IB_PERSISTENT, MovieCacheItem::ibuf, and ImBuf::userflags.

Referenced by get_item_destroyable(), and IMB_moviecache_init().

◆ get_item_priority()

int get_item_priority	(	void *	item_v,
		int	default_priority )

static

Definition at line 208 of file moviecache.cc.

References MovieCacheItem::cache_owner, get_item_priority(), MovieCache::getitempriorityfp, MovieCache::last_userkey, MovieCache::name, PRINT, and MovieCacheItem::priority_data.

Referenced by get_item_priority(), and IMB_moviecache_init().

◆ get_item_size()

size_t get_item_size ( void * p )

static

Definition at line 196 of file moviecache.cc.

References get_item_size(), get_size_in_memory(), MovieCacheItem::ibuf, and size().

Referenced by get_item_size(), and IMB_moviecache_init().

◆ get_size_in_memory()

size_t get_size_in_memory ( ImBuf * ibuf )

static

Definition at line 187 of file moviecache.cc.

References get_size_in_memory(), IB_PERSISTENT, IMB_get_size_in_memory(), and ImBuf::userflags.

Referenced by get_item_size(), get_size_in_memory(), and IMB_moviecache_put_if_possible().

◆ IMB_moviecache_cleanup()

void IMB_moviecache_cleanup	(	MovieCache *	cache,
		bool(cleanup_check_cb)(ImBuf ibuf, void userkey, void *userdata)	,
		void *	userdata )

◆ IMB_moviecache_create()

MovieCache * IMB_moviecache_create	(	const char *	name,
		int	keysize,
		GHashHashFP	hashfp,
		GHashCmpFP	cmpfp )

Definition at line 264 of file moviecache.cc.

References BLI_ghash_new(), BLI_mempool_create(), BLI_MEMPOOL_NOP, MovieCache::cmpfp, MovieCache::hash, MovieCache::hashfp, IMB_moviecache_create(), MovieCache::items_pool, MovieCache::keys_pool, MovieCache::keysize, MEM_callocN(), moviecache_hashcmp(), moviecache_hashhash(), MovieCache::name, PRINT, MovieCache::proxy, STRNCPY(), and MovieCache::userkeys_pool.

Referenced by colormanage_moviecache_ensure(), imagecache_put(), IMB_moviecache_create(), and put_imbuf_cache().

◆ IMB_moviecache_destruct()

void IMB_moviecache_destruct ( )

Definition at line 256 of file moviecache.cc.

References delete_MEM_CacheLimiter(), IMB_moviecache_destruct(), and limitor.

Referenced by BKE_blender_free(), IMB_moviecache_destruct(), blender::bke::image::partial_update::ImagePartialUpdateTest::TearDown(), and blender::bke::tests::ImageTest::TearDown().

◆ IMB_moviecache_free()

void IMB_moviecache_free ( MovieCache * cache )

Definition at line 443 of file moviecache.cc.

References BLI_ghash_free(), BLI_mempool_destroy(), MovieCache::hash, IMB_moviecache_free(), MovieCache::items_pool, MovieCache::keys_pool, MovieCache::last_userkey, MEM_freeN(), moviecache_keyfree(), moviecache_valfree(), MovieCache::name, MovieCache::points, PRINT, and MovieCache::userkeys_pool.

Referenced by colormanage_cache_free(), free_buffers(), image_free_cached_frames(), and IMB_moviecache_free().

◆ IMB_moviecache_get()

ImBuf * IMB_moviecache_get	(	MovieCache *	cache,
		void *	userkey,
		bool *	r_is_cached_empty )

Definition at line 400 of file moviecache.cc.

References MovieCacheItem::added_empty, BLI_ghash_lookup(), MovieCacheItem::c_handle, MovieCacheKey::cache_owner, MovieCache::hash, MovieCacheItem::ibuf, IMB_moviecache_get(), IMB_refImBuf(), limitor_lock, lock, MEM_CacheLimiter_touch(), and MovieCacheKey::userkey.

Referenced by colormanage_cache_get_ibuf(), get_imbuf_cache(), imagecache_get(), and IMB_moviecache_get().

◆ IMB_moviecache_get_cache_segments()

void IMB_moviecache_get_cache_segments	(	MovieCache *	cache,
		int	proxy,
		int	render_flags,
		int *	r_totseg,
		int **	r_points )

Get segments of cached frames. Useful for debugging cache policies.

Definition at line 488 of file moviecache.cc.

References b, BLI_ghash_len(), BLI_ghashIterator_getKey(), BLI_ghashIterator_getValue(), compare_int(), MovieCache::getdatafp, GHASH_ITER, MovieCache::hash, MovieCacheItem::ibuf, IMB_moviecache_get_cache_segments(), MEM_calloc_arrayN(), MEM_freeN(), MEM_SAFE_FREE, MovieCache::points, MovieCache::proxy, MovieCache::render_flags, MovieCache::totseg, and MovieCacheKey::userkey.

Referenced by BKE_movieclip_get_cache_segments(), draw_image_cache(), and IMB_moviecache_get_cache_segments().

◆ IMB_moviecache_has_frame()

bool IMB_moviecache_has_frame	(	MovieCache *	cache,
		void *	userkey )

Definition at line 431 of file moviecache.cc.

References BLI_ghash_lookup(), MovieCacheKey::cache_owner, MovieCache::hash, IMB_moviecache_has_frame(), and MovieCacheKey::userkey.

Referenced by has_imbuf_cache(), and IMB_moviecache_has_frame().

◆ IMB_moviecache_init()

void IMB_moviecache_init ( )

Definition at line 248 of file moviecache.cc.

References get_item_destroyable(), get_item_priority(), get_item_size(), IMB_moviecache_init(), limitor, MEM_CacheLimiter_ItemDestroyable_Func_set(), MEM_CacheLimiter_ItemPriority_Func_set(), moviecache_destructor(), and new_MEM_CacheLimiter().

Referenced by do_moviecache_put(), IMB_moviecache_init(), and blender::bke::tests::ImageTest::SetUp().

◆ IMB_moviecache_put()

void IMB_moviecache_put	(	MovieCache *	cache,
		void *	userkey,
		ImBuf *	ibuf )

Definition at line 366 of file moviecache.cc.

References do_moviecache_put(), and IMB_moviecache_put().

Referenced by colormanage_cache_put(), imagecache_put(), IMB_moviecache_put(), and put_imbuf_cache().

◆ IMB_moviecache_put_if_possible()

bool IMB_moviecache_put_if_possible	(	MovieCache *	cache,
		void *	userkey,
		ImBuf *	ibuf )

Definition at line 371 of file moviecache.cc.

References do_moviecache_put(), get_size_in_memory(), IMB_moviecache_put_if_possible(), limitor, limitor_lock, MEM_CacheLimiter_get_maximum(), MEM_CacheLimiter_get_memory_in_use(), and result.

Referenced by IMB_moviecache_put_if_possible(), and put_imbuf_cache().

◆ IMB_moviecache_remove()

void IMB_moviecache_remove	(	MovieCache *	cache,
		void *	userkey )

Definition at line 392 of file moviecache.cc.

References BLI_ghash_remove(), MovieCacheKey::cache_owner, MovieCache::hash, IMB_moviecache_remove(), moviecache_keyfree(), moviecache_valfree(), and MovieCacheKey::userkey.

Referenced by imagecache_remove(), and IMB_moviecache_remove().

◆ IMB_moviecache_set_getdata_callback()

void IMB_moviecache_set_getdata_callback	(	MovieCache *	cache,
		MovieCacheGetKeyDataFP	getdatafp )

Definition at line 291 of file moviecache.cc.

References MovieCache::getdatafp, and IMB_moviecache_set_getdata_callback().

Referenced by imagecache_put(), IMB_moviecache_set_getdata_callback(), and put_imbuf_cache().

◆ IMB_moviecache_set_priority_callback()

void IMB_moviecache_set_priority_callback	(	MovieCache *	cache,
		MovieCacheGetPriorityDataFP	getprioritydatafp,
		MovieCacheGetItemPriorityFP	getitempriorityfp,
		MovieCachePriorityDeleterFP	prioritydeleterfp )