vp8/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 and patent
   5  *  grant that can be found in the LICENSE file in the root of the source
   6  *  tree. All contributing project authors may be found in the AUTHORS
   7  *  file in the root of the source tree.
   8  */
   9
  10
  11 /*!\defgroup vp8_encoder WebM VP8 Encoder
  12  * \ingroup vp8
  13  *
  14  * @{
  15  */
  16 #include "vp8.h"
  17
  18 /*!\file vp8cx.h
  19  * \brief Provides definitions for using the VP8 encoder algorithm within the
  20  *        vpx Codec Interface.
  21  */
  22 #ifndef VP8CX_H
  23 #define VP8CX_H
  24 #include "vpx_codec_impl_top.h"
  25
  26 /*!\brief Algorithm interface for VP8
  27  *
  28  * This interface provides the capability to encode raw VP8 streams, as would
  29  * be found in AVI files.
  30  */
  31 extern vpx_codec_iface_t vpx_codec_vp8_cx_algo;
  32
  33
  34 /*
  35  * Algorithm Flags
  36  */
  37
  38 /*!\brief Don't reference the last frame
  39  *
  40  * When this flag is set, the encoder will not use the last frame as a
  41  * predictor. When not set, the encoder will choose whether to use the
  42  * last frame or not automatically.
  43  */
  44 #define VP8_EFLAG_NO_REF_LAST      (1<<16)
  45
  46
  47 /*!\brief Don't reference the golden frame
  48  *
  49  * When this flag is set, the encoder will not use the golden frame as a
  50  * predictor. When not set, the encoder will choose whether to use the
  51  * golden frame or not automatically.
  52  */
  53 #define VP8_EFLAG_NO_REF_GF        (1<<17)
  54
  55
  56 /*!\brief Don't reference the alternate reference frame
  57  *
  58  * When this flag is set, the encoder will not use the alt ref frame as a
  59  * predictor. When not set, the encoder will choose whether to use the
  60  * alt ref frame or not automatically.
  61  */
  62 #define VP8_EFLAG_NO_REF_ARF       (1<<21)
  63
  64
  65 /*!\brief Don't update the last frame
  66  *
  67  * When this flag is set, the encoder will not update the last frame with
  68  * the contents of the current frame.
  69  */
  70 #define VP8_EFLAG_NO_UPD_LAST      (1<<18)
  71
  72
  73 /*!\brief Don't update the golden frame
  74  *
  75  * When this flag is set, the encoder will not update the golden frame with
  76  * the contents of the current frame.
  77  */
  78 #define VP8_EFLAG_NO_UPD_GF        (1<<22)
  79
  80
  81 /*!\brief Don't update the alternate reference frame
  82  *
  83  * When this flag is set, the encoder will not update the alt ref frame with
  84  * the contents of the current frame.
  85  */
  86 #define VP8_EFLAG_NO_UPD_ARF       (1<<23)
  87
  88
  89 /*!\brief Force golden frame update
  90  *
  91  * When this flag is set, the encoder copy the contents of the current frame
  92  * to the golden frame buffer.
  93  */
  94 #define VP8_EFLAG_FORCE_GF         (1<<19)
  95
  96
  97 /*!\brief Force alternate reference frame update
  98  *
  99  * When this flag is set, the encoder copy the contents of the current frame
 100  * to the alternate reference frame buffer.
 101  */
 102 #define VP8_EFLAG_FORCE_ARF        (1<<24)
 103
 104
 105 /*!\brief Disable entropy update
 106  *
 107  * When this flag is set, the encoder will not update its internal entropy
 108  * model based on the entropy of this frame.
 109  */
 110 #define VP8_EFLAG_NO_UPD_ENTROPY   (1<<20)
 111
 112
 113 /*!\brief VP8 encoder control functions
 114  *
 115  * The set of macros define the control functions of VP8 encoder interface
 116  */
 117 enum vp8e_enc_control_id
 118 {
 119     VP8E_UPD_ENTROPY           = 5,  /**< control function to set mode of entropy update in encoder */
 120     VP8E_UPD_REFERENCE,              /**< control function to set reference update mode in encoder */
 121     VP8E_USE_REFERENCE,              /**< control function to set which reference frame encoder can use */
 122     VP8E_SET_ROI_MAP,                /**< control function to pass an ROI map to encoder */
 123     VP8E_SET_ACTIVEMAP,              /**< control function to pass an Active map to encoder */
 124     VP8E_SET_SCALEMODE         = 11, /**< control function to set encoder scaling mode */
 125     VP8E_SET_CPUUSED           = 13, /**< control function to set vp8 encoder cpuused  */
 126     VP8E_SET_ENABLEAUTOALTREF,       /**< control function to enable vp8 to automatic set and use altref frame */
 127     VP8E_SET_NOISE_SENSITIVITY,      /**< control function to set noise sensitivity */
 128     VP8E_SET_SHARPNESS,              /**< control function to set sharpness */
 129     VP8E_SET_STATIC_THRESHOLD,       /**< control function to set the threshold for macroblocks treated static */
 130     VP8E_SET_TOKEN_PARTITIONS,       /**< control function to set the number of token partitions  */
 131     VP8E_GET_LAST_QUANTIZER,         /**< return the quantizer chosen by the
 132                                           encoder for the last frame using the internal
 133                                           scale */
 134     VP8E_GET_LAST_QUANTIZER_64,      /**< return the quantizer chosen by the
 135                                           encoder for the last frame, using the 0..63
 136                                           scale as used by the rc_*_quantizer config
 137                                           parameters */
 138     VP8E_SET_ARNR_MAXFRAMES,         /**< control function to set the max number of frames blurred creating arf*/
 139     VP8E_SET_ARNR_STRENGTH ,         /**< control function to set the filter strength for the arf */
 140     VP8E_SET_ARNR_TYPE     ,         /**< control function to set the type of filter to use for the arf*/
 141 } ;
 142
 143 /*!\brief vpx 1-D scaling mode
 144  *
 145  * This set of constants define 1-D vpx scaling modes
 146  */
 147 typedef enum vpx_scaling_mode_1d
 148 {
 149     VP8E_NORMAL      = 0,
 150     VP8E_FOURFIVE    = 1,
 151     VP8E_THREEFIVE   = 2,
 152     VP8E_ONETWO      = 3
 153 } VPX_SCALING_MODE;
 154
 155
 156 /*!\brief  vpx region of interest map
 157  *
 158  * These defines the data structures for the region of interest map
 159  *
 160  */
 161
 162 typedef struct vpx_roi_map
 163 {
 164     unsigned char *roi_map;      /**< specify an id between 0 and 3 for each 16x16 region within a frame */
 165     unsigned int   rows;         /**< number of rows */
 166     unsigned int   cols;         /**< number of cols */
 167     int     delta_q[4];          /**< quantizer delta [-64, 64] off baseline for regions with id between 0 and 3*/
 168     int     delta_lf[4];         /**< loop filter strength delta [-32, 32] for regions with id between 0 and 3 */
 169     unsigned int   static_threshold[4];/**< threshold for region to be treated as static */
 170 } vpx_roi_map_t;
 171
 172 /*!\brief  vpx active region map
 173  *
 174  * These defines the data structures for active region map
 175  *
 176  */
 177
 178
 179 typedef struct vpx_active_map
 180 {
 181     unsigned char  *active_map; /**< specify an on (1) or off (0) each 16x16 region within a frame */
 182     unsigned int    rows;       /**< number of rows */
 183     unsigned int    cols;       /**< number of cols */
 184 } vpx_active_map_t;
 185
 186 /*!\brief  vpx image scaling mode
 187  *
 188  * This defines the data structure for image scaling mode
 189  *
 190  */
 191 typedef struct vpx_scaling_mode
 192 {
 193     VPX_SCALING_MODE    h_scaling_mode;  /**< horizontal scaling mode */
 194     VPX_SCALING_MODE    v_scaling_mode;  /**< vertical scaling mode   */
 195 } vpx_scaling_mode_t;
 196
 197 /*!\brief VP8 encoding mode
 198  *
 199  * This defines VP8 encoding mode
 200  *
 201  */
 202 typedef enum
 203 {
 204     VP8_BEST_QUALITY_ENCODING,
 205     VP8_GOOD_QUALITY_ENCODING,
 206     VP8_REAL_TIME_ENCODING
 207 } vp8e_encoding_mode;
 208
 209 /*!\brief VP8 token partition mode
 210  *
 211  * This defines VP8 partitioning mode for compressed data, i.e., the number of
 212  * sub-streams in the bitstream. Used for parallelized decoding.
 213  *
 214  */
 215
 216 typedef enum
 217 {
 218     VP8_ONE_TOKENPARTITION   = 0,
 219     VP8_TWO_TOKENPARTITION   = 1,
 220     VP8_FOUR_TOKENPARTITION  = 2,
 221     VP8_EIGHT_TOKENPARTITION = 3,
 222 } vp8e_token_partitions;
 223
 224
 225 /*!\brief VP8 encoder control function parameter type
 226  *
 227  * Defines the data types that VP8E control functions take. Note that
 228  * additional common controls are defined in vp8.h
 229  *
 230  */
 231
 232
 233 /* These controls have been deprecated in favor of the flags parameter to
 234  * vpx_codec_encode(). See the definition of VP8_EFLAG_* above.
 235  */
 236 VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_UPD_ENTROPY,            int)
 237 VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_UPD_REFERENCE,          int)
 238 VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_USE_REFERENCE,          int)
 239
 240 VPX_CTRL_USE_TYPE(VP8E_SET_ROI_MAP,            vpx_roi_map_t *)
 241 VPX_CTRL_USE_TYPE(VP8E_SET_ACTIVEMAP,          vpx_active_map_t *)
 242 VPX_CTRL_USE_TYPE(VP8E_SET_SCALEMODE,          vpx_scaling_mode_t *)
 243
 244 VPX_CTRL_USE_TYPE(VP8E_SET_CPUUSED,            int)
 245 VPX_CTRL_USE_TYPE(VP8E_SET_ENABLEAUTOALTREF,   unsigned int)
 246 VPX_CTRL_USE_TYPE(VP8E_SET_NOISE_SENSITIVITY,  unsigned int)
 247 VPX_CTRL_USE_TYPE(VP8E_SET_SHARPNESS,          unsigned int)
 248 VPX_CTRL_USE_TYPE(VP8E_SET_STATIC_THRESHOLD,   unsigned int)
 249 VPX_CTRL_USE_TYPE(VP8E_SET_TOKEN_PARTITIONS,   vp8e_token_partitions)
 250
 251 VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_MAXFRAMES,     unsigned int)
 252 VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_STRENGTH ,     unsigned int)
 253 VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_TYPE     ,     unsigned int)
 254
 255
 256 VPX_CTRL_USE_TYPE(VP8E_GET_LAST_QUANTIZER,     int *)
 257 VPX_CTRL_USE_TYPE(VP8E_GET_LAST_QUANTIZER_64,  int *)
 258
 259 /*! @} - end defgroup vp8_encoder */
 260 #include "vpx_codec_impl_bottom.h"
 261 #endif