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 
345 
365 
379 
392 
407 
415 
424 
432 
441 
450 
458 
466 
481 
493 
501 
509 
515 
524 
532 
540 
549 
557 
563 
573 
588 
597 };
598 
603 typedef enum vpx_scaling_mode_1d {
604  VP8E_NORMAL = 0,
605  VP8E_FOURFIVE = 1,
606  VP8E_THREEFIVE = 2,
607  VP8E_ONETWO = 3
609 
621 
627 
631 
636 
643 typedef struct vpx_roi_map {
645  unsigned char *roi_map;
646  unsigned int rows;
647  unsigned int cols;
648  // TODO(paulwilkins): broken for VP9 which has 8 segments
649  // q and loop filter deltas for each segment
650  // (see MAX_MB_SEGMENTS)
651  int delta_q[4];
652  int delta_lf[4];
654  unsigned int static_threshold[4];
655 } vpx_roi_map_t;
656 
663 typedef struct vpx_active_map {
665  unsigned char *active_map;
666  unsigned int rows;
667  unsigned int cols;
669 
675 typedef struct vpx_scaling_mode {
679 
687 typedef enum {
688  VP8_ONE_TOKENPARTITION = 0,
689  VP8_TWO_TOKENPARTITION = 1,
690  VP8_FOUR_TOKENPARTITION = 2,
691  VP8_EIGHT_TOKENPARTITION = 3
693 
695 typedef enum {
696  VP9E_CONTENT_DEFAULT,
697  VP9E_CONTENT_SCREEN,
698  VP9E_CONTENT_INVALID
700 
706 typedef enum { VP8_TUNE_PSNR, VP8_TUNE_SSIM } vp8e_tuning;
707 
715 typedef struct vpx_svc_layer_id {
719 
728 typedef struct vpx_svc_ref_frame_config {
729  int frame_flags[VPX_TS_MAX_LAYERS];
730  int lst_fb_idx[VPX_TS_MAX_LAYERS];
731  int gld_fb_idx[VPX_TS_MAX_LAYERS];
732  int alt_fb_idx[VPX_TS_MAX_LAYERS];
734 
744 #define VPX_CTRL_VP8E_SET_FRAME_FLAGS
746 #define VPX_CTRL_VP8E_SET_TEMPORAL_LAYER_ID
748 #define VPX_CTRL_VP8E_SET_ROI_MAP
750 #define VPX_CTRL_VP8E_SET_ACTIVEMAP
752 #define VPX_CTRL_VP8E_SET_SCALEMODE
753 
755 #define VPX_CTRL_VP9E_SET_SVC
757 #define VPX_CTRL_VP9E_SET_SVC_PARAMETERS
759 #define VPX_CTRL_VP9E_REGISTER_CX_CALLBACK
761 #define VPX_CTRL_VP9E_SET_SVC_LAYER_ID
762 
764 #define VPX_CTRL_VP8E_SET_CPUUSED
766 #define VPX_CTRL_VP8E_SET_ENABLEAUTOALTREF
768 #define VPX_CTRL_VP8E_SET_NOISE_SENSITIVITY
770 #define VPX_CTRL_VP8E_SET_SHARPNESS
772 #define VPX_CTRL_VP8E_SET_STATIC_THRESHOLD
773 VPX_CTRL_USE_TYPE(VP8E_SET_TOKEN_PARTITIONS, int) /* vp8e_token_partitions */
774 #define VPX_CTRL_VP8E_SET_TOKEN_PARTITIONS
775 
777 #define VPX_CTRL_VP8E_SET_ARNR_MAXFRAMES
779 #define VPX_CTRL_VP8E_SET_ARNR_STRENGTH
781 #define VPX_CTRL_VP8E_SET_ARNR_TYPE
782 VPX_CTRL_USE_TYPE(VP8E_SET_TUNING, int) /* vp8e_tuning */
783 #define VPX_CTRL_VP8E_SET_TUNING
785 #define VPX_CTRL_VP8E_SET_CQ_LEVEL
786 
788 #define VPX_CTRL_VP9E_SET_TILE_COLUMNS
790 #define VPX_CTRL_VP9E_SET_TILE_ROWS
791 
793 #define VPX_CTRL_VP8E_GET_LAST_QUANTIZER
795 #define VPX_CTRL_VP8E_GET_LAST_QUANTIZER_64
797 #define VPX_CTRL_VP9E_GET_SVC_LAYER_ID
798 
800 #define VPX_CTRL_VP8E_SET_MAX_INTRA_BITRATE_PCT
801 VPX_CTRL_USE_TYPE(VP8E_SET_MAX_INTER_BITRATE_PCT, unsigned int)
802 #define VPX_CTRL_VP8E_SET_MAX_INTER_BITRATE_PCT
803 
805 #define VPX_CTRL_VP8E_SET_GF_CBR_BOOST_PCT
806 
808 #define VPX_CTRL_VP8E_SET_SCREEN_CONTENT_MODE
809 
811 #define VPX_CTRL_VP9E_SET_GF_CBR_BOOST_PCT
812 
814 #define VPX_CTRL_VP9E_SET_LOSSLESS
815 
817 #define VPX_CTRL_VP9E_SET_FRAME_PARALLEL_DECODING
818 
819 VPX_CTRL_USE_TYPE(VP9E_SET_AQ_MODE, unsigned int)
820 #define VPX_CTRL_VP9E_SET_AQ_MODE
821 
823 #define VPX_CTRL_VP9E_SET_ALT_REF_AQ
824 
826 #define VPX_CTRL_VP9E_SET_FRAME_PERIODIC_BOOST
827 
829 #define VPX_CTRL_VP9E_SET_NOISE_SENSITIVITY
830 
831 VPX_CTRL_USE_TYPE(VP9E_SET_TUNE_CONTENT, int) /* vp9e_tune_content */
832 #define VPX_CTRL_VP9E_SET_TUNE_CONTENT
833 
835 #define VPX_CTRL_VP9E_SET_COLOR_SPACE
836 
838 #define VPX_CTRL_VP9E_SET_MIN_GF_INTERVAL
839 
841 #define VPX_CTRL_VP9E_SET_MAX_GF_INTERVAL
842 
844 #define VPX_CTRL_VP9E_GET_ACTIVEMAP
845 
847 #define VPX_CTRL_VP9E_SET_COLOR_RANGE
848 
850 #define VPX_CTRL_VP9E_SET_SVC_REF_FRAME_CONFIG
851 
853 #define VPX_CTRL_VP9E_SET_RENDER_SIZE
854 
856 #define VPX_CTRL_VP9E_SET_TARGET_LEVEL
857 
858 VPX_CTRL_USE_TYPE(VP9E_SET_ROW_MT, unsigned int)
859 #define VPX_CTRL_VP9E_SET_ROW_MT
860 
862 #define VPX_CTRL_VP9E_GET_LEVEL
863 
865 #define VPX_CTRL_VP9E_ENABLE_MOTION_VECTOR_UNIT_TEST
866 
869 #ifdef __cplusplus
870 } // extern "C"
871 #endif
872 
873 #endif // VPX_VP8CX_H_
unsigned char * roi_map
Definition: vp8cx.h:645
#define VPX_CTRL_USE_TYPE(id, typ)
vpx_codec_control type definition macro
Definition: vpx_codec.h:418
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:667
vp8e_enc_control_id
VPx encoder control functions.
Definition: vp8cx.h:125
#define VPX_TS_MAX_LAYERS
Definition: vpx_encoder.h:40
Codec control function to set content type.
Definition: vp8cx.h:449
Codec control function to set noise sensitivity.
Definition: vp8cx.h:414
enum vpx_scaling_mode_1d VPX_SCALING_MODE
vpx 1-D scaling mode
unsigned int cols
Definition: vp8cx.h:647
Codec control function to get bitstream level.
Definition: vp8cx.h:562
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:677
vp8e_token_partitions
VP8 token partition mode.
Definition: vp8cx.h:687
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:556
int spatial_layer_id
Definition: vp8cx.h:716
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:431
Codec control function to set number of tile columns.
Definition: vp8cx.h:344
Codec control function to set target level.
Definition: vp8cx.h:548
unsigned int static_threshold[4]
Definition: vp8cx.h:654
Codec control function to set adaptive quantization mode.
Definition: vp8cx.h:391
Codec control function to set color space info.
Definition: vp8cx.h:480
#define VPX_CTRL_USE_TYPE_DEPRECATED(id, typ)
vpx_codec_control deprecated type definition macro
Definition: vpx_codec.h:444
Codec control function to get svc layer ID.
Definition: vp8cx.h:457
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:587
vp9 svc layer parameters
Definition: vp8cx.h:715
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:630
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:173
Boost percentage for Golden Frame in CBR mode.
Definition: vp8cx.h:287
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:531
int delta_lf[4]
Definition: vp8cx.h:652
vp9e_temporal_layering_mode
Temporal layering mode enum for VP9 SVC.
Definition: vp8cx.h:616
Codec control function to set intended rendering image size.
Definition: vp8cx.h:539
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:634
No temporal layering. Used when only spatial layering is used.
Definition: vp8cx.h:620
Codec control function to enable the extreme motion vector unit test in VP9. Please note that this is...
Definition: vp8cx.h:596
unsigned char * active_map
specify an on (1) or off (0) each 16x16 region within a frame
Definition: vp8cx.h:665
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:626
unsigned int rows
Definition: vp8cx.h:666
Codec control function to set the max no of frames to create arf.
Definition: vp8cx.h:211
int temporal_layer_id
Definition: vp8cx.h:717
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:465
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:406
Codec control function to get an Active map back from the encoder.
Definition: vp8cx.h:514
Provides controls common to both the VP8 encoder and decoder.
Codec control function to set color range bit.
Definition: vp8cx.h:523
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:500
Codec control function to set temporal layering mode.
Definition: vp8cx.h:492
VPX_SCALING_MODE h_scaling_mode
Definition: vp8cx.h:676
Codec control function to set minimum interval between GF/ARF frames.
Definition: vp8cx.h:508
Codec control function to turn on/off SVC in encoder.
Definition: vp8cx.h:423
vpx active region map
Definition: vp8cx.h:663
struct vpx_roi_map vpx_roi_map_t
vpx region of interest map
unsigned int rows
Definition: vp8cx.h:646
Codec control function to enable frame parallel decoding feature.
Definition: vp8cx.h:378
Codec control function to set max data rate for Inter frames.
Definition: vp8cx.h:272
vp9 svc frame flag parameters.
Definition: vp8cx.h:728
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:603
Codec control function to set number of tile rows.
Definition: vp8cx.h:364
vp8e_tuning
VP8 model tuning parameters.
Definition: vp8cx.h:706
Codec control function to set sharpness.
Definition: vp8cx.h:176
vpx region of interest map
Definition: vp8cx.h:643
Codec control function to enable/disable special mode for altref adaptive quantization. You can use it with –aq-mode concurrently.
Definition: vp8cx.h:572
int delta_q[4]
Definition: vp8cx.h:651
vpx image scaling mode
Definition: vp8cx.h:675
Codec control function to set svc layer for spatial and temporal.
Definition: vp8cx.h:440
Codec control function to pass an Active map to encoder.
Definition: vp8cx.h:136
vp9e_tune_content
Definition: vp8cx.h:695