| /* |
| * Copyright (c) 2010 The WebM project authors. All Rights Reserved. |
| * |
| * Use of this source code is governed by a BSD-style license |
| * that can be found in the LICENSE file in the root of the source |
| * tree. An additional intellectual property rights grant can be found |
| * in the file PATENTS. All contributing project authors may |
| * be found in the AUTHORS file in the root of the source tree. |
| */ |
| #ifndef VPX_VPX_VP8CX_H_ |
| #define VPX_VPX_VP8CX_H_ |
| |
| /*!\defgroup vp8_encoder WebM VP8/VP9 Encoder |
| * \ingroup vp8 |
| * |
| * @{ |
| */ |
| #include "./vp8.h" |
| #include "./vpx_encoder.h" |
| |
| /*!\file |
| * \brief Provides definitions for using VP8 or VP9 encoder algorithm within the |
| * vpx Codec Interface. |
| */ |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| /*!\name Algorithm interface for VP8 |
| * |
| * This interface provides the capability to encode raw VP8 streams. |
| * @{ |
| */ |
| extern vpx_codec_iface_t vpx_codec_vp8_cx_algo; |
| extern vpx_codec_iface_t *vpx_codec_vp8_cx(void); |
| /*!@} - end algorithm interface member group*/ |
| |
| /*!\name Algorithm interface for VP9 |
| * |
| * This interface provides the capability to encode raw VP9 streams. |
| * @{ |
| */ |
| extern vpx_codec_iface_t vpx_codec_vp9_cx_algo; |
| extern vpx_codec_iface_t *vpx_codec_vp9_cx(void); |
| /*!@} - end algorithm interface member group*/ |
| |
| /* |
| * 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 VPx encoder control functions |
| * |
| * This set of macros define the control functions available for VPx |
| * encoder interface. |
| * |
| * \sa #vpx_codec_control |
| */ |
| enum vp8e_enc_control_id { |
| /*!\brief Codec control function to pass an ROI map to encoder. |
| * |
| * Supported in codecs: VP8 |
| */ |
| VP8E_SET_ROI_MAP = 8, |
| |
| /*!\brief Codec control function to pass an Active map to encoder. |
| * |
| * Supported in codecs: VP8, VP9 |
| */ |
| VP8E_SET_ACTIVEMAP, |
| |
| /*!\brief Codec control function to set encoder scaling mode. |
| * |
| * Supported in codecs: VP8, VP9 |
| */ |
| VP8E_SET_SCALEMODE = 11, |
| |
| /*!\brief Codec control function to set encoder internal speed settings. |
| * |
| * 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. |
| * |
| * \note Valid range for VP8: -16..16 |
| * \note Valid range for VP9: -9..9 |
| * |
| * Supported in codecs: VP8, VP9 |
| */ |
| VP8E_SET_CPUUSED = 13, |
| |
| /*!\brief Codec control function to enable automatic use of arf frames. |
| * |
| * \note Valid range for VP8: 0..1 |
| * \note Valid range for VP9: 0..6 |
| * |
| * Supported in codecs: VP8, VP9 |
| */ |
| VP8E_SET_ENABLEAUTOALTREF, |
| |
| /*!\brief control function to set noise sensitivity |
| * |
| * 0: off, 1: OnYOnly, 2: OnYUV, |
| * 3: OnYUVAggressive, 4: Adaptive |
| * |
| * Supported in codecs: VP8 |
| */ |
| VP8E_SET_NOISE_SENSITIVITY, |
| |
| /*!\brief Codec control function to set higher sharpness at the expense |
| * of a lower PSNR. |
| * |
| * \note Valid range: 0..7 |
| * |
| * Supported in codecs: VP8, VP9 |
| */ |
| VP8E_SET_SHARPNESS, |
| |
| /*!\brief Codec control function to set the threshold for MBs treated static. |
| * |
| * Supported in codecs: VP8, VP9 |
| */ |
| VP8E_SET_STATIC_THRESHOLD, |
| |
| /*!\brief Codec control function to set the number of token partitions. |
| * |
| * Supported in codecs: VP8 |
| */ |
| VP8E_SET_TOKEN_PARTITIONS, |
| |
| /*!\brief Codec control function to get last quantizer chosen by the encoder. |
| * |
| * Return value uses internal quantizer scale defined by the codec. |
| * |
| * Supported in codecs: VP8, VP9 |
| */ |
| VP8E_GET_LAST_QUANTIZER, |
| |
| /*!\brief Codec control function to get last quantizer chosen by the encoder. |
| * |
| * Return value uses the 0..63 scale as used by the rc_*_quantizer config |
| * parameters. |
| * |
| * Supported in codecs: VP8, VP9 |
| */ |
| VP8E_GET_LAST_QUANTIZER_64, |
| |
| /*!\brief Codec control function to set the max no of frames to create arf. |
| * |
| * Supported in codecs: VP8, VP9 |
| */ |
| VP8E_SET_ARNR_MAXFRAMES, |
| |
| /*!\brief Codec control function to set the filter strength for the arf. |
| * |
| * Supported in codecs: VP8, VP9 |
| */ |
| VP8E_SET_ARNR_STRENGTH, |
| |
| /*!\deprecated control function to set the filter type to use for the arf. */ |
| VP8E_SET_ARNR_TYPE, |
| |
| /*!\brief Codec control function to set visual tuning. |
| * |
| * Supported in codecs: VP8, VP9 |
| */ |
| VP8E_SET_TUNING, |
| |
| /*!\brief Codec control function to set constrained / constant quality level. |
| * |
| * \attention For this value to be used vpx_codec_enc_cfg_t::rc_end_usage must |
| * be set to #VPX_CQ or #VPX_Q |
| * \note Valid range: 0..63 |
| * |
| * Supported in codecs: VP8, VP9 |
| */ |
| VP8E_SET_CQ_LEVEL, |
| |
| /*!\brief Codec control function to set 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. |
| * |
| * Supported in codecs: VP8, VP9 |
| */ |
| VP8E_SET_MAX_INTRA_BITRATE_PCT, |
| |
| /*!\brief Codec control function to set reference and update frame flags. |
| * |
| * Supported in codecs: VP8 |
| */ |
| VP8E_SET_FRAME_FLAGS, |
| |
| /*!\brief Codec control function to set max data rate for Inter frames. |
| * |
| * This value controls additional clamping on the maximum size of an |
| * inter frame. 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 allow no more than 4.5 frames worth of bitrate |
| * to an inter frame, set this to 450. |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_MAX_INTER_BITRATE_PCT, |
| |
| /*!\brief Boost percentage for Golden Frame in CBR mode. |
| * |
| * This value controls the amount of boost given to Golden Frame in |
| * CBR mode. It is expressed as a percentage of the average |
| * per-frame bitrate, with the special (and default) value 0 meaning |
| * the feature is off, i.e., no golden frame boost in CBR mode and |
| * average bitrate target is used. |
| * |
| * For example, to allow 100% more bits, i.e, 2X, in a golden frame |
| * than average frame, set this to 100. |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_GF_CBR_BOOST_PCT, |
| |
| /*!\brief Codec control function to set the temporal layer id. |
| * |
| * For temporal scalability: this control allows the application to set the |
| * layer id for each frame to be encoded. Note that this control must be set |
| * for every frame prior to encoding. The usage of this control function |
| * supersedes the internal temporal pattern counter, which is now deprecated. |
| * |
| * Supported in codecs: VP8 |
| */ |
| VP8E_SET_TEMPORAL_LAYER_ID, |
| |
| /*!\brief Codec control function to set encoder screen content mode. |
| * |
| * 0: off, 1: On, 2: On with more aggressive rate control. |
| * |
| * Supported in codecs: VP8 |
| */ |
| VP8E_SET_SCREEN_CONTENT_MODE, |
| |
| /*!\brief Codec control function to set lossless encoding mode. |
| * |
| * VP9 can operate in lossless encoding mode, in which the bitstream |
| * produced will be able to decode and reconstruct a perfect copy of |
| * input source. This control function provides a mean to switch encoder |
| * into lossless coding mode(1) or normal coding mode(0) that may be lossy. |
| * 0 = lossy coding mode |
| * 1 = lossless coding mode |
| * |
| * By default, encoder operates in normal coding mode (maybe lossy). |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_LOSSLESS, |
| |
| /*!\brief Codec control function to set number of tile columns. |
| * |
| * In encoding and decoding, VP9 allows an input image frame be partitioned |
| * into separated vertical tile columns, which can be encoded or decoded |
| * independently. This enables easy implementation of parallel encoding and |
| * decoding. This control requests the encoder to use column tiles in |
| * encoding an input frame, with number of tile columns (in Log2 unit) as |
| * the parameter: |
| * 0 = 1 tile column |
| * 1 = 2 tile columns |
| * 2 = 4 tile columns |
| * ..... |
| * n = 2**n tile columns |
| * The requested tile columns will be capped by the encoder based on image |
| * size limitations (The minimum width of a tile column is 256 pixels, the |
| * maximum is 4096). |
| * |
| * By default, the value is 6, i.e., the maximum number of tiles supported by |
| * the resolution. |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_TILE_COLUMNS, |
| |
| /*!\brief Codec control function to set number of tile rows. |
| * |
| * In encoding and decoding, VP9 allows an input image frame be partitioned |
| * into separated horizontal tile rows. Tile rows are encoded or decoded |
| * sequentially. Even though encoding/decoding of later tile rows depends on |
| * earlier ones, this allows the encoder to output data packets for tile rows |
| * prior to completely processing all tile rows in a frame, thereby reducing |
| * the latency in processing between input and output. The parameter |
| * for this control describes the number of tile rows, which has a valid |
| * range [0, 2]: |
| * 0 = 1 tile row |
| * 1 = 2 tile rows |
| * 2 = 4 tile rows |
| * |
| * By default, the value is 0, i.e. one single row tile for entire image. |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_TILE_ROWS, |
| |
| /*!\brief Codec control function to enable frame parallel decoding feature. |
| * |
| * VP9 has a bitstream feature to reduce decoding dependency between frames |
| * by turning off backward update of probability context used in encoding |
| * and decoding. This allows staged parallel processing of more than one |
| * video frame in the decoder. This control function provides a means to |
| * turn this feature on or off for bitstreams produced by encoder. |
| * |
| * By default, this feature is on. |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_FRAME_PARALLEL_DECODING, |
| |
| /*!\brief Codec control function to set adaptive quantization mode. |
| * |
| * VP9 has a segment based feature that allows encoder to adaptively change |
| * quantization parameter for each segment within a frame to improve the |
| * subjective quality. This control makes encoder operate in one of the |
| * several AQ_modes supported. |
| * |
| * By default, encoder operates with AQ_Mode 0(adaptive quantization off). |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_AQ_MODE, |
| |
| /*!\brief Codec control function to enable/disable periodic Q boost. |
| * |
| * One VP9 encoder speed feature is to enable quality boost by lowering |
| * frame level Q periodically. This control function provides a mean to |
| * turn on/off this feature. |
| * 0 = off |
| * 1 = on |
| * |
| * By default, the encoder is allowed to use this feature for appropriate |
| * encoding modes. |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_FRAME_PERIODIC_BOOST, |
| |
| /*!\brief Codec control function to set noise sensitivity. |
| * |
| * 0: off, 1: On(YOnly), 2: For SVC only, on top two spatial layers(YOnly) |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_NOISE_SENSITIVITY, |
| |
| /*!\brief Codec control function to turn on/off SVC in encoder. |
| * \note Return value is VPX_CODEC_INVALID_PARAM if the encoder does not |
| * support SVC in its current encoding mode |
| * 0: off, 1: on |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_SVC, |
| |
| /*!\brief Codec control function to pass an ROI map to encoder. |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_ROI_MAP, |
| |
| /*!\brief Codec control function to set parameters for SVC. |
| * \note Parameters contain min_q, max_q, scaling factor for each of the |
| * SVC layers. |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_SVC_PARAMETERS, |
| |
| /*!\brief Codec 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. |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_SVC_LAYER_ID, |
| |
| /*!\brief Codec control function to set content type. |
| * \note Valid parameter range: |
| * VP9E_CONTENT_DEFAULT = Regular video content (Default) |
| * VP9E_CONTENT_SCREEN = Screen capture content |
| * VP9E_CONTENT_FILM = Film content: improves grain retention |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_TUNE_CONTENT, |
| |
| /*!\brief Codec control function to get svc layer ID. |
| * \note The layer ID returned is for the data packet from the registered |
| * callback function. |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_GET_SVC_LAYER_ID, |
| |
| /*!\brief Codec control function to register callback to get per layer packet. |
| * \note Parameter for this control function is a structure with a callback |
| * function and a pointer to private data used by the callback. |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_REGISTER_CX_CALLBACK, |
| |
| /*!\brief Codec control function to set color space info. |
| * \note Valid ranges: 0..7, default is "UNKNOWN". |
| * 0 = UNKNOWN, |
| * 1 = BT_601 |
| * 2 = BT_709 |
| * 3 = SMPTE_170 |
| * 4 = SMPTE_240 |
| * 5 = BT_2020 |
| * 6 = RESERVED |
| * 7 = SRGB |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_COLOR_SPACE, |
| |
| /*!\brief Codec control function to set temporal layering mode. |
| * \note Valid ranges: 0..3, default is "0" |
| * (VP9E_TEMPORAL_LAYERING_MODE_NOLAYERING). |
| * 0 = VP9E_TEMPORAL_LAYERING_MODE_NOLAYERING |
| * 1 = VP9E_TEMPORAL_LAYERING_MODE_BYPASS |
| * 2 = VP9E_TEMPORAL_LAYERING_MODE_0101 |
| * 3 = VP9E_TEMPORAL_LAYERING_MODE_0212 |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_TEMPORAL_LAYERING_MODE, |
| |
| /*!\brief Codec control function to set minimum interval between GF/ARF frames |
| * |
| * By default the value is set as 4. |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_MIN_GF_INTERVAL, |
| |
| /*!\brief Codec control function to set minimum interval between GF/ARF frames |
| * |
| * By default the value is set as 16. |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_MAX_GF_INTERVAL, |
| |
| /*!\brief Codec control function to get an Active map back from the encoder. |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_GET_ACTIVEMAP, |
| |
| /*!\brief Codec control function to set color range bit. |
| * \note Valid ranges: 0..1, default is 0 |
| * 0 = Limited range (16..235 or HBD equivalent) |
| * 1 = Full range (0..255 or HBD equivalent) |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_COLOR_RANGE, |
| |
| /*!\brief Codec control function to set the frame flags and buffer indices |
| * for spatial layers. The frame flags and buffer indices are set using the |
| * struct #vpx_svc_ref_frame_config defined below. |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_SVC_REF_FRAME_CONFIG, |
| |
| /*!\brief Codec control function to set intended rendering image size. |
| * |
| * By default, this is identical to the image size in pixels. |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_RENDER_SIZE, |
| |
| /*!\brief Codec control function to set target level. |
| * |
| * 255: off (default); 0: only keep level stats; 10: target for level 1.0; |
| * 11: target for level 1.1; ... 62: target for level 6.2 |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_TARGET_LEVEL, |
| |
| /*!\brief Codec control function to set row level multi-threading. |
| * |
| * 0 : off, 1 : on |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_ROW_MT, |
| |
| /*!\brief Codec control function to get bitstream level. |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_GET_LEVEL, |
| |
| /*!\brief Codec control function to enable/disable special mode for altref |
| * adaptive quantization. You can use it with --aq-mode concurrently. |
| * |
| * Enable special adaptive quantization for altref frames based on their |
| * expected prediction quality for the future frames. |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_ALT_REF_AQ, |
| |
| /*!\brief Boost percentage for Golden Frame in CBR mode. |
| * |
| * This value controls the amount of boost given to Golden Frame in |
| * CBR mode. It is expressed as a percentage of the average |
| * per-frame bitrate, with the special (and default) value 0 meaning |
| * the feature is off, i.e., no golden frame boost in CBR mode and |
| * average bitrate target is used. |
| * |
| * For example, to allow 100% more bits, i.e, 2X, in a golden frame |
| * than average frame, set this to 100. |
| * |
| * Supported in codecs: VP8 |
| */ |
| VP8E_SET_GF_CBR_BOOST_PCT, |
| |
| /*!\brief Codec control function to enable the extreme motion vector unit test |
| * in VP9. Please note that this is only used in motion vector unit test. |
| * |
| * 0 : off, 1 : MAX_EXTREME_MV, 2 : MIN_EXTREME_MV |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_ENABLE_MOTION_VECTOR_UNIT_TEST, |
| |
| /*!\brief Codec control function to constrain the inter-layer prediction |
| * (prediction of lower spatial resolution) in VP9 SVC. |
| * |
| * 0 : inter-layer prediction on, 1 : off, 2 : off only on non-key frames |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_SVC_INTER_LAYER_PRED, |
| |
| /*!\brief Codec control function to set mode and thresholds for frame |
| * dropping in SVC. Drop frame thresholds are set per-layer. Mode is set as: |
| * 0 : layer-dependent dropping, 1 : constrained dropping, current layer drop |
| * forces drop on all upper layers. Default mode is 0. |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_SVC_FRAME_DROP_LAYER, |
| |
| /*!\brief Codec control function to get the refresh and reference flags and |
| * the buffer indices, up to the last encoded spatial layer. |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_GET_SVC_REF_FRAME_CONFIG, |
| |
| /*!\brief Codec control function to enable/disable use of golden reference as |
| * a second temporal reference for SVC. Only used when inter-layer prediction |
| * is disabled on INTER frames. |
| * |
| * 0: Off, 1: Enabled (default) |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_SVC_GF_TEMPORAL_REF, |
| |
| /*!\brief Codec control function to enable spatial layer sync frame, for any |
| * spatial layer. Enabling it for layer k means spatial layer k will disable |
| * all temporal prediction, but keep the inter-layer prediction. It will |
| * refresh any temporal reference buffer for that layer, and reset the |
| * temporal layer for the superframe to 0. Setting the layer sync for base |
| * spatial layer forces a key frame. Default is off (0) for all spatial |
| * layers. Spatial layer sync flag is reset to 0 after each encoded layer, |
| * so when control is invoked it is only used for the current superframe. |
| * |
| * 0: Off (default), 1: Enabled |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_SVC_SPATIAL_LAYER_SYNC, |
| |
| /*!\brief Codec control function to enable temporal dependency model. |
| * |
| * Vp9 allows the encoder to run temporal dependency model and use it to |
| * improve the compression performance. To enable, set this parameter to be |
| * 1. The default value is set to be 1. |
| */ |
| VP9E_SET_TPL, |
| |
| /*!\brief Codec control function to enable postencode frame drop. |
| * |
| * This will allow encoder to drop frame after it's encoded. |
| * |
| * 0: Off (default), 1: Enabled |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_POSTENCODE_DROP, |
| |
| /*!\brief Codec control function to set delta q for uv. |
| * |
| * Cap it at +/-15. |
| * |
| * Supported in codecs: VP9 |
| */ |
| VP9E_SET_DELTA_Q_UV, |
| }; |
| |
| /*!\brief vpx 1-D scaling mode |
| * |
| * This set of constants define 1-D vpx scaling modes |
| */ |
| typedef enum vpx_scaling_mode_1d { |
| VP8E_NORMAL = 0, |
| VP8E_FOURFIVE = 1, |
| VP8E_THREEFIVE = 2, |
| VP8E_ONETWO = 3 |
| } VPX_SCALING_MODE; |
| |
| /*!\brief Temporal layering mode enum for VP9 SVC. |
| * |
| * This set of macros define the different temporal layering modes. |
| * Supported codecs: VP9 (in SVC mode) |
| * |
| */ |
| typedef enum vp9e_temporal_layering_mode { |
| /*!\brief No temporal layering. |
| * Used when only spatial layering is used. |
| */ |
| VP9E_TEMPORAL_LAYERING_MODE_NOLAYERING = 0, |
| |
| /*!\brief Bypass mode. |
| * Used when application needs to control temporal layering. |
| * This will only work when the number of spatial layers equals 1. |
| */ |
| VP9E_TEMPORAL_LAYERING_MODE_BYPASS = 1, |
| |
| /*!\brief 0-1-0-1... temporal layering scheme with two temporal layers. |
| */ |
| VP9E_TEMPORAL_LAYERING_MODE_0101 = 2, |
| |
| /*!\brief 0-2-1-2... temporal layering scheme with three temporal layers. |
| */ |
| VP9E_TEMPORAL_LAYERING_MODE_0212 = 3 |
| } VP9E_TEMPORAL_LAYERING_MODE; |
| |
| /*!\brief vpx region of interest map |
| * |
| * These defines the data structures for the region of interest map |
| * |
| */ |
| |
| typedef struct vpx_roi_map { |
| /*! If ROI is enabled. */ |
| uint8_t enabled; |
| /*! An id between 0-3 (0-7 for vp9) for each 16x16 (8x8 for VP9) |
| * region within a frame. */ |
| unsigned char *roi_map; |
| unsigned int rows; /**< Number of rows. */ |
| unsigned int cols; /**< Number of columns. */ |
| /*! VP8 only uses the first 4 segments. VP9 uses 8 segments. */ |
| int delta_q[8]; /**< Quantizer deltas. */ |
| int delta_lf[8]; /**< Loop filter deltas. */ |
| /*! skip and ref frame segment is only used in VP9. */ |
| int skip[8]; /**< Skip this block. */ |
| int ref_frame[8]; /**< Reference frame for this block. */ |
| /*! Static breakout threshold for each segment. Only used in VP8. */ |
| unsigned int static_threshold[4]; |
| } vpx_roi_map_t; |
| |
| /*!\brief vpx active region map |
| * |
| * These defines the data structures for active region map |
| * |
| */ |
| |
| typedef struct vpx_active_map { |
| /*!\brief specify an on (1) or off (0) each 16x16 region within a frame */ |
| unsigned char *active_map; |
| unsigned int rows; /**< number of rows */ |
| unsigned int cols; /**< number of cols */ |
| } vpx_active_map_t; |
| |
| /*!\brief vpx image scaling mode |
| * |
| * This defines the data structure for image scaling mode |
| * |
| */ |
| typedef struct vpx_scaling_mode { |
| VPX_SCALING_MODE h_scaling_mode; /**< horizontal scaling mode */ |
| VPX_SCALING_MODE v_scaling_mode; /**< vertical scaling mode */ |
| } vpx_scaling_mode_t; |
| |
| /*!\brief VP8 token partition mode |
| * |
| * This defines VP8 partitioning mode for compressed data, i.e., the number of |
| * sub-streams in the bitstream. Used for parallelized decoding. |
| * |
| */ |
| |
| typedef enum { |
| VP8_ONE_TOKENPARTITION = 0, |
| VP8_TWO_TOKENPARTITION = 1, |
| VP8_FOUR_TOKENPARTITION = 2, |
| VP8_EIGHT_TOKENPARTITION = 3 |
| } vp8e_token_partitions; |
| |
| /*!brief VP9 encoder content type */ |
| typedef enum { |
| VP9E_CONTENT_DEFAULT, |
| VP9E_CONTENT_SCREEN, |
| VP9E_CONTENT_FILM, |
| VP9E_CONTENT_INVALID |
| } vp9e_tune_content; |
| |
| /*!\brief VP8 model tuning parameters |
| * |
| * Changes the encoder to tune for certain types of input material. |
| * |
| */ |
| typedef enum { VP8_TUNE_PSNR, VP8_TUNE_SSIM } vp8e_tuning; |
| |
| /*!\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. |
| * |
| */ |
| typedef struct vpx_svc_layer_id { |
| int spatial_layer_id; /**< First spatial layer to start encoding. */ |
| // TODO(jianj): Deprecated, to be removed. |
| int temporal_layer_id; /**< Temporal layer id number. */ |
| int temporal_layer_id_per_spatial[VPX_SS_MAX_LAYERS]; /**< Temp layer id. */ |
| } vpx_svc_layer_id_t; |
| |
| /*!\brief vp9 svc frame flag parameters. |
| * |
| * This defines the frame flags and buffer indices for each spatial layer for |
| * svc encoding. |
| * This is used with the #VP9E_SET_SVC_REF_FRAME_CONFIG control to set frame |
| * flags and buffer indices for each spatial layer for the current (super)frame. |
| * |
| */ |
| typedef struct vpx_svc_ref_frame_config { |
| int lst_fb_idx[VPX_SS_MAX_LAYERS]; /**< Last buffer index. */ |
| int gld_fb_idx[VPX_SS_MAX_LAYERS]; /**< Golden buffer index. */ |
| int alt_fb_idx[VPX_SS_MAX_LAYERS]; /**< Altref buffer index. */ |
| int update_buffer_slot[VPX_SS_MAX_LAYERS]; /**< Update reference frames. */ |
| // TODO(jianj): Remove update_last/golden/alt_ref, these are deprecated. |
| int update_last[VPX_SS_MAX_LAYERS]; /**< Update last. */ |
| int update_golden[VPX_SS_MAX_LAYERS]; /**< Update golden. */ |
| int update_alt_ref[VPX_SS_MAX_LAYERS]; /**< Update altref. */ |
| int reference_last[VPX_SS_MAX_LAYERS]; /**< Last as reference. */ |
| int reference_golden[VPX_SS_MAX_LAYERS]; /**< Golden as reference. */ |
| int reference_alt_ref[VPX_SS_MAX_LAYERS]; /**< Altref as reference. */ |
| int64_t duration[VPX_SS_MAX_LAYERS]; /**< Duration per spatial layer. */ |
| } vpx_svc_ref_frame_config_t; |
| |
| /*!\brief VP9 svc frame dropping mode. |
| * |
| * This defines the frame drop mode for SVC. |
| * |
| */ |
| typedef enum { |
| CONSTRAINED_LAYER_DROP, |
| /**< Upper layers are constrained to drop if current layer drops. */ |
| LAYER_DROP, /**< Any spatial layer can drop. */ |
| FULL_SUPERFRAME_DROP, /**< Only full superframe can drop. */ |
| CONSTRAINED_FROM_ABOVE_DROP, |
| /**< Lower layers are constrained to drop if current layer drops. */ |
| } SVC_LAYER_DROP_MODE; |
| |
| /*!\brief vp9 svc frame dropping parameters. |
| * |
| * This defines the frame drop thresholds for each spatial layer, and |
| * the frame dropping mode: 0 = layer based frame dropping (default), |
| * 1 = constrained dropping where current layer drop forces all upper |
| * spatial layers to drop. |
| */ |
| typedef struct vpx_svc_frame_drop { |
| int framedrop_thresh[VPX_SS_MAX_LAYERS]; /**< Frame drop thresholds */ |
| SVC_LAYER_DROP_MODE |
| framedrop_mode; /**< Layer-based or constrained dropping. */ |
| int max_consec_drop; /**< Maximum consecutive drops, for any layer. */ |
| } vpx_svc_frame_drop_t; |
| |
| /*!\brief vp9 svc spatial layer sync parameters. |
| * |
| * This defines the spatial layer sync flag, defined per spatial layer. |
| * |
| */ |
| typedef struct vpx_svc_spatial_layer_sync { |
| int spatial_layer_sync[VPX_SS_MAX_LAYERS]; /**< Sync layer flags */ |
| int base_layer_intra_only; /**< Flag for setting Intra-only frame on base */ |
| } vpx_svc_spatial_layer_sync_t; |
| |
| /*!\cond */ |
| /*!\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 |
| * |
| */ |
| |
| VPX_CTRL_USE_TYPE(VP8E_SET_FRAME_FLAGS, int) |
| #define VPX_CTRL_VP8E_SET_FRAME_FLAGS |
| VPX_CTRL_USE_TYPE(VP8E_SET_TEMPORAL_LAYER_ID, int) |
| #define VPX_CTRL_VP8E_SET_TEMPORAL_LAYER_ID |
| VPX_CTRL_USE_TYPE(VP8E_SET_ROI_MAP, vpx_roi_map_t *) |
| #define VPX_CTRL_VP8E_SET_ROI_MAP |
| VPX_CTRL_USE_TYPE(VP9E_SET_ROI_MAP, vpx_roi_map_t *) |
| #define VPX_CTRL_VP9E_SET_ROI_MAP |
| VPX_CTRL_USE_TYPE(VP8E_SET_ACTIVEMAP, vpx_active_map_t *) |
| #define VPX_CTRL_VP8E_SET_ACTIVEMAP |
| VPX_CTRL_USE_TYPE(VP8E_SET_SCALEMODE, vpx_scaling_mode_t *) |
| #define VPX_CTRL_VP8E_SET_SCALEMODE |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_SVC, int) |
| #define VPX_CTRL_VP9E_SET_SVC |
| VPX_CTRL_USE_TYPE(VP9E_SET_SVC_PARAMETERS, void *) |
| #define VPX_CTRL_VP9E_SET_SVC_PARAMETERS |
| VPX_CTRL_USE_TYPE(VP9E_REGISTER_CX_CALLBACK, void *) |
| #define VPX_CTRL_VP9E_REGISTER_CX_CALLBACK |
| VPX_CTRL_USE_TYPE(VP9E_SET_SVC_LAYER_ID, vpx_svc_layer_id_t *) |
| #define VPX_CTRL_VP9E_SET_SVC_LAYER_ID |
| |
| VPX_CTRL_USE_TYPE(VP8E_SET_CPUUSED, int) |
| #define VPX_CTRL_VP8E_SET_CPUUSED |
| VPX_CTRL_USE_TYPE(VP8E_SET_ENABLEAUTOALTREF, unsigned int) |
| #define VPX_CTRL_VP8E_SET_ENABLEAUTOALTREF |
| VPX_CTRL_USE_TYPE(VP8E_SET_NOISE_SENSITIVITY, unsigned int) |
| #define VPX_CTRL_VP8E_SET_NOISE_SENSITIVITY |
| VPX_CTRL_USE_TYPE(VP8E_SET_SHARPNESS, unsigned int) |
| #define VPX_CTRL_VP8E_SET_SHARPNESS |
| VPX_CTRL_USE_TYPE(VP8E_SET_STATIC_THRESHOLD, unsigned int) |
| #define VPX_CTRL_VP8E_SET_STATIC_THRESHOLD |
| VPX_CTRL_USE_TYPE(VP8E_SET_TOKEN_PARTITIONS, int) /* vp8e_token_partitions */ |
| #define VPX_CTRL_VP8E_SET_TOKEN_PARTITIONS |
| |
| VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_MAXFRAMES, unsigned int) |
| #define VPX_CTRL_VP8E_SET_ARNR_MAXFRAMES |
| VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_STRENGTH, unsigned int) |
| #define VPX_CTRL_VP8E_SET_ARNR_STRENGTH |
| VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_SET_ARNR_TYPE, unsigned int) |
| #define VPX_CTRL_VP8E_SET_ARNR_TYPE |
| VPX_CTRL_USE_TYPE(VP8E_SET_TUNING, int) /* vp8e_tuning */ |
| #define VPX_CTRL_VP8E_SET_TUNING |
| VPX_CTRL_USE_TYPE(VP8E_SET_CQ_LEVEL, unsigned int) |
| #define VPX_CTRL_VP8E_SET_CQ_LEVEL |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_TILE_COLUMNS, int) |
| #define VPX_CTRL_VP9E_SET_TILE_COLUMNS |
| VPX_CTRL_USE_TYPE(VP9E_SET_TILE_ROWS, int) |
| #define VPX_CTRL_VP9E_SET_TILE_ROWS |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_TPL, int) |
| #define VPX_CTRL_VP9E_SET_TPL |
| |
| VPX_CTRL_USE_TYPE(VP8E_GET_LAST_QUANTIZER, int *) |
| #define VPX_CTRL_VP8E_GET_LAST_QUANTIZER |
| VPX_CTRL_USE_TYPE(VP8E_GET_LAST_QUANTIZER_64, int *) |
| #define VPX_CTRL_VP8E_GET_LAST_QUANTIZER_64 |
| VPX_CTRL_USE_TYPE(VP9E_GET_SVC_LAYER_ID, vpx_svc_layer_id_t *) |
| #define VPX_CTRL_VP9E_GET_SVC_LAYER_ID |
| |
| VPX_CTRL_USE_TYPE(VP8E_SET_MAX_INTRA_BITRATE_PCT, unsigned int) |
| #define VPX_CTRL_VP8E_SET_MAX_INTRA_BITRATE_PCT |
| VPX_CTRL_USE_TYPE(VP9E_SET_MAX_INTER_BITRATE_PCT, unsigned int) |
| #define VPX_CTRL_VP9E_SET_MAX_INTER_BITRATE_PCT |
| |
| VPX_CTRL_USE_TYPE(VP8E_SET_GF_CBR_BOOST_PCT, unsigned int) |
| #define VPX_CTRL_VP8E_SET_GF_CBR_BOOST_PCT |
| |
| VPX_CTRL_USE_TYPE(VP8E_SET_SCREEN_CONTENT_MODE, unsigned int) |
| #define VPX_CTRL_VP8E_SET_SCREEN_CONTENT_MODE |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_GF_CBR_BOOST_PCT, unsigned int) |
| #define VPX_CTRL_VP9E_SET_GF_CBR_BOOST_PCT |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_LOSSLESS, unsigned int) |
| #define VPX_CTRL_VP9E_SET_LOSSLESS |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_FRAME_PARALLEL_DECODING, unsigned int) |
| #define VPX_CTRL_VP9E_SET_FRAME_PARALLEL_DECODING |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_AQ_MODE, unsigned int) |
| #define VPX_CTRL_VP9E_SET_AQ_MODE |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_ALT_REF_AQ, int) |
| #define VPX_CTRL_VP9E_SET_ALT_REF_AQ |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_FRAME_PERIODIC_BOOST, unsigned int) |
| #define VPX_CTRL_VP9E_SET_FRAME_PERIODIC_BOOST |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_NOISE_SENSITIVITY, unsigned int) |
| #define VPX_CTRL_VP9E_SET_NOISE_SENSITIVITY |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_TUNE_CONTENT, int) /* vp9e_tune_content */ |
| #define VPX_CTRL_VP9E_SET_TUNE_CONTENT |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_COLOR_SPACE, int) |
| #define VPX_CTRL_VP9E_SET_COLOR_SPACE |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_MIN_GF_INTERVAL, unsigned int) |
| #define VPX_CTRL_VP9E_SET_MIN_GF_INTERVAL |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_MAX_GF_INTERVAL, unsigned int) |
| #define VPX_CTRL_VP9E_SET_MAX_GF_INTERVAL |
| |
| VPX_CTRL_USE_TYPE(VP9E_GET_ACTIVEMAP, vpx_active_map_t *) |
| #define VPX_CTRL_VP9E_GET_ACTIVEMAP |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_COLOR_RANGE, int) |
| #define VPX_CTRL_VP9E_SET_COLOR_RANGE |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_SVC_REF_FRAME_CONFIG, vpx_svc_ref_frame_config_t *) |
| #define VPX_CTRL_VP9E_SET_SVC_REF_FRAME_CONFIG |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_RENDER_SIZE, int *) |
| #define VPX_CTRL_VP9E_SET_RENDER_SIZE |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_TARGET_LEVEL, unsigned int) |
| #define VPX_CTRL_VP9E_SET_TARGET_LEVEL |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_ROW_MT, unsigned int) |
| #define VPX_CTRL_VP9E_SET_ROW_MT |
| |
| VPX_CTRL_USE_TYPE(VP9E_GET_LEVEL, int *) |
| #define VPX_CTRL_VP9E_GET_LEVEL |
| |
| VPX_CTRL_USE_TYPE(VP9E_ENABLE_MOTION_VECTOR_UNIT_TEST, unsigned int) |
| #define VPX_CTRL_VP9E_ENABLE_MOTION_VECTOR_UNIT_TEST |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_SVC_INTER_LAYER_PRED, unsigned int) |
| #define VPX_CTRL_VP9E_SET_SVC_INTER_LAYER_PRED |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_SVC_FRAME_DROP_LAYER, vpx_svc_frame_drop_t *) |
| #define VPX_CTRL_VP9E_SET_SVC_FRAME_DROP_LAYER |
| |
| VPX_CTRL_USE_TYPE(VP9E_GET_SVC_REF_FRAME_CONFIG, vpx_svc_ref_frame_config_t *) |
| #define VPX_CTRL_VP9E_GET_SVC_REF_FRAME_CONFIG |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_SVC_GF_TEMPORAL_REF, unsigned int) |
| #define VPX_CTRL_VP9E_SET_SVC_GF_TEMPORAL_REF |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_SVC_SPATIAL_LAYER_SYNC, |
| vpx_svc_spatial_layer_sync_t *) |
| #define VPX_CTRL_VP9E_SET_SVC_SPATIAL_LAYER_SYNC |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_POSTENCODE_DROP, unsigned int) |
| #define VPX_CTRL_VP9E_SET_POSTENCODE_DROP |
| |
| VPX_CTRL_USE_TYPE(VP9E_SET_DELTA_Q_UV, int) |
| #define VPX_CTRL_VP9E_SET_DELTA_Q_UV |
| |
| /*!\endcond */ |
| /*! @} - end defgroup vp8_encoder */ |
| #ifdef __cplusplus |
| } // extern "C" |
| #endif |
| |
| #endif // VPX_VPX_VP8CX_H_ |
