vp8cx.h 26.3 KB
Newer Older
John Koleszar's avatar
John Koleszar committed
1
/*
2
 *  Copyright (c) 2010 The WebM project authors. All Rights Reserved.
John Koleszar's avatar
John Koleszar committed
3
 *
4
 *  Use of this source code is governed by a BSD-style license
5 6
 *  that can be found in the LICENSE file in the root of the source
 *  tree. An additional intellectual property rights grant can be found
7
 *  in the file PATENTS.  All contributing project authors may
8
 *  be found in the AUTHORS file in the root of the source tree.
John Koleszar's avatar
John Koleszar committed
9
 */
James Zern's avatar
James Zern committed
10 11
#ifndef VPX_VP8CX_H_
#define VPX_VP8CX_H_
John Koleszar's avatar
John Koleszar committed
12

13
/*!\defgroup vp8_encoder WebM VP8/VP9 Encoder
John Koleszar's avatar
John Koleszar committed
14 15 16 17
 * \ingroup vp8
 *
 * @{
 */
18
#include "./vp8.h"
19
#include "./vpx_encoder.h"
John Koleszar's avatar
John Koleszar committed
20

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

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

Jingning Han's avatar
Jingning Han committed
30 31
/*!\name Algorithm interface for VP10
 *
32
 * This interface provides the capability to encode raw VP10 streams.
Jingning Han's avatar
Jingning Han committed
33 34
 * @{
 */
clang-format's avatar
clang-format committed
35
extern vpx_codec_iface_t vpx_codec_vp10_cx_algo;
Jingning Han's avatar
Jingning Han committed
36 37
extern vpx_codec_iface_t *vpx_codec_vp10_cx(void);
/*!@} - end algorithm interface member group*/
38

John Koleszar's avatar
John Koleszar committed
39 40 41 42 43 44 45 46 47 48
/*
 * 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.
 */
clang-format's avatar
clang-format committed
49
#define VP8_EFLAG_NO_REF_LAST (1 << 16)
John Koleszar's avatar
John Koleszar committed
50 51 52 53 54 55 56

/*!\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.
 */
clang-format's avatar
clang-format committed
57
#define VP8_EFLAG_NO_REF_GF (1 << 17)
John Koleszar's avatar
John Koleszar committed
58 59 60 61 62 63 64

/*!\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.
 */
clang-format's avatar
clang-format committed
65
#define VP8_EFLAG_NO_REF_ARF (1 << 21)
John Koleszar's avatar
John Koleszar committed
66 67 68 69 70 71

/*!\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.
 */
clang-format's avatar
clang-format committed
72
#define VP8_EFLAG_NO_UPD_LAST (1 << 18)
John Koleszar's avatar
John Koleszar committed
73 74 75 76 77 78

/*!\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.
 */
clang-format's avatar
clang-format committed
79
#define VP8_EFLAG_NO_UPD_GF (1 << 22)
John Koleszar's avatar
John Koleszar committed
80 81 82 83 84 85

/*!\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.
 */
clang-format's avatar
clang-format committed
86
#define VP8_EFLAG_NO_UPD_ARF (1 << 23)
John Koleszar's avatar
John Koleszar committed
87 88 89 90 91 92

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

/*!\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.
 */
clang-format's avatar
clang-format committed
100
#define VP8_EFLAG_FORCE_ARF (1 << 24)
John Koleszar's avatar
John Koleszar committed
101 102 103 104 105 106

/*!\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.
 */
clang-format's avatar
clang-format committed
107
#define VP8_EFLAG_NO_UPD_ENTROPY (1 << 20)
John Koleszar's avatar
John Koleszar committed
108

109
/*!\brief VPx encoder control functions
John Koleszar's avatar
John Koleszar committed
110
 *
111
 * This set of macros define the control functions available for VPx
112 113 114
 * encoder interface.
 *
 * \sa #vpx_codec_control
John Koleszar's avatar
John Koleszar committed
115
 */
