motion_val doxy

Originally committed as revision 3776 to svn://svn.ffmpeg.org/ffmpeg/trunk
2004-12-29 12:14:14 +00:00 · 2004-12-29 12:14:14 +00:00 · 6143607303
parent 5ad984c997
commit 6143607303
1 changed files with 8 additions and 1 deletions
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@ -476,7 +476,14 @@ typedef struct AVPanScan{
    uint8_t *mbskip_table;\
 \
    /**\
-     * Motion vector table\
+     * Motion vector table.\
+     * @code\
+     * example:\
+     * int mv_sample_log2= 4 - motion_subsample_log2;\
+     * int mb_width= (width+15)>>4;\
+     * int mv_stride= (mb_width << mv_sample_log2) + 1;\
+     * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
+     * @endcode\
     * - encoding: set by user\
     * - decoding: set by lavc\
     */\