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
  11
  12 /*!\defgroup vp8_encoder WebM VP8 Encoder
  13  * \ingroup vp8
  14  *
  15  * @{
  16  */
  17 #include "vp8.h"
  18
  19 /*!\file
  20  * \brief Provides definitions for using the VP8 encoder algorithm within the
  21  *        vpx Codec Interface.
  22  */
  23 #ifndef VP8CX_H
  24 #define VP8CX_H
  25 #include "vpx_codec_impl_top.h"
  26
  27 /*!\name Algorithm interface for VP8
  28  *
  29  * This interface provides the capability to encode raw VP8 streams, as would
  30  * be found in AVI files.
  31  * @{
  32  */
  33 extern vpx_codec_iface_t  vpx_codec_vp8_cx_algo;
  34 extern vpx_codec_iface_t* vpx_codec_vp8_cx(void);
  35 /*!@} - end algorithm interface member group*/
  36
  37
  38 /*
  39  * Algorithm Flags
  40  */
  41
  42 /*!\brief Don't reference the last frame
  43  *
  44  * When this flag is set, the encoder will not use the last frame as a
  45  * predictor. When not set, the encoder will choose whether to use the
  46  * last frame or not automatically.
  47  */
  48 #define VP8_EFLAG_NO_REF_LAST      (1<<16)
  49
  50
  51 /*!\brief Don't reference the golden frame
  52  *
  53  * When this flag is set, the encoder will not use the golden frame as a
  54  * predictor. When not set, the encoder will choose whether to use the
  55  * golden frame or not automatically.
  56  */
  57 #define VP8_EFLAG_NO_REF_GF        (1<<17)
  58
  59
  60 /*!\brief Don't reference the alternate reference frame
  61  *
  62  * When this flag is set, the encoder will not use the alt ref frame as a
  63  * predictor. When not set, the encoder will choose whether to use the
  64  * alt ref frame or not automatically.
  65  */
  66 #define VP8_EFLAG_NO_REF_ARF       (1<<21)
  67
  68
  69 /*!\brief Don't update the last frame
  70  *
  71  * When this flag is set, the encoder will not update the last frame with
  72  * the contents of the current frame.
  73  */
  74 #define VP8_EFLAG_NO_UPD_LAST      (1<<18)
  75
  76
  77 /*!\brief Don't update the golden frame
  78  *
  79  * When this flag is set, the encoder will not update the golden frame with
  80  * the contents of the current frame.
  81  */
  82 #define VP8_EFLAG_NO_UPD_GF        (1<<22)
  83
  84
  85 /*!\brief Don't update the alternate reference frame
  86  *
  87  * When this flag is set, the encoder will not update the alt ref frame with
  88  * the contents of the current frame.
  89  */
  90 #define VP8_EFLAG_NO_UPD_ARF       (1<<23)
  91
  92
  93 /*!\brief Force golden frame update
  94  *
  95  * When this flag is set, the encoder copy the contents of the current frame
  96  * to the golden frame buffer.
  97  */
  98 #define VP8_EFLAG_FORCE_GF         (1<<19)
  99
 100
 101 /*!\brief Force alternate reference frame update
 102  *
 103  * When this flag is set, the encoder copy the contents of the current frame
 104  * to the alternate reference frame buffer.
 105  */
 106 #define VP8_EFLAG_FORCE_ARF        (1<<24)
 107
 108
 109 /*!\brief Disable entropy update
 110  *
 111  * When this flag is set, the encoder will not update its internal entropy
 112  * model based on the entropy of this frame.
 113  */
 114 #define VP8_EFLAG_NO_UPD_ENTROPY   (1<<20)
 115
 116
 117 /*!\brief VP8 encoder control functions
 118  *
 119  * This set of macros define the control functions available for the VP8
 120  * encoder interface.
 121  *
 122  * \sa #vpx_codec_control
 123  */
 124 enum vp8e_enc_control_id
 125 {
 126     VP8E_UPD_ENTROPY           = 5,  /**< control function to set mode of entropy update in encoder */
 127     VP8E_UPD_REFERENCE,              /**< control function to set reference update mode in encoder */
 128     VP8E_USE_REFERENCE,              /**< control function to set which reference frame encoder can use */
 129     VP8E_SET_ROI_MAP,                /**< control function to pass an ROI map to encoder */
 130     VP8E_SET_ACTIVEMAP,              /**< control function to pass an Active map to encoder */
 131     VP8E_SET_SCALEMODE         = 11, /**< control function to set encoder scaling mode */
 132     /*!\brief control function to set vp8 encoder cpuused
 133      *
 134      * Changes in this value influences, among others, the encoder's selection
 135      * of motion estimation methods. Values greater than 0 will increase encoder
 136      * speed at the expense of quality.
 137      * The full set of adjustments can be found in
 138      * onyx_if.c:vp8_set_speed_features().
 139      * \todo List highlights of the changes at various levels.
 140      *
 141      * \note Valid range: -16..16
 142      */
 143     VP8E_SET_CPUUSED           = 13,
 144     VP8E_SET_ENABLEAUTOALTREF,       /**< control function to enable vp8 to automatic set and use altref frame */
 145     VP8E_SET_NOISE_SENSITIVITY,      /**< control function to set noise sensitivity */
 146     VP8E_SET_SHARPNESS,              /**< control function to set sharpness */
 147     VP8E_SET_STATIC_THRESHOLD,       /**< control function to set the threshold for macroblocks treated static */
 148     VP8E_SET_TOKEN_PARTITIONS,       /**< control function to set the number of token partitions  */
 149     VP8E_GET_LAST_QUANTIZER,         /**< return the quantizer chosen by the
 150                                           encoder for the last frame using the internal
 151                                           scale */
 152     VP8E_GET_LAST_QUANTIZER_64,      /**< return the quantizer chosen by the
 153                                           encoder for the last frame, using the 0..63
 154                                           scale as used by the rc_*_quantizer config
 155                                           parameters */
 156     VP8E_SET_ARNR_MAXFRAMES,         /**< control function to set the max number of frames blurred creating arf*/
 157     VP8E_SET_ARNR_STRENGTH ,         /**< control function to set the filter strength for the arf */
 158     VP8E_SET_ARNR_TYPE     ,         /**< control function to set the type of filter to use for the arf*/
 159     VP8E_SET_TUNING,                 /**< control function to set visual tuning */
 160     /*!\brief control function to set constrained quality level
 161      *
 162      * \attention For this value to be used vpx_codec_enc_cfg_t::g_usage must be
 163      *            set to #VPX_CQ.
 164      * \note Valid range: 0..63
 165      */
 166     VP8E_SET_CQ_LEVEL,
 167
 168     /*!\brief Max data rate for Intra frames
 169      *
 170      * This value controls additional clamping on the maximum size of a
 171      * keyframe. It is expressed as a percentage of the average
 172      * per-frame bitrate, with the special (and default) value 0 meaning
 173      * unlimited, or no additional clamping beyond the codec's built-in
 174      * algorithm.
 175      *
 176      * For example, to allocate no more than 4.5 frames worth of bitrate
 177      * to a keyframe, set this to 450.
 178      *
 179      */
 180     VP8E_SET_MAX_INTRA_BITRATE_PCT,
 181 };
 182
 183 /*!\brief vpx 1-D scaling mode
 184  *
 185  * This set of constants define 1-D vpx scaling modes
 186  */
 187 typedef enum vpx_scaling_mode_1d
 188 {
 189     VP8E_NORMAL      = 0,
 190     VP8E_FOURFIVE    = 1,
 191     VP8E_THREEFIVE   = 2,
 192     VP8E_ONETWO      = 3
 193 } VPX_SCALING_MODE;
 194
 195
 196 /*!\brief  vpx region of interest map
 197  *
 198  * These defines the data structures for the region of interest map
 199  *
 200  */
 201
 202 typedef struct vpx_roi_map
 203 {
 204     unsigned char *roi_map;      /**< specify an id between 0 and 3 for each 16x16 region within a frame */
 205     unsigned int   rows;         /**< number of rows */
 206     unsigned int   cols;         /**< number of cols */
 207     int     delta_q[4];          /**< quantizer delta [-64, 64] off baseline for regions with id between 0 and 3*/
 208     int     delta_lf[4];         /**< loop filter strength delta [-32, 32] for regions with id between 0 and 3 */
 209     unsigned int   static_threshold[4];/**< threshold for region to be treated as static */
 210 } vpx_roi_map_t;
 211
 212 /*!\brief  vpx active region map
 213  *
 214  * These defines the data structures for active region map
 215  *
 216  */
 217
 218
 219 typedef struct vpx_active_map
 220 {
 221     unsigned char  *active_map; /**< specify an on (1) or off (0) each 16x16 region within a frame */
 222     unsigned int    rows;       /**< number of rows */
 223     unsigned int    cols;       /**< number of cols */
 224 } vpx_active_map_t;
 225
 226 /*!\brief  vpx image scaling mode
 227  *
 228  * This defines the data structure for image scaling mode
 229  *
 230  */
 231 typedef struct vpx_scaling_mode
 232 {
 233     VPX_SCALING_MODE    h_scaling_mode;  /**< horizontal scaling mode */
 234     VPX_SCALING_MODE    v_scaling_mode;  /**< vertical scaling mode   */
 235 } vpx_scaling_mode_t;
 236
 237 /*!\brief VP8 encoding mode
 238  *
 239  * This defines VP8 encoding mode
 240  *
 241  */
 242 typedef enum
 243 {
 244     VP8_BEST_QUALITY_ENCODING,
 245     VP8_GOOD_QUALITY_ENCODING,
 246     VP8_REAL_TIME_ENCODING
 247 } vp8e_encoding_mode;
 248
 249 /*!\brief VP8 token partition mode
 250  *
 251  * This defines VP8 partitioning mode for compressed data, i.e., the number of
 252  * sub-streams in the bitstream. Used for parallelized decoding.
 253  *
 254  */
 255
 256 typedef enum
 257 {
 258     VP8_ONE_TOKENPARTITION   = 0,
 259     VP8_TWO_TOKENPARTITION   = 1,
 260     VP8_FOUR_TOKENPARTITION  = 2,
 261     VP8_EIGHT_TOKENPARTITION = 3,
 262 } vp8e_token_partitions;
 263
 264
 265 /*!\brief VP8 model tuning parameters
 266  *
 267  * Changes the encoder to tune for certain types of input material.
 268  *
 269  */
 270 typedef enum
 271 {
 272     VP8_TUNE_PSNR,
 273     VP8_TUNE_SSIM
 274 } vp8e_tuning;
 275
 276
 277 /*!\brief VP8 encoder control function parameter type
 278  *
 279  * Defines the data types that VP8E control functions take. Note that
 280  * additional common controls are defined in vp8.h
 281  *
 282  */
 283
 284
 285 /* These controls have been deprecated in favor of the flags parameter to
 286  * vpx_codec_encode(). See the definition of VP8_EFLAG_* above.
 287  */
 288 VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_UPD_ENTROPY,            int)
 289 VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_UPD_REFERENCE,          int)
 290 VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_USE_REFERENCE,          int)
 291
 292 VPX_CTRL_USE_TYPE(VP8E_SET_ROI_MAP,            vpx_roi_map_t *)
 293 VPX_CTRL_USE_TYPE(VP8E_SET_ACTIVEMAP,          vpx_active_map_t *)
 294 VPX_CTRL_USE_TYPE(VP8E_SET_SCALEMODE,          vpx_scaling_mode_t *)
 295
 296 VPX_CTRL_USE_TYPE(VP8E_SET_CPUUSED,            int)
 297 VPX_CTRL_USE_TYPE(VP8E_SET_ENABLEAUTOALTREF,   unsigned int)
 298 VPX_CTRL_USE_TYPE(VP8E_SET_NOISE_SENSITIVITY,  unsigned int)
 299 VPX_CTRL_USE_TYPE(VP8E_SET_SHARPNESS,          unsigned int)
 300 VPX_CTRL_USE_TYPE(VP8E_SET_STATIC_THRESHOLD,   unsigned int)
 301 VPX_CTRL_USE_TYPE(VP8E_SET_TOKEN_PARTITIONS,   vp8e_token_partitions)
 302
 303 VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_MAXFRAMES,     unsigned int)
 304 VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_STRENGTH ,     unsigned int)
 305 VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_TYPE     ,     unsigned int)
 306 VPX_CTRL_USE_TYPE(VP8E_SET_TUNING,             vp8e_tuning)
 307 VPX_CTRL_USE_TYPE(VP8E_SET_CQ_LEVEL     ,      unsigned int)
 308
 309 VPX_CTRL_USE_TYPE(VP8E_GET_LAST_QUANTIZER,     int *)
 310 VPX_CTRL_USE_TYPE(VP8E_GET_LAST_QUANTIZER_64,  int *)
 311
 312 VPX_CTRL_USE_TYPE(VP8E_SET_MAX_INTRA_BITRATE_PCT, unsigned int)
 313
 314
 315 /*! @} - end defgroup vp8_encoder */
 316 #include "vpx_codec_impl_bottom.h"
 317 #endif