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