# HG changeset patch
# User gpoirier
# Date 1175380783 0
# Node ID e511820c4a9708bc07239587f412fbe0aeebe51b
# Parent  460afa3ac88996c9f82629e02e07d23a244f4847
Add doxy comments, based on Loren's explanations posted here:
Date: Mar 30, 2007 9:00 PM
Subject: Re: [Ffmpeg-devel] Motion Estimation in snow.c for Waevelet encoded frames (DWT)

diff -r 460afa3ac889 -r e511820c4a97 motion_est.c
--- a/motion_est.c	Sat Mar 31 17:24:53 2007 +0000
+++ b/motion_est.c	Sat Mar 31 22:39:43 2007 +0000
@@ -103,6 +103,9 @@
            + (chroma ? FLAG_CHROMA : 0);
 }
 
+/*! \brief compares two blocks, which may be full macroblocks or may be
+    partitions thereof.
+ */
 static av_always_inline int cmp(MpegEncContext *s, const int x, const int y, const int subx, const int suby,
                       const int size, const int h, int ref_index, int src_index,
                       me_cmp_func cmp_func, me_cmp_func chroma_cmp_func, const int flags){
diff -r 460afa3ac889 -r e511820c4a97 motion_est_template.c
--- a/motion_est_template.c	Sat Mar 31 17:24:53 2007 +0000
+++ b/motion_est_template.c	Sat Mar 31 22:39:43 2007 +0000
@@ -991,13 +991,24 @@
         return   var_diamond_search(s, best, dmin, src_index, ref_index, penalty_factor, size, h, flags);
 }
 
+/*!
+   \param P[10][2] a list of candidate mvs to check before starting the
+   iterative search. If one of the candidates is close to the optimal mv, then
+   it takes fewer iterations. And it increases the chance that we find the
+   optimal mv.
+ */
 static av_always_inline int epzs_motion_search_internal(MpegEncContext * s, int *mx_ptr, int *my_ptr,
                              int P[10][2], int src_index, int ref_index, int16_t (*last_mv)[2],
                              int ref_mv_scale, int flags, int size, int h)
 {
     MotionEstContext * const c= &s->me;
-    int best[2]={0, 0};
-    int d, dmin;
+    int best[2]={0, 0};      /*!< x and y coordinates of the best motion vector.
+                               i.e. the difference between the position of the
+                               block current being encoded and the position of
+                               the block chosen to predict it from. */
+    int d;                   ///< the score (cmp + penalty) of any given mv
+    int dmin;                /*!< the best value of d, i.e. the score
+                               corresponding to the mv stored in best[]. */
     int map_generation;
     int penalty_factor;
     const int ref_mv_stride= s->mb_stride; //pass as arg  FIXME
diff -r 460afa3ac889 -r e511820c4a97 mpegvideo.h
--- a/mpegvideo.h	Sat Mar 31 17:24:53 2007 +0000
+++ b/mpegvideo.h	Sat Mar 31 22:39:43 2007 +0000
@@ -162,7 +162,11 @@
     uint32_t *score_map;               ///< map to store the scores
     int map_generation;
     int pre_penalty_factor;
-    int penalty_factor;
+    int penalty_factor;                /*!< an estimate of the bits required to
+                                        code a given mv value, e.g. (1,0) takes
+                                        more bits than (0,0). We have to
+                                        estimate whether any reduction in
+                                        residual is worth the extra bits. */
     int sub_penalty_factor;
     int mb_penalty_factor;
     int flags;