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 
162 
171 
180 
186 
192 
200 
209 
215 
221 
224 
230 
240 
255 
261 
276 
291 
302 
310 
325 
349 
369 
383 
396 
411 
419 
428 
434 
442 
451 
461 
469 
477 
492 
504 
512 
520 
526 
535 
543 
551 
560 
568 
574 
584 
599 
608 
617 
626 
633 
643 
658 
666 
676 };
677 
682 typedef enum vpx_scaling_mode_1d {
683  VP8E_NORMAL = 0,
684  VP8E_FOURFIVE = 1,
685  VP8E_THREEFIVE = 2,
686  VP8E_ONETWO = 3
688 
700 
706 
710 
715 
722 typedef struct vpx_roi_map {
724  uint8_t enabled;
727  unsigned char *roi_map;
728  unsigned int rows;
729  unsigned int cols;
731  int delta_q[8];
732  int delta_lf[8];
734  int skip[8];
735  int ref_frame[8];
737  unsigned int static_threshold[4];
738 } vpx_roi_map_t;
739 
746 typedef struct vpx_active_map {
748  unsigned char *active_map;
749  unsigned int rows;
750  unsigned int cols;
752 
758 typedef struct vpx_scaling_mode {
762 
770 typedef enum {
771  VP8_ONE_TOKENPARTITION = 0,
772  VP8_TWO_TOKENPARTITION = 1,
773  VP8_FOUR_TOKENPARTITION = 2,
774  VP8_EIGHT_TOKENPARTITION = 3
776 
778 typedef enum {
779  VP9E_CONTENT_DEFAULT,
780  VP9E_CONTENT_SCREEN,
781  VP9E_CONTENT_FILM,
782  VP9E_CONTENT_INVALID
784 
790 typedef enum { VP8_TUNE_PSNR, VP8_TUNE_SSIM } vp8e_tuning;
791 
799 typedef struct vpx_svc_layer_id {
801  // TODO(jianj): Deprecated, to be removed.
805 
814 typedef struct vpx_svc_ref_frame_config {
819  // TODO(jianj): Remove update_last/golden/alt_ref, these are deprecated.
828 
834 typedef enum {
840 
848 typedef struct vpx_svc_frame_drop {
854 
864 
874 #define VPX_CTRL_VP8E_SET_FRAME_FLAGS
876 #define VPX_CTRL_VP8E_SET_TEMPORAL_LAYER_ID
878 #define VPX_CTRL_VP8E_SET_ROI_MAP
880 #define VPX_CTRL_VP9E_SET_ROI_MAP
882 #define VPX_CTRL_VP8E_SET_ACTIVEMAP
884 #define VPX_CTRL_VP8E_SET_SCALEMODE
885 
887 #define VPX_CTRL_VP9E_SET_SVC
889 #define VPX_CTRL_VP9E_SET_SVC_PARAMETERS
891 #define VPX_CTRL_VP9E_REGISTER_CX_CALLBACK
893 #define VPX_CTRL_VP9E_SET_SVC_LAYER_ID
894 
896 #define VPX_CTRL_VP8E_SET_CPUUSED
898 #define VPX_CTRL_VP8E_SET_ENABLEAUTOALTREF
900 #define VPX_CTRL_VP8E_SET_NOISE_SENSITIVITY
902 #define VPX_CTRL_VP8E_SET_SHARPNESS
904 #define VPX_CTRL_VP8E_SET_STATIC_THRESHOLD
905 VPX_CTRL_USE_TYPE(VP8E_SET_TOKEN_PARTITIONS, int) /* vp8e_token_partitions */
906 #define VPX_CTRL_VP8E_SET_TOKEN_PARTITIONS
907 
909 #define VPX_CTRL_VP8E_SET_ARNR_MAXFRAMES
911 #define VPX_CTRL_VP8E_SET_ARNR_STRENGTH
913 #define VPX_CTRL_VP8E_SET_ARNR_TYPE
914 VPX_CTRL_USE_TYPE(VP8E_SET_TUNING, int) /* vp8e_tuning */
915 #define VPX_CTRL_VP8E_SET_TUNING
917 #define VPX_CTRL_VP8E_SET_CQ_LEVEL
918 
920 #define VPX_CTRL_VP9E_SET_TILE_COLUMNS
922 #define VPX_CTRL_VP9E_SET_TILE_ROWS
923 
925 #define VPX_CTRL_VP9E_SET_TPL
926 
928 #define VPX_CTRL_VP8E_GET_LAST_QUANTIZER
930 #define VPX_CTRL_VP8E_GET_LAST_QUANTIZER_64
932 #define VPX_CTRL_VP9E_GET_SVC_LAYER_ID
933 
935 #define VPX_CTRL_VP8E_SET_MAX_INTRA_BITRATE_PCT
936 VPX_CTRL_USE_TYPE(VP8E_SET_MAX_INTER_BITRATE_PCT, unsigned int)
937 #define VPX_CTRL_VP8E_SET_MAX_INTER_BITRATE_PCT
938 
940 #define VPX_CTRL_VP8E_SET_GF_CBR_BOOST_PCT
941 
943 #define VPX_CTRL_VP8E_SET_SCREEN_CONTENT_MODE
944 
946 #define VPX_CTRL_VP9E_SET_GF_CBR_BOOST_PCT
947 
949 #define VPX_CTRL_VP9E_SET_LOSSLESS
950 
952 #define VPX_CTRL_VP9E_SET_FRAME_PARALLEL_DECODING
953 
954 VPX_CTRL_USE_TYPE(VP9E_SET_AQ_MODE, unsigned int)
955 #define VPX_CTRL_VP9E_SET_AQ_MODE
956 
958 #define VPX_CTRL_VP9E_SET_ALT_REF_AQ
959 
961 #define VPX_CTRL_VP9E_SET_FRAME_PERIODIC_BOOST
962 
964 #define VPX_CTRL_VP9E_SET_NOISE_SENSITIVITY
965 
966 VPX_CTRL_USE_TYPE(VP9E_SET_TUNE_CONTENT, int) /* vp9e_tune_content */
967 #define VPX_CTRL_VP9E_SET_TUNE_CONTENT
968 
970 #define VPX_CTRL_VP9E_SET_COLOR_SPACE
971 
973 #define VPX_CTRL_VP9E_SET_MIN_GF_INTERVAL
974 
976 #define VPX_CTRL_VP9E_SET_MAX_GF_INTERVAL
977 
979 #define VPX_CTRL_VP9E_GET_ACTIVEMAP
980 
982 #define VPX_CTRL_VP9E_SET_COLOR_RANGE
983 
985 #define VPX_CTRL_VP9E_SET_SVC_REF_FRAME_CONFIG
986 
988 #define VPX_CTRL_VP9E_SET_RENDER_SIZE
989 
991 #define VPX_CTRL_VP9E_SET_TARGET_LEVEL
992 
993 VPX_CTRL_USE_TYPE(VP9E_SET_ROW_MT, unsigned int)
994 #define VPX_CTRL_VP9E_SET_ROW_MT
995 
997 #define VPX_CTRL_VP9E_GET_LEVEL
998 
1000 #define VPX_CTRL_VP9E_ENABLE_MOTION_VECTOR_UNIT_TEST
1001 
1003 #define VPX_CTRL_VP9E_SET_SVC_INTER_LAYER_PRED
1004 
1006 #define VPX_CTRL_VP9E_SET_SVC_FRAME_DROP_LAYER
1007 
1009 #define VPX_CTRL_VP9E_GET_SVC_REF_FRAME_CONFIG
1010 
1012 #define VPX_CTRL_VP9E_SET_SVC_GF_TEMPORAL_REF
1013 
1016 #define VPX_CTRL_VP9E_SET_SVC_SPATIAL_LAYER_SYNC
1017 
1019 #define VPX_CTRL_VP9E_SET_POSTENCODE_DROP
1020 
1023 #ifdef __cplusplus
1024 } // extern "C"
1025 #endif
1026 
1027 #endif // VPX_VPX_VP8CX_H_
unsigned char * roi_map
Definition: vp8cx.h:727
int base_layer_intra_only
Definition: vp8cx.h:862
Codec control function to set encoder internal speed settings.
Definition: vp8cx.h:155
int reference_alt_ref[5]
Definition: vp8cx.h:825
struct vpx_active_map vpx_active_map_t
vpx active region map
Describes the encoder algorithm interface to applications.
unsigned int cols
Definition: vp8cx.h:750
vp8e_enc_control_id
VPx encoder control functions.
Definition: vp8cx.h:125
Codec control function to constrain the inter-layer prediction (prediction of lower spatial resolutio...
Definition: vp8cx.h:616
Codec control function to enable temporal dependency model.
Definition: vp8cx.h:665
int delta_q[8]
Definition: vp8cx.h:731
int lst_fb_idx[5]
Definition: vp8cx.h:815
Codec control function to set content type.
Definition: vp8cx.h:460
Codec control function to set noise sensitivity.
Definition: vp8cx.h:418
enum vpx_scaling_mode_1d VPX_SCALING_MODE
vpx 1-D scaling mode
unsigned int cols
Definition: vp8cx.h:729
SVC_LAYER_DROP_MODE framedrop_mode
Definition: vp8cx.h:851
Codec control function to get bitstream level.
Definition: vp8cx.h:573
Codec control function to set reference and update frame flags.
Definition: vp8cx.h:260
Codec control function to set encoder scaling mode.
Definition: vp8cx.h:142
VPX_SCALING_MODE v_scaling_mode
Definition: vp8cx.h:760
vp8e_token_partitions
VP8 token partition mode.
Definition: vp8cx.h:770
enum vp9e_temporal_layering_mode VP9E_TEMPORAL_LAYERING_MODE
Temporal layering mode enum for VP9 SVC.
Codec control function to pass an ROI map to encoder.
Definition: vp8cx.h:130
int framedrop_thresh[5]
Definition: vp8cx.h:849
int reference_golden[5]
Definition: vp8cx.h:824
Codec control function to enable spatial layer sync frame, for any spatial layer. Enabling it for lay...
Definition: vp8cx.h:657
Codec control function to set visual tuning.
Definition: vp8cx.h:229
Codec control function to set constrained quality level.
Definition: vp8cx.h:239
Definition: vp8cx.h:223
int update_alt_ref[5]
Definition: vp8cx.h:822
Codec control function to set row level multi-threading.
Definition: vp8cx.h:567
int spatial_layer_id
Definition: vp8cx.h:800
Codec control function to set Max data rate for Intra frames.
Definition: vp8cx.h:254
Codec control function to set parameters for SVC.
Definition: vp8cx.h:441
vp9 svc frame dropping parameters.
Definition: vp8cx.h:848
int temporal_layer_id_per_spatial[5]
Definition: vp8cx.h:803
Codec control function to set number of tile columns.
Definition: vp8cx.h:348
#define VPX_SS_MAX_LAYERS
Definition: vpx_encoder.h:46
#define VPX_CTRL_USE_TYPE(id, typ)
vpx_codec_control type definition macro
Definition: vpx_codec.h:419
Codec control function to set target level.
Definition: vp8cx.h:559
int reference_last[5]
Definition: vp8cx.h:823
unsigned int static_threshold[4]
Definition: vp8cx.h:737
int update_buffer_slot[5]
Definition: vp8cx.h:818
Codec control function to set adaptive quantization mode.
Definition: vp8cx.h:395
int skip[8]
Definition: vp8cx.h:734
Codec control function to set color space info.
Definition: vp8cx.h:491
Codec control function to get svc layer ID.
Definition: vp8cx.h:468
int delta_lf[8]
Definition: vp8cx.h:732
Codec control function to set lossless encoding mode.
Definition: vp8cx.h:324
Codec control function to get last quantizer chosen by the encoder.
Definition: vp8cx.h:208
Boost percentage for Golden Frame in CBR mode.
Definition: vp8cx.h:598
vp9 svc layer parameters
Definition: vp8cx.h:799
Codec control function to set the temporal layer id.
Definition: vp8cx.h:301
0-1-0-1... temporal layering scheme with two temporal layers.
Definition: vp8cx.h:709
Codec control function to enable postencode frame drop.
Definition: vp8cx.h:675
Codec control function to set the number of token partitions.
Definition: vp8cx.h:191
control function to set noise sensitivity
Definition: vp8cx.h:170
const struct vpx_codec_iface vpx_codec_iface_t
Codec interface structure.
Definition: vpx_codec.h:174
struct vpx_svc_frame_drop vpx_svc_frame_drop_t
vp9 svc frame dropping parameters.
int ref_frame[8]
Definition: vp8cx.h:735
Definition: vp8cx.h:837
struct vpx_svc_spatial_layer_sync vpx_svc_spatial_layer_sync_t
vp9 svc spatial layer sync parameters.
Boost percentage for Golden Frame in CBR mode.
Definition: vp8cx.h:290
Codec control function to get the refresh and reference flags and the buffer indices, up to the last encoded spatial layer.
Definition: vp8cx.h:632
uint8_t enabled
Definition: vp8cx.h:724
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.
Definition: vp8cx.h:542
vp9e_temporal_layering_mode
Temporal layering mode enum for VP9 SVC.
Definition: vp8cx.h:695
Codec control function to set mode and thresholds for frame dropping in SVC. Drop frame thresholds ar...
Definition: vp8cx.h:625
Codec control function to set intended rendering image size.
Definition: vp8cx.h:550
struct vpx_svc_ref_frame_config vpx_svc_ref_frame_config_t
vp9 svc frame flag parameters.
0-2-1-2... temporal layering scheme with three temporal layers.
Definition: vp8cx.h:713
No temporal layering. Used when only spatial layering is used.
Definition: vp8cx.h:699
#define VPX_CTRL_USE_TYPE_DEPRECATED(id, typ)
vpx_codec_control deprecated type definition macro
Definition: vpx_codec.h:445
Codec control function to enable the extreme motion vector unit test in VP9. Please note that this is...
Definition: vp8cx.h:607
Definition: vp8cx.h:835
Codec control function to pass an ROI map to encoder.
Definition: vp8cx.h:433
unsigned char * active_map
specify an on (1) or off (0) each 16x16 region within a frame
Definition: vp8cx.h:748
Codec control function to set encoder screen content mode.
Definition: vp8cx.h:309
Bypass mode. Used when application needs to control temporal layering. This will only work when the n...
Definition: vp8cx.h:705
Definition: vp8cx.h:838
unsigned int rows
Definition: vp8cx.h:749
Codec control function to set the max no of frames to create arf.
Definition: vp8cx.h:214
int temporal_layer_id
Definition: vp8cx.h:802
struct vpx_scaling_mode vpx_scaling_mode_t
vpx image scaling mode
Codec control function to register callback to get per layer packet.
Definition: vp8cx.h:476
Codec control function to set the filter strength for the arf.
Definition: vp8cx.h:220
Codec control function to enable/disable periodic Q boost.
Definition: vp8cx.h:410
Codec control function to get an Active map back from the encoder.
Definition: vp8cx.h:525
vp9 svc spatial layer sync parameters.
Definition: vp8cx.h:860
Codec control function to enable/disable use of golden reference as a second temporal reference for S...
Definition: vp8cx.h:642
Provides controls common to both the VP8 encoder and decoder.
Codec control function to set color range bit.
Definition: vp8cx.h:534
struct vpx_svc_layer_id vpx_svc_layer_id_t
vp9 svc layer parameters
Codec control function to get last quantizer chosen by the encoder.
Definition: vp8cx.h:199
Codec control function to enable automatic use of arf frames.
Definition: vp8cx.h:161
int max_consec_drop
Definition: vp8cx.h:852
Codec control function to set minimum interval between GF/ARF frames.
Definition: vp8cx.h:511
Codec control function to set temporal layering mode.
Definition: vp8cx.h:503
VPX_SCALING_MODE h_scaling_mode
Definition: vp8cx.h:759
Codec control function to set minimum interval between GF/ARF frames.
Definition: vp8cx.h:519
int update_golden[5]
Definition: vp8cx.h:821
Codec control function to turn on/off SVC in encoder.
Definition: vp8cx.h:427
int spatial_layer_sync[5]
Definition: vp8cx.h:861
vpx active region map
Definition: vp8cx.h:746
struct vpx_roi_map vpx_roi_map_t
vpx region of interest map
unsigned int rows
Definition: vp8cx.h:728
Codec control function to enable frame parallel decoding feature.
Definition: vp8cx.h:382
Codec control function to set max data rate for Inter frames.
Definition: vp8cx.h:275
int update_last[5]
Definition: vp8cx.h:820
vp9 svc frame flag parameters.
Definition: vp8cx.h:814
Codec control function to set the threshold for MBs treated static.
Definition: vp8cx.h:185
int64_t duration[5]
Definition: vp8cx.h:826
vpx_scaling_mode_1d
vpx 1-D scaling mode
Definition: vp8cx.h:682
int alt_fb_idx[5]
Definition: vp8cx.h:817
Codec control function to set number of tile rows.
Definition: vp8cx.h:368
vp8e_tuning
VP8 model tuning parameters.
Definition: vp8cx.h:790
Codec control function to set higher sharpness at the expense of a lower PSNR.
Definition: vp8cx.h:179
vpx region of interest map
Definition: vp8cx.h:722
Codec control function to enable/disable special mode for altref adaptive quantization. You can use it with –aq-mode concurrently.
Definition: vp8cx.h:583
SVC_LAYER_DROP_MODE
VP9 svc frame dropping mode.
Definition: vp8cx.h:834
int gld_fb_idx[5]
Definition: vp8cx.h:816
vpx image scaling mode
Definition: vp8cx.h:758
Codec control function to set svc layer for spatial and temporal.
Definition: vp8cx.h:450
Codec control function to pass an Active map to encoder.
Definition: vp8cx.h:136
vp9e_tune_content
Definition: vp8cx.h:778