vp8cx.h 12.2 KB
Newer Older
John Koleszar's avatar
John Koleszar committed
1
/*
2
 *  Copyright (c) 2010 The WebM project authors. All Rights Reserved.
John Koleszar's avatar
John Koleszar committed
3
 *
4
 *  Use of this source code is governed by a BSD-style license
5 6
 *  that can be found in the LICENSE file in the root of the source
 *  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.
John Koleszar's avatar
John Koleszar committed
9
 */
James Zern's avatar
James Zern committed
10 11
#ifndef VPX_VP8CX_H_
#define VPX_VP8CX_H_
John Koleszar's avatar
John Koleszar committed
12 13 14 15 16 17

/*!\defgroup vp8_encoder WebM VP8 Encoder
 * \ingroup vp8
 *
 * @{
 */
18
#include "./vp8.h"
John Koleszar's avatar
John Koleszar committed
19

James Zern's avatar
James Zern committed
20
/*!\file
John Koleszar's avatar
John Koleszar committed
21 22 23
 * \brief Provides definitions for using the VP8 encoder algorithm within the
 *        vpx Codec Interface.
 */
24 25 26 27

#ifdef __cplusplus
extern "C" {
#endif
John Koleszar's avatar
John Koleszar committed
28

29
/*!\name Algorithm interface for VP8
John Koleszar's avatar
John Koleszar committed
30 31 32
 *
 * This interface provides the capability to encode raw VP8 streams, as would
 * be found in AVI files.
33
 * @{
John Koleszar's avatar
John Koleszar committed
34
 */
35
extern vpx_codec_iface_t  vpx_codec_vp8_cx_algo;
John Koleszar's avatar
John Koleszar committed
36
extern vpx_codec_iface_t *vpx_codec_vp8_cx(void);
John Koleszar's avatar
John Koleszar committed
37

John Koleszar's avatar
John Koleszar committed
38
/* TODO(jkoleszar): These move to VP9 in a later patch set. */
39 40
extern vpx_codec_iface_t  vpx_codec_vp9_cx_algo;
extern vpx_codec_iface_t *vpx_codec_vp9_cx(void);
John Koleszar's avatar
John Koleszar committed
41 42

/*!@} - end algorithm interface member group*/
43 44


John Koleszar's avatar
John Koleszar committed
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
/*
 * Algorithm Flags
 */

/*!\brief Don't reference the last frame
 *
 * When this flag is set, the encoder will not use the last frame as a
 * predictor. When not set, the encoder will choose whether to use the
 * last frame or not automatically.
 */
#define VP8_EFLAG_NO_REF_LAST      (1<<16)


/*!\brief Don't reference the golden frame
 *
 * When this flag is set, the encoder will not use the golden frame as a
 * predictor. When not set, the encoder will choose whether to use the
 * golden frame or not automatically.
 */
#define VP8_EFLAG_NO_REF_GF        (1<<17)


/*!\brief Don't reference the alternate reference frame
 *
 * When this flag is set, the encoder will not use the alt ref frame as a
 * predictor. When not set, the encoder will choose whether to use the
 * alt ref frame or not automatically.
 */
#define VP8_EFLAG_NO_REF_ARF       (1<<21)


/*!\brief Don't update the last frame
 *
 * When this flag is set, the encoder will not update the last frame with
 * the contents of the current frame.
 */
#define VP8_EFLAG_NO_UPD_LAST      (1<<18)


/*!\brief Don't update the golden frame
 *
 * When this flag is set, the encoder will not update the golden frame with
 * the contents of the current frame.
 */
#define VP8_EFLAG_NO_UPD_GF        (1<<22)


/*!\brief Don't update the alternate reference frame
 *
 * When this flag is set, the encoder will not update the alt ref frame with
 * the contents of the current frame.
 */
#define VP8_EFLAG_NO_UPD_ARF       (1<<23)


/*!\brief Force golden frame update
 *
 * When this flag is set, the encoder copy the contents of the current frame
 * to the golden frame buffer.
 */
#define VP8_EFLAG_FORCE_GF         (1<<19)


/*!\brief Force alternate reference frame update
 *
 * When this flag is set, the encoder copy the contents of the current frame
 * to the alternate reference frame buffer.
 */
#define VP8_EFLAG_FORCE_ARF        (1<<24)


/*!\brief Disable entropy update
 *
 * When this flag is set, the encoder will not update its internal entropy
 * model based on the entropy of this frame.
 */
#define VP8_EFLAG_NO_UPD_ENTROPY   (1<<20)


/*!\brief VP8 encoder control functions
 *
126 127 128 129
 * This set of macros define the control functions available for the VP8
 * encoder interface.
 *
 * \sa #vpx_codec_control
John Koleszar's avatar
John Koleszar committed
130
 */
John Koleszar's avatar
John Koleszar committed
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
enum vp8e_enc_control_id {
  VP8E_UPD_ENTROPY           = 5,  /**< control function to set mode of entropy update in encoder */
  VP8E_UPD_REFERENCE,              /**< control function to set reference update mode in encoder */
  VP8E_USE_REFERENCE,              /**< control function to set which reference frame encoder can use */
  VP8E_SET_ROI_MAP,                /**< control function to pass an ROI map to encoder */
  VP8E_SET_ACTIVEMAP,              /**< control function to pass an Active map to encoder */
  VP8E_SET_SCALEMODE         = 11, /**< control function to set encoder scaling mode */
  /*!\brief control function to set vp8 encoder cpuused
   *
   * Changes in this value influences, among others, the encoder's selection
   * of motion estimation methods. Values greater than 0 will increase encoder
   * speed at the expense of quality.
   * The full set of adjustments can be found in
   * onyx_if.c:vp8_set_speed_features().
   * \todo List highlights of the changes at various levels.
   *
   * \note Valid range: -16..16
   */
  VP8E_SET_CPUUSED           = 13,
  VP8E_SET_ENABLEAUTOALTREF,       /**< control function to enable vp8 to automatic set and use altref frame */
151 152 153 154 155 156
  /*!\brief control function to set noise sensitivity
   *
   * 0: off, 1: OnYOnly, 2: OnYUV,
   * 3: OnYUVAggressive, 4: Adaptive
   */
  VP8E_SET_NOISE_SENSITIVITY,
John Koleszar's avatar
John Koleszar committed
157 158 159 160
  VP8E_SET_SHARPNESS,              /**< control function to set sharpness */
  VP8E_SET_STATIC_THRESHOLD,       /**< control function to set the threshold for macroblocks treated static */
  VP8E_SET_TOKEN_PARTITIONS,       /**< control function to set the number of token partitions  */
  VP8E_GET_LAST_QUANTIZER,         /**< return the quantizer chosen by the
John Koleszar's avatar
John Koleszar committed
161 162
                                          encoder for the last frame using the internal
                                          scale */
John Koleszar's avatar
John Koleszar committed
163
  VP8E_GET_LAST_QUANTIZER_64,      /**< return the quantizer chosen by the
John Koleszar's avatar
John Koleszar committed
164 165 166
                                          encoder for the last frame, using the 0..63
                                          scale as used by the rc_*_quantizer config
                                          parameters */
John Koleszar's avatar
John Koleszar committed
167
  VP8E_SET_ARNR_MAXFRAMES,         /**< control function to set the max number of frames blurred creating arf*/
168 169
  VP8E_SET_ARNR_STRENGTH,          //!< control function to set the filter
                                   //!< strength for the arf
170 171 172 173

  /*!\deprecated control function to set the filter type to use for the arf */
  VP8E_SET_ARNR_TYPE,

John Koleszar's avatar
John Koleszar committed
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
  VP8E_SET_TUNING,                 /**< control function to set visual tuning */
  /*!\brief control function to set constrained quality level
   *
   * \attention For this value to be used vpx_codec_enc_cfg_t::g_usage must be
   *            set to #VPX_CQ.
   * \note Valid range: 0..63
   */
  VP8E_SET_CQ_LEVEL,

  /*!\brief Max data rate for Intra frames
   *
   * This value controls additional clamping on the maximum size of a
   * keyframe. It is expressed as a percentage of the average
   * per-frame bitrate, with the special (and default) value 0 meaning
   * unlimited, or no additional clamping beyond the codec's built-in
   * algorithm.
   *
   * For example, to allocate no more than 4.5 frames worth of bitrate
   * to a keyframe, set this to 450.
   *
   */
  VP8E_SET_MAX_INTRA_BITRATE_PCT,
John Koleszar's avatar
John Koleszar committed
196 197 198


  /* TODO(jkoleszar): Move to vp9cx.h */
199
  VP9E_SET_LOSSLESS,
Ronald S. Bultje's avatar
Ronald S. Bultje committed
200 201
  VP9E_SET_TILE_COLUMNS,
  VP9E_SET_TILE_ROWS,
202
  VP9E_SET_FRAME_PARALLEL_DECODING,
203
  VP9E_SET_AQ_MODE,
204
  VP9E_SET_FRAME_PERIODIC_BOOST,
205 206 207 208 209
  /*!\brief control function to set noise sensitivity
   *
   *  0: off, 1: OnYOnly
   */
  VP9E_SET_NOISE_SENSITIVITY,
210 211

  VP9E_SET_SVC,
212
  VP9E_SET_SVC_PARAMETERS,
213 214 215 216 217
  /*!\brief control function to set svc layer for spatial and temporal.
   * \note Valid ranges: 0..#vpx_codec_enc_cfg::ss_number_layers for spatial
   *                     layer and 0..#vpx_codec_enc_cfg::ts_number_layers for
   *                     temporal layer.
   */
218 219
  VP9E_SET_SVC_LAYER_ID,
  VP9E_SET_TUNE_CONTENT
John Koleszar's avatar
John Koleszar committed
220
};
John Koleszar's avatar
John Koleszar committed
221 222 223 224 225

/*!\brief vpx 1-D scaling mode
 *
 * This set of constants define 1-D vpx scaling modes
 */
John Koleszar's avatar
John Koleszar committed
226 227 228 229 230
typedef enum vpx_scaling_mode_1d {
  VP8E_NORMAL      = 0,
  VP8E_FOURFIVE    = 1,
  VP8E_THREEFIVE   = 2,
  VP8E_ONETWO      = 3
John Koleszar's avatar
John Koleszar committed
231 232 233 234 235 236 237 238 239
} VPX_SCALING_MODE;


/*!\brief  vpx region of interest map
 *
 * These defines the data structures for the region of interest map
 *
 */

John Koleszar's avatar
John Koleszar committed
240
typedef struct vpx_roi_map {
Adrian Grange's avatar
Adrian Grange committed
241 242 243 244
  /*! An id between 0 and 3 for each 16x16 region within a frame. */
  unsigned char *roi_map;
  unsigned int rows;       /**< Number of rows. */
  unsigned int cols;       /**< Number of columns. */
245 246 247
  // TODO(paulwilkins): broken for VP9 which has 8 segments
  // q and loop filter deltas for each segment
  // (see MAX_MB_SEGMENTS)
Adrian Grange's avatar
Adrian Grange committed
248 249 250 251
  int delta_q[4];          /**< Quantizer deltas. */
  int delta_lf[4];         /**< Loop filter deltas. */
  /*! Static breakout threshold for each segment. */
  unsigned int static_threshold[4];
John Koleszar's avatar
John Koleszar committed
252 253 254 255 256 257 258 259 260
} vpx_roi_map_t;

/*!\brief  vpx active region map
 *
 * These defines the data structures for active region map
 *
 */


John Koleszar's avatar
John Koleszar committed
261 262 263 264
typedef struct vpx_active_map {
  unsigned char  *active_map; /**< specify an on (1) or off (0) each 16x16 region within a frame */
  unsigned int    rows;       /**< number of rows */
  unsigned int    cols;       /**< number of cols */
John Koleszar's avatar
John Koleszar committed
265 266 267 268 269 270 271
} vpx_active_map_t;

/*!\brief  vpx image scaling mode
 *
 * This defines the data structure for image scaling mode
 *
 */
John Koleszar's avatar
John Koleszar committed
272 273 274
typedef struct vpx_scaling_mode {
  VPX_SCALING_MODE    h_scaling_mode;  /**< horizontal scaling mode */
  VPX_SCALING_MODE    v_scaling_mode;  /**< vertical scaling mode   */
John Koleszar's avatar
John Koleszar committed
275 276 277 278 279
} vpx_scaling_mode_t;

/*!\brief VP8 token partition mode
 *
 * This defines VP8 partitioning mode for compressed data, i.e., the number of
280
 * sub-streams in the bitstream. Used for parallelized decoding.
John Koleszar's avatar
John Koleszar committed
281 282 283
 *
 */

John Koleszar's avatar
John Koleszar committed
284 285 286 287
typedef enum {
  VP8_ONE_TOKENPARTITION   = 0,
  VP8_TWO_TOKENPARTITION   = 1,
  VP8_FOUR_TOKENPARTITION  = 2,
John Koleszar's avatar
John Koleszar committed
288
  VP8_EIGHT_TOKENPARTITION = 3
John Koleszar's avatar
John Koleszar committed
289 290
} vp8e_token_partitions;

291 292 293 294 295 296
/*!brief VP9 encoder content type */
typedef enum {
  VP9E_CONTENT_DEFAULT,
  VP9E_CONTENT_SCREEN,
  VP9E_CONTENT_INVALID
} vp9e_tune_content;
John Koleszar's avatar
John Koleszar committed
297

John Koleszar's avatar
John Koleszar committed
298 299 300 301 302
/*!\brief VP8 model tuning parameters
 *
 * Changes the encoder to tune for certain types of input material.
 *
 */
John Koleszar's avatar
John Koleszar committed
303 304 305
typedef enum {
  VP8_TUNE_PSNR,
  VP8_TUNE_SSIM
John Koleszar's avatar
John Koleszar committed
306 307
} vp8e_tuning;

308 309 310 311 312 313 314
/*!\brief  vp9 svc layer parameters
 *
 * This defines the spatial and temporal layer id numbers for svc encoding.
 * This is used with the #VP9E_SET_SVC_LAYER_ID control to set the spatial and
 * temporal layer id for the current frame.
 *
 */
315
typedef struct vpx_svc_layer_id {
316 317
  int spatial_layer_id;       /**< Spatial layer id number. */
  int temporal_layer_id;      /**< Temporal layer id number. */
318 319
} vpx_svc_layer_id_t;

John Koleszar's avatar
John Koleszar committed
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
/*!\brief VP8 encoder control function parameter type
 *
 * Defines the data types that VP8E control functions take. Note that
 * additional common controls are defined in vp8.h
 *
 */


/* These controls have been deprecated in favor of the flags parameter to
 * vpx_codec_encode(). See the definition of VP8_EFLAG_* above.
 */
VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_UPD_ENTROPY,            int)
VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_UPD_REFERENCE,          int)
VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_USE_REFERENCE,          int)

