WebM Codec SDK
vpx_encoder.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_VPX_ENCODER_H_
11 #define VPX_VPX_ENCODER_H_
12 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 #include "./vpx_codec.h"
33 
37 #define VPX_TS_MAX_PERIODICITY 16
38 
40 #define VPX_TS_MAX_LAYERS 5
41 
43 #define MAX_PERIODICITY VPX_TS_MAX_PERIODICITY
44 
46 #define VPX_MAX_LAYERS 12 // 3 temporal + 4 spatial layers are allowed.
47 
49 #define MAX_LAYERS VPX_MAX_LAYERS // 3 temporal + 4 spatial layers allowed.
50 
52 #define VPX_SS_MAX_LAYERS 5
53 
55 #define VPX_SS_DEFAULT_LAYERS 1
56 
65 #define VPX_ENCODER_ABI_VERSION \
66  (11 + VPX_CODEC_ABI_VERSION)
77 #define VPX_CODEC_CAP_PSNR 0x10000
84 #define VPX_CODEC_CAP_OUTPUT_PARTITION 0x20000
85 
93 #define VPX_CODEC_USE_PSNR 0x10000
95 #define VPX_CODEC_USE_OUTPUT_PARTITION 0x20000
96 #define VPX_CODEC_USE_HIGHBITDEPTH 0x40000
102 typedef struct vpx_fixed_buf {
103  void *buf;
104  size_t sz;
105 } vpx_fixed_buf_t;
112 typedef int64_t vpx_codec_pts_t;
113 
121 typedef uint32_t vpx_codec_frame_flags_t;
122 #define VPX_FRAME_IS_KEY 0x1
125 #define VPX_FRAME_IS_DROPPABLE 0x2
126 
127 #define VPX_FRAME_IS_INVISIBLE 0x4
128 
129 #define VPX_FRAME_IS_FRAGMENT 0x8
130 
137 typedef uint32_t vpx_codec_er_flags_t;
139 #define VPX_ERROR_RESILIENT_DEFAULT 0x1
140 
144 #define VPX_ERROR_RESILIENT_PARTITIONS 0x2
145 
158 };
159 
165 typedef struct vpx_codec_cx_pkt {
167  union {
168  struct {
169  void *buf;
170  size_t sz;
174  unsigned long duration;
182  unsigned int width[VPX_SS_MAX_LAYERS];
183  unsigned int height[VPX_SS_MAX_LAYERS];
187  } frame;
190  struct vpx_psnr_pkt {
191  unsigned int samples[4];
192  uint64_t sse[4];
193  double psnr[4];
194  } psnr;
197  /* This packet size is fixed to allow codecs to extend this
198  * interface without having to manage storage for raw packets,
199  * i.e., if it's smaller than 128 bytes, you can store in the
200  * packet list directly.
201  */
202  char pad[128 - sizeof(enum vpx_codec_cx_pkt_kind)];
203  } data;
211 // putting the definitions here for now. (agrange: find if there
212 // is a better place for this)
214  void *user_data);
215 
219  void *user_priv;
221 
226 typedef struct vpx_rational {
227  int num;
228  int den;
229 } vpx_rational_t;
236 };
237 
244 };
245 
258 };
259 
268 #define VPX_EFLAG_FORCE_KF (1 << 0)
276 typedef struct vpx_codec_enc_cfg {
277  /*
278  * generic settings (g)
279  */
280 
288  unsigned int g_usage;
289 
296  unsigned int g_threads;
297 
306  unsigned int g_profile;
315  unsigned int g_w;
316 
324  unsigned int g_h;
325 
333 
340  unsigned int g_input_bit_depth;
341 
354  struct vpx_rational g_timebase;
355 
363 
369  enum vpx_enc_pass g_pass;
370 
383  unsigned int g_lag_in_frames;
384 
385  /*
386  * rate control settings (rc)
387  */
388 
405  unsigned int rc_dropframe_thresh;
406 
414  unsigned int rc_resize_allowed;
415 
421  unsigned int rc_scaled_width;
422 
428  unsigned int rc_scaled_height;
429 
436  unsigned int rc_resize_up_thresh;
437 
444  unsigned int rc_resize_down_thresh;
445 
454  enum vpx_rc_mode rc_end_usage;
455 
462 
469 
474  unsigned int rc_target_bitrate;
475 
476  /*
477  * quantizer settings
478  */
479 
488  unsigned int rc_min_quantizer;
489 
498  unsigned int rc_max_quantizer;
499 
500  /*
501  * bitrate tolerance
502  */
503 
517  unsigned int rc_undershoot_pct;
518 
532  unsigned int rc_overshoot_pct;
533 
534  /*
535  * decoder buffer model parameters
536  */
537 
547  unsigned int rc_buf_sz;
548 
556  unsigned int rc_buf_initial_sz;
557 
565  unsigned int rc_buf_optimal_sz;
566 
567  /*
568  * 2 pass rate control parameters
569  */
570 
579  unsigned int rc_2pass_vbr_bias_pct;
580 
587 
594 
601 
602  /*
603  * keyframing settings (kf)
604  */
605 
612  enum vpx_kf_mode kf_mode;
613 
621  unsigned int kf_min_dist;
622 
630  unsigned int kf_max_dist;
631 
632  /*
633  * Spatial scalability settings (ss)
634  */
635 
640  unsigned int ss_number_layers;
641 
647  int ss_enable_auto_alt_ref[VPX_SS_MAX_LAYERS];
648 
654  unsigned int ss_target_bitrate[VPX_SS_MAX_LAYERS];
655 
660  unsigned int ts_number_layers;
661 
667  unsigned int ts_target_bitrate[VPX_TS_MAX_LAYERS];
668 
674  unsigned int ts_rate_decimator[VPX_TS_MAX_LAYERS];
675 
683  unsigned int ts_periodicity;
684 
692  unsigned int ts_layer_id[VPX_TS_MAX_PERIODICITY];
693 
700  unsigned int layer_target_bitrate[VPX_MAX_LAYERS];
701 
717 typedef struct vpx_svc_parameters {
718  int max_quantizers[VPX_MAX_LAYERS];
719  int min_quantizers[VPX_MAX_LAYERS];
720  int scaling_factor_num[VPX_MAX_LAYERS];
721  int scaling_factor_den[VPX_MAX_LAYERS];
722  int speed_per_layer[VPX_MAX_LAYERS];
725 
749  vpx_codec_iface_t *iface,
750  const vpx_codec_enc_cfg_t *cfg,
751  vpx_codec_flags_t flags, int ver);
752 
757 #define vpx_codec_enc_init(ctx, iface, cfg, flags) \
758  vpx_codec_enc_init_ver(ctx, iface, cfg, flags, VPX_ENCODER_ABI_VERSION)
759 
782  int num_enc, vpx_codec_flags_t flags, vpx_rational_t *dsf, int ver);
783 
788 #define vpx_codec_enc_init_multi(ctx, iface, cfg, num_enc, flags, dsf) \
789  vpx_codec_enc_init_multi_ver(ctx, iface, cfg, num_enc, flags, dsf, \
790  VPX_ENCODER_ABI_VERSION)
791 
812  vpx_codec_enc_cfg_t *cfg,
813  unsigned int reserved);
814 
830  const vpx_codec_enc_cfg_t *cfg);
831 
844 
846 #define VPX_DL_REALTIME (1)
847 
848 #define VPX_DL_GOOD_QUALITY (1000000)
849 
850 #define VPX_DL_BEST_QUALITY (0)
851 
888  vpx_codec_pts_t pts, unsigned long duration,
890  unsigned long deadline);
891 
936  const vpx_fixed_buf_t *buf,
937  unsigned int pad_before,
938  unsigned int pad_after);
939 
964  vpx_codec_iter_t *iter);
965 
979 
981 #ifdef __cplusplus
982 }
983 #endif
984 #endif // VPX_VPX_ENCODER_H_
Rational Number.
Definition: vpx_encoder.h:226
unsigned int rc_buf_initial_sz
Decoder Buffer Initial Size.
Definition: vpx_encoder.h:556
vpx_fixed_buf_t twopass_stats
Definition: vpx_encoder.h:188
unsigned int width[5]
Width and height of frames in this packet. VP8 will only use the first one.
Definition: vpx_encoder.h:182
unsigned int ts_number_layers
Number of temporal coding layers.
Definition: vpx_encoder.h:660
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.
#define VPX_MAX_LAYERS
Definition: vpx_encoder.h:46
Definition: vpx_encoder.h:243
Image Descriptor.
Definition: vpx_image.h:88
int temporal_layering_mode
Definition: vpx_encoder.h:723
vpx_codec_pts_t pts
time stamp to show frame (in timebase units)
Definition: vpx_encoder.h:172
vpx_kf_mode
Keyframe placement mode.
Definition: vpx_encoder.h:254
unsigned int rc_scaled_width
Internal coded frame width.
Definition: vpx_encoder.h:421
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:213
#define VPX_TS_MAX_LAYERS
Definition: vpx_encoder.h:40
Definition: vpx_encoder.h:241
unsigned int g_usage
Algorithm specific "usage" value.
Definition: vpx_encoder.h:288
struct vpx_codec_enc_cfg vpx_codec_enc_cfg_t
Encoder configuration structure.
struct vpx_fixed_buf vpx_fixed_buf_t
Generic fixed size buffer structure.
unsigned int rc_buf_sz
Decoder Buffer Size.
Definition: vpx_encoder.h:547
unsigned int g_input_bit_depth
Bit-depth of the input frames.
Definition: vpx_encoder.h:340
vpx_codec_enc_output_cx_pkt_cb_fn_t output_cx_pkt
Definition: vpx_encoder.h:218
int den
Definition: vpx_encoder.h:228
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.
unsigned int rc_max_quantizer
Maximum (Worst Quality) Quantizer.
Definition: vpx_encoder.h:498
struct vpx_svc_parameters vpx_svc_extra_cfg_t
vp9 svc extra configure parameters
unsigned int rc_min_quantizer
Minimum (Best Quality) Quantizer.
Definition: vpx_encoder.h:488
Definition: vpx_encoder.h:154
char pad[128 - sizeof(enum vpx_codec_cx_pkt_kind)]
Definition: vpx_encoder.h:202
unsigned int kf_max_dist
Keyframe maximum interval.
Definition: vpx_encoder.h:630
int partition_id
the partition id defines the decoding order of the partitions. Only applicable when "output partition...
Definition: vpx_encoder.h:179
unsigned int g_lag_in_frames
Allow lagged encoding.
Definition: vpx_encoder.h:383
vpx_enc_pass
Multi-pass Encoding Pass.
Definition: vpx_encoder.h:232
Encoder configuration structure.
Definition: vpx_encoder.h:276
Definition: vpx_encoder.h:157
Definition: vpx_encoder.h:156
Definition: vpx_encoder.h:256
void * user_priv
Definition: vpx_encoder.h:219
Encoder output packet.
Definition: vpx_encoder.h:165
unsigned int rc_overshoot_pct
Rate control adaptation overshoot control.
Definition: vpx_encoder.h:532
void * buf
Definition: vpx_encoder.h:103
unsigned int rc_2pass_vbr_bias_pct
Two-pass mode CBR/VBR bias.
Definition: vpx_encoder.h:579
unsigned int rc_buf_optimal_sz
Decoder Buffer Optimal Size.
Definition: vpx_encoder.h:565
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.
Generic fixed size buffer structure.
Definition: vpx_encoder.h:102
uint32_t vpx_codec_frame_flags_t
Compressed Frame Flags.
Definition: vpx_encoder.h:121
unsigned int kf_min_dist
Keyframe minimum interval.
Definition: vpx_encoder.h:621
Definition: vpx_encoder.h:234
unsigned int g_profile
Bitstream profile to use.
Definition: vpx_encoder.h:306
Definition: vpx_encoder.h:235
struct vpx_codec_cx_pkt::@1::@2 frame
#define VPX_SS_MAX_LAYERS
Definition: vpx_encoder.h:52
unsigned int g_w
Width of the frame.
Definition: vpx_encoder.h:315
enum vpx_bit_depth vpx_bit_depth_t
Bit depth for codecThis enumeration determines the bit depth of the codec.
unsigned int rc_undershoot_pct
Rate control adaptation undershoot control.
Definition: vpx_encoder.h:517
uint64_t sse[4]
Definition: vpx_encoder.h:192
unsigned int g_h
Height of the frame.
Definition: vpx_encoder.h:324
size_t sz
Definition: vpx_encoder.h:170
enum vpx_codec_cx_pkt_kind kind
Definition: vpx_encoder.h:166
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:186
unsigned int rc_dropframe_thresh
Temporal resampling configuration, if supported by the codec.
Definition: vpx_encoder.h:405
vpx_fixed_buf_t raw
Definition: vpx_encoder.h:195
Callback function pointer / user data pair storage.
Definition: vpx_encoder.h:217
long vpx_enc_frame_flags_t
Encoded Frame Flags.
Definition: vpx_encoder.h:267
unsigned int rc_target_bitrate
Target data rate.
Definition: vpx_encoder.h:474
int num
Definition: vpx_encoder.h:227
const struct vpx_codec_iface vpx_codec_iface_t
Codec interface structure.
Definition: vpx_codec.h:174
long vpx_codec_flags_t
Initialization-time Feature Enabling.
Definition: vpx_codec.h:167
vpx_codec_cx_pkt_kind
Encoder output packet variants.
Definition: vpx_encoder.h:152
Definition: vpx_encoder.h:240
double psnr[4]
Definition: vpx_encoder.h:193
Definition: vpx_encoder.h:255
unsigned int g_threads
Maximum number of threads to use.
Definition: vpx_encoder.h:296
unsigned int samples[4]
Definition: vpx_encoder.h:191
vpx_fixed_buf_t firstpass_mb_stats
Definition: vpx_encoder.h:189
vpx_rc_mode
Rate control mode.
Definition: vpx_encoder.h:239
const vpx_image_t * vpx_codec_get_preview_frame(vpx_codec_ctx_t *ctx)
Get Preview Frame.
unsigned int ss_number_layers
Number of spatial coding layers.
Definition: vpx_encoder.h:640
unsigned int height[5]
Definition: vpx_encoder.h:183
unsigned long duration
duration to show frame (in timebase units)
Definition: vpx_encoder.h:174
vpx_bit_depth_t g_bit_depth
Bit-depth of the codec.
Definition: vpx_encoder.h:332
uint32_t vpx_codec_er_flags_t
Error Resilient flags.
Definition: vpx_encoder.h:137
unsigned int rc_resize_allowed
Enable/disable spatial resampling, if supported by the codec.
Definition: vpx_encoder.h:414
vpx_codec_err_t
Algorithm return codes.
Definition: vpx_codec.h:90
const vpx_codec_cx_pkt_t * vpx_codec_get_cx_data(vpx_codec_ctx_t *ctx, vpx_codec_iter_t *iter)
Encoded data iterator.
union vpx_codec_cx_pkt::@1 data
struct vpx_codec_cx_pkt vpx_codec_cx_pkt_t
Encoder output packet.
struct vpx_rational vpx_rational_t
Rational Number.
int temporal_layering_mode
Temporal layering mode indicating which temporal layering scheme to use.
Definition: vpx_encoder.h:709
struct vpx_codec_enc_output_cx_cb_pair vpx_codec_priv_output_cx_pkt_cb_pair_t
Callback function pointer / user data pair storage.
vpx_fixed_buf_t rc_twopass_stats_in
Two-pass stats buffer.
Definition: vpx_encoder.h:461
Definition: vpx_encoder.h:257
unsigned int rc_scaled_height
Internal coded frame height.
Definition: vpx_encoder.h:428
Definition: vpx_encoder.h:155
vpx_fixed_buf_t rc_firstpass_mb_stats_in
first pass mb stats buffer.
Definition: vpx_encoder.h:468
int64_t vpx_codec_pts_t
Time Stamp Type.
Definition: vpx_encoder.h:112
vpx_codec_err_t vpx_codec_enc_config_default(vpx_codec_iface_t *iface, vpx_codec_enc_cfg_t *cfg, unsigned int reserved)
Get a default configuration.
#define VPX_TS_MAX_PERIODICITY
Definition: vpx_encoder.h:37
vpx_fixed_buf_t * vpx_codec_get_global_headers(vpx_codec_ctx_t *ctx)
Get global stream headers.
Definition: vpx_encoder.h:242
Describes the codec algorithm interface to applications.
unsigned int ts_periodicity
Length of the sequence defining frame temporal layer membership.
Definition: vpx_encoder.h:683
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.
size_t sz
Definition: vpx_encoder.h:104
unsigned int rc_resize_down_thresh
Spatial resampling down watermark.
Definition: vpx_encoder.h:444
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.
const void * vpx_codec_iter_t
Iterator.
Definition: vpx_codec.h:187
Definition: vpx_encoder.h:153
vpx_codec_frame_flags_t flags
Definition: vpx_encoder.h:175
void * buf
Definition: vpx_encoder.h:169
unsigned int rc_2pass_vbr_maxsection_pct
Two-pass mode per-GOP maximum bitrate.
Definition: vpx_encoder.h:593
vp9 svc extra configure parameters
Definition: vpx_encoder.h:717
vpx_codec_er_flags_t g_error_resilient
Enable error resilient modes.
Definition: vpx_encoder.h:362
unsigned int rc_2pass_vbr_minsection_pct
Two-pass mode per-GOP minimum bitrate.
Definition: vpx_encoder.h:586
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:600
unsigned int rc_resize_up_thresh
Spatial resampling up watermark.
Definition: vpx_encoder.h:436
Definition: vpx_encoder.h:233
Codec context structure.
Definition: vpx_codec.h:197