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 
60 
67 #define VP8_EFLAG_NO_REF_GF (1<<17)
68 
69 
76 #define VP8_EFLAG_NO_REF_ARF (1<<21)
77 
78 
84 #define VP8_EFLAG_NO_UPD_LAST (1<<18)
85 
86 
92 #define VP8_EFLAG_NO_UPD_GF (1<<22)
93 
94 
100 #define VP8_EFLAG_NO_UPD_ARF (1<<23)
101 
102 
108 #define VP8_EFLAG_FORCE_GF (1<<19)
109 
110 
116 #define VP8_EFLAG_FORCE_ARF (1<<24)
117 
118 
124 #define VP8_EFLAG_NO_UPD_ENTROPY (1<<20)
125 
126 
140 
146 
152 
165 
171 
180 
186 
192 
198 
206 
215 
221 
227 
230 
236 
246 
261 
267 
282 
297 
308 
316 
331 
354 
374 
388 
401 
416 
424 
433 
441 
450 
459 
467 
475 
490 
501 
509 
517 
523 
532 
540 
548 
557 
563 };
564 
569 typedef enum vpx_scaling_mode_1d {
570  VP8E_NORMAL = 0,
571  VP8E_FOURFIVE = 1,
572  VP8E_THREEFIVE = 2,
573  VP8E_ONETWO = 3
575 
587 
593 
597 
602 
609 typedef struct vpx_roi_map {
611  unsigned char *roi_map;
612  unsigned int rows;
613  unsigned int cols;
614  // TODO(paulwilkins): broken for VP9 which has 8 segments
615  // q and loop filter deltas for each segment
616  // (see MAX_MB_SEGMENTS)
617  int delta_q[4];
618  int delta_lf[4];
620  unsigned int static_threshold[4];
621 } vpx_roi_map_t;
622 
630 typedef struct vpx_active_map {
631  unsigned char *active_map;
632  unsigned int rows;
633  unsigned int cols;
635 
641 typedef struct vpx_scaling_mode {
645 
653 typedef enum {
654  VP8_ONE_TOKENPARTITION = 0,
655  VP8_TWO_TOKENPARTITION = 1,
656  VP8_FOUR_TOKENPARTITION = 2,
657  VP8_EIGHT_TOKENPARTITION = 3
659 
661 typedef enum {
662  VP9E_CONTENT_DEFAULT,
663  VP9E_CONTENT_SCREEN,
664  VP9E_CONTENT_INVALID
666 
672 typedef enum {
673  VP8_TUNE_PSNR,
674  VP8_TUNE_SSIM
675 } vp8e_tuning;
676 
684 typedef struct vpx_svc_layer_id {
688 
697 typedef struct vpx_svc_ref_frame_config {
698  int frame_flags[VPX_TS_MAX_LAYERS];
699  int lst_fb_idx[VPX_TS_MAX_LAYERS];
700  int gld_fb_idx[VPX_TS_MAX_LAYERS];
701  int alt_fb_idx[VPX_TS_MAX_LAYERS];
703 
713 #define VPX_CTRL_VP8E_SET_FRAME_FLAGS
715 #define VPX_CTRL_VP8E_SET_TEMPORAL_LAYER_ID
717 #define VPX_CTRL_VP8E_SET_ROI_MAP
719 #define VPX_CTRL_VP8E_SET_ACTIVEMAP
721 #define VPX_CTRL_VP8E_SET_SCALEMODE
722 
724 #define VPX_CTRL_VP9E_SET_SVC
726 #define VPX_CTRL_VP9E_SET_SVC_PARAMETERS
728 #define VPX_CTRL_VP9E_REGISTER_CX_CALLBACK
730 #define VPX_CTRL_VP9E_SET_SVC_LAYER_ID
731 
733 #define VPX_CTRL_VP8E_SET_CPUUSED
735 #define VPX_CTRL_VP8E_SET_ENABLEAUTOALTREF
737 #define VPX_CTRL_VP8E_SET_NOISE_SENSITIVITY
739 #define VPX_CTRL_VP8E_SET_SHARPNESS
741 #define VPX_CTRL_VP8E_SET_STATIC_THRESHOLD
742 VPX_CTRL_USE_TYPE(VP8E_SET_TOKEN_PARTITIONS, int) /* vp8e_token_partitions */
743 #define VPX_CTRL_VP8E_SET_TOKEN_PARTITIONS
744 
746 #define VPX_CTRL_VP8E_SET_ARNR_MAXFRAMES
748 #define VPX_CTRL_VP8E_SET_ARNR_STRENGTH
750 #define VPX_CTRL_VP8E_SET_ARNR_TYPE
751 VPX_CTRL_USE_TYPE(VP8E_SET_TUNING, int) /* vp8e_tuning */
752 #define VPX_CTRL_VP8E_SET_TUNING
754 #define VPX_CTRL_VP8E_SET_CQ_LEVEL
755 
757 #define VPX_CTRL_VP9E_SET_TILE_COLUMNS
759 #define VPX_CTRL_VP9E_SET_TILE_ROWS
760 
762 #define VPX_CTRL_VP8E_GET_LAST_QUANTIZER
764 #define VPX_CTRL_VP8E_GET_LAST_QUANTIZER_64
766 #define VPX_CTRL_VP9E_GET_SVC_LAYER_ID
767 
769 #define VPX_CTRL_VP8E_SET_MAX_INTRA_BITRATE_PCT
770 VPX_CTRL_USE_TYPE(VP8E_SET_MAX_INTER_BITRATE_PCT, unsigned int)
771 #define VPX_CTRL_VP8E_SET_MAX_INTER_BITRATE_PCT
772 
774 #define VPX_CTRL_VP8E_SET_SCREEN_CONTENT_MODE
775 
777 #define VPX_CTRL_VP9E_SET_GF_CBR_BOOST_PCT
778 
780 #define VPX_CTRL_VP9E_SET_LOSSLESS
781 
783 #define VPX_CTRL_VP9E_SET_FRAME_PARALLEL_DECODING
784 
785 VPX_CTRL_USE_TYPE(VP9E_SET_AQ_MODE, unsigned int)
786 #define VPX_CTRL_VP9E_SET_AQ_MODE
787 
789 #define VPX_CTRL_VP9E_SET_FRAME_PERIODIC_BOOST
790 
792 #define VPX_CTRL_VP9E_SET_NOISE_SENSITIVITY
793 
794 VPX_CTRL_USE_TYPE(VP9E_SET_TUNE_CONTENT, int) /* vp9e_tune_content */
795 #define VPX_CTRL_VP9E_SET_TUNE_CONTENT
796 
798 #define VPX_CTRL_VP9E_SET_COLOR_SPACE
799 
801 #define VPX_CTRL_VP9E_SET_MIN_GF_INTERVAL
802 
804 #define VPX_CTRL_VP9E_SET_MAX_GF_INTERVAL
805 
807 #define VPX_CTRL_VP9E_GET_ACTIVEMAP
808 
810 #define VPX_CTRL_VP9E_SET_COLOR_RANGE
811 
813 #define VPX_CTRL_VP9E_SET_SVC_REF_FRAME_CONFIG
814 
816 #define VPX_CTRL_VP9E_SET_RENDER_SIZE
817 
819 #define VPX_CTRL_VP9E_SET_TARGET_LEVEL
820 
822 #define VPX_CTRL_VP9E_GET_LEVEL
823 
826 #ifdef __cplusplus
827 } // extern "C"
828 #endif
829 
830 #endif // VPX_VP8CX_H_
unsigned char * roi_map
Definition: vp8cx.h:611
Codec control function to set encoder internal speed settings.
Definition: vp8cx.h:164
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:633
vp8e_enc_control_id
VPx encoder control functions.
Definition: vp8cx.h:134
#define VPX_TS_MAX_LAYERS
Definition: vpx_encoder.h:40
Codec control function to set content type.
Definition: vp8cx.h:458
Codec control function to set noise sensitivity.
Definition: vp8cx.h:423
enum vpx_scaling_mode_1d VPX_SCALING_MODE
vpx 1-D scaling mode
unsigned int cols
Definition: vp8cx.h:613
Codec control function to get bitstream level.
Definition: vp8cx.h:562
Codec control function to set reference and update frame flags.
Definition: vp8cx.h:266
Codec control function to set encoder scaling mode.
Definition: vp8cx.h:151
VPX_SCALING_MODE v_scaling_mode
Definition: vp8cx.h:643
vp8e_token_partitions
VP8 token partition mode.
Definition: vp8cx.h:653
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:139
Codec control function to set visual tuning.
Definition: vp8cx.h:235
Codec control function to set constrained quality level.
Definition: vp8cx.h:245
Definition: vp8cx.h:229
int spatial_layer_id
Definition: vp8cx.h:685
Codec control function to set Max data rate for Intra frames.
Definition: vp8cx.h:260
Codec control function to set parameters for SVC.
Definition: vp8cx.h:440
Codec control function to set number of tile columns.
Definition: vp8cx.h:353
#define VPX_CTRL_USE_TYPE(id, typ)
vpx_codec_control type definition macro
Definition: vpx_codec.h:423
Codec control function to set target level.
Definition: vp8cx.h:556
unsigned int static_threshold[4]
Definition: vp8cx.h:620
Codec control function to set adaptive quantization mode.
Definition: vp8cx.h:400
Codec control function to set color space info.
Definition: vp8cx.h:489
Codec control function to get svc layer ID.
Definition: vp8cx.h:466
Codec control function to set lossless encoding mode.
Definition: vp8cx.h:330
Codec control function to get last quantizer chosen by the encoder.
Definition: vp8cx.h:214
vp9 svc layer parameters
Definition: vp8cx.h:684
Codec control function to set the temporal layer id.
Definition: vp8cx.h:307
0-1-0-1... temporal layering scheme with two temporal layers.
Definition: vp8cx.h:596
Codec control function to set the number of token partitions.
Definition: vp8cx.h:197
control function to set noise sensitivity
Definition: vp8cx.h:179
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:296
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
int delta_lf[4]
Definition: vp8cx.h:618
vp9e_temporal_layering_mode
Temporal layering mode enum for VP9 SVC.
Definition: vp8cx.h:582
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:600
No temporal layering. Used when only spatial layering is used.
Definition: vp8cx.h:586
#define VPX_CTRL_USE_TYPE_DEPRECATED(id, typ)
vpx_codec_control deprecated type definition macro
Definition: vpx_codec.h:450
unsigned char * active_map
Definition: vp8cx.h:631
Codec control function to set encoder screen content mode.
Definition: vp8cx.h:315
Bypass mode. Used when application needs to control temporal layering. This will only work when the n...
Definition: vp8cx.h:592
unsigned int rows
Definition: vp8cx.h:632
Codec control function to set the max no of frames to create arf.
Definition: vp8cx.h:220
int temporal_layer_id
Definition: vp8cx.h:686
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:474
Codec control function to set the filter strength for the arf.
Definition: vp8cx.h:226
Codec control function to enable/disable periodic Q boost.
Definition: vp8cx.h:415
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:205
Codec control function to enable automatic set and use alf frames.
Definition: vp8cx.h:170
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:642
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:432
vpx active region map
Definition: vp8cx.h:630
struct vpx_roi_map vpx_roi_map_t
vpx region of interest map
unsigned int rows
Definition: vp8cx.h:612
Codec control function to enable frame parallel decoding feature.
Definition: vp8cx.h:387
Codec control function to set max data rate for Inter frames.
Definition: vp8cx.h:281
vp9 svc frame flag parameters.
Definition: vp8cx.h:697
Codec control function to set the threshold for MBs treated static.
Definition: vp8cx.h:191
vpx_scaling_mode_1d
vpx 1-D scaling mode
Definition: vp8cx.h:569
Codec control function to set number of tile rows.
Definition: vp8cx.h:373
vp8e_tuning
VP8 model tuning parameters.
Definition: vp8cx.h:672
Codec control function to set sharpness.
Definition: vp8cx.h:185
vpx region of interest map
Definition: vp8cx.h:609
int delta_q[4]
Definition: vp8cx.h:617
vpx image scaling mode
Definition: vp8cx.h:641
Codec control function to set svc layer for spatial and temporal.
Definition: vp8cx.h:449
Codec control function to pass an Active map to encoder.
Definition: vp8cx.h:145
vp9e_tune_content
Definition: vp8cx.h:661