John Koleszar's avatar
John Koleszar committed
116
enum vp8e_enc_control_id {
117 118 119 120
  /*!\brief Codec control function to pass an ROI map to encoder.
   *
   * Supported in codecs: VP8, VP9
   */
clang-format's avatar
clang-format committed
121
  VP8E_SET_ROI_MAP = 8,
122 123 124 125 126 127 128 129 130 131 132

  /*!\brief Codec control function to pass an Active map to encoder.
   *
   * Supported in codecs: VP8, VP9
   */
  VP8E_SET_ACTIVEMAP,

  /*!\brief Codec control function to set encoder scaling mode.
   *
   * Supported in codecs: VP8, VP9
   */
clang-format's avatar
clang-format committed
133
  VP8E_SET_SCALEMODE = 11,
134 135

  /*!\brief Codec control function to set encoder internal speed settings.
John Koleszar's avatar
John Koleszar committed
136 137 138 139 140
   *
   * 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.
   *
141 142 143 144
   * \note Valid range for VP8: -16..16
   * \note Valid range for VP9: -8..8
   *
   * Supported in codecs: VP8, VP9
John Koleszar's avatar
John Koleszar committed
145
   */
clang-format's avatar
clang-format committed
146
  VP8E_SET_CPUUSED = 13,
147 148 149 150 151 152 153

  /*!\brief Codec control function to enable automatic set and use alf frames.
   *
   * Supported in codecs: VP8, VP9
   */
  VP8E_SET_ENABLEAUTOALTREF,

154 155 156 157
  /*!\brief control function to set noise sensitivity
   *
   * 0: off, 1: OnYOnly, 2: OnYUV,
   * 3: OnYUVAggressive, 4: Adaptive
158 159
   *
   * Supported in codecs: VP8
160 161
   */
  VP8E_SET_NOISE_SENSITIVITY,
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210

  /*!\brief Codec control function to set sharpness.
   *
   * Supported in codecs: VP8, VP9
   */
  VP8E_SET_SHARPNESS,

  /*!\brief Codec control function to set the threshold for MBs treated static.
   *
   * Supported in codecs: VP8, VP9
   */
  VP8E_SET_STATIC_THRESHOLD,

  /*!\brief Codec control function to set the number of token partitions.
   *
   * Supported in codecs: VP8
   */
  VP8E_SET_TOKEN_PARTITIONS,

  /*!\brief Codec control function to get last quantizer chosen by the encoder.
   *
   * Return value uses internal quantizer scale defined by the codec.
   *
   * Supported in codecs: VP8, VP9
   */
  VP8E_GET_LAST_QUANTIZER,

  /*!\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.
   *
   * Supported in codecs: VP8, VP9
   */
  VP8E_GET_LAST_QUANTIZER_64,

  /*!\brief Codec control function to set the max no of frames to create arf.
   *
   * Supported in codecs: VP8, VP9
   */
  VP8E_SET_ARNR_MAXFRAMES,

  /*!\brief Codec control function to set the filter strength for the arf.
   *
   * Supported in codecs: VP8, VP9
   */
  VP8E_SET_ARNR_STRENGTH,

  /*!\deprecated control function to set the filter type to use for the arf. */
211 212
  VP8E_SET_ARNR_TYPE,

213 214 215 216 217 218 219
  /*!\brief Codec control function to set visual tuning.
   *
   * Supported in codecs: VP8, VP9
   */
  VP8E_SET_TUNING,

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

229
  /*!\brief Codec control function to set Max data rate for Intra frames.
John Koleszar's avatar
John Koleszar committed
230 231 232 233 234 235 236 237 238 239
   *
   * 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.
   *
240
   * Supported in codecs: VP8, VP9
John Koleszar's avatar
John Koleszar committed
241 242
   */
  VP8E_SET_MAX_INTRA_BITRATE_PCT,
John Koleszar's avatar
John Koleszar committed
243

244 245 246 247 248 249 250
  /*!\brief Codec control function to set reference and update frame flags.
   *
   *  Supported in codecs: VP8
   */
  VP8E_SET_FRAME_FLAGS,

