Document some members of the GF_GROUP struct
The comments are copied from Jingning's presentation "Frame Scheduling
System in Libaom AV1".
Change-Id: I2065bf2ceea3d32e39876cd2e22785c00a31b1da
diff --git a/av1/encoder/firstpass.h b/av1/encoder/firstpass.h
index 069bdc9..bc43d35 100644
--- a/av1/encoder/firstpass.h
+++ b/av1/encoder/firstpass.h
@@ -174,7 +174,9 @@
*/
typedef struct {
/*!\cond */
+ // The frame processing order within a GOP
unsigned char index;
+ // Frame update type, e.g. ARF/GF/LF/Overlay
FRAME_UPDATE_TYPE update_type[MAX_STATIC_GF_GROUP_LENGTH];
unsigned char arf_src_offset[MAX_STATIC_GF_GROUP_LENGTH];
// The number of frames displayed so far within the GOP at a given coding
@@ -187,10 +189,12 @@
// This is currently only populated for AOM_Q mode
unsigned char q_val[MAX_STATIC_GF_GROUP_LENGTH];
int bit_allocation[MAX_STATIC_GF_GROUP_LENGTH];
+ // The frame coding type - inter/intra frame
FRAME_TYPE frame_type[MAX_STATIC_GF_GROUP_LENGTH];
+ // The reference frame buffer control - update or reset
REFBUF_STATE refbuf_state[MAX_STATIC_GF_GROUP_LENGTH];
int arf_index; // the index in the gf group of ARF, if no arf, then -1
- int size;
+ int size; // The total length of a GOP
/*!\endcond */
} GF_GROUP;
/*!\cond */
