2 * Copyright (c) 2010 The WebM project authors. All Rights Reserved.
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.
13 /*!\defgroup vp8_encoder WebM VP8/VP9 Encoder
19 #include "./vpx_encoder.h"
22 * \brief Provides definitions for using VP8 or VP9 encoder algorithm within the
23 * vpx Codec Interface.
30 /*!\name Algorithm interface for VP8
32 * This interface provides the capability to encode raw VP8 streams.
35 extern vpx_codec_iface_t vpx_codec_vp8_cx_algo;
36 extern vpx_codec_iface_t *vpx_codec_vp8_cx(void);
37 /*!@} - end algorithm interface member group*/
39 /*!\name Algorithm interface for VP9
41 * This interface provides the capability to encode raw VP9 streams.
44 extern vpx_codec_iface_t vpx_codec_vp9_cx_algo;
45 extern vpx_codec_iface_t *vpx_codec_vp9_cx(void);
46 /*!@} - end algorithm interface member group*/
53 /*!\brief Don't reference the last frame
55 * When this flag is set, the encoder will not use the last frame as a
56 * predictor. When not set, the encoder will choose whether to use the
57 * last frame or not automatically.
59 #define VP8_EFLAG_NO_REF_LAST (1<<16)
62 /*!\brief Don't reference the golden frame
64 * When this flag is set, the encoder will not use the golden frame as a
65 * predictor. When not set, the encoder will choose whether to use the
66 * golden frame or not automatically.
68 #define VP8_EFLAG_NO_REF_GF (1<<17)
71 /*!\brief Don't reference the alternate reference frame
73 * When this flag is set, the encoder will not use the alt ref frame as a
74 * predictor. When not set, the encoder will choose whether to use the
75 * alt ref frame or not automatically.
77 #define VP8_EFLAG_NO_REF_ARF (1<<21)
80 /*!\brief Don't update the last frame
82 * When this flag is set, the encoder will not update the last frame with
83 * the contents of the current frame.
85 #define VP8_EFLAG_NO_UPD_LAST (1<<18)
88 /*!\brief Don't update the golden frame
90 * When this flag is set, the encoder will not update the golden frame with
91 * the contents of the current frame.
93 #define VP8_EFLAG_NO_UPD_GF (1<<22)
96 /*!\brief Don't update the alternate reference frame
98 * When this flag is set, the encoder will not update the alt ref frame with
99 * the contents of the current frame.
101 #define VP8_EFLAG_NO_UPD_ARF (1<<23)
104 /*!\brief Force golden frame update
106 * When this flag is set, the encoder copy the contents of the current frame
107 * to the golden frame buffer.
109 #define VP8_EFLAG_FORCE_GF (1<<19)
112 /*!\brief Force alternate reference frame update
114 * When this flag is set, the encoder copy the contents of the current frame
115 * to the alternate reference frame buffer.
117 #define VP8_EFLAG_FORCE_ARF (1<<24)
120 /*!\brief Disable entropy update
122 * When this flag is set, the encoder will not update its internal entropy
123 * model based on the entropy of this frame.
125 #define VP8_EFLAG_NO_UPD_ENTROPY (1<<20)
128 /*!\brief VPx encoder control functions
130 * This set of macros define the control functions available for VPx
133 * \sa #vpx_codec_control
135 enum vp8e_enc_control_id {
136 /*!\brief Codec control function to set mode of entropy update in encoder.
138 * Supported in codecs: VP8, VP9
140 VP8E_UPD_ENTROPY = 5,
142 /*!\brief Codec control function to set reference update mode in encoder.
144 * Supported in codecs: VP8, VP9
148 /*!\brief Codec control function to set which reference frame encoder can use.
150 * Supported in codecs: VP8, VP9
154 /*!\brief Codec control function to pass an ROI map to encoder.
156 * Supported in codecs: VP8, VP9
160 /*!\brief Codec control function to pass an Active map to encoder.
162 * Supported in codecs: VP8, VP9
166 /*!\brief Codec control function to set encoder scaling mode.
168 * Supported in codecs: VP8, VP9
170 VP8E_SET_SCALEMODE = 11,
172 /*!\brief Codec control function to set encoder internal speed settings.
174 * Changes in this value influences, among others, the encoder's selection
175 * of motion estimation methods. Values greater than 0 will increase encoder
176 * speed at the expense of quality.
178 * \note Valid range for VP8: -16..16
179 * \note Valid range for VP9: -8..8
181 * Supported in codecs: VP8, VP9
183 VP8E_SET_CPUUSED = 13,
185 /*!\brief Codec control function to enable automatic set and use alf frames.
187 * Supported in codecs: VP8, VP9
189 VP8E_SET_ENABLEAUTOALTREF,
191 /*!\brief control function to set noise sensitivity
193 * 0: off, 1: OnYOnly, 2: OnYUV,
194 * 3: OnYUVAggressive, 4: Adaptive
196 * Supported in codecs: VP8
198 VP8E_SET_NOISE_SENSITIVITY,
200 /*!\brief Codec control function to set sharpness.
202 * Supported in codecs: VP8, VP9
206 /*!\brief Codec control function to set the threshold for MBs treated static.
208 * Supported in codecs: VP8, VP9
210 VP8E_SET_STATIC_THRESHOLD,
212 /*!\brief Codec control function to set the number of token partitions.
214 * Supported in codecs: VP8
216 VP8E_SET_TOKEN_PARTITIONS,
218 /*!\brief Codec control function to get last quantizer chosen by the encoder.
220 * Return value uses internal quantizer scale defined by the codec.
222 * Supported in codecs: VP8, VP9
224 VP8E_GET_LAST_QUANTIZER,
226 /*!\brief Codec control function to get last quantizer chosen by the encoder.
228 * Return value uses the 0..63 scale as used by the rc_*_quantizer config
231 * Supported in codecs: VP8, VP9
233 VP8E_GET_LAST_QUANTIZER_64,
235 /*!\brief Codec control function to set the max no of frames to create arf.
237 * Supported in codecs: VP8, VP9
239 VP8E_SET_ARNR_MAXFRAMES,
241 /*!\brief Codec control function to set the filter strength for the arf.
243 * Supported in codecs: VP8, VP9
245 VP8E_SET_ARNR_STRENGTH,
247 /*!\deprecated control function to set the filter type to use for the arf. */
250 /*!\brief Codec control function to set visual tuning.
252 * Supported in codecs: VP8, VP9
256 /*!\brief Codec control function to set constrained quality level.
258 * \attention For this value to be used vpx_codec_enc_cfg_t::g_usage must be
260 * \note Valid range: 0..63
262 * Supported in codecs: VP8, VP9
266 /*!\brief Codec control function to set Max data rate for Intra frames.
268 * This value controls additional clamping on the maximum size of a
269 * keyframe. It is expressed as a percentage of the average
270 * per-frame bitrate, with the special (and default) value 0 meaning
271 * unlimited, or no additional clamping beyond the codec's built-in
274 * For example, to allocate no more than 4.5 frames worth of bitrate
275 * to a keyframe, set this to 450.
277 * Supported in codecs: VP8, VP9
279 VP8E_SET_MAX_INTRA_BITRATE_PCT,
281 /*!\brief Codec control function to set reference and update frame flags.
283 * Supported in codecs: VP8
285 VP8E_SET_FRAME_FLAGS,
287 /*!\brief Codec control function to set max data rate for Inter frames.
289 * This value controls additional clamping on the maximum size of an
290 * inter frame. It is expressed as a percentage of the average
291 * per-frame bitrate, with the special (and default) value 0 meaning
292 * unlimited, or no additional clamping beyond the codec's built-in
295 * For example, to allow no more than 4.5 frames worth of bitrate
296 * to an inter frame, set this to 450.
298 * Supported in codecs: VP9
300 VP9E_SET_MAX_INTER_BITRATE_PCT,
302 /*!\brief Boost percentage for Golden Frame in CBR mode.
304 * This value controls the amount of boost given to Golden Frame in
305 * CBR mode. It is expressed as a percentage of the average
306 * per-frame bitrate, with the special (and default) value 0 meaning
307 * the feature is off, i.e., no golden frame boost in CBR mode and
308 * average bitrate target is used.
310 * For example, to allow 100% more bits, i.e, 2X, in a golden frame
311 * than average frame, set this to 100.
313 * Supported in codecs: VP9
315 VP9E_SET_GF_CBR_BOOST_PCT,
317 /*!\brief Codec control function to set the temporal layer id.
319 * For temporal scalability: this control allows the application to set the
320 * layer id for each frame to be encoded. Note that this control must be set
321 * for every frame prior to encoding. The usage of this control function
322 * supersedes the internal temporal pattern counter, which is now deprecated.
324 * Supported in codecs: VP8
326 VP8E_SET_TEMPORAL_LAYER_ID,
328 /*!\brief Codec control function to set encoder screen content mode.
330 * 0: off, 1: On, 2: On with more aggressive rate control.
332 * Supported in codecs: VP8
334 VP8E_SET_SCREEN_CONTENT_MODE,
336 /*!\brief Codec control function to set lossless encoding mode.
338 * VP9 can operate in lossless encoding mode, in which the bitstream
339 * produced will be able to decode and reconstruct a perfect copy of
340 * input source. This control function provides a mean to switch encoder
341 * into lossless coding mode(1) or normal coding mode(0) that may be lossy.
342 * 0 = lossy coding mode
343 * 1 = lossless coding mode
345 * By default, encoder operates in normal coding mode (maybe lossy).
347 * Supported in codecs: VP9
351 /*!\brief Codec control function to set number of tile columns.
353 * In encoding and decoding, VP9 allows an input image frame be partitioned
354 * into separated vertical tile columns, which can be encoded or decoded
355 * independently. This enables easy implementation of parallel encoding and
356 * decoding. This control requests the encoder to use column tiles in
357 * encoding an input frame, with number of tile columns (in Log2 unit) as
363 * n = 2**n tile columns
364 * The requested tile columns will be capped by encoder based on image size
365 * limitation (The minimum width of a tile column is 256 pixel, the maximum
368 * By default, the value is 0, i.e. one single column tile for entire image.
370 * Supported in codecs: VP9
372 VP9E_SET_TILE_COLUMNS,
374 /*!\brief Codec control function to set number of tile rows.
376 * In encoding and decoding, VP9 allows an input image frame be partitioned
377 * into separated horizontal tile rows. Tile rows are encoded or decoded
378 * sequentially. Even though encoding/decoding of later tile rows depends on
379 * earlier ones, this allows the encoder to output data packets for tile rows
380 * prior to completely processing all tile rows in a frame, thereby reducing
381 * the latency in processing between input and output. The parameter
382 * for this control describes the number of tile rows, which has a valid
388 * By default, the value is 0, i.e. one single row tile for entire image.
390 * Supported in codecs: VP9
394 /*!\brief Codec control function to enable frame parallel decoding feature.
396 * VP9 has a bitstream feature to reduce decoding dependency between frames
397 * by turning off backward update of probability context used in encoding
398 * and decoding. This allows staged parallel processing of more than one
399 * video frames in the decoder. This control function provides a mean to
400 * turn this feature on or off for bitstreams produced by encoder.
402 * By default, this feature is off.
404 * Supported in codecs: VP9
406 VP9E_SET_FRAME_PARALLEL_DECODING,
408 /*!\brief Codec control function to set adaptive quantization mode.
410 * VP9 has a segment based feature that allows encoder to adaptively change
411 * quantization parameter for each segment within a frame to improve the
412 * subjective quality. This control makes encoder operate in one of the
413 * several AQ_modes supported.
415 * By default, encoder operates with AQ_Mode 0(adaptive quantization off).
417 * Supported in codecs: VP9
421 /*!\brief Codec control function to enable/disable periodic Q boost.
423 * One VP9 encoder speed feature is to enable quality boost by lowering
424 * frame level Q periodically. This control function provides a mean to
425 * turn on/off this feature.
429 * By default, the encoder is allowed to use this feature for appropriate
432 * Supported in codecs: VP9
434 VP9E_SET_FRAME_PERIODIC_BOOST,
436 /*!\brief Codec control function to set noise sensitivity.
438 * 0: off, 1: On(YOnly)
440 * Supported in codecs: VP9
442 VP9E_SET_NOISE_SENSITIVITY,
444 /*!\brief Codec control function to turn on/off SVC in encoder.
445 * \note Return value is VPX_CODEC_INVALID_PARAM if the encoder does not
446 * support SVC in its current encoding mode
449 * Supported in codecs: VP9
453 #if VPX_ENCODER_ABI_VERSION > (4 + VPX_CODEC_ABI_VERSION)
454 /*!\brief Codec control function to set parameters for SVC.
455 * \note Parameters contain min_q, max_q, scaling factor for each of the
458 * Supported in codecs: VP9
460 VP9E_SET_SVC_PARAMETERS,
463 /*!\brief Codec control function to set svc layer for spatial and temporal.
464 * \note Valid ranges: 0..#vpx_codec_enc_cfg::ss_number_layers for spatial
465 * layer and 0..#vpx_codec_enc_cfg::ts_number_layers for
468 * Supported in codecs: VP9
470 VP9E_SET_SVC_LAYER_ID,
472 /*!\brief Codec control function to set content type.
473 * \note Valid parameter range:
474 * VP9E_CONTENT_DEFAULT = Regular video content (Default)
475 * VP9E_CONTENT_SCREEN = Screen capture content
477 * Supported in codecs: VP9
479 VP9E_SET_TUNE_CONTENT,
481 #if VPX_ENCODER_ABI_VERSION > (4 + VPX_CODEC_ABI_VERSION)
482 /*!\brief Codec control function to get svc layer ID.
483 * \note The layer ID returned is for the data packet from the registered
486 * Supported in codecs: VP9
488 VP9E_GET_SVC_LAYER_ID,
490 /*!\brief Codec control function to register callback to get per layer packet.
491 * \note Parameter for this control function is a structure with a callback
492 * function and a pointer to private data used by the callback.
494 * Supported in codecs: VP9
496 VP9E_REGISTER_CX_CALLBACK,
499 /*!\brief Codec control function to set color space info.
500 * \note Valid ranges: 0..7, default is "UNKNOWN".
510 * Supported in codecs: VP9
512 VP9E_SET_COLOR_SPACE,
514 /*!\brief Codec control function to get an Active map back from the encoder.
516 * Supported in codecs: VP9
521 /*!\brief vpx 1-D scaling mode
523 * This set of constants define 1-D vpx scaling modes
525 typedef enum vpx_scaling_mode_1d {
533 /*!\brief vpx region of interest map
535 * These defines the data structures for the region of interest map
539 typedef struct vpx_roi_map {
540 /*! An id between 0 and 3 for each 16x16 region within a frame. */
541 unsigned char *roi_map;
542 unsigned int rows; /**< Number of rows. */
543 unsigned int cols; /**< Number of columns. */
544 // TODO(paulwilkins): broken for VP9 which has 8 segments
545 // q and loop filter deltas for each segment
546 // (see MAX_MB_SEGMENTS)
547 int delta_q[4]; /**< Quantizer deltas. */
548 int delta_lf[4]; /**< Loop filter deltas. */
549 /*! Static breakout threshold for each segment. */
550 unsigned int static_threshold[4];
553 /*!\brief vpx active region map
555 * These defines the data structures for active region map
560 typedef struct vpx_active_map {
561 unsigned char *active_map; /**< specify an on (1) or off (0) each 16x16 region within a frame */
562 unsigned int rows; /**< number of rows */
563 unsigned int cols; /**< number of cols */
566 /*!\brief vpx image scaling mode
568 * This defines the data structure for image scaling mode
571 typedef struct vpx_scaling_mode {
572 VPX_SCALING_MODE h_scaling_mode; /**< horizontal scaling mode */
573 VPX_SCALING_MODE v_scaling_mode; /**< vertical scaling mode */
574 } vpx_scaling_mode_t;
576 /*!\brief VP8 token partition mode
578 * This defines VP8 partitioning mode for compressed data, i.e., the number of
579 * sub-streams in the bitstream. Used for parallelized decoding.
584 VP8_ONE_TOKENPARTITION = 0,
585 VP8_TWO_TOKENPARTITION = 1,
586 VP8_FOUR_TOKENPARTITION = 2,
587 VP8_EIGHT_TOKENPARTITION = 3
588 } vp8e_token_partitions;
590 /*!brief VP9 encoder content type */
592 VP9E_CONTENT_DEFAULT,
597 /*!\brief VP8 model tuning parameters
599 * Changes the encoder to tune for certain types of input material.
607 #if VPX_ENCODER_ABI_VERSION > (4 + VPX_CODEC_ABI_VERSION)
608 /*!\brief vp9 svc layer parameters
610 * This defines the spatial and temporal layer id numbers for svc encoding.
611 * This is used with the #VP9E_SET_SVC_LAYER_ID control to set the spatial and
612 * temporal layer id for the current frame.
615 typedef struct vpx_svc_layer_id {
616 int spatial_layer_id; /**< Spatial layer id number. */
617 int temporal_layer_id; /**< Temporal layer id number. */
618 } vpx_svc_layer_id_t;
620 /*!\brief vp9 svc layer parameters
622 * This defines the temporal layer id numbers for svc encoding.
623 * This is used with the #VP9E_SET_SVC_LAYER_ID control to set the
624 * temporal layer id for the current frame.
627 typedef struct vpx_svc_layer_id {
628 int temporal_layer_id; /**< Temporal layer id number. */
629 } vpx_svc_layer_id_t;
632 /*!\brief VP8 encoder control function parameter type
634 * Defines the data types that VP8E control functions take. Note that
635 * additional common controls are defined in vp8.h
640 /* These controls have been deprecated in favor of the flags parameter to
641 * vpx_codec_encode(). See the definition of VP8_EFLAG_* above.
643 VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_UPD_ENTROPY, int)
644 VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_UPD_REFERENCE, int)
645 VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_USE_REFERENCE, int)
647 VPX_CTRL_USE_TYPE(VP8E_SET_FRAME_FLAGS, int)
648 VPX_CTRL_USE_TYPE(VP8E_SET_TEMPORAL_LAYER_ID, int)
649 VPX_CTRL_USE_TYPE(VP8E_SET_ROI_MAP, vpx_roi_map_t *)
650 VPX_CTRL_USE_TYPE(VP8E_SET_ACTIVEMAP, vpx_active_map_t *)
651 VPX_CTRL_USE_TYPE(VP8E_SET_SCALEMODE, vpx_scaling_mode_t *)
653 VPX_CTRL_USE_TYPE(VP9E_SET_SVC, int)
654 #if VPX_ENCODER_ABI_VERSION > (4 + VPX_CODEC_ABI_VERSION)
655 VPX_CTRL_USE_TYPE(VP9E_SET_SVC_PARAMETERS, void *)
656 VPX_CTRL_USE_TYPE(VP9E_REGISTER_CX_CALLBACK, void *)
658 VPX_CTRL_USE_TYPE(VP9E_SET_SVC_LAYER_ID, vpx_svc_layer_id_t *)
660 VPX_CTRL_USE_TYPE(VP8E_SET_CPUUSED, int)
661 VPX_CTRL_USE_TYPE(VP8E_SET_ENABLEAUTOALTREF, unsigned int)
662 VPX_CTRL_USE_TYPE(VP8E_SET_NOISE_SENSITIVITY, unsigned int)
663 VPX_CTRL_USE_TYPE(VP8E_SET_SHARPNESS, unsigned int)
664 VPX_CTRL_USE_TYPE(VP8E_SET_STATIC_THRESHOLD, unsigned int)
665 VPX_CTRL_USE_TYPE(VP8E_SET_TOKEN_PARTITIONS, int) /* vp8e_token_partitions */
667 VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_MAXFRAMES, unsigned int)
668 VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_STRENGTH, unsigned int)
669 VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_SET_ARNR_TYPE, unsigned int)
670 VPX_CTRL_USE_TYPE(VP8E_SET_TUNING, int) /* vp8e_tuning */
671 VPX_CTRL_USE_TYPE(VP8E_SET_CQ_LEVEL, unsigned int)
673 VPX_CTRL_USE_TYPE(VP9E_SET_TILE_COLUMNS, int)
674 VPX_CTRL_USE_TYPE(VP9E_SET_TILE_ROWS, int)
676 VPX_CTRL_USE_TYPE(VP8E_GET_LAST_QUANTIZER, int *)
677 VPX_CTRL_USE_TYPE(VP8E_GET_LAST_QUANTIZER_64, int *)
678 #if VPX_ENCODER_ABI_VERSION > (4 + VPX_CODEC_ABI_VERSION)
679 VPX_CTRL_USE_TYPE(VP9E_GET_SVC_LAYER_ID, vpx_svc_layer_id_t *)
682 VPX_CTRL_USE_TYPE(VP8E_SET_MAX_INTRA_BITRATE_PCT, unsigned int)
683 VPX_CTRL_USE_TYPE(VP8E_SET_MAX_INTER_BITRATE_PCT, unsigned int)
685 VPX_CTRL_USE_TYPE(VP8E_SET_SCREEN_CONTENT_MODE, unsigned int)
687 VPX_CTRL_USE_TYPE(VP9E_SET_GF_CBR_BOOST_PCT, unsigned int)
689 VPX_CTRL_USE_TYPE(VP9E_SET_LOSSLESS, unsigned int)
691 VPX_CTRL_USE_TYPE(VP9E_SET_FRAME_PARALLEL_DECODING, unsigned int)
693 VPX_CTRL_USE_TYPE(VP9E_SET_AQ_MODE, unsigned int)
695 VPX_CTRL_USE_TYPE(VP9E_SET_FRAME_PERIODIC_BOOST, unsigned int)
697 VPX_CTRL_USE_TYPE(VP9E_SET_NOISE_SENSITIVITY, unsigned int)
699 VPX_CTRL_USE_TYPE(VP9E_SET_TUNE_CONTENT, int) /* vp9e_tune_content */
701 VPX_CTRL_USE_TYPE(VP9E_SET_COLOR_SPACE, int)
703 VPX_CTRL_USE_TYPE(VP9E_GET_ACTIVEMAP, vpx_active_map_t *)
704 /*! @} - end defgroup vp8_encoder */
709 #endif // VPX_VP8CX_H_