From: Michael Niedermayer <michael@niedermayer.cc>
Date: Fri, 17 Jun 2016 19:24:06 +0000 (+0200)
Subject: avcodec/snow: Document BlockNode
X-Git-Tag: android-x86-7.1-r1~4857
X-Git-Url: http://git.osdn.net/view?a=commitdiff_plain;h=4efbeadadc6f5a107d5219cbd677b644e7cdca84;p=android-x86%2Fexternal-ffmpeg.git

avcodec/snow: Document BlockNode

Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
---

diff --git a/libavcodec/snow.h b/libavcodec/snow.h
index 00d7c4211d..59c710b5f9 100644
--- a/libavcodec/snow.h
+++ b/libavcodec/snow.h
@@ -48,14 +48,14 @@
 #define LOG2_OBMC_MAX 8
 #define OBMC_MAX (1<<(LOG2_OBMC_MAX))
 typedef struct BlockNode{
-    int16_t mx;
-    int16_t my;
-    uint8_t ref;
-    uint8_t color[3];
-    uint8_t type;
+    int16_t mx;                 ///< Motion vector component X, see mv_scale
+    int16_t my;                 ///< Motion vector component Y, see mv_scale
+    uint8_t ref;                ///< Reference frame index
+    uint8_t color[3];           ///< Color for intra
+    uint8_t type;               ///< Bitfield of BLOCK_*
 //#define TYPE_SPLIT    1
-#define BLOCK_INTRA   1
-#define BLOCK_OPT     2
+#define BLOCK_INTRA   1         ///< Intra block, inter otherwise
+#define BLOCK_OPT     2         ///< Block needs no checks in this round of iterative motion estiation
 //#define TYPE_NOCOLOR  4
     uint8_t level; //FIXME merge into type?
 }BlockNode;