Clarify purpose of VP9_INVERT_TILE_DECODE_ORDER
authorYaowu Xu <yaowu@google.com>
Tue, 13 Jan 2015 20:19:46 +0000 (12:19 -0800)
committerYaowu Xu <yaowu@google.com>
Thu, 15 Jan 2015 00:26:14 +0000 (16:26 -0800)
Change-Id: I1eb98f4576994c5c9fa5ba748d85cd186910ee4f

vpx/vp8dx.h

index 5cc25cd..c5475c4 100644 (file)
@@ -85,7 +85,14 @@ enum vp8_dec_control_id {
    */
   VP9_SET_BYTE_ALIGNMENT,
 
-  /** For testing. */
+  /** control function to invert the decoding order to from right to left. The
+   * function is used in a test to confirm the decoding independence of tile
+   * columns. The function may be used in application where this order
+   * of decoding is desired.
+   *
+   * TODO(yaowu): Rework the unit test that uses this control, and in a future
+   *              release, this test-only control shall be removed.
+   */
   VP9_INVERT_TILE_DECODE_ORDER,
 
   VP8_DECODER_CTRL_ID_MAX