Libmv: Replace region tracker with autotracker in Blender

The title actually tells it all, this commit switches Blender to use the new
autotrack API from Libmv.

From the user point of view it means that prediction model is now used when
tracking which gives really nice results.

All the other changes are not really visible for users, those are just frame
accessors, caches and so for the new API.

1 files changed, 3 insertions, 473 deletions

diff --git a/source/blender/blenkernel/intern/tracking_region_tracker.c b/source/blender/blenkernel/intern/tracking_region_tracker.c
index c41106f37cb..09c95ae4321 100644
--- a/source/blender/blenkernel/intern/tracking_region_tracker.c
+++ b/source/blender/blenkernel/intern/tracking_region_tracker.c
@@ -51,170 +51,6 @@
 #include "libmv-capi.h"
 #include "tracking_private.h"
 
-typedef struct TrackContext {
-	/* the reference marker and cutout search area */
-	MovieTrackingMarker reference_marker;
-
-	/* keyframed patch. This is the search area */
-	float *search_area;
-	int search_area_height;
-	int search_area_width;
-	int framenr;
-
-	float *mask;
-} TrackContext;
-
-typedef struct MovieTrackingContext {
-	MovieClipUser user;
-	MovieClip *clip;
-	int clip_flag;
-
-	int frames, first_frame;
-	bool first_time;
-
-	MovieTrackingSettings settings;
-	TracksMap *tracks_map;
-
-	bool backwards, sequence;
-	int sync_frame;
-} MovieTrackingContext;
-
-static void track_context_free(void *customdata)
-{
-	TrackContext *track_context = (TrackContext *)customdata;
-
-	if (track_context->search_area)
-		MEM_freeN(track_context->search_area);
-
-	if (track_context->mask)
-		MEM_freeN(track_context->mask);
-}
-
-/* Create context for motion 2D tracking, copies all data needed
- * for thread-safe tracking, allowing clip modifications during
- * tracking.
- */
-MovieTrackingContext *BKE_tracking_context_new(MovieClip *clip, MovieClipUser *user,
-                                               const bool backwards, const bool sequence)
-{
-	MovieTrackingContext *context = MEM_callocN(sizeof(MovieTrackingContext), "trackingContext");
-	MovieTracking *tracking = &clip->tracking;
-	MovieTrackingSettings *settings = &tracking->settings;
-	ListBase *tracksbase = BKE_tracking_get_active_tracks(tracking);
-	MovieTrackingTrack *track;
-	MovieTrackingObject *object = BKE_tracking_object_get_active(tracking);
-	int num_tracks = 0;
-
-	context->clip = clip;
-	context->settings = *settings;
-	context->backwards = backwards;
-	context->sync_frame = user->framenr;
-	context->first_time = true;
-	context->first_frame = user->framenr;
-	context->sequence = sequence;
-
-	/* count */
-	track = tracksbase->first;
-	while (track) {
-		if (TRACK_SELECTED(track) && (track->flag & (TRACK_LOCKED | TRACK_HIDDEN)) == 0) {
-			int framenr = BKE_movieclip_remap_scene_to_clip_frame(clip, user->framenr);
-			MovieTrackingMarker *marker = BKE_tracking_marker_get(track, framenr);
-
-			if ((marker->flag & MARKER_DISABLED) == 0)
-				num_tracks++;
-		}
-
-		track = track->next;
-	}
-
-	/* create tracking contextx for all tracks which would be tracked */
-	if (num_tracks) {
-		int width, height;
-
-		context->tracks_map = tracks_map_new(object->name, object->flag & TRACKING_OBJECT_CAMERA,
-		                                     num_tracks, sizeof(TrackContext));
-
-		BKE_movieclip_get_size(clip, user, &width, &height);
-
-		/* create tracking data */
-		track = tracksbase->first;
-		while (track) {
-			if (TRACK_SELECTED(track) && (track->flag & (TRACK_HIDDEN | TRACK_LOCKED)) == 0) {
-				int framenr = BKE_movieclip_remap_scene_to_clip_frame(clip, user->framenr);
-				MovieTrackingMarker *marker = BKE_tracking_marker_get(track, framenr);
-
-				if ((marker->flag & MARKER_DISABLED) == 0) {
-					TrackContext track_context;
-					memset(&track_context, 0, sizeof(TrackContext));
-					tracks_map_insert(context->tracks_map, track, &track_context);
-				}
-			}
-
-			track = track->next;
-		}
-	}
-
-	/* store needed clip flags passing to get_buffer functions
-	 * - MCLIP_USE_PROXY is needed to because timecode affects on movie clip
-	 *   only in case Proxy/Timecode flag is set, so store this flag to use
-	 *   timecodes properly but reset render size to SIZE_FULL so correct resolution
-	 *   would be used for images
-	 * - MCLIP_USE_PROXY_CUSTOM_DIR is needed because proxy/timecode files might
-	 *   be stored in a different location
-	 * ignore all the rest possible flags for now
-	 */
-	context->clip_flag = clip->flag & MCLIP_TIMECODE_FLAGS;
-
-	context->user = *user;
-	context->user.render_size = MCLIP_PROXY_RENDER_SIZE_FULL;
-	context->user.render_flag = 0;
-
-	if (!sequence)
-		BLI_begin_threaded_malloc();
-
-	return context;
-}
-
-/* Free context used for tracking. */
-void BKE_tracking_context_free(MovieTrackingContext *context)
-{
-	if (!context->sequence)
-		BLI_end_threaded_malloc();
-
-	tracks_map_free(context->tracks_map, track_context_free);
-
-	MEM_freeN(context);
-}
-
-/* Synchronize tracks between clip editor and tracking context,
- * by merging them together so all new created tracks and tracked
- * ones presents in the movie clip.
- */
-void BKE_tracking_context_sync(MovieTrackingContext *context)
-{
-	MovieTracking *tracking = &context->clip->tracking;
-	int newframe;
-
-	tracks_map_merge(context->tracks_map, tracking);
-
-	if (context->backwards)
-		newframe = context->user.framenr + 1;
-	else
-		newframe = context->user.framenr - 1;
-
-	context->sync_frame = newframe;
-
-	BKE_tracking_dopesheet_tag_update(tracking);
-}
-
-/* Synchronize clip user's frame number with a frame number from tracking context,
- * used to update current frame displayed in the clip editor while tracking.
- */
-void BKE_tracking_context_sync_user(const MovieTrackingContext *context, MovieClipUser *user)
-{
-	user->framenr = context->sync_frame;
-}
-
 /* **** utility functions for tracking **** */
 
 /* convert from float and byte RGBA to grayscale. Supports different coefficients for RGB. */
