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 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29 
35 extern vpx_codec_iface_t vpx_codec_vp8_cx_algo;
36 extern vpx_codec_iface_t *vpx_codec_vp8_cx(void);
44 extern vpx_codec_iface_t vpx_codec_vp9_cx_algo;
45 extern vpx_codec_iface_t *vpx_codec_vp9_cx(void);
48 /*
49  * Algorithm Flags
50  */
51 
58 #define VP8_EFLAG_NO_REF_LAST (1 << 16)
59 
66 #define VP8_EFLAG_NO_REF_GF (1 << 17)
67 
74 #define VP8_EFLAG_NO_REF_ARF (1 << 21)
75 
81 #define VP8_EFLAG_NO_UPD_LAST (1 << 18)
82 
88 #define VP8_EFLAG_NO_UPD_GF (1 << 22)
89 
95 #define VP8_EFLAG_NO_UPD_ARF (1 << 23)
96 
102 #define VP8_EFLAG_FORCE_GF (1 << 19)
103 
109 #define VP8_EFLAG_FORCE_ARF (1 << 24)
110 
116 #define VP8_EFLAG_NO_UPD_ENTROPY (1 << 20)
117 
131 
137 
143 
156 
165 
174 
183 
189 
195 
203 
212 
218 
224 
227 
233 
243 
258 
264 
279 
294 
305 
313 
328 
352 
372 
386 
399 
414 
422 
431 
437 
445 
454 
464 
472 
480 
495 
507 
515 
523 
529 
538 
546 
554 
563 
571 
577 
587 
602 
611 
620 
629 
636 
646 
661 
669 
679 
687 };
688 
693 typedef enum vpx_scaling_mode_1d {
694  VP8E_NORMAL = 0,
695  VP8E_FOURFIVE = 1,
696  VP8E_THREEFIVE = 2,
697  VP8E_ONETWO = 3
699 
711 
717 
721 
726 
733 typedef struct vpx_roi_map {
735  uint8_t enabled;
738  unsigned char *roi_map;
739  unsigned int rows;
740  unsigned int cols;
742  int delta_q[8];
743  int delta_lf[8];
745  int skip[8];
746  int ref_frame[8];
748  unsigned int static_threshold[4];
750 
757 typedef struct vpx_active_map {
759  unsigned char *active_map;
760  unsigned int rows;
761  unsigned int cols;
763 
769 typedef struct vpx_scaling_mode {
773 
781 typedef enum {
782  VP8_ONE_TOKENPARTITION = 0,
783  VP8_TWO_TOKENPARTITION = 1,
784  VP8_FOUR_TOKENPARTITION = 2,
785  VP8_EIGHT_TOKENPARTITION = 3
787 
789 typedef enum {
790  VP9E_CONTENT_DEFAULT,
791  VP9E_CONTENT_SCREEN,
792  VP9E_CONTENT_FILM,
793  VP9E_CONTENT_INVALID
795 
801 typedef enum { VP8_TUNE_PSNR, VP8_TUNE_SSIM } vp8e_tuning;
802 
810 typedef struct vpx_svc_layer_id {
812  // TODO(jianj): Deprecated, to be removed.
816 
825 typedef struct vpx_svc_ref_frame_config {
830  // TODO(jianj): Remove update_last/golden/alt_ref, these are deprecated.
839 
845 typedef enum {
853 
861 typedef struct vpx_svc_frame_drop {
867 
877 
887 #define VPX_CTRL_VP8E_SET_FRAME_FLAGS
889 #define VPX_CTRL_VP8E_SET_TEMPORAL_LAYER_ID
891 #define VPX_CTRL_VP8E_SET_ROI_MAP
893 #define VPX_CTRL_VP9E_SET_ROI_MAP
895 #define VPX_CTRL_VP8E_SET_ACTIVEMAP
897 #define VPX_CTRL_VP8E_SET_SCALEMODE
898 
900 #define VPX_CTRL_VP9E_SET_SVC
902 #define VPX_CTRL_VP9E_SET_SVC_PARAMETERS
904 #define VPX_CTRL_VP9E_REGISTER_CX_CALLBACK
906 #define VPX_CTRL_VP9E_SET_SVC_LAYER_ID
907 
909 #define VPX_CTRL_VP8E_SET_CPUUSED
911 #define VPX_CTRL_VP8E_SET_ENABLEAUTOALTREF
913 #define VPX_CTRL_VP8E_SET_NOISE_SENSITIVITY
915 #define VPX_CTRL_VP8E_SET_SHARPNESS
917 #define VPX_CTRL_VP8E_SET_STATIC_THRESHOLD
918 VPX_CTRL_USE_TYPE(VP8E_SET_TOKEN_PARTITIONS, int) /* vp8e_token_partitions */
919 #define VPX_CTRL_VP8E_SET_TOKEN_PARTITIONS
920 
922 #define VPX_CTRL_VP8E_SET_ARNR_MAXFRAMES
924 #define VPX_CTRL_VP8E_SET_ARNR_STRENGTH
926 #define VPX_CTRL_VP8E_SET_ARNR_TYPE
927 VPX_CTRL_USE_TYPE(VP8E_SET_TUNING, int) /* vp8e_tuning */
928 #define VPX_CTRL_VP8E_SET_TUNING
930 #define VPX_CTRL_VP8E_SET_CQ_LEVEL
931 
933 #define VPX_CTRL_VP9E_SET_TILE_COLUMNS
935 #define VPX_CTRL_VP9E_SET_TILE_ROWS
936 
938 #define VPX_CTRL_VP9E_SET_TPL
939 
941 #define VPX_CTRL_VP8E_GET_LAST_QUANTIZER
943 #define VPX_CTRL_VP8E_GET_LAST_QUANTIZER_64
945 #define VPX_CTRL_VP9E_GET_SVC_LAYER_ID
946 
948 #define VPX_CTRL_VP8E_SET_MAX_INTRA_BITRATE_PCT
950 #define VPX_CTRL_VP9E_SET_MAX_INTER_BITRATE_PCT
951 
953 #define VPX_CTRL_VP8E_SET_GF_CBR_BOOST_PCT
954 
956 #define VPX_CTRL_VP8E_SET_SCREEN_CONTENT_MODE
957 
959 #define VPX_CTRL_VP9E_SET_GF_CBR_BOOST_PCT
960 
962 #define VPX_CTRL_VP9E_SET_LOSSLESS
963 
965 #define VPX_CTRL_VP9E_SET_FRAME_PARALLEL_DECODING
966 
967 VPX_CTRL_USE_TYPE(VP9E_SET_AQ_MODE, unsigned int)
968 #define VPX_CTRL_VP9E_SET_AQ_MODE
969 
971 #define VPX_CTRL_VP9E_SET_ALT_REF_AQ
972 
974 #define VPX_CTRL_VP9E_SET_FRAME_PERIODIC_BOOST
975 
977 #define VPX_CTRL_VP9E_SET_NOISE_SENSITIVITY
978 
979 VPX_CTRL_USE_TYPE(VP9E_SET_TUNE_CONTENT, int) /* vp9e_tune_content */
980 #define VPX_CTRL_VP9E_SET_TUNE_CONTENT
981 
983 #define VPX_CTRL_VP9E_SET_COLOR_SPACE
984 
986 #define VPX_CTRL_VP9E_SET_MIN_GF_INTERVAL
987 
989 #define VPX_CTRL_VP9E_SET_MAX_GF_INTERVAL
990 
992 #define VPX_CTRL_VP9E_GET_ACTIVEMAP
993 
995 #define VPX_CTRL_VP9E_SET_COLOR_RANGE
996 
998 #define VPX_CTRL_VP9E_SET_SVC_REF_FRAME_CONFIG
999 
1001 #define VPX_CTRL_VP9E_SET_RENDER_SIZE
1002 
1004 #define VPX_CTRL_VP9E_SET_TARGET_LEVEL
1005 
1006 VPX_CTRL_USE_TYPE(VP9E_SET_ROW_MT, unsigned int)
1007 #define VPX_CTRL_VP9E_SET_ROW_MT
1008 
1010 #define VPX_CTRL_VP9E_GET_LEVEL
1011 
1013 #define VPX_CTRL_VP9E_ENABLE_MOTION_VECTOR_UNIT_TEST
1014 
1016 #define VPX_CTRL_VP9E_SET_SVC_INTER_LAYER_PRED
1017 
1019 #define VPX_CTRL_VP9E_SET_SVC_FRAME_DROP_LAYER
1020 
1022 #define VPX_CTRL_VP9E_GET_SVC_REF_FRAME_CONFIG
1023 
1025 #define VPX_CTRL_VP9E_SET_SVC_GF_TEMPORAL_REF
1026 
1029 #define VPX_CTRL_VP9E_SET_SVC_SPATIAL_LAYER_SYNC
1030 
1032 #define VPX_CTRL_VP9E_SET_POSTENCODE_DROP
1033 
1035 #define VPX_CTRL_VP9E_SET_DELTA_Q_UV
1036 
1039 #ifdef __cplusplus
1040 } // extern "C"
1041 #endif
1042 
1043 #endif // VPX_VPX_VP8CX_H_
#define VPX_CTRL_USE_TYPE_DEPRECATED(id, typ)
vpx_codec_control deprecated type definition macro
Definition: vpx_codec.h:448
#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:46
struct vpx_active_map vpx_active_map_t
vpx active region map
struct vpx_svc_layer_id vpx_svc_layer_id_t
vp9 svc layer parameters
SVC_LAYER_DROP_MODE
VP9 svc frame dropping mode.
Definition: vp8cx.h:845
vp8e_tuning
VP8 model tuning parameters.
Definition: vp8cx.h:801
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:781
vp8e_enc_control_id
VPx encoder control functions.
Definition: vp8cx.h:125
vpx_scaling_mode_1d
vpx 1-D scaling mode
Definition: vp8cx.h:693
vp9e_tune_content
Definition: vp8cx.h:789
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:706
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:850
@ FULL_SUPERFRAME_DROP
Definition: vp8cx.h:849
@ CONSTRAINED_LAYER_DROP
Definition: vp8cx.h:846
@ LAYER_DROP
Definition: vp8cx.h:848
@ VP9E_SET_MIN_GF_INTERVAL
Codec control function to set minimum interval between GF/ARF frames.
Definition: vp8cx.h:514
@ VP9E_SET_MAX_INTER_BITRATE_PCT
Codec control function to set max data rate for Inter frames.
Definition: vp8cx.h:278
@ VP9E_SET_FRAME_PERIODIC_BOOST
Codec control function to enable/disable periodic Q boost.
Definition: vp8cx.h:413
@ VP9E_SET_SVC_LAYER_ID
Codec control function to set svc layer for spatial and temporal.
Definition: vp8cx.h:453
@ VP8E_SET_MAX_INTRA_BITRATE_PCT
Codec control function to set Max data rate for Intra frames.
Definition: vp8cx.h:257
@ VP8E_SET_ARNR_STRENGTH
Codec control function to set the filter strength for the arf.
Definition: vp8cx.h:223
@ VP8E_SET_TUNING
Codec control function to set visual tuning.
Definition: vp8cx.h:232
@ VP9E_SET_SVC_INTER_LAYER_PRED
Codec control function to constrain the inter-layer prediction (prediction of lower spatial resolutio...
Definition: vp8cx.h:619
@ VP9E_SET_ROI_MAP
Codec control function to pass an ROI map to encoder.
Definition: vp8cx.h:436
@ VP8E_SET_ENABLEAUTOALTREF
Codec control function to enable automatic use of arf frames.
Definition: vp8cx.h:164
@ VP8E_SET_ROI_MAP
Codec control function to pass an ROI map to encoder.
Definition: vp8cx.h:130
@ VP9E_SET_TARGET_LEVEL
Codec control function to set target level.
Definition: vp8cx.h:562
@ VP9E_GET_LEVEL
Codec control function to get bitstream level.
Definition: vp8cx.h:576
@ 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:610
@ VP9E_SET_TEMPORAL_LAYERING_MODE
Codec control function to set temporal layering mode.
Definition: vp8cx.h:506
@ VP9E_SET_AQ_MODE
Codec control function to set adaptive quantization mode.
Definition: vp8cx.h:398
@ VP9E_GET_SVC_REF_FRAME_CONFIG
Codec control function to get the refresh and reference flags and the buffer indices,...
Definition: vp8cx.h:635
@ 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:645
@ VP8E_SET_NOISE_SENSITIVITY
control function to set noise sensitivity
Definition: vp8cx.h:173
@ VP8E_SET_TOKEN_PARTITIONS
Codec control function to set the number of token partitions.
Definition: vp8cx.h:194
@ VP9E_SET_POSTENCODE_DROP
Codec control function to enable postencode frame drop.
Definition: vp8cx.h:678
@ VP9E_REGISTER_CX_CALLBACK
Codec control function to register callback to get per layer packet.
Definition: vp8cx.h:479
@ VP8E_SET_ARNR_TYPE
Definition: vp8cx.h:226
@ VP9E_SET_COLOR_RANGE
Codec control function to set color range bit.
Definition: vp8cx.h:537
@ VP8E_GET_LAST_QUANTIZER
Codec control function to get last quantizer chosen by the encoder.
Definition: vp8cx.h:202
@ VP9E_SET_TILE_ROWS
Codec control function to set number of tile rows.
Definition: vp8cx.h:371
@ VP8E_SET_ARNR_MAXFRAMES
Codec control function to set the max no of frames to create arf.
Definition: vp8cx.h:217
@ VP8E_SET_ACTIVEMAP
Codec control function to pass an Active map to encoder.
Definition: vp8cx.h:136
@ VP9E_SET_LOSSLESS
Codec control function to set lossless encoding mode.
Definition: vp8cx.h:327
@ 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:660
@ VP9E_SET_SVC_PARAMETERS
Codec control function to set parameters for SVC.
Definition: vp8cx.h:444
@ VP8E_SET_SCALEMODE
Codec control function to set encoder scaling mode.
Definition: vp8cx.h:142
@ VP9E_SET_FRAME_PARALLEL_DECODING
Codec control function to enable frame parallel decoding feature.
Definition: vp8cx.h:385
@ VP8E_SET_SHARPNESS
Codec control function to set higher sharpness at the expense of a lower PSNR.
Definition: vp8cx.h:182
@ VP8E_SET_GF_CBR_BOOST_PCT
Boost percentage for Golden Frame in CBR mode.
Definition: vp8cx.h:601
@ VP9E_SET_TUNE_CONTENT
Codec control function to set content type.
Definition: vp8cx.h:463
@ VP9E_SET_SVC
Codec control function to turn on/off SVC in encoder.
Definition: vp8cx.h:430
@ VP9E_SET_TPL
Codec control function to enable temporal dependency model.
Definition: vp8cx.h:668
@ VP9E_SET_ROW_MT
Codec control function to set row level multi-threading.
Definition: vp8cx.h:570
@ VP8E_SET_CPUUSED
Codec control function to set encoder internal speed settings.
Definition: vp8cx.h:155
@ VP8E_SET_TEMPORAL_LAYER_ID
Codec control function to set the temporal layer id.
Definition: vp8cx.h:304
@ VP9E_SET_TILE_COLUMNS
Codec control function to set number of tile columns.
Definition: vp8cx.h:351
@ 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:628
@ VP9E_SET_SVC_REF_FRAME_CONFIG
Codec control function to set the frame flags and buffer indices for spatial layers....
Definition: vp8cx.h:545
@ VP8E_SET_STATIC_THRESHOLD
Codec control function to set the threshold for MBs treated static.
Definition: vp8cx.h:188
@ VP9E_SET_COLOR_SPACE
Codec control function to set color space info.
Definition: vp8cx.h:494
@ VP9E_SET_RENDER_SIZE
Codec control function to set intended rendering image size.
Definition: vp8cx.h:553
@ VP8E_SET_SCREEN_CONTENT_MODE
Codec control function to set encoder screen content mode.
Definition: vp8cx.h:312
@ VP8E_SET_CQ_LEVEL
Codec control function to set constrained / constant quality level.
Definition: vp8cx.h:242
@ VP9E_SET_NOISE_SENSITIVITY
Codec control function to set noise sensitivity.
Definition: vp8cx.h:421
@ VP8E_GET_LAST_QUANTIZER_64
Codec control function to get last quantizer chosen by the encoder.
Definition: vp8cx.h:211
@ VP8E_SET_FRAME_FLAGS
Codec control function to set reference and update frame flags.
Definition: vp8cx.h:263
@ VP9E_GET_ACTIVEMAP
Codec control function to get an Active map back from the encoder.
Definition: vp8cx.h:528
@ VP9E_SET_GF_CBR_BOOST_PCT
Boost percentage for Golden Frame in CBR mode.
Definition: vp8cx.h:293
@ VP9E_GET_SVC_LAYER_ID
Codec control function to get svc layer ID.
Definition: vp8cx.h:471
@ VP9E_SET_MAX_GF_INTERVAL
Codec control function to set minimum interval between GF/ARF frames.
Definition: vp8cx.h:522
@ VP9E_SET_ALT_REF_AQ
Codec control function to enable/disable special mode for altref adaptive quantization....
Definition: vp8cx.h:586
@ VP9E_SET_DELTA_Q_UV
Codec control function to set delta q for uv.
Definition: vp8cx.h:686
@ 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:716
@ VP9E_TEMPORAL_LAYERING_MODE_0101
0-1-0-1... temporal layering scheme with two temporal layers.
Definition: vp8cx.h:720
@ VP9E_TEMPORAL_LAYERING_MODE_NOLAYERING
No temporal layering. Used when only spatial layering is used.
Definition: vp8cx.h:710
@ VP9E_TEMPORAL_LAYERING_MODE_0212
0-2-1-2... temporal layering scheme with three temporal layers.
Definition: vp8cx.h:724
vpx active region map
Definition: vp8cx.h:757
unsigned int rows
Definition: vp8cx.h:760
unsigned int cols
Definition: vp8cx.h:761
unsigned char * active_map
specify an on (1) or off (0) each 16x16 region within a frame
Definition: vp8cx.h:759
vpx region of interest map
Definition: vp8cx.h:733
uint8_t enabled
Definition: vp8cx.h:735
int skip[8]
Definition: vp8cx.h:745
unsigned int static_threshold[4]
Definition: vp8cx.h:748
unsigned int rows
Definition: vp8cx.h:739
unsigned int cols
Definition: vp8cx.h:740
int ref_frame[8]
Definition: vp8cx.h:746
int delta_q[8]
Definition: vp8cx.h:742
unsigned char * roi_map
Definition: vp8cx.h:738
int delta_lf[8]
Definition: vp8cx.h:743
vpx image scaling mode
Definition: vp8cx.h:769
VPX_SCALING_MODE v_scaling_mode
Definition: vp8cx.h:771
VPX_SCALING_MODE h_scaling_mode
Definition: vp8cx.h:770
vp9 svc frame dropping parameters.
Definition: vp8cx.h:861
int framedrop_thresh[5]
Definition: vp8cx.h:862
SVC_LAYER_DROP_MODE framedrop_mode
Definition: vp8cx.h:864
int max_consec_drop
Definition: vp8cx.h:865
vp9 svc layer parameters
Definition: vp8cx.h:810
int temporal_layer_id
Definition: vp8cx.h:813
int temporal_layer_id_per_spatial[5]
Definition: vp8cx.h:814
int spatial_layer_id
Definition: vp8cx.h:811
vp9 svc frame flag parameters.
Definition: vp8cx.h:825
int lst_fb_idx[5]
Definition: vp8cx.h:826
int update_alt_ref[5]
Definition: vp8cx.h:833
int update_buffer_slot[5]
Definition: vp8cx.h:829
int gld_fb_idx[5]
Definition: vp8cx.h:827
int reference_last[5]
Definition: vp8cx.h:834
int reference_golden[5]
Definition: vp8cx.h:835
int update_last[5]
Definition: vp8cx.h:831
int reference_alt_ref[5]
Definition: vp8cx.h:836
int64_t duration[5]
Definition: vp8cx.h:837
int alt_fb_idx[5]
Definition: vp8cx.h:828
int update_golden[5]
Definition: vp8cx.h:832
vp9 svc spatial layer sync parameters.
Definition: vp8cx.h:873
int spatial_layer_sync[5]
Definition: vp8cx.h:874
int base_layer_intra_only
Definition: vp8cx.h:875
Provides controls common to both the VP8 encoder and decoder.
Describes the encoder algorithm interface to applications.