diff mpegvideo.h @ 4757:e511820c4a97 libavcodec

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)
author gpoirier
date Sat, 31 Mar 2007 22:39:43 +0000
parents b3f099adfb36
children 522e52c630bd
line wrap: on
line diff
--- 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;