[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [55448] trunk/blender: Prefetching for movie clips

Sergey Sharybin sergey.vfx at gmail.com
Wed Mar 20 18:03:21 CET 2013


Revision: 55448
          http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=55448
Author:   nazgul
Date:     2013-03-20 17:03:20 +0000 (Wed, 20 Mar 2013)
Log Message:
-----------
Prefetching for movie clips

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.

Modified Paths:
--------------
    trunk/blender/intern/memutil/MEM_CacheLimiter.h
    trunk/blender/intern/memutil/MEM_CacheLimiterC-Api.h
    trunk/blender/intern/memutil/intern/MEM_CacheLimiterC-Api.cpp
    trunk/blender/source/blender/blenkernel/BKE_movieclip.h
    trunk/blender/source/blender/blenkernel/intern/movieclip.c
    trunk/blender/source/blender/blenloader/intern/readfile.c
    trunk/blender/source/blender/editors/space_clip/clip_draw.c
    trunk/blender/source/blender/editors/space_clip/clip_editor.c
    trunk/blender/source/blender/editors/space_clip/clip_intern.h
    trunk/blender/source/blender/editors/space_clip/clip_ops.c
    trunk/blender/source/blender/editors/space_clip/space_clip.c
    trunk/blender/source/blender/imbuf/IMB_moviecache.h
    trunk/blender/source/blender/imbuf/intern/moviecache.c
    trunk/blender/source/blender/makesdna/DNA_movieclip_types.h
    trunk/blender/source/blender/makesrna/intern/rna_userdef.c
    trunk/blender/source/blender/windowmanager/WM_api.h
    trunk/blender/source/blender/windowmanager/intern/wm_jobs.c

Modified: trunk/blender/intern/memutil/MEM_CacheLimiter.h
===================================================================
--- trunk/blender/intern/memutil/MEM_CacheLimiter.h	2013-03-20 16:51:50 UTC (rev 55447)
+++ trunk/blender/intern/memutil/MEM_CacheLimiter.h	2013-03-20 17:03:20 UTC (rev 55448)
@@ -161,6 +161,13 @@
 		delete handle;
 	}
 
+	size_t get_memory_in_use() {
+		if (getDataSize)
+			return total_size();
+		else
+			return MEM_get_memory_in_use();
+	}
+
 	void enforce_limits() {
 		size_t max = MEM_CacheLimiter_get_maximum();
 		size_t mem_in_use, cur_size;
@@ -169,12 +176,7 @@
 			return;
 		}
 
-		if (getDataSize) {
-			mem_in_use = total_size();
-		}
-		else {
-			mem_in_use = MEM_get_memory_in_use();
-		}
+		mem_in_use = get_memory_in_use();
 
 		if (mem_in_use <= max) {
 			return;

Modified: trunk/blender/intern/memutil/MEM_CacheLimiterC-Api.h
===================================================================
--- trunk/blender/intern/memutil/MEM_CacheLimiterC-Api.h	2013-03-20 16:51:50 UTC (rev 55447)
+++ trunk/blender/intern/memutil/MEM_CacheLimiterC-Api.h	2013-03-20 17:03:20 UTC (rev 55448)
@@ -49,7 +49,7 @@
 
 #ifndef __MEM_CACHELIMITER_H__
 void MEM_CacheLimiter_set_maximum(size_t m);
-int MEM_CacheLimiter_get_maximum(void);
+size_t MEM_CacheLimiter_get_maximum(void);
 #endif /* __MEM_CACHELIMITER_H__ */
 
 /**
@@ -145,6 +145,8 @@
 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

Modified: trunk/blender/intern/memutil/intern/MEM_CacheLimiterC-Api.cpp
===================================================================
--- trunk/blender/intern/memutil/intern/MEM_CacheLimiterC-Api.cpp	2013-03-20 16:51:50 UTC (rev 55447)
+++ trunk/blender/intern/memutil/intern/MEM_CacheLimiterC-Api.cpp	2013-03-20 17:03:20 UTC (rev 55448)
@@ -202,3 +202,8 @@
 {
 	cast(This)->get_cache()->set_item_priority_func(item_priority_func);
 }
+
+size_t MEM_CacheLimiter_get_memory_in_use(MEM_CacheLimiterC *This)
+{
+	return cast(This)->get_cache()->get_memory_in_use();
+}

Modified: trunk/blender/source/blender/blenkernel/BKE_movieclip.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_movieclip.h	2013-03-20 16:51:50 UTC (rev 55447)
+++ trunk/blender/source/blender/blenkernel/BKE_movieclip.h	2013-03-20 17:03:20 UTC (rev 55448)
@@ -70,8 +70,12 @@
 float BKE_movieclip_remap_scene_to_clip_frame(struct MovieClip *clip, float framenr);
 float BKE_movieclip_remap_clip_to_scene_frame(struct MovieClip *clip, float framenr);
 
-void BKE_movieclip_filename_for_frame(struct MovieClip *clip, int framenr, char *name);
+void BKE_movieclip_filename_for_frame(struct MovieClip *clip, struct MovieClipUser *user, char *name);
+struct ImBuf *BKE_movieclip_anim_ibuf_for_frame(struct MovieClip *clip, struct MovieClipUser *user);
 
+int BKE_movieclip_has_cached_frame(struct MovieClip *clip, struct MovieClipUser *user);
+int BKE_movieclip_put_frame_if_possible(struct MovieClip *clip, struct MovieClipUser *user, struct ImBuf *ibuf);
+
 /* cacheing flags */
 #define MOVIECLIP_CACHE_SKIP        (1 << 0)
 

Modified: trunk/blender/source/blender/blenkernel/intern/movieclip.c
===================================================================
--- trunk/blender/source/blender/blenkernel/intern/movieclip.c	2013-03-20 16:51:50 UTC (rev 55447)
+++ trunk/blender/source/blender/blenkernel/intern/movieclip.c	2013-03-20 17:03:20 UTC (rev 55448)
@@ -457,8 +457,30 @@
 	return NULL;
 }
 
