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 26extern "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 */ 35extern vpx_codec_iface_t vpx_codec_vp8_cx_algo; 36extern vpx_codec_iface_t *vpx_codec_vp8_cx(void); 37 38/* TODO(jkoleszar): These move to VP9 in a later patch set. */ 39extern vpx_codec_iface_t vpx_codec_vp9_cx_algo; 40extern 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 */ 131enum 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 VP8E_SET_NOISE_SENSITIVITY, /**< control function to set noise sensitivity */ 152 VP8E_SET_SHARPNESS, /**< control function to set sharpness */ 153 VP8E_SET_STATIC_THRESHOLD, /**< control function to set the threshold for macroblocks treated static */ 154 VP8E_SET_TOKEN_PARTITIONS, /**< control function to set the number of token partitions */ 155 VP8E_GET_LAST_QUANTIZER, /**< return the quantizer chosen by the 156 encoder for the last frame using the internal 157 scale */ 158 VP8E_GET_LAST_QUANTIZER_64, /**< return the quantizer chosen by the 159 encoder for the last frame, using the 0..63 160 scale as used by the rc_*_quantizer config 161 parameters */ 162 VP8E_SET_ARNR_MAXFRAMES, /**< control function to set the max number of frames blurred creating arf*/ 163 VP8E_SET_ARNR_STRENGTH, /**< control function to set the filter strength for the arf */ 164 VP8E_SET_ARNR_TYPE, /**< control function to set the type of filter to use for the arf*/ 165 VP8E_SET_TUNING, /**< control function to set visual tuning */ 166 /*!\brief control function to set constrained quality level 167 * 168 * \attention For this value to be used vpx_codec_enc_cfg_t::g_usage must be 169 * set to #VPX_CQ. 170 * \note Valid range: 0..63 171 */ 172 VP8E_SET_CQ_LEVEL, 173 174 /*!\brief Max data rate for Intra frames 175 * 176 * This value controls additional clamping on the maximum size of a 177 * keyframe. It is expressed as a percentage of the average 178 * per-frame bitrate, with the special (and default) value 0 meaning 179 * unlimited, or no additional clamping beyond the codec's built-in 180 * algorithm. 181 * 182 * For example, to allocate no more than 4.5 frames worth of bitrate 183 * to a keyframe, set this to 450. 184 * 185 */ 186 VP8E_SET_MAX_INTRA_BITRATE_PCT, 187 188 189 /* TODO(jkoleszar): Move to vp9cx.h */ 190 VP9E_SET_LOSSLESS, 191 VP9E_SET_TILE_COLUMNS, 192 VP9E_SET_TILE_ROWS, 193 VP9E_SET_FRAME_PARALLEL_DECODING, 194 VP9E_SET_AQ_MODE, 195 VP9E_SET_FRAME_PERIODIC_BOOST, 196 197 VP9E_SET_SVC, 198 VP9E_SET_SVC_PARAMETERS, 199 /*!\brief control function to set svc layer for spatial and temporal. 200 * \note Valid ranges: 0..#vpx_codec_enc_cfg::ss_number_layers for spatial 201 * layer and 0..#vpx_codec_enc_cfg::ts_number_layers for 202 * temporal layer. 203 */ 204 VP9E_SET_SVC_LAYER_ID 205}; 206 207/*!\brief vpx 1-D scaling mode 208 * 209 * This set of constants define 1-D vpx scaling modes 210 */ 211typedef enum vpx_scaling_mode_1d { 212 VP8E_NORMAL = 0, 213 VP8E_FOURFIVE = 1, 214 VP8E_THREEFIVE = 2, 215 VP8E_ONETWO = 3 216} VPX_SCALING_MODE; 217 218 219/*!\brief vpx region of interest map 220 * 221 * These defines the data structures for the region of interest map 222 * 223 */ 224 225typedef struct vpx_roi_map { 226 /*! An id between 0 and 3 for each 16x16 region within a frame. */ 227 unsigned char *roi_map; 228 unsigned int rows; /**< Number of rows. */ 229 unsigned int cols; /**< Number of columns. */ 230 // TODO(paulwilkins): broken for VP9 which has 8 segments 231 // q and loop filter deltas for each segment 232 // (see MAX_MB_SEGMENTS) 233 int delta_q[4]; /**< Quantizer deltas. */ 234 int delta_lf[4]; /**< Loop filter deltas. */ 235 /*! Static breakout threshold for each segment. */ 236 unsigned int static_threshold[4]; 237} vpx_roi_map_t; 238 239/*!\brief vpx active region map 240 * 241 * These defines the data structures for active region map 242 * 243 */ 244 245 246typedef struct vpx_active_map { 247 unsigned char *active_map; /**< specify an on (1) or off (0) each 16x16 region within a frame */ 248 unsigned int rows; /**< number of rows */ 249 unsigned int cols; /**< number of cols */ 250} vpx_active_map_t; 251 252/*!\brief vpx image scaling mode 253 * 254 * This defines the data structure for image scaling mode 255 * 256 */ 257typedef struct vpx_scaling_mode { 258 VPX_SCALING_MODE h_scaling_mode; /**< horizontal scaling mode */ 259 VPX_SCALING_MODE v_scaling_mode; /**< vertical scaling mode */ 260} vpx_scaling_mode_t; 261 262/*!\brief VP8 token partition mode 263 * 264 * This defines VP8 partitioning mode for compressed data, i.e., the number of 265 * sub-streams in the bitstream. Used for parallelized decoding. 266 * 267 */ 268 269typedef enum { 270 VP8_ONE_TOKENPARTITION = 0, 271 VP8_TWO_TOKENPARTITION = 1, 272 VP8_FOUR_TOKENPARTITION = 2, 273 VP8_EIGHT_TOKENPARTITION = 3 274} vp8e_token_partitions; 275 276 277/*!\brief VP8 model tuning parameters 278 * 279 * Changes the encoder to tune for certain types of input material. 280 * 281 */ 282typedef enum { 283 VP8_TUNE_PSNR, 284 VP8_TUNE_SSIM 285} vp8e_tuning; 286 287/*!\brief vp9 svc parameters 288 * 289 * This defines parameters for svc encoding. 290 * 291 */ 292typedef struct vpx_svc_parameters { 293 unsigned int width; /**< width of current spatial layer */ 294 unsigned int height; /**< height of current spatial layer */ 295 int spatial_layer; /**< current spatial layer number - 0 = base */ 296 int temporal_layer; /**< current temporal layer number - 0 = base */ 297 int flags; /**< encode frame flags */ 298 int max_quantizer; /**< max quantizer for current layer */ 299 int min_quantizer; /**< min quantizer for current layer */ 300 int distance_from_i_frame; /**< frame number within current gop */ 301 int lst_fb_idx; /**< last frame frame buffer index */ 302 int gld_fb_idx; /**< golden frame frame buffer index */ 303 int alt_fb_idx; /**< alt reference frame frame buffer index */ 304} vpx_svc_parameters_t; 305 306/*!\brief vp9 svc layer parameters 307 * 308 * This defines the spatial and temporal layer id numbers for svc encoding. 309 * This is used with the #VP9E_SET_SVC_LAYER_ID control to set the spatial and 310 * temporal layer id for the current frame. 311 * 312 */ 313typedef struct vpx_svc_layer_id { 314 int spatial_layer_id; /**< Spatial layer id number. */ 315 int temporal_layer_id; /**< Temporal layer id number. */ 316} vpx_svc_layer_id_t; 317 318/*!\brief VP8 encoder control function parameter type 319 * 320 * Defines the data types that VP8E control functions take. Note that 321 * additional common controls are defined in vp8.h 322 * 323 */ 324 325 326/* These controls have been deprecated in favor of the flags parameter to 327 * vpx_codec_encode(). See the definition of VP8_EFLAG_* above. 328 */ 329VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_UPD_ENTROPY, int) 330VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_UPD_REFERENCE, int) 331VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_USE_REFERENCE, int) 332 333VPX_CTRL_USE_TYPE(VP8E_SET_ROI_MAP, vpx_roi_map_t *) 334VPX_CTRL_USE_TYPE(VP8E_SET_ACTIVEMAP, vpx_active_map_t *) 335VPX_CTRL_USE_TYPE(VP8E_SET_SCALEMODE, vpx_scaling_mode_t *) 336 337VPX_CTRL_USE_TYPE(VP9E_SET_SVC, int) 338VPX_CTRL_USE_TYPE(VP9E_SET_SVC_PARAMETERS, vpx_svc_parameters_t *) 339VPX_CTRL_USE_TYPE(VP9E_SET_SVC_LAYER_ID, vpx_svc_layer_id_t *) 340 341VPX_CTRL_USE_TYPE(VP8E_SET_CPUUSED, int) 342VPX_CTRL_USE_TYPE(VP8E_SET_ENABLEAUTOALTREF, unsigned int) 343VPX_CTRL_USE_TYPE(VP8E_SET_NOISE_SENSITIVITY, unsigned int) 344VPX_CTRL_USE_TYPE(VP8E_SET_SHARPNESS, unsigned int) 345VPX_CTRL_USE_TYPE(VP8E_SET_STATIC_THRESHOLD, unsigned int) 346VPX_CTRL_USE_TYPE(VP8E_SET_TOKEN_PARTITIONS, int) /* vp8e_token_partitions */ 347 348VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_MAXFRAMES, unsigned int) 349VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_STRENGTH, unsigned int) 350VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_TYPE, unsigned int) 351VPX_CTRL_USE_TYPE(VP8E_SET_TUNING, int) /* vp8e_tuning */ 352VPX_CTRL_USE_TYPE(VP8E_SET_CQ_LEVEL, unsigned int) 353 354VPX_CTRL_USE_TYPE(VP9E_SET_TILE_COLUMNS, int) 355VPX_CTRL_USE_TYPE(VP9E_SET_TILE_ROWS, int) 356 357VPX_CTRL_USE_TYPE(VP8E_GET_LAST_QUANTIZER, int *) 358VPX_CTRL_USE_TYPE(VP8E_GET_LAST_QUANTIZER_64, int *) 359 360VPX_CTRL_USE_TYPE(VP8E_SET_MAX_INTRA_BITRATE_PCT, unsigned int) 361 362VPX_CTRL_USE_TYPE(VP9E_SET_LOSSLESS, unsigned int) 363 364VPX_CTRL_USE_TYPE(VP9E_SET_FRAME_PARALLEL_DECODING, unsigned int) 365 366VPX_CTRL_USE_TYPE(VP9E_SET_AQ_MODE, unsigned int) 367 368VPX_CTRL_USE_TYPE(VP9E_SET_FRAME_PERIODIC_BOOST, unsigned int) 369 370/*! @} - end defgroup vp8_encoder */ 371#ifdef __cplusplus 372} // extern "C" 373#endif 374 375#endif // VPX_VP8CX_H_ 376