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 
555 
565 
580 };
581 
586 typedef enum vpx_scaling_mode_1d {
587  VP8E_NORMAL = 0,
588  VP8E_FOURFIVE = 1,
589  VP8E_THREEFIVE = 2,
590  VP8E_ONETWO = 3
592 
604 
610 
614 
619 
626 typedef struct vpx_roi_map {
628  unsigned char *roi_map;
629  unsigned int rows;
630  unsigned int cols;
631  // TODO(paulwilkins): broken for VP9 which has 8 segments
632  // q and loop filter deltas for each segment
633  // (see MAX_MB_SEGMENTS)
634  int delta_q[4];
635  int delta_lf[4];
637  unsigned int static_threshold[4];
638 } vpx_roi_map_t;
639 
646 typedef struct vpx_active_map {
648  unsigned char *active_map;
649  unsigned int rows;
650  unsigned int cols;
652 
658 typedef struct vpx_scaling_mode {
662 
670 typedef enum {
671  VP8_ONE_TOKENPARTITION = 0,
672  VP8_TWO_TOKENPARTITION = 1,
673  VP8_FOUR_TOKENPARTITION = 2,
674  VP8_EIGHT_TOKENPARTITION = 3
676 
678 typedef enum {
679  VP9E_CONTENT_DEFAULT,
680  VP9E_CONTENT_SCREEN,
681  VP9E_CONTENT_INVALID
683 
689 typedef enum { VP8_TUNE_PSNR, VP8_TUNE_SSIM } vp8e_tuning;
690 
698 typedef struct vpx_svc_layer_id {
702 
711 typedef struct vpx_svc_ref_frame_config {
712  int frame_flags[VPX_TS_MAX_LAYERS];
713  int lst_fb_idx[VPX_TS_MAX_LAYERS];
714  int gld_fb_idx[VPX_TS_MAX_LAYERS];
715  int alt_fb_idx[VPX_TS_MAX_LAYERS];
717 
727 #define VPX_CTRL_VP8E_SET_FRAME_FLAGS
729 #define VPX_CTRL_VP8E_SET_TEMPORAL_LAYER_ID
731 #define VPX_CTRL_VP8E_SET_ROI_MAP
733 #define VPX_CTRL_VP8E_SET_ACTIVEMAP
735 #define VPX_CTRL_VP8E_SET_SCALEMODE
736 
738 #define VPX_CTRL_VP9E_SET_SVC
740 #define VPX_CTRL_VP9E_SET_SVC_PARAMETERS
742 #define VPX_CTRL_VP9E_REGISTER_CX_CALLBACK
744 #define VPX_CTRL_VP9E_SET_SVC_LAYER_ID
745 
747 #define VPX_CTRL_VP8E_SET_CPUUSED
749 #define VPX_CTRL_VP8E_SET_ENABLEAUTOALTREF
751 #define VPX_CTRL_VP8E_SET_NOISE_SENSITIVITY
753 #define VPX_CTRL_VP8E_SET_SHARPNESS
755 #define VPX_CTRL_VP8E_SET_STATIC_THRESHOLD
756 VPX_CTRL_USE_TYPE(VP8E_SET_TOKEN_PARTITIONS, int) /* vp8e_token_partitions */
757 #define VPX_CTRL_VP8E_SET_TOKEN_PARTITIONS
758 
760 #define VPX_CTRL_VP8E_SET_ARNR_MAXFRAMES
762 #define VPX_CTRL_VP8E_SET_ARNR_STRENGTH
764 #define VPX_CTRL_VP8E_SET_ARNR_TYPE
765 VPX_CTRL_USE_TYPE(VP8E_SET_TUNING, int) /* vp8e_tuning */
766 #define VPX_CTRL_VP8E_SET_TUNING
768 #define VPX_CTRL_VP8E_SET_CQ_LEVEL
769 
771 #define VPX_CTRL_VP9E_SET_TILE_COLUMNS
773 #define VPX_CTRL_VP9E_SET_TILE_ROWS
774 
776 #define VPX_CTRL_VP8E_GET_LAST_QUANTIZER
778 #define VPX_CTRL_VP8E_GET_LAST_QUANTIZER_64
780 #define VPX_CTRL_VP9E_GET_SVC_LAYER_ID
781 
783 #define VPX_CTRL_VP8E_SET_MAX_INTRA_BITRATE_PCT
784 VPX_CTRL_USE_TYPE(VP8E_SET_MAX_INTER_BITRATE_PCT, unsigned int)
785 #define VPX_CTRL_VP8E_SET_MAX_INTER_BITRATE_PCT
786 
788 #define VPX_CTRL_VP8E_SET_GF_CBR_BOOST_PCT
789 
791 #define VPX_CTRL_VP8E_SET_SCREEN_CONTENT_MODE
792 
794 #define VPX_CTRL_VP9E_SET_GF_CBR_BOOST_PCT
795 
797 #define VPX_CTRL_VP9E_SET_LOSSLESS
798 
800 #define VPX_CTRL_VP9E_SET_FRAME_PARALLEL_DECODING
801 
802 VPX_CTRL_USE_TYPE(VP9E_SET_AQ_MODE, unsigned int)
803 #define VPX_CTRL_VP9E_SET_AQ_MODE
804 
806 #define VPX_CTRL_VP9E_SET_ALT_REF_AQ
807 
809 #define VPX_CTRL_VP9E_SET_FRAME_PERIODIC_BOOST
810 
812 #define VPX_CTRL_VP9E_SET_NOISE_SENSITIVITY
813 
814 VPX_CTRL_USE_TYPE(VP9E_SET_TUNE_CONTENT, int) /* vp9e_tune_content */
815 #define VPX_CTRL_VP9E_SET_TUNE_CONTENT
816 
818 #define VPX_CTRL_VP9E_SET_COLOR_SPACE
819 
821 #define VPX_CTRL_VP9E_SET_MIN_GF_INTERVAL
822 
824 #define VPX_CTRL_VP9E_SET_MAX_GF_INTERVAL
825 
827 #define VPX_CTRL_VP9E_GET_ACTIVEMAP
828 
830 #define VPX_CTRL_VP9E_SET_COLOR_RANGE
831 
833 #define VPX_CTRL_VP9E_SET_SVC_REF_FRAME_CONFIG
834 
836 #define VPX_CTRL_VP9E_SET_RENDER_SIZE
837 
839 #define VPX_CTRL_VP9E_SET_TARGET_LEVEL
840 
842 #define VPX_CTRL_VP9E_GET_LEVEL
843 
846 #ifdef __cplusplus
847 } // extern "C"
848 #endif
849 
850 #endif // VPX_VP8CX_H_
unsigned char * roi_map
Definition: vp8cx.h:628
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:650
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:630
Codec control function to get bitstream level.
Definition: vp8cx.h:554
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:660
vp8e_token_partitions
VP8 token partition mode.
Definition: vp8cx.h:670
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
int spatial_layer_id
Definition: vp8cx.h:699
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
#define VPX_CTRL_USE_TYPE(id, typ)
vpx_codec_control type definition macro
Definition: vpx_codec.h:414
Codec control function to set target level.
Definition: vp8cx.h:548
unsigned int static_threshold[4]
Definition: vp8cx.h:637
Codec control function to set adaptive quantization mode.
Definition: vp8cx.h:391
Codec control function to set color space info.
Definition: vp8cx.h:480
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:579
vp9 svc layer parameters
Definition: vp8cx.h:698
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:613
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:169
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:635
vp9e_temporal_layering_mode
Temporal layering mode enum for VP9 SVC.
Definition: vp8cx.h:599
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:617
No temporal layering. Used when only spatial layering is used.
Definition: vp8cx.h:603
#define VPX_CTRL_USE_TYPE_DEPRECATED(id, typ)
vpx_codec_control deprecated type definition macro
Definition: vpx_codec.h:440
unsigned char * active_map
specify an on (1) or off (0) each 16x16 region within a frame
Definition: vp8cx.h:648
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:609
unsigned int rows
Definition: vp8cx.h:649
Codec control function to set the max no of frames to create arf.
Definition: vp8cx.h:211
int temporal_layer_id
Definition: vp8cx.h:700
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:659
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:646
struct vpx_roi_map vpx_roi_map_t
vpx region of interest map
unsigned int rows
Definition: vp8cx.h:629
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:711
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:586
Codec control function to set number of tile rows.
Definition: vp8cx.h:364
vp8e_tuning
VP8 model tuning parameters.
Definition: vp8cx.h:689
Codec control function to set sharpness.
Definition: vp8cx.h:176
vpx region of interest map
Definition: vp8cx.h:626
Codec control function to enable/disable special mode for altref adaptive quantization. You can use it with –aq-mode concurrently.
Definition: vp8cx.h:564
int delta_q[4]
Definition: vp8cx.h:634
vpx image scaling mode
Definition: vp8cx.h:658
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:678