Tracking: Implement Nuke/Natron distortion model

Neither Nuke nor Natron support OpenCV's radial distortion model
which makes it impossible to have any kind of interoperability.

The new model is available under the distortion model menu in Lens
settings.

Differential Revision: https://developer.blender.org/D7484

4 files changed, 35 insertions, 0 deletions

diff --git a/source/blender/blenkernel/intern/movieclip.c b/source/blender/blenkernel/intern/movieclip.c
index 7991559d1ce..4c7b791f103 100644
--- a/source/blender/blenkernel/intern/movieclip.c
+++ b/source/blender/blenkernel/intern/movieclip.c
@@ -460,6 +460,7 @@ typedef struct MovieClipCache {
     float principal[2];
     float polynomial_k[3];
     float division_k[2];
+    float nuke_k[2];
     short distortion_model;
     bool undistortion_used;
 
@@ -908,6 +909,9 @@ static bool check_undistortion_cache_flags(const MovieClip *clip)
   if (!equals_v2v2(&camera->division_k1, cache->postprocessed.division_k)) {
     return false;
   }
+  if (!equals_v2v2(&camera->nuke_k1, cache->postprocessed.nuke_k)) {
+    return false;
+  }
 
   return true;
 }
@@ -1010,6 +1014,7 @@ static void put_postprocessed_frame_to_cache(
     copy_v2_v2(cache->postprocessed.principal, camera->principal);
     copy_v3_v3(cache->postprocessed.polynomial_k, &camera->k1);
     copy_v2_v2(cache->postprocessed.division_k, &camera->division_k1);
+    copy_v2_v2(cache->postprocessed.nuke_k, &camera->nuke_k1);
     cache->postprocessed.undistortion_used = true;
   }
   else {
diff --git a/source/blender/blenkernel/intern/tracking_util.c b/source/blender/blenkernel/intern/tracking_util.c
index 5f7452e4775..629c01ec298 100644
--- a/source/blender/blenkernel/intern/tracking_util.c
+++ b/source/blender/blenkernel/intern/tracking_util.c
@@ -451,6 +451,12 @@ static void distortion_model_parameters_from_tracking(
       camera_intrinsics_options->division_k1 = camera->division_k1;
       camera_intrinsics_options->division_k2 = camera->division_k2;
       return;
+
+    case TRACKING_DISTORTION_MODEL_NUKE:
+      camera_intrinsics_options->distortion_model = LIBMV_DISTORTION_MODEL_NUKE;
+      camera_intrinsics_options->nuke_k1 = camera->nuke_k1;
+      camera_intrinsics_options->nuke_k2 = camera->nuke_k2;
+      return;
   }
 
   /* Unknown distortion model, which might be due to opening newer file in older Blender.
@@ -479,6 +485,12 @@ static void distortion_model_parameters_from_options(
       camera->division_k1 = camera_intrinsics_options->division_k1;
       camera->division_k2 = camera_intrinsics_options->division_k2;
       return;
+
+    case LIBMV_DISTORTION_MODEL_NUKE:
+      camera->distortion_model = TRACKING_DISTORTION_MODEL_NUKE;
+      camera->nuke_k1 = camera_intrinsics_options->nuke_k1;
+      camera->nuke_k2 = camera_intrinsics_options->nuke_k2;
+      return;
   }
 
   /* Libmv returned distortion model which is not known to Blender. This is a logical error in code
diff --git a/source/blender/makesdna/DNA_tracking_types.h b/source/blender/makesdna/DNA_tracking_types.h
index ab9f3d07849..32a00cc25d1 100644
--- a/source/blender/makesdna/DNA_tracking_types.h
+++ b/source/blender/makesdna/DNA_tracking_types.h
@@ -70,6 +70,9 @@ typedef struct MovieTrackingCamera {
 
   /* Division distortion model coefficients */
   float division_k1, division_k2;
+
+  /* Nuke distortion model coefficients */
+  float nuke_k1, nuke_k2;
 } MovieTrackingCamera;
 
 typedef struct MovieTrackingMarker {
@@ -455,6 +458,7 @@ typedef struct MovieTracking {
 enum {
   TRACKING_DISTORTION_MODEL_POLYNOMIAL = 0,
   TRACKING_DISTORTION_MODEL_DIVISION = 1,
+  TRACKING_DISTORTION_MODEL_NUKE = 2,
 };
 
 /* MovieTrackingCamera->units */
diff --git a/source/blender/makesrna/intern/rna_tracking.c b/source/blender/makesrna/intern/rna_tracking.c
index 131c13c4d90..507d06482df 100644
--- a/source/blender/makesrna/intern/rna_tracking.c
+++ b/source/blender/makesrna/intern/rna_tracking.c
@@ -1149,6 +1149,7 @@ static void rna_def_trackingCamera(BlenderRNA *brna)
        "Divisions",
        "Division distortion model which "
        "better represents wide-angle cameras"},
+      {TRACKING_DISTORTION_MODEL_NUKE, "NUKE", 0, "Nuke", "Nuke distortion model"},
       {0, NULL, 0, NULL, NULL},
   };
 
@@ -1252,6 +1253,19 @@ static void rna_def_trackingCamera(BlenderRNA *brna)
   RNA_def_property_ui_text(prop, "K2", "First coefficient of second order division distortion");
   RNA_def_property_update(prop, NC_MOVIECLIP | NA_EDITED, "rna_tracking_flushUpdate");
 
+  /* Nuke distortion parameters */
+  prop = RNA_def_property(srna, "nuke_k1", PROP_FLOAT, PROP_NONE);
+  RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
+  RNA_def_property_ui_range(prop, -10, 10, 0.1, 3);
+  RNA_def_property_ui_text(prop, "K1", "First coefficient of second order Nuke distortion");
+  RNA_def_property_update(prop, NC_MOVIECLIP | NA_EDITED, "rna_tracking_flushUpdate");
+
+  prop = RNA_def_property(srna, "nuke_k2", PROP_FLOAT, PROP_NONE);
+  RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
+  RNA_def_property_ui_range(prop, -10, 10, 0.1, 3);
+  RNA_def_property_ui_text(prop, "K2", "Second coefficient of second order Nuke distortion");
+  RNA_def_property_update(prop, NC_MOVIECLIP | NA_EDITED, "rna_tracking_flushUpdate");
+
   /* pixel aspect */
   prop = RNA_def_property(srna, "pixel_aspect", PROP_FLOAT, PROP_XYZ);
   RNA_def_property_float_sdna(prop, NULL, "pixel_aspect");