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 };
680 
685 typedef enum vpx_scaling_mode_1d {
686  VP8E_NORMAL = 0,
687  VP8E_FOURFIVE = 1,
688  VP8E_THREEFIVE = 2,
689  VP8E_ONETWO = 3
691 
703 
709 
713 
718 
725 typedef struct vpx_roi_map {
727  uint8_t enabled;
730  unsigned char *roi_map;
731  unsigned int rows;
732  unsigned int cols;
734  int delta_q[8];
735  int delta_lf[8];
737  int skip[8];
738  int ref_frame[8];
740  unsigned int static_threshold[4];
741 } vpx_roi_map_t;
742 
749 typedef struct vpx_active_map {
751  unsigned char *active_map;
752  unsigned int rows;
753  unsigned int cols;
755 
761 typedef struct vpx_scaling_mode {
765 
773 typedef enum {
774  VP8_ONE_TOKENPARTITION = 0,
775  VP8_TWO_TOKENPARTITION = 1,
776  VP8_FOUR_TOKENPARTITION = 2,
777  VP8_EIGHT_TOKENPARTITION = 3
779 
781 typedef enum {
782  VP9E_CONTENT_DEFAULT,
783  VP9E_CONTENT_SCREEN,
784  VP9E_CONTENT_FILM,
785  VP9E_CONTENT_INVALID
787 
793 typedef enum { VP8_TUNE_PSNR, VP8_TUNE_SSIM } vp8e_tuning;
794 
802 typedef struct vpx_svc_layer_id {
804  // TODO(jianj): Deprecated, to be removed.
806  int temporal_layer_id_per_spatial[VPX_SS_MAX_LAYERS];
808 
817 typedef struct vpx_svc_ref_frame_config {
818  int lst_fb_idx[VPX_SS_MAX_LAYERS];
819  int gld_fb_idx[VPX_SS_MAX_LAYERS];
820  int alt_fb_idx[VPX_SS_MAX_LAYERS];
821  int update_buffer_slot[VPX_SS_MAX_LAYERS];
822  // TODO(jianj): Remove update_last/golden/alt_ref, these are deprecated.
823  int update_last[VPX_SS_MAX_LAYERS];
824  int update_golden[VPX_SS_MAX_LAYERS];
825  int update_alt_ref[VPX_SS_MAX_LAYERS];
826  int reference_last[VPX_SS_MAX_LAYERS];
827  int reference_golden[VPX_SS_MAX_LAYERS];
828  int reference_alt_ref[VPX_SS_MAX_LAYERS];
829  int64_t duration[VPX_SS_MAX_LAYERS];
831 
837 typedef enum {
845 
853 typedef struct vpx_svc_frame_drop {
854  int framedrop_thresh[VPX_SS_MAX_LAYERS];
855  SVC_LAYER_DROP_MODE
859 
866  int spatial_layer_sync[VPX_SS_MAX_LAYERS];
869 
879 #define VPX_CTRL_VP8E_SET_FRAME_FLAGS
881 #define VPX_CTRL_VP8E_SET_TEMPORAL_LAYER_ID
883 #define VPX_CTRL_VP8E_SET_ROI_MAP
885 #define VPX_CTRL_VP9E_SET_ROI_MAP
887 #define VPX_CTRL_VP8E_SET_ACTIVEMAP
889 #define VPX_CTRL_VP8E_SET_SCALEMODE
890 
892 #define VPX_CTRL_VP9E_SET_SVC
894 #define VPX_CTRL_VP9E_SET_SVC_PARAMETERS
896 #define VPX_CTRL_VP9E_REGISTER_CX_CALLBACK
898 #define VPX_CTRL_VP9E_SET_SVC_LAYER_ID
899 
901 #define VPX_CTRL_VP8E_SET_CPUUSED
903 #define VPX_CTRL_VP8E_SET_ENABLEAUTOALTREF
905 #define VPX_CTRL_VP8E_SET_NOISE_SENSITIVITY
907 #define VPX_CTRL_VP8E_SET_SHARPNESS
909 #define VPX_CTRL_VP8E_SET_STATIC_THRESHOLD
910 VPX_CTRL_USE_TYPE(VP8E_SET_TOKEN_PARTITIONS, int) /* vp8e_token_partitions */
911 #define VPX_CTRL_VP8E_SET_TOKEN_PARTITIONS
912 
914 #define VPX_CTRL_VP8E_SET_ARNR_MAXFRAMES
916 #define VPX_CTRL_VP8E_SET_ARNR_STRENGTH
918 #define VPX_CTRL_VP8E_SET_ARNR_TYPE
919 VPX_CTRL_USE_TYPE(VP8E_SET_TUNING, int) /* vp8e_tuning */
920 #define VPX_CTRL_VP8E_SET_TUNING
922 #define VPX_CTRL_VP8E_SET_CQ_LEVEL
923 
925 #define VPX_CTRL_VP9E_SET_TILE_COLUMNS
927 #define VPX_CTRL_VP9E_SET_TILE_ROWS
928 
930 #define VPX_CTRL_VP9E_SET_TPL
931 
933 #define VPX_CTRL_VP8E_GET_LAST_QUANTIZER
935 #define VPX_CTRL_VP8E_GET_LAST_QUANTIZER_64
937 #define VPX_CTRL_VP9E_GET_SVC_LAYER_ID
938 
940 #define VPX_CTRL_VP8E_SET_MAX_INTRA_BITRATE_PCT
942 #define VPX_CTRL_VP9E_SET_MAX_INTER_BITRATE_PCT
943 
945 #define VPX_CTRL_VP8E_SET_GF_CBR_BOOST_PCT
946 
948 #define VPX_CTRL_VP8E_SET_SCREEN_CONTENT_MODE
949 
951 #define VPX_CTRL_VP9E_SET_GF_CBR_BOOST_PCT
952 
954 #define VPX_CTRL_VP9E_SET_LOSSLESS
955 
957 #define VPX_CTRL_VP9E_SET_FRAME_PARALLEL_DECODING
958 
959 VPX_CTRL_USE_TYPE(VP9E_SET_AQ_MODE, unsigned int)
960 #define VPX_CTRL_VP9E_SET_AQ_MODE
961 
963 #define VPX_CTRL_VP9E_SET_ALT_REF_AQ
964 
966 #define VPX_CTRL_VP9E_SET_FRAME_PERIODIC_BOOST
967 
969 #define VPX_CTRL_VP9E_SET_NOISE_SENSITIVITY
970 
971 VPX_CTRL_USE_TYPE(VP9E_SET_TUNE_CONTENT, int) /* vp9e_tune_content */
972 #define VPX_CTRL_VP9E_SET_TUNE_CONTENT
973 
975 #define VPX_CTRL_VP9E_SET_COLOR_SPACE
976 
978 #define VPX_CTRL_VP9E_SET_MIN_GF_INTERVAL
979 
981 #define VPX_CTRL_VP9E_SET_MAX_GF_INTERVAL
982 
984 #define VPX_CTRL_VP9E_GET_ACTIVEMAP
985 
987 #define VPX_CTRL_VP9E_SET_COLOR_RANGE
988 
990 #define VPX_CTRL_VP9E_SET_SVC_REF_FRAME_CONFIG
991 
993 #define VPX_CTRL_VP9E_SET_RENDER_SIZE
994 
996 #define VPX_CTRL_VP9E_SET_TARGET_LEVEL
997 
998 VPX_CTRL_USE_TYPE(VP9E_SET_ROW_MT, unsigned int)
999 #define VPX_CTRL_VP9E_SET_ROW_MT
1000 
1002 #define VPX_CTRL_VP9E_GET_LEVEL
1003 
1005 #define VPX_CTRL_VP9E_ENABLE_MOTION_VECTOR_UNIT_TEST
1006 
1008 #define VPX_CTRL_VP9E_SET_SVC_INTER_LAYER_PRED
1009 
1011 #define VPX_CTRL_VP9E_SET_SVC_FRAME_DROP_LAYER
1012 
1014 #define VPX_CTRL_VP9E_GET_SVC_REF_FRAME_CONFIG
1015 
1017 #define VPX_CTRL_VP9E_SET_SVC_GF_TEMPORAL_REF
1018 
1021 #define VPX_CTRL_VP9E_SET_SVC_SPATIAL_LAYER_SYNC
1022 
1024 #define VPX_CTRL_VP9E_SET_POSTENCODE_DROP
1025 
1028 #ifdef __cplusplus
1029 } // extern "C"
1030 #endif
1031 
1032 #endif // VPX_VPX_VP8CX_H_
unsigned char * roi_map
Definition: vp8cx.h:730
int base_layer_intra_only
Definition: vp8cx.h:867
Codec control function to set encoder internal speed settings.
Definition: vp8cx.h:155
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:753
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:619
Codec control function to enable temporal dependency model.
Definition: vp8cx.h:668
int delta_q[8]
Definition: vp8cx.h:734
Codec control function to set content type.
Definition: vp8cx.h:463
Codec control function to set noise sensitivity.
Definition: vp8cx.h:421
enum vpx_scaling_mode_1d VPX_SCALING_MODE
vpx 1-D scaling mode
unsigned int cols
Definition: vp8cx.h:732
SVC_LAYER_DROP_MODE framedrop_mode
Definition: vp8cx.h:856
Codec control function to get bitstream level.
Definition: vp8cx.h:576
Codec control function to set reference and update frame flags.
Definition: vp8cx.h:263
Codec control function to set encoder scaling mode.
Definition: vp8cx.h:142
VPX_SCALING_MODE v_scaling_mode
Definition: vp8cx.h:763
vp8e_token_partitions
VP8 token partition mode.
Definition: vp8cx.h:773
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
Codec control function to enable spatial layer sync frame, for any spatial layer. Enabling it for lay...
Definition: vp8cx.h:660
Codec control function to set visual tuning.
Definition: vp8cx.h:232
Codec control function to set constrained / constant quality level.
Definition: vp8cx.h:242
Definition: vp8cx.h:226
Codec control function to set row level multi-threading.
Definition: vp8cx.h:570
int spatial_layer_id
Definition: vp8cx.h:803
Codec control function to set Max data rate for Intra frames.
Definition: vp8cx.h:257
Codec control function to set parameters for SVC.
Definition: vp8cx.h:444
vp9 svc frame dropping parameters.
Definition: vp8cx.h:853
Codec control function to set number of tile columns.
Definition: vp8cx.h:351
#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:562
unsigned int static_threshold[4]
Definition: vp8cx.h:740
Codec control function to set adaptive quantization mode.
Definition: vp8cx.h:398
int skip[8]
Definition: vp8cx.h:737
Codec control function to set color space info.
Definition: vp8cx.h:494
Codec control function to get svc layer ID.
Definition: vp8cx.h:471
int delta_lf[8]
Definition: vp8cx.h:735
Codec control function to set lossless encoding mode.
Definition: vp8cx.h:327
Codec control function to get last quantizer chosen by the encoder.
Definition: vp8cx.h:211
Boost percentage for Golden Frame in CBR mode.
Definition: vp8cx.h:601
vp9 svc layer parameters
Definition: vp8cx.h:802
Codec control function to set the temporal layer id.
Definition: vp8cx.h:304
0-1-0-1... temporal layering scheme with two temporal layers.
Definition: vp8cx.h:712
Codec control function to enable postencode frame drop.
Definition: vp8cx.h:678
Codec control function to set the number of token partitions.
Definition: vp8cx.h:194
control function to set noise sensitivity
Definition: vp8cx.h:173
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:738
Definition: vp8cx.h:840
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:293
Codec control function to get the refresh and reference flags and the buffer indices, up to the last encoded spatial layer.
Definition: vp8cx.h:635
uint8_t enabled
Definition: vp8cx.h:727
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:545
vp9e_temporal_layering_mode
Temporal layering mode enum for VP9 SVC.
Definition: vp8cx.h:698
Codec control function to set mode and thresholds for frame dropping in SVC. Drop frame thresholds ar...
Definition: vp8cx.h:628
Codec control function to set intended rendering image size.
Definition: vp8cx.h:553
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:716
No temporal layering. Used when only spatial layering is used.
Definition: vp8cx.h:702
#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:610
Definition: vp8cx.h:838
Codec control function to pass an ROI map to encoder.
Definition: vp8cx.h:436
unsigned char * active_map
specify an on (1) or off (0) each 16x16 region within a frame
Definition: vp8cx.h:751
Definition: vp8cx.h:842
Codec control function to set encoder screen content mode.
Definition: vp8cx.h:312
Bypass mode. Used when application needs to control temporal layering. This will only work when the n...
Definition: vp8cx.h:708
Definition: vp8cx.h:841
unsigned int rows
Definition: vp8cx.h:752
Codec control function to set the max no of frames to create arf.
Definition: vp8cx.h:217
int temporal_layer_id
Definition: vp8cx.h:805
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:479
Codec control function to set the filter strength for the arf.
Definition: vp8cx.h:223
Codec control function to enable/disable periodic Q boost.
Definition: vp8cx.h:413
Codec control function to get an Active map back from the encoder.
Definition: vp8cx.h:528
vp9 svc spatial layer sync parameters.
Definition: vp8cx.h:865
Codec control function to enable/disable use of golden reference as a second temporal reference for S...
Definition: vp8cx.h:645
Provides controls common to both the VP8 encoder and decoder.
Codec control function to set color range bit.
Definition: vp8cx.h:537
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:202
Codec control function to enable automatic use of arf frames.
Definition: vp8cx.h:164
int max_consec_drop
Definition: vp8cx.h:857
Codec control function to set minimum interval between GF/ARF frames.
Definition: vp8cx.h:514
Codec control function to set temporal layering mode.
Definition: vp8cx.h:506
VPX_SCALING_MODE h_scaling_mode
Definition: vp8cx.h:762
Codec control function to set minimum interval between GF/ARF frames.
Definition: vp8cx.h:522
Codec control function to turn on/off SVC in encoder.
Definition: vp8cx.h:430
vpx active region map
Definition: vp8cx.h:749
struct vpx_roi_map vpx_roi_map_t
vpx region of interest map
unsigned int rows
Definition: vp8cx.h:731
Codec control function to enable frame parallel decoding feature.
Definition: vp8cx.h:385
Codec control function to set max data rate for Inter frames.
Definition: vp8cx.h:278
vp9 svc frame flag parameters.
Definition: vp8cx.h:817
Codec control function to set the threshold for MBs treated static.
Definition: vp8cx.h:188
vpx_scaling_mode_1d
vpx 1-D scaling mode
Definition: vp8cx.h:685
Codec control function to set number of tile rows.
Definition: vp8cx.h:371
vp8e_tuning
VP8 model tuning parameters.
Definition: vp8cx.h:793
Codec control function to set higher sharpness at the expense of a lower PSNR.
Definition: vp8cx.h:182
vpx region of interest map
Definition: vp8cx.h:725
Codec control function to enable/disable special mode for altref adaptive quantization. You can use it with –aq-mode concurrently.
Definition: vp8cx.h:586
SVC_LAYER_DROP_MODE
VP9 svc frame dropping mode.
Definition: vp8cx.h:837
vpx image scaling mode
Definition: vp8cx.h:761
Codec control function to set svc layer for spatial and temporal.
Definition: vp8cx.h:453
Codec control function to pass an Active map to encoder.
Definition: vp8cx.h:136
vp9e_tune_content
Definition: vp8cx.h:781