John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 1 | /* |
Yaowu Xu | 9c01aa1 | 2016-09-01 14:32:49 -0700 | [diff] [blame] | 2 | * Copyright (c) 2016, Alliance for Open Media. All rights reserved |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 3 | * |
Yaowu Xu | 9c01aa1 | 2016-09-01 14:32:49 -0700 | [diff] [blame] | 4 | * This source code is subject to the terms of the BSD 2 Clause License and |
| 5 | * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License |
| 6 | * was not distributed with this source code in the LICENSE file, you can |
| 7 | * obtain it at www.aomedia.org/license/software. If the Alliance for Open |
| 8 | * Media Patent License 1.0 was not distributed with this source code in the |
| 9 | * PATENTS file, you can obtain it at www.aomedia.org/license/patent. |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 10 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 11 | #ifndef AOM_AOMCX_H_ |
| 12 | #define AOM_AOMCX_H_ |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 13 | |
Yaowu Xu | 9c01aa1 | 2016-09-01 14:32:49 -0700 | [diff] [blame] | 14 | /*!\defgroup aom_encoder AOMedia AOM/AV1 Encoder |
| 15 | * \ingroup aom |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 16 | * |
| 17 | * @{ |
| 18 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 19 | #include "./aom.h" |
| 20 | #include "./aom_encoder.h" |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 21 | |
James Zern | f42d52e | 2011-02-16 17:54:49 -0800 | [diff] [blame] | 22 | /*!\file |
Yaowu Xu | 9c01aa1 | 2016-09-01 14:32:49 -0700 | [diff] [blame] | 23 | * \brief Provides definitions for using AOM or AV1 encoder algorithm within the |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 24 | * aom Codec Interface. |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 25 | */ |
Dmitry Kovalev | e288c60 | 2013-09-29 18:00:15 -0700 | [diff] [blame] | 26 | |
| 27 | #ifdef __cplusplus |
| 28 | extern "C" { |
| 29 | #endif |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 30 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 31 | /*!\name Algorithm interface for AV1 |
Jingning Han | 3ee6db6 | 2015-08-05 19:00:31 -0700 | [diff] [blame] | 32 | * |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 33 | * This interface provides the capability to encode raw AV1 streams. |
Jingning Han | 3ee6db6 | 2015-08-05 19:00:31 -0700 | [diff] [blame] | 34 | * @{ |
| 35 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 36 | extern aom_codec_iface_t aom_codec_av1_cx_algo; |
| 37 | extern aom_codec_iface_t *aom_codec_av1_cx(void); |
Jingning Han | 3ee6db6 | 2015-08-05 19:00:31 -0700 | [diff] [blame] | 38 | /*!@} - end algorithm interface member group*/ |
John Koleszar | 0952acb | 2010-06-01 11:14:25 -0400 | [diff] [blame] | 39 | |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 40 | /* |
| 41 | * Algorithm Flags |
| 42 | */ |
| 43 | |
| 44 | /*!\brief Don't reference the last frame |
| 45 | * |
| 46 | * When this flag is set, the encoder will not use the last frame as a |
| 47 | * predictor. When not set, the encoder will choose whether to use the |
| 48 | * last frame or not automatically. |
| 49 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 50 | #define AOM_EFLAG_NO_REF_LAST (1 << 16) |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 51 | |
| 52 | /*!\brief Don't reference the golden frame |
| 53 | * |
| 54 | * When this flag is set, the encoder will not use the golden frame as a |
| 55 | * predictor. When not set, the encoder will choose whether to use the |
| 56 | * golden frame or not automatically. |
| 57 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 58 | #define AOM_EFLAG_NO_REF_GF (1 << 17) |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 59 | |
| 60 | /*!\brief Don't reference the alternate reference frame |
| 61 | * |
| 62 | * When this flag is set, the encoder will not use the alt ref frame as a |
| 63 | * predictor. When not set, the encoder will choose whether to use the |
| 64 | * alt ref frame or not automatically. |
| 65 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 66 | #define AOM_EFLAG_NO_REF_ARF (1 << 21) |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 67 | |
| 68 | /*!\brief Don't update the last frame |
| 69 | * |
| 70 | * When this flag is set, the encoder will not update the last frame with |
| 71 | * the contents of the current frame. |
| 72 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 73 | #define AOM_EFLAG_NO_UPD_LAST (1 << 18) |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 74 | |
| 75 | /*!\brief Don't update the golden frame |
| 76 | * |
| 77 | * When this flag is set, the encoder will not update the golden frame with |
| 78 | * the contents of the current frame. |
| 79 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 80 | #define AOM_EFLAG_NO_UPD_GF (1 << 22) |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 81 | |
| 82 | /*!\brief Don't update the alternate reference frame |
| 83 | * |
| 84 | * When this flag is set, the encoder will not update the alt ref frame with |
| 85 | * the contents of the current frame. |
| 86 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 87 | #define AOM_EFLAG_NO_UPD_ARF (1 << 23) |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 88 | |
| 89 | /*!\brief Force golden frame update |
| 90 | * |
| 91 | * When this flag is set, the encoder copy the contents of the current frame |
| 92 | * to the golden frame buffer. |
| 93 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 94 | #define AOM_EFLAG_FORCE_GF (1 << 19) |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 95 | |
| 96 | /*!\brief Force alternate reference frame update |
| 97 | * |
| 98 | * When this flag is set, the encoder copy the contents of the current frame |
| 99 | * to the alternate reference frame buffer. |
| 100 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 101 | #define AOM_EFLAG_FORCE_ARF (1 << 24) |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 102 | |
| 103 | /*!\brief Disable entropy update |
| 104 | * |
| 105 | * When this flag is set, the encoder will not update its internal entropy |
| 106 | * model based on the entropy of this frame. |
| 107 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 108 | #define AOM_EFLAG_NO_UPD_ENTROPY (1 << 20) |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 109 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 110 | /*!\brief AVx encoder control functions |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 111 | * |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 112 | * This set of macros define the control functions available for AVx |
James Zern | 8e17e82 | 2011-02-24 14:12:57 -0800 | [diff] [blame] | 113 | * encoder interface. |
| 114 | * |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 115 | * \sa #aom_codec_control |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 116 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 117 | enum aome_enc_control_id { |
Yunqing Wang | bdcc140 | 2016-03-25 09:05:25 -0700 | [diff] [blame] | 118 | /*!\brief Codec control function to set which reference frame encoder can use. |
Yunqing Wang | bdcc140 | 2016-03-25 09:05:25 -0700 | [diff] [blame] | 119 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 120 | AOME_USE_REFERENCE = 7, |
Yunqing Wang | bdcc140 | 2016-03-25 09:05:25 -0700 | [diff] [blame] | 121 | |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 122 | /*!\brief Codec control function to pass an ROI map to encoder. |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 123 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 124 | AOME_SET_ROI_MAP = 8, |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 125 | |
| 126 | /*!\brief Codec control function to pass an Active map to encoder. |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 127 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 128 | AOME_SET_ACTIVEMAP, |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 129 | |
| 130 | /*!\brief Codec control function to set encoder scaling mode. |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 131 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 132 | AOME_SET_SCALEMODE = 11, |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 133 | |
| 134 | /*!\brief Codec control function to set encoder internal speed settings. |
John Koleszar | c6b9039 | 2012-07-13 15:21:29 -0700 | [diff] [blame] | 135 | * |
| 136 | * Changes in this value influences, among others, the encoder's selection |
| 137 | * of motion estimation methods. Values greater than 0 will increase encoder |
| 138 | * speed at the expense of quality. |
John Koleszar | c6b9039 | 2012-07-13 15:21:29 -0700 | [diff] [blame] | 139 | * |
Alex Converse | c7f8070 | 2016-12-12 16:35:13 -0800 | [diff] [blame] | 140 | * \note Valid range: -8..8 |
John Koleszar | c6b9039 | 2012-07-13 15:21:29 -0700 | [diff] [blame] | 141 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 142 | AOME_SET_CPUUSED = 13, |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 143 | |
| 144 | /*!\brief Codec control function to enable automatic set and use alf frames. |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 145 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 146 | AOME_SET_ENABLEAUTOALTREF, |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 147 | |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 148 | /*!\brief Codec control function to set sharpness. |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 149 | */ |
Alex Converse | 0f4bcda | 2016-12-12 15:43:35 -0800 | [diff] [blame] | 150 | AOME_SET_SHARPNESS = AOME_SET_ENABLEAUTOALTREF + 2, |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 151 | |
| 152 | /*!\brief Codec control function to set the threshold for MBs treated static. |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 153 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 154 | AOME_SET_STATIC_THRESHOLD, |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 155 | |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 156 | /*!\brief Codec control function to get last quantizer chosen by the encoder. |
| 157 | * |
| 158 | * Return value uses internal quantizer scale defined by the codec. |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 159 | */ |
Alex Converse | 0f4bcda | 2016-12-12 15:43:35 -0800 | [diff] [blame] | 160 | AOME_GET_LAST_QUANTIZER = AOME_SET_STATIC_THRESHOLD + 2, |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 161 | |
| 162 | /*!\brief Codec control function to get last quantizer chosen by the encoder. |
| 163 | * |
| 164 | * Return value uses the 0..63 scale as used by the rc_*_quantizer config |
| 165 | * parameters. |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 166 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 167 | AOME_GET_LAST_QUANTIZER_64, |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 168 | |
| 169 | /*!\brief Codec control function to set the max no of frames to create arf. |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 170 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 171 | AOME_SET_ARNR_MAXFRAMES, |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 172 | |
| 173 | /*!\brief Codec control function to set the filter strength for the arf. |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 174 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 175 | AOME_SET_ARNR_STRENGTH, |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 176 | |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 177 | /*!\brief Codec control function to set visual tuning. |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 178 | */ |
Alex Converse | fab6224 | 2016-12-13 10:09:15 -0800 | [diff] [blame] | 179 | AOME_SET_TUNING = AOME_SET_ARNR_STRENGTH + 2, |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 180 | |
| 181 | /*!\brief Codec control function to set constrained quality level. |
John Koleszar | c6b9039 | 2012-07-13 15:21:29 -0700 | [diff] [blame] | 182 | * |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 183 | * \attention For this value to be used aom_codec_enc_cfg_t::g_usage must be |
| 184 | * set to #AOM_CQ. |
John Koleszar | c6b9039 | 2012-07-13 15:21:29 -0700 | [diff] [blame] | 185 | * \note Valid range: 0..63 |
| 186 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 187 | AOME_SET_CQ_LEVEL, |
John Koleszar | 1654ae9 | 2011-07-28 09:17:32 -0400 | [diff] [blame] | 188 | |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 189 | /*!\brief Codec control function to set Max data rate for Intra frames. |
John Koleszar | c6b9039 | 2012-07-13 15:21:29 -0700 | [diff] [blame] | 190 | * |
| 191 | * This value controls additional clamping on the maximum size of a |
| 192 | * keyframe. It is expressed as a percentage of the average |
| 193 | * per-frame bitrate, with the special (and default) value 0 meaning |
| 194 | * unlimited, or no additional clamping beyond the codec's built-in |
| 195 | * algorithm. |
| 196 | * |
| 197 | * For example, to allocate no more than 4.5 frames worth of bitrate |
| 198 | * to a keyframe, set this to 450. |
John Koleszar | c6b9039 | 2012-07-13 15:21:29 -0700 | [diff] [blame] | 199 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 200 | AOME_SET_MAX_INTRA_BITRATE_PCT, |
John Koleszar | 83b1d90 | 2012-11-05 12:37:14 -0800 | [diff] [blame] | 201 | |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 202 | /*!\brief Codec control function to set max data rate for Inter frames. |
Yaowu Xu | 636099f | 2014-10-24 09:31:16 -0700 | [diff] [blame] | 203 | * |
| 204 | * This value controls additional clamping on the maximum size of an |
| 205 | * inter frame. It is expressed as a percentage of the average |
| 206 | * per-frame bitrate, with the special (and default) value 0 meaning |
| 207 | * unlimited, or no additional clamping beyond the codec's built-in |
| 208 | * algorithm. |
| 209 | * |
| 210 | * For example, to allow no more than 4.5 frames worth of bitrate |
| 211 | * to an inter frame, set this to 450. |
Yaowu Xu | 636099f | 2014-10-24 09:31:16 -0700 | [diff] [blame] | 212 | */ |
Alex Converse | 0f4bcda | 2016-12-12 15:43:35 -0800 | [diff] [blame] | 213 | AV1E_SET_MAX_INTER_BITRATE_PCT = AOME_SET_MAX_INTRA_BITRATE_PCT + 2, |
Yaowu Xu | 636099f | 2014-10-24 09:31:16 -0700 | [diff] [blame] | 214 | |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 215 | /*!\brief Boost percentage for Golden Frame in CBR mode. |
Yaowu Xu | 03a60b7 | 2014-10-27 13:13:14 -0700 | [diff] [blame] | 216 | * |
| 217 | * This value controls the amount of boost given to Golden Frame in |
| 218 | * CBR mode. It is expressed as a percentage of the average |
| 219 | * per-frame bitrate, with the special (and default) value 0 meaning |
| 220 | * the feature is off, i.e., no golden frame boost in CBR mode and |
| 221 | * average bitrate target is used. |
| 222 | * |
| 223 | * For example, to allow 100% more bits, i.e, 2X, in a golden frame |
| 224 | * than average frame, set this to 100. |
Yaowu Xu | 03a60b7 | 2014-10-27 13:13:14 -0700 | [diff] [blame] | 225 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 226 | AV1E_SET_GF_CBR_BOOST_PCT, |
John Koleszar | 83b1d90 | 2012-11-05 12:37:14 -0800 | [diff] [blame] | 227 | |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 228 | /*!\brief Codec control function to set lossless encoding mode. |
Yaowu Xu | 87c436f | 2015-01-13 12:39:42 -0800 | [diff] [blame] | 229 | * |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 230 | * AV1 can operate in lossless encoding mode, in which the bitstream |
Yaowu Xu | 87c436f | 2015-01-13 12:39:42 -0800 | [diff] [blame] | 231 | * produced will be able to decode and reconstruct a perfect copy of |
| 232 | * input source. This control function provides a mean to switch encoder |
| 233 | * into lossless coding mode(1) or normal coding mode(0) that may be lossy. |
| 234 | * 0 = lossy coding mode |
| 235 | * 1 = lossless coding mode |
| 236 | * |
| 237 | * By default, encoder operates in normal coding mode (maybe lossy). |
| 238 | */ |
Alex Converse | 0f4bcda | 2016-12-12 15:43:35 -0800 | [diff] [blame] | 239 | AV1E_SET_LOSSLESS = AV1E_SET_GF_CBR_BOOST_PCT + 2, |
Thomas Davies | af6df17 | 2016-11-09 14:04:18 +0000 | [diff] [blame] | 240 | |
Fangwen Fu | 8d164de | 2016-12-14 13:40:54 -0800 | [diff] [blame] | 241 | #if CONFIG_TEMPMV_SIGNALING |
| 242 | /*!\brief Codec control function to set temporal mv prediction |
| 243 | * enabling/disabling. |
| 244 | * |
| 245 | * This will enable or disable temporal mv predicton. The default value is 0. |
| 246 | * |
| 247 | * Supported in codecs: AV1 |
| 248 | */ |
| 249 | AV1E_SET_DISABLE_TEMPMV, |
| 250 | #endif |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 251 | /*!\brief Codec control function to set number of tile columns. |
Yaowu Xu | 87c436f | 2015-01-13 12:39:42 -0800 | [diff] [blame] | 252 | * |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 253 | * In encoding and decoding, AV1 allows an input image frame be partitioned |
Yaowu Xu | 87c436f | 2015-01-13 12:39:42 -0800 | [diff] [blame] | 254 | * into separated vertical tile columns, which can be encoded or decoded |
| 255 | * independently. This enables easy implementation of parallel encoding and |
| 256 | * decoding. This control requests the encoder to use column tiles in |
| 257 | * encoding an input frame, with number of tile columns (in Log2 unit) as |
| 258 | * the parameter: |
| 259 | * 0 = 1 tile column |
| 260 | * 1 = 2 tile columns |
| 261 | * 2 = 4 tile columns |
| 262 | * ..... |
| 263 | * n = 2**n tile columns |
| 264 | * The requested tile columns will be capped by encoder based on image size |
| 265 | * limitation (The minimum width of a tile column is 256 pixel, the maximum |
| 266 | * is 4096). |
| 267 | * |
| 268 | * By default, the value is 0, i.e. one single column tile for entire image. |
| 269 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 270 | AV1E_SET_TILE_COLUMNS, |
Yaowu Xu | 87c436f | 2015-01-13 12:39:42 -0800 | [diff] [blame] | 271 | |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 272 | /*!\brief Codec control function to set number of tile rows. |
Yaowu Xu | 87c436f | 2015-01-13 12:39:42 -0800 | [diff] [blame] | 273 | * |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 274 | * In encoding and decoding, AV1 allows an input image frame be partitioned |
Yaowu Xu | 87c436f | 2015-01-13 12:39:42 -0800 | [diff] [blame] | 275 | * into separated horizontal tile rows. Tile rows are encoded or decoded |
| 276 | * sequentially. Even though encoding/decoding of later tile rows depends on |
| 277 | * earlier ones, this allows the encoder to output data packets for tile rows |
| 278 | * prior to completely processing all tile rows in a frame, thereby reducing |
| 279 | * the latency in processing between input and output. The parameter |
| 280 | * for this control describes the number of tile rows, which has a valid |
| 281 | * range [0, 2]: |
| 282 | * 0 = 1 tile row |
| 283 | * 1 = 2 tile rows |
| 284 | * 2 = 4 tile rows |
| 285 | * |
| 286 | * By default, the value is 0, i.e. one single row tile for entire image. |
| 287 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 288 | AV1E_SET_TILE_ROWS, |
Yaowu Xu | 87c436f | 2015-01-13 12:39:42 -0800 | [diff] [blame] | 289 | |
Ryan Lei | 7386eda | 2016-12-08 21:08:31 -0800 | [diff] [blame] | 290 | #if CONFIG_DEBLOCKING_ACROSS_TILES |
| 291 | /*!\brief Codec control function to set loop_filter_across_tiles_enabled. |
| 292 | * |
| 293 | * In encoding and decoding, AV1 allows disabling loop filter across tile |
| 294 | * boundary The parameter for this control describes the value of this flag, |
| 295 | * which has a valid range [0, 1]: |
| 296 | * 0 = disable loop filter across tile boundary |
| 297 | * 1 = enable loop filter across tile boundary |
| 298 | * |
| 299 | * By default, the value is 0, i.e. disable loop filter across tile boundary. |
| 300 | * |
| 301 | * Supported in codecs: AV1 |
| 302 | */ |
| 303 | AV1E_SET_TILE_LOOPFILTER, |
| 304 | #endif |
| 305 | |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 306 | /*!\brief Codec control function to enable frame parallel decoding feature. |
Yaowu Xu | 87c436f | 2015-01-13 12:39:42 -0800 | [diff] [blame] | 307 | * |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 308 | * AV1 has a bitstream feature to reduce decoding dependency between frames |
Yaowu Xu | 87c436f | 2015-01-13 12:39:42 -0800 | [diff] [blame] | 309 | * by turning off backward update of probability context used in encoding |
| 310 | * and decoding. This allows staged parallel processing of more than one |
| 311 | * video frames in the decoder. This control function provides a mean to |
| 312 | * turn this feature on or off for bitstreams produced by encoder. |
| 313 | * |
| 314 | * By default, this feature is off. |
| 315 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 316 | AV1E_SET_FRAME_PARALLEL_DECODING, |
Yaowu Xu | 87c436f | 2015-01-13 12:39:42 -0800 | [diff] [blame] | 317 | |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 318 | /*!\brief Codec control function to set adaptive quantization mode. |
Yaowu Xu | 87c436f | 2015-01-13 12:39:42 -0800 | [diff] [blame] | 319 | * |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 320 | * AV1 has a segment based feature that allows encoder to adaptively change |
Yaowu Xu | 87c436f | 2015-01-13 12:39:42 -0800 | [diff] [blame] | 321 | * quantization parameter for each segment within a frame to improve the |
| 322 | * subjective quality. This control makes encoder operate in one of the |
| 323 | * several AQ_modes supported. |
| 324 | * |
| 325 | * By default, encoder operates with AQ_Mode 0(adaptive quantization off). |
| 326 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 327 | AV1E_SET_AQ_MODE, |
Yaowu Xu | 4ab39e1 | 2015-01-14 09:07:02 -0800 | [diff] [blame] | 328 | |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 329 | /*!\brief Codec control function to enable/disable periodic Q boost. |
Yaowu Xu | 4ab39e1 | 2015-01-14 09:07:02 -0800 | [diff] [blame] | 330 | * |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 331 | * One AV1 encoder speed feature is to enable quality boost by lowering |
Yaowu Xu | 4ab39e1 | 2015-01-14 09:07:02 -0800 | [diff] [blame] | 332 | * frame level Q periodically. This control function provides a mean to |
| 333 | * turn on/off this feature. |
| 334 | * 0 = off |
| 335 | * 1 = on |
| 336 | * |
| 337 | * By default, the encoder is allowed to use this feature for appropriate |
| 338 | * encoding modes. |
| 339 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 340 | AV1E_SET_FRAME_PERIODIC_BOOST, |
Yaowu Xu | 4ab39e1 | 2015-01-14 09:07:02 -0800 | [diff] [blame] | 341 | |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 342 | /*!\brief Codec control function to set noise sensitivity. |
JackyChen | bb1a236 | 2014-09-12 11:48:44 -0700 | [diff] [blame] | 343 | * |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 344 | * 0: off, 1: On(YOnly) |
JackyChen | bb1a236 | 2014-09-12 11:48:44 -0700 | [diff] [blame] | 345 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 346 | AV1E_SET_NOISE_SENSITIVITY, |
Ivan Maltz | 01b35c3 | 2013-09-05 08:55:47 -0700 | [diff] [blame] | 347 | |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 348 | /*!\brief Codec control function to set content type. |
Yaowu Xu | dc08b20 | 2015-01-14 11:17:09 -0800 | [diff] [blame] | 349 | * \note Valid parameter range: |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 350 | * AOM_CONTENT_DEFAULT = Regular video content (Default) |
| 351 | * AOM_CONTENT_SCREEN = Screen capture content |
Yaowu Xu | dc08b20 | 2015-01-14 11:17:09 -0800 | [diff] [blame] | 352 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 353 | AV1E_SET_TUNE_CONTENT, |
Yaowu Xu | 193ca4b | 2015-01-14 11:48:29 -0800 | [diff] [blame] | 354 | |
Yaowu Xu | 268f106 | 2015-03-13 09:42:57 -0700 | [diff] [blame] | 355 | /*!\brief Codec control function to set color space info. |
Yaowu Xu | e94b415 | 2015-01-13 10:07:20 -0800 | [diff] [blame] | 356 | * \note Valid ranges: 0..7, default is "UNKNOWN". |
| 357 | * 0 = UNKNOWN, |
| 358 | * 1 = BT_601 |
| 359 | * 2 = BT_709 |
| 360 | * 3 = SMPTE_170 |
| 361 | * 4 = SMPTE_240 |
| 362 | * 5 = BT_2020 |
| 363 | * 6 = RESERVED |
| 364 | * 7 = SRGB |
| 365 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 366 | AV1E_SET_COLOR_SPACE, |
Alex Converse | 4dcb839 | 2015-03-20 14:55:43 -0700 | [diff] [blame] | 367 | |
Debargha Mukherjee | 9852643 | 2015-04-01 16:39:06 -0700 | [diff] [blame] | 368 | /*!\brief Codec control function to set minimum interval between GF/ARF frames |
| 369 | * |
| 370 | * By default the value is set as 4. |
Debargha Mukherjee | 9852643 | 2015-04-01 16:39:06 -0700 | [diff] [blame] | 371 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 372 | AV1E_SET_MIN_GF_INTERVAL, |
Debargha Mukherjee | 9852643 | 2015-04-01 16:39:06 -0700 | [diff] [blame] | 373 | |
| 374 | /*!\brief Codec control function to set minimum interval between GF/ARF frames |
| 375 | * |
| 376 | * By default the value is set as 16. |
Debargha Mukherjee | 9852643 | 2015-04-01 16:39:06 -0700 | [diff] [blame] | 377 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 378 | AV1E_SET_MAX_GF_INTERVAL, |
Debargha Mukherjee | 9852643 | 2015-04-01 16:39:06 -0700 | [diff] [blame] | 379 | |
Alex Converse | 4dcb839 | 2015-03-20 14:55:43 -0700 | [diff] [blame] | 380 | /*!\brief Codec control function to get an Active map back from the encoder. |
Alex Converse | 4dcb839 | 2015-03-20 14:55:43 -0700 | [diff] [blame] | 381 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 382 | AV1E_GET_ACTIVEMAP, |
Ronald S. Bultje | eeb5ef0 | 2015-09-15 21:56:51 -0400 | [diff] [blame] | 383 | |
| 384 | /*!\brief Codec control function to set color range bit. |
| 385 | * \note Valid ranges: 0..1, default is 0 |
| 386 | * 0 = Limited range (16..235 or HBD equivalent) |
| 387 | * 1 = Full range (0..255 or HBD equivalent) |
Ronald S. Bultje | eeb5ef0 | 2015-09-15 21:56:51 -0400 | [diff] [blame] | 388 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 389 | AV1E_SET_COLOR_RANGE, |
Yaowu Xu | 7c514e2 | 2015-09-28 15:55:46 -0700 | [diff] [blame] | 390 | |
Yaowu Xu | 7c514e2 | 2015-09-28 15:55:46 -0700 | [diff] [blame] | 391 | /*!\brief Codec control function to set intended rendering image size. |
| 392 | * |
| 393 | * By default, this is identical to the image size in pixels. |
Yaowu Xu | 7c514e2 | 2015-09-28 15:55:46 -0700 | [diff] [blame] | 394 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 395 | AV1E_SET_RENDER_SIZE, |
Geza Lore | 454989f | 2016-03-24 13:56:05 +0000 | [diff] [blame] | 396 | |
hui su | be3f069 | 2016-05-05 15:37:37 -0700 | [diff] [blame] | 397 | /*!\brief Codec control function to set target level. |
| 398 | * |
| 399 | * 255: off (default); 0: only keep level stats; 10: target for level 1.0; |
| 400 | * 11: target for level 1.1; ... 62: target for level 6.2 |
hui su | be3f069 | 2016-05-05 15:37:37 -0700 | [diff] [blame] | 401 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 402 | AV1E_SET_TARGET_LEVEL, |
hui su | 72d4890 | 2016-05-05 12:04:42 -0700 | [diff] [blame] | 403 | |
| 404 | /*!\brief Codec control function to get bitstream level. |
hui su | 72d4890 | 2016-05-05 12:04:42 -0700 | [diff] [blame] | 405 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 406 | AV1E_GET_LEVEL, |
Yaowu Xu | 6fe07a2 | 2016-07-14 10:57:35 -0700 | [diff] [blame] | 407 | |
Geza Lore | 454989f | 2016-03-24 13:56:05 +0000 | [diff] [blame] | 408 | /*!\brief Codec control function to set intended superblock size. |
| 409 | * |
| 410 | * By default, the superblock size is determined separately for each |
| 411 | * frame by the encoder. |
Alex Converse | 85370ae | 2016-12-13 11:18:28 -0800 | [diff] [blame] | 412 | * |
| 413 | * Experiment: EXT_PARTITION |
Geza Lore | 454989f | 2016-03-24 13:56:05 +0000 | [diff] [blame] | 414 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 415 | AV1E_SET_SUPERBLOCK_SIZE, |
Alex Converse | 85370ae | 2016-12-13 11:18:28 -0800 | [diff] [blame] | 416 | |
| 417 | /*!\brief Codec control function to enable automatic set and use |
| 418 | * bwd-pred frames. |
| 419 | * |
| 420 | * Experiment: EXT_REFS |
| 421 | */ |
| 422 | AOME_SET_ENABLEAUTOBWDREF, |
| 423 | |
| 424 | /*!\brief Codec control function to encode with quantisation matrices. |
| 425 | * |
| 426 | * AOM can operate with default quantisation matrices dependent on |
| 427 | * quantisation level and block type. |
| 428 | * 0 = do not use quantisation matrices |
| 429 | * 1 = use quantisation matrices |
| 430 | * |
| 431 | * By default, the encoder operates without quantisation matrices. |
| 432 | * |
| 433 | * Experiment: AOM_QM |
| 434 | */ |
| 435 | AV1E_SET_ENABLE_QM, |
| 436 | |
| 437 | /*!\brief Codec control function to set the min quant matrix flatness. |
| 438 | * |
| 439 | * AOM can operate with different ranges of quantisation matrices. |
| 440 | * As quantisation levels increase, the matrices get flatter. This |
| 441 | * control sets the minimum level of flatness from which the matrices |
| 442 | * are determined. |
| 443 | * |
| 444 | * By default, the encoder sets this minimum at half the available |
| 445 | * range. |
| 446 | * |
| 447 | * Experiment: AOM_QM |
| 448 | */ |
| 449 | AV1E_SET_QM_MIN, |
| 450 | |
| 451 | /*!\brief Codec control function to set the max quant matrix flatness. |
| 452 | * |
| 453 | * AOM can operate with different ranges of quantisation matrices. |
| 454 | * As quantisation levels increase, the matrices get flatter. This |
| 455 | * control sets the maximum level of flatness possible. |
| 456 | * |
| 457 | * By default, the encoder sets this maximum at the top of the |
| 458 | * available range. |
| 459 | * |
| 460 | * Experiment: AOM_QM |
| 461 | */ |
| 462 | AV1E_SET_QM_MAX, |
| 463 | |
| 464 | /*!\brief Codec control function to set a maximum number of tile groups. |
| 465 | * |
| 466 | * This will set the maximum number of tile groups. This will be |
| 467 | * overridden if an MTU size is set. The default value is 1. |
| 468 | * |
| 469 | * Experiment: TILE_GROUPS |
| 470 | */ |
| 471 | AV1E_SET_NUM_TG, |
| 472 | |
| 473 | /*!\brief Codec control function to set an MTU size for a tile group. |
| 474 | * |
| 475 | * This will set the maximum number of bytes in a tile group. This can be |
| 476 | * exceeded only if a single tile is larger than this amount. |
| 477 | * |
| 478 | * By default, the value is 0, in which case a fixed number of tile groups |
| 479 | * is used. |
| 480 | * |
| 481 | * Experiment: TILE_GROUPS |
| 482 | */ |
| 483 | AV1E_SET_MTU, |
Alex Converse | eb780e7 | 2016-12-13 12:46:41 -0800 | [diff] [blame] | 484 | |
| 485 | /*!\brief Codec control function to set the number of symbols in an ANS data |
| 486 | * window. |
| 487 | * |
| 488 | * The number of ANS symbols (both boolean and non-booleans alphabets) in an |
| 489 | * ANS data window is set to 1 << value. |
| 490 | * |
| 491 | * \note Valid range: [8, 23] |
| 492 | * |
| 493 | * Experiment: ANS |
| 494 | */ |
| 495 | AV1E_SET_ANS_WINDOW_SIZE_LOG2, |
John Koleszar | b0da9b3 | 2010-12-17 09:43:39 -0500 | [diff] [blame] | 496 | }; |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 497 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 498 | /*!\brief aom 1-D scaling mode |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 499 | * |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 500 | * This set of constants define 1-D aom scaling modes |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 501 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 502 | typedef enum aom_scaling_mode_1d { |
| 503 | AOME_NORMAL = 0, |
| 504 | AOME_FOURFIVE = 1, |
| 505 | AOME_THREEFIVE = 2, |
| 506 | AOME_ONETWO = 3 |
| 507 | } AOM_SCALING_MODE; |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 508 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 509 | /*!\brief aom region of interest map |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 510 | * |
| 511 | * These defines the data structures for the region of interest map |
| 512 | * |
| 513 | */ |
| 514 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 515 | typedef struct aom_roi_map { |
Adrian Grange | f58eca9 | 2013-10-24 15:11:36 -0700 | [diff] [blame] | 516 | /*! An id between 0 and 3 for each 16x16 region within a frame. */ |
| 517 | unsigned char *roi_map; |
clang-format | 83a5207 | 2016-08-08 20:22:13 -0700 | [diff] [blame] | 518 | unsigned int rows; /**< Number of rows. */ |
| 519 | unsigned int cols; /**< Number of columns. */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 520 | // TODO(paulwilkins): broken for AV1 which has 8 segments |
Paul Wilkins | 31ee193 | 2013-04-24 13:04:45 +0100 | [diff] [blame] | 521 | // q and loop filter deltas for each segment |
| 522 | // (see MAX_MB_SEGMENTS) |
clang-format | 83a5207 | 2016-08-08 20:22:13 -0700 | [diff] [blame] | 523 | int delta_q[4]; /**< Quantizer deltas. */ |
| 524 | int delta_lf[4]; /**< Loop filter deltas. */ |
Adrian Grange | f58eca9 | 2013-10-24 15:11:36 -0700 | [diff] [blame] | 525 | /*! Static breakout threshold for each segment. */ |
| 526 | unsigned int static_threshold[4]; |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 527 | } aom_roi_map_t; |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 528 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 529 | /*!\brief aom active region map |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 530 | * |
| 531 | * These defines the data structures for active region map |
| 532 | * |
| 533 | */ |
| 534 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 535 | typedef struct aom_active_map { |
clang-format | 83a5207 | 2016-08-08 20:22:13 -0700 | [diff] [blame] | 536 | /*!\brief specify an on (1) or off (0) each 16x16 region within a frame */ |
| 537 | unsigned char *active_map; |
| 538 | unsigned int rows; /**< number of rows */ |
| 539 | unsigned int cols; /**< number of cols */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 540 | } aom_active_map_t; |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 541 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 542 | /*!\brief aom image scaling mode |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 543 | * |
| 544 | * This defines the data structure for image scaling mode |
| 545 | * |
| 546 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 547 | typedef struct aom_scaling_mode { |
| 548 | AOM_SCALING_MODE h_scaling_mode; /**< horizontal scaling mode */ |
| 549 | AOM_SCALING_MODE v_scaling_mode; /**< vertical scaling mode */ |
| 550 | } aom_scaling_mode_t; |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 551 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 552 | /*!brief AV1 encoder content type */ |
Alex Converse | 572de92 | 2014-07-31 08:27:32 -0700 | [diff] [blame] | 553 | typedef enum { |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 554 | AOM_CONTENT_DEFAULT, |
| 555 | AOM_CONTENT_SCREEN, |
| 556 | AOM_CONTENT_INVALID |
| 557 | } aom_tune_content; |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 558 | |
Alex Converse | 6e3c805 | 2016-12-16 09:48:56 -0800 | [diff] [blame] | 559 | /*!\brief Model tuning parameters |
John Koleszar | b0da9b3 | 2010-12-17 09:43:39 -0500 | [diff] [blame] | 560 | * |
| 561 | * Changes the encoder to tune for certain types of input material. |
| 562 | * |
| 563 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 564 | typedef enum { AOM_TUNE_PSNR, AOM_TUNE_SSIM } aom_tune_metric; |
John Koleszar | b0da9b3 | 2010-12-17 09:43:39 -0500 | [diff] [blame] | 565 | |
James Zern | 7dd7a7d | 2015-10-09 16:31:17 -0700 | [diff] [blame] | 566 | /*!\cond */ |
Alex Converse | 6e3c805 | 2016-12-16 09:48:56 -0800 | [diff] [blame] | 567 | /*!\brief Encoder control function parameter type |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 568 | * |
Alex Converse | 6e3c805 | 2016-12-16 09:48:56 -0800 | [diff] [blame] | 569 | * Defines the data types that AOME/AV1E control functions take. Note that |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 570 | * additional common controls are defined in aom.h |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 571 | * |
| 572 | */ |
| 573 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 574 | AOM_CTRL_USE_TYPE_DEPRECATED(AOME_USE_REFERENCE, int) |
| 575 | #define AOM_CTRL_AOME_USE_REFERENCE |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 576 | AOM_CTRL_USE_TYPE(AOME_SET_ROI_MAP, aom_roi_map_t *) |
| 577 | #define AOM_CTRL_AOME_SET_ROI_MAP |
| 578 | AOM_CTRL_USE_TYPE(AOME_SET_ACTIVEMAP, aom_active_map_t *) |
| 579 | #define AOM_CTRL_AOME_SET_ACTIVEMAP |
| 580 | AOM_CTRL_USE_TYPE(AOME_SET_SCALEMODE, aom_scaling_mode_t *) |
| 581 | #define AOM_CTRL_AOME_SET_SCALEMODE |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 582 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 583 | AOM_CTRL_USE_TYPE(AOME_SET_CPUUSED, int) |
| 584 | #define AOM_CTRL_AOME_SET_CPUUSED |
| 585 | AOM_CTRL_USE_TYPE(AOME_SET_ENABLEAUTOALTREF, unsigned int) |
| 586 | #define AOM_CTRL_AOME_SET_ENABLEAUTOALTREF |
Zoe Liu | cf5083d | 2016-02-04 09:47:46 -0800 | [diff] [blame] | 587 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 588 | AOM_CTRL_USE_TYPE(AOME_SET_ENABLEAUTOBWDREF, unsigned int) |
| 589 | #define AOM_CTRL_AOME_SET_ENABLEAUTOBWDREF |
Zoe Liu | cf5083d | 2016-02-04 09:47:46 -0800 | [diff] [blame] | 590 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 591 | AOM_CTRL_USE_TYPE(AOME_SET_SHARPNESS, unsigned int) |
| 592 | #define AOM_CTRL_AOME_SET_SHARPNESS |
| 593 | AOM_CTRL_USE_TYPE(AOME_SET_STATIC_THRESHOLD, unsigned int) |
| 594 | #define AOM_CTRL_AOME_SET_STATIC_THRESHOLD |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 595 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 596 | AOM_CTRL_USE_TYPE(AOME_SET_ARNR_MAXFRAMES, unsigned int) |
| 597 | #define AOM_CTRL_AOME_SET_ARNR_MAXFRAMES |
| 598 | AOM_CTRL_USE_TYPE(AOME_SET_ARNR_STRENGTH, unsigned int) |
| 599 | #define AOM_CTRL_AOME_SET_ARNR_STRENGTH |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 600 | AOM_CTRL_USE_TYPE(AOME_SET_TUNING, int) /* aom_tune_metric */ |
| 601 | #define AOM_CTRL_AOME_SET_TUNING |
| 602 | AOM_CTRL_USE_TYPE(AOME_SET_CQ_LEVEL, unsigned int) |
| 603 | #define AOM_CTRL_AOME_SET_CQ_LEVEL |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 604 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 605 | AOM_CTRL_USE_TYPE(AV1E_SET_TILE_COLUMNS, int) |
| 606 | #define AOM_CTRL_AV1E_SET_TILE_COLUMNS |
| 607 | AOM_CTRL_USE_TYPE(AV1E_SET_TILE_ROWS, int) |
| 608 | #define AOM_CTRL_AV1E_SET_TILE_ROWS |
Ryan Lei | 7386eda | 2016-12-08 21:08:31 -0800 | [diff] [blame] | 609 | #if CONFIG_DEBLOCKING_ACROSS_TILES |
| 610 | AOM_CTRL_USE_TYPE(AV1E_SET_TILE_LOOPFILTER, int) |
| 611 | #define AOM_CTRL_AV1E_SET_TILE_LOOPFILTER |
| 612 | #endif // CONFIG_DEBLOCKING_ACROSS_TILES |
Ronald S. Bultje | 1407bdc | 2013-02-01 09:35:28 -0800 | [diff] [blame] | 613 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 614 | AOM_CTRL_USE_TYPE(AOME_GET_LAST_QUANTIZER, int *) |
| 615 | #define AOM_CTRL_AOME_GET_LAST_QUANTIZER |
| 616 | AOM_CTRL_USE_TYPE(AOME_GET_LAST_QUANTIZER_64, int *) |
| 617 | #define AOM_CTRL_AOME_GET_LAST_QUANTIZER_64 |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 618 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 619 | AOM_CTRL_USE_TYPE(AOME_SET_MAX_INTRA_BITRATE_PCT, unsigned int) |
| 620 | #define AOM_CTRL_AOME_SET_MAX_INTRA_BITRATE_PCT |
| 621 | AOM_CTRL_USE_TYPE(AOME_SET_MAX_INTER_BITRATE_PCT, unsigned int) |
| 622 | #define AOM_CTRL_AOME_SET_MAX_INTER_BITRATE_PCT |
John Koleszar | 1654ae9 | 2011-07-28 09:17:32 -0400 | [diff] [blame] | 623 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 624 | AOM_CTRL_USE_TYPE(AV1E_SET_GF_CBR_BOOST_PCT, unsigned int) |
| 625 | #define AOM_CTRL_AV1E_SET_GF_CBR_BOOST_PCT |
Yaowu Xu | 4165290 | 2015-03-12 17:59:18 -0700 | [diff] [blame] | 626 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 627 | AOM_CTRL_USE_TYPE(AV1E_SET_LOSSLESS, unsigned int) |
| 628 | #define AOM_CTRL_AV1E_SET_LOSSLESS |
John Koleszar | 1654ae9 | 2011-07-28 09:17:32 -0400 | [diff] [blame] | 629 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 630 | AOM_CTRL_USE_TYPE(AV1E_SET_ENABLE_QM, unsigned int) |
| 631 | #define AOM_CTRL_AV1E_SET_ENABLE_QM |
Yaowu Xu | 0818a7c | 2016-08-11 09:39:47 -0700 | [diff] [blame] | 632 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 633 | AOM_CTRL_USE_TYPE(AV1E_SET_QM_MIN, unsigned int) |
| 634 | #define AOM_CTRL_AV1E_SET_QM_MIN |
Yaowu Xu | 0818a7c | 2016-08-11 09:39:47 -0700 | [diff] [blame] | 635 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 636 | AOM_CTRL_USE_TYPE(AV1E_SET_QM_MAX, unsigned int) |
| 637 | #define AOM_CTRL_AV1E_SET_QM_MAX |
Yaowu Xu | 0818a7c | 2016-08-11 09:39:47 -0700 | [diff] [blame] | 638 | |
Thomas Davies | af6df17 | 2016-11-09 14:04:18 +0000 | [diff] [blame] | 639 | AOM_CTRL_USE_TYPE(AV1E_SET_NUM_TG, unsigned int) |
| 640 | #define AOM_CTRL_AV1E_SET_NUM_TG |
| 641 | AOM_CTRL_USE_TYPE(AV1E_SET_MTU, unsigned int) |
| 642 | #define AOM_CTRL_AV1E_SET_MTU |
Thomas Davies | af6df17 | 2016-11-09 14:04:18 +0000 | [diff] [blame] | 643 | |
Fangwen Fu | 8d164de | 2016-12-14 13:40:54 -0800 | [diff] [blame] | 644 | #if CONFIG_TEMPMV_SIGNALING |
| 645 | AOM_CTRL_USE_TYPE(AV1E_SET_DISABLE_TEMPMV, unsigned int) |
| 646 | #define AOM_CTRL_AV1E_SET_DISABLE_TEMPMV |
| 647 | #endif |
| 648 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 649 | AOM_CTRL_USE_TYPE(AV1E_SET_FRAME_PARALLEL_DECODING, unsigned int) |
| 650 | #define AOM_CTRL_AV1E_SET_FRAME_PARALLEL_DECODING |
Ivan Maltz | 01b35c3 | 2013-09-05 08:55:47 -0700 | [diff] [blame] | 651 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 652 | AOM_CTRL_USE_TYPE(AV1E_SET_AQ_MODE, unsigned int) |
| 653 | #define AOM_CTRL_AV1E_SET_AQ_MODE |
Guillaume Martres | 1708465 | 2013-11-14 19:23:57 +0100 | [diff] [blame] | 654 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 655 | AOM_CTRL_USE_TYPE(AV1E_SET_FRAME_PERIODIC_BOOST, unsigned int) |
| 656 | #define AOM_CTRL_AV1E_SET_FRAME_PERIODIC_BOOST |
Marco Paniconi | 0eb88c9 | 2014-04-03 15:49:03 -0700 | [diff] [blame] | 657 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 658 | AOM_CTRL_USE_TYPE(AV1E_SET_NOISE_SENSITIVITY, unsigned int) |
| 659 | #define AOM_CTRL_AV1E_SET_NOISE_SENSITIVITY |
JackyChen | bb1a236 | 2014-09-12 11:48:44 -0700 | [diff] [blame] | 660 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 661 | AOM_CTRL_USE_TYPE(AV1E_SET_TUNE_CONTENT, int) /* aom_tune_content */ |
| 662 | #define AOM_CTRL_AV1E_SET_TUNE_CONTENT |
Yaowu Xu | e94b415 | 2015-01-13 10:07:20 -0800 | [diff] [blame] | 663 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 664 | AOM_CTRL_USE_TYPE(AV1E_SET_COLOR_SPACE, int) |
| 665 | #define AOM_CTRL_AV1E_SET_COLOR_SPACE |
Alex Converse | 4dcb839 | 2015-03-20 14:55:43 -0700 | [diff] [blame] | 666 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 667 | AOM_CTRL_USE_TYPE(AV1E_SET_MIN_GF_INTERVAL, unsigned int) |
| 668 | #define AOM_CTRL_AV1E_SET_MIN_GF_INTERVAL |
Debargha Mukherjee | 9852643 | 2015-04-01 16:39:06 -0700 | [diff] [blame] | 669 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 670 | AOM_CTRL_USE_TYPE(AV1E_SET_MAX_GF_INTERVAL, unsigned int) |
| 671 | #define AOM_CTRL_AV1E_SET_MAX_GF_INTERVAL |
Debargha Mukherjee | 9852643 | 2015-04-01 16:39:06 -0700 | [diff] [blame] | 672 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 673 | AOM_CTRL_USE_TYPE(AV1E_GET_ACTIVEMAP, aom_active_map_t *) |
| 674 | #define AOM_CTRL_AV1E_GET_ACTIVEMAP |
Ronald S. Bultje | eeb5ef0 | 2015-09-15 21:56:51 -0400 | [diff] [blame] | 675 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 676 | AOM_CTRL_USE_TYPE(AV1E_SET_COLOR_RANGE, int) |
| 677 | #define AOM_CTRL_AV1E_SET_COLOR_RANGE |
Yaowu Xu | 7c514e2 | 2015-09-28 15:55:46 -0700 | [diff] [blame] | 678 | |
Yaowu Xu | 7c514e2 | 2015-09-28 15:55:46 -0700 | [diff] [blame] | 679 | /*!\brief |
| 680 | * |
| 681 | * TODO(rbultje) : add support of the control in ffmpeg |
| 682 | */ |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 683 | #define AOM_CTRL_AV1E_SET_RENDER_SIZE |
| 684 | AOM_CTRL_USE_TYPE(AV1E_SET_RENDER_SIZE, int *) |
Geza Lore | 454989f | 2016-03-24 13:56:05 +0000 | [diff] [blame] | 685 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 686 | AOM_CTRL_USE_TYPE(AV1E_SET_SUPERBLOCK_SIZE, unsigned int) |
| 687 | #define AOM_CTRL_AV1E_SET_SUPERBLOCK_SIZE |
James Zern | 7dd7a7d | 2015-10-09 16:31:17 -0700 | [diff] [blame] | 688 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 689 | AOM_CTRL_USE_TYPE(AV1E_SET_TARGET_LEVEL, unsigned int) |
| 690 | #define AOM_CTRL_AV1E_SET_TARGET_LEVEL |
hui su | be3f069 | 2016-05-05 15:37:37 -0700 | [diff] [blame] | 691 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 692 | AOM_CTRL_USE_TYPE(AV1E_GET_LEVEL, int *) |
| 693 | #define AOM_CTRL_AV1E_GET_LEVEL |
Alex Converse | eb780e7 | 2016-12-13 12:46:41 -0800 | [diff] [blame] | 694 | |
| 695 | AOM_CTRL_USE_TYPE(AV1E_SET_ANS_WINDOW_SIZE_LOG2, unsigned int) |
| 696 | #define AOM_CTRL_AV1E_SET_ANS_WINDOW_SIZE_LOG2 |
James Zern | 7dd7a7d | 2015-10-09 16:31:17 -0700 | [diff] [blame] | 697 | /*!\endcond */ |
Alex Converse | c77b2ff | 2016-12-12 17:29:32 -0800 | [diff] [blame] | 698 | /*! @} - end defgroup aom_encoder */ |
Dmitry Kovalev | e288c60 | 2013-09-29 18:00:15 -0700 | [diff] [blame] | 699 | #ifdef __cplusplus |
| 700 | } // extern "C" |
| 701 | #endif |
| 702 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 703 | #endif // AOM_AOMCX_H_ |