Go to the documentation of this file.
10 #ifndef VPX_VPX_VPX_ENCODER_H_
11 #define VPX_VPX_VPX_ENCODER_H_
37 #define VPX_TS_MAX_PERIODICITY 16
40 #define VPX_TS_MAX_LAYERS 5
43 #define VPX_MAX_LAYERS 12 // 3 temporal + 4 spatial layers are allowed.
46 #define VPX_SS_MAX_LAYERS 5
49 #define VPX_SS_DEFAULT_LAYERS 1
59 #define VPX_ENCODER_ABI_VERSION \
60 (14 + VPX_CODEC_ABI_VERSION)
71 #define VPX_CODEC_CAP_PSNR 0x10000
78 #define VPX_CODEC_CAP_OUTPUT_PARTITION 0x20000
87 #define VPX_CODEC_USE_PSNR 0x10000
89 #define VPX_CODEC_USE_OUTPUT_PARTITION 0x20000
90 #define VPX_CODEC_USE_HIGHBITDEPTH 0x40000
96 typedef struct vpx_fixed_buf {
116 #define VPX_FRAME_IS_KEY 0x1
119 #define VPX_FRAME_IS_DROPPABLE 0x2
121 #define VPX_FRAME_IS_INVISIBLE 0x4
123 #define VPX_FRAME_IS_FRAGMENT 0x8
133 #define VPX_ERROR_RESILIENT_DEFAULT 0x1
138 #define VPX_ERROR_RESILIENT_PARTITIONS 0x2
184 struct vpx_psnr_pkt {
260 #define VPX_EFLAG_FORCE_KF (1 << 0)
268 typedef struct vpx_codec_enc_cfg {
741 #define vpx_codec_enc_init(ctx, iface, cfg, flags) \
742 vpx_codec_enc_init_ver(ctx, iface, cfg, flags, VPX_ENCODER_ABI_VERSION)
772 #define vpx_codec_enc_init_multi(ctx, iface, cfg, num_enc, flags, dsf) \
773 vpx_codec_enc_init_multi_ver(ctx, iface, cfg, num_enc, flags, dsf, \
774 VPX_ENCODER_ABI_VERSION)
830 #define VPX_DL_REALTIME (1)
832 #define VPX_DL_GOOD_QUALITY (1000000)
834 #define VPX_DL_BEST_QUALITY (0)
874 unsigned long deadline);
921 unsigned int pad_before,
922 unsigned int pad_after);
968 #endif // VPX_VPX_VPX_ENCODER_H_
unsigned int rc_2pass_vbr_minsection_pct
Two-pass mode per-GOP minimum bitrate.
Definition: vpx_encoder.h:570
struct vpx_codec_enc_cfg vpx_codec_enc_cfg_t
Encoder configuration structure.
vpx_codec_err_t vpx_codec_enc_config_set(vpx_codec_ctx_t *ctx, const vpx_codec_enc_cfg_t *cfg)
Set or change configuration.
vp9 svc extra configure parameters
Definition: vpx_encoder.h:701
int max_quantizers[12]
Definition: vpx_encoder.h:702
vpx_fixed_buf_t rc_firstpass_mb_stats_in
first pass mb stats buffer.
Definition: vpx_encoder.h:454
uint64_t sse[4]
Definition: vpx_encoder.h:186
Codec context structure.
Definition: vpx_codec.h:197
unsigned int rc_2pass_vbr_corpus_complexity
Two-pass corpus vbr mode complexity control Used only in VP9: A value representing the corpus midpoin...
Definition: vpx_encoder.h:584
unsigned int rc_scaled_height
Internal coded frame height.
Definition: vpx_encoder.h:414
#define VPX_SS_MAX_LAYERS
Definition: vpx_encoder.h:46
Generic fixed size buffer structure.
Definition: vpx_encoder.h:96
vpx_fixed_buf_t * vpx_codec_get_global_headers(vpx_codec_ctx_t *ctx)
Get global stream headers.
enum vpx_codec_cx_pkt_kind kind
Definition: vpx_encoder.h:160
unsigned int ss_number_layers
Number of spatial coding layers.
Definition: vpx_encoder.h:624
union vpx_codec_cx_pkt::@1 data
vpx_fixed_buf_t rc_twopass_stats_in
Two-pass stats buffer.
Definition: vpx_encoder.h:447
Encoder configuration structure.
Definition: vpx_encoder.h:268
unsigned int kf_max_dist
Keyframe maximum interval.
Definition: vpx_encoder.h:614
@ VPX_CODEC_PSNR_PKT
Definition: vpx_encoder.h:150
int min_quantizers[12]
Definition: vpx_encoder.h:703
unsigned int height[5]
Definition: vpx_encoder.h:177
@ VPX_VBR
Definition: vpx_encoder.h:232
long vpx_enc_frame_flags_t
Encoded Frame Flags.
Definition: vpx_encoder.h:259
unsigned int rc_buf_sz
Decoder Buffer Size.
Definition: vpx_encoder.h:531
int num
Definition: vpx_encoder.h:219
uint8_t spatial_layer_encoded[5]
Flag to indicate if spatial layer frame in this packet is encoded or dropped. VP8 will always be set ...
Definition: vpx_encoder.h:180
vpx_fixed_buf_t firstpass_mb_stats
Definition: vpx_encoder.h:183
vpx_codec_err_t vpx_codec_enc_init_ver(vpx_codec_ctx_t *ctx, vpx_codec_iface_t *iface, const vpx_codec_enc_cfg_t *cfg, vpx_codec_flags_t flags, int ver)
Initialize an encoder instance.
struct vpx_codec_cx_pkt vpx_codec_cx_pkt_t
Encoder output packet.
const vpx_codec_cx_pkt_t * vpx_codec_get_cx_data(vpx_codec_ctx_t *ctx, vpx_codec_iter_t *iter)
Encoded data iterator.
Encoder output packet.
Definition: vpx_encoder.h:159
const typedef void * vpx_codec_iter_t
Iterator.
Definition: vpx_codec.h:187
unsigned int g_w
Width of the frame.
Definition: vpx_encoder.h:304
@ VPX_CODEC_CX_FRAME_PKT
Definition: vpx_encoder.h:147
#define VPX_TS_MAX_LAYERS
Definition: vpx_encoder.h:40
unsigned int rc_scaled_width
Internal coded frame width.
Definition: vpx_encoder.h:407
unsigned int g_profile
Bitstream profile to use.
Definition: vpx_encoder.h:295
unsigned int rc_overshoot_pct
Rate control adaptation overshoot control.
Definition: vpx_encoder.h:516
unsigned int rc_resize_down_thresh
Spatial resampling down watermark.
Definition: vpx_encoder.h:430
#define VPX_MAX_LAYERS
Definition: vpx_encoder.h:43
@ VPX_CODEC_STATS_PKT
Definition: vpx_encoder.h:148
int64_t vpx_codec_pts_t
Time Stamp Type.
Definition: vpx_encoder.h:106
@ VPX_RC_LAST_PASS
Definition: vpx_encoder.h:227
int scaling_factor_den[12]
Definition: vpx_encoder.h:705
@ VPX_CODEC_CUSTOM_PKT
Definition: vpx_encoder.h:151
vpx_bit_depth_t g_bit_depth
Bit-depth of the codec.
Definition: vpx_encoder.h:321
double psnr[4]
Definition: vpx_encoder.h:187
#define VPX_TS_MAX_PERIODICITY
Definition: vpx_encoder.h:37
unsigned int rc_dropframe_thresh
Temporal resampling configuration, if supported by the codec.
Definition: vpx_encoder.h:391
int scaling_factor_num[12]
Definition: vpx_encoder.h:704
void * user_priv
Definition: vpx_encoder.h:211
vpx_codec_er_flags_t g_error_resilient
Enable error resilient modes.
Definition: vpx_encoder.h:351
Image Descriptor.
Definition: vpx_image.h:71
unsigned int g_h
Height of the frame.
Definition: vpx_encoder.h:313
unsigned int rc_resize_up_thresh
Spatial resampling up watermark.
Definition: vpx_encoder.h:422
vpx_codec_enc_output_cx_pkt_cb_fn_t output_cx_pkt
Definition: vpx_encoder.h:210
unsigned int g_usage
Deprecated: Algorithm specific "usage" value.
Definition: vpx_encoder.h:277
unsigned int rc_max_quantizer
Maximum (Worst Quality) Quantizer.
Definition: vpx_encoder.h:482
unsigned int g_lag_in_frames
Allow lagged encoding.
Definition: vpx_encoder.h:372
size_t sz
Definition: vpx_encoder.h:164
vpx_codec_err_t vpx_codec_enc_init_multi_ver(vpx_codec_ctx_t *ctx, vpx_codec_iface_t *iface, vpx_codec_enc_cfg_t *cfg, int num_enc, vpx_codec_flags_t flags, vpx_rational_t *dsf, int ver)
Initialize multi-encoder instance.
vpx_codec_err_t
Algorithm return codes.
Definition: vpx_codec.h:90
void * buf
Definition: vpx_encoder.h:163
unsigned int rc_resize_allowed
Enable/disable spatial resampling, if supported by the codec.
Definition: vpx_encoder.h:400
long vpx_codec_flags_t
Initialization-time Feature Enabling.
Definition: vpx_codec.h:167
vpx_codec_frame_flags_t flags
Definition: vpx_encoder.h:169
vpx_enc_pass
Multi-pass Encoding Pass.
Definition: vpx_encoder.h:224
unsigned long duration
duration to show frame (in timebase units)
Definition: vpx_encoder.h:168
@ VPX_KF_FIXED
Definition: vpx_encoder.h:247
int partition_id
the partition id defines the decoding order of the partitions. Only applicable when "output partition...
Definition: vpx_encoder.h:173
char pad[128 - sizeof(enum vpx_codec_cx_pkt_kind)]
Definition: vpx_encoder.h:196
vpx_fixed_buf_t raw
Definition: vpx_encoder.h:189
Callback function pointer / user data pair storage.
Definition: vpx_encoder.h:209
const struct vpx_codec_iface vpx_codec_iface_t
Codec interface structure.
Definition: vpx_codec.h:174
vpx_codec_pts_t pts
time stamp to show frame (in timebase units)
Definition: vpx_encoder.h:166
unsigned int g_input_bit_depth
Bit-depth of the input frames.
Definition: vpx_encoder.h:329
@ VPX_CQ
Definition: vpx_encoder.h:234
@ VPX_RC_FIRST_PASS
Definition: vpx_encoder.h:226
unsigned int rc_2pass_vbr_bias_pct
Two-pass mode CBR/VBR bias.
Definition: vpx_encoder.h:563
unsigned int kf_min_dist
Keyframe minimum interval.
Definition: vpx_encoder.h:605
unsigned int rc_min_quantizer
Minimum (Best Quality) Quantizer.
Definition: vpx_encoder.h:473
enum vpx_bit_depth vpx_bit_depth_t
Bit depth for codecThis enumeration determines the bit depth of the codec.
unsigned int rc_buf_initial_sz
Decoder Buffer Initial Size.
Definition: vpx_encoder.h:540
size_t sz
Definition: vpx_encoder.h:98
void(* vpx_codec_enc_output_cx_pkt_cb_fn_t)(vpx_codec_cx_pkt_t *pkt, void *user_data)
Encoder return output buffer callback.
Definition: vpx_encoder.h:205
struct vpx_fixed_buf vpx_fixed_buf_t
Generic fixed size buffer structure.
unsigned int rc_buf_optimal_sz
Decoder Buffer Optimal Size.
Definition: vpx_encoder.h:549
vpx_codec_err_t vpx_codec_set_cx_data_buf(vpx_codec_ctx_t *ctx, const vpx_fixed_buf_t *buf, unsigned int pad_before, unsigned int pad_after)
Set compressed data output buffer.
@ VPX_KF_AUTO
Definition: vpx_encoder.h:248
struct vpx_svc_parameters vpx_svc_extra_cfg_t
vp9 svc extra configure parameters
vpx_kf_mode
Keyframe placement mode.
Definition: vpx_encoder.h:246
vpx_codec_cx_pkt_kind
Encoder output packet variants.
Definition: vpx_encoder.h:146
int speed_per_layer[12]
Definition: vpx_encoder.h:706
unsigned int rc_target_bitrate
Target data rate.
Definition: vpx_encoder.h:460
unsigned int rc_2pass_vbr_maxsection_pct
Two-pass mode per-GOP maximum bitrate.
Definition: vpx_encoder.h:577
void * buf
Definition: vpx_encoder.h:97
vpx_fixed_buf_t twopass_stats
Definition: vpx_encoder.h:182
vpx_rc_mode
Rate control mode.
Definition: vpx_encoder.h:231
unsigned int g_threads
Maximum number of threads to use.
Definition: vpx_encoder.h:285
vpx_codec_err_t vpx_codec_encode(vpx_codec_ctx_t *ctx, const vpx_image_t *img, vpx_codec_pts_t pts, unsigned long duration, vpx_enc_frame_flags_t flags, unsigned long deadline)
Encode a frame.
const vpx_image_t * vpx_codec_get_preview_frame(vpx_codec_ctx_t *ctx)
Get Preview Frame.
unsigned int samples[4]
Definition: vpx_encoder.h:185
struct vpx_codec_cx_pkt::@1::@2 frame
int den
Definition: vpx_encoder.h:220
vpx_codec_err_t vpx_codec_enc_config_default(vpx_codec_iface_t *iface, vpx_codec_enc_cfg_t *cfg, unsigned int usage)
Get a default configuration.
Describes the codec algorithm interface to applications.
uint32_t vpx_codec_er_flags_t
Error Resilient flags.
Definition: vpx_encoder.h:131
unsigned int width[5]
Width and height of frames in this packet. VP8 will only use the first one.
Definition: vpx_encoder.h:176
int temporal_layering_mode
Temporal layering mode indicating which temporal layering scheme to use.
Definition: vpx_encoder.h:693
@ VPX_KF_DISABLED
Definition: vpx_encoder.h:249
uint32_t vpx_codec_frame_flags_t
Compressed Frame Flags.
Definition: vpx_encoder.h:115
Rational Number.
Definition: vpx_encoder.h:218
@ VPX_RC_ONE_PASS
Definition: vpx_encoder.h:225
struct vpx_rational vpx_rational_t
Rational Number.
@ VPX_CBR
Definition: vpx_encoder.h:233
unsigned int ts_number_layers
Number of temporal coding layers.
Definition: vpx_encoder.h:644
int temporal_layering_mode
Definition: vpx_encoder.h:707
unsigned int rc_undershoot_pct
Rate control adaptation undershoot control.
Definition: vpx_encoder.h:501
@ VPX_CODEC_FPMB_STATS_PKT
Definition: vpx_encoder.h:149
@ VPX_Q
Definition: vpx_encoder.h:235
struct vpx_codec_enc_output_cx_cb_pair vpx_codec_priv_output_cx_pkt_cb_pair_t
Callback function pointer / user data pair storage.
unsigned int ts_periodicity
Length of the sequence defining frame temporal layer membership.
Definition: vpx_encoder.h:667