Commit 5dd146cb authored by Yaowu Xu's avatar Yaowu Xu

Added comment for vp9 only codec controls

Comments are updated to reflect that these controls apply to VP9 only,
thereby, to insure the document produced by doxygent to reflect the
same fact too.

Change-Id: Ic54c88ec066aa0ec4552d43dd4a7016e1f810f42
parent 41652906
......@@ -248,6 +248,8 @@ enum vp8e_enc_control_id {
* 1 = lossless coding mode
*
* By default, encoder operates in normal coding mode (maybe lossy).
*
* Supported in codecs: VP9
*/
VP9E_SET_LOSSLESS,
......@@ -269,6 +271,8 @@ enum vp8e_enc_control_id {
* is 4096).
*
* By default, the value is 0, i.e. one single column tile for entire image.
*
* Supported in codecs: VP9
*/
VP9E_SET_TILE_COLUMNS,
......@@ -287,6 +291,8 @@ enum vp8e_enc_control_id {
* 2 = 4 tile rows
*
* By default, the value is 0, i.e. one single row tile for entire image.
*
* Supported in codecs: VP9
*/
VP9E_SET_TILE_ROWS,
......@@ -299,6 +305,8 @@ enum vp8e_enc_control_id {
* turn this feature on or off for bitstreams produced by encoder.
*
* By default, this feature is off.
*
* Supported in codecs: VP9
*/
VP9E_SET_FRAME_PARALLEL_DECODING,
......@@ -310,6 +318,8 @@ enum vp8e_enc_control_id {
* several AQ_modes supported.
*
* By default, encoder operates with AQ_Mode 0(adaptive quantization off).
*
* Supported in codecs: VP9
*/
VP9E_SET_AQ_MODE,
......@@ -323,12 +333,16 @@ enum vp8e_enc_control_id {
*
* By default, the encoder is allowed to use this feature for appropriate
* encoding modes.
*
* Supported in codecs: VP9
*/
VP9E_SET_FRAME_PERIODIC_BOOST,
/*!\brief control function to set noise sensitivity
*
* 0: off, 1: OnYOnly
*
* Supported in codecs: VP9
*/
VP9E_SET_NOISE_SENSITIVITY,
......@@ -336,12 +350,16 @@ enum vp8e_enc_control_id {
* \note Return value is VPX_CODEC_INVALID_PARAM if the encoder does not
* support SVC in its current encoding mode
* 0: off, 1: on
*
* Supported in codecs: VP9
*/
VP9E_SET_SVC,
/*!\brief control function to set parameters for SVC.
* \note Parameters contain min_q, max_q, scaling factor for each of the
* SVC layers.
*
* Supported in codecs: VP9
*/
VP9E_SET_SVC_PARAMETERS,
......@@ -349,6 +367,8 @@ enum vp8e_enc_control_id {
* \note Valid ranges: 0..#vpx_codec_enc_cfg::ss_number_layers for spatial
* layer and 0..#vpx_codec_enc_cfg::ts_number_layers for
* temporal layer.
*
* Supported in codecs: VP9
*/
VP9E_SET_SVC_LAYER_ID,
......@@ -356,12 +376,16 @@ enum vp8e_enc_control_id {
* \note Valid parameter range:
* VP9E_CONTENT_DEFAULT = Regular video content (Default)
* VP9E_CONTENT_SCREEN = Screen capture content
*
* Supported in codecs: VP9
*/
VP9E_SET_TUNE_CONTENT,
/*!\brief control function to get svc layer ID.
* \note The layer ID returned is for the data packet from the registered
* callback function.
*
* Supported in codecs: VP9
*/
VP9E_GET_SVC_LAYER_ID,
......@@ -381,6 +405,8 @@ enum vp8e_enc_control_id {
* 5 = BT_2020
* 6 = RESERVED
* 7 = SRGB
*
* Supported in codecs: VP9
*/
VP9E_SET_COLOR_SPACE,
};
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment