[Bf-blender-cvs] [6fba2726c77] master: Tracking: Cleanup, finish pass of comments in the context

[Sergey Sharybin]

Commit: 6fba2726c77167f8a4746312cb0d522fd43e4c63
Author: Sergey Sharybin
Date:   Mon Nov 30 14:48:48 2020 +0100
Branches: master
https://developer.blender.org/rB6fba2726c77167f8a4746312cb0d522fd43e4c63

Tracking: Cleanup, finish pass of comments in the context

Some fields are still not really documented, but they are subject of
refactor/fix which will happen shortly.

===================================================================

M	source/blender/blenkernel/intern/tracking_auto.c

===================================================================

diff --git a/source/blender/blenkernel/intern/tracking_auto.c b/source/blender/blenkernel/intern/tracking_auto.c
index 995e25a1536..faa1f207788 100644
--- a/source/blender/blenkernel/intern/tracking_auto.c
+++ b/source/blender/blenkernel/intern/tracking_auto.c
@@ -91,11 +91,23 @@ typedef struct AutoTrackContext {
   int num_input_tracks;
   MovieTrackingTrack **input_tracks;
 
+  /* Dimensions of movie frame, in pixels.
+   *
+   * NOTE: All clips and frames within a clip are expected to have match3ed dimensions.
+   *
+   * TODO(sergey): Make it more flexible to fully support multiple-clip tracking. Could either be
+   * stored as a `pair<MovieClip, Dimensions>` or even be replaced with actual frame size access
+   * to support variadic frame dimensions. */
   int frame_width, frame_height;
 
-  struct libmv_AutoTrack *autotrack;
+  /* Accessor for images of clip. Used by the autotrack context. */
   TrackingImageAccessor *image_accessor;
 
+  /* Auto-track context.
+   *
+   * NOTE: Is accessed from multiple threads at once. */
+  struct libmv_AutoTrack *autotrack;
+
   AutoTrackOptions *track_options; /* Per-tracking track options. */
 
   int sync_frame;