ClangFormat: apply to source, most of intern
[blender.git] / source / blender / blenkernel / intern / tracking_stabilize.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2011 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup bke
22  *
23  * This file contains implementation of 2D image stabilization.
24  */
25
26 #include <limits.h>
27
28 #include "DNA_movieclip_types.h"
29 #include "DNA_scene_types.h"
30 #include "DNA_anim_types.h"
31 #include "RNA_access.h"
32
33 #include "BLI_utildefines.h"
34 #include "BLI_sort_utils.h"
35 #include "BLI_ghash.h"
36 #include "BLI_math_vector.h"
37 #include "BLI_math.h"
38 #include "BLI_task.h"
39
40 #include "BKE_tracking.h"
41 #include "BKE_movieclip.h"
42 #include "BKE_fcurve.h"
43
44 #include "MEM_guardedalloc.h"
45 #include "IMB_imbuf_types.h"
46 #include "IMB_imbuf.h"
47
48 /* == Parameterization constants == */
49
50 /* When measuring the scale changes relative to the rotation pivot point, it
51  * might happen accidentally that a probe point (tracking point), which doesn't
52  * actually move on a circular path, gets very close to the pivot point, causing
53  * the measured scale contribution to go toward infinity. We damp this undesired
54  * effect by adding a bias (floor) to the measured distances, which will
55  * dominate very small distances and thus cause the corresponding track's
56  * contribution to diminish.
57  * Measurements happen in normalized (0...1) coordinates within a frame.
58  */
59 static float SCALE_ERROR_LIMIT_BIAS = 0.01f;
60
61 /* When to consider a track as completely faded out.
62  * This is used in conjunction with the "disabled" flag of the track
63  * to determine start positions, end positions and gaps
64  */
65 static float EPSILON_WEIGHT = 0.005f;
66
67 /* == private working data == */
68
69 /* Per track baseline for stabilization, defined at reference frame.
70  * A track's reference frame is chosen as close as possible to the (global)
71  * anchor_frame. Baseline holds the constant part of each track's contribution
72  * to the observed movement; it is calculated at initialization pass, using the
73  * measurement value at reference frame plus the average contribution to fill
74  * the gap between global anchor_frame and the reference frame for this track.
75  * This struct with private working data is associated to the local call context
76  * via `StabContext::private_track_data`
77  */
78 typedef struct TrackStabilizationBase {
79   float stabilization_offset_base[2];
80
81   /* measured relative to translated pivot */
82   float stabilization_rotation_base[2][2];
83
84   /* measured relative to translated pivot */
85   float stabilization_scale_base;
86
87   bool is_init_for_stabilization;
88   FCurve *track_weight_curve;
89 } TrackStabilizationBase;
90
91 /* Tracks are reordered for initialization, starting as close as possible to
92  * anchor_frame
93  */
94 typedef struct TrackInitOrder {
95   int sort_value;
96   int reference_frame;
97   MovieTrackingTrack *data;
98 } TrackInitOrder;
99
100 /* Per frame private working data, for accessing possibly animated values. */
101 typedef struct StabContext {
102   MovieClip *clip;
103   MovieTracking *tracking;
104   MovieTrackingStabilization *stab;
105   GHash *private_track_data;
106   FCurve *locinf;
107   FCurve *rotinf;
108   FCurve *scaleinf;
109   FCurve *target_pos[2];
110   FCurve *target_rot;
111   FCurve *target_scale;
112   bool use_animation;
113 } StabContext;
114
115 static TrackStabilizationBase *access_stabilization_baseline_data(StabContext *ctx,
116                                                                   MovieTrackingTrack *track)
117 {
118   return BLI_ghash_lookup(ctx->private_track_data, track);
119 }
120
121 static void attach_stabilization_baseline_data(StabContext *ctx,
122                                                MovieTrackingTrack *track,
123                                                TrackStabilizationBase *private_data)
124 {
125   BLI_ghash_insert(ctx->private_track_data, track, private_data);
126 }
127
128 static void discard_stabilization_baseline_data(void *val)
129 {
130   if (val != NULL) {
131     MEM_freeN(val);
132   }
133 }
134
135 /* == access animated values for given frame == */
136
137 static FCurve *retrieve_stab_animation(MovieClip *clip, const char *data_path, int idx)
138 {
139   return id_data_find_fcurve(&clip->id,
140                              &clip->tracking.stabilization,
141                              &RNA_MovieTrackingStabilization,
142                              data_path,
143                              idx,
144                              NULL);
145 }
146
147 static FCurve *retrieve_track_weight_animation(MovieClip *clip, MovieTrackingTrack *track)
148 {
149   return id_data_find_fcurve(&clip->id, track, &RNA_MovieTrackingTrack, "weight_stab", 0, NULL);
150 }
151
152 static float fetch_from_fcurve(FCurve *animationCurve,
153                                int framenr,
154                                StabContext *ctx,
155                                float default_value)
156 {
157   if (ctx && ctx->use_animation && animationCurve) {
158     int scene_framenr = BKE_movieclip_remap_clip_to_scene_frame(ctx->clip, framenr);
159     return evaluate_fcurve(animationCurve, scene_framenr);
160   }
161   return default_value;
162 }
163
164 static float get_animated_locinf(StabContext *ctx, int framenr)
165 {
166   return fetch_from_fcurve(ctx->locinf, framenr, ctx, ctx->stab->locinf);
167 }
168
169 static float get_animated_rotinf(StabContext *ctx, int framenr)
170 {
171   return fetch_from_fcurve(ctx->rotinf, framenr, ctx, ctx->stab->rotinf);
172 }
173
174 static float get_animated_scaleinf(StabContext *ctx, int framenr)
175 {
176   return fetch_from_fcurve(ctx->scaleinf, framenr, ctx, ctx->stab->scaleinf);
177 }
178
179 static void get_animated_target_pos(StabContext *ctx, int framenr, float target_pos[2])
180 {
181   target_pos[0] = fetch_from_fcurve(ctx->target_pos[0], framenr, ctx, ctx->stab->target_pos[0]);
182   target_pos[1] = fetch_from_fcurve(ctx->target_pos[1], framenr, ctx, ctx->stab->target_pos[1]);
183 }
184
185 static float get_animated_target_rot(StabContext *ctx, int framenr)
186 {
187   return fetch_from_fcurve(ctx->target_rot, framenr, ctx, ctx->stab->target_rot);
188 }
189
190 static float get_animated_target_scale(StabContext *ctx, int framenr)
191 {
192   return fetch_from_fcurve(ctx->target_scale, framenr, ctx, ctx->stab->scale);
193 }
194
195 static float get_animated_weight(StabContext *ctx, MovieTrackingTrack *track, int framenr)
196 {
197   TrackStabilizationBase *working_data = access_stabilization_baseline_data(ctx, track);
198   if (working_data && working_data->track_weight_curve) {
199     int scene_framenr = BKE_movieclip_remap_clip_to_scene_frame(ctx->clip, framenr);
200     return evaluate_fcurve(working_data->track_weight_curve, scene_framenr);
201   }
202   /* Use weight at global 'current frame' as fallback default. */
203   return track->weight_stab;
204 }
205
206 static void use_values_from_fcurves(StabContext *ctx, bool toggle)
207 {
208   if (ctx != NULL) {
209     ctx->use_animation = toggle;
210   }
211 }
212
213 /* Prepare per call private working area.
214  * Used for access to possibly animated values: retrieve available F-curves.
215  */
216 static StabContext *initialize_stabilization_working_context(MovieClip *clip)
217 {
218   StabContext *ctx = MEM_callocN(sizeof(StabContext), "2D stabilization animation runtime data");
219   ctx->clip = clip;
220   ctx->tracking = &clip->tracking;
221   ctx->stab = &clip->tracking.stabilization;
222   ctx->private_track_data = BLI_ghash_ptr_new("2D stabilization per track private working data");
223   ctx->locinf = retrieve_stab_animation(clip, "influence_location", 0);
224   ctx->rotinf = retrieve_stab_animation(clip, "influence_rotation", 0);
225   ctx->scaleinf = retrieve_stab_animation(clip, "influence_scale", 0);
226   ctx->target_pos[0] = retrieve_stab_animation(clip, "target_pos", 0);
227   ctx->target_pos[1] = retrieve_stab_animation(clip, "target_pos", 1);
228   ctx->target_rot = retrieve_stab_animation(clip, "target_rot", 0);
229   ctx->target_scale = retrieve_stab_animation(clip, "target_zoom", 0);
230   ctx->use_animation = true;
231   return ctx;
232 }
233
234 /**
235  * Discard all private working data attached to this call context.
236  *
237  * \note We allocate the record for the per track baseline contribution
238  * locally for each call context (i.e. call to #BKE_tracking_stabilization_data_get)
239  * Thus it is correct to discard all allocations found within the
240  * corresponding _local_ GHash.
241  */
242 static void discard_stabilization_working_context(StabContext *ctx)
243 {
244   if (ctx != NULL) {
245     BLI_ghash_free(ctx->private_track_data, NULL, discard_stabilization_baseline_data);
246     MEM_freeN(ctx);
247   }
248 }
249
250 static bool is_init_for_stabilization(StabContext *ctx, MovieTrackingTrack *track)
251 {
252   TrackStabilizationBase *working_data = access_stabilization_baseline_data(ctx, track);
253   return (working_data != NULL && working_data->is_init_for_stabilization);
254 }
255
256 static bool is_usable_for_stabilization(StabContext *ctx, MovieTrackingTrack *track)
257 {
258   return (track->flag & TRACK_USE_2D_STAB) && is_init_for_stabilization(ctx, track);
259 }
260
261 static bool is_effectively_disabled(StabContext *ctx,
262                                     MovieTrackingTrack *track,
263                                     MovieTrackingMarker *marker)
264 {
265   return (marker->flag & MARKER_DISABLED) ||
266          (EPSILON_WEIGHT > get_animated_weight(ctx, track, marker->framenr));
267 }
268
269 static int search_closest_marker_index(MovieTrackingTrack *track, int ref_frame)
270 {
271   MovieTrackingMarker *markers = track->markers;
272   int end = track->markersnr;
273   int i = track->last_marker;
274
275   i = MAX2(0, i);
276   i = MIN2(i, end - 1);
277   for (; i < end - 1 && markers[i].framenr <= ref_frame; ++i)
278     ;
279   for (; 0 < i && markers[i].framenr > ref_frame; --i)
280     ;
281
282   track->last_marker = i;
283   return i;
284 }
285
286 static void retrieve_next_higher_usable_frame(
287     StabContext *ctx, MovieTrackingTrack *track, int i, int ref_frame, int *next_higher)
288 {
289   MovieTrackingMarker *markers = track->markers;
290   int end = track->markersnr;
291   BLI_assert(0 <= i && i < end);
292
293   while (i < end &&
294          (markers[i].framenr < ref_frame || is_effectively_disabled(ctx, track, &markers[i]))) {
295     ++i;
296   }
297   if (i < end && markers[i].framenr < *next_higher) {
298     BLI_assert(markers[i].framenr >= ref_frame);
299     *next_higher = markers[i].framenr;
300   }
301 }
302
303 static void retrieve_next_lower_usable_frame(
304     StabContext *ctx, MovieTrackingTrack *track, int i, int ref_frame, int *next_lower)
305 {
306   MovieTrackingMarker *markers = track->markers;
307   BLI_assert(0 <= i && i < track->markersnr);
308   while (i >= 0 &&
309          (markers[i].framenr > ref_frame || is_effectively_disabled(ctx, track, &markers[i]))) {
310     --i;
311   }
312   if (0 <= i && markers[i].framenr > *next_lower) {
313     BLI_assert(markers[i].framenr <= ref_frame);
314     *next_lower = markers[i].framenr;
315   }
316 }
317
318 /* Find closest frames with usable stabilization data.
319  * A frame counts as _usable_ when there is at least one track marked for
320  * translation stabilization, which has an enabled tracking marker at this very
321  * frame. We search both for the next lower and next higher position, to allow
322  * the caller to interpolate gaps and to extrapolate at the ends of the
323  * definition range.
324  *
325  * NOTE: Regarding performance note that the individual tracks will cache the
326  *       last search position.
327  */
328 static void find_next_working_frames(StabContext *ctx,
329                                      int framenr,
330                                      int *next_lower,
331                                      int *next_higher)
332 {
333   for (MovieTrackingTrack *track = ctx->tracking->tracks.first; track != NULL;
334        track = track->next) {
335     if (is_usable_for_stabilization(ctx, track)) {
336       int startpoint = search_closest_marker_index(track, framenr);
337       retrieve_next_higher_usable_frame(ctx, track, startpoint, framenr, next_higher);
338       retrieve_next_lower_usable_frame(ctx, track, startpoint, framenr, next_lower);
339     }
340   }
341 }
342
343 /* Find active (enabled) marker closest to the reference frame. */
344 static MovieTrackingMarker *get_closest_marker(StabContext *ctx,
345                                                MovieTrackingTrack *track,
346                                                int ref_frame)
347 {
348   int next_lower = MINAFRAME;
349   int next_higher = MAXFRAME;
350   int i = search_closest_marker_index(track, ref_frame);
351   retrieve_next_higher_usable_frame(ctx, track, i, ref_frame, &next_higher);
352   retrieve_next_lower_usable_frame(ctx, track, i, ref_frame, &next_lower);
353
354   if ((next_higher - ref_frame) < (ref_frame - next_lower)) {
355     return BKE_tracking_marker_get_exact(track, next_higher);
356   }
357   else {
358     return BKE_tracking_marker_get_exact(track, next_lower);
359   }
360 }
361
362 /* Retrieve tracking data, if available and applicable for this frame.
363  * The returned weight value signals the validity; data recorded for this
364  * tracking marker on the exact requested frame is output with the full weight
365  * of this track, while gaps in the data sequence cause the weight to go to zero.
366  */
367 static MovieTrackingMarker *get_tracking_data_point(StabContext *ctx,
368                                                     MovieTrackingTrack *track,
369                                                     int framenr,
370                                                     float *r_weight)
371 {
372   MovieTrackingMarker *marker = BKE_tracking_marker_get_exact(track, framenr);
373   if (marker != NULL && !(marker->flag & MARKER_DISABLED)) {
374     *r_weight = get_animated_weight(ctx, track, framenr);
375     return marker;
376   }
377   else {
378     /* No marker at this frame (=gap) or marker disabled. */
379     *r_weight = 0.0f;
380     return NULL;
381   }
382 }
383
384 /* Define the reference point for rotation/scale measurement and compensation.
385  * The stabilizator works by assuming the image was distorted by a affine linear
386  * transform, i.e. it was rotated and stretched around this reference point
387  * (pivot point) and then shifted laterally. Any scale and orientation changes
388  * will be picked up relative to this point. And later the image will be
389  * stabilized by rotating around this point. The result can only be as
390  * accurate as this pivot point actually matches the real rotation center
391  * of the actual movements. Thus any scheme to define a pivot point is
392  * always guesswork.
393  *
394  * As a simple default, we use the weighted average of the location markers
395  * of the current frame as pivot point. TODO It is planned to add further
396  * options,  like e.g. anchoring the pivot point at the canvas. Moreover,
397  * it is planned to allow for a user controllable offset.
398  */
399 static void setup_pivot(const float ref_pos[2], float r_pivot[2])
400 {
401   zero_v2(r_pivot); /* TODO: add an animated offset position here. */
402   add_v2_v2(r_pivot, ref_pos);
403 }
404
405 /* Calculate the contribution of a single track at the time position (frame) of
406  * the given marker. Each track has a local reference frame, which is as close
407  * as possible to the global anchor_frame. Thus the translation contribution is
408  * comprised of the offset relative to the image position at that reference
409  * frame, plus a guess of the contribution for the time span between the
410  * anchor_frame and the local reference frame of this track. The constant part
411  * of this contribution is precomputed initially. At the anchor_frame, by
412  * definition the contribution of all tracks is zero, keeping the frame in place.
413  *
414  * track_ref is per track baseline contribution at reference frame; filled in at
415  *           initialization
416  * marker is tracking data to use as contribution for current frame.
417  * result_offset is a total cumulated contribution of this track,
418  *               relative to the stabilization anchor_frame,
419  *               in normalized (0...1) coordinates.
420  */
421 static void translation_contribution(TrackStabilizationBase *track_ref,
422                                      MovieTrackingMarker *marker,
423                                      float result_offset[2])
424 {
425   add_v2_v2v2(result_offset, track_ref->stabilization_offset_base, marker->pos);
426 }
427
428 /* Similar to the ::translation_contribution(), the rotation contribution is
429  * comprised of the contribution by this individual track, and the averaged
430  * contribution from anchor_frame to the ref point of this track.
431  * - Contribution is in terms of angles, -pi < angle < +pi, and all averaging
432  *   happens in this domain.
433  * - Yet the actual measurement happens as vector between pivot and the current
434  *   tracking point
435  * - Currently we use the center of frame as approximation for the rotation pivot
436  *   point.
437  * - Moreover, the pivot point has to be compensated for the already determined
438  *   shift offset, in order to get the pure rotation around the pivot.
439  *   To turn this into a _contribution_, the likewise corrected angle at the
440  *   reference frame has to be subtracted, to get only the pure angle difference
441  *   this tracking point has captured.
442  * - To get from vectors to angles, we have to go through an arcus tangens,
443  *   which involves the issue of the definition range: the resulting angles will
444  *   flip by 360deg when the measured vector passes from the 2nd to the third
445  *   quadrant, thus messing up the average calculation. Since _any_ tracking
446  *   point might be used, these problems are quite common in practice.
447  * - Thus we perform the subtraction of the reference and the addition of the
448  *   baseline contribution in polar coordinates as simple addition of angles;
449  *   since these parts are fixed, we can bake them into a rotation matrix.
450  *   With this approach, the border of the arcus tangens definition range will
451  *   be reached only, when the _whole_ contribution approaches +- 180deg,
452  *   meaning we've already tilted the frame upside down. This situation is way
453  *   less common and can be tolerated.
454  * - As an additional feature, when activated, also changes in image scale
455  *   relative to the rotation center can be picked up. To handle those values
456  *   in the same framework, we average the scales as logarithms.
457  *
458  * aspect is a total aspect ratio of the undistorted image (includes fame and
459  * pixel aspect). The function returns a quality factor, which can be used
460  * to damp the contributions of points in close proximity to the pivot point,
461  * since such contributions might be dominated by rounding errors and thus
462  * poison the calculated average. When the quality factor goes towards zero,
463  * the weight of this contribution should be reduced accordingly.
464  */
465 static float rotation_contribution(TrackStabilizationBase *track_ref,
466                                    MovieTrackingMarker *marker,
467                                    const float aspect,
468                                    const float pivot[2],
469                                    float *result_angle,
470                                    float *result_scale)
471 {
472   float len, quality;
473   float pos[2];
474   sub_v2_v2v2(pos, marker->pos, pivot);
475
476   pos[0] *= aspect;
477   mul_m2v2(track_ref->stabilization_rotation_base, pos);
478
479   *result_angle = atan2f(pos[1], pos[0]);
480
481   len = len_v2(pos);
482
483   /* prevent points very close to the pivot point from poisoning the result */
484   quality = 1 - expf(-len * len / SCALE_ERROR_LIMIT_BIAS * SCALE_ERROR_LIMIT_BIAS);
485   len += SCALE_ERROR_LIMIT_BIAS;
486
487   *result_scale = len * track_ref->stabilization_scale_base;
488   BLI_assert(0.0 < *result_scale);
489
490   return quality;
491 }
492
493 /* Workaround to allow for rotation around an arbitrary pivot point.
494  * Currently, the public API functions do not support this flexibility.
495  * Rather, rotation will always be applied around a fixed origin.
496  * As a workaround, we shift the image after rotation to match the
497  * desired rotation centre. And since this offset needs to be applied
498  * after the rotation and scaling, we can collapse it with the
499  * translation compensation, which is also a lateral shift (offset).
500  * The offset to apply is intended_pivot - rotated_pivot
501  */
502 static void compensate_rotation_center(const int size,
503                                        float aspect,
504                                        const float angle,
505                                        const float scale,
506                                        const float pivot[2],
507                                        float result_translation[2])
508 {
509   const float origin[2] = {0.5f * aspect * size, 0.5f * size};
510   float intended_pivot[2], rotated_pivot[2];
511   float rotation_mat[2][2];
512
513   copy_v2_v2(intended_pivot, pivot);
514   copy_v2_v2(rotated_pivot, pivot);
515   angle_to_mat2(rotation_mat, +angle);
516   sub_v2_v2(rotated_pivot, origin);
517   mul_m2v2(rotation_mat, rotated_pivot);
518   mul_v2_fl(rotated_pivot, scale);
519   add_v2_v2(rotated_pivot, origin);
520   add_v2_v2(result_translation, intended_pivot);
521   sub_v2_v2(result_translation, rotated_pivot);
522 }
523
524 /* Weighted average of the per track cumulated contributions at given frame.
525  * Returns truth if all desired calculations could be done and all averages are
526  * available.
527  *
528  * NOTE: Even if the result is not `true`, the returned translation and angle
529  *       are always sensible and as good as can be. Especially in the
530  *       initialization phase we might not be able to get any average (yet) or
531  *       get only a translation value. Since initialization visits tracks in a
532  *       specific order, starting from anchor_frame, the result is logically
533  *       correct non the less. But under normal operation conditions,
534  *       a result of `false` should disable the stabilization function
535  */
536 static bool average_track_contributions(StabContext *ctx,
537                                         int framenr,
538                                         float aspect,
539                                         float r_translation[2],
540                                         float r_pivot[2],
541                                         float *r_angle,
542                                         float *r_scale_step)
543 {
544   bool ok;
545   float weight_sum;
546   MovieTrackingTrack *track;
547   MovieTracking *tracking = ctx->tracking;
548   MovieTrackingStabilization *stab = &tracking->stabilization;
549   float ref_pos[2];
550   BLI_assert(stab->flag & TRACKING_2D_STABILIZATION);
551
552   zero_v2(r_translation);
553   *r_scale_step = 0.0f; /* logarithm */
554   *r_angle = 0.0f;
555
556   zero_v2(ref_pos);
557
558   ok = false;
559   weight_sum = 0.0f;
560   for (track = tracking->tracks.first; track; track = track->next) {
561     if (!is_init_for_stabilization(ctx, track)) {
562       continue;
563     }
564     if (track->flag & TRACK_USE_2D_STAB) {
565       float weight = 0.0f;
566       MovieTrackingMarker *marker = get_tracking_data_point(ctx, track, framenr, &weight);
567       if (marker) {
568         TrackStabilizationBase *stabilization_base = access_stabilization_baseline_data(ctx,
569                                                                                         track);
570         BLI_assert(stabilization_base != NULL);
571         float offset[2];
572         weight_sum += weight;
573         translation_contribution(stabilization_base, marker, offset);
574         r_translation[0] += weight * offset[0];
575         r_translation[1] += weight * offset[1];
576         ref_pos[0] += weight * marker->pos[0];
577         ref_pos[1] += weight * marker->pos[1];
578         ok |= (weight_sum > EPSILON_WEIGHT);
579       }
580     }
581   }
582   if (!ok) {
583     return false;
584   }
585
586   ref_pos[0] /= weight_sum;
587   ref_pos[1] /= weight_sum;
588   r_translation[0] /= weight_sum;
589   r_translation[1] /= weight_sum;
590   setup_pivot(ref_pos, r_pivot);
591
592   if (!(stab->flag & TRACKING_STABILIZE_ROTATION)) {
593     return ok;
594   }
595
596   ok = false;
597   weight_sum = 0.0f;
598   for (track = tracking->tracks.first; track; track = track->next) {
599     if (!is_init_for_stabilization(ctx, track)) {
600       continue;
601     }
602     if (track->flag & TRACK_USE_2D_STAB_ROT) {
603       float weight = 0.0f;
604       MovieTrackingMarker *marker = get_tracking_data_point(ctx, track, framenr, &weight);
605       if (marker) {
606         TrackStabilizationBase *stabilization_base = access_stabilization_baseline_data(ctx,
607                                                                                         track);
608         BLI_assert(stabilization_base != NULL);
609         float rotation, scale, quality;
610         quality = rotation_contribution(
611             stabilization_base, marker, aspect, r_pivot, &rotation, &scale);
612         weight *= quality;
613         weight_sum += weight;
614         *r_angle += rotation * weight;
615         if (stab->flag & TRACKING_STABILIZE_SCALE) {
616           *r_scale_step += logf(scale) * weight;
617         }
618         else {
619           *r_scale_step = 0;
620         }
621         ok |= (weight_sum > EPSILON_WEIGHT);
622       }
623     }
624   }
625   if (ok) {
626     *r_scale_step /= weight_sum;
627     *r_angle /= weight_sum;
628   }
629   else {
630     /* We reach this point because translation could be calculated,
631      * but rotation/scale found no data to work on.
632      */
633     *r_scale_step = 0.0f;
634     *r_angle = 0.0f;
635   }
636   return true;
637 }
638
639 /* Calculate weight center of location tracks for given frame.
640  * This function performs similar calculations as average_track_contributions(),
641  * but does not require the tracks to be initialized for stabilisation. Moreover,
642  * when there is no usable tracking data for the given frame number, data from
643  * a neighbouring frame is used. Thus this function can be used to calculate
644  * a starting point on initialization.
645  */
646 static void average_marker_positions(StabContext *ctx, int framenr, float r_ref_pos[2])
647 {
648   bool ok = false;
649   float weight_sum;
650   MovieTrackingTrack *track;
651   MovieTracking *tracking = ctx->tracking;
652
653   zero_v2(r_ref_pos);
654   weight_sum = 0.0f;
655   for (track = tracking->tracks.first; track; track = track->next) {
656     if (track->flag & TRACK_USE_2D_STAB) {
657       float weight = 0.0f;
658       MovieTrackingMarker *marker = get_tracking_data_point(ctx, track, framenr, &weight);
659       if (marker) {
660         weight_sum += weight;
661         r_ref_pos[0] += weight * marker->pos[0];
662         r_ref_pos[1] += weight * marker->pos[1];
663         ok |= (weight_sum > EPSILON_WEIGHT);
664       }
665     }
666   }
667   if (ok) {
668     r_ref_pos[0] /= weight_sum;
669     r_ref_pos[1] /= weight_sum;
670   }
671   else {
672     /* No usable tracking data on any track on this frame.
673      * Use data from neighbouring frames to extrapolate...
674      */
675     int next_lower = MINAFRAME;
676     int next_higher = MAXFRAME;
677     use_values_from_fcurves(ctx, true);
678     for (track = tracking->tracks.first; track; track = track->next) {
679       /* Note: we deliberately do not care if this track
680        *       is already initialized for stabilisation */
681       if (track->flag & TRACK_USE_2D_STAB) {
682         int startpoint = search_closest_marker_index(track, framenr);
683         retrieve_next_higher_usable_frame(ctx, track, startpoint, framenr, &next_higher);
684         retrieve_next_lower_usable_frame(ctx, track, startpoint, framenr, &next_lower);
685       }
686     }
687     if (next_lower >= MINFRAME) {
688       /* use next usable frame to the left.
689        * Also default to this frame when we're in a gap */
690       average_marker_positions(ctx, next_lower, r_ref_pos);
691     }
692     else if (next_higher < MAXFRAME) {
693       average_marker_positions(ctx, next_higher, r_ref_pos);
694     }
695     use_values_from_fcurves(ctx, false);
696   }
697 }
698
699 /* Linear interpolation of data retrieved at two measurement points.
700  * This function is used to fill gaps in the middle of the covered area,
701  * at frames without any usable tracks for stabilization.
702  *
703  * framenr is a position to interpolate for.
704  * frame_a is a valid measurement point below framenr
705  * frame_b is a valid measurement point above framenr
706  * Returns truth if both measurements could actually be retrieved.
707  * Otherwise output parameters remain unaltered
708  */
709 static bool interpolate_averaged_track_contributions(StabContext *ctx,
710                                                      int framenr,
711                                                      int frame_a,
712                                                      int frame_b,
713                                                      const float aspect,
714                                                      float r_translation[2],
715                                                      float r_pivot[2],
716                                                      float *r_angle,
717                                                      float *r_scale_step)
718 {
719   float t, s;
720   float trans_a[2], trans_b[2];
721   float angle_a, angle_b;
722   float scale_a, scale_b;
723   float pivot_a[2], pivot_b[2];
724   bool success = false;
725
726   BLI_assert(frame_a <= frame_b);
727   BLI_assert(frame_a <= framenr);
728   BLI_assert(framenr <= frame_b);
729
730   t = ((float)framenr - frame_a) / (frame_b - frame_a);
731   s = 1.0f - t;
732
733   success = average_track_contributions(
734       ctx, frame_a, aspect, trans_a, pivot_a, &angle_a, &scale_a);
735   if (!success) {
736     return false;
737   }
738   success = average_track_contributions(
739       ctx, frame_b, aspect, trans_b, pivot_b, &angle_b, &scale_b);
740   if (!success) {
741     return false;
742   }
743
744   interp_v2_v2v2(r_translation, trans_a, trans_b, t);
745   interp_v2_v2v2(r_pivot, pivot_a, pivot_b, t);
746   *r_scale_step = s * scale_a + t * scale_b;
747   *r_angle = s * angle_a + t * angle_b;
748   return true;
749 }
750
751 /* Reorder tracks starting with those providing a tracking data frame
752  * closest to the global anchor_frame. Tracks with a gap at anchor_frame or
753  * starting farer away from anchor_frame altogether will be visited later.
754  * This allows to build up baseline contributions incrementally.
755  *
756  * order is an array for sorting the tracks. Must be of suitable size to hold
757  * all tracks.
758  * Returns number of actually usable tracks, can be less than the overall number
759  * of tracks.
760  *
761  * NOTE: After returning, the order array holds entries up to the number of
762  *       usable tracks, appropriately sorted starting with the closest tracks.
763  *       Initialization includes disabled tracks, since they might be enabled
764  *       through automation later.
765  */
766 static int establish_track_initialization_order(StabContext *ctx, TrackInitOrder *order)
767 {
768   size_t tracknr = 0;
769   MovieTrackingTrack *track;
770   MovieTracking *tracking = ctx->tracking;
771   int anchor_frame = tracking->stabilization.anchor_frame;
772
773   for (track = tracking->tracks.first; track != NULL; track = track->next) {
774     MovieTrackingMarker *marker;
775     order[tracknr].data = track;
776     marker = get_closest_marker(ctx, track, anchor_frame);
777     if (marker != NULL && (track->flag & (TRACK_USE_2D_STAB | TRACK_USE_2D_STAB_ROT))) {
778       order[tracknr].sort_value = abs(marker->framenr - anchor_frame);
779       order[tracknr].reference_frame = marker->framenr;
780       ++tracknr;
781     }
782   }
783   if (tracknr) {
784     qsort(order, tracknr, sizeof(TrackInitOrder), BLI_sortutil_cmp_int);
785   }
786   return tracknr;
787 }
788
789 /* Setup the constant part of this track's contribution to the determined frame
790  * movement. Tracks usually don't provide tracking data for every frame. Thus,
791  * for determining data at a given frame, we split up the contribution into a
792  * part covered by actual measurements on this track, and the initial gap
793  * between this track's reference frame and the global anchor_frame.
794  * The (missing) data for the gap can be substituted by the average offset
795  * observed by the other tracks covering the gap. This approximation doesn't
796  * introduce wrong data, but it records data with incorrect weight. A totally
797  * correct solution would require us to average the contribution per frame, and
798  * then integrate stepwise over all frames -- which of course would be way more
799  * expensive, especially for longer clips. To the contrary, our solution
800  * cumulates the total contribution per track and averages afterwards over all
801  * tracks; it can thus be calculated just based on the data of a single frame,
802  * plus the "baseline" for the reference frame, which is what we are computing
803  * here.
804  *
805  * Since we're averaging _contributions_, we have to calculate the _difference_
806  * of the measured position at current frame and the position at the reference
807  * frame. But the "reference" part of this difference is constant and can thus
808  * be packed together with the baseline contribution into a single precomputed
809  * vector per track.
810  *
811  * In case of the rotation contribution, the principle is the same, but we have
812  * to compensate for the already determined translation and measure the pure
813  * rotation, simply because this is how we model the offset: shift plus rotation
814  * around the shifted rotation center. To circumvent problems with the
815  * definition range of the arcus tangens function, we perform this baseline
816  * addition and reference angle subtraction in polar coordinates and bake this
817  * operation into a precomputed rotation matrix.
818  *
819  * track is a track to be initialized to initialize
820  * reference_frame is a local frame for this track, the closest pick to the
821  *                 global anchor_frame.
822  * aspect is a total aspect ratio of the undistorted image (includes fame and
823  *        pixel aspect).
824  * target_pos is a possibly animated target position as set by the user for
825  *            the reference_frame
826  * average_translation is a value observed by the _other_ tracks for the gap
827  *                     between reference_frame and anchor_frame. This
828  *                     average must not contain contributions of frames
829  *                     not yet initialized
830  * average_angle in a similar way, the rotation value observed by the
831  *               _other_ tracks.
832  * average_scale_step is an image scale factor observed on average by the other
833  *                    tracks for this frame. This value is recorded and
834  *                    averaged as logarithm. The recorded scale changes
835  *                    are damped for very small contributions, to limit
836  *                    the effect of probe points approaching the pivot
837  *                    too closely.
838  *
839  * NOTE: when done, this track is marked as initialized
840  */
841 static void initialize_track_for_stabilization(StabContext *ctx,
842                                                MovieTrackingTrack *track,
843                                                int reference_frame,
844                                                float aspect,
845                                                const float average_translation[2],
846                                                const float pivot[2],
847                                                const float average_angle,
848                                                const float average_scale_step)
849 {
850   float pos[2], angle, len;
851   TrackStabilizationBase *local_data = access_stabilization_baseline_data(ctx, track);
852   MovieTrackingMarker *marker = BKE_tracking_marker_get_exact(track, reference_frame);
853   /* Logic for initialization order ensures there *is* a marker on that
854    * very frame.
855    */
856   BLI_assert(marker != NULL);
857   BLI_assert(local_data != NULL);
858
859   /* Per track baseline value for translation. */
860   sub_v2_v2v2(local_data->stabilization_offset_base, average_translation, marker->pos);
861
862   /* Per track baseline value for rotation. */
863   sub_v2_v2v2(pos, marker->pos, pivot);
864
865   pos[0] *= aspect;
866   angle = average_angle - atan2f(pos[1], pos[0]);
867   angle_to_mat2(local_data->stabilization_rotation_base, angle);
868
869   /* Per track baseline value for zoom. */
870   len = len_v2(pos) + SCALE_ERROR_LIMIT_BIAS;
871   local_data->stabilization_scale_base = expf(average_scale_step) / len;
872
873   local_data->is_init_for_stabilization = true;
874 }
875
876 static void initialize_all_tracks(StabContext *ctx, float aspect)
877 {
878   size_t i, track_len = 0;
879   MovieClip *clip = ctx->clip;
880   MovieTracking *tracking = ctx->tracking;
881   MovieTrackingTrack *track;
882   TrackInitOrder *order;
883
884   /* Attempt to start initialization at anchor_frame.
885    * By definition, offset contribution is zero there.
886    */
887   int reference_frame = tracking->stabilization.anchor_frame;
888   float average_angle = 0, average_scale_step = 0;
889   float average_translation[2], average_pos[2], pivot[2];
890   zero_v2(average_translation);
891   zero_v2(pivot);
892
893   /* Initialize private working data. */
894   for (track = tracking->tracks.first; track != NULL; track = track->next) {
895     TrackStabilizationBase *local_data = access_stabilization_baseline_data(ctx, track);
896     if (!local_data) {
897       local_data = MEM_callocN(sizeof(TrackStabilizationBase),
898                                "2D stabilization per track baseline data");
899       attach_stabilization_baseline_data(ctx, track, local_data);
900     }
901     BLI_assert(local_data != NULL);
902     local_data->track_weight_curve = retrieve_track_weight_animation(clip, track);
903     local_data->is_init_for_stabilization = false;
904
905     ++track_len;
906   }
907   if (!track_len) {
908     return;
909   }
910
911   order = MEM_mallocN(track_len * sizeof(TrackInitOrder), "stabilization track order");
912   if (!order) {
913     return;
914   }
915
916   track_len = establish_track_initialization_order(ctx, order);
917   if (track_len == 0) {
918     goto cleanup;
919   }
920
921   /* starting point for pivot, before having initialized any track */
922   average_marker_positions(ctx, reference_frame, average_pos);
923   setup_pivot(average_pos, pivot);
924
925   for (i = 0; i < track_len; ++i) {
926     track = order[i].data;
927     if (reference_frame != order[i].reference_frame) {
928       reference_frame = order[i].reference_frame;
929       average_track_contributions(ctx,
930                                   reference_frame,
931                                   aspect,
932                                   average_translation,
933                                   pivot,
934                                   &average_angle,
935                                   &average_scale_step);
936     }
937     initialize_track_for_stabilization(ctx,
938                                        track,
939                                        reference_frame,
940                                        aspect,
941                                        average_translation,
942                                        pivot,
943                                        average_angle,
944                                        average_scale_step);
945   }
946
947 cleanup:
948   MEM_freeN(order);
949 }
950
951 /* Retrieve the measurement of frame movement by averaging contributions of
952  * active tracks.
953  *
954  * translation is a measurement in normalized 0..1 coordinates.
955  * angle is a measurement in radians -pi..+pi counter clockwise relative to
956  *       translation compensated frame center
957  * scale_step is a measurement of image scale changes, in logarithmic scale
958  *            (zero means scale == 1)
959  * Returns calculation enabled and all data retrieved as expected for this frame.
960  *
961  * NOTE: when returning `false`, output parameters are reset to neutral values.
962  */
963 static bool stabilization_determine_offset_for_frame(StabContext *ctx,
964                                                      int framenr,
965                                                      float aspect,
966                                                      float r_translation[2],
967                                                      float r_pivot[2],
968                                                      float *r_angle,
969                                                      float *r_scale_step)
970 {
971   bool success = false;
972
973   /* Early output if stabilization is disabled. */
974   if ((ctx->stab->flag & TRACKING_2D_STABILIZATION) == 0) {
975     zero_v2(r_translation);
976     *r_scale_step = 0.0f;
977     *r_angle = 0.0f;
978     return false;
979   }
980
981   success = average_track_contributions(
982       ctx, framenr, aspect, r_translation, r_pivot, r_angle, r_scale_step);
983   if (!success) {
984     /* Try to hold extrapolated settings beyond the definition range
985      * and to interpolate in gaps without any usable tracking data
986      * to prevent sudden jump to image zero position.
987      */
988     int next_lower = MINAFRAME;
989     int next_higher = MAXFRAME;
990     use_values_from_fcurves(ctx, true);
991     find_next_working_frames(ctx, framenr, &next_lower, &next_higher);
992     if (next_lower >= MINFRAME && next_higher < MAXFRAME) {
993       success = interpolate_averaged_track_contributions(ctx,
994                                                          framenr,
995                                                          next_lower,
996                                                          next_higher,
997                                                          aspect,
998                                                          r_translation,
999                                                          r_pivot,
1000                                                          r_angle,
1001                                                          r_scale_step);
1002     }
1003     else if (next_higher < MAXFRAME) {
1004       /* Before start of stabilized range: extrapolate start point
1005        * settings.
1006        */
1007       success = average_track_contributions(
1008           ctx, next_higher, aspect, r_translation, r_pivot, r_angle, r_scale_step);
1009     }
1010     else if (next_lower >= MINFRAME) {
1011       /* After end of stabilized range: extrapolate end point settings. */
1012       success = average_track_contributions(
1013           ctx, next_lower, aspect, r_translation, r_pivot, r_angle, r_scale_step);
1014     }
1015     use_values_from_fcurves(ctx, false);
1016   }
1017   return success;
1018 }
1019
1020 /* Calculate stabilization data (translation, scale and rotation) from given raw
1021  * measurements. Result is in absolute image dimensions (expanded image, square
1022  * pixels), includes automatic or manual scaling and compensates for a target
1023  * frame position, if given.
1024  *
1025  * size is a size of the expanded image, the width in pixels is size * aspect.
1026  * aspect is a ratio (width / height) of the effective canvas (square pixels).
1027  * do_compensate denotes whether to actually output values necessary to
1028  *               _compensate_ the determined frame movement.
1029  *               Otherwise, the effective target movement is returned.
1030  */
1031 static void stabilization_calculate_data(StabContext *ctx,
1032                                          int framenr,
1033                                          int size,
1034                                          float aspect,
1035                                          bool do_compensate,
1036                                          float scale_step,
1037                                          float r_translation[2],
1038                                          float r_pivot[2],
1039                                          float *r_scale,
1040                                          float *r_angle)
1041 {
1042   float target_pos[2], target_scale;
1043   float scaleinf = get_animated_scaleinf(ctx, framenr);
1044
1045   if (ctx->stab->flag & TRACKING_STABILIZE_SCALE) {
1046     *r_scale = expf(scale_step * scaleinf); /* Averaged in log scale */
1047   }
1048   else {
1049     *r_scale = 1.0f;
1050   }
1051
1052   mul_v2_fl(r_translation, get_animated_locinf(ctx, framenr));
1053   *r_angle *= get_animated_rotinf(ctx, framenr);
1054
1055   /* Compensate for a target frame position.
1056    * This allows to follow tracking / panning shots in a semi manual fashion,
1057    * when animating the settings for the target frame position.
1058    */
1059   get_animated_target_pos(ctx, framenr, target_pos);
1060   sub_v2_v2(r_translation, target_pos);
1061   *r_angle -= get_animated_target_rot(ctx, framenr);
1062   target_scale = get_animated_target_scale(ctx, framenr);
1063   if (target_scale != 0.0f) {
1064     *r_scale /= target_scale;
1065     /* target_scale is an expected/intended reference zoom value */
1066   }
1067
1068   /* Convert from relative to absolute coordinates, square pixels. */
1069   r_translation[0] *= (float)size * aspect;
1070   r_translation[1] *= (float)size;
1071   r_pivot[0] *= (float)size * aspect;
1072   r_pivot[1] *= (float)size;
1073
1074   /* Output measured data, or inverse of the measured values for
1075    * compensation?
1076    */
1077   if (do_compensate) {
1078     mul_v2_fl(r_translation, -1.0f);
1079     *r_angle *= -1.0f;
1080     if (*r_scale != 0.0f) {
1081       *r_scale = 1.0f / *r_scale;
1082     }
1083   }
1084 }
1085
1086 static void stabilization_data_to_mat4(float pixel_aspect,
1087                                        const float pivot[2],
1088                                        const float translation[2],
1089                                        float scale,
1090                                        float angle,
1091                                        float r_mat[4][4])
1092 {
1093   float translation_mat[4][4], rotation_mat[4][4], scale_mat[4][4], pivot_mat[4][4],
1094       inv_pivot_mat[4][4], aspect_mat[4][4], inv_aspect_mat[4][4];
1095   float scale_vector[3] = {scale, scale, 1.0f};
1096
1097   unit_m4(translation_mat);
1098   unit_m4(rotation_mat);
1099   unit_m4(scale_mat);
1100   unit_m4(aspect_mat);
1101   unit_m4(pivot_mat);
1102   unit_m4(inv_pivot_mat);
1103
1104   /* aspect ratio correction matrix */
1105   aspect_mat[0][0] /= pixel_aspect;
1106   invert_m4_m4(inv_aspect_mat, aspect_mat);
1107
1108   add_v2_v2(pivot_mat[3], pivot);
1109   sub_v2_v2(inv_pivot_mat[3], pivot);
1110
1111   size_to_mat4(scale_mat, scale_vector);      /* scale matrix */
1112   add_v2_v2(translation_mat[3], translation); /* translation matrix */
1113   rotate_m4(rotation_mat, 'Z', angle);        /* rotation matrix */
1114
1115   /* Compose transformation matrix. */
1116   mul_m4_series(r_mat,
1117                 aspect_mat,
1118                 translation_mat,
1119                 pivot_mat,
1120                 scale_mat,
1121                 rotation_mat,
1122                 inv_pivot_mat,
1123                 inv_aspect_mat);
1124 }
1125
1126 /* Calculate scale factor necessary to eliminate black image areas
1127  * caused by the compensating movements of the stabilizator.
1128  * This function visits every frame where stabilisation data is
1129  * available and determines the factor for this frame. The overall
1130  * largest factor found is returned as result.
1131  *
1132  * NOTE: all tracks need to be initialized before calling this function.
1133  */
1134 static float calculate_autoscale_factor(StabContext *ctx, int size, float aspect)
1135 {
1136   MovieTrackingStabilization *stab = ctx->stab;
1137   float pixel_aspect = ctx->tracking->camera.pixel_aspect;
1138   int height = size, width = aspect * size;
1139
1140   int sfra = INT_MAX, efra = INT_MIN, cfra;
1141   float scale = 1.0f, scale_step = 0.0f;
1142   MovieTrackingTrack *track;
1143
1144   /* Calculate maximal frame range of tracks where stabilization is active. */
1145   for (track = ctx->tracking->tracks.first; track; track = track->next) {
1146     if ((track->flag & TRACK_USE_2D_STAB) ||
1147         ((stab->flag & TRACKING_STABILIZE_ROTATION) && (track->flag & TRACK_USE_2D_STAB_ROT))) {
1148       int first_frame = track->markers[0].framenr;
1149       int last_frame = track->markers[track->markersnr - 1].framenr;
1150       sfra = min_ii(sfra, first_frame);
1151       efra = max_ii(efra, last_frame);
1152     }
1153   }
1154
1155   use_values_from_fcurves(ctx, true);
1156   for (cfra = sfra; cfra <= efra; cfra++) {
1157     float translation[2], pivot[2], angle, tmp_scale;
1158     float mat[4][4];
1159     const float points[4][2] = {{0.0f, 0.0f}, {0.0f, height}, {width, height}, {width, 0.0f}};
1160     const bool do_compensate = true;
1161     /* Calculate stabilization parameters for the current frame. */
1162     stabilization_determine_offset_for_frame(
1163         ctx, cfra, aspect, translation, pivot, &angle, &scale_step);
1164     stabilization_calculate_data(ctx,
1165                                  cfra,
1166                                  size,
1167                                  aspect,
1168                                  do_compensate,
1169                                  scale_step,
1170                                  translation,
1171                                  pivot,
1172                                  &tmp_scale,
1173                                  &angle);
1174     /* Compose transformation matrix. */
1175     /* NOTE: Here we operate in NON-COMPENSATED coordinates, meaning we have
1176      * to construct transformation matrix using proper pivot point.
1177      * Compensation for that will happen later on.
1178      */
1179     stabilization_data_to_mat4(pixel_aspect, pivot, translation, tmp_scale, angle, mat);
1180     /* Investigate the transformed border lines for this frame;
1181      * find out, where it cuts the original frame.
1182      */
1183     for (int edge_index = 0; edge_index < 4; edge_index++) {
1184       /* Calculate coordinates of stabilized frame edge points.
1185        * Use matrix multiplication here so we operate in homogeneous
1186        * coordinates.
1187        */
1188       float stable_edge_p1[3], stable_edge_p2[3];
1189       copy_v2_v2(stable_edge_p1, points[edge_index]);
1190       copy_v2_v2(stable_edge_p2, points[(edge_index + 1) % 4]);
1191       stable_edge_p1[2] = stable_edge_p2[2] = 0.0f;
1192       mul_m4_v3(mat, stable_edge_p1);
1193       mul_m4_v3(mat, stable_edge_p2);
1194       /* Now we iterate over all original frame corners (we call them
1195        * 'point' here) to see if there's black area between stabilized
1196        * frame edge and original point.
1197        */
1198       for (int point_index = 0; point_index < 4; point_index++) {
1199         const float point[3] = {points[point_index][0], points[point_index][1], 0.0f};
1200         /* Calculate vector which goes from first edge point to
1201          * second one.
1202          */
1203         float stable_edge_vec[3];
1204         sub_v3_v3v3(stable_edge_vec, stable_edge_p2, stable_edge_p1);
1205         /* Calculate vector which connects current frame point to
1206          * first edge point.
1207          */
1208         float point_to_edge_start_vec[3];
1209         sub_v3_v3v3(point_to_edge_start_vec, point, stable_edge_p1);
1210         /* Use this two vectors to check whether frame point is inside
1211          * of the stabilized frame or not.
1212          * If the point is inside, there is no black area happening
1213          * and no scaling required for it.
1214          */
1215         if (cross_v2v2(stable_edge_vec, point_to_edge_start_vec) >= 0.0f) {
1216           /* We are scaling around motion-compensated pivot point. */
1217           float scale_pivot[2];
1218           add_v2_v2v2(scale_pivot, pivot, translation);
1219           /* Calculate line which goes via `point` and parallel to
1220            * the stabilized frame edge. This line is coming via
1221            * `point` and `point2` at the end.
1222            */
1223           float point2[2];
1224           add_v2_v2v2(point2, point, stable_edge_vec);
1225           /* Calculate actual distance between pivot point and
1226            * the stabilized frame edge. Then calculate distance
1227            * between pivot point and line which goes via actual
1228            * corner and is parallel to the edge.
1229            *
1230            * Dividing one by another will give us required scale
1231            * factor to get rid of black areas.
1232            */
1233           float real_dist = dist_to_line_v2(scale_pivot, stable_edge_p1, stable_edge_p2);
1234           float required_dist = dist_to_line_v2(scale_pivot, point, point2);
1235           const float S = required_dist / real_dist;
1236           scale = max_ff(scale, S);
1237         }
1238       }
1239     }
1240   }
1241   if (stab->maxscale > 0.0f) {
1242     scale = min_ff(scale, stab->maxscale);
1243   }
1244   use_values_from_fcurves(ctx, false);
1245
1246   return scale;
1247 }
1248
1249 /* Prepare working data and determine reference point for each track.
1250  *
1251  * NOTE: These calculations _could_ be cached and reused for all frames of the
1252  *       same clip. However, since proper initialization depends on (weight)
1253  *       animation and setup of tracks, ensuring consistency of cached init data
1254  *       turns out to be tricky, hard to maintain and generally not worth the
1255  *       effort. Thus we'll re-initialize on every frame.
1256  */
1257 static StabContext *init_stabilizer(MovieClip *clip, int size, float aspect)
1258 {
1259   StabContext *ctx = initialize_stabilization_working_context(clip);
1260   BLI_assert(ctx != NULL);
1261   initialize_all_tracks(ctx, aspect);
1262   if (ctx->stab->flag & TRACKING_AUTOSCALE) {
1263     ctx->stab->scale = 1.0;
1264     ctx->stab->scale = calculate_autoscale_factor(ctx, size, aspect);
1265   }
1266   /* By default, just use values for the global current frame. */
1267   use_values_from_fcurves(ctx, false);
1268   return ctx;
1269 }
1270
1271 /* === public interface functions === */
1272
1273 /* Get stabilization data (translation, scaling and angle) for a given frame.
1274  * Returned data describes how to compensate the detected movement, but with any
1275  * chosen scale factor already applied and any target frame position already
1276  * compensated. In case stabilization fails or is disabled, neutral values are
1277  * returned.
1278  *
1279  * framenr is a frame number, relative to the clip (not relative to the scene
1280  *         timeline)
1281  * width is an effective width of the canvas (square pixels), used to scale the
1282  *       determined translation
1283  *
1284  * Outputs:
1285  * - translation of the lateral shift, absolute canvas coordinates
1286  *   (square pixels).
1287  * - scale of the scaling to apply
1288  * - angle of the rotation angle, relative to the frame center
1289  */
1290 /* TODO(sergey): Use r_ prefix for output parameters here. */
1291 void BKE_tracking_stabilization_data_get(MovieClip *clip,
1292                                          int framenr,
1293                                          int width,
1294                                          int height,
1295                                          float translation[2],
1296                                          float *scale,
1297                                          float *angle)
1298 {
1299   StabContext *ctx = NULL;
1300   MovieTracking *tracking = &clip->tracking;
1301   bool enabled = (tracking->stabilization.flag & TRACKING_2D_STABILIZATION);
1302   /* Might become a parameter of a stabilization compositor node. */
1303   bool do_compensate = true;
1304   float scale_step = 0.0f;
1305   float pixel_aspect = tracking->camera.pixel_aspect;
1306   float aspect = (float)width * pixel_aspect / height;
1307   int size = height;
1308   float pivot[2];
1309
1310   if (enabled) {
1311     ctx = init_stabilizer(clip, size, aspect);
1312   }
1313
1314   if (enabled && stabilization_determine_offset_for_frame(
1315                      ctx, framenr, aspect, translation, pivot, angle, &scale_step)) {
1316     stabilization_calculate_data(
1317         ctx, framenr, size, aspect, do_compensate, scale_step, translation, pivot, scale, angle);
1318     compensate_rotation_center(size, aspect, *angle, *scale, pivot, translation);
1319   }
1320   else {
1321     zero_v2(translation);
1322     *scale = 1.0f;
1323     *angle = 0.0f;
1324   }
1325   discard_stabilization_working_context(ctx);
1326 }
1327
1328 typedef void (*interpolation_func)(struct ImBuf *, struct ImBuf *, float, float, int, int);
1329
1330 typedef struct TrackingStabilizeFrameInterpolationData {
1331   ImBuf *ibuf;
1332   ImBuf *tmpibuf;
1333   float (*mat)[4];
1334
1335   interpolation_func interpolation;
1336 } TrackingStabilizeFrameInterpolationData;
1337
1338 static void tracking_stabilize_frame_interpolation_cb(
1339     void *__restrict userdata, const int j, const ParallelRangeTLS *__restrict UNUSED(tls))
1340 {
1341   TrackingStabilizeFrameInterpolationData *data = userdata;
1342   ImBuf *ibuf = data->ibuf;
1343   ImBuf *tmpibuf = data->tmpibuf;
1344   float(*mat)[4] = data->mat;
1345
1346   interpolation_func interpolation = data->interpolation;
1347
1348   for (int i = 0; i < tmpibuf->x; i++) {
1349     float vec[3] = {i, j, 0.0f};
1350
1351     mul_v3_m4v3(vec, mat, vec);
1352
1353     interpolation(ibuf, tmpibuf, vec[0], vec[1], i, j);
1354   }
1355 }
1356
1357 /* Stabilize given image buffer using stabilization data for a specified
1358  * frame number.
1359  *
1360  * NOTE: frame number should be in clip space, not scene space.
1361  */
1362 /* TODO(sergey): Use r_ prefix for output parameters here. */
1363 ImBuf *BKE_tracking_stabilize_frame(
1364     MovieClip *clip, int framenr, ImBuf *ibuf, float translation[2], float *scale, float *angle)
1365 {
1366   float tloc[2], tscale, tangle;
1367   MovieTracking *tracking = &clip->tracking;
1368   MovieTrackingStabilization *stab = &tracking->stabilization;
1369   ImBuf *tmpibuf;
1370   int width = ibuf->x, height = ibuf->y;
1371   float pixel_aspect = tracking->camera.pixel_aspect;
1372   float mat[4][4];
1373   int filter = tracking->stabilization.filter;
1374   interpolation_func interpolation = NULL;
1375   int ibuf_flags;
1376
1377   if (translation)
1378     copy_v2_v2(tloc, translation);
1379
1380   if (scale)
1381     tscale = *scale;
1382
1383   /* Perform early output if no stabilization is used. */
1384   if ((stab->flag & TRACKING_2D_STABILIZATION) == 0) {
1385     if (translation)
1386       zero_v2(translation);
1387
1388     if (scale)
1389       *scale = 1.0f;
1390
1391     if (angle)
1392       *angle = 0.0f;
1393
1394     return ibuf;
1395   }
1396
1397   /* Allocate frame for stabilization result. */
1398   ibuf_flags = 0;
1399   if (ibuf->rect)
1400     ibuf_flags |= IB_rect;
1401   if (ibuf->rect_float)
1402     ibuf_flags |= IB_rectfloat;
1403
1404   tmpibuf = IMB_allocImBuf(ibuf->x, ibuf->y, ibuf->planes, ibuf_flags);
1405
1406   /* Calculate stabilization matrix. */
1407   BKE_tracking_stabilization_data_get(clip, framenr, width, height, tloc, &tscale, &tangle);
1408   BKE_tracking_stabilization_data_to_mat4(
1409       ibuf->x, ibuf->y, pixel_aspect, tloc, tscale, tangle, mat);
1410
1411   /* The following code visits each nominal target grid position
1412    * and picks interpolated data "backwards" from source.
1413    * thus we need the inverse of the transformation to apply. */
1414   invert_m4(mat);
1415
1416   if (filter == TRACKING_FILTER_NEAREST)
1417     interpolation = nearest_interpolation;
1418   else if (filter == TRACKING_FILTER_BILINEAR)
1419     interpolation = bilinear_interpolation;
1420   else if (filter == TRACKING_FILTER_BICUBIC)
1421     interpolation = bicubic_interpolation;
1422   else
1423     /* fallback to default interpolation method */
1424     interpolation = nearest_interpolation;
1425
1426   TrackingStabilizeFrameInterpolationData data = {
1427       .ibuf = ibuf,
1428       .tmpibuf = tmpibuf,
1429       .mat = mat,
1430       .interpolation = interpolation,
1431   };
1432
1433   ParallelRangeSettings settings;
1434   BLI_parallel_range_settings_defaults(&settings);
1435   settings.use_threading = (tmpibuf->y > 128);
1436   BLI_task_parallel_range(
1437       0, tmpibuf->y, &data, tracking_stabilize_frame_interpolation_cb, &settings);
1438
1439   if (tmpibuf->rect_float)
1440     tmpibuf->userflags |= IB_RECT_INVALID;
1441
1442   if (translation)
1443     copy_v2_v2(translation, tloc);
1444
1445   if (scale)
1446     *scale = tscale;
1447
1448   if (angle)
1449     *angle = tangle;
1450
1451   return tmpibuf;
1452 }
1453
1454 /* Build a 4x4 transformation matrix based on the given 2D stabilization data.
1455  * mat is a 4x4 matrix in homogeneous coordinates, adapted to the
1456  *     final image buffer size and compensated for pixel aspect ratio,
1457  *     ready for direct OpenGL drawing.
1458  *
1459  * TODO(sergey): The signature of this function should be changed. we actually
1460  *               don't need the dimensions of the image buffer. Instead we
1461  *               should consider to provide the pivot point of the rotation as a
1462  *               further stabilization data parameter.
1463  */
1464 void BKE_tracking_stabilization_data_to_mat4(int buffer_width,
1465                                              int buffer_height,
1466                                              float pixel_aspect,
1467                                              float translation[2],
1468                                              float scale,
1469                                              float angle,
1470                                              float r_mat[4][4])
1471 {
1472   /* Since we cannot receive the real pivot point coordinates (API limitation),
1473    * we perform the rotation/scale around the center of frame.
1474    * Then we correct by an additional shift, which was calculated in
1475    * compensate_rotation_center() and "sneaked in" as additional offset
1476    * in the translation parameter. This works, since translation needs to be
1477    * applied after rotation/scale anyway. Thus effectively the image gets
1478    * rotated around the desired pivot point
1479    */
1480   /* TODO(sergey) pivot shouldn't be calculated here, rather received
1481    * as a parameter.
1482    */
1483   float pivot[2];
1484   pivot[0] = 0.5f * pixel_aspect * buffer_width;
1485   pivot[1] = 0.5f * buffer_height;
1486   /* Compose transformation matrix. */
1487   stabilization_data_to_mat4(pixel_aspect, pivot, translation, scale, angle, r_mat);
1488 }