doxygen info of av1_update_intra_mb_txb_context()
Rename av1_update_txb_context by av1_update_intra_mb_txb_context
because this function is only used by intra macroblock.
Change-Id: Idf144c541d989bb3a912410b6157f5d1cd006044
diff --git a/av1/encoder/encodeframe.c b/av1/encoder/encodeframe.c
index f861d86..d04ec3d 100644
--- a/av1/encoder/encodeframe.c
+++ b/av1/encoder/encodeframe.c
@@ -4952,8 +4952,8 @@
}
}
- av1_update_txb_context(cpi, td, dry_run, bsize,
- tile_data->allow_update_cdf);
+ av1_update_intra_mb_txb_context(cpi, td, dry_run, bsize,
+ tile_data->allow_update_cdf);
} else {
int ref;
const int is_compound = has_second_ref(mbmi);
diff --git a/av1/encoder/encodetxb.c b/av1/encoder/encodetxb.c
index ccde689..c74e37d 100644
--- a/av1/encoder/encodetxb.c
+++ b/av1/encoder/encodetxb.c
@@ -2227,9 +2227,9 @@
blk_col, blk_row);
}
-void av1_update_txb_context(const AV1_COMP *cpi, ThreadData *td,
- RUN_TYPE dry_run, BLOCK_SIZE bsize,
- uint8_t allow_update_cdf) {
+void av1_update_intra_mb_txb_context(const AV1_COMP *cpi, ThreadData *td,
+ RUN_TYPE dry_run, BLOCK_SIZE bsize,
+ uint8_t allow_update_cdf) {
const AV1_COMMON *const cm = &cpi->common;
const int num_planes = av1_num_planes(cm);
MACROBLOCK *const x = &td->mb;
diff --git a/av1/encoder/encodetxb.h b/av1/encoder/encodetxb.h
index 5260cbf..ca98536 100644
--- a/av1/encoder/encodetxb.h
+++ b/av1/encoder/encodetxb.h
@@ -158,7 +158,7 @@
* \param[in] x Pointer to structure holding the data for the
current encoding macroblock
* \param[in] w Entropy coding write pointer
- * \param[in] bsize size of the current encoding macroblock
+ * \param[in] bsize Block size of the current macroblock
*/
void av1_write_intra_coeffs_mb(const AV1_COMMON *const cm, MACROBLOCK *x,
@@ -179,14 +179,29 @@
*/
uint8_t av1_get_txb_entropy_context(const tran_low_t *qcoeff,
const SCAN_ORDER *scan_order, int eob);
-/*!\cond */
-void av1_update_txb_context(const AV1_COMP *cpi, ThreadData *td,
- RUN_TYPE dry_run, BLOCK_SIZE bsize,
- uint8_t allow_update_cdf);
-/*!\endcond */
/*!\brief Update the probability model (cdf) and the entropy context related to
- * coefficient coding.
+ * coefficient coding for all transform blocks in the intra macroblock.
+ *
+ * \ingroup coefficient_coding
+ *
+ * This function will go through each transform block in the intra macorblock
+ * and call \ref av1_update_and_record_txb_context to update the probability
+ * model and entropy context properly.
+ *
+ * \param[in] cpi Top-level encoder structure
+ * \param[in] td Top-level multithreading structure
+ * \param[in] dry_run Whether this is a dry run.
+ * \param[in] bsize Block size of the current macroblock
+ * \param[in] allow_update_cdf Allowed to update probability model (cdf) or
+ * not.
+ */
+void av1_update_intra_mb_txb_context(const AV1_COMP *cpi, ThreadData *td,
+ RUN_TYPE dry_run, BLOCK_SIZE bsize,
+ uint8_t allow_update_cdf);
+
+/*!\brief Update the probability model (cdf) and the entropy context related to
+ * coefficient coding for a transform block.
*
* \ingroup coefficient_coding
*
