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