forked from bartvdbraak/blender
808ac6debf
This commit basically implements frames prefetching for movie clip datablock. Number of frames to be prefetched is controlled in User Preferences, System tab, Prefetch Frames option. Currently prefetching is destructive-less for movie cache, meaning mo frames will be removed from the cache when while prefetching. This is because it's half of simplier to implement, but it also makes sense from tracking point of view -- we could want to playback in both directions and removing frames from behind time cursor is not always a good idea. Anyway, smarter prefetching strategy could be developed later. Some implementation notes: - Added MEM_CacheLimiter_get_memory_in_use function to get memory usage of specified memory limiter. - Fixed prototype of MEM_CacheLimiter_get_maximum which was simply wrong (used wrong data type for output). - Added some utility functions to movie clip and movie cache for direct cache interaction and obtaining cache statistics. - Prefetching is implemented using general jobs system. which is invoking from clip draw function. - Prefetcing will stop as soon other job or playback starts. This is done from performance point of view. Jobs will likely require lots of CPU power and better to provide whole CPU to it. Playback is a bit more complicated case. For jpeg sequence playback prefetching while paying back is nice. But trying to prefetch heavy exr images and doing color space conversion slows down both playback and prefetching. TODO: - Think of better policy of dealing with already cached frames (like when cached frames from other clips prevents frames from current clip to be prefetched) - Currently a bit funky redraw notification happens from prefetch job. Perhaps own ND_ is better to have here. - Hiding clip while prefetch is active in theory shall stop prefetching job. - Having multiple clips opened on file load will prefetch frames for only one of them.
156 lines
4.0 KiB
C
156 lines
4.0 KiB
C
/*
|
|
* ***** BEGIN GPL LICENSE BLOCK *****
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
* Contributor(s): Peter Schlaile <peter@schlaile.de> 2005
|
|
*
|
|
* ***** END GPL LICENSE BLOCK *****
|
|
*/
|
|
|
|
/** \file memutil/MEM_CacheLimiterC-Api.h
|
|
* \ingroup memutil
|
|
*/
|
|
|
|
|
|
#ifndef __MEM_CACHELIMITERC_API_H__
|
|
#define __MEM_CACHELIMITERC_API_H__
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
struct MEM_CacheLimiter_s;
|
|
struct MEM_CacheLimiterHandle_s;
|
|
|
|
typedef struct MEM_CacheLimiter_s MEM_CacheLimiterC;
|
|
typedef struct MEM_CacheLimiterHandle_s MEM_CacheLimiterHandleC;
|
|
|
|
/* function used to remove data from memory */
|
|
typedef void (*MEM_CacheLimiter_Destruct_Func)(void*);
|
|
|
|
/* function used to measure stored data element size */
|
|
typedef size_t (*MEM_CacheLimiter_DataSize_Func) (void*);
|
|
|
|
/* function used to measure priority of item when freeing memory */
|
|
typedef int (*MEM_CacheLimiter_ItemPriority_Func) (void*, int);
|
|
|
|
#ifndef __MEM_CACHELIMITER_H__
|
|
void MEM_CacheLimiter_set_maximum(size_t m);
|
|
size_t MEM_CacheLimiter_get_maximum(void);
|
|
#endif /* __MEM_CACHELIMITER_H__ */
|
|
|
|
/**
|
|
* Create new MEM_CacheLimiter object
|
|
* managed objects are destructed with the data_destructor
|
|
*
|
|
* @param data_destructor
|
|
* @return A new MEM_CacheLimter object
|
|
*/
|
|
|
|
MEM_CacheLimiterC *new_MEM_CacheLimiter(MEM_CacheLimiter_Destruct_Func data_destructor,
|
|
MEM_CacheLimiter_DataSize_Func data_size);
|
|
|
|
/**
|
|
* Delete MEM_CacheLimiter
|
|
*
|
|
* Frees the memory of the CacheLimiter but does not touch managed objects!
|
|
*
|
|
* @param This "This" pointer
|
|
*/
|
|
|
|
void delete_MEM_CacheLimiter(MEM_CacheLimiterC *This);
|
|
|
|
/**
|
|
* Manage object
|
|
*
|
|
* @param This "This" pointer, data data object to manage
|
|
* @return CacheLimiterHandle to ref, unref, touch the managed object
|
|
*/
|
|
|
|
MEM_CacheLimiterHandleC *MEM_CacheLimiter_insert(MEM_CacheLimiterC *This, void *data);
|
|
|
|
/**
|
|
* Free objects until memory constraints are satisfied
|
|
*
|
|
* @param This "This" pointer
|
|
*/
|
|
|
|
void MEM_CacheLimiter_enforce_limits(MEM_CacheLimiterC *This);
|
|
|
|
/**
|
|
* Unmanage object previously inserted object.
|
|
* Does _not_ delete managed object!
|
|
*
|
|
* @param This "This" pointer, handle of object
|
|
*/
|
|
|
|
void MEM_CacheLimiter_unmanage(MEM_CacheLimiterHandleC *handle);
|
|
|
|
|
|
/**
|
|
* Raise priority of object (put it at the tail of the deletion chain)
|
|
*
|
|
* @param handle of object
|
|
*/
|
|
|
|
void MEM_CacheLimiter_touch(MEM_CacheLimiterHandleC *handle);
|
|
|
|
/**
|
|
* Increment reference counter. Objects with reference counter != 0 are _not_
|
|
* deleted.
|
|
*
|
|
* @param handle of object
|
|
*/
|
|
|
|
void MEM_CacheLimiter_ref(MEM_CacheLimiterHandleC *handle);
|
|
|
|
/**
|
|
* Decrement reference counter. Objects with reference counter != 0 are _not_
|
|
* deleted.
|
|
*
|
|
* @param handle of object
|
|
*/
|
|
|
|
void MEM_CacheLimiter_unref(MEM_CacheLimiterHandleC *handle);
|
|
|
|
/**
|
|
* Get reference counter.
|
|
*
|
|
* @param This "This" pointer, handle of object
|
|
*/
|
|
|
|
int MEM_CacheLimiter_get_refcount(MEM_CacheLimiterHandleC *handle);
|
|
|
|
/**
|
|
* Get pointer to managed object
|
|
*
|
|
* @param handle of object
|
|
*/
|
|
|
|
void *MEM_CacheLimiter_get(MEM_CacheLimiterHandleC *handle);
|
|
|
|
void MEM_CacheLimiter_ItemPriority_Func_set(MEM_CacheLimiterC *This,
|
|
MEM_CacheLimiter_ItemPriority_Func item_priority_func);
|
|
|
|
size_t MEM_CacheLimiter_get_memory_in_use(MEM_CacheLimiterC *This);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
|
|
#endif // __MEM_CACHELIMITERC_API_H__
|