VPX_CTRL_USE_TYPE(VP8E_SET_ROI_MAP,            vpx_roi_map_t *)
VPX_CTRL_USE_TYPE(VP8E_SET_ACTIVEMAP,          vpx_active_map_t *)
VPX_CTRL_USE_TYPE(VP8E_SET_SCALEMODE,          vpx_scaling_mode_t *)

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

John Koleszar's avatar
John Koleszar committed
343 344 345 346 347
VPX_CTRL_USE_TYPE(VP8E_SET_CPUUSED,            int)
VPX_CTRL_USE_TYPE(VP8E_SET_ENABLEAUTOALTREF,   unsigned int)
VPX_CTRL_USE_TYPE(VP8E_SET_NOISE_SENSITIVITY,  unsigned int)
VPX_CTRL_USE_TYPE(VP8E_SET_SHARPNESS,          unsigned int)
VPX_CTRL_USE_TYPE(VP8E_SET_STATIC_THRESHOLD,   unsigned int)
John Koleszar's avatar
John Koleszar committed
348
VPX_CTRL_USE_TYPE(VP8E_SET_TOKEN_PARTITIONS,   int) /* vp8e_token_partitions */
John Koleszar's avatar
John Koleszar committed
349 350

VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_MAXFRAMES,     unsigned int)
John Koleszar's avatar
John Koleszar committed
351
VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_STRENGTH,     unsigned int)
352
VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_SET_ARNR_TYPE,     unsigned int)
John Koleszar's avatar
John Koleszar committed
353
VPX_CTRL_USE_TYPE(VP8E_SET_TUNING,             int) /* vp8e_tuning */
John Koleszar's avatar
John Koleszar committed
354
VPX_CTRL_USE_TYPE(VP8E_SET_CQ_LEVEL,      unsigned int)
John Koleszar's avatar
John Koleszar committed
355

