blob: f86f2fabf477a2ad3433c9f84736ce8abc89b6bb [file] [log] [blame]
John Koleszar0ea50ce2010-05-18 11:58:33 -04001/*
Yaowu Xu9c01aa12016-09-01 14:32:49 -07002 * Copyright (c) 2016, Alliance for Open Media. All rights reserved
John Koleszar0ea50ce2010-05-18 11:58:33 -04003 *
Yaowu Xu9c01aa12016-09-01 14:32:49 -07004 * 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 Koleszar0ea50ce2010-05-18 11:58:33 -040010 */
Yaowu Xuf883b422016-08-30 14:01:10 -070011#ifndef AOM_AOMCX_H_
12#define AOM_AOMCX_H_
John Koleszar0ea50ce2010-05-18 11:58:33 -040013
Yaowu Xu9c01aa12016-09-01 14:32:49 -070014/*!\defgroup aom_encoder AOMedia AOM/AV1 Encoder
15 * \ingroup aom
John Koleszar0ea50ce2010-05-18 11:58:33 -040016 *
17 * @{
18 */
Yaowu Xuf883b422016-08-30 14:01:10 -070019#include "./aom.h"
20#include "./aom_encoder.h"
John Koleszar0ea50ce2010-05-18 11:58:33 -040021
James Zernf42d52e2011-02-16 17:54:49 -080022/*!\file
Yaowu Xu9c01aa12016-09-01 14:32:49 -070023 * \brief Provides definitions for using AOM or AV1 encoder algorithm within the
Yaowu Xuf883b422016-08-30 14:01:10 -070024 * aom Codec Interface.
John Koleszar0ea50ce2010-05-18 11:58:33 -040025 */
Dmitry Kovaleve288c602013-09-29 18:00:15 -070026
27#ifdef __cplusplus
28extern "C" {
29#endif
John Koleszar0ea50ce2010-05-18 11:58:33 -040030
Yaowu Xuf883b422016-08-30 14:01:10 -070031/*!\name Algorithm interface for AV1
Jingning Han3ee6db62015-08-05 19:00:31 -070032 *
Yaowu Xuf883b422016-08-30 14:01:10 -070033 * This interface provides the capability to encode raw AV1 streams.
Jingning Han3ee6db62015-08-05 19:00:31 -070034 * @{
35 */
Yaowu Xuf883b422016-08-30 14:01:10 -070036extern aom_codec_iface_t aom_codec_av1_cx_algo;
37extern aom_codec_iface_t *aom_codec_av1_cx(void);
Jingning Han3ee6db62015-08-05 19:00:31 -070038/*!@} - end algorithm interface member group*/
John Koleszar0952acb2010-06-01 11:14:25 -040039
John Koleszar0ea50ce2010-05-18 11:58:33 -040040/*
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 Xuf883b422016-08-30 14:01:10 -070050#define AOM_EFLAG_NO_REF_LAST (1 << 16)
John Koleszar0ea50ce2010-05-18 11:58:33 -040051
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 Xuf883b422016-08-30 14:01:10 -070058#define AOM_EFLAG_NO_REF_GF (1 << 17)
John Koleszar0ea50ce2010-05-18 11:58:33 -040059
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 Xuf883b422016-08-30 14:01:10 -070066#define AOM_EFLAG_NO_REF_ARF (1 << 21)
John Koleszar0ea50ce2010-05-18 11:58:33 -040067
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 Xuf883b422016-08-30 14:01:10 -070073#define AOM_EFLAG_NO_UPD_LAST (1 << 18)
John Koleszar0ea50ce2010-05-18 11:58:33 -040074
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 Xuf883b422016-08-30 14:01:10 -070080#define AOM_EFLAG_NO_UPD_GF (1 << 22)
John Koleszar0ea50ce2010-05-18 11:58:33 -040081
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 Xuf883b422016-08-30 14:01:10 -070087#define AOM_EFLAG_NO_UPD_ARF (1 << 23)
John Koleszar0ea50ce2010-05-18 11:58:33 -040088
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 Xuf883b422016-08-30 14:01:10 -070094#define AOM_EFLAG_FORCE_GF (1 << 19)
John Koleszar0ea50ce2010-05-18 11:58:33 -040095
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 Xuf883b422016-08-30 14:01:10 -0700101#define AOM_EFLAG_FORCE_ARF (1 << 24)
John Koleszar0ea50ce2010-05-18 11:58:33 -0400102
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 Xuf883b422016-08-30 14:01:10 -0700108#define AOM_EFLAG_NO_UPD_ENTROPY (1 << 20)
John Koleszar0ea50ce2010-05-18 11:58:33 -0400109
Yaowu Xuf883b422016-08-30 14:01:10 -0700110/*!\brief AVx encoder control functions
John Koleszar0ea50ce2010-05-18 11:58:33 -0400111 *
Yaowu Xuf883b422016-08-30 14:01:10 -0700112 * This set of macros define the control functions available for AVx
James Zern8e17e822011-02-24 14:12:57 -0800113 * encoder interface.
114 *
Yaowu Xuf883b422016-08-30 14:01:10 -0700115 * \sa #aom_codec_control
John Koleszar0ea50ce2010-05-18 11:58:33 -0400116 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700117enum aome_enc_control_id {
Yunqing Wangbdcc1402016-03-25 09:05:25 -0700118 /*!\brief Codec control function to set which reference frame encoder can use.
Yunqing Wangbdcc1402016-03-25 09:05:25 -0700119 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700120 AOME_USE_REFERENCE = 7,
Yunqing Wangbdcc1402016-03-25 09:05:25 -0700121
Yaowu Xu268f1062015-03-13 09:42:57 -0700122 /*!\brief Codec control function to pass an ROI map to encoder.
Yaowu Xu268f1062015-03-13 09:42:57 -0700123 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700124 AOME_SET_ROI_MAP = 8,
Yaowu Xu268f1062015-03-13 09:42:57 -0700125
126 /*!\brief Codec control function to pass an Active map to encoder.
Yaowu Xu268f1062015-03-13 09:42:57 -0700127 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700128 AOME_SET_ACTIVEMAP,
Yaowu Xu268f1062015-03-13 09:42:57 -0700129
130 /*!\brief Codec control function to set encoder scaling mode.
Yaowu Xu268f1062015-03-13 09:42:57 -0700131 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700132 AOME_SET_SCALEMODE = 11,
Yaowu Xu268f1062015-03-13 09:42:57 -0700133
134 /*!\brief Codec control function to set encoder internal speed settings.
John Koleszarc6b90392012-07-13 15:21:29 -0700135 *
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 Koleszarc6b90392012-07-13 15:21:29 -0700139 *
Alex Conversec7f80702016-12-12 16:35:13 -0800140 * \note Valid range: -8..8
John Koleszarc6b90392012-07-13 15:21:29 -0700141 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700142 AOME_SET_CPUUSED = 13,
Yaowu Xu268f1062015-03-13 09:42:57 -0700143
144 /*!\brief Codec control function to enable automatic set and use alf frames.
Yaowu Xu268f1062015-03-13 09:42:57 -0700145 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700146 AOME_SET_ENABLEAUTOALTREF,
Yaowu Xu268f1062015-03-13 09:42:57 -0700147
Yaowu Xu268f1062015-03-13 09:42:57 -0700148 /*!\brief Codec control function to set sharpness.
Yaowu Xu268f1062015-03-13 09:42:57 -0700149 */
Alex Converse0f4bcda2016-12-12 15:43:35 -0800150 AOME_SET_SHARPNESS = AOME_SET_ENABLEAUTOALTREF + 2,
Yaowu Xu268f1062015-03-13 09:42:57 -0700151
152 /*!\brief Codec control function to set the threshold for MBs treated static.
Yaowu Xu268f1062015-03-13 09:42:57 -0700153 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700154 AOME_SET_STATIC_THRESHOLD,
Yaowu Xu268f1062015-03-13 09:42:57 -0700155
Yaowu Xu268f1062015-03-13 09:42:57 -0700156 /*!\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 Xu268f1062015-03-13 09:42:57 -0700159 */
Alex Converse0f4bcda2016-12-12 15:43:35 -0800160 AOME_GET_LAST_QUANTIZER = AOME_SET_STATIC_THRESHOLD + 2,
Yaowu Xu268f1062015-03-13 09:42:57 -0700161
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 Xu268f1062015-03-13 09:42:57 -0700166 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700167 AOME_GET_LAST_QUANTIZER_64,
Yaowu Xu268f1062015-03-13 09:42:57 -0700168
169 /*!\brief Codec control function to set the max no of frames to create arf.
Yaowu Xu268f1062015-03-13 09:42:57 -0700170 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700171 AOME_SET_ARNR_MAXFRAMES,
Yaowu Xu268f1062015-03-13 09:42:57 -0700172
173 /*!\brief Codec control function to set the filter strength for the arf.
Yaowu Xu268f1062015-03-13 09:42:57 -0700174 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700175 AOME_SET_ARNR_STRENGTH,
Yaowu Xu268f1062015-03-13 09:42:57 -0700176
Yaowu Xu268f1062015-03-13 09:42:57 -0700177 /*!\brief Codec control function to set visual tuning.
Yaowu Xu268f1062015-03-13 09:42:57 -0700178 */
Alex Conversefab62242016-12-13 10:09:15 -0800179 AOME_SET_TUNING = AOME_SET_ARNR_STRENGTH + 2,
Yaowu Xu268f1062015-03-13 09:42:57 -0700180
181 /*!\brief Codec control function to set constrained quality level.
John Koleszarc6b90392012-07-13 15:21:29 -0700182 *
Yaowu Xuf883b422016-08-30 14:01:10 -0700183 * \attention For this value to be used aom_codec_enc_cfg_t::g_usage must be
184 * set to #AOM_CQ.
John Koleszarc6b90392012-07-13 15:21:29 -0700185 * \note Valid range: 0..63
186 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700187 AOME_SET_CQ_LEVEL,
John Koleszar1654ae92011-07-28 09:17:32 -0400188
Yaowu Xu268f1062015-03-13 09:42:57 -0700189 /*!\brief Codec control function to set Max data rate for Intra frames.
John Koleszarc6b90392012-07-13 15:21:29 -0700190 *
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 Koleszarc6b90392012-07-13 15:21:29 -0700199 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700200 AOME_SET_MAX_INTRA_BITRATE_PCT,
John Koleszar83b1d902012-11-05 12:37:14 -0800201
Yaowu Xu268f1062015-03-13 09:42:57 -0700202 /*!\brief Codec control function to set max data rate for Inter frames.
Yaowu Xu636099f2014-10-24 09:31:16 -0700203 *
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 Xu636099f2014-10-24 09:31:16 -0700212 */
Alex Converse0f4bcda2016-12-12 15:43:35 -0800213 AV1E_SET_MAX_INTER_BITRATE_PCT = AOME_SET_MAX_INTRA_BITRATE_PCT + 2,
Yaowu Xu636099f2014-10-24 09:31:16 -0700214
Yaowu Xu268f1062015-03-13 09:42:57 -0700215 /*!\brief Boost percentage for Golden Frame in CBR mode.
Yaowu Xu03a60b72014-10-27 13:13:14 -0700216 *
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 Xu03a60b72014-10-27 13:13:14 -0700225 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700226 AV1E_SET_GF_CBR_BOOST_PCT,
John Koleszar83b1d902012-11-05 12:37:14 -0800227
Yaowu Xu268f1062015-03-13 09:42:57 -0700228 /*!\brief Codec control function to set lossless encoding mode.
Yaowu Xu87c436f2015-01-13 12:39:42 -0800229 *
Yaowu Xuf883b422016-08-30 14:01:10 -0700230 * AV1 can operate in lossless encoding mode, in which the bitstream
Yaowu Xu87c436f2015-01-13 12:39:42 -0800231 * 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 Converse0f4bcda2016-12-12 15:43:35 -0800239 AV1E_SET_LOSSLESS = AV1E_SET_GF_CBR_BOOST_PCT + 2,
Thomas Daviesaf6df172016-11-09 14:04:18 +0000240
Fangwen Fu8d164de2016-12-14 13:40:54 -0800241#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 Xu268f1062015-03-13 09:42:57 -0700251 /*!\brief Codec control function to set number of tile columns.
Yaowu Xu87c436f2015-01-13 12:39:42 -0800252 *
Yaowu Xuf883b422016-08-30 14:01:10 -0700253 * In encoding and decoding, AV1 allows an input image frame be partitioned
Yaowu Xu87c436f2015-01-13 12:39:42 -0800254 * 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 Xuf883b422016-08-30 14:01:10 -0700270 AV1E_SET_TILE_COLUMNS,
Yaowu Xu87c436f2015-01-13 12:39:42 -0800271
Yaowu Xu268f1062015-03-13 09:42:57 -0700272 /*!\brief Codec control function to set number of tile rows.
Yaowu Xu87c436f2015-01-13 12:39:42 -0800273 *
Yaowu Xuf883b422016-08-30 14:01:10 -0700274 * In encoding and decoding, AV1 allows an input image frame be partitioned
Yaowu Xu87c436f2015-01-13 12:39:42 -0800275 * 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 Xuf883b422016-08-30 14:01:10 -0700288 AV1E_SET_TILE_ROWS,
Yaowu Xu87c436f2015-01-13 12:39:42 -0800289
Ryan Lei7386eda2016-12-08 21:08:31 -0800290#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 Xu268f1062015-03-13 09:42:57 -0700306 /*!\brief Codec control function to enable frame parallel decoding feature.
Yaowu Xu87c436f2015-01-13 12:39:42 -0800307 *
Yaowu Xuf883b422016-08-30 14:01:10 -0700308 * AV1 has a bitstream feature to reduce decoding dependency between frames
Yaowu Xu87c436f2015-01-13 12:39:42 -0800309 * 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 Xuf883b422016-08-30 14:01:10 -0700316 AV1E_SET_FRAME_PARALLEL_DECODING,
Yaowu Xu87c436f2015-01-13 12:39:42 -0800317
Yaowu Xu268f1062015-03-13 09:42:57 -0700318 /*!\brief Codec control function to set adaptive quantization mode.
Yaowu Xu87c436f2015-01-13 12:39:42 -0800319 *
Yaowu Xuf883b422016-08-30 14:01:10 -0700320 * AV1 has a segment based feature that allows encoder to adaptively change
Yaowu Xu87c436f2015-01-13 12:39:42 -0800321 * 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 Xuf883b422016-08-30 14:01:10 -0700327 AV1E_SET_AQ_MODE,
Yaowu Xu4ab39e12015-01-14 09:07:02 -0800328
Yaowu Xu268f1062015-03-13 09:42:57 -0700329 /*!\brief Codec control function to enable/disable periodic Q boost.
Yaowu Xu4ab39e12015-01-14 09:07:02 -0800330 *
Yaowu Xuf883b422016-08-30 14:01:10 -0700331 * One AV1 encoder speed feature is to enable quality boost by lowering
Yaowu Xu4ab39e12015-01-14 09:07:02 -0800332 * 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 Xuf883b422016-08-30 14:01:10 -0700340 AV1E_SET_FRAME_PERIODIC_BOOST,
Yaowu Xu4ab39e12015-01-14 09:07:02 -0800341
Yaowu Xu268f1062015-03-13 09:42:57 -0700342 /*!\brief Codec control function to set noise sensitivity.
JackyChenbb1a2362014-09-12 11:48:44 -0700343 *
Yaowu Xu268f1062015-03-13 09:42:57 -0700344 * 0: off, 1: On(YOnly)
JackyChenbb1a2362014-09-12 11:48:44 -0700345 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700346 AV1E_SET_NOISE_SENSITIVITY,
Ivan Maltz01b35c32013-09-05 08:55:47 -0700347
Yaowu Xu268f1062015-03-13 09:42:57 -0700348 /*!\brief Codec control function to set content type.
Yaowu Xudc08b202015-01-14 11:17:09 -0800349 * \note Valid parameter range:
Yaowu Xuf883b422016-08-30 14:01:10 -0700350 * AOM_CONTENT_DEFAULT = Regular video content (Default)
351 * AOM_CONTENT_SCREEN = Screen capture content
Yaowu Xudc08b202015-01-14 11:17:09 -0800352 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700353 AV1E_SET_TUNE_CONTENT,
Yaowu Xu193ca4b2015-01-14 11:48:29 -0800354
Yaowu Xu268f1062015-03-13 09:42:57 -0700355 /*!\brief Codec control function to set color space info.
Yaowu Xue94b4152015-01-13 10:07:20 -0800356 * \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 Xuf883b422016-08-30 14:01:10 -0700366 AV1E_SET_COLOR_SPACE,
Alex Converse4dcb8392015-03-20 14:55:43 -0700367
Debargha Mukherjee98526432015-04-01 16:39:06 -0700368 /*!\brief Codec control function to set minimum interval between GF/ARF frames
369 *
370 * By default the value is set as 4.
Debargha Mukherjee98526432015-04-01 16:39:06 -0700371 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700372 AV1E_SET_MIN_GF_INTERVAL,
Debargha Mukherjee98526432015-04-01 16:39:06 -0700373
374 /*!\brief Codec control function to set minimum interval between GF/ARF frames
375 *
376 * By default the value is set as 16.
Debargha Mukherjee98526432015-04-01 16:39:06 -0700377 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700378 AV1E_SET_MAX_GF_INTERVAL,
Debargha Mukherjee98526432015-04-01 16:39:06 -0700379
Alex Converse4dcb8392015-03-20 14:55:43 -0700380 /*!\brief Codec control function to get an Active map back from the encoder.
Alex Converse4dcb8392015-03-20 14:55:43 -0700381 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700382 AV1E_GET_ACTIVEMAP,
Ronald S. Bultjeeeb5ef02015-09-15 21:56:51 -0400383
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. Bultjeeeb5ef02015-09-15 21:56:51 -0400388 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700389 AV1E_SET_COLOR_RANGE,
Yaowu Xu7c514e22015-09-28 15:55:46 -0700390
Yaowu Xu7c514e22015-09-28 15:55:46 -0700391 /*!\brief Codec control function to set intended rendering image size.
392 *
393 * By default, this is identical to the image size in pixels.
Yaowu Xu7c514e22015-09-28 15:55:46 -0700394 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700395 AV1E_SET_RENDER_SIZE,
Geza Lore454989f2016-03-24 13:56:05 +0000396
hui sube3f0692016-05-05 15:37:37 -0700397 /*!\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 sube3f0692016-05-05 15:37:37 -0700401 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700402 AV1E_SET_TARGET_LEVEL,
hui su72d48902016-05-05 12:04:42 -0700403
404 /*!\brief Codec control function to get bitstream level.
hui su72d48902016-05-05 12:04:42 -0700405 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700406 AV1E_GET_LEVEL,
Yaowu Xu6fe07a22016-07-14 10:57:35 -0700407
Geza Lore454989f2016-03-24 13:56:05 +0000408 /*!\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 Converse85370ae2016-12-13 11:18:28 -0800412 *
413 * Experiment: EXT_PARTITION
Geza Lore454989f2016-03-24 13:56:05 +0000414 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700415 AV1E_SET_SUPERBLOCK_SIZE,
Alex Converse85370ae2016-12-13 11:18:28 -0800416
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 Converseeb780e72016-12-13 12:46:41 -0800484
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 Koleszarb0da9b32010-12-17 09:43:39 -0500496};
John Koleszar0ea50ce2010-05-18 11:58:33 -0400497
Yaowu Xuf883b422016-08-30 14:01:10 -0700498/*!\brief aom 1-D scaling mode
John Koleszar0ea50ce2010-05-18 11:58:33 -0400499 *
Yaowu Xuf883b422016-08-30 14:01:10 -0700500 * This set of constants define 1-D aom scaling modes
John Koleszar0ea50ce2010-05-18 11:58:33 -0400501 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700502typedef 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 Koleszar0ea50ce2010-05-18 11:58:33 -0400508
Yaowu Xuf883b422016-08-30 14:01:10 -0700509/*!\brief aom region of interest map
John Koleszar0ea50ce2010-05-18 11:58:33 -0400510 *
511 * These defines the data structures for the region of interest map
512 *
513 */
514
Yaowu Xuf883b422016-08-30 14:01:10 -0700515typedef struct aom_roi_map {
Adrian Grangef58eca92013-10-24 15:11:36 -0700516 /*! An id between 0 and 3 for each 16x16 region within a frame. */
517 unsigned char *roi_map;
clang-format83a52072016-08-08 20:22:13 -0700518 unsigned int rows; /**< Number of rows. */
519 unsigned int cols; /**< Number of columns. */
Yaowu Xuf883b422016-08-30 14:01:10 -0700520 // TODO(paulwilkins): broken for AV1 which has 8 segments
Paul Wilkins31ee1932013-04-24 13:04:45 +0100521 // q and loop filter deltas for each segment
522 // (see MAX_MB_SEGMENTS)
clang-format83a52072016-08-08 20:22:13 -0700523 int delta_q[4]; /**< Quantizer deltas. */
524 int delta_lf[4]; /**< Loop filter deltas. */
Adrian Grangef58eca92013-10-24 15:11:36 -0700525 /*! Static breakout threshold for each segment. */
526 unsigned int static_threshold[4];
Yaowu Xuf883b422016-08-30 14:01:10 -0700527} aom_roi_map_t;
John Koleszar0ea50ce2010-05-18 11:58:33 -0400528
Yaowu Xuf883b422016-08-30 14:01:10 -0700529/*!\brief aom active region map
John Koleszar0ea50ce2010-05-18 11:58:33 -0400530 *
531 * These defines the data structures for active region map
532 *
533 */
534
Yaowu Xuf883b422016-08-30 14:01:10 -0700535typedef struct aom_active_map {
clang-format83a52072016-08-08 20:22:13 -0700536 /*!\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 Xuf883b422016-08-30 14:01:10 -0700540} aom_active_map_t;
John Koleszar0ea50ce2010-05-18 11:58:33 -0400541
Yaowu Xuf883b422016-08-30 14:01:10 -0700542/*!\brief aom image scaling mode
John Koleszar0ea50ce2010-05-18 11:58:33 -0400543 *
544 * This defines the data structure for image scaling mode
545 *
546 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700547typedef 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 Koleszar0ea50ce2010-05-18 11:58:33 -0400551
Yaowu Xuf883b422016-08-30 14:01:10 -0700552/*!brief AV1 encoder content type */
Alex Converse572de922014-07-31 08:27:32 -0700553typedef enum {
Yaowu Xuf883b422016-08-30 14:01:10 -0700554 AOM_CONTENT_DEFAULT,
555 AOM_CONTENT_SCREEN,
556 AOM_CONTENT_INVALID
557} aom_tune_content;
John Koleszar0ea50ce2010-05-18 11:58:33 -0400558
Alex Converse6e3c8052016-12-16 09:48:56 -0800559/*!\brief Model tuning parameters
John Koleszarb0da9b32010-12-17 09:43:39 -0500560 *
561 * Changes the encoder to tune for certain types of input material.
562 *
563 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700564typedef enum { AOM_TUNE_PSNR, AOM_TUNE_SSIM } aom_tune_metric;
John Koleszarb0da9b32010-12-17 09:43:39 -0500565
James Zern7dd7a7d2015-10-09 16:31:17 -0700566/*!\cond */
Alex Converse6e3c8052016-12-16 09:48:56 -0800567/*!\brief Encoder control function parameter type
John Koleszar0ea50ce2010-05-18 11:58:33 -0400568 *
Alex Converse6e3c8052016-12-16 09:48:56 -0800569 * Defines the data types that AOME/AV1E control functions take. Note that
Yaowu Xuf883b422016-08-30 14:01:10 -0700570 * additional common controls are defined in aom.h
John Koleszar0ea50ce2010-05-18 11:58:33 -0400571 *
572 */
573
Yaowu Xuf883b422016-08-30 14:01:10 -0700574AOM_CTRL_USE_TYPE_DEPRECATED(AOME_USE_REFERENCE, int)
575#define AOM_CTRL_AOME_USE_REFERENCE
Yaowu Xuf883b422016-08-30 14:01:10 -0700576AOM_CTRL_USE_TYPE(AOME_SET_ROI_MAP, aom_roi_map_t *)
577#define AOM_CTRL_AOME_SET_ROI_MAP
578AOM_CTRL_USE_TYPE(AOME_SET_ACTIVEMAP, aom_active_map_t *)
579#define AOM_CTRL_AOME_SET_ACTIVEMAP
580AOM_CTRL_USE_TYPE(AOME_SET_SCALEMODE, aom_scaling_mode_t *)
581#define AOM_CTRL_AOME_SET_SCALEMODE
John Koleszar0ea50ce2010-05-18 11:58:33 -0400582
Yaowu Xuf883b422016-08-30 14:01:10 -0700583AOM_CTRL_USE_TYPE(AOME_SET_CPUUSED, int)
584#define AOM_CTRL_AOME_SET_CPUUSED
585AOM_CTRL_USE_TYPE(AOME_SET_ENABLEAUTOALTREF, unsigned int)
586#define AOM_CTRL_AOME_SET_ENABLEAUTOALTREF
Zoe Liucf5083d2016-02-04 09:47:46 -0800587
Yaowu Xuf883b422016-08-30 14:01:10 -0700588AOM_CTRL_USE_TYPE(AOME_SET_ENABLEAUTOBWDREF, unsigned int)
589#define AOM_CTRL_AOME_SET_ENABLEAUTOBWDREF
Zoe Liucf5083d2016-02-04 09:47:46 -0800590
Yaowu Xuf883b422016-08-30 14:01:10 -0700591AOM_CTRL_USE_TYPE(AOME_SET_SHARPNESS, unsigned int)
592#define AOM_CTRL_AOME_SET_SHARPNESS
593AOM_CTRL_USE_TYPE(AOME_SET_STATIC_THRESHOLD, unsigned int)
594#define AOM_CTRL_AOME_SET_STATIC_THRESHOLD
John Koleszar0ea50ce2010-05-18 11:58:33 -0400595
Yaowu Xuf883b422016-08-30 14:01:10 -0700596AOM_CTRL_USE_TYPE(AOME_SET_ARNR_MAXFRAMES, unsigned int)
597#define AOM_CTRL_AOME_SET_ARNR_MAXFRAMES
598AOM_CTRL_USE_TYPE(AOME_SET_ARNR_STRENGTH, unsigned int)
599#define AOM_CTRL_AOME_SET_ARNR_STRENGTH
Yaowu Xuf883b422016-08-30 14:01:10 -0700600AOM_CTRL_USE_TYPE(AOME_SET_TUNING, int) /* aom_tune_metric */
601#define AOM_CTRL_AOME_SET_TUNING
602AOM_CTRL_USE_TYPE(AOME_SET_CQ_LEVEL, unsigned int)
603#define AOM_CTRL_AOME_SET_CQ_LEVEL
John Koleszar0ea50ce2010-05-18 11:58:33 -0400604
Yaowu Xuf883b422016-08-30 14:01:10 -0700605AOM_CTRL_USE_TYPE(AV1E_SET_TILE_COLUMNS, int)
606#define AOM_CTRL_AV1E_SET_TILE_COLUMNS
607AOM_CTRL_USE_TYPE(AV1E_SET_TILE_ROWS, int)
608#define AOM_CTRL_AV1E_SET_TILE_ROWS
Ryan Lei7386eda2016-12-08 21:08:31 -0800609#if CONFIG_DEBLOCKING_ACROSS_TILES
610AOM_CTRL_USE_TYPE(AV1E_SET_TILE_LOOPFILTER, int)
611#define AOM_CTRL_AV1E_SET_TILE_LOOPFILTER
612#endif // CONFIG_DEBLOCKING_ACROSS_TILES
Ronald S. Bultje1407bdc2013-02-01 09:35:28 -0800613
Yaowu Xuf883b422016-08-30 14:01:10 -0700614AOM_CTRL_USE_TYPE(AOME_GET_LAST_QUANTIZER, int *)
615#define AOM_CTRL_AOME_GET_LAST_QUANTIZER
616AOM_CTRL_USE_TYPE(AOME_GET_LAST_QUANTIZER_64, int *)
617#define AOM_CTRL_AOME_GET_LAST_QUANTIZER_64
John Koleszar0ea50ce2010-05-18 11:58:33 -0400618
Yaowu Xuf883b422016-08-30 14:01:10 -0700619AOM_CTRL_USE_TYPE(AOME_SET_MAX_INTRA_BITRATE_PCT, unsigned int)
620#define AOM_CTRL_AOME_SET_MAX_INTRA_BITRATE_PCT
621AOM_CTRL_USE_TYPE(AOME_SET_MAX_INTER_BITRATE_PCT, unsigned int)
622#define AOM_CTRL_AOME_SET_MAX_INTER_BITRATE_PCT
John Koleszar1654ae92011-07-28 09:17:32 -0400623
Yaowu Xuf883b422016-08-30 14:01:10 -0700624AOM_CTRL_USE_TYPE(AV1E_SET_GF_CBR_BOOST_PCT, unsigned int)
625#define AOM_CTRL_AV1E_SET_GF_CBR_BOOST_PCT
Yaowu Xu41652902015-03-12 17:59:18 -0700626
Yaowu Xuf883b422016-08-30 14:01:10 -0700627AOM_CTRL_USE_TYPE(AV1E_SET_LOSSLESS, unsigned int)
628#define AOM_CTRL_AV1E_SET_LOSSLESS
John Koleszar1654ae92011-07-28 09:17:32 -0400629
Yaowu Xuf883b422016-08-30 14:01:10 -0700630AOM_CTRL_USE_TYPE(AV1E_SET_ENABLE_QM, unsigned int)
631#define AOM_CTRL_AV1E_SET_ENABLE_QM
Yaowu Xu0818a7c2016-08-11 09:39:47 -0700632
Yaowu Xuf883b422016-08-30 14:01:10 -0700633AOM_CTRL_USE_TYPE(AV1E_SET_QM_MIN, unsigned int)
634#define AOM_CTRL_AV1E_SET_QM_MIN
Yaowu Xu0818a7c2016-08-11 09:39:47 -0700635
Yaowu Xuf883b422016-08-30 14:01:10 -0700636AOM_CTRL_USE_TYPE(AV1E_SET_QM_MAX, unsigned int)
637#define AOM_CTRL_AV1E_SET_QM_MAX
Yaowu Xu0818a7c2016-08-11 09:39:47 -0700638
Thomas Daviesaf6df172016-11-09 14:04:18 +0000639AOM_CTRL_USE_TYPE(AV1E_SET_NUM_TG, unsigned int)
640#define AOM_CTRL_AV1E_SET_NUM_TG
641AOM_CTRL_USE_TYPE(AV1E_SET_MTU, unsigned int)
642#define AOM_CTRL_AV1E_SET_MTU
Thomas Daviesaf6df172016-11-09 14:04:18 +0000643
Fangwen Fu8d164de2016-12-14 13:40:54 -0800644#if CONFIG_TEMPMV_SIGNALING
645AOM_CTRL_USE_TYPE(AV1E_SET_DISABLE_TEMPMV, unsigned int)
646#define AOM_CTRL_AV1E_SET_DISABLE_TEMPMV
647#endif
648
Yaowu Xuf883b422016-08-30 14:01:10 -0700649AOM_CTRL_USE_TYPE(AV1E_SET_FRAME_PARALLEL_DECODING, unsigned int)
650#define AOM_CTRL_AV1E_SET_FRAME_PARALLEL_DECODING
Ivan Maltz01b35c32013-09-05 08:55:47 -0700651
Yaowu Xuf883b422016-08-30 14:01:10 -0700652AOM_CTRL_USE_TYPE(AV1E_SET_AQ_MODE, unsigned int)
653#define AOM_CTRL_AV1E_SET_AQ_MODE
Guillaume Martres17084652013-11-14 19:23:57 +0100654
Yaowu Xuf883b422016-08-30 14:01:10 -0700655AOM_CTRL_USE_TYPE(AV1E_SET_FRAME_PERIODIC_BOOST, unsigned int)
656#define AOM_CTRL_AV1E_SET_FRAME_PERIODIC_BOOST
Marco Paniconi0eb88c92014-04-03 15:49:03 -0700657
Yaowu Xuf883b422016-08-30 14:01:10 -0700658AOM_CTRL_USE_TYPE(AV1E_SET_NOISE_SENSITIVITY, unsigned int)
659#define AOM_CTRL_AV1E_SET_NOISE_SENSITIVITY
JackyChenbb1a2362014-09-12 11:48:44 -0700660
Yaowu Xuf883b422016-08-30 14:01:10 -0700661AOM_CTRL_USE_TYPE(AV1E_SET_TUNE_CONTENT, int) /* aom_tune_content */
662#define AOM_CTRL_AV1E_SET_TUNE_CONTENT
Yaowu Xue94b4152015-01-13 10:07:20 -0800663
Yaowu Xuf883b422016-08-30 14:01:10 -0700664AOM_CTRL_USE_TYPE(AV1E_SET_COLOR_SPACE, int)
665#define AOM_CTRL_AV1E_SET_COLOR_SPACE
Alex Converse4dcb8392015-03-20 14:55:43 -0700666
Yaowu Xuf883b422016-08-30 14:01:10 -0700667AOM_CTRL_USE_TYPE(AV1E_SET_MIN_GF_INTERVAL, unsigned int)
668#define AOM_CTRL_AV1E_SET_MIN_GF_INTERVAL
Debargha Mukherjee98526432015-04-01 16:39:06 -0700669
Yaowu Xuf883b422016-08-30 14:01:10 -0700670AOM_CTRL_USE_TYPE(AV1E_SET_MAX_GF_INTERVAL, unsigned int)
671#define AOM_CTRL_AV1E_SET_MAX_GF_INTERVAL
Debargha Mukherjee98526432015-04-01 16:39:06 -0700672
Yaowu Xuf883b422016-08-30 14:01:10 -0700673AOM_CTRL_USE_TYPE(AV1E_GET_ACTIVEMAP, aom_active_map_t *)
674#define AOM_CTRL_AV1E_GET_ACTIVEMAP
Ronald S. Bultjeeeb5ef02015-09-15 21:56:51 -0400675
Yaowu Xuf883b422016-08-30 14:01:10 -0700676AOM_CTRL_USE_TYPE(AV1E_SET_COLOR_RANGE, int)
677#define AOM_CTRL_AV1E_SET_COLOR_RANGE
Yaowu Xu7c514e22015-09-28 15:55:46 -0700678
Yaowu Xu7c514e22015-09-28 15:55:46 -0700679/*!\brief
680 *
681 * TODO(rbultje) : add support of the control in ffmpeg
682 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700683#define AOM_CTRL_AV1E_SET_RENDER_SIZE
684AOM_CTRL_USE_TYPE(AV1E_SET_RENDER_SIZE, int *)
Geza Lore454989f2016-03-24 13:56:05 +0000685
Yaowu Xuf883b422016-08-30 14:01:10 -0700686AOM_CTRL_USE_TYPE(AV1E_SET_SUPERBLOCK_SIZE, unsigned int)
687#define AOM_CTRL_AV1E_SET_SUPERBLOCK_SIZE
James Zern7dd7a7d2015-10-09 16:31:17 -0700688
Yaowu Xuf883b422016-08-30 14:01:10 -0700689AOM_CTRL_USE_TYPE(AV1E_SET_TARGET_LEVEL, unsigned int)
690#define AOM_CTRL_AV1E_SET_TARGET_LEVEL
hui sube3f0692016-05-05 15:37:37 -0700691
Yaowu Xuf883b422016-08-30 14:01:10 -0700692AOM_CTRL_USE_TYPE(AV1E_GET_LEVEL, int *)
693#define AOM_CTRL_AV1E_GET_LEVEL
Alex Converseeb780e72016-12-13 12:46:41 -0800694
695AOM_CTRL_USE_TYPE(AV1E_SET_ANS_WINDOW_SIZE_LOG2, unsigned int)
696#define AOM_CTRL_AV1E_SET_ANS_WINDOW_SIZE_LOG2
James Zern7dd7a7d2015-10-09 16:31:17 -0700697/*!\endcond */
Alex Conversec77b2ff2016-12-12 17:29:32 -0800698/*! @} - end defgroup aom_encoder */
Dmitry Kovaleve288c602013-09-29 18:00:15 -0700699#ifdef __cplusplus
700} // extern "C"
701#endif
702
Yaowu Xuf883b422016-08-30 14:01:10 -0700703#endif // AOM_AOMCX_H_