WebM Codec SDK
vp8cx.h
Go to the documentation of this file.
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_VPX_VP8CX_H_
11#define VPX_VPX_VP8CX_H_
12
18#include "./vp8.h"
19#include "./vpx_encoder.h"
20#include "./vpx_ext_ratectrl.h"
21
27#ifdef __cplusplus
28extern "C" {
29#endif
30
42
59
65/*
66 * Algorithm Flags
67 */
68
75#define VP8_EFLAG_NO_REF_LAST (1 << 16)
76
83#define VP8_EFLAG_NO_REF_GF (1 << 17)
84
91#define VP8_EFLAG_NO_REF_ARF (1 << 21)
92
98#define VP8_EFLAG_NO_UPD_LAST (1 << 18)
99
105#define VP8_EFLAG_NO_UPD_GF (1 << 22)
106
112#define VP8_EFLAG_NO_UPD_ARF (1 << 23)
113
119#define VP8_EFLAG_FORCE_GF (1 << 19)
120
126#define VP8_EFLAG_FORCE_ARF (1 << 24)
127
133#define VP8_EFLAG_NO_UPD_ENTROPY (1 << 20)
134
148
154
160
174
183
192
201
207
213
221
230
236
242
245
251
261
276
282
297
312
323
331
346
370
390
404
417
432
440
449
455
463
472
482
490
498
513
521
529
535
544
552
560
569
577
583
593
608
617
626
635
642
652
667
675
685
693
701
710
720
734
740
750
761
771};
772
778 VP8E_NORMAL = 0,
779 VP8E_FOURFIVE = 1,
780 VP8E_THREEFIVE = 2,
781 VP8E_ONETWO = 3
783
810
817typedef struct vpx_roi_map {
819 uint8_t enabled;
822 unsigned char *roi_map;
823 unsigned int rows;
824 unsigned int cols;
826 int delta_q[8];
827 int delta_lf[8];
829 int skip[8];
830 int ref_frame[8];
832 unsigned int static_threshold[4];
834
841typedef struct vpx_active_map {
843 unsigned char *active_map;
844 unsigned int rows;
845 unsigned int cols;
847
857
865typedef enum {
866 VP8_ONE_TOKENPARTITION = 0,
867 VP8_TWO_TOKENPARTITION = 1,
868 VP8_FOUR_TOKENPARTITION = 2,
869 VP8_EIGHT_TOKENPARTITION = 3
871
873typedef enum {
874 VP9E_CONTENT_DEFAULT,
875 VP9E_CONTENT_SCREEN,
876 VP9E_CONTENT_FILM,
877 VP9E_CONTENT_INVALID
879
885typedef enum { VP8_TUNE_PSNR, VP8_TUNE_SSIM } vp8e_tuning;
886
900
923
937
951
961
971#define VPX_CTRL_VP8E_SET_ROI_MAP
973#define VPX_CTRL_VP8E_SET_ACTIVEMAP
975#define VPX_CTRL_VP8E_SET_SCALEMODE
977#define VPX_CTRL_VP8E_SET_CPUUSED
979#define VPX_CTRL_VP8E_SET_ENABLEAUTOALTREF
981#define VPX_CTRL_VP8E_SET_NOISE_SENSITIVITY
983#define VPX_CTRL_VP8E_SET_SHARPNESS
985#define VPX_CTRL_VP8E_SET_STATIC_THRESHOLD
986VPX_CTRL_USE_TYPE(VP8E_SET_TOKEN_PARTITIONS, int) /* vp8e_token_partitions */
987#define VPX_CTRL_VP8E_SET_TOKEN_PARTITIONS
989#define VPX_CTRL_VP8E_GET_LAST_QUANTIZER
991#define VPX_CTRL_VP8E_GET_LAST_QUANTIZER_64
993#define VPX_CTRL_VP8E_SET_ARNR_MAXFRAMES
995#define VPX_CTRL_VP8E_SET_ARNR_STRENGTH
997#define VPX_CTRL_VP8E_SET_ARNR_TYPE
998VPX_CTRL_USE_TYPE(VP8E_SET_TUNING, int) /* vp8e_tuning */
999#define VPX_CTRL_VP8E_SET_TUNING
1001#define VPX_CTRL_VP8E_SET_CQ_LEVEL
1003#define VPX_CTRL_VP8E_SET_MAX_INTRA_BITRATE_PCT
1005#define VPX_CTRL_VP8E_SET_FRAME_FLAGS
1007#define VPX_CTRL_VP9E_SET_MAX_INTER_BITRATE_PCT
1009#define VPX_CTRL_VP9E_SET_GF_CBR_BOOST_PCT
1011#define VPX_CTRL_VP8E_SET_TEMPORAL_LAYER_ID
1013#define VPX_CTRL_VP8E_SET_SCREEN_CONTENT_MODE
1015#define VPX_CTRL_VP9E_SET_LOSSLESS
1017#define VPX_CTRL_VP9E_SET_TILE_COLUMNS
1019#define VPX_CTRL_VP9E_SET_TILE_ROWS
1021#define VPX_CTRL_VP9E_SET_FRAME_PARALLEL_DECODING
1023#define VPX_CTRL_VP9E_SET_AQ_MODE
1025#define VPX_CTRL_VP9E_SET_FRAME_PERIODIC_BOOST
1027#define VPX_CTRL_VP9E_SET_NOISE_SENSITIVITY
1029#define VPX_CTRL_VP9E_SET_SVC
1031#define VPX_CTRL_VP9E_SET_ROI_MAP
1033#define VPX_CTRL_VP9E_SET_SVC_PARAMETERS
1035#define VPX_CTRL_VP9E_SET_SVC_LAYER_ID
1036VPX_CTRL_USE_TYPE(VP9E_SET_TUNE_CONTENT, int) /* vp9e_tune_content */
1037#define VPX_CTRL_VP9E_SET_TUNE_CONTENT
1039#define VPX_CTRL_VP9E_GET_SVC_LAYER_ID
1041#define VPX_CTRL_VP9E_REGISTER_CX_CALLBACK
1043#define VPX_CTRL_VP9E_SET_COLOR_SPACE
1045#define VPX_CTRL_VP9E_SET_MIN_GF_INTERVAL
1047#define VPX_CTRL_VP9E_SET_MAX_GF_INTERVAL
1049#define VPX_CTRL_VP9E_GET_ACTIVEMAP
1051#define VPX_CTRL_VP9E_SET_COLOR_RANGE
1053#define VPX_CTRL_VP9E_SET_SVC_REF_FRAME_CONFIG
1055#define VPX_CTRL_VP9E_SET_RENDER_SIZE
1057#define VPX_CTRL_VP9E_SET_TARGET_LEVEL
1059#define VPX_CTRL_VP9E_SET_ROW_MT
1061#define VPX_CTRL_VP9E_GET_LEVEL
1063#define VPX_CTRL_VP9E_SET_ALT_REF_AQ
1065#define VPX_CTRL_VP8E_SET_GF_CBR_BOOST_PCT
1067#define VPX_CTRL_VP9E_ENABLE_MOTION_VECTOR_UNIT_TEST
1069#define VPX_CTRL_VP9E_SET_SVC_INTER_LAYER_PRED
1071#define VPX_CTRL_VP9E_SET_SVC_FRAME_DROP_LAYER
1073#define VPX_CTRL_VP9E_GET_SVC_REF_FRAME_CONFIG
1075#define VPX_CTRL_VP9E_SET_SVC_GF_TEMPORAL_REF
1078#define VPX_CTRL_VP9E_SET_SVC_SPATIAL_LAYER_SYNC
1080#define VPX_CTRL_VP9E_SET_TPL
1082#define VPX_CTRL_VP9E_SET_POSTENCODE_DROP
1084#define VPX_CTRL_VP9E_SET_DELTA_Q_UV
1086#define VPX_CTRL_VP9E_SET_DISABLE_OVERSHOOT_MAXQ_CBR
1088#define VPX_CTRL_VP9E_SET_DISABLE_LOOPFILTER
1090#define VPX_CTRL_VP9E_SET_EXTERNAL_RATE_CONTROL
1092#define VPX_CTRL_VP9E_SET_RTC_EXTERNAL_RATECTRL
1094#define VPX_CTRL_VP9E_GET_LOOPFILTER_LEVEL
1096#define VPX_CTRL_VP9E_GET_LAST_QUANTIZER_SVC_LAYERS
1098#define VPX_CTRL_VP8E_SET_RTC_EXTERNAL_RATECTRL
1100#define VPX_CTRL_VP9E_SET_QUANTIZER_ONE_PASS
1101
1104#ifdef __cplusplus
1105} // extern "C"
1106#endif
1107
1108#endif // VPX_VPX_VP8CX_H_
#define VPX_CTRL_USE_TYPE_DEPRECATED(id, typ)
vpx_codec_control deprecated type definition macro
Definition vpx_codec.h:441
#define VPX_CTRL_USE_TYPE(id, typ)
vpx_codec_control type definition macro
Definition vpx_codec.h:422
const struct vpx_codec_iface vpx_codec_iface_t
Codec interface structure.
Definition vpx_codec.h:177
#define VPX_SS_MAX_LAYERS
Definition vpx_encoder.h:48
struct vpx_active_map vpx_active_map_t
vpx active region map
vpx_codec_iface_t * vpx_codec_vp9_cx(void)
The interface to the VP9 encoder.
struct vpx_svc_layer_id vpx_svc_layer_id_t
vp9 svc layer parameters
vpx_codec_iface_t vpx_codec_vp9_cx_algo
A single instance of the VP9 encoder.
SVC_LAYER_DROP_MODE
VP9 svc frame dropping mode.
Definition vp8cx.h:929
vp8e_tuning
VP8 model tuning parameters.
Definition vp8cx.h:885
enum vp9e_temporal_layering_mode VP9E_TEMPORAL_LAYERING_MODE
Temporal layering mode enum for VP9 SVC.
struct vpx_scaling_mode vpx_scaling_mode_t
vpx image scaling mode
vp8e_token_partitions
VP8 token partition mode.
Definition vp8cx.h:865
vpx_codec_iface_t vpx_codec_vp8_cx_algo
A single instance of the VP8 encoder.
vp8e_enc_control_id
VPx encoder control functions.
Definition vp8cx.h:142
vpx_codec_iface_t * vpx_codec_vp8_cx(void)
The interface to the VP8 encoder.
vpx_scaling_mode_1d
vpx 1-D scaling mode
Definition vp8cx.h:777
vp9e_tune_content
Definition vp8cx.h:873
struct vpx_roi_map vpx_roi_map_t
vpx region of interest map
struct vpx_svc_ref_frame_config vpx_svc_ref_frame_config_t
vp9 svc frame flag parameters.
vp9e_temporal_layering_mode
Temporal layering mode enum for VP9 SVC.
Definition vp8cx.h:790
struct vpx_svc_frame_drop vpx_svc_frame_drop_t
vp9 svc frame dropping parameters.
enum vpx_scaling_mode_1d VPX_SCALING_MODE
vpx 1-D scaling mode
struct vpx_svc_spatial_layer_sync vpx_svc_spatial_layer_sync_t
vp9 svc spatial layer sync parameters.
@ CONSTRAINED_FROM_ABOVE_DROP
Definition vp8cx.h:934
@ FULL_SUPERFRAME_DROP
Definition vp8cx.h:933
@ CONSTRAINED_LAYER_DROP
Definition vp8cx.h:930
@ LAYER_DROP
Definition vp8cx.h:932
@ VP9E_SET_MIN_GF_INTERVAL
Codec control function to set minimum interval between GF/ARF frames.
Definition vp8cx.h:520
@ VP9E_SET_MAX_INTER_BITRATE_PCT
Codec control function to set max data rate for Inter frames.
Definition vp8cx.h:296
@ VP9E_SET_FRAME_PERIODIC_BOOST
Codec control function to enable/disable periodic Q boost.
Definition vp8cx.h:431
@ VP9E_SET_SVC_LAYER_ID
Codec control function to set svc layer for spatial and temporal.
Definition vp8cx.h:471
@ VP8E_SET_MAX_INTRA_BITRATE_PCT
Codec control function to set Max data rate for Intra frames.
Definition vp8cx.h:275
@ VP8E_SET_ARNR_STRENGTH
Codec control function to set the filter strength for the arf.
Definition vp8cx.h:241
@ VP8E_SET_TUNING
Codec control function to set visual tuning.
Definition vp8cx.h:250
@ VP9E_SET_SVC_INTER_LAYER_PRED
Codec control function to constrain the inter-layer prediction (prediction of lower spatial resolutio...
Definition vp8cx.h:625
@ VP9E_SET_ROI_MAP
Codec control function to pass an ROI map to encoder.
Definition vp8cx.h:454
@ VP9E_GET_LOOPFILTER_LEVEL
Codec control function to get loopfilter level in the encoder.
Definition vp8cx.h:739
@ VP8E_SET_ENABLEAUTOALTREF
Codec control function to enable automatic use of arf frames.
Definition vp8cx.h:182
@ VP8E_SET_ROI_MAP
Codec control function to pass an ROI map to encoder.
Definition vp8cx.h:147
@ VP8E_SET_RTC_EXTERNAL_RATECTRL
Codec control to disable internal features in rate control.
Definition vp8cx.h:760
@ VP9E_SET_TARGET_LEVEL
Codec control function to set target level.
Definition vp8cx.h:568
@ VP9E_GET_LEVEL
Codec control function to get bitstream level.
Definition vp8cx.h:582
@ VP9E_ENABLE_MOTION_VECTOR_UNIT_TEST
Codec control function to enable the extreme motion vector unit test in VP9. Please note that this is...
Definition vp8cx.h:616
@ VP9E_SET_AQ_MODE
Codec control function to set adaptive quantization mode.
Definition vp8cx.h:416
@ VP9E_GET_SVC_REF_FRAME_CONFIG
Codec control function to get the refresh and reference flags and the buffer indices,...
Definition vp8cx.h:641
@ VP9E_SET_SVC_GF_TEMPORAL_REF
Codec control function to enable/disable use of golden reference as a second temporal reference for S...
Definition vp8cx.h:651
@ VP8E_SET_NOISE_SENSITIVITY
control function to set noise sensitivity
Definition vp8cx.h:191
@ VP8E_SET_TOKEN_PARTITIONS
Codec control function to set the number of token partitions.
Definition vp8cx.h:212
@ VP9E_SET_POSTENCODE_DROP
Codec control function to enable postencode frame drop.
Definition vp8cx.h:684
@ VP9E_REGISTER_CX_CALLBACK
Codec control function to register callback to get per layer packet.
Definition vp8cx.h:497
@ VP8E_SET_ARNR_TYPE
Definition vp8cx.h:244
@ VP9E_SET_COLOR_RANGE
Codec control function to set color range bit.
Definition vp8cx.h:543
@ VP8E_GET_LAST_QUANTIZER
Codec control function to get last quantizer chosen by the encoder.
Definition vp8cx.h:220
@ VP9E_SET_TILE_ROWS
Codec control function to set number of tile rows.
Definition vp8cx.h:389
@ VP8E_SET_ARNR_MAXFRAMES
Codec control function to set the max no of frames to create arf.
Definition vp8cx.h:235
@ VP8E_SET_ACTIVEMAP
Codec control function to pass an Active map to encoder.
Definition vp8cx.h:153
@ VP9E_SET_LOSSLESS
Codec control function to set lossless encoding mode.
Definition vp8cx.h:345
@ VP9E_SET_DISABLE_OVERSHOOT_MAXQ_CBR
Codec control function to disable increase Q on overshoot in CBR.
Definition vp8cx.h:700
@ VP9E_SET_SVC_SPATIAL_LAYER_SYNC
Codec control function to enable spatial layer sync frame, for any spatial layer. Enabling it for lay...
Definition vp8cx.h:666
@ VP9E_SET_SVC_PARAMETERS
Codec control function to set parameters for SVC.
Definition vp8cx.h:462
@ VP8E_SET_SCALEMODE
Codec control function to set encoder scaling mode.
Definition vp8cx.h:159
@ VP9E_SET_FRAME_PARALLEL_DECODING
Codec control function to enable frame parallel decoding feature.
Definition vp8cx.h:403
@ VP8E_SET_SHARPNESS
Codec control function to set higher sharpness at the expense of a lower PSNR.
Definition vp8cx.h:200
@ VP8E_SET_GF_CBR_BOOST_PCT
Boost percentage for Golden Frame in CBR mode.
Definition vp8cx.h:607
@ VP9E_SET_TUNE_CONTENT
Codec control function to set content type.
Definition vp8cx.h:481
@ VP9E_SET_SVC
Codec control function to turn on/off SVC in encoder.
Definition vp8cx.h:448
@ VP9E_SET_TPL
Codec control function to enable temporal dependency model.
Definition vp8cx.h:674
@ VP9E_SET_ROW_MT
Codec control function to set row level multi-threading.
Definition vp8cx.h:576
@ VP8E_SET_CPUUSED
Codec control function to set encoder internal speed settings.
Definition vp8cx.h:173
@ VP8E_SET_TEMPORAL_LAYER_ID
Codec control function to set the temporal layer id.
Definition vp8cx.h:322
@ VP9E_SET_TILE_COLUMNS
Codec control function to set number of tile columns.
Definition vp8cx.h:369
@ VP9E_SET_SVC_FRAME_DROP_LAYER
Codec control function to set mode and thresholds for frame dropping in SVC. Drop frame thresholds ar...
Definition vp8cx.h:634
@ VP9E_SET_SVC_REF_FRAME_CONFIG
Codec control function to set the frame flags and buffer indices for spatial layers....
Definition vp8cx.h:551
@ VP8E_SET_STATIC_THRESHOLD
Codec control function to set the threshold for MBs treated static.
Definition vp8cx.h:206
@ VP9E_SET_COLOR_SPACE
Codec control function to set color space info.
Definition vp8cx.h:512
@ VP9E_GET_LAST_QUANTIZER_SVC_LAYERS
Codec control to get last quantizers for all spatial layers.
Definition vp8cx.h:749
@ VP9E_SET_RENDER_SIZE
Codec control function to set intended rendering image size.
Definition vp8cx.h:559
@ VP8E_SET_SCREEN_CONTENT_MODE
Codec control function to set encoder screen content mode.
Definition vp8cx.h:330
@ VP9E_SET_DISABLE_LOOPFILTER
Codec control function to disable loopfilter.
Definition vp8cx.h:709
@ VP8E_SET_CQ_LEVEL
Codec control function to set constrained / constant quality level.
Definition vp8cx.h:260
@ VP9E_SET_NOISE_SENSITIVITY
Codec control function to set noise sensitivity.
Definition vp8cx.h:439
@ VP8E_GET_LAST_QUANTIZER_64
Codec control function to get last quantizer chosen by the encoder.
Definition vp8cx.h:229
@ VP9E_SET_QUANTIZER_ONE_PASS
Codec control to set quantizer for the next frame.
Definition vp8cx.h:770
@ VP8E_SET_FRAME_FLAGS
Codec control function to set reference and update frame flags.
Definition vp8cx.h:281
@ VP9E_GET_ACTIVEMAP
Codec control function to get an Active map back from the encoder.
Definition vp8cx.h:534
@ VP9E_SET_GF_CBR_BOOST_PCT
Boost percentage for Golden Frame in CBR mode.
Definition vp8cx.h:311
@ VP9E_SET_RTC_EXTERNAL_RATECTRL
Codec control to disable internal features in rate control.
Definition vp8cx.h:733
@ VP9E_GET_SVC_LAYER_ID
Codec control function to get svc layer ID.
Definition vp8cx.h:489
@ VP9E_SET_EXTERNAL_RATE_CONTROL
Codec control function to enable external rate control library.
Definition vp8cx.h:719
@ VP9E_SET_MAX_GF_INTERVAL
Codec control function to set minimum interval between GF/ARF frames.
Definition vp8cx.h:528
@ VP9E_SET_ALT_REF_AQ
Codec control function to enable/disable special mode for altref adaptive quantization....
Definition vp8cx.h:592
@ VP9E_SET_DELTA_Q_UV
Codec control function to set delta q for uv.
Definition vp8cx.h:692
@ VP9E_TEMPORAL_LAYERING_MODE_BYPASS
Bypass mode. Used when application needs to control temporal layering. This will only work when the n...
Definition vp8cx.h:800
@ VP9E_TEMPORAL_LAYERING_MODE_0101
0-1-0-1... temporal layering scheme with two temporal layers.
Definition vp8cx.h:804
@ VP9E_TEMPORAL_LAYERING_MODE_NOLAYERING
No temporal layering. Used when only spatial layering is used.
Definition vp8cx.h:794
@ VP9E_TEMPORAL_LAYERING_MODE_0212
0-2-1-2... temporal layering scheme with three temporal layers.
Definition vp8cx.h:808
vpx active region map
Definition vp8cx.h:841
unsigned int rows
Definition vp8cx.h:844
unsigned int cols
Definition vp8cx.h:845
unsigned char * active_map
specify an on (1) or off (0) each 16x16 region within a frame
Definition vp8cx.h:843
Callback function set for external rate control.
Definition vpx_ext_ratectrl.h:511
vpx region of interest map
Definition vp8cx.h:817
uint8_t enabled
Definition vp8cx.h:819
int skip[8]
Definition vp8cx.h:829
unsigned int static_threshold[4]
Definition vp8cx.h:832
unsigned int rows
Definition vp8cx.h:823
unsigned int cols
Definition vp8cx.h:824
int ref_frame[8]
Definition vp8cx.h:830
int delta_q[8]
Definition vp8cx.h:826
unsigned char * roi_map
Definition vp8cx.h:822
int delta_lf[8]
Definition vp8cx.h:827
vpx image scaling mode
Definition vp8cx.h:853
VPX_SCALING_MODE v_scaling_mode
Definition vp8cx.h:855
VPX_SCALING_MODE h_scaling_mode
Definition vp8cx.h:854
vp9 svc frame dropping parameters.
Definition vp8cx.h:945
int framedrop_thresh[5]
Definition vp8cx.h:946
SVC_LAYER_DROP_MODE framedrop_mode
Definition vp8cx.h:948
int max_consec_drop
Definition vp8cx.h:949
vp9 svc layer parameters
Definition vp8cx.h:894
int temporal_layer_id
Definition vp8cx.h:897
int temporal_layer_id_per_spatial[5]
Definition vp8cx.h:898
int spatial_layer_id
Definition vp8cx.h:895
vp9 svc frame flag parameters.
Definition vp8cx.h:909
int lst_fb_idx[5]
Definition vp8cx.h:910
int update_alt_ref[5]
Definition vp8cx.h:917
int update_buffer_slot[5]
Definition vp8cx.h:913
int gld_fb_idx[5]
Definition vp8cx.h:911
int reference_last[5]
Definition vp8cx.h:918
int reference_golden[5]
Definition vp8cx.h:919
int update_last[5]
Definition vp8cx.h:915
int reference_alt_ref[5]
Definition vp8cx.h:920
int64_t duration[5]
Definition vp8cx.h:921
int alt_fb_idx[5]
Definition vp8cx.h:912
int update_golden[5]
Definition vp8cx.h:916
vp9 svc spatial layer sync parameters.
Definition vp8cx.h:957
int spatial_layer_sync[5]
Definition vp8cx.h:958
int base_layer_intra_only
Definition vp8cx.h:959
Provides controls common to both the VP8 encoder and decoder.
Describes the encoder algorithm interface to applications.