Blender V4.3
Classes | Macros | Functions | Variables
moviecache.cc File Reference
Blender » BlenKernel
#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 "BLI_utildefines.h"
#include "IMB_moviecache.hh"
#include "IMB_imbuf.hh"
#include "IMB_imbuf_types.hh"

Go to the source code of this file.

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 35 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(), and moviecache_valfree().

Function Documentation

◆ check_unused_keys()

static void check_unused_keys ( MovieCache * cache)
static

Definition at line 132 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(), MovieCache::hash, MovieCacheItem::ibuf, moviecache_keyfree(), moviecache_valfree(), MovieCache::name, and PRINT.

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

◆ compare_int()

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

Definition at line 162 of file moviecache.cc.

References b.

Referenced by IMB_moviecache_get_cache_segments().

◆ do_moviecache_put()

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

Definition at line 309 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(), 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 IMB_moviecache_put(), and IMB_moviecache_put_if_possible().

◆ get_item_destroyable()

static bool get_item_destroyable ( void * item_v)
static

Definition at line 232 of file moviecache.cc.

References IB_BITMAPDIRTY, IB_PERSISTENT, MovieCacheItem::ibuf, and ImBuf::userflags.

Referenced by IMB_moviecache_init().

◆ get_item_priority()

static int get_item_priority ( void * item_v,
int default_priority )
static

Definition at line 209 of file moviecache.cc.

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

Referenced by IMB_moviecache_init().

◆ get_item_size()

static size_t get_item_size ( void * p)
static

Definition at line 197 of file moviecache.cc.

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

Referenced by IMB_moviecache_init().

◆ get_size_in_memory()

static size_t get_size_in_memory ( ImBuf * ibuf)
static

Definition at line 188 of file moviecache.cc.

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

Referenced by get_item_size(), 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 )

Definition at line 465 of file moviecache.cc.

References 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, PRINT, and MovieCacheKey::userkey.

Referenced by BKE_image_free_all_textures(), BKE_image_free_anim_ibufs(), and BKE_movieclip_clear_proxy_cache().

◆ IMB_moviecache_create()

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

Definition at line 265 of file moviecache.cc.

References BLI_ghash_new(), BLI_mempool_create(), BLI_MEMPOOL_NOP, MovieCache::cmpfp, MovieCache::hash, MovieCache::hashfp, 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(), and put_imbuf_cache().

◆ IMB_moviecache_destruct()

void IMB_moviecache_destruct ( )

Definition at line 257 of file moviecache.cc.

References delete_MEM_CacheLimiter(), and limitor.

Referenced by BKE_blender_free(), 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 444 of file moviecache.cc.

References BLI_ghash_free(), BLI_mempool_destroy(), MovieCache::hash, 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(), and image_free_cached_frames().

◆ IMB_moviecache_get()

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

Definition at line 401 of file moviecache.cc.

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

Referenced by colormanage_cache_get_ibuf(), get_imbuf_cache(), and imagecache_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 489 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, MEM_callocN, MEM_freeN(), MEM_SAFE_FREE, MovieCache::points, MovieCache::proxy, MovieCache::render_flags, MovieCache::totseg, and MovieCacheKey::userkey.

Referenced by BKE_movieclip_get_cache_segments(), and draw_image_cache().

◆ IMB_moviecache_has_frame()

bool IMB_moviecache_has_frame ( MovieCache * cache,
void * userkey )

Definition at line 432 of file moviecache.cc.

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

Referenced by has_imbuf_cache().

◆ IMB_moviecache_init()

void IMB_moviecache_init ( )

Definition at line 249 of file moviecache.cc.

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

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

◆ IMB_moviecache_put()

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

Definition at line 367 of file moviecache.cc.

References do_moviecache_put().

Referenced by colormanage_cache_put(), imagecache_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 372 of file moviecache.cc.

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

Referenced by put_imbuf_cache().

◆ IMB_moviecache_remove()

void IMB_moviecache_remove ( MovieCache * cache,
void * userkey )

Definition at line 393 of file moviecache.cc.

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

Referenced by imagecache_remove().

◆ IMB_moviecache_set_getdata_callback()

void IMB_moviecache_set_getdata_callback ( MovieCache * cache,
MovieCacheGetKeyDataFP getdatafp )

Definition at line 292 of file moviecache.cc.

References MovieCache::getdatafp.

Referenced by imagecache_put(), and put_imbuf_cache().

◆ IMB_moviecache_set_priority_callback()

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

Definition at line 297 of file moviecache.cc.

References MovieCache::getitempriorityfp, MovieCache::getprioritydatafp, MovieCache::keysize, MovieCache::last_userkey, MEM_mallocN, and MovieCache::prioritydeleterfp.

Referenced by put_imbuf_cache().

◆ IMB_moviecacheIter_done()

bool IMB_moviecacheIter_done ( MovieCacheIter * iter)

Definition at line 590 of file moviecache.cc.

References BLI_ghashIterator_done().

Referenced by BKE_image_file_format_set(), BKE_image_get_first_ibuf(), BKE_image_get_ibuf_with_name(), BKE_image_has_loaded_ibuf(), BKE_image_is_dirty_writable(), BKE_image_merge(), image_mem_size(), and image_save_sequence_exec().