-static void put_imbuf_cache(MovieClip *clip, MovieClipUser *user, ImBuf *ibuf, int flag)
+static int has_imbuf_cache(MovieClip *clip, MovieClipUser *user, int flag)
 {
+	if (clip->cache) {
+		MovieClipImBufCacheKey key;
+
+		key.framenr = user->framenr;
+
+		if (flag & MCLIP_USE_PROXY) {
+			key.proxy = rendersize_to_proxy(user, flag);
+			key.render_flag = user->render_flag;
+		}
+		else {
+			key.proxy = IMB_PROXY_NONE;
+			key.render_flag = 0;
+		}
+
+		return IMB_moviecache_has_frame(clip->cache->moviecache, &key);
+	}
+
+	return FALSE;
+}
+
+static bool put_imbuf_cache(MovieClip *clip, MovieClipUser *user, ImBuf *ibuf, int flag, bool destructive)
+{
 	MovieClipImBufCacheKey key;
 
 	if (!clip->cache) {
@@ -489,7 +511,13 @@
 		key.render_flag = 0;
 	}
 
-	IMB_moviecache_put(clip->cache->moviecache, &key, ibuf);
+	if (destructive) {
+		IMB_moviecache_put(clip->cache->moviecache, &key, ibuf);
+		return true;
+	}
+	else {
+		return IMB_moviecache_put_if_possible(clip->cache->moviecache, &key, ibuf);
+	}
 }
 
 /*********************** common functions *************************/
@@ -814,7 +842,7 @@
 		}
 
 		if (ibuf && (cache_flag & MOVIECLIP_CACHE_SKIP) == 0)
-			put_imbuf_cache(clip, user, ibuf, flag);
+			put_imbuf_cache(clip, user, ibuf, flag, true);
 	}
 
 	if (ibuf) {
@@ -1111,6 +1139,7 @@
 	free_buffers(clip);
 
 	clip->tracking.stabilization.ok = FALSE;
+	clip->prefetch_ok = FALSE;
 
 	/* update clip source */
 	detect_clip_source(clip);
@@ -1420,13 +1449,58 @@
 	return framenr + (float) clip->start_frame - 1.0f;
 }
 