@@ -296,51 +132,6 @@ static ImBuf *tracking_context_get_frame_ibuf(MovieClip *clip, MovieClipUser *us
 	return ibuf;
 }
 
-/* Get previous keyframed marker. */
-static MovieTrackingMarker *tracking_context_get_keyframed_marker(MovieTrackingTrack *track,
-                                                                  int curfra, bool backwards)
-{
-	MovieTrackingMarker *marker_keyed = NULL;
-	MovieTrackingMarker *marker_keyed_fallback = NULL;
-	int a = BKE_tracking_marker_get(track, curfra) - track->markers;
-
-	while (a >= 0 && a < track->markersnr) {
-		int next = backwards ? a + 1 : a - 1;
-		bool is_keyframed = false;
-		MovieTrackingMarker *cur_marker = &track->markers[a];
-		MovieTrackingMarker *next_marker = NULL;
-
-		if (next >= 0 && next < track->markersnr)
-			next_marker = &track->markers[next];
-
-		if ((cur_marker->flag & MARKER_DISABLED) == 0) {
-			/* If it'll happen so we didn't find a real keyframe marker,
-			 * fallback to the first marker in current tracked segment
-			 * as a keyframe.
-			 */
-			if (next_marker && next_marker->flag & MARKER_DISABLED) {
-				if (marker_keyed_fallback == NULL)
-					marker_keyed_fallback = cur_marker;
-			}
-
-			is_keyframed |= (cur_marker->flag & MARKER_TRACKED) == 0;
-		}
-
-		if (is_keyframed) {
-			marker_keyed = cur_marker;
-
-			break;
-		}
-
-		a = next;
-	}
-
-	if (marker_keyed == NULL)
-		marker_keyed = marker_keyed_fallback;
-
-	return marker_keyed;
-}
-
 /* Get image buffer for previous marker's keyframe. */
 static ImBuf *tracking_context_get_keyframed_ibuf(MovieClip *clip, MovieClipUser *user, int clip_flag,
                                                   MovieTrackingTrack *track, int curfra, bool backwards,
@@ -349,7 +140,7 @@ static ImBuf *tracking_context_get_keyframed_ibuf(MovieClip *clip, MovieClipUser
 	MovieTrackingMarker *marker_keyed;
 	int keyed_framenr;
 
-	marker_keyed = tracking_context_get_keyframed_marker(track, curfra, backwards);
+	marker_keyed = tracking_get_keyframed_marker(track, curfra, backwards);
 	if (marker_keyed == NULL) {
 		return NULL;
 	}
@@ -381,50 +172,9 @@ static ImBuf *tracking_context_get_reference_ibuf(MovieClip *clip, MovieClipUser
 	return ibuf;
 }
 
-/* Update track's reference patch (patch from which track is tracking from)
- *
- * Returns false if reference image buffer failed to load.
- */
-static bool track_context_update_reference(MovieTrackingContext *context, TrackContext *track_context,
-                                           MovieTrackingTrack *track, MovieTrackingMarker *marker, int curfra,
-                                           int frame_width, int frame_height)
-{
-	MovieTrackingMarker *reference_marker = NULL;
-	ImBuf *reference_ibuf = NULL;
-	int width, height;
-
-	/* calculate patch for keyframed position */
-	reference_ibuf = tracking_context_get_reference_ibuf(context->clip, &context->user, context->clip_flag,
-	                                                     track, curfra, context->backwards, &reference_marker);
-
-	if (!reference_ibuf)
-		return false;
-
-	track_context->reference_marker = *reference_marker;
-
-	if (track_context->search_area) {
-		MEM_freeN(track_context->search_area);
-	}
-
-	track_context->search_area = track_get_search_floatbuf(reference_ibuf, track, reference_marker, &width, &height);
-	track_context->search_area_height = height;
-	track_context->search_area_width = width;
-
-	if ((track->algorithm_flag & TRACK_ALGORITHM_FLAG_USE_MASK) != 0) {
-		if (track_context->mask)
-			MEM_freeN(track_context->mask);
-
-		track_context->mask = BKE_tracking_track_get_mask(frame_width, frame_height, track, marker);
-	}
-
-	IMB_freeImBuf(reference_ibuf);
-
-	return true;
-}
-
 /* Fill in libmv tracker options structure with settings need to be used to perform track. */
-static void tracking_configure_tracker(const MovieTrackingTrack *track, float *mask,
-                                       libmv_TrackRegionOptions *options)
+void tracking_configure_tracker(const MovieTrackingTrack *track, float *mask,
+                                libmv_TrackRegionOptions *options)
 {
 	options->motion_model = track->motion_model;
 
@@ -442,102 +192,6 @@ static void tracking_configure_tracker(const MovieTrackingTrack *track, float *m
 		options->image1_mask = NULL;
 }
 
-/* returns false if marker crossed margin area from frame bounds */
-static bool tracking_check_marker_margin(MovieTrackingTrack *track, MovieTrackingMarker *marker,
-                                         int frame_width, int frame_height)
-{
-	float pat_min[2], pat_max[2];
-	float margin_left, margin_top, margin_right, margin_bottom;
-	float normalized_track_margin[2];
-
-	/* margin from frame boundaries */
-	BKE_tracking_marker_pattern_minmax(marker, pat_min, pat_max);
-
-	normalized_track_margin[0] = (float)track->margin / frame_width;
-	normalized_track_margin[1] = (float)track->margin / frame_height;
-
-	margin_left   = max_ff(-pat_min[0], normalized_track_margin[0]);
-	margin_top    = max_ff( pat_max[1], normalized_track_margin[1]);
-	margin_right  = max_ff( pat_max[0], normalized_track_margin[0]);
-	margin_bottom = max_ff(-pat_min[1], normalized_track_margin[1]);
-
-	/* do not track markers which are too close to boundary */
-	if (marker->pos[0] < margin_left || marker->pos[0] > 1.0f - margin_right ||
-	    marker->pos[1] < margin_bottom || marker->pos[1] > 1.0f - margin_top)
-	{
-		return false;
-	}
-
-	return true;
-}
-
-/* Scale search area of marker based on scale changes of pattern area,
- *
- * TODO(sergey): currently based on pattern bounding box scale change,
- *               smarter approach here is welcome.
- */
-static void tracking_scale_marker_search(const MovieTrackingMarker *old_marker, MovieTrackingMarker *new_marker)
-{
-	float old_pat_min[2], old_pat_max[2];
-	float new_pat_min[2], new_pat_max[2];
-	float scale_x, scale_y;
-
-	BKE_tracking_marker_pattern_minmax(old_marker, old_pat_min, old_pat_max);
-	BKE_tracking_marker_pattern_minmax(new_marker, new_pat_min, new_pat_max);
-
-	scale_x = (new_pat_max[0] - new_pat_min[0]) / (old_pat_max[0] - old_pat_min[0]);
-	scale_y = (new_pat_max[1] - new_pat_min[1]) / (old_pat_max[1] - old_pat_min[1]);
-
-	new_marker->search_min[0] *= scale_x;
-	new_marker->search_min[1] *= scale_y;
-
-	new_marker->search_max[0] *= scale_x;
-	new_marker->search_max[1] *= scale_y;
-}
-
-/* Insert new marker which was tracked from old_marker to a new image,
- * will also ensure tracked segment is surrounded by disabled markers.
- */
-static void tracking_insert_new_marker(MovieTrackingContext *context, MovieTrackingTrack *track,
-                                       const MovieTrackingMarker *old_marker, int curfra, bool tracked,
-                                       int frame_width, int frame_height,
-                                       const double dst_pixel_x[5], const double dst_pixel_y[5])
-{
-	MovieTrackingMarker new_marker;
-	int frame_delta = context->backwards ? -1 : 1;
-	int nextfra = curfra + frame_delta;
-
-	new_marker = *old_marker;
-
-	if (tracked) {
-		tracking_set_marker_coords_from_tracking(frame_width, frame_height, &new_marker, dst_pixel_x, dst_pixel_y);
-		new_marker.flag |= MARKER_TRACKED;
-		new_marker.framenr = nextfra;
-
-		tracking_scale_marker_search(old_marker, &new_marker);
-
-		if (context->first_time) {
-			/* check if there's no keyframe/tracked markers before tracking marker.
-			 * if so -- create disabled marker before currently tracking "segment"
-			 */
-
-			tracking_marker_insert_disabled(track, old_marker, !context->backwards, false);
-		}
-
-		/* insert currently tracked marker */
-		BKE_tracking_marker_insert(track, &new_marker);
-
-		/* make currently tracked segment be finished with disabled marker */
-		tracking_marker_insert_disabled(track, &new_marker, context->backwards, false);
-	}
-	else {
-		new_marker.framenr = nextfra;
-		new_marker.flag |= MARKER_DISABLED;
-
-		BKE_tracking_marker_insert(track, &new_marker);
-	}
-}
-
 /* Peform tracking from a reference_marker to destination_ibuf.
  * Uses marker as an initial position guess.
  *
@@ -601,130 +255,6 @@ static bool configure_and_run_tracker(ImBuf *destination_ibuf, MovieTrackingTrac
 	return tracked;
 }
 
-/* Track all the tracks from context one more frame,
- * returns FALSe if nothing was tracked.
- */
-bool BKE_tracking_context_step(MovieTrackingContext *context)
-{
-	ImBuf *destination_ibuf;
-	int frame_delta = context->backwards ? -1 : 1;
-	int curfra =  BKE_movieclip_remap_scene_to_clip_frame(context->clip, context->user.framenr);
-	int a, map_size;
-	bool ok = false;
-
-	int frame_width, frame_height;
-
-	map_size = tracks_map_get_size(context->tracks_map);
-
-	/* Nothing to track, avoid unneeded frames reading to save time and memory. */
-	if (!map_size)
-		return false;
-
-	/* Get an image buffer for frame we're tracking to. */
-	context->user.framenr += frame_delta;
-
-	destination_ibuf = BKE_movieclip_get_ibuf_flag(context->clip, &context->user,
-	                                               context->clip_flag, MOVIECLIP_CACHE_SKIP);
-	if (!destination_ibuf)
-		return false;
-
-	frame_width = destination_ibuf->x;
-	frame_height = destination_ibuf->y;
-
-#pragma omp parallel for private(a) shared(destination_ibuf, ok) if (map_size > 1)
-	for (a = 0; a < map_size; a++) {
-		TrackContext *track_context = NULL;
-		MovieTrackingTrack *track;
-		MovieTrackingMarker *marker;
-
-		tracks_map_get_indexed_element(context->tracks_map, a, &track, (void **)&track_context);
-
-		marker = BKE_tracking_marker_get_exact(track, curfra);
-
-		if (marker && (marker->flag & MARKER_DISABLED) == 0) {
-			bool tracked = false, need_readjust;
-			double dst_pixel_x[5], dst_pixel_y[5];
-
-			if (track->pattern_match == TRACK_MATCH_KEYFRAME)
-				need_readjust = context->first_time;
-			else
-				need_readjust = true;
-
-			/* do not track markers which are too close to boundary */
-			if (tracking_check_marker_margin(track, marker, frame_width, frame_height)) {
-				if (need_readjust) {
-					if (track_context_update_reference(context, track_context, track, marker,
-					                                   curfra, frame_width, frame_height) == false)
-					{
-						/* happens when reference frame fails to be loaded */
-						continue;
-					}
-				}
-
-				tracked = configure_and_run_tracker(destination_ibuf, track,
-				                                    &track_context->reference_marker, marker,
-				                                    track_context->search_area,
-				                                    track_context->search_area_width,
-				                                    track_context->search_area_height,
-				                                    track_context->mask,
-				                                    dst_pixel_x, dst_pixel_y);
-			}
-
-			BLI_spin_lock(&context->tracks_map->spin_lock);
-			tracking_insert_new_marker(context, track, marker, curfra, tracked,
-			                           frame_width, frame_height, dst_pixel_x, dst_pixel_y);
-			BLI_spin_unlock(&context->tracks_map->spin_lock);
-
-			ok = true;
-		}
-	}
-
-	IMB_freeImBuf(destination_ibuf);
-
-	context->first_time = false;
-	context->frames++;
-
-	return ok;
-}
-
-void BKE_tracking_context_finish(MovieTrackingContext *context)
-{
-	MovieClip *clip = context->clip;
-	ListBase *plane_tracks_base = BKE_tracking_get_active_plane_tracks(&clip->tracking);
-	MovieTrackingPlaneTrack *plane_track;
-	int map_size = tracks_map_get_size(context->tracks_map);
-
-	for (plane_track = plane_tracks_base->first;
-	     plane_track;
-	     plane_track = plane_track->next)
-	{
-		if ((plane_track->flag & PLANE_TRACK_AUTOKEY) == 0) {
-			int i;
-			for (i = 0; i < map_size; i++) {
-				TrackContext *track_context = NULL;
-				MovieTrackingTrack *track, *old_track;
-				bool do_update = false;
-				int j;
-
-				tracks_map_get_indexed_element(context->tracks_map, i, &track, (void **)&track_context);
-
-				old_track = BLI_ghash_lookup(context->tracks_map->hash, track);
-				for (j = 0; j < plane_track->point_tracksnr; j++) {
-					if (plane_track->point_tracks[j] == old_track) {
-						do_update = true;
-						break;
-					}
-				}
-
-				if (do_update) {
-					BKE_tracking_track_plane_from_existing_motion(plane_track, context->first_frame);
-					break;
-				}
-			}
-		}
-	}
-}
-
 static bool refine_marker_reference_frame_get(MovieTrackingTrack *track,
                                               MovieTrackingMarker *marker,
                                               bool backwards,