vp8cx.h 26.4 KB
Newer Older
John Koleszar's avatar
John Koleszar committed
1
/*
2
 * Copyright (c) 2016, Alliance for Open Media. All rights reserved
John Koleszar's avatar
John Koleszar committed
3
 *
4 5 6 7 8 9
 * This source code is subject to the terms of the BSD 2 Clause License and
 * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
 * was not distributed with this source code in the LICENSE file, you can
 * obtain it at www.aomedia.org/license/software. If the Alliance for Open
 * Media Patent License 1.0 was not distributed with this source code in the
 * PATENTS file, you can obtain it at www.aomedia.org/license/patent.
John Koleszar's avatar
John Koleszar committed
10
 */
Adrian Grange's avatar
Adrian Grange committed
11 12
#ifndef AOM_AOMCX_H_
#define AOM_AOMCX_H_
John Koleszar's avatar
John Koleszar committed
13

Adrian Grange's avatar
Adrian Grange committed
14
/*!\defgroup vp8_encoder WebM AOM/VP9 Encoder
John Koleszar's avatar
John Koleszar committed
15 16 17 18
 * \ingroup vp8
 *
 * @{
 */
19
#include "./vp8.h"
Adrian Grange's avatar
Adrian Grange committed
20
#include "./aom_encoder.h"
John Koleszar's avatar
John Koleszar committed
21

James Zern's avatar
James Zern committed
22
/*!\file
Adrian Grange's avatar
Adrian Grange committed
23
 * \brief Provides definitions for using AOM or VP9 encoder algorithm within the
Adrian Grange's avatar
Adrian Grange committed
24
 *        aom Codec Interface.
John Koleszar's avatar
John Koleszar committed
25
 */
26 27 28 29