-void BKE_movieclip_filename_for_frame(MovieClip *clip, int framenr, char *name)
+void BKE_movieclip_filename_for_frame(MovieClip *clip, MovieClipUser *user, char *name)
 {
-	if (clip->source != MCLIP_SRC_MOVIE) {
-		get_sequence_fname(clip, framenr, name);
+	if (clip->source == MCLIP_SRC_SEQUENCE) {
+		int use_proxy;
+
+		use_proxy = (clip->flag & MCLIP_USE_PROXY) && user->render_size != MCLIP_PROXY_RENDER_SIZE_FULL;
+
+		if (use_proxy) {
+			int undistort = user->render_flag & MCLIP_PROXY_RENDER_UNDISTORT;
+			get_proxy_fname(clip, user->render_size, undistort, user->framenr, name);
+		}
+		else {
+			get_sequence_fname(clip, user->framenr, name);
+		}
 	}
 	else {
 		BLI_strncpy(name, clip->name, FILE_MAX);
 		BLI_path_abs(name, ID_BLEND_PATH(G.main, &clip->id));
 	}
 }
+
+ImBuf *BKE_movieclip_anim_ibuf_for_frame(MovieClip *clip, MovieClipUser *user)
+{
+	ImBuf *ibuf = NULL;
+
+	if (clip->source == MCLIP_SRC_MOVIE) {
+		BLI_lock_thread(LOCK_MOVIECLIP);
+		ibuf = movieclip_load_movie_file(clip, user, user->framenr, clip->flag);
+		BLI_unlock_thread(LOCK_MOVIECLIP);
+	}
+
+	return ibuf;
+}
+
+int BKE_movieclip_has_cached_frame(MovieClip *clip, MovieClipUser *user)
+{
+	int has_frame = FALSE;
+
+	BLI_lock_thread(LOCK_MOVIECLIP);
+	has_frame = has_imbuf_cache(clip, user, clip->flag);
+	BLI_unlock_thread(LOCK_MOVIECLIP);
+
+	return has_frame;
+}
+
+int BKE_movieclip_put_frame_if_possible(MovieClip *clip, MovieClipUser *user, ImBuf *ibuf)
+{
+	bool result;
+
+	BLI_lock_thread(LOCK_MOVIECLIP);
+	result = put_imbuf_cache(clip, user, ibuf, clip->flag, false);
+	BLI_unlock_thread(LOCK_MOVIECLIP);
+
+	return result;
+}

Modified: trunk/blender/source/blender/blenloader/intern/readfile.c
===================================================================
--- trunk/blender/source/blender/blenloader/intern/readfile.c	2013-03-20 16:51:50 UTC (rev 55447)
+++ trunk/blender/source/blender/blenloader/intern/readfile.c	2013-03-20 17:03:20 UTC (rev 55448)
@@ -6579,6 +6579,8 @@
 	clip->tracking.dopesheet.channels.first = clip->tracking.dopesheet.channels.last = NULL;
 	clip->tracking.dopesheet.coverage_segments.first = clip->tracking.dopesheet.coverage_segments.last = NULL;
 
+	clip->prefetch_ok = FALSE;
+
 	link_list(fd, &tracking->objects);
 	
 	for (object = tracking->objects.first; object; object = object->next) {

Modified: trunk/blender/source/blender/editors/space_clip/clip_draw.c
===================================================================
--- trunk/blender/source/blender/editors/space_clip/clip_draw.c	2013-03-20 16:51:50 UTC (rev 55447)
+++ trunk/blender/source/blender/editors/space_clip/clip_draw.c	2013-03-20 17:03:20 UTC (rev 55448)
@@ -1484,6 +1484,8 @@
 	if (ibuf) {
 		draw_movieclip_buffer(C, sc, ar, ibuf, width, height, zoomx, zoomy);
 		IMB_freeImBuf(ibuf);
+
+		clip_start_prefetch_job(C);
 	}
 	else {
 		ED_region_grid_draw(ar, zoomx, zoomy);

Modified: trunk/blender/source/blender/editors/space_clip/clip_editor.c
===================================================================
--- trunk/blender/source/blender/editors/space_clip/clip_editor.c	2013-03-20 16:51:50 UTC (rev 55447)
+++ trunk/blender/source/blender/editors/space_clip/clip_editor.c	2013-03-20 17:03:20 UTC (rev 55448)
@@ -30,17 +30,29 @@
  */
 
 #include <stddef.h>
+#include <errno.h>
+#include <sys/types.h>
+#include <fcntl.h>
 
+#ifndef WIN32
+#  include <unistd.h>
+#else
+#  include <io.h>
+#endif
+
 #include "MEM_guardedalloc.h"
 
 #include "DNA_mask_types.h"
 #include "DNA_object_types.h"	/* SELECT */
 
 #include "BLI_utildefines.h"
+#include "BLI_fileops.h"
 #include "BLI_math.h"
 #include "BLI_string.h"
 #include "BLI_rect.h"
+#include "BLI_threads.h"
 
+#include "BKE_global.h"
 #include "BKE_main.h"
 #include "BKE_mask.h"
 #include "BKE_movieclip.h"
@@ -724,3 +736,384 @@
 		MEM_freeN(context);
 	}
 }
+
+/* ******** pre-fetching functions ******** */
+
+typedef struct PrefetchJob {
+	MovieClip *clip;
+	int start_frame, end_frame;
+	short render_size, render_flag;
+} PrefetchJob;
+
+typedef struct PrefetchQueue {
+	int current_frame, start_frame, end_frame;
+	short render_size, render_flag;
+
+	SpinLock spin;
+
+	short *stop;
+	short *do_update;
+	float *progress;
+} PrefetchQueue;
+
+typedef struct PrefetchThread {
+	MovieClip *clip;
+	PrefetchQueue *queue;
+} PrefetchThread;
+
+/* check whether pre-fetching is allowed */
+static bool check_prefetch_allowed(void)
+{
+	wmWindowManager *wm;
+
+	/* if there's any job started, better to leave all CPU and
+	 * HDD bandwidth to it
+	 *
+	 * also, display transform could be needed during playback,
+	 * so better to avoid prefetching in this case and reserve
+	 * all the power for display transform
+	 */
+	for (wm = G.main->wm.first; wm; wm = wm->id.next) {
+		if (WM_jobs_has_running_except(wm, WM_JOB_TYPE_CLIP_PREFETCH))
+			return false;
+
+		if (ED_screen_animation_playing(wm))
+			return false;
+	}
+
+	return true;
+}
+
+/* read file for specified frame number to the memory */
+static unsigned char *prefetch_read_file_to_memory(MovieClip *clip, int current_frame, short render_size,
+                                                   short render_flag , size_t *size_r)
+{
+	MovieClipUser user = {0};
+	char name[FILE_MAX];
+	size_t size;
+	int file;
+	unsigned char *mem;
+
+	user.framenr = current_frame;

@@ Diff output truncated at 10240 characters. @@



More information about the Bf-blender-cvs mailing list