Doc update for control codes
BUG=aomedia:2651
Change-Id: I16cea9dae7c296f5287322d7691c207117a7aac6
(cherry picked from commit bef4734c8a30d94f44892a23608aac4170b592c1)
diff --git a/aom/aomcx.h b/aom/aomcx.h
index 228bc0a..7515ef9 100644
--- a/aom/aomcx.h
+++ b/aom/aomcx.h
@@ -186,7 +186,7 @@
* the expense of quality.
*
* Valid range: 0..8. 0 runs the slowest, and 8 runs the fastest;
- * quality improves as run-time decreases (since more compression
+ * quality improves as speed decreases (since more compression
* possibilities are explored).
*/
AOME_SET_CPUUSED = 13,
@@ -311,11 +311,11 @@
* input source.
*
* - 0 = normal coding mode, may be lossy (default)
- * - 1 = lossless
+ * - 1 = lossless coding mode
*/
AV1E_SET_LOSSLESS = AV1E_SET_GF_CBR_BOOST_PCT + 2, // 31
- /*!\brief Code control function to enable the row based multi-threading
+ /*!\brief Codec control function to enable the row based multi-threading
* of the encoder, unsigned int parameter
*
* - 0 = disable
@@ -477,7 +477,7 @@
* - 10 = SMPTE 428 (CIE 1921 XYZ)
* - 11 = SMPTE RP 431-2
* - 12 = SMPTE EG 432-1
- * - 13 = For future use (values 13 - 21)
+ * - 13..21 = For future use
* - 22 = EBU Tech. 3213-E
* - 23 = For future use
*/
@@ -532,7 +532,7 @@
/*!\brief Codec control function to set chroma 4:2:0 sample position info,
* aom_chroma_sample_position_t parameter
*
- * UNKNOWN is default
+ * AOM_CSP_UNKNOWN is default
*/
AV1E_SET_CHROMA_SAMPLE_POSITION = 48,
@@ -996,6 +996,9 @@
/*!\brief Codec control function to turn on / off smooth intra modes usage,
* int parameter
*
+ * This will enable or disable usage of smooth, smooth_h and smooth_v intra
+ * modes.
+ *
* - 0 = disable
* - 1 = enable (default)
*/
@@ -1012,6 +1015,8 @@
/*!\brief Codec control function to turn on / off CFL uv intra mode usage, int
* parameter
*
+ * This will enable or disable usage of chroma-from-luma intra mode.
+ *
* - 0 = disable
* - 1 = enable (default)
*/
@@ -1071,13 +1076,15 @@
/*!\brief Codec control function to set the single tile decoding mode,
* unsigned int parameter
*
+ * \attention Only applicable if large scale tiling is on.
+ *
* - 0 = single tile decoding is off
* - 1 = single tile decoding is on (default)
*/
AV1E_SET_SINGLE_TILE_DECODING = 109,
- /*!\brief Codec control function to enable the motion vector unit test,
- * unsigned int parameter
+ /*!\brief Codec control function to enable the extreme motion vector unit
+ * test, unsigned int parameter
*
* - 0 = off
* - 1 = MAX_EXTREME_MV
@@ -1096,7 +1103,7 @@
/*!\brief Codec control function to add film grain parameters (one of several
* preset types) info in the bitstream, int parameter
*
- Valid ranges: 0..16, 0 is unknown, 1..15 are test vectors
+ Valid range: 0..16, 0 is unknown, 1..16 are test vectors
*/
AV1E_SET_FILM_GRAIN_TEST_VECTOR = 112,
