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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
|
/* SPDX-License-Identifier: GPL-2.0-or-later
* Copyright 2011 Blender Foundation. All rights reserved. */
/** \file
* \ingroup bke
*/
#undef DEBUG_MESSAGES
#include <memory.h>
#include <stdlib.h> /* for qsort */
#include "MEM_CacheLimiterC-Api.h"
#include "MEM_guardedalloc.h"
#include "BLI_ghash.h"
#include "BLI_mempool.h"
#include "BLI_string.h"
#include "BLI_threads.h"
#include "BLI_utildefines.h"
#include "IMB_moviecache.h"
#include "IMB_imbuf.h"
#include "IMB_imbuf_types.h"
#ifdef DEBUG_MESSAGES
# if defined __GNUC__
# define PRINT(format, args...) printf(format, ##args)
# else
# define PRINT(format, ...) printf(__VA_ARGS__)
# endif
#else
# define PRINT(format, ...)
#endif
static MEM_CacheLimiterC *limitor = NULL;
static pthread_mutex_t limitor_lock = BLI_MUTEX_INITIALIZER;
typedef struct MovieCache {
char name[64];
GHash *hash;
GHashHashFP hashfp;
GHashCmpFP cmpfp;
MovieCacheGetKeyDataFP getdatafp;
MovieCacheGetPriorityDataFP getprioritydatafp;
MovieCacheGetItemPriorityFP getitempriorityfp;
MovieCachePriorityDeleterFP prioritydeleterfp;
struct BLI_mempool *keys_pool;
struct BLI_mempool *items_pool;
struct BLI_mempool *userkeys_pool;
int keysize;
void *last_userkey;
int totseg, *points, proxy, render_flags; /* for visual statistics optimization */
int pad;
} MovieCache;
typedef struct MovieCacheKey {
MovieCache *cache_owner;
void *userkey;
} MovieCacheKey;
typedef struct MovieCacheItem {
MovieCache *cache_owner;
ImBuf *ibuf;
MEM_CacheLimiterHandleC *c_handle;
void *priority_data;
/* Indicates that #ibuf is null, because there was an error during load. */
bool added_empty;
} MovieCacheItem;
static unsigned int moviecache_hashhash(const void *keyv)
{
const MovieCacheKey *key = keyv;
return key->cache_owner->hashfp(key->userkey);
}
static bool moviecache_hashcmp(const void *av, const void *bv)
{
const MovieCacheKey *a = av;
const MovieCacheKey *b = bv;
return a->cache_owner->cmpfp(a->userkey, b->userkey);
}
static void moviecache_keyfree(void *val)
{
MovieCacheKey *key = val;
BLI_mempool_free(key->cache_owner->userkeys_pool, key->userkey);
BLI_mempool_free(key->cache_owner->keys_pool, key);
}
static void moviecache_valfree(void *val)
{
MovieCacheItem *item = (MovieCacheItem *)val;
MovieCache *cache = item->cache_owner;
PRINT("%s: cache '%s' free item %p buffer %p\n", __func__, cache->name, item, item->ibuf);
if (item->c_handle) {
BLI_mutex_lock(&limitor_lock);
MEM_CacheLimiter_unmanage(item->c_handle);
BLI_mutex_unlock(&limitor_lock);
}
if (item->ibuf) {
IMB_freeImBuf(item->ibuf);
}
if (item->priority_data && cache->prioritydeleterfp) {
cache->prioritydeleterfp(item->priority_data);
}
BLI_mempool_free(item->cache_owner->items_pool, item);
}
static void check_unused_keys(MovieCache *cache)
{
GHashIterator gh_iter;
BLI_ghashIterator_init(&gh_iter, cache->hash);
while (!BLI_ghashIterator_done(&gh_iter)) {
const MovieCacheKey *key = BLI_ghashIterator_getKey(&gh_iter);
const MovieCacheItem *item = BLI_ghashIterator_getValue(&gh_iter);
BLI_ghashIterator_step(&gh_iter);
if (item->added_empty) {
/* Don't remove entries that have been added empty. Those indicate that the image couldn't be
* loaded correctly. */
continue;
}
bool remove = !item->ibuf;
if (remove) {
PRINT("%s: cache '%s' remove item %p without buffer\n", __func__, cache->name, item);
}
if (remove) {
BLI_ghash_remove(cache->hash, key, moviecache_keyfree, moviecache_valfree);
}
}
}
static int compare_int(const void *av, const void *bv)
{
const int *a = av;
const int *b = bv;
return *a - *b;
}
static void moviecache_destructor(void *p)
{
MovieCacheItem *item = (MovieCacheItem *)p;
if (item && item->ibuf) {
MovieCache *cache = item->cache_owner;
PRINT("%s: cache '%s' destroy item %p buffer %p\n", __func__, cache->name, item, item->ibuf);
IMB_freeImBuf(item->ibuf);
item->ibuf = NULL;
item->c_handle = NULL;
/* force cached segments to be updated */
MEM_SAFE_FREE(cache->points);
}
}
static size_t get_size_in_memory(ImBuf *ibuf)
{
/* Keep textures in the memory to avoid constant file reload on viewport update. */
if (ibuf->userflags & IB_PERSISTENT) {
return 0;
}
return IMB_get_size_in_memory(ibuf);
}
static size_t get_item_size(void *p)
{
size_t size = sizeof(MovieCacheItem);
MovieCacheItem *item = (MovieCacheItem *)p;
if (item->ibuf) {
size += get_size_in_memory(item->ibuf);
}
return size;
}
static int get_item_priority(void *item_v, int default_priority)
{
MovieCacheItem *item = (MovieCacheItem *)item_v;
MovieCache *cache = item->cache_owner;
int priority;
if (!cache->getitempriorityfp) {
PRINT("%s: cache '%s' item %p use default priority %d\n",
__func__,
cache->name,
item,
default_priority);
return default_priority;
}
priority = cache->getitempriorityfp(cache->last_userkey, item->priority_data);
PRINT("%s: cache '%s' item %p priority %d\n", __func__, cache->name, item, priority);
return priority;
}
static bool get_item_destroyable(void *item_v)
{
MovieCacheItem *item = (MovieCacheItem *)item_v;
if (item->ibuf == NULL) {
return true;
}
/* IB_BITMAPDIRTY means image was modified from inside blender and
* changes are not saved to disk.
*
* Such buffers are never to be freed.
*/
if ((item->ibuf->userflags & IB_BITMAPDIRTY) || (item->ibuf->userflags & IB_PERSISTENT)) {
return false;
}
return true;
}
void IMB_moviecache_init(void)
{
limitor = new_MEM_CacheLimiter(moviecache_destructor, get_item_size);
MEM_CacheLimiter_ItemPriority_Func_set(limitor, get_item_priority);
MEM_CacheLimiter_ItemDestroyable_Func_set(limitor, get_item_destroyable);
}
void IMB_moviecache_destruct(void)
{
if (limitor) {
delete_MEM_CacheLimiter(limitor);
limitor = NULL;
}
}
MovieCache *IMB_moviecache_create(const char *name,
int keysize,
GHashHashFP hashfp,
GHashCmpFP cmpfp)
{
MovieCache *cache;
PRINT("%s: cache '%s' create\n", __func__, name);
cache = MEM_callocN(sizeof(MovieCache), "MovieCache");
BLI_strncpy(cache->name, name, sizeof(cache->name));
cache->keys_pool = BLI_mempool_create(sizeof(MovieCacheKey), 0, 64, BLI_MEMPOOL_NOP);
cache->items_pool = BLI_mempool_create(sizeof(MovieCacheItem), 0, 64, BLI_MEMPOOL_NOP);
cache->userkeys_pool = BLI_mempool_create(keysize, 0, 64, BLI_MEMPOOL_NOP);
cache->hash = BLI_ghash_new(
moviecache_hashhash, moviecache_hashcmp, "MovieClip ImBuf cache hash");
cache->keysize = keysize;
cache->hashfp = hashfp;
cache->cmpfp = cmpfp;
cache->proxy = -1;
return cache;
}
void IMB_moviecache_set_getdata_callback(MovieCache *cache, MovieCacheGetKeyDataFP getdatafp)
{
cache->getdatafp = getdatafp;
}
void IMB_moviecache_set_priority_callback(struct MovieCache *cache,
MovieCacheGetPriorityDataFP getprioritydatafp,
MovieCacheGetItemPriorityFP getitempriorityfp,
MovieCachePriorityDeleterFP prioritydeleterfp)
{
cache->last_userkey = MEM_mallocN(cache->keysize, "movie cache last user key");
cache->getprioritydatafp = getprioritydatafp;
cache->getitempriorityfp = getitempriorityfp;
cache->prioritydeleterfp = prioritydeleterfp;
}
static void do_moviecache_put(MovieCache *cache, void *userkey, ImBuf *ibuf, bool need_lock)
{
MovieCacheKey *key;
MovieCacheItem *item;
if (!limitor) {
IMB_moviecache_init();
}
if (ibuf != NULL) {
IMB_refImBuf(ibuf);
}
key = BLI_mempool_alloc(cache->keys_pool);
key->cache_owner = cache;
key->userkey = BLI_mempool_alloc(cache->userkeys_pool);
memcpy(key->userkey, userkey, cache->keysize);
item = BLI_mempool_alloc(cache->items_pool);
PRINT("%s: cache '%s' put %p, item %p\n", __func__, cache->name, ibuf, item);
item->ibuf = ibuf;
item->cache_owner = cache;
item->c_handle = NULL;
item->priority_data = NULL;
item->added_empty = ibuf == NULL;
if (cache->getprioritydatafp) {
item->priority_data = cache->getprioritydatafp(userkey);
}
BLI_ghash_reinsert(cache->hash, key, item, moviecache_keyfree, moviecache_valfree);
if (cache->last_userkey) {
memcpy(cache->last_userkey, userkey, cache->keysize);
}
if (need_lock) {
BLI_mutex_lock(&limitor_lock);
}
item->c_handle = MEM_CacheLimiter_insert(limitor, item);
MEM_CacheLimiter_ref(item->c_handle);
MEM_CacheLimiter_enforce_limits(limitor);
MEM_CacheLimiter_unref(item->c_handle);
if (need_lock) {
BLI_mutex_unlock(&limitor_lock);
}
/* cache limiter can't remove unused keys which points to destroyed values */
check_unused_keys(cache);
MEM_SAFE_FREE(cache->points);
}
void IMB_moviecache_put(MovieCache *cache, void *userkey, ImBuf *ibuf)
{
do_moviecache_put(cache, userkey, ibuf, true);
}
bool IMB_moviecache_put_if_possible(MovieCache *cache, void *userkey, ImBuf *ibuf)
{
size_t mem_in_use, mem_limit, elem_size;
bool result = false;
elem_size = (ibuf == NULL) ? 0 : get_size_in_memory(ibuf);
mem_limit = MEM_CacheLimiter_get_maximum();
BLI_mutex_lock(&limitor_lock);
mem_in_use = MEM_CacheLimiter_get_memory_in_use(limitor);
if (mem_in_use + elem_size <= mem_limit) {
do_moviecache_put(cache, userkey, ibuf, false);
result = true;
}
BLI_mutex_unlock(&limitor_lock);
return result;
}
void IMB_moviecache_remove(MovieCache *cache, void *userkey)
{
MovieCacheKey key;
key.cache_owner = cache;
key.userkey = userkey;
BLI_ghash_remove(cache->hash, &key, moviecache_keyfree, moviecache_valfree);
}
ImBuf *IMB_moviecache_get(MovieCache *cache, void *userkey, bool *r_is_cached_empty)
{
MovieCacheKey key;
MovieCacheItem *item;
key.cache_owner = cache;
key.userkey = userkey;
item = (MovieCacheItem *)BLI_ghash_lookup(cache->hash, &key);
if (r_is_cached_empty) {
*r_is_cached_empty = false;
}
if (item) {
if (item->ibuf) {
BLI_mutex_lock(&limitor_lock);
MEM_CacheLimiter_touch(item->c_handle);
BLI_mutex_unlock(&limitor_lock);
IMB_refImBuf(item->ibuf);
return item->ibuf;
}
if (r_is_cached_empty) {
*r_is_cached_empty = true;
}
}
return NULL;
}
bool IMB_moviecache_has_frame(MovieCache *cache, void *userkey)
{
MovieCacheKey key;
MovieCacheItem *item;
key.cache_owner = cache;
key.userkey = userkey;
item = (MovieCacheItem *)BLI_ghash_lookup(cache->hash, &key);
return item != NULL;
}
void IMB_moviecache_free(MovieCache *cache)
{
PRINT("%s: cache '%s' free\n", __func__, cache->name);
BLI_ghash_free(cache->hash, moviecache_keyfree, moviecache_valfree);
BLI_mempool_destroy(cache->keys_pool);
BLI_mempool_destroy(cache->items_pool);
BLI_mempool_destroy(cache->userkeys_pool);
if (cache->points) {
MEM_freeN(cache->points);
}
if (cache->last_userkey) {
MEM_freeN(cache->last_userkey);
}
MEM_freeN(cache);
}
void IMB_moviecache_cleanup(MovieCache *cache,
bool(cleanup_check_cb)(ImBuf *ibuf, void *userkey, void *userdata),
void *userdata)
{
GHashIterator gh_iter;
check_unused_keys(cache);
BLI_ghashIterator_init(&gh_iter, cache->hash);
while (!BLI_ghashIterator_done(&gh_iter)) {
MovieCacheKey *key = BLI_ghashIterator_getKey(&gh_iter);
MovieCacheItem *item = BLI_ghashIterator_getValue(&gh_iter);
BLI_ghashIterator_step(&gh_iter);
if (cleanup_check_cb(item->ibuf, key->userkey, userdata)) {
PRINT("%s: cache '%s' remove item %p\n", __func__, cache->name, item);
BLI_ghash_remove(cache->hash, key, moviecache_keyfree, moviecache_valfree);
}
}
}
void IMB_moviecache_get_cache_segments(
MovieCache *cache, int proxy, int render_flags, int *r_totseg, int **r_points)
{
*r_totseg = 0;
*r_points = NULL;
if (!cache->getdatafp) {
return;
}
if (cache->proxy != proxy || cache->render_flags != render_flags) {
MEM_SAFE_FREE(cache->points);
}
if (cache->points) {
*r_totseg = cache->totseg;
*r_points = cache->points;
}
else {
int totframe = BLI_ghash_len(cache->hash);
int *frames = MEM_callocN(totframe * sizeof(int), "movieclip cache frames");
int a, totseg = 0;
GHashIterator gh_iter;
a = 0;
GHASH_ITER (gh_iter, cache->hash) {
MovieCacheKey *key = BLI_ghashIterator_getKey(&gh_iter);
MovieCacheItem *item = BLI_ghashIterator_getValue(&gh_iter);
int framenr, curproxy, curflags;
if (item->ibuf) {
cache->getdatafp(key->userkey, &framenr, &curproxy, &curflags);
if (curproxy == proxy && curflags == render_flags) {
frames[a++] = framenr;
}
}
}
qsort(frames, totframe, sizeof(int), compare_int);
/* count */
for (a = 0; a < totframe; a++) {
if (a && frames[a] - frames[a - 1] != 1) {
totseg++;
}
if (a == totframe - 1) {
totseg++;
}
}
if (totseg) {
int b, *points;
points = MEM_callocN(sizeof(int[2]) * totseg, "movieclip cache segments");
/* fill */
for (a = 0, b = 0; a < totframe; a++) {
if (a == 0) {
points[b++] = frames[a];
}
if (a && frames[a] - frames[a - 1] != 1) {
points[b++] = frames[a - 1];
points[b++] = frames[a];
}
if (a == totframe - 1) {
points[b++] = frames[a];
}
}
*r_totseg = totseg;
*r_points = points;
cache->totseg = totseg;
cache->points = points;
cache->proxy = proxy;
cache->render_flags = render_flags;
}
MEM_freeN(frames);
}
}
struct MovieCacheIter *IMB_moviecacheIter_new(MovieCache *cache)
{
GHashIterator *iter;
check_unused_keys(cache);
iter = BLI_ghashIterator_new(cache->hash);
return (struct MovieCacheIter *)iter;
}
void IMB_moviecacheIter_free(struct MovieCacheIter *iter)
{
BLI_ghashIterator_free((GHashIterator *)iter);
}
bool IMB_moviecacheIter_done(struct MovieCacheIter *iter)
{
return BLI_ghashIterator_done((GHashIterator *)iter);
}
void IMB_moviecacheIter_step(struct MovieCacheIter *iter)
{
BLI_ghashIterator_step((GHashIterator *)iter);
}
ImBuf *IMB_moviecacheIter_getImBuf(struct MovieCacheIter *iter)
{
MovieCacheItem *item = BLI_ghashIterator_getValue((GHashIterator *)iter);
return item->ibuf;
}
void *IMB_moviecacheIter_getUserKey(struct MovieCacheIter *iter)
{
MovieCacheKey *key = BLI_ghashIterator_getKey((GHashIterator *)iter);
return key->userkey;
}
|