  /*!\brief Codec control function to set max data rate for Inter frames.
251 252 253 254 255 256 257 258 259 260
   *
   * 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.
   *
261
   * Supported in codecs: VP9
262
   */
263
  VP9E_SET_MAX_INTER_BITRATE_PCT,
264

265
  /*!\brief Boost percentage for Golden Frame in CBR mode.
266 267 268 269 270 271 272 273 274 275
   *
   * 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.
   *
276
   * Supported in codecs: VP9
277
   */
278
  VP9E_SET_GF_CBR_BOOST_PCT,
John Koleszar's avatar
John Koleszar committed
279

280
  /*!\brief Codec control function to set the temporal layer id.
Marco's avatar
Marco committed
281 282 283 284 285
   *
   * 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.
286 287
   *
   * Supported in codecs: VP8
Marco's avatar
Marco committed
288 289 290
   */
  VP8E_SET_TEMPORAL_LAYER_ID,

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

299
  /*!\brief Codec control function to set lossless encoding mode.
Yaowu Xu's avatar
Yaowu Xu committed
300 301 302 303 304 305 306 307 308
   *
   * 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).
309 310
   *
   * Supported in codecs: VP9
Yaowu Xu's avatar
Yaowu Xu committed
311
   */
312
  VP9E_SET_LOSSLESS,
313 314 315 316 317 318 319 320 321 322 323 324 325 326
#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,
327 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

  /*!\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,
354
#endif
Yaowu Xu's avatar
Yaowu Xu committed
355

356
  /*!\brief Codec control function to set number of tile columns.
Yaowu Xu's avatar
Yaowu Xu committed
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
   *
   * 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.
374 375
   *
   * Supported in codecs: VP9
Yaowu Xu's avatar
Yaowu Xu committed
376
   */
Ronald S. Bultje's avatar
Ronald S. Bultje committed
377
  VP9E_SET_TILE_COLUMNS,
Yaowu Xu's avatar
Yaowu Xu committed
378

379
  /*!\brief Codec control function to set number of tile rows.
Yaowu Xu's avatar
Yaowu Xu committed
380 381 382 383 384 385 386 387 388 389 390 391 392 393
   *
   * 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.
394 395
   *
   * Supported in codecs: VP9
Yaowu Xu's avatar
Yaowu Xu committed
396
   */
Ronald S. Bultje's avatar
Ronald S. Bultje committed
397
  VP9E_SET_TILE_ROWS,
Yaowu Xu's avatar
Yaowu Xu committed
398

399
  /*!\brief Codec control function to enable frame parallel decoding feature.
Yaowu Xu's avatar
Yaowu Xu committed
400 401 402 403 404 405 406 407
   *
   * 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.
408 409
   *
   * Supported in codecs: VP9
Yaowu Xu's avatar
Yaowu Xu committed
410
   */
411
  VP9E_SET_FRAME_PARALLEL_DECODING,
Yaowu Xu's avatar
Yaowu Xu committed
412

413
  /*!\brief Codec control function to set adaptive quantization mode.
Yaowu Xu's avatar
Yaowu Xu committed
414 415 416 417 418 419 420
   *
   * 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).
421 422
   *
   * Supported in codecs: VP9
Yaowu Xu's avatar
Yaowu Xu committed
423
   */
424
  VP9E_SET_AQ_MODE,
425

426
  /*!\brief Codec control function to enable/disable periodic Q boost.
427 428 429 430 431 432 433 434 435
   *
   * 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.
436 437
   *
   * Supported in codecs: VP9
438
   */
439
  VP9E_SET_FRAME_PERIODIC_BOOST,
440

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

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

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

466
  /*!\brief Codec control function to set svc layer for spatial and temporal.
467 468 469
   * \note Valid ranges: 0..#vpx_codec_enc_cfg::ss_number_layers for spatial
   *                     layer and 0..#vpx_codec_enc_cfg::ts_number_layers for
   *                     temporal layer.
470 471
   *
   * Supported in codecs: VP9
472
   */
473
  VP9E_SET_SVC_LAYER_ID,
474

475
  /*!\brief Codec control function to set content type.
476
   * \note Valid parameter range:
477 478
   *              VPX_CONTENT_DEFAULT = Regular video content (Default)
   *              VPX_CONTENT_SCREEN  = Screen capture content
479 480
   *
   * Supported in codecs: VP9
481
   */
482
  VP9E_SET_TUNE_CONTENT,
483

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

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

500
  /*!\brief Codec control function to set color space info.
501 502 503 504 505 506 507 508 509
   * \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
510 511
   *
   * Supported in codecs: VP9
512 513
   */
  VP9E_SET_COLOR_SPACE,
514

515
  /*!\brief Codec control function to set temporal layering mode.
clang-format's avatar
clang-format committed
516 517
   * \note Valid ranges: 0..3, default is "0"
   * (VP9E_TEMPORAL_LAYERING_MODE_NOLAYERING).
518 519 520 521 522 523 524 525 526
   *                     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,

527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
  /*!\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,

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

  /*!\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,
557 558 559 560 561 562 563 564

  /*!\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
   * struct #vpx_svc_ref_frame_config defined below.
   *
   * Supported in codecs: VP9
  */
  VP9E_SET_SVC_REF_FRAME_CONFIG,
565 566 567 568 569 570 571 572

