Cleanup: More proper sections in tracking code

Follows the code style

2 files changed, 92 insertions, 28 deletions

diff --git a/source/blender/blenkernel/BKE_tracking.h b/source/blender/blenkernel/BKE_tracking.h
index 29eb180a2ab..2d115cfb351 100644
--- a/source/blender/blenkernel/BKE_tracking.h
+++ b/source/blender/blenkernel/BKE_tracking.h
@@ -28,7 +28,9 @@ struct Scene;
 struct bGPDlayer;
 struct rcti;
 
-/* **** Common functions **** */
+/* --------------------------------------------------------------------
+ * Common functions.
+ */
 
 /**
  * Free tracking structure, only frees structure contents
@@ -84,7 +86,10 @@ void BKE_tracking_get_projection_matrix(struct MovieTracking *tracking,
                                         int winy,
                                         float mat[4][4]);
 
-/* **** Clipboard **** */
+/* --------------------------------------------------------------------
+ * Clipboard.
+ */
+
 /**
  * Free clipboard by freeing memory used by all tracks in it.
  */
@@ -240,7 +245,9 @@ float BKE_tracking_track_get_weight_for_marker(struct MovieClip *clip,
                                                struct MovieTrackingTrack *track,
                                                struct MovieTrackingMarker *marker);
 
-/* Selection */
+/* --------------------------------------------------------------------
+ * Selection.
+ */
 
 /**
  * \param area: which part of marker should be selected. see TRACK_AREA_* constants.
@@ -252,7 +259,10 @@ void BKE_tracking_track_select(struct ListBase *tracksbase,
 void BKE_tracking_track_deselect(struct MovieTrackingTrack *track, int area);
 void BKE_tracking_tracks_deselect_all(struct ListBase *tracksbase);
 
-/* **** Marker **** */
+/* --------------------------------------------------------------------
+ * Marker.
+ */
+
 struct MovieTrackingMarker *BKE_tracking_marker_insert(struct MovieTrackingTrack *track,
                                                        struct MovieTrackingMarker *marker);
 void BKE_tracking_marker_delete(struct MovieTrackingTrack *track, int framenr);
@@ -296,7 +306,10 @@ void BKE_tracking_marker_get_subframe_position(struct MovieTrackingTrack *track,
                                                float framenr,
                                                float pos[2]);
 
-/* **** Plane Track **** */
+/* --------------------------------------------------------------------
+ * Plane track.
+ */
+
 /**
  * Creates new plane track out of selected point tracks.
  */
@@ -342,7 +355,10 @@ void BKE_tracking_plane_tracks_replace_point_track(struct MovieTracking *trackin
                                                    struct MovieTrackingTrack *old_track,
                                                    struct MovieTrackingTrack *new_track);
 
-/* **** Plane Marker **** */
+/* --------------------------------------------------------------------
+ * Plane marker.
+ */
+
 struct MovieTrackingPlaneMarker *BKE_tracking_plane_marker_insert(
     struct MovieTrackingPlaneTrack *plane_track, struct MovieTrackingPlaneMarker *plane_marker);
 void BKE_tracking_plane_marker_delete(struct MovieTrackingPlaneTrack *plane_track, int framenr);
@@ -368,7 +384,10 @@ void BKE_tracking_plane_marker_get_subframe_corners(struct MovieTrackingPlaneTra
                                                     float framenr,
                                                     float corners[4][2]);
 
