shithub: libvpx

Download patch

ref: 5dd146cb2643e62b849e8ddeed928b2f513355c0
parent: 416529069b647085d4d3f75ca9239ba14c881e2c
author: Yaowu Xu <yaowu@google.com>
date: Thu Mar 12 14:14:43 EDT 2015 

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


--- a/vpx/vp8cx.h
+++ b/vpx/vp8cx.h
@@ -248,6 +248,8 @@
    *                          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 @@
    * 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 @@
    *            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 @@
    * 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 @@
    * several AQ_modes supported.
    *
    * By default, encoder operates with AQ_Mode 0(adaptive quantization off).
+   *
+   * Supported in codecs: VP9
    */
   VP9E_SET_AQ_MODE,
 
@@ -323,6 +333,8 @@
    *
    * By default, the encoder is allowed to use this feature for appropriate
    * encoding modes.
+   *
+   * Supported in codecs: VP9
    */
   VP9E_SET_FRAME_PERIODIC_BOOST,
 
@@ -329,6 +341,8 @@
   /*!\brief control function to set noise sensitivity
    *
    *  0: off, 1: OnYOnly
+   *
+   * Supported in codecs: VP9
    */
   VP9E_SET_NOISE_SENSITIVITY,
 
@@ -336,6 +350,8 @@
    * \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,
 
@@ -342,6 +358,8 @@
   /*!\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 @@
    * \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,6 +376,8 @@
    * \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,
 
@@ -362,6 +384,8 @@
   /*!\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 @@
    *                     5 = BT_2020
    *                     6 = RESERVED
    *                     7 = SRGB
+   *
+   * Supported in codecs: VP9
    */
   VP9E_SET_COLOR_SPACE,
 };