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