-/* **** Object **** */
+/* --------------------------------------------------------------------
+ * Object.
+ */
+
 struct MovieTrackingObject *BKE_tracking_object_add(struct MovieTracking *tracking,
                                                     const char *name);
 bool BKE_tracking_object_delete(struct MovieTracking *tracking,
@@ -390,7 +409,10 @@ struct ListBase *BKE_tracking_object_get_plane_tracks(struct MovieTracking *trac
 struct MovieTrackingReconstruction *BKE_tracking_object_get_reconstruction(
     struct MovieTracking *tracking, struct MovieTrackingObject *object);
 
-/* **** Camera **** */
+/* --------------------------------------------------------------------
+ * Camera.
+ */
+
 /**
  * Converts principal offset from center to offset of blender's camera.
  */
@@ -409,7 +431,10 @@ void BKE_tracking_camera_get_reconstructed_interpolate(struct MovieTracking *tra
                                                        float framenr,
                                                        float mat[4][4]);
 
-/* **** Distortion/Undistortion **** */
+/* --------------------------------------------------------------------
+ * (Un)distortion.
+ */
+
 struct MovieDistortion *BKE_tracking_distortion_new(struct MovieTracking *tracking,
                                                     int calibration_width,
                                                     int calibration_height);
@@ -463,7 +488,10 @@ void BKE_tracking_max_distortion_delta_across_bound(struct MovieTracking *tracki
                                                     bool undistort,
                                                     float delta[2]);
 
-/* **** Image sampling **** */
+/* --------------------------------------------------------------------
+ * Image sampling.
+ */
+
 struct ImBuf *BKE_tracking_sample_pattern(int frame_width,
                                           int frame_height,
                                           struct ImBuf *search_ib,
@@ -493,7 +521,9 @@ struct ImBuf *BKE_tracking_get_search_imbuf(struct ImBuf *ibuf,
 void BKE_tracking_disable_channels(
     struct ImBuf *ibuf, bool disable_red, bool disable_green, bool disable_blue, bool grayscale);
 
-/* **** 2D tracking **** */
+/* --------------------------------------------------------------------
+ * 2D tracking.
+ */
 
 /**
  * Refine marker's position using previously known keyframe.
@@ -505,7 +535,9 @@ void BKE_tracking_refine_marker(struct MovieClip *clip,
                                 struct MovieTrackingMarker *marker,
                                 bool backwards);
 
-/* *** 2D auto track  *** */
+/* --------------------------------------------------------------------
+ * 2D tracking using auto-track pipeline.
+ */
 
 struct AutoTrackContext *BKE_autotrack_context_new(struct MovieClip *clip,
                                                    struct MovieClipUser *user,
@@ -517,7 +549,9 @@ void BKE_autotrack_context_sync_user(struct AutoTrackContext *context, struct Mo
 void BKE_autotrack_context_finish(struct AutoTrackContext *context);
 void BKE_autotrack_context_free(struct AutoTrackContext *context);
 
-/* **** Plane tracking **** */
+/* --------------------------------------------------------------------
+ * Plane tracking.
+ */
 
 /**
  * \note frame number should be in clip space, not scene space.
@@ -530,7 +564,9 @@ void BKE_tracking_homography_between_two_quads(/*const*/ float reference_corners
                                                /*const*/ float corners[4][2],
                                                float H[3][3]);
 
-/* **** Camera solving **** */
+/* --------------------------------------------------------------------
+ * Camera solving.
+ */
 
 /**
  * Perform early check on whether everything is fine to start reconstruction.
@@ -617,7 +653,9 @@ void BKE_tracking_detect_harris(struct MovieTracking *tracking,
                                 struct bGPDlayer *layer,
                                 bool place_outside_layer);
 
-/* **** 2D stabilization **** */
+/* --------------------------------------------------------------------
+ * 2D stabilization.
+ */
 
 /**
  * Get stabilization data (translation, scaling and angle) for a given frame.
@@ -686,7 +724,9 @@ void BKE_tracking_dopesheet_tag_update(struct MovieTracking *tracking);
  */
 void BKE_tracking_dopesheet_update(struct MovieTracking *tracking);
 
-/* **** Query/search **** */
+/* --------------------------------------------------------------------
+ * Query and search.
+ */
 
 /**
  * \note Returns NULL if the track comes from camera object,.
@@ -722,7 +762,9 @@ void BKE_tracking_get_rna_path_prefix_for_plane_track(
     char *rna_path,
     size_t rna_path_len);
 
-/* **** Utility macros **** */
+/* --------------------------------------------------------------------
+ * Utility macros.
+ */
 
 #define TRACK_SELECTED(track) \
   ((track)->flag & SELECT || (track)->pat_flag & SELECT || (track)->search_flag & SELECT)
diff --git a/source/blender/blenkernel/intern/tracking.c b/source/blender/blenkernel/intern/tracking.c
index 348d6a91eb8..9a052d7cb60 100644
--- a/source/blender/blenkernel/intern/tracking.c
+++ b/source/blender/blenkernel/intern/tracking.c
@@ -60,7 +60,9 @@ static struct {
   ListBase tracks;
 } tracking_clipboard;
 
-/*********************** Common functions *************************/
+/* --------------------------------------------------------------------
+ * Common functions.
+ */
 
 /* Free the whole list of tracks, list's head and tail are set to NULL. */
 static void tracking_tracks_free(ListBase *tracks)
@@ -435,7 +437,9 @@ void BKE_tracking_get_projection_matrix(MovieTracking *tracking,
   }
 }
 
-/*********************** clipboard *************************/
+/* --------------------------------------------------------------------
+ * Clipboard.
+ */
 
 void BKE_tracking_clipboard_free(void)
 {
@@ -496,7 +500,9 @@ void BKE_tracking_clipboard_paste_tracks(MovieTracking *tracking, MovieTrackingO
   }
 }
 
-/*********************** Tracks *************************/
+/* --------------------------------------------------------------------
+ * Tracks.
+ */
 
 MovieTrackingTrack *BKE_tracking_track_add_empty(MovieTracking *tracking, ListBase *tracks_list)
 {
@@ -1276,7 +1282,9 @@ void BKE_tracking_tracks_deselect_all(ListBase *tracksbase)
   }
 }
 
-/*********************** Marker *************************/
+/* --------------------------------------------------------------------
+ * Marker.
+ */
 
 MovieTrackingMarker *BKE_tracking_marker_insert(MovieTrackingTrack *track,
                                                 MovieTrackingMarker *marker)
@@ -1591,7 +1599,9 @@ void BKE_tracking_marker_get_subframe_position(MovieTrackingTrack *track,
   add_v2_v2(pos, track->offset);
 }
 
-/*********************** Plane Track *************************/
+/* --------------------------------------------------------------------
+ * Plane track.
+ */
 
 MovieTrackingPlaneTrack *BKE_tracking_plane_track_add(MovieTracking *tracking,
                                                       ListBase *plane_tracks_base,
@@ -1796,7 +1806,9 @@ void BKE_tracking_plane_tracks_replace_point_track(MovieTracking *tracking,
   }
 }
 
-/*********************** Plane Marker *************************/
+/* --------------------------------------------------------------------
+ * Plane marker.
+ */
 
 MovieTrackingPlaneMarker *BKE_tracking_plane_marker_insert(MovieTrackingPlaneTrack *plane_track,
                                                            MovieTrackingPlaneMarker *plane_marker)
@@ -1974,7 +1986,9 @@ void BKE_tracking_plane_marker_get_subframe_corners(MovieTrackingPlaneTrack *pla
   }
 }
 
-/*********************** Object *************************/
+/* --------------------------------------------------------------------
+ * Object.
+ */
 
 MovieTrackingObject *BKE_tracking_object_add(MovieTracking *tracking, const char *name)
 {
@@ -2119,7 +2133,9 @@ MovieTrackingReconstruction *BKE_tracking_object_get_reconstruction(MovieTrackin
   return &object->reconstruction;
 }
 
-/*********************** Camera *************************/
+/* --------------------------------------------------------------------
+ * Camera.
+ */
 
 static int reconstructed_camera_index_get(MovieTrackingReconstruction *reconstruction,
                                           int framenr,
@@ -2275,7 +2291,9 @@ void BKE_tracking_camera_get_reconstructed_interpolate(MovieTracking *tracking,
   reconstructed_camera_scale_set(object, mat);
 }
 
-/*********************** Distortion/Undistortion *************************/
+/* --------------------------------------------------------------------
+ * (Un)distortion.
+ */
 
 MovieDistortion *BKE_tracking_distortion_new(MovieTracking *tracking,
                                              int calibration_width,
@@ -2588,7 +2606,9 @@ void BKE_tracking_max_distortion_delta_across_bound(MovieTracking *tracking,
   }
 }
 
-/*********************** Image sampling *************************/
+/* --------------------------------------------------------------------
+ * Image sampling.
+ */
 
 static void disable_imbuf_channels(ImBuf *ibuf, MovieTrackingTrack *track, bool grayscale)
 {
@@ -2832,7 +2852,9 @@ void BKE_tracking_disable_channels(
   }
 }
 
-/*********************** Dopesheet functions *************************/
+/* --------------------------------------------------------------------
+ * Dopesheet functions.
+ */
 
 /* ** Channels sort comparators ** */