From: Yaowu Xu <yaowu@google.com>
Date: Wed, 14 Jan 2015 17:07:02 +0000 (-0800)
Subject: Add comments for VP9E_SET_FRAME_PERIODIC_BOOST
X-Git-Tag: v1.4.0~254^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=4ab39e13eacbe20b6c156bf3a52c571b548497aa;p=libvpx

Add comments for VP9E_SET_FRAME_PERIODIC_BOOST

Change-Id: Id6decd0024b87da82d85d62ec2f4bdff416faa39
---

diff --git a/vpx/vp8cx.h b/vpx/vp8cx.h
index 2921fefb8..32de177e3 100644
--- a/vpx/vp8cx.h
+++ b/vpx/vp8cx.h
@@ -308,7 +308,20 @@ enum vp8e_enc_control_id {
    * By default, encoder operates with AQ_Mode 0(adaptive quantization off).
    */
   VP9E_SET_AQ_MODE,
+
+  /*!\brief Codec control function to enable/disable periodic Q boost
+   *
+   * One VP9 encoder speed feature is to enable quality boost by lowering
+   * frame level Q periodically. This control function provides a mean to
+   * turn on/off this feature.
+   *               0 = off
+   *               1 = on
+   *
+   * By default, the encoder is allowed to use this feature for appropriate
+   * encoding modes.
+   */
   VP9E_SET_FRAME_PERIODIC_BOOST,
+
   /*!\brief control function to set noise sensitivity
    *
    *  0: off, 1: OnYOnly