  /*!\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
573
};
John Koleszar's avatar
John Koleszar committed
574 575 576 577 578

/*!\brief vpx 1-D scaling mode
 *
 * This set of constants define 1-D vpx scaling modes
 */
John Koleszar's avatar
John Koleszar committed
579
typedef enum vpx_scaling_mode_1d {
clang-format's avatar
clang-format committed
580 581 582 583
  VP8E_NORMAL = 0,
  VP8E_FOURFIVE = 1,
  VP8E_THREEFIVE = 2,
  VP8E_ONETWO = 3
John Koleszar's avatar
John Koleszar committed
584 585
} VPX_SCALING_MODE;

586 587 588 589 590 591 592 593 594 595
/*!\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
596
  VP9E_TEMPORAL_LAYERING_MODE_NOLAYERING = 0,
597 598 599 600 601

  /*!\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
602
  VP9E_TEMPORAL_LAYERING_MODE_BYPASS = 1,
603 604 605

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

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

/*!\brief  vpx region of interest map
 *
 * These defines the data structures for the region of interest map
 *
 */

John Koleszar's avatar
John Koleszar committed
619
typedef struct vpx_roi_map {
Adrian Grange's avatar
Adrian Grange committed
620 621
  /*! An id between 0 and 3 for each 16x16 region within a frame. */
  unsigned char *roi_map;
clang-format's avatar
clang-format committed
622 623
  unsigned int rows; /**< Number of rows. */
  unsigned int cols; /**< Number of columns. */
624 625 626
  // 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
627 628
  int delta_q[4];  /**< Quantizer deltas. */
  int delta_lf[4]; /**< Loop filter deltas. */
Adrian Grange's avatar
Adrian Grange committed
629 630
  /*! Static breakout threshold for each segment. */
  unsigned int static_threshold[4];
John Koleszar's avatar
John Koleszar committed
631 632 633 634 635 636 637 638
} vpx_roi_map_t;

/*!\brief  vpx active region map
 *
 * These defines the data structures for active region map
 *
 */

John Koleszar's avatar
John Koleszar committed
639
typedef struct vpx_active_map {
clang-format's avatar
clang-format committed
640 641 642 643 644
  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 */
John Koleszar's avatar
John Koleszar committed
645 646 647 648 649 650 651
} vpx_active_map_t;

/*!\brief  vpx image scaling mode
 *
 * This defines the data structure for image scaling mode
 *
 */
John Koleszar's avatar
John Koleszar committed
652
typedef struct vpx_scaling_mode {
clang-format's avatar
clang-format committed
653 654
  VPX_SCALING_MODE h_scaling_mode; /**< horizontal scaling mode */
  VPX_SCALING_MODE v_scaling_mode; /**< vertical scaling mode   */
John Koleszar's avatar
John Koleszar committed
655 656 657 658 659
} vpx_scaling_mode_t;

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

John Koleszar's avatar
John Koleszar committed
664
typedef enum {
clang-format's avatar
clang-format committed
665 666 667
  VP8_ONE_TOKENPARTITION = 0,
  VP8_TWO_TOKENPARTITION = 1,
  VP8_FOUR_TOKENPARTITION = 2,
John Koleszar's avatar
John Koleszar committed
668
  VP8_EIGHT_TOKENPARTITION = 3
John Koleszar's avatar
John Koleszar committed
669 670
} vp8e_token_partitions;

671 672
/*!brief VP9 encoder content type */
typedef enum {
673 674 675 676
  VPX_CONTENT_DEFAULT,
  VPX_CONTENT_SCREEN,
  VPX_CONTENT_INVALID
} vpx_tune_content;
John Koleszar's avatar
John Koleszar committed
677

John Koleszar's avatar
John Koleszar committed
678 679 680 681 682
/*!\brief VP8 model tuning parameters
 *
 * Changes the encoder to tune for certain types of input material.
 *
 */
clang-format's avatar
clang-format committed
683
typedef enum { VPX_TUNE_PSNR, VPX_TUNE_SSIM } vpx_tune_metric;
John Koleszar's avatar
John Koleszar committed
684

685 686 687 688 689 690 691
/*!\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.
 *
 */
692
typedef struct vpx_svc_layer_id {
clang-format's avatar
clang-format committed
693 694
  int spatial_layer_id;  /**< Spatial layer id number. */
  int temporal_layer_id; /**< Temporal layer id number. */
695 696
} vpx_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.
 *
 */
typedef struct vpx_svc_ref_frame_config {
clang-format's avatar
clang-format committed
706
  int frame_flags[VPX_TS_MAX_LAYERS]; /**< Frame flags. */
707 708 709 710 711
  int lst_fb_idx[VPX_TS_MAX_LAYERS];  /**< Last buffer index. */
  int gld_fb_idx[VPX_TS_MAX_LAYERS];  /**< Golden buffer index. */
  int alt_fb_idx[VPX_TS_MAX_LAYERS];  /**< Altref buffer index. */
} vpx_svc_ref_frame_config_t;

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

clang-format's avatar
clang-format committed
720
VPX_CTRL_USE_TYPE(VP8E_SET_FRAME_FLAGS, int)
721
#define VPX_CTRL_VP8E_SET_FRAME_FLAGS
clang-format's avatar
clang-format committed
722
VPX_CTRL_USE_TYPE(VP8E_SET_TEMPORAL_LAYER_ID, int)
723
#define VPX_CTRL_VP8E_SET_TEMPORAL_LAYER_ID
clang-format's avatar
clang-format committed
724
VPX_CTRL_USE_TYPE(VP8E_SET_ROI_MAP, vpx_roi_map_t *)
725
#define VPX_CTRL_VP8E_SET_ROI_MAP
clang-format's avatar
clang-format committed
726
VPX_CTRL_USE_TYPE(VP8E_SET_ACTIVEMAP, vpx_active_map_t *)
727
#define VPX_CTRL_VP8E_SET_ACTIVEMAP
clang-format's avatar
clang-format committed
728
VPX_CTRL_USE_TYPE(VP8E_SET_SCALEMODE, vpx_scaling_mode_t *)
729
#define VPX_CTRL_VP8E_SET_SCALEMODE
John Koleszar's avatar
John Koleszar committed
730

clang-format's avatar
clang-format committed
731
VPX_CTRL_USE_TYPE(VP9E_SET_SVC, int)
732
#define VPX_CTRL_VP9E_SET_SVC
clang-format's avatar
clang-format committed
733
VPX_CTRL_USE_TYPE(VP9E_SET_SVC_PARAMETERS, void *)
734
#define VPX_CTRL_VP9E_SET_SVC_PARAMETERS
clang-format's avatar
clang-format committed
735
VPX_CTRL_USE_TYPE(VP9E_REGISTER_CX_CALLBACK, void *)
736
#define VPX_CTRL_VP9E_REGISTER_CX_CALLBACK
clang-format's avatar
clang-format committed
737
VPX_CTRL_USE_TYPE(VP9E_SET_SVC_LAYER_ID, vpx_svc_layer_id_t *)
738
#define VPX_CTRL_VP9E_SET_SVC_LAYER_ID
739

clang-format's avatar
clang-format committed
740
VPX_CTRL_USE_TYPE(VP8E_SET_CPUUSED, int)
741
#define VPX_CTRL_VP8E_SET_CPUUSED
clang-format's avatar
clang-format committed
742
VPX_CTRL_USE_TYPE(VP8E_SET_ENABLEAUTOALTREF, unsigned int)
743
#define VPX_CTRL_VP8E_SET_ENABLEAUTOALTREF
clang-format's avatar
clang-format committed
744
VPX_CTRL_USE_TYPE(VP8E_SET_NOISE_SENSITIVITY, unsigned int)
745
#define VPX_CTRL_VP8E_SET_NOISE_SENSITIVITY
clang-format's avatar
clang-format committed
746
VPX_CTRL_USE_TYPE(VP8E_SET_SHARPNESS, unsigned int)
747
#define VPX_CTRL_VP8E_SET_SHARPNESS
clang-format's avatar
clang-format committed
748
VPX_CTRL_USE_TYPE(VP8E_SET_STATIC_THRESHOLD, unsigned int)
749
#define VPX_CTRL_VP8E_SET_STATIC_THRESHOLD
clang-format's avatar
clang-format committed
750
VPX_CTRL_USE_TYPE(VP8E_SET_TOKEN_PARTITIONS, int) /* vp8e_token_partitions */
751
#define VPX_CTRL_VP8E_SET_TOKEN_PARTITIONS
John Koleszar's avatar
John Koleszar committed
752

clang-format's avatar
clang-format committed
753
VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_MAXFRAMES, unsigned int)
754
#define VPX_CTRL_VP8E_SET_ARNR_MAXFRAMES
clang-format's avatar
clang-format committed
755
VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_STRENGTH, unsigned int)
756
#define VPX_CTRL_VP8E_SET_ARNR_STRENGTH
clang-format's avatar
clang-format committed
757
VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_SET_ARNR_TYPE, unsigned int)
758
#define VPX_CTRL_VP8E_SET_ARNR_TYPE
clang-format's avatar
clang-format committed
759
VPX_CTRL_USE_TYPE(VP8E_SET_TUNING, int) /* vpx_tune_metric */
760
#define VPX_CTRL_VP8E_SET_TUNING
clang-format's avatar
clang-format committed
761
VPX_CTRL_USE_TYPE(VP8E_SET_CQ_LEVEL, unsigned int)
762
#define VPX_CTRL_VP8E_SET_CQ_LEVEL
John Koleszar's avatar
John Koleszar committed
763

