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 Encoder
  14  * \ingroup vp8
  15  *
  16  * @{
  17  */
  18 #include "./vp8.h"
  19
  20 /*!\file
  21  * \brief Provides definitions for using the VP8 encoder algorithm within the
  22  *        vpx Codec Interface.
  23  */
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif
  28
  29 /*!\name Algorithm interface for VP8
  30  *
  31  * This interface provides the capability to encode raw VP8 streams, as would
  32  * be found in AVI files.
  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
  38 /* TODO(jkoleszar): These move to VP9 in a later patch set. */
  39 extern vpx_codec_iface_t  vpx_codec_vp9_cx_algo;
  40 extern vpx_codec_iface_t *vpx_codec_vp9_cx(void);
  41
  42 /*!@} - end algorithm interface member group*/
  43
  44
  45 /*
  46  * Algorithm Flags
  47  */
  48
  49 /*!\brief Don't reference the last frame
  50  *
  51  * When this flag is set, the encoder will not use the last frame as a
  52  * predictor. When not set, the encoder will choose whether to use the
  53  * last frame or not automatically.
  54  */
  55 #define VP8_EFLAG_NO_REF_LAST      (1<<16)
  56
  57
  58 /*!\brief Don't reference the golden frame
  59  *
  60  * When this flag is set, the encoder will not use the golden frame as a
  61  * predictor. When not set, the encoder will choose whether to use the
  62  * golden frame or not automatically.
  63  */
  64 #define VP8_EFLAG_NO_REF_GF        (1<<17)
  65
  66
  67 /*!\brief Don't reference the alternate reference frame
  68  *
  69  * When this flag is set, the encoder will not use the alt ref frame as a
  70  * predictor. When not set, the encoder will choose whether to use the
  71  * alt ref frame or not automatically.
  72  */
  73 #define VP8_EFLAG_NO_REF_ARF       (1<<21)
  74
  75
  76 /*!\brief Don't update the last frame
  77  *
  78  * When this flag is set, the encoder will not update the last frame with
  79  * the contents of the current frame.
  80  */
  81 #define VP8_EFLAG_NO_UPD_LAST      (1<<18)
  82
  83
  84 /*!\brief Don't update the golden frame
  85  *
  86  * When this flag is set, the encoder will not update the golden frame with
  87  * the contents of the current frame.
  88  */
  89 #define VP8_EFLAG_NO_UPD_GF        (1<<22)
  90
  91
  92 /*!\brief Don't update the alternate reference frame
  93  *
  94  * When this flag is set, the encoder will not update the alt ref frame with
  95  * the contents of the current frame.
  96  */
  97 #define VP8_EFLAG_NO_UPD_ARF       (1<<23)
  98
  99
 100 /*!\brief Force golden frame update
 101  *
 102  * When this flag is set, the encoder copy the contents of the current frame
 103  * to the golden frame buffer.
 104  */
 105 #define VP8_EFLAG_FORCE_GF         (1<<19)
 106
 107
 108 /*!\brief Force alternate reference frame update
 109  *
 110  * When this flag is set, the encoder copy the contents of the current frame
 111  * to the alternate reference frame buffer.
 112  */
 113 #define VP8_EFLAG_FORCE_ARF        (1<<24)
 114
 115
 116 /*!\brief Disable entropy update
 117  *
 118  * When this flag is set, the encoder will not update its internal entropy
 119  * model based on the entropy of this frame.
 120  */
 121 #define VP8_EFLAG_NO_UPD_ENTROPY   (1<<20)
 122
 123
 124 /*!\brief VP8 encoder control functions
 125  *
 126  * This set of macros define the control functions available for the VP8
 127  * encoder interface.
 128  *
 129  * \sa #vpx_codec_control
 130  */
 131 enum vp8e_enc_control_id {
 132   VP8E_UPD_ENTROPY           = 5,  /**< control function to set mode of entropy update in encoder */
 133   VP8E_UPD_REFERENCE,              /**< control function to set reference update mode in encoder */
 134   VP8E_USE_REFERENCE,              /**< control function to set which reference frame encoder can use */
 135   VP8E_SET_ROI_MAP,                /**< control function to pass an ROI map to encoder */
 136   VP8E_SET_ACTIVEMAP,              /**< control function to pass an Active map to encoder */
 137   VP8E_SET_SCALEMODE         = 11, /**< control function to set encoder scaling mode */
 138   /*!\brief control function to set vp8 encoder cpuused
 139    *
 140    * Changes in this value influences, among others, the encoder's selection
 141    * of motion estimation methods. Values greater than 0 will increase encoder
 142    * speed at the expense of quality.
 143    * The full set of adjustments can be found in
 144    * onyx_if.c:vp8_set_speed_features().
 145    * \todo List highlights of the changes at various levels.
 146    *
 147    * \note Valid range: -16..16
 148    */
 149   VP8E_SET_CPUUSED           = 13,
 150   VP8E_SET_ENABLEAUTOALTREF,       /**< control function to enable vp8 to automatic set and use altref frame */
 151   /*!\brief control function to set noise sensitivity
 152    *
 153    * 0: off, 1: OnYOnly, 2: OnYUV,
 154    * 3: OnYUVAggressive, 4: Adaptive
 155    */
 156   VP8E_SET_NOISE_SENSITIVITY,
 157   VP8E_SET_SHARPNESS,              /**< control function to set sharpness */
 158   VP8E_SET_STATIC_THRESHOLD,       /**< control function to set the threshold for macroblocks treated static */
 159   VP8E_SET_TOKEN_PARTITIONS,       /**< control function to set the number of token partitions  */
 160   VP8E_GET_LAST_QUANTIZER,         /**< return the quantizer chosen by the
 161                                           encoder for the last frame using the internal
 162                                           scale */
 163   VP8E_GET_LAST_QUANTIZER_64,      /**< return the quantizer chosen by the
 164                                           encoder for the last frame, using the 0..63
 165                                           scale as used by the rc_*_quantizer config
 166                                           parameters */
 167   VP8E_SET_ARNR_MAXFRAMES,         /**< control function to set the max number of frames blurred creating arf*/
 168   VP8E_SET_ARNR_STRENGTH,          //!< control function to set the filter
 169                                    //!< strength for the arf
 170
 171   /*!\deprecated control function to set the filter type to use for the arf */
 172   VP8E_SET_ARNR_TYPE,
 173
 174   VP8E_SET_TUNING,                 /**< control function to set visual tuning */
 175   /*!\brief control function to set constrained quality level
 176    *
 177    * \attention For this value to be used vpx_codec_enc_cfg_t::g_usage must be
 178    *            set to #VPX_CQ.
 179    * \note Valid range: 0..63
 180    */
 181   VP8E_SET_CQ_LEVEL,
 182
 183   /*!\brief Max data rate for Intra frames
 184    *
 185    * This value controls additional clamping on the maximum size of a
 186    * keyframe. It is expressed as a percentage of the average
 187    * per-frame bitrate, with the special (and default) value 0 meaning
 188    * unlimited, or no additional clamping beyond the codec's built-in
 189    * algorithm.
 190    *
 191    * For example, to allocate no more than 4.5 frames worth of bitrate
 192    * to a keyframe, set this to 450.
 193    *
 194    */
 195   VP8E_SET_MAX_INTRA_BITRATE_PCT,
 196   VP8E_SET_FRAME_FLAGS,           /**< control function to set reference and update frame flags */
 197
 198   /*!\brief Max data rate for Inter frames
 199    *
 200    * This value controls additional clamping on the maximum size of an
 201    * inter frame. It is expressed as a percentage of the average
 202    * per-frame bitrate, with the special (and default) value 0 meaning
 203    * unlimited, or no additional clamping beyond the codec's built-in
 204    * algorithm.
 205    *
 206    * For example, to allow no more than 4.5 frames worth of bitrate
 207    * to an inter frame, set this to 450.
 208    *
 209    */
 210   VP8E_SET_MAX_INTER_BITRATE_PCT,
 211
 212   /*!\brief Boost percentage for Golden Frame in CBR mode
 213    *
 214    * This value controls the amount of boost given to Golden Frame in
 215    * CBR mode. It is expressed as a percentage of the average
 216    * per-frame bitrate, with the special (and default) value 0 meaning
 217    * the feature is off, i.e., no golden frame boost in CBR mode and
 218    * average bitrate target is used.
 219    *
 220    * For example, to allow 100% more bits, i.e, 2X, in a golden frame
 221    * than average frame, set this to 100.
 222    *
 223    */
 224   VP8E_SET_GF_CBR_BOOST_PCT,
 225
 226   /*!\brief Codec control function to set the temporal layer id
 227    *
 228    * For temporal scalability: this control allows the application to set the
 229    * layer id for each frame to be encoded. Note that this control must be set
 230    * for every frame prior to encoding. The usage of this control function
 231    * supersedes the internal temporal pattern counter, which is now deprecated.
 232    */
 233   VP8E_SET_TEMPORAL_LAYER_ID,
 234
 235   VP8E_SET_SCREEN_CONTENT_MODE,  /**<control function to set encoder screen content mode */
 236
 237   /*!\brief Codec control function to set lossless encoding mode
 238    *
 239    * VP9 can operate in lossless encoding mode, in which the bitstream
 240    * produced will be able to decode and reconstruct a perfect copy of
 241    * input source. This control function provides a mean to switch encoder
 242    * into lossless coding mode(1) or normal coding mode(0) that may be lossy.
 243    *                          0 = lossy coding mode
 244    *                          1 = lossless coding mode
 245    *
 246    *  By default, encoder operates in normal coding mode (maybe lossy).
 247    */
 248   VP9E_SET_LOSSLESS,
 249
 250   /*!\brief Codec control function to set number of tile columns
 251    *
 252    * In encoding and decoding, VP9 allows an input image frame be partitioned
 253    * into separated vertical tile columns, which can be encoded or decoded
 254    * independently. This enables easy implementation of parallel encoding and
 255    * decoding. This control requests the encoder to use column tiles in
 256    * encoding an input frame, with number of tile columns (in Log2 unit) as
 257    * the parameter:
 258    *             0 = 1 tile column
 259    *             1 = 2 tile columns
 260    *             2 = 4 tile columns
 261    *             .....
 262    *             n = 2**n tile columns
 263    * The requested tile columns will be capped by encoder based on image size
 264    * limitation (The minimum width of a tile column is 256 pixel, the maximum
 265    * is 4096).
 266    *
 267    * By default, the value is 0, i.e. one single column tile for entire image.
 268    */
 269   VP9E_SET_TILE_COLUMNS,
 270
 271   /*!\brief Codec control function to set number of tile rows
 272    *
 273    * In encoding and decoding, VP9 allows an input image frame be partitioned
 274    * into separated horizontal tile rows. Tile rows are encoded or decoded
 275    * sequentially. Even though encoding/decoding of later tile rows depends on
 276    * earlier ones, this allows the encoder to output data packets for tile rows
 277    * prior to completely processing all tile rows in a frame, thereby reducing
 278    * the latency in processing between input and output. The parameter
 279    * for this control describes the number of tile rows, which has a valid
 280    * range [0, 2]:
 281    *            0 = 1 tile row
 282    *            1 = 2 tile rows
 283    *            2 = 4 tile rows
 284    *
 285    * By default, the value is 0, i.e. one single row tile for entire image.
 286    */
 287   VP9E_SET_TILE_ROWS,
 288
 289   /*!\brief Codec control function to enable frame parallel decoding feature
 290    *
 291    * VP9 has a bitstream feature to reduce decoding dependency between frames
 292    * by turning off backward update of probability context used in encoding
 293    * and decoding. This allows staged parallel processing of more than one
 294    * video frames in the decoder. This control function provides a mean to
 295    * turn this feature on or off for bitstreams produced by encoder.
 296    *
 297    * By default, this feature is off.
 298    */
 299   VP9E_SET_FRAME_PARALLEL_DECODING,
 300
 301   /*!\brief Codec control function to set adaptive quantization mode
 302    *
 303    * VP9 has a segment based feature that allows encoder to adaptively change
 304    * quantization parameter for each segment within a frame to improve the
 305    * subjective quality. This control makes encoder operate in one of the
 306    * several AQ_modes supported.
 307    *
 308    * By default, encoder operates with AQ_Mode 0(adaptive quantization off).
 309    */
 310   VP9E_SET_AQ_MODE,
 311
 312   /*!\brief Codec control function to enable/disable periodic Q boost
 313    *
 314    * One VP9 encoder speed feature is to enable quality boost by lowering
 315    * frame level Q periodically. This control function provides a mean to
 316    * turn on/off this feature.
 317    *               0 = off
 318    *               1 = on
 319    *
 320    * By default, the encoder is allowed to use this feature for appropriate
 321    * encoding modes.
 322    */
 323   VP9E_SET_FRAME_PERIODIC_BOOST,
 324
 325   /*!\brief control function to set noise sensitivity
 326    *
 327    *  0: off, 1: OnYOnly
 328    */
 329   VP9E_SET_NOISE_SENSITIVITY,
 330
 331   VP9E_SET_SVC,
 332   VP9E_SET_SVC_PARAMETERS,
 333
 334   /*!\brief control function to set svc layer for spatial and temporal.
 335    * \note Valid ranges: 0..#vpx_codec_enc_cfg::ss_number_layers for spatial
 336    *                     layer and 0..#vpx_codec_enc_cfg::ts_number_layers for
 337    *                     temporal layer.
 338    */
 339   VP9E_SET_SVC_LAYER_ID,
 340
 341   /*!\brief control function to set content type.
 342    * \note Valid parameter range:
 343    *              VP9E_CONTENT_DEFAULT = Regular video content (Default)
 344    *              VP9E_CONTENT_SCREEN  = Screen capture content
 345    */
 346   VP9E_SET_TUNE_CONTENT,
 347
 348   /*!\brief control function to get svc layer ID.
 349    * \note The layer ID returned is for the data packet from the registered
 350    *       callback function.
 351    */
 352   VP9E_GET_SVC_LAYER_ID,
 353
 354   /*!\brief control function to register callback for getting per layer packet.
 355    * \note Parameter for this control function is a structure with a callback
 356    *       function and a pointer to private data used by the callback.
 357    */
 358   VP9E_REGISTER_CX_CALLBACK,
 359
 360   /*!\brief control function to set color space info.
 361    * \note Valid ranges: 0..7, default is "UNKNOWN".
 362    *                     0 = UNKNOWN,
 363    *                     1 = BT_601
 364    *                     2 = BT_709
 365    *                     3 = SMPTE_170
 366    *                     4 = SMPTE_240
 367    *                     5 = BT_2020
 368    *                     6 = RESERVED
 369    *                     7 = SRGB
 370    */
 371   VP9E_SET_COLOR_SPACE,
 372 };
 373
 374 /*!\brief vpx 1-D scaling mode
 375  *
 376  * This set of constants define 1-D vpx scaling modes
 377  */
 378 typedef enum vpx_scaling_mode_1d {
 379   VP8E_NORMAL      = 0,
 380   VP8E_FOURFIVE    = 1,
 381   VP8E_THREEFIVE   = 2,
 382   VP8E_ONETWO      = 3
 383 } VPX_SCALING_MODE;
 384
 385
 386 /*!\brief  vpx region of interest map
 387  *
 388  * These defines the data structures for the region of interest map
 389  *
 390  */
 391
 392 typedef struct vpx_roi_map {
 393   /*! An id between 0 and 3 for each 16x16 region within a frame. */
 394   unsigned char *roi_map;
 395   unsigned int rows;       /**< Number of rows. */
 396   unsigned int cols;       /**< Number of columns. */
 397   // TODO(paulwilkins): broken for VP9 which has 8 segments
 398   // q and loop filter deltas for each segment
 399   // (see MAX_MB_SEGMENTS)
 400   int delta_q[4];          /**< Quantizer deltas. */
 401   int delta_lf[4];         /**< Loop filter deltas. */
 402   /*! Static breakout threshold for each segment. */
 403   unsigned int static_threshold[4];
 404 } vpx_roi_map_t;
 405
 406 /*!\brief  vpx active region map
 407  *
 408  * These defines the data structures for active region map
 409  *
 410  */
 411
 412
 413 typedef struct vpx_active_map {
 414   unsigned char  *active_map; /**< specify an on (1) or off (0) each 16x16 region within a frame */
 415   unsigned int    rows;       /**< number of rows */
 416   unsigned int    cols;       /**< number of cols */
 417 } vpx_active_map_t;
 418
 419 /*!\brief  vpx image scaling mode
 420  *
 421  * This defines the data structure for image scaling mode
 422  *
 423  */
 424 typedef struct vpx_scaling_mode {
 425   VPX_SCALING_MODE    h_scaling_mode;  /**< horizontal scaling mode */
 426   VPX_SCALING_MODE    v_scaling_mode;  /**< vertical scaling mode   */
 427 } vpx_scaling_mode_t;
 428
 429 /*!\brief VP8 token partition mode
 430  *
 431  * This defines VP8 partitioning mode for compressed data, i.e., the number of
 432  * sub-streams in the bitstream. Used for parallelized decoding.
 433  *
 434  */
 435
 436 typedef enum {
 437   VP8_ONE_TOKENPARTITION   = 0,
 438   VP8_TWO_TOKENPARTITION   = 1,
 439   VP8_FOUR_TOKENPARTITION  = 2,
 440   VP8_EIGHT_TOKENPARTITION = 3
 441 } vp8e_token_partitions;
 442
 443 /*!brief VP9 encoder content type */
 444 typedef enum {
 445   VP9E_CONTENT_DEFAULT,
 446   VP9E_CONTENT_SCREEN,
 447   VP9E_CONTENT_INVALID
 448 } vp9e_tune_content;
 449
 450 /*!\brief VP8 model tuning parameters
 451  *
 452  * Changes the encoder to tune for certain types of input material.
 453  *
 454  */
 455 typedef enum {
 456   VP8_TUNE_PSNR,
 457   VP8_TUNE_SSIM
 458 } vp8e_tuning;
 459
 460 /*!\brief  vp9 svc layer parameters
 461  *
 462  * This defines the spatial and temporal layer id numbers for svc encoding.
 463  * This is used with the #VP9E_SET_SVC_LAYER_ID control to set the spatial and
 464  * temporal layer id for the current frame.
 465  *
 466  */
 467 typedef struct vpx_svc_layer_id {
 468   int spatial_layer_id;       /**< Spatial layer id number. */
 469   int temporal_layer_id;      /**< Temporal layer id number. */
 470 } vpx_svc_layer_id_t;
 471
 472 /*!\brief VP8 encoder control function parameter type
 473  *
 474  * Defines the data types that VP8E control functions take. Note that
 475  * additional common controls are defined in vp8.h
 476  *
 477  */
 478
 479
 480 /* These controls have been deprecated in favor of the flags parameter to
 481  * vpx_codec_encode(). See the definition of VP8_EFLAG_* above.
 482  */
 483 VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_UPD_ENTROPY,            int)
 484 VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_UPD_REFERENCE,          int)
 485 VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_USE_REFERENCE,          int)
 486
 487 VPX_CTRL_USE_TYPE(VP8E_SET_FRAME_FLAGS,        int)
 488 VPX_CTRL_USE_TYPE(VP8E_SET_TEMPORAL_LAYER_ID,  int)
 489 VPX_CTRL_USE_TYPE(VP8E_SET_ROI_MAP,            vpx_roi_map_t *)
 490 VPX_CTRL_USE_TYPE(VP8E_SET_ACTIVEMAP,          vpx_active_map_t *)
 491 VPX_CTRL_USE_TYPE(VP8E_SET_SCALEMODE,          vpx_scaling_mode_t *)
 492
 493 VPX_CTRL_USE_TYPE(VP9E_SET_SVC,                int)
 494 VPX_CTRL_USE_TYPE(VP9E_SET_SVC_PARAMETERS,     void *)
 495 VPX_CTRL_USE_TYPE(VP9E_REGISTER_CX_CALLBACK,   void *)
 496 VPX_CTRL_USE_TYPE(VP9E_SET_SVC_LAYER_ID,       vpx_svc_layer_id_t *)
 497
 498 VPX_CTRL_USE_TYPE(VP8E_SET_CPUUSED,            int)
 499 VPX_CTRL_USE_TYPE(VP8E_SET_ENABLEAUTOALTREF,   unsigned int)
 500 VPX_CTRL_USE_TYPE(VP8E_SET_NOISE_SENSITIVITY,  unsigned int)
 501 VPX_CTRL_USE_TYPE(VP8E_SET_SHARPNESS,          unsigned int)
 502 VPX_CTRL_USE_TYPE(VP8E_SET_STATIC_THRESHOLD,   unsigned int)
 503 VPX_CTRL_USE_TYPE(VP8E_SET_TOKEN_PARTITIONS,   int) /* vp8e_token_partitions */
 504
 505 VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_MAXFRAMES,     unsigned int)
 506 VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_STRENGTH,     unsigned int)
 507 VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_SET_ARNR_TYPE,     unsigned int)
 508 VPX_CTRL_USE_TYPE(VP8E_SET_TUNING,             int) /* vp8e_tuning */
 509 VPX_CTRL_USE_TYPE(VP8E_SET_CQ_LEVEL,      unsigned int)
 510
 511 VPX_CTRL_USE_TYPE(VP9E_SET_TILE_COLUMNS,  int)
 512 VPX_CTRL_USE_TYPE(VP9E_SET_TILE_ROWS,  int)
 513
 514 VPX_CTRL_USE_TYPE(VP8E_GET_LAST_QUANTIZER,     int *)
 515 VPX_CTRL_USE_TYPE(VP8E_GET_LAST_QUANTIZER_64,  int *)
 516 VPX_CTRL_USE_TYPE(VP9E_GET_SVC_LAYER_ID,  vpx_svc_layer_id_t *)
 517
 518 VPX_CTRL_USE_TYPE(VP8E_SET_MAX_INTRA_BITRATE_PCT, unsigned int)
 519 VPX_CTRL_USE_TYPE(VP8E_SET_MAX_INTER_BITRATE_PCT, unsigned int)
 520
 521 VPX_CTRL_USE_TYPE(VP8E_SET_GF_CBR_BOOST_PCT, unsigned int)
 522
 523 VPX_CTRL_USE_TYPE(VP8E_SET_SCREEN_CONTENT_MODE, unsigned int)
 524
 525 VPX_CTRL_USE_TYPE(VP9E_SET_LOSSLESS, unsigned int)
 526
 527 VPX_CTRL_USE_TYPE(VP9E_SET_FRAME_PARALLEL_DECODING, unsigned int)
 528
 529 VPX_CTRL_USE_TYPE(VP9E_SET_AQ_MODE, unsigned int)
 530
 531 VPX_CTRL_USE_TYPE(VP9E_SET_FRAME_PERIODIC_BOOST, unsigned int)
 532
 533 VPX_CTRL_USE_TYPE(VP9E_SET_NOISE_SENSITIVITY,  unsigned int)
 534
 535 VPX_CTRL_USE_TYPE(VP9E_SET_TUNE_CONTENT, int) /* vp9e_tune_content */
 536
 537 VPX_CTRL_USE_TYPE(VP9E_SET_COLOR_SPACE, int)
 538 /*! @} - end defgroup vp8_encoder */
 539 #ifdef __cplusplus
 540 }  // extern "C"
 541 #endif
 542
 543 #endif  // VPX_VP8CX_H_