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