clang-format's avatar
clang-format committed
764
VPX_CTRL_USE_TYPE(VP9E_SET_TILE_COLUMNS, int)
765
#define VPX_CTRL_VP9E_SET_TILE_COLUMNS
clang-format's avatar
clang-format committed
766
VPX_CTRL_USE_TYPE(VP9E_SET_TILE_ROWS, int)
767
#define VPX_CTRL_VP9E_SET_TILE_ROWS
768

clang-format's avatar
clang-format committed
769
VPX_CTRL_USE_TYPE(VP8E_GET_LAST_QUANTIZER, int *)
770
#define VPX_CTRL_VP8E_GET_LAST_QUANTIZER
clang-format's avatar
clang-format committed
771
VPX_CTRL_USE_TYPE(VP8E_GET_LAST_QUANTIZER_64, int *)
772
#define VPX_CTRL_VP8E_GET_LAST_QUANTIZER_64
clang-format's avatar
clang-format committed
773
VPX_CTRL_USE_TYPE(VP9E_GET_SVC_LAYER_ID, vpx_svc_layer_id_t *)
774
#define VPX_CTRL_VP9E_GET_SVC_LAYER_ID
John Koleszar's avatar
John Koleszar committed
775

776
VPX_CTRL_USE_TYPE(VP8E_SET_MAX_INTRA_BITRATE_PCT, unsigned int)
777
#define VPX_CTRL_VP8E_SET_MAX_INTRA_BITRATE_PCT
778
VPX_CTRL_USE_TYPE(VP8E_SET_MAX_INTER_BITRATE_PCT, unsigned int)
779
#define VPX_CTRL_VP8E_SET_MAX_INTER_BITRATE_PCT
780