#ifdef __cplusplus
extern "C" {
#endif
John Koleszar's avatar
John Koleszar committed
30

31
/*!\name Algorithm interface for AV1
Jingning Han's avatar
Jingning Han committed
32
 *
33
 * This interface provides the capability to encode raw AV1 streams.
Jingning Han's avatar
Jingning Han committed
34 35
 * @{
 */
36 37
extern aom_codec_iface_t aom_codec_av1_cx_algo;
extern aom_codec_iface_t *aom_codec_av1_cx(void);
Jingning Han's avatar
Jingning Han committed
38
/*!@} - end algorithm interface member group*/
39

John Koleszar's avatar
John Koleszar committed
40 41 42 43 44 45 46 47 48 49
/*
 * Algorithm Flags
 */

/*!\brief Don't reference the last frame
 *
 * When this flag is set, the encoder will not use the last frame as a
 * predictor. When not set, the encoder will choose whether to use the
 * last frame or not automatically.
 */
Adrian Grange's avatar
Adrian Grange committed
50
#define AOM_EFLAG_NO_REF_LAST (1 << 16)
John Koleszar's avatar
John Koleszar committed
51 52 53 54 55 56 57

/*!\brief Don't reference the golden frame
 *
 * When this flag is set, the encoder will not use the golden frame as a
 * predictor. When not set, the encoder will choose whether to use the
 * golden frame or not automatically.
 */
Adrian Grange's avatar
Adrian Grange committed
58
#define AOM_EFLAG_NO_REF_GF (1 << 17)
John Koleszar's avatar
John Koleszar committed
59 60 61 62 63 64 65

/*!\brief Don't reference the alternate reference frame
 *
 * When this flag is set, the encoder will not use the alt ref frame as a
 * predictor. When not set, the encoder will choose whether to use the
 * alt ref frame or not automatically.
 */
Adrian Grange's avatar
Adrian Grange committed
66
#define AOM_EFLAG_NO_REF_ARF (1 << 21)
John Koleszar's avatar
John Koleszar committed
67 68 69 70 71 72

/*!\brief Don't update the last frame
 *
 * When this flag is set, the encoder will not update the last frame with
 * the contents of the current frame.
 */
Adrian Grange's avatar
Adrian Grange committed
73
#define AOM_EFLAG_NO_UPD_LAST (1 << 18)
John Koleszar's avatar
John Koleszar committed
74 75 76 77 78 79

/*!\brief Don't update the golden frame
 *
 * When this flag is set, the encoder will not update the golden frame with
 * the contents of the current frame.
 */
Adrian Grange's avatar
Adrian Grange committed
80
#define AOM_EFLAG_NO_UPD_GF (1 << 22)
John Koleszar's avatar
John Koleszar committed
81 82 83 84 85 86

/*!\brief Don't update the alternate reference frame
 *
 * When this flag is set, the encoder will not update the alt ref frame with
 * the contents of the current frame.
 */
Adrian Grange's avatar
Adrian Grange committed
87
#define AOM_EFLAG_NO_UPD_ARF (1 << 23)
John Koleszar's avatar
John Koleszar committed
88 89 90 91 92 93

/*!\brief Force golden frame update
 *
 * When this flag is set, the encoder copy the contents of the current frame
 * to the golden frame buffer.
 */
Adrian Grange's avatar
Adrian Grange committed
94
#define AOM_EFLAG_FORCE_GF (1 << 19)
John Koleszar's avatar
John Koleszar committed
95 96 97 98 99 100

/*!\brief Force alternate reference frame update
 *
 * When this flag is set, the encoder copy the contents of the current frame
 * to the alternate reference frame buffer.
 */
Adrian Grange's avatar
Adrian Grange committed
101
#define AOM_EFLAG_FORCE_ARF (1 << 24)
John Koleszar's avatar
John Koleszar committed
102 103 104 105 106 107

/*!\brief Disable entropy update
 *
 * When this flag is set, the encoder will not update its internal entropy
 * model based on the entropy of this frame.
 */
Adrian Grange's avatar
Adrian Grange committed
108
#define AOM_EFLAG_NO_UPD_ENTROPY (1 << 20)
John Koleszar's avatar
John Koleszar committed
109

110
/*!\brief VPx encoder control functions
John Koleszar's avatar
John Koleszar committed
111
 *
112
 * This set of macros define the control functions available for VPx
113 114
 * encoder interface.
 *
Adrian Grange's avatar
Adrian Grange committed
115
 * \sa #aom_codec_control
John Koleszar's avatar
John Koleszar committed
116
 */
John Koleszar's avatar
John Koleszar committed
117
enum vp8e_enc_control_id {
118 119
  /*!\brief Codec control function to pass an ROI map to encoder.
   *
Adrian Grange's avatar
Adrian Grange committed
120
   * Supported in codecs: AOM, VP9
121
   */
Adrian Grange's avatar
Adrian Grange committed
122
  AOME_SET_ROI_MAP = 8,
123 124 125

  /*!\brief Codec control function to pass an Active map to encoder.
   *
Adrian Grange's avatar
Adrian Grange committed
126
   * Supported in codecs: AOM, VP9
127
   */
Adrian Grange's avatar
Adrian Grange committed
128
  AOME_SET_ACTIVEMAP,
129 130 131

  /*!\brief Codec control function to set encoder scaling mode.
   *
Adrian Grange's avatar
Adrian Grange committed
132
   * Supported in codecs: AOM, VP9
133
   */
Adrian Grange's avatar
Adrian Grange committed
134
  AOME_SET_SCALEMODE = 11,
135 136

  /*!\brief Codec control function to set encoder internal speed settings.
John Koleszar's avatar
John Koleszar committed
137 138 139 140 141
   *
   * Changes in this value influences, among others, the encoder's selection
   * of motion estimation methods. Values greater than 0 will increase encoder
   * speed at the expense of quality.
   *
Adrian Grange's avatar
Adrian Grange committed
142
   * \note Valid range for AOM: -16..16
143 144
   * \note Valid range for VP9: -8..8
   *
Adrian Grange's avatar
Adrian Grange committed
145
   * Supported in codecs: AOM, VP9
John Koleszar's avatar
John Koleszar committed
146
   */
Adrian Grange's avatar
Adrian Grange committed
147
  AOME_SET_CPUUSED = 13,
148 149 150

  /*!\brief Codec control function to enable automatic set and use alf frames.
   *
Adrian Grange's avatar
Adrian Grange committed
151
   * Supported in codecs: AOM, VP9
152
   */
Adrian Grange's avatar
Adrian Grange committed
153
  AOME_SET_ENABLEAUTOALTREF,
154

155 156 157 158
  /*!\brief control function to set noise sensitivity
   *
   * 0: off, 1: OnYOnly, 2: OnYUV,
   * 3: OnYUVAggressive, 4: Adaptive
159
   *
Adrian Grange's avatar
Adrian Grange committed
160
   * Supported in codecs: AOM
161
   */
Adrian Grange's avatar
Adrian Grange committed
162
  AOME_SET_NOISE_SENSITIVITY,
163 164 165

  /*!\brief Codec control function to set sharpness.
   *
Adrian Grange's avatar
Adrian Grange committed
166
   * Supported in codecs: AOM, VP9
167
   */
Adrian Grange's avatar
Adrian Grange committed
168
  AOME_SET_SHARPNESS,
169 170 171

  /*!\brief Codec control function to set the threshold for MBs treated static.
   *
Adrian Grange's avatar
Adrian Grange committed
172
   * Supported in codecs: AOM, VP9
173
   */
Adrian Grange's avatar
Adrian Grange committed
174
  AOME_SET_STATIC_THRESHOLD,
175 176 177

  /*!\brief Codec control function to set the number of token partitions.
   *
Adrian Grange's avatar
Adrian Grange committed
178
   * Supported in codecs: AOM
179
   */
Adrian Grange's avatar
Adrian Grange committed
180
  AOME_SET_TOKEN_PARTITIONS,
181 182 183 184 185

  /*!\brief Codec control function to get last quantizer chosen by the encoder.
   *
   * Return value uses internal quantizer scale defined by the codec.
   *
Adrian Grange's avatar
Adrian Grange committed
186
   * Supported in codecs: AOM, VP9
187
   */
Adrian Grange's avatar
Adrian Grange committed
188
  AOME_GET_LAST_QUANTIZER,
189 190 191 192 193 194

  /*!\brief Codec control function to get last quantizer chosen by the encoder.
   *
   * Return value uses the 0..63 scale as used by the rc_*_quantizer config
   * parameters.
   *
Adrian Grange's avatar
Adrian Grange committed
195
   * Supported in codecs: AOM, VP9
196
   */
Adrian Grange's avatar
Adrian Grange committed
197
  AOME_GET_LAST_QUANTIZER_64,
198 199 200

  /*!\brief Codec control function to set the max no of frames to create arf.
   *
Adrian Grange's avatar
Adrian Grange committed
201
   * Supported in codecs: AOM, VP9
202
   */
Adrian Grange's avatar
Adrian Grange committed
203
  AOME_SET_ARNR_MAXFRAMES,
204 205 206

  /*!\brief Codec control function to set the filter strength for the arf.
   *
Adrian Grange's avatar
Adrian Grange committed
207
   * Supported in codecs: AOM, VP9
208
   */
Adrian Grange's avatar
Adrian Grange committed
209
  AOME_SET_ARNR_STRENGTH,
210 211

  /*!\deprecated control function to set the filter type to use for the arf. */
Adrian Grange's avatar
Adrian Grange committed
212
  AOME_SET_ARNR_TYPE,
213

214 215
  /*!\brief Codec control function to set visual tuning.
   *
Adrian Grange's avatar
Adrian Grange committed
216
   * Supported in codecs: AOM, VP9
217
   */
Adrian Grange's avatar
Adrian Grange committed
218
  AOME_SET_TUNING,
219 220

  /*!\brief Codec control function to set constrained quality level.
John Koleszar's avatar
John Koleszar committed
221
   *
Adrian Grange's avatar
Adrian Grange committed
222
   * \attention For this value to be used aom_codec_enc_cfg_t::g_usage must be
Adrian Grange's avatar
Adrian Grange committed
223
   *            set to #AOM_CQ.
John Koleszar's avatar
John Koleszar committed
224
   * \note Valid range: 0..63
225
   *
Adrian Grange's avatar
Adrian Grange committed
226
   * Supported in codecs: AOM, VP9
John Koleszar's avatar
John Koleszar committed
227
   */
Adrian Grange's avatar
Adrian Grange committed
228
  AOME_SET_CQ_LEVEL,
John Koleszar's avatar
John Koleszar committed
229

230
  /*!\brief Codec control function to set Max data rate for Intra frames.
John Koleszar's avatar
John Koleszar committed
231 232 233 234 235 236 237 238 239 240
   *
   * This value controls additional clamping on the maximum size of a
   * keyframe. It is expressed as a percentage of the average
   * per-frame bitrate, with the special (and default) value 0 meaning
   * unlimited, or no additional clamping beyond the codec's built-in
   * algorithm.
   *
   * For example, to allocate no more than 4.5 frames worth of bitrate
   * to a keyframe, set this to 450.
   *
Adrian Grange's avatar
Adrian Grange committed
241
   * Supported in codecs: AOM, VP9
John Koleszar's avatar
John Koleszar committed
242
   */
Adrian Grange's avatar
Adrian Grange committed
243
  AOME_SET_MAX_INTRA_BITRATE_PCT,
John Koleszar's avatar
John Koleszar committed
244

245 246
  /*!\brief Codec control function to set reference and update frame flags.
   *
Adrian Grange's avatar
Adrian Grange committed
247
   *  Supported in codecs: AOM
248
   */
Adrian Grange's avatar
Adrian Grange committed
249
  AOME_SET_FRAME_FLAGS,
250 251

  /*!\brief Codec control function to set max data rate for Inter frames.
252 253 254 255 256 257 258 259 260 261
   *
   * This value controls additional clamping on the maximum size of an
   * inter frame. It is expressed as a percentage of the average
   * per-frame bitrate, with the special (and default) value 0 meaning
   * unlimited, or no additional clamping beyond the codec's built-in
   * algorithm.
   *
   * For example, to allow no more than 4.5 frames worth of bitrate
   * to an inter frame, set this to 450.
   *
262
   * Supported in codecs: VP9
263
   */
264
  VP9E_SET_MAX_INTER_BITRATE_PCT,
265

266
  /*!\brief Boost percentage for Golden Frame in CBR mode.
267 268 269 270 271 272 273 274 275 276
   *
   * This value controls the amount of boost given to Golden Frame in
   * CBR mode. It is expressed as a percentage of the average
   * per-frame bitrate, with the special (and default) value 0 meaning
   * the feature is off, i.e., no golden frame boost in CBR mode and
   * average bitrate target is used.
   *
   * For example, to allow 100% more bits, i.e, 2X, in a golden frame
   * than average frame, set this to 100.
   *
277
   * Supported in codecs: VP9
278
   */
279
  VP9E_SET_GF_CBR_BOOST_PCT,
John Koleszar's avatar
John Koleszar committed
280

281
  /*!\brief Codec control function to set the temporal layer id.
Marco's avatar
Marco committed
282 283 284 285 286
   *
   * For temporal scalability: this control allows the application to set the
   * layer id for each frame to be encoded. Note that this control must be set
   * for every frame prior to encoding. The usage of this control function
   * supersedes the internal temporal pattern counter, which is now deprecated.
287
   *
Adrian Grange's avatar
Adrian Grange committed
288
   * Supported in codecs: AOM
Marco's avatar
Marco committed
289
   */
Adrian Grange's avatar
Adrian Grange committed
290
  AOME_SET_TEMPORAL_LAYER_ID,
Marco's avatar
Marco committed
291

292
  /*!\brief Codec control function to set encoder screen content mode.
293 294
   *
   * 0: off, 1: On, 2: On with more aggressive rate control.
295
   *
Adrian Grange's avatar
Adrian Grange committed
296
   * Supported in codecs: AOM
297
   */
Adrian Grange's avatar
Adrian Grange committed
298
  AOME_SET_SCREEN_CONTENT_MODE,
Marco's avatar
Marco committed
299

300
  /*!\brief Codec control function to set lossless encoding mode.
Yaowu Xu's avatar
Yaowu Xu committed
301 302 303 304 305 306 307 308 309
   *
   * VP9 can operate in lossless encoding mode, in which the bitstream
   * produced will be able to decode and reconstruct a perfect copy of
   * input source. This control function provides a mean to switch encoder
   * into lossless coding mode(1) or normal coding mode(0) that may be lossy.
   *                          0 = lossy coding mode
   *                          1 = lossless coding mode
   *
   *  By default, encoder operates in normal coding mode (maybe lossy).
310 311
   *
   * Supported in codecs: VP9
Yaowu Xu's avatar
Yaowu Xu committed
312
   */
313
  VP9E_SET_LOSSLESS,
314 315 316 317 318 319 320 321 322 323 324 325 326 327
#if CONFIG_AOM_QM
  /*!\brief Codec control function to encode with quantisation matrices.
   *
   * AOM can operate with default quantisation matrices dependent on
   * quantisation level and block type.
   *                          0 = do not use quantisation matrices
   *                          1 = use quantisation matrices
   *
   *  By default, the encoder operates without quantisation matrices.
   *
   * Supported in codecs: AOM
   */

  VP9E_SET_ENABLE_QM,
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354

  /*!\brief Codec control function to set the min quant matrix flatness.
   *
   * AOM can operate with different ranges of quantisation matrices.
   * As quantisation levels increase, the matrices get flatter. This
   * control sets the minimum level of flatness from which the matrices
   * are determined.
   *
   *  By default, the encoder sets this minimum at half the available
   *  range.
   *
   * Supported in codecs: AOM
   */
  VP9E_SET_QM_MIN,

  /*!\brief Codec control function to set the max quant matrix flatness.
   *
   * AOM can operate with different ranges of quantisation matrices.
   * As quantisation levels increase, the matrices get flatter. This
   * control sets the maximum level of flatness possible.
   *
   * By default, the encoder sets this maximum at the top of the
   * available range.
   *
   * Supported in codecs: AOM
   */
  VP9E_SET_QM_MAX,
355
#endif
Yaowu Xu's avatar
Yaowu Xu committed
356

357
  /*!\brief Codec control function to set number of tile columns.
Yaowu Xu's avatar
Yaowu Xu committed
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
   *
   * In encoding and decoding, VP9 allows an input image frame be partitioned
   * into separated vertical tile columns, which can be encoded or decoded
   * independently. This enables easy implementation of parallel encoding and
   * decoding. This control requests the encoder to use column tiles in
   * encoding an input frame, with number of tile columns (in Log2 unit) as
   * the parameter:
   *             0 = 1 tile column
   *             1 = 2 tile columns
   *             2 = 4 tile columns
   *             .....
   *             n = 2**n tile columns
   * The requested tile columns will be capped by encoder based on image size
   * limitation (The minimum width of a tile column is 256 pixel, the maximum
   * is 4096).
   *
   * By default, the value is 0, i.e. one single column tile for entire image.
375 376
   *
   * Supported in codecs: VP9
Yaowu Xu's avatar
Yaowu Xu committed
377
   */
Ronald S. Bultje's avatar
Ronald S. Bultje committed
378
  VP9E_SET_TILE_COLUMNS,
Yaowu Xu's avatar
Yaowu Xu committed
379

380
  /*!\brief Codec control function to set number of tile rows.
Yaowu Xu's avatar
Yaowu Xu committed
381 382 383 384 385 386 387 388 389 390 391 392 393 394
   *
   * In encoding and decoding, VP9 allows an input image frame be partitioned
   * into separated horizontal tile rows. Tile rows are encoded or decoded
   * sequentially. Even though encoding/decoding of later tile rows depends on
   * earlier ones, this allows the encoder to output data packets for tile rows
   * prior to completely processing all tile rows in a frame, thereby reducing
   * the latency in processing between input and output. The parameter
   * for this control describes the number of tile rows, which has a valid
   * range [0, 2]:
   *            0 = 1 tile row
   *            1 = 2 tile rows
   *            2 = 4 tile rows
   *
   * By default, the value is 0, i.e. one single row tile for entire image.
395 396
   *
   * Supported in codecs: VP9
Yaowu Xu's avatar
Yaowu Xu committed
397
   */
Ronald S. Bultje's avatar
Ronald S. Bultje committed
398
  VP9E_SET_TILE_ROWS,
Yaowu Xu's avatar
Yaowu Xu committed
399

400
  /*!\brief Codec control function to enable frame parallel decoding feature.
Yaowu Xu's avatar
Yaowu Xu committed
401 402 403 404 405 406 407 408
   *
   * VP9 has a bitstream feature to reduce decoding dependency between frames
   * by turning off backward update of probability context used in encoding
   * and decoding. This allows staged parallel processing of more than one
   * video frames in the decoder. This control function provides a mean to
   * turn this feature on or off for bitstreams produced by encoder.
   *
   * By default, this feature is off.
409 410
   *
   * Supported in codecs: VP9
Yaowu Xu's avatar
Yaowu Xu committed
411
   */
412
  VP9E_SET_FRAME_PARALLEL_DECODING,
Yaowu Xu's avatar
Yaowu Xu committed
413

414
  /*!\brief Codec control function to set adaptive quantization mode.
Yaowu Xu's avatar
Yaowu Xu committed
415 416 417 418 419 420 421
   *
   * VP9 has a segment based feature that allows encoder to adaptively change
   * quantization parameter for each segment within a frame to improve the
   * subjective quality. This control makes encoder operate in one of the
   * several AQ_modes supported.
   *
   * By default, encoder operates with AQ_Mode 0(adaptive quantization off).
422 423
   *
   * Supported in codecs: VP9
Yaowu Xu's avatar
Yaowu Xu committed
424
   */
425
  VP9E_SET_AQ_MODE,
426

427
  /*!\brief Codec control function to enable/disable periodic Q boost.
428 429 430 431 432 433 434 435 436
   *
   * One VP9 encoder speed feature is to enable quality boost by lowering
   * frame level Q periodically. This control function provides a mean to
   * turn on/off this feature.
   *               0 = off
   *               1 = on
   *
   * By default, the encoder is allowed to use this feature for appropriate
   * encoding modes.
437 438
   *
   * Supported in codecs: VP9
439
   */
440
  VP9E_SET_FRAME_PERIODIC_BOOST,
441

442
  /*!\brief Codec control function to set noise sensitivity.
443
   *
444
   *  0: off, 1: On(YOnly)
445 446
   *
   * Supported in codecs: VP9
447 448
   */
  VP9E_SET_NOISE_SENSITIVITY,
449

450
  /*!\brief Codec control function to turn on/off SVC in encoder.
Adrian Grange's avatar
Adrian Grange committed
451
   * \note Return value is AOM_CODEC_INVALID_PARAM if the encoder does not
452 453
   *       support SVC in its current encoding mode
   *  0: off, 1: on
454 455
   *
   * Supported in codecs: VP9
456
   */
457
  VP9E_SET_SVC,
458

459
  /*!\brief Codec control function to set parameters for SVC.
460 461
   * \note Parameters contain min_q, max_q, scaling factor for each of the
   *       SVC layers.
462 463
   *
   * Supported in codecs: VP9
464
   */
465
  VP9E_SET_SVC_PARAMETERS,
466

467
  /*!\brief Codec control function to set svc layer for spatial and temporal.
Adrian Grange's avatar
Adrian Grange committed
468 469
   * \note Valid ranges: 0..#aom_codec_enc_cfg::ss_number_layers for spatial
   *                     layer and 0..#aom_codec_enc_cfg::ts_number_layers for
470
   *                     temporal layer.
471 472
   *
   * Supported in codecs: VP9
473
   */
474
  VP9E_SET_SVC_LAYER_ID,
475

476
  /*!\brief Codec control function to set content type.
477
   * \note Valid parameter range:
Adrian Grange's avatar
Adrian Grange committed
478 479
   *              AOM_CONTENT_DEFAULT = Regular video content (Default)
   *              AOM_CONTENT_SCREEN  = Screen capture content
480 481
   *
   * Supported in codecs: VP9
482
   */
483
  VP9E_SET_TUNE_CONTENT,
484

485
  /*!\brief Codec control function to get svc layer ID.
486 487
   * \note The layer ID returned is for the data packet from the registered
   *       callback function.
488 489
   *
   * Supported in codecs: VP9
490
   */
491
  VP9E_GET_SVC_LAYER_ID,
492

493
  /*!\brief Codec control function to register callback to get per layer packet.
494 495
   * \note Parameter for this control function is a structure with a callback
   *       function and a pointer to private data used by the callback.
496 497
   *
   * Supported in codecs: VP9
498
   */
499
  VP9E_REGISTER_CX_CALLBACK,
500

501
  /*!\brief Codec control function to set color space info.
502 503 504 505 506 507 508 509 510
   * \note Valid ranges: 0..7, default is "UNKNOWN".
   *                     0 = UNKNOWN,
   *                     1 = BT_601
   *                     2 = BT_709
   *                     3 = SMPTE_170
   *                     4 = SMPTE_240
   *                     5 = BT_2020
   *                     6 = RESERVED
   *                     7 = SRGB
511 512
   *
   * Supported in codecs: VP9
513 514
   */
  VP9E_SET_COLOR_SPACE,
515

516
  /*!\brief Codec control function to set temporal layering mode.
clang-format's avatar
clang-format committed
517 518
   * \note Valid ranges: 0..3, default is "0"
   * (VP9E_TEMPORAL_LAYERING_MODE_NOLAYERING).
519 520 521 522 523 524 525 526 527
   *                     0 = VP9E_TEMPORAL_LAYERING_MODE_NOLAYERING
   *                     1 = VP9E_TEMPORAL_LAYERING_MODE_BYPASS
   *                     2 = VP9E_TEMPORAL_LAYERING_MODE_0101
   *                     3 = VP9E_TEMPORAL_LAYERING_MODE_0212
   *
   * Supported in codecs: VP9
   */
  VP9E_SET_TEMPORAL_LAYERING_MODE,

528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
  /*!\brief Codec control function to set minimum interval between GF/ARF frames
   *
   * By default the value is set as 4.
   *
   * Supported in codecs: VP9
   */
  VP9E_SET_MIN_GF_INTERVAL,

  /*!\brief Codec control function to set minimum interval between GF/ARF frames
   *
   * By default the value is set as 16.
   *
   * Supported in codecs: VP9
   */
  VP9E_SET_MAX_GF_INTERVAL,

544 545 546 547 548
  /*!\brief Codec control function to get an Active map back from the encoder.
   *
   * Supported in codecs: VP9
   */
  VP9E_GET_ACTIVEMAP,
549 550 551 552 553 554 555 556 557

  /*!\brief Codec control function to set color range bit.
   * \note Valid ranges: 0..1, default is 0
   *                     0 = Limited range (16..235 or HBD equivalent)
   *                     1 = Full range (0..255 or HBD equivalent)
   *
   * Supported in codecs: VP9
   */
  VP9E_SET_COLOR_RANGE,
558 559 560

  /*!\brief Codec control function to set the frame flags and buffer indices
   * for spatial layers. The frame flags and buffer indices are set using the
Adrian Grange's avatar
Adrian Grange committed
561
   * struct #aom_svc_ref_frame_config defined below.
562 563 564 565
   *
   * Supported in codecs: VP9
  */
  VP9E_SET_SVC_REF_FRAME_CONFIG,
566 567 568 569 570 571 572 573

  /*!\brief Codec control function to set intended rendering image size.
   *
   * By default, this is identical to the image size in pixels.
   *
   * Supported in codecs: VP9
   */
  VP9E_SET_RENDER_SIZE,
John Koleszar's avatar
John Koleszar committed
574
};
John Koleszar's avatar
John Koleszar committed
575

Adrian Grange's avatar
Adrian Grange committed
576
/*!\brief aom 1-D scaling mode
John Koleszar's avatar
John Koleszar committed
577
 *
Adrian Grange's avatar
Adrian Grange committed
578
 * This set of constants define 1-D aom scaling modes
John Koleszar's avatar
John Koleszar committed
579
 */
Adrian Grange's avatar
Adrian Grange committed
580
typedef enum aom_scaling_mode_1d {
Adrian Grange's avatar
Adrian Grange committed
581 582 583 584
  AOME_NORMAL = 0,
  AOME_FOURFIVE = 1,
  AOME_THREEFIVE = 2,
  AOME_ONETWO = 3
Adrian Grange's avatar
Adrian Grange committed
585
} AOM_SCALING_MODE;
John Koleszar's avatar
John Koleszar committed
586

587 588 589 590 591 592 593 594 595 596
/*!\brief Temporal layering mode enum for VP9 SVC.
 *
 * This set of macros define the different temporal layering modes.
 * Supported codecs: VP9 (in SVC mode)
 *
 */
typedef enum vp9e_temporal_layering_mode {
  /*!\brief No temporal layering.
   * Used when only spatial layering is used.
   */
clang-format's avatar
clang-format committed
597
  VP9E_TEMPORAL_LAYERING_MODE_NOLAYERING = 0,
598 599 600 601 602

  /*!\brief Bypass mode.
   * Used when application needs to control temporal layering.
   * This will only work when the number of spatial layers equals 1.
   */
clang-format's avatar
clang-format committed
603
  VP9E_TEMPORAL_LAYERING_MODE_BYPASS = 1,
604 605 606

  /*!\brief 0-1-0-1... temporal layering scheme with two temporal layers.
   */
clang-format's avatar
clang-format committed
607
  VP9E_TEMPORAL_LAYERING_MODE_0101 = 2,
608 609 610

  /*!\brief 0-2-1-2... temporal layering scheme with three temporal layers.
   */
clang-format's avatar
clang-format committed
611
  VP9E_TEMPORAL_LAYERING_MODE_0212 = 3
612
} VP9E_TEMPORAL_LAYERING_MODE;
John Koleszar's avatar
John Koleszar committed
613

Adrian Grange's avatar
Adrian Grange committed
614
/*!\brief  aom region of interest map
John Koleszar's avatar
John Koleszar committed
615 616 617 618 619
 *
 * These defines the data structures for the region of interest map
 *
 */

Adrian Grange's avatar
Adrian Grange committed
620
typedef struct aom_roi_map {
Adrian Grange's avatar
Adrian Grange committed
621 622
  /*! An id between 0 and 3 for each 16x16 region within a frame. */
  unsigned char *roi_map;
clang-format's avatar
clang-format committed
623 624
  unsigned int rows; /**< Number of rows. */
  unsigned int cols; /**< Number of columns. */
625 626 627
  // TODO(paulwilkins): broken for VP9 which has 8 segments
  // q and loop filter deltas for each segment
  // (see MAX_MB_SEGMENTS)
clang-format's avatar
clang-format committed
628 629
  int delta_q[4];  /**< Quantizer deltas. */
  int delta_lf[4]; /**< Loop filter deltas. */
Adrian Grange's avatar
Adrian Grange committed
630 631
  /*! Static breakout threshold for each segment. */
  unsigned int static_threshold[4];
Adrian Grange's avatar
Adrian Grange committed
632
} aom_roi_map_t;
John Koleszar's avatar
John Koleszar committed
633

Adrian Grange's avatar
Adrian Grange committed
634
/*!\brief  aom active region map
John Koleszar's avatar
John Koleszar committed
635 636 637 638 639
 *
 * These defines the data structures for active region map
 *
 */

Adrian Grange's avatar
Adrian Grange committed
640
typedef struct aom_active_map {
clang-format's avatar
clang-format committed
641 642 643 644 645
  unsigned char
      *active_map; /**< specify an on (1) or off (0) each 16x16 region within a
                      frame */
  unsigned int rows; /**< number of rows */
  unsigned int cols; /**< number of cols */
Adrian Grange's avatar
Adrian Grange committed
646
} aom_active_map_t;
John Koleszar's avatar
John Koleszar committed
647

Adrian Grange's avatar
Adrian Grange committed
648
/*!\brief  aom image scaling mode
John Koleszar's avatar
John Koleszar committed
649 650 651 652
 *
 * This defines the data structure for image scaling mode
 *
 */
Adrian Grange's avatar
Adrian Grange committed
653
typedef struct aom_scaling_mode {
Adrian Grange's avatar
Adrian Grange committed
654 655
  AOM_SCALING_MODE h_scaling_mode; /**< horizontal scaling mode */
  AOM_SCALING_MODE v_scaling_mode; /**< vertical scaling mode   */
Adrian Grange's avatar
Adrian Grange committed
656
} aom_scaling_mode_t;
John Koleszar's avatar
John Koleszar committed
657

Adrian Grange's avatar
Adrian Grange committed
658
/*!\brief AOM token partition mode
John Koleszar's avatar
John Koleszar committed
659
 *
Adrian Grange's avatar
Adrian Grange committed
660
 * This defines AOM partitioning mode for compressed data, i.e., the number of
661
 * sub-streams in the bitstream. Used for parallelized decoding.
John Koleszar's avatar
John Koleszar committed
662 663 664
 *
 */

John Koleszar's avatar
John Koleszar committed
665
typedef enum {
Adrian Grange's avatar
Adrian Grange committed
666 667 668 669
  AOM_ONE_TOKENPARTITION = 0,
  AOM_TWO_TOKENPARTITION = 1,
  AOM_FOUR_TOKENPARTITION = 2,
  AOM_EIGHT_TOKENPARTITION = 3
John Koleszar's avatar
John Koleszar committed
670 671
} vp8e_token_partitions;

672 673
/*!brief VP9 encoder content type */
typedef enum {
Adrian Grange's avatar
Adrian Grange committed
674 675 676
  AOM_CONTENT_DEFAULT,
  AOM_CONTENT_SCREEN,
  AOM_CONTENT_INVALID
Adrian Grange's avatar
Adrian Grange committed
677
} aom_tune_content;
John Koleszar's avatar
John Koleszar committed
678

Adrian Grange's avatar
Adrian Grange committed
679
/*!\brief AOM model tuning parameters
John Koleszar's avatar
John Koleszar committed
680 681 682 683
 *
 * Changes the encoder to tune for certain types of input material.
 *
 */
Adrian Grange's avatar
Adrian Grange committed
684
typedef enum { AOM_TUNE_PSNR, AOM_TUNE_SSIM } aom_tune_metric;
John Koleszar's avatar
John Koleszar committed
685

686 687 688 689 690 691 692
/*!\brief  vp9 svc layer parameters
 *
 * This defines the spatial and temporal layer id numbers for svc encoding.
 * This is used with the #VP9E_SET_SVC_LAYER_ID control to set the spatial and
 * temporal layer id for the current frame.
 *
 */
Adrian Grange's avatar
Adrian Grange committed
693
typedef struct aom_svc_layer_id {
clang-format's avatar
clang-format committed
694 695
  int spatial_layer_id;  /**< Spatial layer id number. */
  int temporal_layer_id; /**< Temporal layer id number. */
Adrian Grange's avatar
Adrian Grange committed
696
} aom_svc_layer_id_t;
697

698 699 700 701 702 703 704 705
/*!\brief  vp9 svc frame flag parameters.
 *
 * This defines the frame flags and buffer indices for each spatial layer for
 * svc encoding.
 * This is used with the #VP9E_SET_SVC_REF_FRAME_CONFIG control to set frame
 * flags and buffer indices for each spatial layer for the current (super)frame.
 *
 */
Adrian Grange's avatar
Adrian Grange committed
706
typedef struct aom_svc_ref_frame_config {
Adrian Grange's avatar
Adrian Grange committed
707 708 709 710
  int frame_flags[AOM_TS_MAX_LAYERS]; /**< Frame flags. */
  int lst_fb_idx[AOM_TS_MAX_LAYERS];  /**< Last buffer index. */
  int gld_fb_idx[AOM_TS_MAX_LAYERS];  /**< Golden buffer index. */
  int alt_fb_idx[AOM_TS_MAX_LAYERS];  /**< Altref buffer index. */
Adrian Grange's avatar
Adrian Grange committed
711
} aom_svc_ref_frame_config_t;
712

713
/*!\cond */
Adrian Grange's avatar
Adrian Grange committed
714
/*!\brief AOM encoder control function parameter type
John Koleszar's avatar
John Koleszar committed
715
 *
Adrian Grange's avatar
Adrian Grange committed
716
 * Defines the data types that AOME control functions take. Note that
John Koleszar's avatar
John Koleszar committed
717 718 719 720
 * additional common controls are defined in vp8.h
 *
 */

Adrian Grange's avatar
Adrian Grange committed
721 722 723 724 725 726 727 728 729 730
AOM_CTRL_USE_TYPE(AOME_SET_FRAME_FLAGS, int)
#define AOM_CTRL_AOME_SET_FRAME_FLAGS
AOM_CTRL_USE_TYPE(AOME_SET_TEMPORAL_LAYER_ID, int)
#define AOM_CTRL_AOME_SET_TEMPORAL_LAYER_ID
AOM_CTRL_USE_TYPE(AOME_SET_ROI_MAP, aom_roi_map_t *)
#define AOM_CTRL_AOME_SET_ROI_MAP
AOM_CTRL_USE_TYPE(AOME_SET_ACTIVEMAP, aom_active_map_t *)
#define AOM_CTRL_AOME_SET_ACTIVEMAP
AOM_CTRL_USE_TYPE(AOME_SET_SCALEMODE, aom_scaling_mode_t *)
#define AOM_CTRL_AOME_SET_SCALEMODE
Adrian Grange's avatar
Adrian Grange committed
731 732 733 734 735 736 737 738 739 740

AOM_CTRL_USE_TYPE(VP9E_SET_SVC, int)
#define AOM_CTRL_VP9E_SET_SVC
AOM_CTRL_USE_TYPE(VP9E_SET_SVC_PARAMETERS, void *)
#define AOM_CTRL_VP9E_SET_SVC_PARAMETERS
AOM_CTRL_USE_TYPE(VP9E_REGISTER_CX_CALLBACK, void *)
#define AOM_CTRL_VP9E_REGISTER_CX_CALLBACK
AOM_CTRL_USE_TYPE(VP9E_SET_SVC_LAYER_ID, aom_svc_layer_id_t *)
#define AOM_CTRL_VP9E_SET_SVC_LAYER_ID

Adrian Grange's avatar
Adrian Grange committed
741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
AOM_CTRL_USE_TYPE(AOME_SET_CPUUSED, int)
#define AOM_CTRL_AOME_SET_CPUUSED
AOM_CTRL_USE_TYPE(AOME_SET_ENABLEAUTOALTREF, unsigned int)
#define AOM_CTRL_AOME_SET_ENABLEAUTOALTREF
AOM_CTRL_USE_TYPE(AOME_SET_NOISE_SENSITIVITY, unsigned int)
#define AOM_CTRL_AOME_SET_NOISE_SENSITIVITY
AOM_CTRL_USE_TYPE(AOME_SET_SHARPNESS, unsigned int)
#define AOM_CTRL_AOME_SET_SHARPNESS
AOM_CTRL_USE_TYPE(AOME_SET_STATIC_THRESHOLD, unsigned int)
#define AOM_CTRL_AOME_SET_STATIC_THRESHOLD
AOM_CTRL_USE_TYPE(AOME_SET_TOKEN_PARTITIONS, int) /* vp8e_token_partitions */
#define AOM_CTRL_AOME_SET_TOKEN_PARTITIONS

AOM_CTRL_USE_TYPE(AOME_SET_ARNR_MAXFRAMES, unsigned int)
#define AOM_CTRL_AOME_SET_ARNR_MAXFRAMES
AOM_CTRL_USE_TYPE(AOME_SET_ARNR_STRENGTH, unsigned int)
#define AOM_CTRL_AOME_SET_ARNR_STRENGTH
AOM_CTRL_USE_TYPE_DEPRECATED(AOME_SET_ARNR_TYPE, unsigned int)
#define AOM_CTRL_AOME_SET_ARNR_TYPE
AOM_CTRL_USE_TYPE(AOME_SET_TUNING, int) /* aom_tune_metric */
#define AOM_CTRL_AOME_SET_TUNING
AOM_CTRL_USE_TYPE(AOME_SET_CQ_LEVEL, unsigned int)
#define AOM_CTRL_AOME_SET_CQ_LEVEL
Adrian Grange's avatar
Adrian Grange committed
764 765 766 767 768 769

AOM_CTRL_USE_TYPE(VP9E_SET_TILE_COLUMNS, int)
#define AOM_CTRL_VP9E_SET_TILE_COLUMNS
AOM_CTRL_USE_TYPE(VP9E_SET_TILE_ROWS, int)
#define AOM_CTRL_VP9E_SET_TILE_ROWS

Adrian Grange's avatar
Adrian Grange committed
770 771 772 773
AOM_CTRL_USE_TYPE(AOME_GET_LAST_QUANTIZER, int *)
#define AOM_CTRL_AOME_GET_LAST_QUANTIZER
AOM_CTRL_USE_TYPE(AOME_GET_LAST_QUANTIZER_64, int *)
#define AOM_CTRL_AOME_GET_LAST_QUANTIZER_64
Adrian Grange's avatar
Adrian Grange committed
774 775 776
AOM_CTRL_USE_TYPE(VP9E_GET_SVC_LAYER_ID, aom_svc_layer_id_t *)
#define AOM_CTRL_VP9E_GET_SVC_LAYER_ID

Adrian Grange's avatar
Adrian Grange committed
777 778 779 780
AOM_CTRL_USE_TYPE(AOME_SET_MAX_INTRA_BITRATE_PCT, unsigned int)
#define AOM_CTRL_AOME_SET_MAX_INTRA_BITRATE_PCT
AOM_CTRL_USE_TYPE(AOME_SET_MAX_INTER_BITRATE_PCT, unsigned int)
#define AOM_CTRL_AOME_SET_MAX_INTER_BITRATE_PCT
Adrian Grange's avatar
Adrian Grange committed
781

Adrian Grange's avatar
Adrian Grange committed
782 783
AOM_CTRL_USE_TYPE(AOME_SET_SCREEN_CONTENT_MODE, unsigned int)
#define AOM_CTRL_AOME_SET_SCREEN_CONTENT_MODE
Adrian Grange's avatar
Adrian Grange committed
784 785 786 787 788 789

AOM_CTRL_USE_TYPE(VP9E_SET_GF_CBR_BOOST_PCT, unsigned int)
#define AOM_CTRL_VP9E_SET_GF_CBR_BOOST_PCT

AOM_CTRL_USE_TYPE(VP9E_SET_LOSSLESS, unsigned int)
#define AOM_CTRL_VP9E_SET_LOSSLESS
790

791
#if CONFIG_AOM_QM
Adrian Grange's avatar
Adrian Grange committed
792 793
AOM_CTRL_USE_TYPE(VP9E_SET_ENABLE_QM, unsigned int)
#define AOM_CTRL_VP9E_SET_ENABLE_QM
794

Adrian Grange's avatar
Adrian Grange committed
795 796
AOM_CTRL_USE_TYPE(VP9E_SET_QM_MIN, unsigned int)
#define AOM_CTRL_VP9E_SET_QM_MIN
797

Adrian Grange's avatar
Adrian Grange committed
798 799
AOM_CTRL_USE_TYPE(VP9E_SET_QM_MAX, unsigned int)
#define AOM_CTRL_VP9E_SET_QM_MAX
800 801
#endif

Adrian Grange's avatar
Adrian Grange committed
802 803
AOM_CTRL_USE_TYPE(VP9E_SET_FRAME_PARALLEL_DECODING, unsigned int)
#define AOM_CTRL_VP9E_SET_FRAME_PARALLEL_DECODING
804

Adrian Grange's avatar
Adrian Grange committed
805 806
AOM_CTRL_USE_TYPE(VP9E_SET_AQ_MODE, unsigned int)
#define AOM_CTRL_VP9E_SET_AQ_MODE
807

Adrian Grange's avatar
Adrian Grange committed
808 809
AOM_CTRL_USE_TYPE(VP9E_SET_FRAME_PERIODIC_BOOST, unsigned int)
#define AOM_CTRL_VP9E_SET_FRAME_PERIODIC_BOOST
810

Adrian Grange's avatar
Adrian Grange committed
811 812
AOM_CTRL_USE_TYPE(VP9E_SET_NOISE_SENSITIVITY, unsigned int)
#define AOM_CTRL_VP9E_SET_NOISE_SENSITIVITY
813

Adrian Grange's avatar
Adrian Grange committed
814 815
AOM_CTRL_USE_TYPE(VP9E_SET_TUNE_CONTENT, int) /* aom_tune_content */
#define AOM_CTRL_VP9E_SET_TUNE_CONTENT
816

Adrian Grange's avatar
Adrian Grange committed
817 818
AOM_CTRL_USE_TYPE(VP9E_SET_COLOR_SPACE, int)
#define AOM_CTRL_VP9E_SET_COLOR_SPACE
819

Adrian Grange's avatar
Adrian Grange committed
820 821
AOM_CTRL_USE_TYPE(VP9E_SET_MIN_GF_INTERVAL, unsigned int)
#define AOM_CTRL_VP9E_SET_MIN_GF_INTERVAL
822

Adrian Grange's avatar
Adrian Grange committed
823 824
AOM_CTRL_USE_TYPE(VP9E_SET_MAX_GF_INTERVAL, unsigned int)
#define AOM_CTRL_VP9E_SET_MAX_GF_INTERVAL
825

Adrian Grange's avatar
Adrian Grange committed
826 827
AOM_CTRL_USE_TYPE(VP9E_GET_ACTIVEMAP, aom_active_map_t *)
#define AOM_CTRL_VP9E_GET_ACTIVEMAP
828

Adrian Grange's avatar
Adrian Grange committed
829 830
AOM_CTRL_USE_TYPE(VP9E_SET_COLOR_RANGE, int)
#define AOM_CTRL_VP9E_SET_COLOR_RANGE
831

Adrian Grange's avatar
Adrian Grange committed
832 833
AOM_CTRL_USE_TYPE(VP9E_SET_SVC_REF_FRAME_CONFIG, aom_svc_ref_frame_config_t *)
#define AOM_CTRL_VP9E_SET_SVC_REF_FRAME_CONFIG
834

Adrian Grange's avatar
Adrian Grange committed
835 836
AOM_CTRL_USE_TYPE(VP9E_SET_RENDER_SIZE, int *)
#define AOM_CTRL_VP9E_SET_RENDER_SIZE
837 838

/*!\endcond */
John Koleszar's avatar
John Koleszar committed
839
/*! @} - end defgroup vp8_encoder */
840 841 842 843
#ifdef __cplusplus
}  // extern "C"
#endif

Adrian Grange's avatar
Adrian Grange committed
844
#endif  // AOM_AOMCX_H_