blob: 272ddff9be12970fa06a6e0f153b512f05da99f7 [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
Yaowu Xu268f1062015-03-13 09:42:57 -0700241 /*!\brief Codec control function to set number of tile columns.
Yaowu Xu87c436f2015-01-13 12:39:42 -0800242 *
Yaowu Xuf883b422016-08-30 14:01:10 -0700243 * In encoding and decoding, AV1 allows an input image frame be partitioned
Yaowu Xu87c436f2015-01-13 12:39:42 -0800244 * into separated vertical tile columns, which can be encoded or decoded
245 * independently. This enables easy implementation of parallel encoding and
246 * decoding. This control requests the encoder to use column tiles in
247 * encoding an input frame, with number of tile columns (in Log2 unit) as
248 * the parameter:
249 * 0 = 1 tile column
250 * 1 = 2 tile columns
251 * 2 = 4 tile columns
252 * .....
253 * n = 2**n tile columns
254 * The requested tile columns will be capped by encoder based on image size
255 * limitation (The minimum width of a tile column is 256 pixel, the maximum
256 * is 4096).
257 *
258 * By default, the value is 0, i.e. one single column tile for entire image.
259 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700260 AV1E_SET_TILE_COLUMNS,
Yaowu Xu87c436f2015-01-13 12:39:42 -0800261
Yaowu Xu268f1062015-03-13 09:42:57 -0700262 /*!\brief Codec control function to set number of tile rows.
Yaowu Xu87c436f2015-01-13 12:39:42 -0800263 *
Yaowu Xuf883b422016-08-30 14:01:10 -0700264 * In encoding and decoding, AV1 allows an input image frame be partitioned
Yaowu Xu87c436f2015-01-13 12:39:42 -0800265 * into separated horizontal tile rows. Tile rows are encoded or decoded
266 * sequentially. Even though encoding/decoding of later tile rows depends on
267 * earlier ones, this allows the encoder to output data packets for tile rows
268 * prior to completely processing all tile rows in a frame, thereby reducing
269 * the latency in processing between input and output. The parameter
270 * for this control describes the number of tile rows, which has a valid
271 * range [0, 2]:
272 * 0 = 1 tile row
273 * 1 = 2 tile rows
274 * 2 = 4 tile rows
275 *
276 * By default, the value is 0, i.e. one single row tile for entire image.
277 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700278 AV1E_SET_TILE_ROWS,
Yaowu Xu87c436f2015-01-13 12:39:42 -0800279
Yaowu Xu268f1062015-03-13 09:42:57 -0700280 /*!\brief Codec control function to enable frame parallel decoding feature.
Yaowu Xu87c436f2015-01-13 12:39:42 -0800281 *
Yaowu Xuf883b422016-08-30 14:01:10 -0700282 * AV1 has a bitstream feature to reduce decoding dependency between frames
Yaowu Xu87c436f2015-01-13 12:39:42 -0800283 * by turning off backward update of probability context used in encoding
284 * and decoding. This allows staged parallel processing of more than one
285 * video frames in the decoder. This control function provides a mean to
286 * turn this feature on or off for bitstreams produced by encoder.
287 *
288 * By default, this feature is off.
289 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700290 AV1E_SET_FRAME_PARALLEL_DECODING,
Yaowu Xu87c436f2015-01-13 12:39:42 -0800291
Yaowu Xu268f1062015-03-13 09:42:57 -0700292 /*!\brief Codec control function to set adaptive quantization mode.
Yaowu Xu87c436f2015-01-13 12:39:42 -0800293 *
Yaowu Xuf883b422016-08-30 14:01:10 -0700294 * AV1 has a segment based feature that allows encoder to adaptively change
Yaowu Xu87c436f2015-01-13 12:39:42 -0800295 * quantization parameter for each segment within a frame to improve the
296 * subjective quality. This control makes encoder operate in one of the
297 * several AQ_modes supported.
298 *
299 * By default, encoder operates with AQ_Mode 0(adaptive quantization off).
300 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700301 AV1E_SET_AQ_MODE,
Yaowu Xu4ab39e12015-01-14 09:07:02 -0800302
Yaowu Xu268f1062015-03-13 09:42:57 -0700303 /*!\brief Codec control function to enable/disable periodic Q boost.
Yaowu Xu4ab39e12015-01-14 09:07:02 -0800304 *
Yaowu Xuf883b422016-08-30 14:01:10 -0700305 * One AV1 encoder speed feature is to enable quality boost by lowering
Yaowu Xu4ab39e12015-01-14 09:07:02 -0800306 * frame level Q periodically. This control function provides a mean to
307 * turn on/off this feature.
308 * 0 = off
309 * 1 = on
310 *
311 * By default, the encoder is allowed to use this feature for appropriate
312 * encoding modes.
313 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700314 AV1E_SET_FRAME_PERIODIC_BOOST,
Yaowu Xu4ab39e12015-01-14 09:07:02 -0800315
Yaowu Xu268f1062015-03-13 09:42:57 -0700316 /*!\brief Codec control function to set noise sensitivity.
JackyChenbb1a2362014-09-12 11:48:44 -0700317 *
Yaowu Xu268f1062015-03-13 09:42:57 -0700318 * 0: off, 1: On(YOnly)
JackyChenbb1a2362014-09-12 11:48:44 -0700319 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700320 AV1E_SET_NOISE_SENSITIVITY,
Ivan Maltz01b35c32013-09-05 08:55:47 -0700321
Yaowu Xu268f1062015-03-13 09:42:57 -0700322 /*!\brief Codec control function to set content type.
Yaowu Xudc08b202015-01-14 11:17:09 -0800323 * \note Valid parameter range:
Yaowu Xuf883b422016-08-30 14:01:10 -0700324 * AOM_CONTENT_DEFAULT = Regular video content (Default)
325 * AOM_CONTENT_SCREEN = Screen capture content
Yaowu Xudc08b202015-01-14 11:17:09 -0800326 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700327 AV1E_SET_TUNE_CONTENT,
Yaowu Xu193ca4b2015-01-14 11:48:29 -0800328
Yaowu Xu268f1062015-03-13 09:42:57 -0700329 /*!\brief Codec control function to set color space info.
Yaowu Xue94b4152015-01-13 10:07:20 -0800330 * \note Valid ranges: 0..7, default is "UNKNOWN".
331 * 0 = UNKNOWN,
332 * 1 = BT_601
333 * 2 = BT_709
334 * 3 = SMPTE_170
335 * 4 = SMPTE_240
336 * 5 = BT_2020
337 * 6 = RESERVED
338 * 7 = SRGB
339 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700340 AV1E_SET_COLOR_SPACE,
Alex Converse4dcb8392015-03-20 14:55:43 -0700341
Debargha Mukherjee98526432015-04-01 16:39:06 -0700342 /*!\brief Codec control function to set minimum interval between GF/ARF frames
343 *
344 * By default the value is set as 4.
Debargha Mukherjee98526432015-04-01 16:39:06 -0700345 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700346 AV1E_SET_MIN_GF_INTERVAL,
Debargha Mukherjee98526432015-04-01 16:39:06 -0700347
348 /*!\brief Codec control function to set minimum interval between GF/ARF frames
349 *
350 * By default the value is set as 16.
Debargha Mukherjee98526432015-04-01 16:39:06 -0700351 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700352 AV1E_SET_MAX_GF_INTERVAL,
Debargha Mukherjee98526432015-04-01 16:39:06 -0700353
Alex Converse4dcb8392015-03-20 14:55:43 -0700354 /*!\brief Codec control function to get an Active map back from the encoder.
Alex Converse4dcb8392015-03-20 14:55:43 -0700355 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700356 AV1E_GET_ACTIVEMAP,
Ronald S. Bultjeeeb5ef02015-09-15 21:56:51 -0400357
358 /*!\brief Codec control function to set color range bit.
359 * \note Valid ranges: 0..1, default is 0
360 * 0 = Limited range (16..235 or HBD equivalent)
361 * 1 = Full range (0..255 or HBD equivalent)
Ronald S. Bultjeeeb5ef02015-09-15 21:56:51 -0400362 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700363 AV1E_SET_COLOR_RANGE,
Yaowu Xu7c514e22015-09-28 15:55:46 -0700364
Yaowu Xu7c514e22015-09-28 15:55:46 -0700365 /*!\brief Codec control function to set intended rendering image size.
366 *
367 * By default, this is identical to the image size in pixels.
Yaowu Xu7c514e22015-09-28 15:55:46 -0700368 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700369 AV1E_SET_RENDER_SIZE,
Geza Lore454989f2016-03-24 13:56:05 +0000370
hui sube3f0692016-05-05 15:37:37 -0700371 /*!\brief Codec control function to set target level.
372 *
373 * 255: off (default); 0: only keep level stats; 10: target for level 1.0;
374 * 11: target for level 1.1; ... 62: target for level 6.2
hui sube3f0692016-05-05 15:37:37 -0700375 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700376 AV1E_SET_TARGET_LEVEL,
hui su72d48902016-05-05 12:04:42 -0700377
378 /*!\brief Codec control function to get bitstream level.
hui su72d48902016-05-05 12:04:42 -0700379 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700380 AV1E_GET_LEVEL,
Yaowu Xu6fe07a22016-07-14 10:57:35 -0700381
Geza Lore454989f2016-03-24 13:56:05 +0000382 /*!\brief Codec control function to set intended superblock size.
383 *
384 * By default, the superblock size is determined separately for each
385 * frame by the encoder.
Alex Converse85370ae2016-12-13 11:18:28 -0800386 *
387 * Experiment: EXT_PARTITION
Geza Lore454989f2016-03-24 13:56:05 +0000388 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700389 AV1E_SET_SUPERBLOCK_SIZE,
Alex Converse85370ae2016-12-13 11:18:28 -0800390
391 /*!\brief Codec control function to enable automatic set and use
392 * bwd-pred frames.
393 *
394 * Experiment: EXT_REFS
395 */
396 AOME_SET_ENABLEAUTOBWDREF,
397
398 /*!\brief Codec control function to encode with quantisation matrices.
399 *
400 * AOM can operate with default quantisation matrices dependent on
401 * quantisation level and block type.
402 * 0 = do not use quantisation matrices
403 * 1 = use quantisation matrices
404 *
405 * By default, the encoder operates without quantisation matrices.
406 *
407 * Experiment: AOM_QM
408 */
409 AV1E_SET_ENABLE_QM,
410
411 /*!\brief Codec control function to set the min quant matrix flatness.
412 *
413 * AOM can operate with different ranges of quantisation matrices.
414 * As quantisation levels increase, the matrices get flatter. This
415 * control sets the minimum level of flatness from which the matrices
416 * are determined.
417 *
418 * By default, the encoder sets this minimum at half the available
419 * range.
420 *
421 * Experiment: AOM_QM
422 */
423 AV1E_SET_QM_MIN,
424
425 /*!\brief Codec control function to set the max quant matrix flatness.
426 *
427 * AOM can operate with different ranges of quantisation matrices.
428 * As quantisation levels increase, the matrices get flatter. This
429 * control sets the maximum level of flatness possible.
430 *
431 * By default, the encoder sets this maximum at the top of the
432 * available range.
433 *
434 * Experiment: AOM_QM
435 */
436 AV1E_SET_QM_MAX,
437
438 /*!\brief Codec control function to set a maximum number of tile groups.
439 *
440 * This will set the maximum number of tile groups. This will be
441 * overridden if an MTU size is set. The default value is 1.
442 *
443 * Experiment: TILE_GROUPS
444 */
445 AV1E_SET_NUM_TG,
446
447 /*!\brief Codec control function to set an MTU size for a tile group.
448 *
449 * This will set the maximum number of bytes in a tile group. This can be
450 * exceeded only if a single tile is larger than this amount.
451 *
452 * By default, the value is 0, in which case a fixed number of tile groups
453 * is used.
454 *
455 * Experiment: TILE_GROUPS
456 */
457 AV1E_SET_MTU,
John Koleszarb0da9b32010-12-17 09:43:39 -0500458};
John Koleszar0ea50ce2010-05-18 11:58:33 -0400459
Yaowu Xuf883b422016-08-30 14:01:10 -0700460/*!\brief aom 1-D scaling mode
John Koleszar0ea50ce2010-05-18 11:58:33 -0400461 *
Yaowu Xuf883b422016-08-30 14:01:10 -0700462 * This set of constants define 1-D aom scaling modes
John Koleszar0ea50ce2010-05-18 11:58:33 -0400463 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700464typedef enum aom_scaling_mode_1d {
465 AOME_NORMAL = 0,
466 AOME_FOURFIVE = 1,
467 AOME_THREEFIVE = 2,
468 AOME_ONETWO = 3
469} AOM_SCALING_MODE;
John Koleszar0ea50ce2010-05-18 11:58:33 -0400470
Yaowu Xuf883b422016-08-30 14:01:10 -0700471/*!\brief aom region of interest map
John Koleszar0ea50ce2010-05-18 11:58:33 -0400472 *
473 * These defines the data structures for the region of interest map
474 *
475 */
476
Yaowu Xuf883b422016-08-30 14:01:10 -0700477typedef struct aom_roi_map {
Adrian Grangef58eca92013-10-24 15:11:36 -0700478 /*! An id between 0 and 3 for each 16x16 region within a frame. */
479 unsigned char *roi_map;
clang-format83a52072016-08-08 20:22:13 -0700480 unsigned int rows; /**< Number of rows. */
481 unsigned int cols; /**< Number of columns. */
Yaowu Xuf883b422016-08-30 14:01:10 -0700482 // TODO(paulwilkins): broken for AV1 which has 8 segments
Paul Wilkins31ee1932013-04-24 13:04:45 +0100483 // q and loop filter deltas for each segment
484 // (see MAX_MB_SEGMENTS)
clang-format83a52072016-08-08 20:22:13 -0700485 int delta_q[4]; /**< Quantizer deltas. */
486 int delta_lf[4]; /**< Loop filter deltas. */
Adrian Grangef58eca92013-10-24 15:11:36 -0700487 /*! Static breakout threshold for each segment. */
488 unsigned int static_threshold[4];
Yaowu Xuf883b422016-08-30 14:01:10 -0700489} aom_roi_map_t;
John Koleszar0ea50ce2010-05-18 11:58:33 -0400490
Yaowu Xuf883b422016-08-30 14:01:10 -0700491/*!\brief aom active region map
John Koleszar0ea50ce2010-05-18 11:58:33 -0400492 *
493 * These defines the data structures for active region map
494 *
495 */
496
Yaowu Xuf883b422016-08-30 14:01:10 -0700497typedef struct aom_active_map {
clang-format83a52072016-08-08 20:22:13 -0700498 /*!\brief specify an on (1) or off (0) each 16x16 region within a frame */
499 unsigned char *active_map;
500 unsigned int rows; /**< number of rows */
501 unsigned int cols; /**< number of cols */
Yaowu Xuf883b422016-08-30 14:01:10 -0700502} aom_active_map_t;
John Koleszar0ea50ce2010-05-18 11:58:33 -0400503
Yaowu Xuf883b422016-08-30 14:01:10 -0700504/*!\brief aom image scaling mode
John Koleszar0ea50ce2010-05-18 11:58:33 -0400505 *
506 * This defines the data structure for image scaling mode
507 *
508 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700509typedef struct aom_scaling_mode {
510 AOM_SCALING_MODE h_scaling_mode; /**< horizontal scaling mode */
511 AOM_SCALING_MODE v_scaling_mode; /**< vertical scaling mode */
512} aom_scaling_mode_t;
John Koleszar0ea50ce2010-05-18 11:58:33 -0400513
Yaowu Xuf883b422016-08-30 14:01:10 -0700514/*!brief AV1 encoder content type */
Alex Converse572de922014-07-31 08:27:32 -0700515typedef enum {
Yaowu Xuf883b422016-08-30 14:01:10 -0700516 AOM_CONTENT_DEFAULT,
517 AOM_CONTENT_SCREEN,
518 AOM_CONTENT_INVALID
519} aom_tune_content;
John Koleszar0ea50ce2010-05-18 11:58:33 -0400520
John Koleszarb0da9b32010-12-17 09:43:39 -0500521/*!\brief VP8 model tuning parameters
522 *
523 * Changes the encoder to tune for certain types of input material.
524 *
525 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700526typedef enum { AOM_TUNE_PSNR, AOM_TUNE_SSIM } aom_tune_metric;
John Koleszarb0da9b32010-12-17 09:43:39 -0500527
James Zern7dd7a7d2015-10-09 16:31:17 -0700528/*!\cond */
John Koleszar0ea50ce2010-05-18 11:58:33 -0400529/*!\brief VP8 encoder control function parameter type
530 *
531 * Defines the data types that VP8E control functions take. Note that
Yaowu Xuf883b422016-08-30 14:01:10 -0700532 * additional common controls are defined in aom.h
John Koleszar0ea50ce2010-05-18 11:58:33 -0400533 *
534 */
535
Yaowu Xuf883b422016-08-30 14:01:10 -0700536AOM_CTRL_USE_TYPE_DEPRECATED(AOME_USE_REFERENCE, int)
537#define AOM_CTRL_AOME_USE_REFERENCE
Yaowu Xuf883b422016-08-30 14:01:10 -0700538AOM_CTRL_USE_TYPE(AOME_SET_ROI_MAP, aom_roi_map_t *)
539#define AOM_CTRL_AOME_SET_ROI_MAP
540AOM_CTRL_USE_TYPE(AOME_SET_ACTIVEMAP, aom_active_map_t *)
541#define AOM_CTRL_AOME_SET_ACTIVEMAP
542AOM_CTRL_USE_TYPE(AOME_SET_SCALEMODE, aom_scaling_mode_t *)
543#define AOM_CTRL_AOME_SET_SCALEMODE
John Koleszar0ea50ce2010-05-18 11:58:33 -0400544
Yaowu Xuf883b422016-08-30 14:01:10 -0700545AOM_CTRL_USE_TYPE(AOME_SET_CPUUSED, int)
546#define AOM_CTRL_AOME_SET_CPUUSED
547AOM_CTRL_USE_TYPE(AOME_SET_ENABLEAUTOALTREF, unsigned int)
548#define AOM_CTRL_AOME_SET_ENABLEAUTOALTREF
Zoe Liucf5083d2016-02-04 09:47:46 -0800549
Yaowu Xuf883b422016-08-30 14:01:10 -0700550AOM_CTRL_USE_TYPE(AOME_SET_ENABLEAUTOBWDREF, unsigned int)
551#define AOM_CTRL_AOME_SET_ENABLEAUTOBWDREF
Zoe Liucf5083d2016-02-04 09:47:46 -0800552
Yaowu Xuf883b422016-08-30 14:01:10 -0700553AOM_CTRL_USE_TYPE(AOME_SET_SHARPNESS, unsigned int)
554#define AOM_CTRL_AOME_SET_SHARPNESS
555AOM_CTRL_USE_TYPE(AOME_SET_STATIC_THRESHOLD, unsigned int)
556#define AOM_CTRL_AOME_SET_STATIC_THRESHOLD
John Koleszar0ea50ce2010-05-18 11:58:33 -0400557
Yaowu Xuf883b422016-08-30 14:01:10 -0700558AOM_CTRL_USE_TYPE(AOME_SET_ARNR_MAXFRAMES, unsigned int)
559#define AOM_CTRL_AOME_SET_ARNR_MAXFRAMES
560AOM_CTRL_USE_TYPE(AOME_SET_ARNR_STRENGTH, unsigned int)
561#define AOM_CTRL_AOME_SET_ARNR_STRENGTH
Yaowu Xuf883b422016-08-30 14:01:10 -0700562AOM_CTRL_USE_TYPE(AOME_SET_TUNING, int) /* aom_tune_metric */
563#define AOM_CTRL_AOME_SET_TUNING
564AOM_CTRL_USE_TYPE(AOME_SET_CQ_LEVEL, unsigned int)
565#define AOM_CTRL_AOME_SET_CQ_LEVEL
John Koleszar0ea50ce2010-05-18 11:58:33 -0400566
Yaowu Xuf883b422016-08-30 14:01:10 -0700567AOM_CTRL_USE_TYPE(AV1E_SET_TILE_COLUMNS, int)
568#define AOM_CTRL_AV1E_SET_TILE_COLUMNS
569AOM_CTRL_USE_TYPE(AV1E_SET_TILE_ROWS, int)
570#define AOM_CTRL_AV1E_SET_TILE_ROWS
Ronald S. Bultje1407bdc2013-02-01 09:35:28 -0800571
Yaowu Xuf883b422016-08-30 14:01:10 -0700572AOM_CTRL_USE_TYPE(AOME_GET_LAST_QUANTIZER, int *)
573#define AOM_CTRL_AOME_GET_LAST_QUANTIZER
574AOM_CTRL_USE_TYPE(AOME_GET_LAST_QUANTIZER_64, int *)
575#define AOM_CTRL_AOME_GET_LAST_QUANTIZER_64
John Koleszar0ea50ce2010-05-18 11:58:33 -0400576
Yaowu Xuf883b422016-08-30 14:01:10 -0700577AOM_CTRL_USE_TYPE(AOME_SET_MAX_INTRA_BITRATE_PCT, unsigned int)
578#define AOM_CTRL_AOME_SET_MAX_INTRA_BITRATE_PCT
579AOM_CTRL_USE_TYPE(AOME_SET_MAX_INTER_BITRATE_PCT, unsigned int)
580#define AOM_CTRL_AOME_SET_MAX_INTER_BITRATE_PCT
John Koleszar1654ae92011-07-28 09:17:32 -0400581
Yaowu Xuf883b422016-08-30 14:01:10 -0700582AOM_CTRL_USE_TYPE(AV1E_SET_GF_CBR_BOOST_PCT, unsigned int)
583#define AOM_CTRL_AV1E_SET_GF_CBR_BOOST_PCT
Yaowu Xu41652902015-03-12 17:59:18 -0700584
Yaowu Xuf883b422016-08-30 14:01:10 -0700585AOM_CTRL_USE_TYPE(AV1E_SET_LOSSLESS, unsigned int)
586#define AOM_CTRL_AV1E_SET_LOSSLESS
John Koleszar1654ae92011-07-28 09:17:32 -0400587
Yaowu Xuf883b422016-08-30 14:01:10 -0700588AOM_CTRL_USE_TYPE(AV1E_SET_ENABLE_QM, unsigned int)
589#define AOM_CTRL_AV1E_SET_ENABLE_QM
Yaowu Xu0818a7c2016-08-11 09:39:47 -0700590
Yaowu Xuf883b422016-08-30 14:01:10 -0700591AOM_CTRL_USE_TYPE(AV1E_SET_QM_MIN, unsigned int)
592#define AOM_CTRL_AV1E_SET_QM_MIN
Yaowu Xu0818a7c2016-08-11 09:39:47 -0700593
Yaowu Xuf883b422016-08-30 14:01:10 -0700594AOM_CTRL_USE_TYPE(AV1E_SET_QM_MAX, unsigned int)
595#define AOM_CTRL_AV1E_SET_QM_MAX
Yaowu Xu0818a7c2016-08-11 09:39:47 -0700596
Thomas Daviesaf6df172016-11-09 14:04:18 +0000597AOM_CTRL_USE_TYPE(AV1E_SET_NUM_TG, unsigned int)
598#define AOM_CTRL_AV1E_SET_NUM_TG
599AOM_CTRL_USE_TYPE(AV1E_SET_MTU, unsigned int)
600#define AOM_CTRL_AV1E_SET_MTU
Thomas Daviesaf6df172016-11-09 14:04:18 +0000601
Yaowu Xuf883b422016-08-30 14:01:10 -0700602AOM_CTRL_USE_TYPE(AV1E_SET_FRAME_PARALLEL_DECODING, unsigned int)
603#define AOM_CTRL_AV1E_SET_FRAME_PARALLEL_DECODING
Ivan Maltz01b35c32013-09-05 08:55:47 -0700604
Yaowu Xuf883b422016-08-30 14:01:10 -0700605AOM_CTRL_USE_TYPE(AV1E_SET_AQ_MODE, unsigned int)
606#define AOM_CTRL_AV1E_SET_AQ_MODE
Guillaume Martres17084652013-11-14 19:23:57 +0100607
Yaowu Xuf883b422016-08-30 14:01:10 -0700608AOM_CTRL_USE_TYPE(AV1E_SET_FRAME_PERIODIC_BOOST, unsigned int)
609#define AOM_CTRL_AV1E_SET_FRAME_PERIODIC_BOOST
Marco Paniconi0eb88c92014-04-03 15:49:03 -0700610
Yaowu Xuf883b422016-08-30 14:01:10 -0700611AOM_CTRL_USE_TYPE(AV1E_SET_NOISE_SENSITIVITY, unsigned int)
612#define AOM_CTRL_AV1E_SET_NOISE_SENSITIVITY
JackyChenbb1a2362014-09-12 11:48:44 -0700613
Yaowu Xuf883b422016-08-30 14:01:10 -0700614AOM_CTRL_USE_TYPE(AV1E_SET_TUNE_CONTENT, int) /* aom_tune_content */
615#define AOM_CTRL_AV1E_SET_TUNE_CONTENT
Yaowu Xue94b4152015-01-13 10:07:20 -0800616
Yaowu Xuf883b422016-08-30 14:01:10 -0700617AOM_CTRL_USE_TYPE(AV1E_SET_COLOR_SPACE, int)
618#define AOM_CTRL_AV1E_SET_COLOR_SPACE
Alex Converse4dcb8392015-03-20 14:55:43 -0700619
Yaowu Xuf883b422016-08-30 14:01:10 -0700620AOM_CTRL_USE_TYPE(AV1E_SET_MIN_GF_INTERVAL, unsigned int)
621#define AOM_CTRL_AV1E_SET_MIN_GF_INTERVAL
Debargha Mukherjee98526432015-04-01 16:39:06 -0700622
Yaowu Xuf883b422016-08-30 14:01:10 -0700623AOM_CTRL_USE_TYPE(AV1E_SET_MAX_GF_INTERVAL, unsigned int)
624#define AOM_CTRL_AV1E_SET_MAX_GF_INTERVAL
Debargha Mukherjee98526432015-04-01 16:39:06 -0700625
Yaowu Xuf883b422016-08-30 14:01:10 -0700626AOM_CTRL_USE_TYPE(AV1E_GET_ACTIVEMAP, aom_active_map_t *)
627#define AOM_CTRL_AV1E_GET_ACTIVEMAP
Ronald S. Bultjeeeb5ef02015-09-15 21:56:51 -0400628
Yaowu Xuf883b422016-08-30 14:01:10 -0700629AOM_CTRL_USE_TYPE(AV1E_SET_COLOR_RANGE, int)
630#define AOM_CTRL_AV1E_SET_COLOR_RANGE
Yaowu Xu7c514e22015-09-28 15:55:46 -0700631
Yaowu Xu7c514e22015-09-28 15:55:46 -0700632/*!\brief
633 *
634 * TODO(rbultje) : add support of the control in ffmpeg
635 */
Yaowu Xuf883b422016-08-30 14:01:10 -0700636#define AOM_CTRL_AV1E_SET_RENDER_SIZE
637AOM_CTRL_USE_TYPE(AV1E_SET_RENDER_SIZE, int *)
Geza Lore454989f2016-03-24 13:56:05 +0000638
Yaowu Xuf883b422016-08-30 14:01:10 -0700639AOM_CTRL_USE_TYPE(AV1E_SET_SUPERBLOCK_SIZE, unsigned int)
640#define AOM_CTRL_AV1E_SET_SUPERBLOCK_SIZE
James Zern7dd7a7d2015-10-09 16:31:17 -0700641
Yaowu Xuf883b422016-08-30 14:01:10 -0700642AOM_CTRL_USE_TYPE(AV1E_SET_TARGET_LEVEL, unsigned int)
643#define AOM_CTRL_AV1E_SET_TARGET_LEVEL
hui sube3f0692016-05-05 15:37:37 -0700644
Yaowu Xuf883b422016-08-30 14:01:10 -0700645AOM_CTRL_USE_TYPE(AV1E_GET_LEVEL, int *)
646#define AOM_CTRL_AV1E_GET_LEVEL
James Zern7dd7a7d2015-10-09 16:31:17 -0700647/*!\endcond */
Alex Conversec77b2ff2016-12-12 17:29:32 -0800648/*! @} - end defgroup aom_encoder */
Dmitry Kovaleve288c602013-09-29 18:00:15 -0700649#ifdef __cplusplus
650} // extern "C"
651#endif
652
Yaowu Xuf883b422016-08-30 14:01:10 -0700653#endif // AOM_AOMCX_H_