vpx/vp8cx.h

   1 /*
   2  *  Copyright (c) 2010 The VP8 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 vp8cx.h
  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/vpx_codec_impl_top.h"
  26
  27 /*!\brief 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 extern vpx_codec_iface_t vpx_codec_vp8_cx_algo;
  33
  34
  35 #if CONFIG_EXPERIMENTAL
  36 /*!\brief Algorithm interface for VP8 experimental branch
  37  *
  38  * This interface provides the ability to encode using the "experimental"
  39  * VP8 variant, which is bitstream incompatible with the default VP8 encoder.
  40  */
  41 extern vpx_codec_iface_t vpx_codec_vp8x_cx_algo;
  42 #endif
  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  * The set of macros define the control functions of VP8 encoder interface
 127  */
 128 enum vp8e_enc_control_id
 129 {
 130     VP8E_UPD_ENTROPY           = 5,  /**< control function to set mode of entropy update in encoder */
 131     VP8E_UPD_REFERENCE,              /**< control function to set reference update mode in encoder */
 132     VP8E_USE_REFERENCE,              /**< control function to set which reference frame encoder can use */
 133     VP8E_SET_ROI_MAP,                /**< control function to pass an ROI map to encoder */
 134     VP8E_SET_ACTIVEMAP,              /**< control function to pass an Active map to encoder */
 135     VP8E_SET_SCALEMODE         = 11, /**< control function to set encoder scaling mode */
 136     VP8E_SET_CPUUSED           = 13, /**< control function to set vp8 encoder cpuused  */
 137     VP8E_SET_ENABLEAUTOALTREF,       /**< control function to enable vp8 to automatic set and use altref frame */
 138     VP8E_SET_NOISE_SENSITIVITY,      /**< control function to set noise sensitivity */
 139     VP8E_SET_SHARPNESS,              /**< control function to set sharpness */
 140     VP8E_SET_STATIC_THRESHOLD,       /**< control function to set the threshold for macroblocks treated static */
 141     VP8E_SET_TOKEN_PARTITIONS,       /**< control function to set the number of token partitions  */
 142     VP8E_GET_LAST_QUANTIZER,         /**< return the quantizer chosen by the
 143                                           encoder for the last frame using the internal
 144                                           scale */
 145     VP8E_GET_LAST_QUANTIZER_64,      /**< return the quantizer chosen by the
 146                                           encoder for the last frame, using the 0..63
 147                                           scale as used by the rc_*_quantizer config
 148                                           parameters */
 149     VP8E_SET_ARNR_MAXFRAMES,         /**< control function to set the max number of frames blurred creating arf*/
 150     VP8E_SET_ARNR_STRENGTH ,         /**< control function to set the filter strength for the arf */
 151     VP8E_SET_ARNR_TYPE     ,         /**< control function to set the type of filter to use for the arf*/
 152 } ;
 153
 154 /*!\brief vpx 1-D scaling mode
 155  *
 156  * This set of constants define 1-D vpx scaling modes
 157  */
 158 typedef enum vpx_scaling_mode_1d
 159 {
 160     VP8E_NORMAL      = 0,
 161     VP8E_FOURFIVE    = 1,
 162     VP8E_THREEFIVE   = 2,
 163     VP8E_ONETWO      = 3
 164 } VPX_SCALING_MODE;
 165
 166
 167 /*!\brief  vpx region of interest map
 168  *
 169  * These defines the data structures for the region of interest map
 170  *
 171  */
 172
 173 typedef struct vpx_roi_map
 174 {
 175     unsigned char *roi_map;      /**< specify an id between 0 and 3 for each 16x16 region within a frame */
 176     unsigned int   rows;         /**< number of rows */
 177     unsigned int   cols;         /**< number of cols */
 178     int     delta_q[4];          /**< quantizer delta [-64, 64] off baseline for regions with id between 0 and 3*/
 179     int     delta_lf[4];         /**< loop filter strength delta [-32, 32] for regions with id between 0 and 3 */
 180     unsigned int   static_threshold[4];/**< threshold for region to be treated as static */
 181 } vpx_roi_map_t;
 182
 183 /*!\brief  vpx active region map
 184  *
 185  * These defines the data structures for active region map
 186  *
 187  */
 188
 189
 190 typedef struct vpx_active_map
 191 {
 192     unsigned char  *active_map; /**< specify an on (1) or off (0) each 16x16 region within a frame */
 193     unsigned int    rows;       /**< number of rows */
 194     unsigned int    cols;       /**< number of cols */
 195 } vpx_active_map_t;
 196
 197 /*!\brief  vpx image scaling mode
 198  *
 199  * This defines the data structure for image scaling mode
 200  *
 201  */
 202 typedef struct vpx_scaling_mode
 203 {
 204     VPX_SCALING_MODE    h_scaling_mode;  /**< horizontal scaling mode */
 205     VPX_SCALING_MODE    v_scaling_mode;  /**< vertical scaling mode   */
 206 } vpx_scaling_mode_t;
 207
 208 /*!\brief VP8 encoding mode
 209  *
 210  * This defines VP8 encoding mode
 211  *
 212  */
 213 typedef enum
 214 {
 215     VP8_BEST_QUALITY_ENCODING,
 216     VP8_GOOD_QUALITY_ENCODING,
 217     VP8_REAL_TIME_ENCODING
 218 } vp8e_encoding_mode;
 219
 220 /*!\brief VP8 token partition mode
 221  *
 222  * This defines VP8 partitioning mode for compressed data, i.e., the number of
 223  * sub-streams in the bitstream. Used for parallelized decoding.
 224  *
 225  */
 226
 227 typedef enum
 228 {
 229     VP8_ONE_TOKENPARTITION   = 0,
 230     VP8_TWO_TOKENPARTITION   = 1,
 231     VP8_FOUR_TOKENPARTITION  = 2,
 232     VP8_EIGHT_TOKENPARTITION = 3,
 233 } vp8e_token_partitions;
 234
 235
 236 /*!\brief VP8 encoder control function parameter type
 237  *
 238  * Defines the data types that VP8E control functions take. Note that
 239  * additional common controls are defined in vp8.h
 240  *
 241  */
 242
 243
 244 /* These controls have been deprecated in favor of the flags parameter to
 245  * vpx_codec_encode(). See the definition of VP8_EFLAG_* above.
 246  */
 247 VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_UPD_ENTROPY,            int)
 248 VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_UPD_REFERENCE,          int)
 249 VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_USE_REFERENCE,          int)
 250
 251 VPX_CTRL_USE_TYPE(VP8E_SET_ROI_MAP,            vpx_roi_map_t *)
 252 VPX_CTRL_USE_TYPE(VP8E_SET_ACTIVEMAP,          vpx_active_map_t *)
 253 VPX_CTRL_USE_TYPE(VP8E_SET_SCALEMODE,          vpx_scaling_mode_t *)
 254
 255 VPX_CTRL_USE_TYPE(VP8E_SET_CPUUSED,            int)
 256 VPX_CTRL_USE_TYPE(VP8E_SET_ENABLEAUTOALTREF,   unsigned int)
 257 VPX_CTRL_USE_TYPE(VP8E_SET_NOISE_SENSITIVITY,  unsigned int)
 258 VPX_CTRL_USE_TYPE(VP8E_SET_SHARPNESS,          unsigned int)
 259 VPX_CTRL_USE_TYPE(VP8E_SET_STATIC_THRESHOLD,   unsigned int)
 260 VPX_CTRL_USE_TYPE(VP8E_SET_TOKEN_PARTITIONS,   vp8e_token_partitions)
 261
 262 VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_MAXFRAMES,     unsigned int)
 263 VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_STRENGTH ,     unsigned int)
 264 VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_TYPE     ,     unsigned int)
 265
 266
 267 VPX_CTRL_USE_TYPE(VP8E_GET_LAST_QUANTIZER,     int *)
 268 VPX_CTRL_USE_TYPE(VP8E_GET_LAST_QUANTIZER_64,  int *)
 269
 270 /*! @} - end defgroup vp8_encoder */
 271 #include "vpx/vpx_codec_impl_bottom.h"
 272 #endif