Add comments to document CONFIG_LOSSLESS_DPCM
Add comments to document CONFIG_LOSSLESS_DPCM
diff --git a/av1/common/blockd.h b/av1/common/blockd.h
index 6e9ca76..f3b1cc9 100644
--- a/av1/common/blockd.h
+++ b/av1/common/blockd.h
@@ -568,15 +568,13 @@
#endif // CONFIG_WAIP
#if CONFIG_LOSSLESS_DPCM
- // use_dpcm_y: 0 dpcm mode is not selected for luma blk, 1 dpcm mode is
- // selected
+ /*! \brief Whether dpcm mode is selected for luma blk*/
uint8_t use_dpcm_y;
- // dpcm_mode_y: 0 horizontal, 1 vertical
+ /*! \brief dpcm direction if dpcm is selected for the luma blk*/
uint8_t dpcm_mode_y;
- // use_dpcm_uv: 0 dpcm mode is not selected for chroma blk, 1 dpcm mode is
- // selected
+ /*! \brief Whether dpcm mode is selected for chroma blk*/
uint8_t use_dpcm_uv;
- // dpcm_mode_uv: 0 horizontal, 1 vertical
+ /*! \brief dpcm direction if dpcm is selected for the chroma blk*/
uint8_t dpcm_mode_uv;
#endif
diff --git a/av1/encoder/block.h b/av1/encoder/block.h
index ef01c11..cfa29b7 100644
--- a/av1/encoder/block.h
+++ b/av1/encoder/block.h
@@ -1322,14 +1322,30 @@
*/
int pc_wiener_restore_cost[2];
#endif // CONFIG_LR_IMPROVEMENTS
+/**@}*/
#if CONFIG_LOSSLESS_DPCM
+ /*****************************************************************************
+ * \name DPCM Mode Costs
+ ****************************************************************************/
+ /**@{*/
+ /*!
+ * dpcm_cost
+ */
int dpcm_cost[2];
+ /*!
+ * dpcm_vert_horz_cost
+ */
int dpcm_vert_horz_cost[2];
+ /*!
+ * dpcm_uv_cost
+ */
int dpcm_uv_cost[2];
+ /*!
+ * dpcm_uv_vert_horz_cost
+ */
int dpcm_uv_vert_horz_cost[2];
-#endif // CONFIG_LOSSLESS_DPCM
-
/**@}*/
+#endif // CONFIG_LOSSLESS_DPCM
} ModeCosts;
/*! \brief Holds mv costs for encoding and motion search.
@@ -1816,10 +1832,6 @@
*/
TxfmSearchInfo txfm_search_info;
/**@}*/
-#if CONFIG_LOSSLESS_DPCM
- // dpcm_flag indicates if the current prediction mode is dpcm
- uint8_t dpcm_flag;
-#endif
/*****************************************************************************
* \name Misc
****************************************************************************/
diff --git a/av1/encoder/intra_mode_search.h b/av1/encoder/intra_mode_search.h
index ef3877d..39610f7 100644
--- a/av1/encoder/intra_mode_search.h
+++ b/av1/encoder/intra_mode_search.h
@@ -56,9 +56,21 @@
int best_mrl_index;
#if CONFIG_LOSSLESS_DPCM
+ /*!
+ * \brief The best dpcm mode found for Y block
+ */
int best_dpcm_index;
+ /*!
+ * \brief The best dpcm direction found for Y block
+ */
int best_dpcm_dir;
+ /*!
+ * \brief The best dpcm mode found for UV block
+ */
int best_dpcm_uv_index;
+ /*!
+ * \brief The best dpcm direction found for UV block
+ */
int best_dpcm_uv_dir;
#endif
/*!
