granicus.if.org Git - libvpx/blob - vpx/vp8cx.h

   1 /*
   2  *  Copyright (c) 2010 The WebM project authors. All Rights Reserved.
   3  *
   4  *  Use of this source code is governed by a BSD-style license
   5  *  that can be found in the LICENSE file in the root of the source
   6  *  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.
   9  */
  10 #ifndef VPX_VP8CX_H_
  11 #define VPX_VP8CX_H_
  12
  13 /*!\defgroup vp8_encoder WebM VP8/VP9 Encoder
  14  * \ingroup vp8
  15  *
  16  * @{
  17  */
  18 #include "./vp8.h"
  19 #include "./vpx_encoder.h"
  20
  21 /*!\file
  22  * \brief Provides definitions for using VP8 or VP9 encoder algorithm within the
  23  *        vpx Codec Interface.
  24  */
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif
  29
  30 /*!\name Algorithm interface for VP8
  31  *
  32  * This interface provides the capability to encode raw VP8 streams.
  33  * @{
  34  */
  35 extern vpx_codec_iface_t  vpx_codec_vp8_cx_algo;
  36 extern vpx_codec_iface_t *vpx_codec_vp8_cx(void);
  37 /*!@} - end algorithm interface member group*/
  38
  39 /*!\name Algorithm interface for VP9
  40  *
  41  * This interface provides the capability to encode raw VP9 streams.
  42  * @{
  43  */
  44 extern vpx_codec_iface_t  vpx_codec_vp9_cx_algo;
  45 extern vpx_codec_iface_t *vpx_codec_vp9_cx(void);
  46 /*!@} - end algorithm interface member group*/
  47
  48 /*!\name Algorithm interface for VP10
  49  *
  50  * This interface provides the capability to encode raw VP9 streams.
  51  * @{
  52  */
  53 extern vpx_codec_iface_t  vpx_codec_vp10_cx_algo;
  54 extern vpx_codec_iface_t *vpx_codec_vp10_cx(void);
  55 /*!@} - end algorithm interface member group*/
  56
  57 /*
  58  * Algorithm Flags
  59  */
  60
  61 /*!\brief Don't reference the last frame
  62  *
  63  * When this flag is set, the encoder will not use the last frame as a
  64  * predictor. When not set, the encoder will choose whether to use the
  65  * last frame or not automatically.
  66  */
  67 #define VP8_EFLAG_NO_REF_LAST      (1<<16)
  68
  69
  70 /*!\brief Don't reference the golden frame
  71  *
  72  * When this flag is set, the encoder will not use the golden frame as a
  73  * predictor. When not set, the encoder will choose whether to use the
  74  * golden frame or not automatically.
  75  */
  76 #define VP8_EFLAG_NO_REF_GF        (1<<17)
  77
  78
  79 /*!\brief Don't reference the alternate reference frame
  80  *
  81  * When this flag is set, the encoder will not use the alt ref frame as a
  82  * predictor. When not set, the encoder will choose whether to use the
  83  * alt ref frame or not automatically.
  84  */
  85 #define VP8_EFLAG_NO_REF_ARF       (1<<21)
  86
  87
  88 /*!\brief Don't update the last frame
  89  *
  90  * When this flag is set, the encoder will not update the last frame with
  91  * the contents of the current frame.
  92  */
  93 #define VP8_EFLAG_NO_UPD_LAST      (1<<18)
  94
  95
  96 /*!\brief Don't update the golden frame
  97  *
  98  * When this flag is set, the encoder will not update the golden frame with
  99  * the contents of the current frame.
 100  */
 101 #define VP8_EFLAG_NO_UPD_GF        (1<<22)
 102
 103
 104 /*!\brief Don't update the alternate reference frame
 105  *
 106  * When this flag is set, the encoder will not update the alt ref frame with
 107  * the contents of the current frame.
 108  */
 109 #define VP8_EFLAG_NO_UPD_ARF       (1<<23)
 110
 111
 112 /*!\brief Force golden frame update
 113  *
 114  * When this flag is set, the encoder copy the contents of the current frame
 115  * to the golden frame buffer.
 116  */
 117 #define VP8_EFLAG_FORCE_GF         (1<<19)
 118
 119
 120 /*!\brief Force alternate reference frame update
 121  *
 122  * When this flag is set, the encoder copy the contents of the current frame
 123  * to the alternate reference frame buffer.
 124  */
 125 #define VP8_EFLAG_FORCE_ARF        (1<<24)
 126
 127
 128 /*!\brief Disable entropy update
 129  *
 130  * When this flag is set, the encoder will not update its internal entropy
 131  * model based on the entropy of this frame.
 132  */
 133 #define VP8_EFLAG_NO_UPD_ENTROPY   (1<<20)
 134
 135
 136 /*!\brief VPx encoder control functions
 137  *
 138  * This set of macros define the control functions available for VPx
 139  * encoder interface.
 140  *
 141  * \sa #vpx_codec_control
 142  */
 143 enum vp8e_enc_control_id {
 144   /*!\brief Codec control function to pass an ROI map to encoder.
 145    *
 146    * Supported in codecs: VP8, VP9
 147    */
 148   VP8E_SET_ROI_MAP           = 8,
 149
 150   /*!\brief Codec control function to pass an Active map to encoder.
 151    *
 152    * Supported in codecs: VP8, VP9
 153    */
 154   VP8E_SET_ACTIVEMAP,
 155
 156   /*!\brief Codec control function to set encoder scaling mode.
 157    *
 158    * Supported in codecs: VP8, VP9
 159    */
 160   VP8E_SET_SCALEMODE         = 11,
 161
 162   /*!\brief Codec control function to set encoder internal speed settings.
 163    *
 164    * Changes in this value influences, among others, the encoder's selection
 165    * of motion estimation methods. Values greater than 0 will increase encoder
 166    * speed at the expense of quality.
 167    *
 168    * \note Valid range for VP8: -16..16
 169    * \note Valid range for VP9: -8..8
 170    *
 171    * Supported in codecs: VP8, VP9
 172    */
 173   VP8E_SET_CPUUSED           = 13,
 174
 175   /*!\brief Codec control function to enable automatic set and use alf frames.
 176    *
 177    * Supported in codecs: VP8, VP9
 178    */
 179   VP8E_SET_ENABLEAUTOALTREF,
 180
 181   /*!\brief control function to set noise sensitivity
 182    *
 183    * 0: off, 1: OnYOnly, 2: OnYUV,
 184    * 3: OnYUVAggressive, 4: Adaptive
 185    *
 186    * Supported in codecs: VP8
 187    */
 188   VP8E_SET_NOISE_SENSITIVITY,
 189
 190   /*!\brief Codec control function to set sharpness.
 191    *
 192    * Supported in codecs: VP8, VP9
 193    */
 194   VP8E_SET_SHARPNESS,
 195
 196   /*!\brief Codec control function to set the threshold for MBs treated static.
 197    *
 198    * Supported in codecs: VP8, VP9
 199    */
 200   VP8E_SET_STATIC_THRESHOLD,
 201
 202   /*!\brief Codec control function to set the number of token partitions.
 203    *
 204    * Supported in codecs: VP8
 205    */
 206   VP8E_SET_TOKEN_PARTITIONS,
 207
 208   /*!\brief Codec control function to get last quantizer chosen by the encoder.
 209    *
 210    * Return value uses internal quantizer scale defined by the codec.
 211    *
 212    * Supported in codecs: VP8, VP9
 213    */
 214   VP8E_GET_LAST_QUANTIZER,
 215
 216   /*!\brief Codec control function to get last quantizer chosen by the encoder.
 217    *
 218    * Return value uses the 0..63 scale as used by the rc_*_quantizer config
 219    * parameters.
 220    *
 221    * Supported in codecs: VP8, VP9
 222    */
 223   VP8E_GET_LAST_QUANTIZER_64,
 224
 225   /*!\brief Codec control function to set the max no of frames to create arf.
 226    *
 227    * Supported in codecs: VP8, VP9
 228    */
 229   VP8E_SET_ARNR_MAXFRAMES,
 230
 231   /*!\brief Codec control function to set the filter strength for the arf.
 232    *
 233    * Supported in codecs: VP8, VP9
 234    */
 235   VP8E_SET_ARNR_STRENGTH,
 236
 237   /*!\deprecated control function to set the filter type to use for the arf. */
 238   VP8E_SET_ARNR_TYPE,
 239
 240   /*!\brief Codec control function to set visual tuning.
 241    *
 242    * Supported in codecs: VP8, VP9
 243    */
 244   VP8E_SET_TUNING,
 245
 246   /*!\brief Codec control function to set constrained quality level.
 247    *
 248    * \attention For this value to be used vpx_codec_enc_cfg_t::g_usage must be
 249    *            set to #VPX_CQ.
 250    * \note Valid range: 0..63
 251    *
 252    * Supported in codecs: VP8, VP9
 253    */
 254   VP8E_SET_CQ_LEVEL,
 255
 256   /*!\brief Codec control function to set Max data rate for Intra frames.
 257    *
 258    * This value controls additional clamping on the maximum size of a
 259    * keyframe. It is expressed as a percentage of the average
 260    * per-frame bitrate, with the special (and default) value 0 meaning
 261    * unlimited, or no additional clamping beyond the codec's built-in
 262    * algorithm.
 263    *
 264    * For example, to allocate no more than 4.5 frames worth of bitrate
 265    * to a keyframe, set this to 450.
 266    *
 267    * Supported in codecs: VP8, VP9
 268    */
 269   VP8E_SET_MAX_INTRA_BITRATE_PCT,
 270
 271   /*!\brief Codec control function to set reference and update frame flags.
 272    *
 273    *  Supported in codecs: VP8
 274    */
 275   VP8E_SET_FRAME_FLAGS,
 276
 277   /*!\brief Codec control function to set max data rate for Inter frames.
 278    *
 279    * This value controls additional clamping on the maximum size of an
 280    * inter frame. It is expressed as a percentage of the average
 281    * per-frame bitrate, with the special (and default) value 0 meaning
 282    * unlimited, or no additional clamping beyond the codec's built-in
 283    * algorithm.
 284    *
 285    * For example, to allow no more than 4.5 frames worth of bitrate
 286    * to an inter frame, set this to 450.
 287    *
 288    * Supported in codecs: VP9
 289    */
 290   VP9E_SET_MAX_INTER_BITRATE_PCT,
 291
 292   /*!\brief Boost percentage for Golden Frame in CBR mode.
 293    *
 294    * This value controls the amount of boost given to Golden Frame in
 295    * CBR mode. It is expressed as a percentage of the average
 296    * per-frame bitrate, with the special (and default) value 0 meaning
 297    * the feature is off, i.e., no golden frame boost in CBR mode and
 298    * average bitrate target is used.
 299    *
 300    * For example, to allow 100% more bits, i.e, 2X, in a golden frame
 301    * than average frame, set this to 100.
 302    *
 303    * Supported in codecs: VP9
 304    */
 305   VP9E_SET_GF_CBR_BOOST_PCT,
 306
 307   /*!\brief Codec control function to set the temporal layer id.
 308    *
 309    * For temporal scalability: this control allows the application to set the
 310    * layer id for each frame to be encoded. Note that this control must be set
 311    * for every frame prior to encoding. The usage of this control function
 312    * supersedes the internal temporal pattern counter, which is now deprecated.
 313    *
 314    * Supported in codecs: VP8
 315    */
 316   VP8E_SET_TEMPORAL_LAYER_ID,
 317
 318   /*!\brief Codec control function to set encoder screen content mode.
 319    *
 320    * 0: off, 1: On, 2: On with more aggressive rate control.
 321    *
 322    * Supported in codecs: VP8
 323    */
 324   VP8E_SET_SCREEN_CONTENT_MODE,
 325
 326   /*!\brief Codec control function to set lossless encoding mode.
 327    *
 328    * VP9 can operate in lossless encoding mode, in which the bitstream
 329    * produced will be able to decode and reconstruct a perfect copy of
 330    * input source. This control function provides a mean to switch encoder
 331    * into lossless coding mode(1) or normal coding mode(0) that may be lossy.
 332    *                          0 = lossy coding mode
 333    *                          1 = lossless coding mode
 334    *
 335    *  By default, encoder operates in normal coding mode (maybe lossy).
 336    *
 337    * Supported in codecs: VP9
 338    */
 339   VP9E_SET_LOSSLESS,
 340
 341   /*!\brief Codec control function to set number of tile columns.
 342    *
 343    * In encoding and decoding, VP9 allows an input image frame be partitioned
 344    * into separated vertical tile columns, which can be encoded or decoded
 345    * independently. This enables easy implementation of parallel encoding and
 346    * decoding. This control requests the encoder to use column tiles in
 347    * encoding an input frame, with number of tile columns (in Log2 unit) as
 348    * the parameter:
 349    *             0 = 1 tile column
 350    *             1 = 2 tile columns
 351    *             2 = 4 tile columns
 352    *             .....
 353    *             n = 2**n tile columns
 354    * The requested tile columns will be capped by encoder based on image size
 355    * limitation (The minimum width of a tile column is 256 pixel, the maximum
 356    * is 4096).
 357    *
 358    * By default, the value is 0, i.e. one single column tile for entire image.
 359    *
 360    * Supported in codecs: VP9
 361    */
 362   VP9E_SET_TILE_COLUMNS,
 363
 364   /*!\brief Codec control function to set number of tile rows.
 365    *
 366    * In encoding and decoding, VP9 allows an input image frame be partitioned
 367    * into separated horizontal tile rows. Tile rows are encoded or decoded
 368    * sequentially. Even though encoding/decoding of later tile rows depends on
 369    * earlier ones, this allows the encoder to output data packets for tile rows
 370    * prior to completely processing all tile rows in a frame, thereby reducing
 371    * the latency in processing between input and output. The parameter
 372    * for this control describes the number of tile rows, which has a valid
 373    * range [0, 2]:
 374    *            0 = 1 tile row
 375    *            1 = 2 tile rows
 376    *            2 = 4 tile rows
 377    *
 378    * By default, the value is 0, i.e. one single row tile for entire image.
 379    *
 380    * Supported in codecs: VP9
 381    */
 382   VP9E_SET_TILE_ROWS,
 383
 384   /*!\brief Codec control function to enable frame parallel decoding feature.
 385    *
 386    * VP9 has a bitstream feature to reduce decoding dependency between frames
 387    * by turning off backward update of probability context used in encoding
 388    * and decoding. This allows staged parallel processing of more than one
 389    * video frames in the decoder. This control function provides a mean to
 390    * turn this feature on or off for bitstreams produced by encoder.
 391    *
 392    * By default, this feature is off.
 393    *
 394    * Supported in codecs: VP9
 395    */
 396   VP9E_SET_FRAME_PARALLEL_DECODING,
 397
 398   /*!\brief Codec control function to set adaptive quantization mode.
 399    *
 400    * VP9 has a segment based feature that allows encoder to adaptively change
 401    * quantization parameter for each segment within a frame to improve the
 402    * subjective quality. This control makes encoder operate in one of the
 403    * several AQ_modes supported.
 404    *
 405    * By default, encoder operates with AQ_Mode 0(adaptive quantization off).
 406    *
 407    * Supported in codecs: VP9
 408    */
 409   VP9E_SET_AQ_MODE,
 410
 411   /*!\brief Codec control function to enable/disable periodic Q boost.
 412    *
 413    * One VP9 encoder speed feature is to enable quality boost by lowering
 414    * frame level Q periodically. This control function provides a mean to
 415    * turn on/off this feature.
 416    *               0 = off
 417    *               1 = on
 418    *
 419    * By default, the encoder is allowed to use this feature for appropriate
 420    * encoding modes.
 421    *
 422    * Supported in codecs: VP9
 423    */
 424   VP9E_SET_FRAME_PERIODIC_BOOST,
 425
 426   /*!\brief Codec control function to set noise sensitivity.
 427    *
 428    *  0: off, 1: On(YOnly)
 429    *
 430    * Supported in codecs: VP9
 431    */
 432   VP9E_SET_NOISE_SENSITIVITY,
 433
 434   /*!\brief Codec control function to turn on/off SVC in encoder.
 435    * \note Return value is VPX_CODEC_INVALID_PARAM if the encoder does not
 436    *       support SVC in its current encoding mode
 437    *  0: off, 1: on
 438    *
 439    * Supported in codecs: VP9
 440    */
 441   VP9E_SET_SVC,
 442
 443   /*!\brief Codec control function to set parameters for SVC.
 444    * \note Parameters contain min_q, max_q, scaling factor for each of the
 445    *       SVC layers.
 446    *
 447    * Supported in codecs: VP9
 448    */
 449   VP9E_SET_SVC_PARAMETERS,
 450
 451   /*!\brief Codec control function to set svc layer for spatial and temporal.
 452    * \note Valid ranges: 0..#vpx_codec_enc_cfg::ss_number_layers for spatial
 453    *                     layer and 0..#vpx_codec_enc_cfg::ts_number_layers for
 454    *                     temporal layer.
 455    *
 456    * Supported in codecs: VP9
 457    */
 458   VP9E_SET_SVC_LAYER_ID,
 459
 460   /*!\brief Codec control function to set content type.
 461    * \note Valid parameter range:
 462    *              VP9E_CONTENT_DEFAULT = Regular video content (Default)
 463    *              VP9E_CONTENT_SCREEN  = Screen capture content
 464    *
 465    * Supported in codecs: VP9
 466    */
 467   VP9E_SET_TUNE_CONTENT,
 468
 469   /*!\brief Codec control function to get svc layer ID.
 470    * \note The layer ID returned is for the data packet from the registered
 471    *       callback function.
 472    *
 473    * Supported in codecs: VP9
 474    */
 475   VP9E_GET_SVC_LAYER_ID,
 476
 477   /*!\brief Codec control function to register callback to get per layer packet.
 478    * \note Parameter for this control function is a structure with a callback
 479    *       function and a pointer to private data used by the callback.
 480    *
 481    * Supported in codecs: VP9
 482    */
 483   VP9E_REGISTER_CX_CALLBACK,
 484
 485   /*!\brief Codec control function to set color space info.
 486    * \note Valid ranges: 0..7, default is "UNKNOWN".
 487    *                     0 = UNKNOWN,
 488    *                     1 = BT_601
 489    *                     2 = BT_709
 490    *                     3 = SMPTE_170
 491    *                     4 = SMPTE_240
 492    *                     5 = BT_2020
 493    *                     6 = RESERVED
 494    *                     7 = SRGB
 495    *
 496    * Supported in codecs: VP9
 497    */
 498   VP9E_SET_COLOR_SPACE,
 499
 500   /*!\brief Codec control function to set temporal layering mode.
 501    * \note Valid ranges: 0..3, default is "0" (VP9E_TEMPORAL_LAYERING_MODE_NOLAYERING).
 502    *                     0 = VP9E_TEMPORAL_LAYERING_MODE_NOLAYERING
 503    *                     1 = VP9E_TEMPORAL_LAYERING_MODE_BYPASS
 504    *                     2 = VP9E_TEMPORAL_LAYERING_MODE_0101
 505    *                     3 = VP9E_TEMPORAL_LAYERING_MODE_0212
 506    *
 507    * Supported in codecs: VP9
 508    */
 509   VP9E_SET_TEMPORAL_LAYERING_MODE,
 510
 511   /*!\brief Codec control function to set minimum interval between GF/ARF frames
 512    *
 513    * By default the value is set as 4.
 514    *
 515    * Supported in codecs: VP9
 516    */
 517   VP9E_SET_MIN_GF_INTERVAL,
 518
 519   /*!\brief Codec control function to set minimum interval between GF/ARF frames
 520    *
 521    * By default the value is set as 16.
 522    *
 523    * Supported in codecs: VP9
 524    */
 525   VP9E_SET_MAX_GF_INTERVAL,
 526
 527   /*!\brief Codec control function to get an Active map back from the encoder.
 528    *
 529    * Supported in codecs: VP9
 530    */
 531   VP9E_GET_ACTIVEMAP,
 532
 533   /*!\brief Codec control function to set color range bit.
 534    * \note Valid ranges: 0..1, default is 0
 535    *                     0 = Limited range (16..235 or HBD equivalent)
 536    *                     1 = Full range (0..255 or HBD equivalent)
 537    *
 538    * Supported in codecs: VP9
 539    */
 540   VP9E_SET_COLOR_RANGE,
 541
 542   /*!\brief Codec control function to set the frame flags and buffer indices
 543    * for spatial layers. The frame flags and buffer indices are set using the
 544    * struct #vpx_svc_ref_frame_config defined below.
 545    *
 546    * Supported in codecs: VP9
 547   */
 548   VP9E_SET_SVC_REF_FRAME_CONFIG,
 549
 550   /*!\brief Codec control function to set intended rendering image size.
 551    *
 552    * By default, this is identical to the image size in pixels.
 553    *
 554    * Supported in codecs: VP9
 555    */
 556   VP9E_SET_RENDER_SIZE,
 557
 558   /*!\brief Codec control function to set target level.
 559    *
 560    * 255: off (default); 0: only keep level stats; 10: target for level 1.0;
 561    * 11: target for level 1.1; ... 62: target for level 6.2
 562    *
 563    * Supported in codecs: VP9
 564    */
 565   VP9E_SET_TARGET_LEVEL,
 566
 567   /*!\brief Codec control function to get bitstream level.
 568    *
 569    * Supported in codecs: VP9
 570    */
 571   VP9E_GET_LEVEL
 572 };
 573
 574 /*!\brief vpx 1-D scaling mode
 575  *
 576  * This set of constants define 1-D vpx scaling modes
 577  */
 578 typedef enum vpx_scaling_mode_1d {
 579   VP8E_NORMAL      = 0,
 580   VP8E_FOURFIVE    = 1,
 581   VP8E_THREEFIVE   = 2,
 582   VP8E_ONETWO      = 3
 583 } VPX_SCALING_MODE;
 584
 585 /*!\brief Temporal layering mode enum for VP9 SVC.
 586  *
 587  * This set of macros define the different temporal layering modes.
 588  * Supported codecs: VP9 (in SVC mode)
 589  *
 590  */
 591 typedef enum vp9e_temporal_layering_mode {
 592   /*!\brief No temporal layering.
 593    * Used when only spatial layering is used.
 594    */
 595   VP9E_TEMPORAL_LAYERING_MODE_NOLAYERING   = 0,
 596
 597   /*!\brief Bypass mode.
 598    * Used when application needs to control temporal layering.
 599    * This will only work when the number of spatial layers equals 1.
 600    */
 601   VP9E_TEMPORAL_LAYERING_MODE_BYPASS       = 1,
 602
 603   /*!\brief 0-1-0-1... temporal layering scheme with two temporal layers.
 604    */
 605   VP9E_TEMPORAL_LAYERING_MODE_0101         = 2,
 606
 607   /*!\brief 0-2-1-2... temporal layering scheme with three temporal layers.
 608    */
 609   VP9E_TEMPORAL_LAYERING_MODE_0212         = 3
 610 } VP9E_TEMPORAL_LAYERING_MODE;
 611
 612 /*!\brief  vpx region of interest map
 613  *
 614  * These defines the data structures for the region of interest map
 615  *
 616  */
 617
 618 typedef struct vpx_roi_map {
 619   /*! An id between 0 and 3 for each 16x16 region within a frame. */
 620   unsigned char *roi_map;
 621   unsigned int rows;       /**< Number of rows. */
 622   unsigned int cols;       /**< Number of columns. */
 623   // TODO(paulwilkins): broken for VP9 which has 8 segments
 624   // q and loop filter deltas for each segment
 625   // (see MAX_MB_SEGMENTS)
 626   int delta_q[4];          /**< Quantizer deltas. */
 627   int delta_lf[4];         /**< Loop filter deltas. */
 628   /*! Static breakout threshold for each segment. */
 629   unsigned int static_threshold[4];
 630 } vpx_roi_map_t;
 631
 632 /*!\brief  vpx active region map
 633  *
 634  * These defines the data structures for active region map
 635  *
 636  */
 637
 638
 639 typedef struct vpx_active_map {
 640   unsigned char  *active_map; /**< specify an on (1) or off (0) each 16x16 region within a frame */
 641   unsigned int    rows;       /**< number of rows */
 642   unsigned int    cols;       /**< number of cols */
 643 } vpx_active_map_t;
 644
 645 /*!\brief  vpx image scaling mode
 646  *
 647  * This defines the data structure for image scaling mode
 648  *
 649  */
 650 typedef struct vpx_scaling_mode {
 651   VPX_SCALING_MODE    h_scaling_mode;  /**< horizontal scaling mode */
 652   VPX_SCALING_MODE    v_scaling_mode;  /**< vertical scaling mode   */
 653 } vpx_scaling_mode_t;
 654
 655 /*!\brief VP8 token partition mode
 656  *
 657  * This defines VP8 partitioning mode for compressed data, i.e., the number of
 658  * sub-streams in the bitstream. Used for parallelized decoding.
 659  *
 660  */
 661
 662 typedef enum {
 663   VP8_ONE_TOKENPARTITION   = 0,
 664   VP8_TWO_TOKENPARTITION   = 1,
 665   VP8_FOUR_TOKENPARTITION  = 2,
 666   VP8_EIGHT_TOKENPARTITION = 3
 667 } vp8e_token_partitions;
 668
 669 /*!brief VP9 encoder content type */
 670 typedef enum {
 671   VP9E_CONTENT_DEFAULT,
 672   VP9E_CONTENT_SCREEN,
 673   VP9E_CONTENT_INVALID
 674 } vp9e_tune_content;
 675
 676 /*!\brief VP8 model tuning parameters
 677  *
 678  * Changes the encoder to tune for certain types of input material.
 679  *
 680  */
 681 typedef enum {
 682   VP8_TUNE_PSNR,
 683   VP8_TUNE_SSIM
 684 } vp8e_tuning;
 685
 686 /*!\brief  vp9 svc layer parameters
 687  *
 688  * This defines the spatial and temporal layer id numbers for svc encoding.
 689  * This is used with the #VP9E_SET_SVC_LAYER_ID control to set the spatial and
 690  * temporal layer id for the current frame.
 691  *
 692  */
 693 typedef struct vpx_svc_layer_id {
 694   int spatial_layer_id;       /**< Spatial layer id number. */
 695   int temporal_layer_id;      /**< Temporal layer id number. */
 696 } vpx_svc_layer_id_t;
 697
 698 /*!\brief  vp9 svc frame flag parameters.
 699  *
 700  * This defines the frame flags and buffer indices for each spatial layer for
 701  * svc encoding.
 702  * This is used with the #VP9E_SET_SVC_REF_FRAME_CONFIG control to set frame
 703  * flags and buffer indices for each spatial layer for the current (super)frame.
 704  *
 705  */
 706 typedef struct vpx_svc_ref_frame_config {
 707   int frame_flags[VPX_TS_MAX_LAYERS];  /**< Frame flags. */
 708   int lst_fb_idx[VPX_TS_MAX_LAYERS];  /**< Last buffer index. */
 709   int gld_fb_idx[VPX_TS_MAX_LAYERS];  /**< Golden buffer index. */
 710   int alt_fb_idx[VPX_TS_MAX_LAYERS];  /**< Altref buffer index. */
 711 } vpx_svc_ref_frame_config_t;
 712
 713 /*!\cond */
 714 /*!\brief VP8 encoder control function parameter type
 715  *
 716  * Defines the data types that VP8E control functions take. Note that
 717  * additional common controls are defined in vp8.h
 718  *
 719  */
 720
 721 VPX_CTRL_USE_TYPE(VP8E_SET_FRAME_FLAGS,        int)
 722 #define VPX_CTRL_VP8E_SET_FRAME_FLAGS
 723 VPX_CTRL_USE_TYPE(VP8E_SET_TEMPORAL_LAYER_ID,  int)
 724 #define VPX_CTRL_VP8E_SET_TEMPORAL_LAYER_ID
 725 VPX_CTRL_USE_TYPE(VP8E_SET_ROI_MAP,            vpx_roi_map_t *)
 726 #define VPX_CTRL_VP8E_SET_ROI_MAP
 727 VPX_CTRL_USE_TYPE(VP8E_SET_ACTIVEMAP,          vpx_active_map_t *)
 728 #define VPX_CTRL_VP8E_SET_ACTIVEMAP
 729 VPX_CTRL_USE_TYPE(VP8E_SET_SCALEMODE,          vpx_scaling_mode_t *)
 730 #define VPX_CTRL_VP8E_SET_SCALEMODE
 731
 732 VPX_CTRL_USE_TYPE(VP9E_SET_SVC,                int)
 733 #define VPX_CTRL_VP9E_SET_SVC
 734 VPX_CTRL_USE_TYPE(VP9E_SET_SVC_PARAMETERS,     void *)
 735 #define VPX_CTRL_VP9E_SET_SVC_PARAMETERS
 736 VPX_CTRL_USE_TYPE(VP9E_REGISTER_CX_CALLBACK,   void *)
 737 #define VPX_CTRL_VP9E_REGISTER_CX_CALLBACK
 738 VPX_CTRL_USE_TYPE(VP9E_SET_SVC_LAYER_ID,       vpx_svc_layer_id_t *)
 739 #define VPX_CTRL_VP9E_SET_SVC_LAYER_ID
 740
 741 VPX_CTRL_USE_TYPE(VP8E_SET_CPUUSED,            int)
 742 #define VPX_CTRL_VP8E_SET_CPUUSED
 743 VPX_CTRL_USE_TYPE(VP8E_SET_ENABLEAUTOALTREF,   unsigned int)
 744 #define VPX_CTRL_VP8E_SET_ENABLEAUTOALTREF
 745 VPX_CTRL_USE_TYPE(VP8E_SET_NOISE_SENSITIVITY,  unsigned int)
 746 #define VPX_CTRL_VP8E_SET_NOISE_SENSITIVITY
 747 VPX_CTRL_USE_TYPE(VP8E_SET_SHARPNESS,          unsigned int)
 748 #define VPX_CTRL_VP8E_SET_SHARPNESS
 749 VPX_CTRL_USE_TYPE(VP8E_SET_STATIC_THRESHOLD,   unsigned int)
 750 #define VPX_CTRL_VP8E_SET_STATIC_THRESHOLD
 751 VPX_CTRL_USE_TYPE(VP8E_SET_TOKEN_PARTITIONS,   int) /* vp8e_token_partitions */
 752 #define VPX_CTRL_VP8E_SET_TOKEN_PARTITIONS
 753
 754 VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_MAXFRAMES,     unsigned int)
 755 #define VPX_CTRL_VP8E_SET_ARNR_MAXFRAMES
 756 VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_STRENGTH,     unsigned int)
 757 #define VPX_CTRL_VP8E_SET_ARNR_STRENGTH
 758 VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_SET_ARNR_TYPE,     unsigned int)
 759 #define VPX_CTRL_VP8E_SET_ARNR_TYPE
 760 VPX_CTRL_USE_TYPE(VP8E_SET_TUNING,             int) /* vp8e_tuning */
 761 #define VPX_CTRL_VP8E_SET_TUNING
 762 VPX_CTRL_USE_TYPE(VP8E_SET_CQ_LEVEL,      unsigned int)
 763 #define VPX_CTRL_VP8E_SET_CQ_LEVEL
 764
 765 VPX_CTRL_USE_TYPE(VP9E_SET_TILE_COLUMNS,  int)
 766 #define VPX_CTRL_VP9E_SET_TILE_COLUMNS
 767 VPX_CTRL_USE_TYPE(VP9E_SET_TILE_ROWS,  int)
 768 #define VPX_CTRL_VP9E_SET_TILE_ROWS
 769
 770 VPX_CTRL_USE_TYPE(VP8E_GET_LAST_QUANTIZER,     int *)
 771 #define VPX_CTRL_VP8E_GET_LAST_QUANTIZER
 772 VPX_CTRL_USE_TYPE(VP8E_GET_LAST_QUANTIZER_64,  int *)
 773 #define VPX_CTRL_VP8E_GET_LAST_QUANTIZER_64
 774 VPX_CTRL_USE_TYPE(VP9E_GET_SVC_LAYER_ID,  vpx_svc_layer_id_t *)
 775 #define VPX_CTRL_VP9E_GET_SVC_LAYER_ID
 776
 777 VPX_CTRL_USE_TYPE(VP8E_SET_MAX_INTRA_BITRATE_PCT, unsigned int)
 778 #define VPX_CTRL_VP8E_SET_MAX_INTRA_BITRATE_PCT
 779 VPX_CTRL_USE_TYPE(VP8E_SET_MAX_INTER_BITRATE_PCT, unsigned int)
 780 #define VPX_CTRL_VP8E_SET_MAX_INTER_BITRATE_PCT
 781
 782 VPX_CTRL_USE_TYPE(VP8E_SET_SCREEN_CONTENT_MODE, unsigned int)
 783 #define VPX_CTRL_VP8E_SET_SCREEN_CONTENT_MODE
 784
 785 VPX_CTRL_USE_TYPE(VP9E_SET_GF_CBR_BOOST_PCT, unsigned int)
 786 #define VPX_CTRL_VP9E_SET_GF_CBR_BOOST_PCT
 787
 788 VPX_CTRL_USE_TYPE(VP9E_SET_LOSSLESS, unsigned int)
 789 #define VPX_CTRL_VP9E_SET_LOSSLESS
 790
 791 VPX_CTRL_USE_TYPE(VP9E_SET_FRAME_PARALLEL_DECODING, unsigned int)
 792 #define VPX_CTRL_VP9E_SET_FRAME_PARALLEL_DECODING
 793
 794 VPX_CTRL_USE_TYPE(VP9E_SET_AQ_MODE, unsigned int)
 795 #define VPX_CTRL_VP9E_SET_AQ_MODE
 796
 797 VPX_CTRL_USE_TYPE(VP9E_SET_FRAME_PERIODIC_BOOST, unsigned int)
 798 #define VPX_CTRL_VP9E_SET_FRAME_PERIODIC_BOOST
 799
 800 VPX_CTRL_USE_TYPE(VP9E_SET_NOISE_SENSITIVITY,  unsigned int)
 801 #define VPX_CTRL_VP9E_SET_NOISE_SENSITIVITY
 802
 803 VPX_CTRL_USE_TYPE(VP9E_SET_TUNE_CONTENT, int) /* vp9e_tune_content */
 804 #define VPX_CTRL_VP9E_SET_TUNE_CONTENT
 805
 806 VPX_CTRL_USE_TYPE(VP9E_SET_COLOR_SPACE, int)
 807 #define VPX_CTRL_VP9E_SET_COLOR_SPACE
 808
 809 VPX_CTRL_USE_TYPE(VP9E_SET_MIN_GF_INTERVAL,  unsigned int)
 810 #define VPX_CTRL_VP9E_SET_MIN_GF_INTERVAL
 811
 812 VPX_CTRL_USE_TYPE(VP9E_SET_MAX_GF_INTERVAL,  unsigned int)
 813 #define VPX_CTRL_VP9E_SET_MAX_GF_INTERVAL
 814
 815 VPX_CTRL_USE_TYPE(VP9E_GET_ACTIVEMAP, vpx_active_map_t *)
 816 #define VPX_CTRL_VP9E_GET_ACTIVEMAP
 817
 818 VPX_CTRL_USE_TYPE(VP9E_SET_COLOR_RANGE, int)
 819 #define VPX_CTRL_VP9E_SET_COLOR_RANGE
 820
 821 VPX_CTRL_USE_TYPE(VP9E_SET_SVC_REF_FRAME_CONFIG, vpx_svc_ref_frame_config_t *)
 822 #define VPX_CTRL_VP9E_SET_SVC_REF_FRAME_CONFIG
 823
 824 VPX_CTRL_USE_TYPE(VP9E_SET_RENDER_SIZE, int *)
 825 #define VPX_CTRL_VP9E_SET_RENDER_SIZE
 826
 827 VPX_CTRL_USE_TYPE(VP9E_SET_TARGET_LEVEL,  unsigned int)
 828 #define VPX_CTRL_VP9E_SET_TARGET_LEVEL
 829
 830 VPX_CTRL_USE_TYPE(VP9E_GET_LEVEL, int *)
 831 #define VPX_CTRL_VP9E_GET_LEVEL
 832
 833 /*!\endcond */
 834 /*! @} - end defgroup vp8_encoder */
 835 #ifdef __cplusplus
 836 }  // extern "C"
 837 #endif
 838
 839 #endif  // VPX_VP8CX_H_