Marco's avatar
Marco committed
781
VPX_CTRL_USE_TYPE(VP8E_SET_SCREEN_CONTENT_MODE, unsigned int)
782
#define VPX_CTRL_VP8E_SET_SCREEN_CONTENT_MODE
Marco's avatar
Marco committed
783

784
VPX_CTRL_USE_TYPE(VP9E_SET_GF_CBR_BOOST_PCT, unsigned int)
785
#define VPX_CTRL_VP9E_SET_GF_CBR_BOOST_PCT
786

John Koleszar's avatar
John Koleszar committed
787
VPX_CTRL_USE_TYPE(VP9E_SET_LOSSLESS, unsigned int)
788
#define VPX_CTRL_VP9E_SET_LOSSLESS
789

790 791 792
#if CONFIG_AOM_QM
VPX_CTRL_USE_TYPE(VP9E_SET_ENABLE_QM, unsigned int)
#define VPX_CTRL_VP9E_SET_ENABLE_QM
793 794 795 796 797 798

VPX_CTRL_USE_TYPE(VP9E_SET_QM_MIN, unsigned int)
#define VPX_CTRL_VP9E_SET_QM_MIN

VPX_CTRL_USE_TYPE(VP9E_SET_QM_MAX, unsigned int)
#define VPX_CTRL_VP9E_SET_QM_MAX
799 800
#endif