356
VPX_CTRL_USE_TYPE(VP9E_SET_TILE_COLUMNS,  int)
Ronald S. Bultje's avatar
Ronald S. Bultje committed
357
VPX_CTRL_USE_TYPE(VP9E_SET_TILE_ROWS,  int)
358

John Koleszar's avatar
John Koleszar committed
359 360 361
VPX_CTRL_USE_TYPE(VP8E_GET_LAST_QUANTIZER,     int *)
VPX_CTRL_USE_TYPE(VP8E_GET_LAST_QUANTIZER_64,  int *)

362 363
VPX_CTRL_USE_TYPE(VP8E_SET_MAX_INTRA_BITRATE_PCT, unsigned int)

John Koleszar's avatar
John Koleszar committed
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 369
VPX_CTRL_USE_TYPE(VP9E_SET_AQ_MODE, unsigned int)

370 371
VPX_CTRL_USE_TYPE(VP9E_SET_FRAME_PERIODIC_BOOST, unsigned int)

372 373
VPX_CTRL_USE_TYPE(VP9E_SET_NOISE_SENSITIVITY,  unsigned int)

374
VPX_CTRL_USE_TYPE(VP9E_SET_TUNE_CONTENT, int) /* vp9e_tune_content */
John Koleszar's avatar
John Koleszar committed
375
/*! @} - end defgroup vp8_encoder */
376 377 378 379
#ifdef __cplusplus
}  // extern "C"
#endif

James Zern's avatar
James Zern committed
380
#endif  // VPX_VP8CX_H_