◆ IMB_moviecacheIter_free()

void IMB_moviecacheIter_free ( MovieCacheIter * iter)

Definition at line 585 of file moviecache.cc.

References BLI_ghashIterator_free().

Referenced by BKE_image_file_format_set(), BKE_image_get_first_ibuf(), BKE_image_get_ibuf_with_name(), BKE_image_has_loaded_ibuf(), BKE_image_is_dirty_writable(), BKE_image_merge(), image_mem_size(), and image_save_sequence_exec().

◆ IMB_moviecacheIter_getImBuf()

ImBuf * IMB_moviecacheIter_getImBuf ( MovieCacheIter * iter)

Definition at line 600 of file moviecache.cc.

References BLI_ghashIterator_getValue(), and MovieCacheItem::ibuf.

Referenced by BKE_image_file_format_set(), BKE_image_get_first_ibuf(), BKE_image_get_ibuf_with_name(), BKE_image_has_loaded_ibuf(), BKE_image_is_dirty_writable(), BKE_image_merge(), image_mem_size(), and image_save_sequence_exec().

◆ IMB_moviecacheIter_getUserKey()

void * IMB_moviecacheIter_getUserKey ( MovieCacheIter * iter)

Definition at line 606 of file moviecache.cc.

References BLI_ghashIterator_getKey(), and MovieCacheKey::userkey.

Referenced by BKE_image_merge().

◆ IMB_moviecacheIter_new()

MovieCacheIter * IMB_moviecacheIter_new ( MovieCache * cache)

Definition at line 575 of file moviecache.cc.

References BLI_ghashIterator_new(), check_unused_keys(), and MovieCache::hash.

Referenced by BKE_image_file_format_set(), BKE_image_get_first_ibuf(), BKE_image_get_ibuf_with_name(), BKE_image_has_loaded_ibuf(), BKE_image_is_dirty_writable(), BKE_image_merge(), image_mem_size(), and image_save_sequence_exec().

◆ IMB_moviecacheIter_step()

void IMB_moviecacheIter_step ( MovieCacheIter * iter)

Definition at line 595 of file moviecache.cc.

References BLI_ghashIterator_step().

Referenced by BKE_image_file_format_set(), BKE_image_get_ibuf_with_name(), BKE_image_has_loaded_ibuf(), BKE_image_is_dirty_writable(), BKE_image_merge(), image_mem_size(), and image_save_sequence_exec().

◆ moviecache_destructor()

static void moviecache_destructor ( void * p)
static

Definition at line 169 of file moviecache.cc.

References MovieCacheItem::c_handle, MovieCacheItem::cache_owner, MovieCacheItem::ibuf, IMB_freeImBuf(), MEM_SAFE_FREE, MovieCache::name, MovieCache::points, and PRINT.

Referenced by IMB_moviecache_init().

◆ moviecache_hashcmp()

static bool moviecache_hashcmp ( const void * av,
const void * bv )
static

Definition at line 91 of file moviecache.cc.

References b.

Referenced by IMB_moviecache_create().

◆ moviecache_hashhash()

static uint moviecache_hashhash ( const void * keyv)
static

Definition at line 84 of file moviecache.cc.

References MovieCacheKey::cache_owner, MovieCache::hashfp, and MovieCacheKey::userkey.

Referenced by IMB_moviecache_create().

◆ moviecache_keyfree()

static void moviecache_keyfree ( void * val)
static

Definition at line 99 of file moviecache.cc.

References BLI_mempool_free(), MovieCacheKey::cache_owner, MovieCache::keys_pool, MovieCacheKey::userkey, and MovieCache::userkeys_pool.

Referenced by check_unused_keys(), do_moviecache_put(), IMB_moviecache_cleanup(), IMB_moviecache_free(), and IMB_moviecache_remove().

◆ moviecache_valfree()

static void moviecache_valfree ( void * val)
static

Definition at line 108 of file moviecache.cc.

References BLI_mempool_free(), MovieCacheItem::c_handle, MovieCacheItem::cache_owner, MovieCacheItem::ibuf, IMB_freeImBuf(), MovieCache::items_pool, limitor_lock, MEM_CacheLimiter_unmanage(), MovieCache::name, PRINT, MovieCacheItem::priority_data, and MovieCache::prioritydeleterfp.

Referenced by check_unused_keys(), do_moviecache_put(), IMB_moviecache_cleanup(), IMB_moviecache_free(), and IMB_moviecache_remove().

Variable Documentation

◆ limitor

MEM_CacheLimiterC* limitor = nullptr
static

Definition at line 38 of file moviecache.cc.

Referenced by do_moviecache_put(), IMB_moviecache_destruct(), IMB_moviecache_init(), and IMB_moviecache_put_if_possible().

◆ limitor_lock

std::recursive_mutex limitor_lock
static

Definition at line 44 of file moviecache.cc.

Referenced by do_moviecache_put(), IMB_moviecache_get(), IMB_moviecache_put_if_possible(), and moviecache_valfree().

Generated on Thu Feb 6 2025 07:36:39 for Blender by  doxygen 1.11.0