801
VPX_CTRL_USE_TYPE(VP9E_SET_FRAME_PARALLEL_DECODING, unsigned int)
802
#define VPX_CTRL_VP9E_SET_FRAME_PARALLEL_DECODING
803

804
VPX_CTRL_USE_TYPE(VP9E_SET_AQ_MODE, unsigned int)
805
#define VPX_CTRL_VP9E_SET_AQ_MODE
806

807
VPX_CTRL_USE_TYPE(VP9E_SET_FRAME_PERIODIC_BOOST, unsigned int)
808
#define VPX_CTRL_VP9E_SET_FRAME_PERIODIC_BOOST
809

clang-format's avatar
clang-format committed
810
VPX_CTRL_USE_TYPE(VP9E_SET_NOISE_SENSITIVITY, unsigned int)
811
#define VPX_CTRL_VP9E_SET_NOISE_SENSITIVITY
812

813
VPX_CTRL_USE_TYPE(VP9E_SET_TUNE_CONTENT, int) /* vpx_tune_content */
814
#define VPX_CTRL_VP9E_SET_TUNE_CONTENT
815 816

VPX_CTRL_USE_TYPE(VP9E_SET_COLOR_SPACE, int)
817
#define VPX_CTRL_VP9E_SET_COLOR_SPACE
818

clang-format's avatar
clang-format committed
819
VPX_CTRL_USE_TYPE(VP9E_SET_MIN_GF_INTERVAL, unsigned int)
820
#define VPX_CTRL_VP9E_SET_MIN_GF_INTERVAL
821

clang-format's avatar
clang-format committed
822
VPX_CTRL_USE_TYPE(VP9E_SET_MAX_GF_INTERVAL, unsigned int)
823
#define VPX_CTRL_VP9E_SET_MAX_GF_INTERVAL
824

825
VPX_CTRL_USE_TYPE(VP9E_GET_ACTIVEMAP, vpx_active_map_t *)
826
#define VPX_CTRL_VP9E_GET_ACTIVEMAP
827 828

VPX_CTRL_USE_TYPE(VP9E_SET_COLOR_RANGE, int)
829
#define VPX_CTRL_VP9E_SET_COLOR_RANGE
830 831

VPX_CTRL_USE_TYPE(VP9E_SET_SVC_REF_FRAME_CONFIG, vpx_svc_ref_frame_config_t *)
832
#define VPX_CTRL_VP9E_SET_SVC_REF_FRAME_CONFIG
833 834

VPX_CTRL_USE_TYPE(VP9E_SET_RENDER_SIZE, int *)
835 836 837
#define VPX_CTRL_VP9E_SET_RENDER_SIZE

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

James Zern's avatar
James Zern committed
843
#endif  // VPX_VP8CX_H_