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_VP8CX_H_
11 #define 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 
177 
183 
189 
197 
206 
212 
218 
221 
227 
237 
252 
258 
273 
288 
299 
307 
322 
346 
366 
380 
393 
408 
416 
425 
431 
439 
448 
458 
466 
474 
489 
501 
509 
517 
523 
532 
540 
548 
557 
565 
571 
581 
596 
605 
614 
623 };
624 
629 typedef enum vpx_scaling_mode_1d {
630  VP8E_NORMAL = 0,
631  VP8E_FOURFIVE = 1,
632  VP8E_THREEFIVE = 2,
633  VP8E_ONETWO = 3
635 
647 
653 
657 
662 
669 typedef struct vpx_roi_map {
671  uint8_t enabled;
674  unsigned char *roi_map;
675  unsigned int rows;
676  unsigned int cols;
678  int delta_q[8];
679  int delta_lf[8];
681  int skip[8];
682  int ref_frame[8];
684  unsigned int static_threshold[4];
685 } vpx_roi_map_t;
686 
693 typedef struct vpx_active_map {
695  unsigned char *active_map;
696  unsigned int rows;
697  unsigned int cols;
699 
705 typedef struct vpx_scaling_mode {
709 
717 typedef enum {
718  VP8_ONE_TOKENPARTITION = 0,
719  VP8_TWO_TOKENPARTITION = 1,
720  VP8_FOUR_TOKENPARTITION = 2,
721  VP8_EIGHT_TOKENPARTITION = 3
723 
725 typedef enum {
726  VP9E_CONTENT_DEFAULT,
727  VP9E_CONTENT_SCREEN,
728  VP9E_CONTENT_FILM,
729  VP9E_CONTENT_INVALID
731 
737 typedef enum { VP8_TUNE_PSNR, VP8_TUNE_SSIM } vp8e_tuning;
738 
746 typedef struct vpx_svc_layer_id {
750 
759 typedef struct vpx_svc_ref_frame_config {
760  int frame_flags[VPX_TS_MAX_LAYERS];
761  int lst_fb_idx[VPX_TS_MAX_LAYERS];
762  int gld_fb_idx[VPX_TS_MAX_LAYERS];
763  int alt_fb_idx[VPX_TS_MAX_LAYERS];
765 
771 typedef enum {
776 
784 typedef struct vpx_svc_frame_drop {
785  int framedrop_thresh[VPX_SS_MAX_LAYERS];
786  SVC_LAYER_DROP_MODE
789 
799 #define VPX_CTRL_VP8E_SET_FRAME_FLAGS
801 #define VPX_CTRL_VP8E_SET_TEMPORAL_LAYER_ID
803 #define VPX_CTRL_VP8E_SET_ROI_MAP
805 #define VPX_CTRL_VP9E_SET_ROI_MAP
807 #define VPX_CTRL_VP8E_SET_ACTIVEMAP
809 #define VPX_CTRL_VP8E_SET_SCALEMODE
810 
812 #define VPX_CTRL_VP9E_SET_SVC
814 #define VPX_CTRL_VP9E_SET_SVC_PARAMETERS
816 #define VPX_CTRL_VP9E_REGISTER_CX_CALLBACK
818 #define VPX_CTRL_VP9E_SET_SVC_LAYER_ID
819 
821 #define VPX_CTRL_VP8E_SET_CPUUSED
823 #define VPX_CTRL_VP8E_SET_ENABLEAUTOALTREF
825 #define VPX_CTRL_VP8E_SET_NOISE_SENSITIVITY
827 #define VPX_CTRL_VP8E_SET_SHARPNESS
829 #define VPX_CTRL_VP8E_SET_STATIC_THRESHOLD
830 VPX_CTRL_USE_TYPE(VP8E_SET_TOKEN_PARTITIONS, int) /* vp8e_token_partitions */
831 #define VPX_CTRL_VP8E_SET_TOKEN_PARTITIONS
832 
834 #define VPX_CTRL_VP8E_SET_ARNR_MAXFRAMES
836 #define VPX_CTRL_VP8E_SET_ARNR_STRENGTH
838 #define VPX_CTRL_VP8E_SET_ARNR_TYPE
839 VPX_CTRL_USE_TYPE(VP8E_SET_TUNING, int) /* vp8e_tuning */
840 #define VPX_CTRL_VP8E_SET_TUNING
842 #define VPX_CTRL_VP8E_SET_CQ_LEVEL
843 
845 #define VPX_CTRL_VP9E_SET_TILE_COLUMNS
847 #define VPX_CTRL_VP9E_SET_TILE_ROWS
848 
850 #define VPX_CTRL_VP8E_GET_LAST_QUANTIZER
852 #define VPX_CTRL_VP8E_GET_LAST_QUANTIZER_64
854 #define VPX_CTRL_VP9E_GET_SVC_LAYER_ID
855 
857 #define VPX_CTRL_VP8E_SET_MAX_INTRA_BITRATE_PCT
858 VPX_CTRL_USE_TYPE(VP8E_SET_MAX_INTER_BITRATE_PCT, unsigned int)
859 #define VPX_CTRL_VP8E_SET_MAX_INTER_BITRATE_PCT
860 
862 #define VPX_CTRL_VP8E_SET_GF_CBR_BOOST_PCT
863 
865 #define VPX_CTRL_VP8E_SET_SCREEN_CONTENT_MODE
866 
868 #define VPX_CTRL_VP9E_SET_GF_CBR_BOOST_PCT
869 
871 #define VPX_CTRL_VP9E_SET_LOSSLESS
872 
874 #define VPX_CTRL_VP9E_SET_FRAME_PARALLEL_DECODING
875 
876 VPX_CTRL_USE_TYPE(VP9E_SET_AQ_MODE, unsigned int)
877 #define VPX_CTRL_VP9E_SET_AQ_MODE
878 
880 #define VPX_CTRL_VP9E_SET_ALT_REF_AQ
881 
883 #define VPX_CTRL_VP9E_SET_FRAME_PERIODIC_BOOST
884 
886 #define VPX_CTRL_VP9E_SET_NOISE_SENSITIVITY
887 
888 VPX_CTRL_USE_TYPE(VP9E_SET_TUNE_CONTENT, int) /* vp9e_tune_content */
889 #define VPX_CTRL_VP9E_SET_TUNE_CONTENT
890 
892 #define VPX_CTRL_VP9E_SET_COLOR_SPACE
893 
895 #define VPX_CTRL_VP9E_SET_MIN_GF_INTERVAL
896 
898 #define VPX_CTRL_VP9E_SET_MAX_GF_INTERVAL
899 
901 #define VPX_CTRL_VP9E_GET_ACTIVEMAP
902 
904 #define VPX_CTRL_VP9E_SET_COLOR_RANGE
905 
907 #define VPX_CTRL_VP9E_SET_SVC_REF_FRAME_CONFIG
908 
910 #define VPX_CTRL_VP9E_SET_RENDER_SIZE
911 
913 #define VPX_CTRL_VP9E_SET_TARGET_LEVEL
914 
915 VPX_CTRL_USE_TYPE(VP9E_SET_ROW_MT, unsigned int)
916 #define VPX_CTRL_VP9E_SET_ROW_MT
917 
919 #define VPX_CTRL_VP9E_GET_LEVEL
920 
922 #define VPX_CTRL_VP9E_ENABLE_MOTION_VECTOR_UNIT_TEST
923 
925 #define VPX_CTRL_VP9E_SET_SVC_INTER_LAYER_PRED
926 
928 #define VPX_CTRL_VP9E_SET_SVC_FRAME_DROP_LAYER
929 
932 #ifdef __cplusplus
933 } // extern "C"
934 #endif
935 
936 #endif // VPX_VP8CX_H_
unsigned char * roi_map
Definition: vp8cx.h:674
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:697
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:613
int delta_q[8]
Definition: vp8cx.h:678
#define VPX_TS_MAX_LAYERS
Definition: vpx_encoder.h:40
Codec control function to set content type.
Definition: vp8cx.h:457
Codec control function to set noise sensitivity.
Definition: vp8cx.h:415
enum vpx_scaling_mode_1d VPX_SCALING_MODE
vpx 1-D scaling mode
unsigned int cols
Definition: vp8cx.h:676
SVC_LAYER_DROP_MODE framedrop_mode
Definition: vp8cx.h:787
Codec control function to get bitstream level.
Definition: vp8cx.h:570
Codec control function to set reference and update frame flags.
Definition: vp8cx.h:257
Codec control function to set encoder scaling mode.
Definition: vp8cx.h:142
VPX_SCALING_MODE v_scaling_mode
Definition: vp8cx.h:707
vp8e_token_partitions
VP8 token partition mode.
Definition: vp8cx.h:717
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 set visual tuning.
Definition: vp8cx.h:226
Codec control function to set constrained quality level.
Definition: vp8cx.h:236
Definition: vp8cx.h:220
Codec control function to set row level multi-threading.
Definition: vp8cx.h:564
int spatial_layer_id
Definition: vp8cx.h:747
Codec control function to set Max data rate for Intra frames.
Definition: vp8cx.h:251
Codec control function to set parameters for SVC.
Definition: vp8cx.h:438
vp9 svc frame dropping parameters.
Definition: vp8cx.h:784
Codec control function to set number of tile columns.
Definition: vp8cx.h:345
#define VPX_SS_MAX_LAYERS
Definition: vpx_encoder.h:52
#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:556
unsigned int static_threshold[4]
Definition: vp8cx.h:684
Codec control function to set adaptive quantization mode.
Definition: vp8cx.h:392
int skip[8]
Definition: vp8cx.h:681
Codec control function to set color space info.
Definition: vp8cx.h:488
Codec control function to get svc layer ID.
Definition: vp8cx.h:465
int delta_lf[8]
Definition: vp8cx.h:679
Codec control function to set lossless encoding mode.
Definition: vp8cx.h:321
Codec control function to get last quantizer chosen by the encoder.
Definition: vp8cx.h:205
Boost percentage for Golden Frame in CBR mode.
Definition: vp8cx.h:595
vp9 svc layer parameters
Definition: vp8cx.h:746
Codec control function to set the temporal layer id.
Definition: vp8cx.h:298
0-1-0-1... temporal layering scheme with two temporal layers.
Definition: vp8cx.h:656
Codec control function to set the number of token partitions.
Definition: vp8cx.h:188
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:682
Definition: vp8cx.h:772
Boost percentage for Golden Frame in CBR mode.
Definition: vp8cx.h:287
uint8_t enabled
Definition: vp8cx.h:671
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:539
vp9e_temporal_layering_mode
Temporal layering mode enum for VP9 SVC.
Definition: vp8cx.h:642
Codec control function to set mode and thresholds for frame dropping in SVC. Drop frame thresholds ar...
Definition: vp8cx.h:622
Codec control function to set intended rendering image size.
Definition: vp8cx.h:547
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:660
No temporal layering. Used when only spatial layering is used.
Definition: vp8cx.h:646
#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:604
Definition: vp8cx.h:773
Codec control function to pass an ROI map to encoder.
Definition: vp8cx.h:430
unsigned char * active_map
specify an on (1) or off (0) each 16x16 region within a frame
Definition: vp8cx.h:695
Codec control function to set encoder screen content mode.
Definition: vp8cx.h:306
Bypass mode. Used when application needs to control temporal layering. This will only work when the n...
Definition: vp8cx.h:652
unsigned int rows
Definition: vp8cx.h:696
Codec control function to set the max no of frames to create arf.
Definition: vp8cx.h:211
int temporal_layer_id
Definition: vp8cx.h:748
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:473
Codec control function to set the filter strength for the arf.
Definition: vp8cx.h:217
Codec control function to enable/disable periodic Q boost.
Definition: vp8cx.h:407
Codec control function to get an Active map back from the encoder.
Definition: vp8cx.h:522
Provides controls common to both the VP8 encoder and decoder.
Codec control function to set color range bit.
Definition: vp8cx.h:531
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:196
Codec control function to enable automatic set and use alf frames.
Definition: vp8cx.h:161
Codec control function to set minimum interval between GF/ARF frames.
Definition: vp8cx.h:508
Codec control function to set temporal layering mode.
Definition: vp8cx.h:500
VPX_SCALING_MODE h_scaling_mode
Definition: vp8cx.h:706
Codec control function to set minimum interval between GF/ARF frames.
Definition: vp8cx.h:516
Codec control function to turn on/off SVC in encoder.
Definition: vp8cx.h:424
vpx active region map
Definition: vp8cx.h:693
struct vpx_roi_map vpx_roi_map_t
vpx region of interest map
unsigned int rows
Definition: vp8cx.h:675
Codec control function to enable frame parallel decoding feature.
Definition: vp8cx.h:379
Codec control function to set max data rate for Inter frames.
Definition: vp8cx.h:272
vp9 svc frame flag parameters.
Definition: vp8cx.h:759
Codec control function to set the threshold for MBs treated static.
Definition: vp8cx.h:182
vpx_scaling_mode_1d
vpx 1-D scaling mode
Definition: vp8cx.h:629
Codec control function to set number of tile rows.
Definition: vp8cx.h:365
vp8e_tuning
VP8 model tuning parameters.
Definition: vp8cx.h:737
Codec control function to set sharpness.
Definition: vp8cx.h:176
vpx region of interest map
Definition: vp8cx.h:669
Codec control function to enable/disable special mode for altref adaptive quantization. You can use it with –aq-mode concurrently.
Definition: vp8cx.h:580
SVC_LAYER_DROP_MODE
VP9 svc frame dropping mode.
Definition: vp8cx.h:771
vpx image scaling mode
Definition: vp8cx.h:705
Codec control function to set svc layer for spatial and temporal.
Definition: vp8cx.h:447
Codec control function to pass an Active map to encoder.
Definition: vp8cx.h:136
vp9e_tune_content
Definition: vp8cx.h:725