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
27extern "C" {
28#endif
29
35extern vpx_codec_iface_t vpx_codec_vp8_cx_algo;
36extern vpx_codec_iface_t *vpx_codec_vp8_cx(void);
44extern vpx_codec_iface_t vpx_codec_vp9_cx_algo;
45extern 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
433
442
452
460
468
483
495
503
511
517
526
534
542
551
559
565
575
590
599};
600
606 VP8E_NORMAL = 0,
607 VP8E_FOURFIVE = 1,
608 VP8E_THREEFIVE = 2,
609 VP8E_ONETWO = 3
611
623
629
633
638
645typedef struct vpx_roi_map {
647 unsigned char *roi_map;
648 unsigned int rows;
649 unsigned int cols;
650 // TODO(paulwilkins): broken for VP9 which has 8 segments
651 // q and loop filter deltas for each segment
652 // (see MAX_MB_SEGMENTS)
653 int delta_q[4];
654 int delta_lf[4];
656 unsigned int static_threshold[4];
658
665typedef struct vpx_active_map {
667 unsigned char *active_map;
668 unsigned int rows;
669 unsigned int cols;
671
677typedef struct vpx_scaling_mode {
681
689typedef enum {
690 VP8_ONE_TOKENPARTITION = 0,
691 VP8_TWO_TOKENPARTITION = 1,
692 VP8_FOUR_TOKENPARTITION = 2,
693 VP8_EIGHT_TOKENPARTITION = 3
695
697typedef enum {
698 VP9E_CONTENT_DEFAULT,
699 VP9E_CONTENT_SCREEN,
700 VP9E_CONTENT_FILM,
701 VP9E_CONTENT_INVALID
703
709typedef enum { VP8_TUNE_PSNR, VP8_TUNE_SSIM } vp8e_tuning;
710
718typedef struct vpx_svc_layer_id {
722
737
747#define VPX_CTRL_VP8E_SET_FRAME_FLAGS
749#define VPX_CTRL_VP8E_SET_TEMPORAL_LAYER_ID
751#define VPX_CTRL_VP8E_SET_ROI_MAP
753#define VPX_CTRL_VP8E_SET_ACTIVEMAP
755#define VPX_CTRL_VP8E_SET_SCALEMODE
756
758#define VPX_CTRL_VP9E_SET_SVC
760#define VPX_CTRL_VP9E_SET_SVC_PARAMETERS
762#define VPX_CTRL_VP9E_REGISTER_CX_CALLBACK
764#define VPX_CTRL_VP9E_SET_SVC_LAYER_ID
765
767#define VPX_CTRL_VP8E_SET_CPUUSED
769#define VPX_CTRL_VP8E_SET_ENABLEAUTOALTREF
771#define VPX_CTRL_VP8E_SET_NOISE_SENSITIVITY
773#define VPX_CTRL_VP8E_SET_SHARPNESS
775#define VPX_CTRL_VP8E_SET_STATIC_THRESHOLD
776VPX_CTRL_USE_TYPE(VP8E_SET_TOKEN_PARTITIONS, int) /* vp8e_token_partitions */
777#define VPX_CTRL_VP8E_SET_TOKEN_PARTITIONS
778
780#define VPX_CTRL_VP8E_SET_ARNR_MAXFRAMES
782#define VPX_CTRL_VP8E_SET_ARNR_STRENGTH
784#define VPX_CTRL_VP8E_SET_ARNR_TYPE
785VPX_CTRL_USE_TYPE(VP8E_SET_TUNING, int) /* vp8e_tuning */
786#define VPX_CTRL_VP8E_SET_TUNING
788#define VPX_CTRL_VP8E_SET_CQ_LEVEL
789
791#define VPX_CTRL_VP9E_SET_TILE_COLUMNS
793#define VPX_CTRL_VP9E_SET_TILE_ROWS
794
796#define VPX_CTRL_VP8E_GET_LAST_QUANTIZER
798#define VPX_CTRL_VP8E_GET_LAST_QUANTIZER_64
800#define VPX_CTRL_VP9E_GET_SVC_LAYER_ID
801
803#define VPX_CTRL_VP8E_SET_MAX_INTRA_BITRATE_PCT
804VPX_CTRL_USE_TYPE(VP8E_SET_MAX_INTER_BITRATE_PCT, unsigned int)
805#define VPX_CTRL_VP8E_SET_MAX_INTER_BITRATE_PCT
806
808#define VPX_CTRL_VP8E_SET_GF_CBR_BOOST_PCT
809
811#define VPX_CTRL_VP8E_SET_SCREEN_CONTENT_MODE
812
814#define VPX_CTRL_VP9E_SET_GF_CBR_BOOST_PCT
815
817#define VPX_CTRL_VP9E_SET_LOSSLESS
818
820#define VPX_CTRL_VP9E_SET_FRAME_PARALLEL_DECODING
821
823#define VPX_CTRL_VP9E_SET_AQ_MODE
824
826#define VPX_CTRL_VP9E_SET_ALT_REF_AQ
827
829#define VPX_CTRL_VP9E_SET_FRAME_PERIODIC_BOOST
830
832#define VPX_CTRL_VP9E_SET_NOISE_SENSITIVITY
833
834VPX_CTRL_USE_TYPE(VP9E_SET_TUNE_CONTENT, int) /* vp9e_tune_content */
835#define VPX_CTRL_VP9E_SET_TUNE_CONTENT
836
838#define VPX_CTRL_VP9E_SET_COLOR_SPACE
839
841#define VPX_CTRL_VP9E_SET_MIN_GF_INTERVAL
842
844#define VPX_CTRL_VP9E_SET_MAX_GF_INTERVAL
845
847#define VPX_CTRL_VP9E_GET_ACTIVEMAP
848
850#define VPX_CTRL_VP9E_SET_COLOR_RANGE
851
853#define VPX_CTRL_VP9E_SET_SVC_REF_FRAME_CONFIG
854
856#define VPX_CTRL_VP9E_SET_RENDER_SIZE
857
859#define VPX_CTRL_VP9E_SET_TARGET_LEVEL
860
862#define VPX_CTRL_VP9E_SET_ROW_MT
863
865#define VPX_CTRL_VP9E_GET_LEVEL
866
868#define VPX_CTRL_VP9E_ENABLE_MOTION_VECTOR_UNIT_TEST
869
872#ifdef __cplusplus
873} // extern "C"
874#endif
875
876#endif // VPX_VP8CX_H_
#define VPX_CTRL_USE_TYPE_DEPRECATED(id, typ)
vpx_codec_control deprecated type definition macro
Definition: vpx_codec.h:445
#define VPX_CTRL_USE_TYPE(id, typ)
vpx_codec_control type definition macro
Definition: vpx_codec.h:419
const struct vpx_codec_iface vpx_codec_iface_t
Codec interface structure.
Definition: vpx_codec.h:174
#define VPX_TS_MAX_LAYERS
Definition: vpx_encoder.h:40
struct vpx_active_map vpx_active_map_t
vpx active region map
struct vpx_svc_layer_id vpx_svc_layer_id_t
vp9 svc layer parameters
vp8e_tuning
VP8 model tuning parameters.
Definition: vp8cx.h:709
enum vp9e_temporal_layering_mode VP9E_TEMPORAL_LAYERING_MODE
Temporal layering mode enum for VP9 SVC.
struct vpx_scaling_mode vpx_scaling_mode_t
vpx image scaling mode
vp8e_token_partitions
VP8 token partition mode.
Definition: vp8cx.h:689
vp8e_enc_control_id
VPx encoder control functions.
Definition: vp8cx.h:125
vpx_scaling_mode_1d
vpx 1-D scaling mode
Definition: vp8cx.h:605
vp9e_tune_content
Definition: vp8cx.h:697
struct vpx_roi_map vpx_roi_map_t
vpx region of interest map
struct vpx_svc_ref_frame_config vpx_svc_ref_frame_config_t
vp9 svc frame flag parameters.
vp9e_temporal_layering_mode
Temporal layering mode enum for VP9 SVC.
Definition: vp8cx.h:618
enum vpx_scaling_mode_1d VPX_SCALING_MODE
vpx 1-D scaling mode
@ VP9E_SET_MIN_GF_INTERVAL
Codec control function to set minimum interval between GF/ARF frames.
Definition: vp8cx.h:502
@ VP9E_SET_MAX_INTER_BITRATE_PCT
Codec control function to set max data rate for Inter frames.
Definition: vp8cx.h:272
@ VP9E_SET_FRAME_PERIODIC_BOOST
Codec control function to enable/disable periodic Q boost.
Definition: vp8cx.h:407
@ VP9E_SET_SVC_LAYER_ID
Codec control function to set svc layer for spatial and temporal.
Definition: vp8cx.h:441
@ VP8E_SET_MAX_INTRA_BITRATE_PCT
Codec control function to set Max data rate for Intra frames.
Definition: vp8cx.h:251
@ VP8E_SET_ARNR_STRENGTH
Codec control function to set the filter strength for the arf.
Definition: vp8cx.h:217
@ VP8E_SET_TUNING
Codec control function to set visual tuning.
Definition: vp8cx.h:226
@ VP8E_SET_ENABLEAUTOALTREF
Codec control function to enable automatic set and use alf frames.
Definition: vp8cx.h:161
@ VP8E_SET_ROI_MAP
Codec control function to pass an ROI map to encoder.
Definition: vp8cx.h:130
@ VP9E_SET_TARGET_LEVEL
Codec control function to set target level.
Definition: vp8cx.h:550
@ VP9E_GET_LEVEL
Codec control function to get bitstream level.
Definition: vp8cx.h:564
@ VP9E_ENABLE_MOTION_VECTOR_UNIT_TEST
Codec control function to enable the extreme motion vector unit test in VP9. Please note that this is...
Definition: vp8cx.h:598
@ VP9E_SET_TEMPORAL_LAYERING_MODE
Codec control function to set temporal layering mode.
Definition: vp8cx.h:494
@ VP9E_SET_AQ_MODE
Codec control function to set adaptive quantization mode.
Definition: vp8cx.h:392
@ VP8E_SET_NOISE_SENSITIVITY
control function to set noise sensitivity
Definition: vp8cx.h:170
@ VP8E_SET_TOKEN_PARTITIONS
Codec control function to set the number of token partitions.
Definition: vp8cx.h:188
@ VP9E_REGISTER_CX_CALLBACK
Codec control function to register callback to get per layer packet.
Definition: vp8cx.h:467
@ VP8E_SET_ARNR_TYPE
Definition: vp8cx.h:220
@ VP9E_SET_COLOR_RANGE
Codec control function to set color range bit.
Definition: vp8cx.h:525
@ VP8E_GET_LAST_QUANTIZER
Codec control function to get last quantizer chosen by the encoder.
Definition: vp8cx.h:196
@ VP9E_SET_TILE_ROWS
Codec control function to set number of tile rows.
Definition: vp8cx.h:365
@ VP8E_SET_ARNR_MAXFRAMES
Codec control function to set the max no of frames to create arf.
Definition: vp8cx.h:211
@ VP8E_SET_ACTIVEMAP
Codec control function to pass an Active map to encoder.
Definition: vp8cx.h:136
@ VP9E_SET_LOSSLESS
Codec control function to set lossless encoding mode.
Definition: vp8cx.h:321
@ VP9E_SET_SVC_PARAMETERS
Codec control function to set parameters for SVC.
Definition: vp8cx.h:432
@ VP8E_SET_SCALEMODE
Codec control function to set encoder scaling mode.
Definition: vp8cx.h:142
@ VP9E_SET_FRAME_PARALLEL_DECODING
Codec control function to enable frame parallel decoding feature.
Definition: vp8cx.h:379
@ VP8E_SET_SHARPNESS
Codec control function to set sharpness.
Definition: vp8cx.h:176
@ VP8E_SET_GF_CBR_BOOST_PCT
Boost percentage for Golden Frame in CBR mode.
Definition: vp8cx.h:589
@ VP9E_SET_TUNE_CONTENT
Codec control function to set content type.
Definition: vp8cx.h:451
@ VP9E_SET_SVC
Codec control function to turn on/off SVC in encoder.
Definition: vp8cx.h:424
@ VP9E_SET_ROW_MT
Codec control function to set row level multi-threading.
Definition: vp8cx.h:558
@ VP8E_SET_CPUUSED
Codec control function to set encoder internal speed settings.
Definition: vp8cx.h:155
@ VP8E_SET_TEMPORAL_LAYER_ID
Codec control function to set the temporal layer id.
Definition: vp8cx.h:298
@ VP9E_SET_TILE_COLUMNS
Codec control function to set number of tile columns.
Definition: vp8cx.h:345
@ VP9E_SET_SVC_REF_FRAME_CONFIG
Codec control function to set the frame flags and buffer indices for spatial layers....
Definition: vp8cx.h:533
@ VP8E_SET_STATIC_THRESHOLD
Codec control function to set the threshold for MBs treated static.
Definition: vp8cx.h:182
@ VP9E_SET_COLOR_SPACE
Codec control function to set color space info.
Definition: vp8cx.h:482
@ VP9E_SET_RENDER_SIZE
Codec control function to set intended rendering image size.
Definition: vp8cx.h:541
@ VP8E_SET_SCREEN_CONTENT_MODE
Codec control function to set encoder screen content mode.
Definition: vp8cx.h:306
@ VP8E_SET_CQ_LEVEL
Codec control function to set constrained quality level.
Definition: vp8cx.h:236
@ VP9E_SET_NOISE_SENSITIVITY
Codec control function to set noise sensitivity.
Definition: vp8cx.h:415
@ VP8E_GET_LAST_QUANTIZER_64
Codec control function to get last quantizer chosen by the encoder.
Definition: vp8cx.h:205
@ VP8E_SET_FRAME_FLAGS
Codec control function to set reference and update frame flags.
Definition: vp8cx.h:257
@ VP9E_GET_ACTIVEMAP
Codec control function to get an Active map back from the encoder.
Definition: vp8cx.h:516
@ VP9E_SET_GF_CBR_BOOST_PCT
Boost percentage for Golden Frame in CBR mode.
Definition: vp8cx.h:287
@ VP9E_GET_SVC_LAYER_ID
Codec control function to get svc layer ID.
Definition: vp8cx.h:459
@ VP9E_SET_MAX_GF_INTERVAL
Codec control function to set minimum interval between GF/ARF frames.
Definition: vp8cx.h:510
@ VP9E_SET_ALT_REF_AQ
Codec control function to enable/disable special mode for altref adaptive quantization....
Definition: vp8cx.h:574
@ VP9E_TEMPORAL_LAYERING_MODE_BYPASS
Bypass mode. Used when application needs to control temporal layering. This will only work when the n...
Definition: vp8cx.h:628
@ VP9E_TEMPORAL_LAYERING_MODE_0101
0-1-0-1... temporal layering scheme with two temporal layers.
Definition: vp8cx.h:632
@ VP9E_TEMPORAL_LAYERING_MODE_NOLAYERING
No temporal layering. Used when only spatial layering is used.
Definition: vp8cx.h:622
@ VP9E_TEMPORAL_LAYERING_MODE_0212
0-2-1-2... temporal layering scheme with three temporal layers.
Definition: vp8cx.h:636
vpx active region map
Definition: vp8cx.h:665
unsigned int rows
Definition: vp8cx.h:668
unsigned int cols
Definition: vp8cx.h:669
unsigned char * active_map
specify an on (1) or off (0) each 16x16 region within a frame
Definition: vp8cx.h:667
vpx region of interest map
Definition: vp8cx.h:645
unsigned int static_threshold[4]
Definition: vp8cx.h:656
unsigned int rows
Definition: vp8cx.h:648
int delta_lf[4]
Definition: vp8cx.h:654
unsigned int cols
Definition: vp8cx.h:649
int delta_q[4]
Definition: vp8cx.h:653
unsigned char * roi_map
Definition: vp8cx.h:647
vpx image scaling mode
Definition: vp8cx.h:677
VPX_SCALING_MODE v_scaling_mode
Definition: vp8cx.h:679
VPX_SCALING_MODE h_scaling_mode
Definition: vp8cx.h:678
vp9 svc layer parameters
Definition: vp8cx.h:718
int temporal_layer_id
Definition: vp8cx.h:720
int spatial_layer_id
Definition: vp8cx.h:719
vp9 svc frame flag parameters.
Definition: vp8cx.h:731
int lst_fb_idx[5]
Definition: vp8cx.h:733
int gld_fb_idx[5]
Definition: vp8cx.h:734
int alt_fb_idx[5]
Definition: vp8cx.h:735
int frame_flags[5]
Definition: vp8cx.h:732
Provides controls common to both the VP8 encoder and decoder.
Describes the encoder algorithm interface to applications.