This SDK includes a number of sample applications. Each sample documents a feature of the SDK in both prose and the associated C code. The following samples are included:
In addition, the SDK contains a number of utilities. Since these utilities are built upon the concepts described in the sample code listed above, they are not documented in pieces like the samples are. Their source is included here for reference. The following utilities are included:
unsigned int rc_2pass_vbr_minsection_pct
Two-pass mode per-GOP minimum bitrate.
Definition: vpx_encoder.h:589
@ VP8D_GET_FRAME_CORRUPTED
Definition: vp8dx.h:63
int alt_fb_idx[5]
Definition: vp8cx.h:735
@ VPX_CS_RESERVED
Definition: vpx_image.h:77
@ VPX_CS_BT_709
Definition: vpx_image.h:73
@ VPX_IMG_FMT_YV12
Definition: vpx_image.h:53
int gld_fb_idx[5]
Definition: vp8cx.h:734
int lst_fb_idx[5]
Definition: vp8cx.h:733
vpx region of interest map
Definition: vp8cx.h:645
unsigned int ts_rate_decimator[5]
Frame rate decimation factor for each temporal layer.
Definition: vpx_encoder.h:677
@ VP9_DECODE_SVC_SPATIAL_LAYER
Definition: vp8dx.h:117
@ VP8E_SET_ARNR_STRENGTH
Codec control function to set the filter strength for the arf.
Definition: vp8cx.h:217
unsigned int d_h
Definition: vpx_image.h:100
unsigned int threads
Definition: vpx_decoder.h:108
@ VPX_CS_SRGB
Definition: vpx_image.h:78
vp9 svc extra configure parameters
Definition: vpx_encoder.h:720
int max_quantizers[12]
Definition: vpx_encoder.h:721
#define VPX_IMG_FMT_HIGHBITDEPTH
Definition: vpx_image.h:35
Codec context structure.
Definition: vpx_codec.h:197
@ VP9E_SET_TARGET_LEVEL
Codec control function to set target level.
Definition: vp8cx.h:550
@ VPX_CS_SMPTE_240
Definition: vpx_image.h:75
unsigned int sz
Definition: vpx_decoder.h:90
@ VPX_BITS_8
Definition: vpx_codec.h:218
const char * vpx_codec_err_to_string(vpx_codec_err_t err)
Convert error number to printable string.
unsigned int h
Definition: vpx_decoder.h:92
unsigned int cols
Definition: vp8cx.h:669
Generic fixed size buffer structure.
Definition: vpx_encoder.h:102
@ VP8E_SET_ENABLEAUTOALTREF
Codec control function to enable automatic set and use alf frames.
Definition: vp8cx.h:161
@ VP9E_SET_AQ_MODE
Codec control function to set adaptive quantization mode.
Definition: vp8cx.h:392
enum vpx_codec_cx_pkt_kind kind
Definition: vpx_encoder.h:171
@ VP9E_GET_SVC_LAYER_ID
Codec control function to get svc layer ID.
Definition: vp8cx.h:459
void vpx_img_free(vpx_image_t *img)
Close an image descriptor.
@ VP9E_SET_LOSSLESS
Codec control function to set lossless encoding mode.
Definition: vp8cx.h:321
@ VP8_SET_POSTPROC
Definition: vp8.h:49
@ VP8E_SET_SCREEN_CONTENT_MODE
Codec control function to set encoder screen content mode.
Definition: vp8cx.h:306
@ 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
unsigned int ss_number_layers
Number of spatial coding layers.
Definition: vpx_encoder.h:643
union vpx_codec_cx_pkt::@1 data
@ VP8E_GET_LAST_QUANTIZER_64
Codec control function to get last quantizer chosen by the encoder.
Definition: vp8cx.h:205
#define VP8_EFLAG_NO_REF_LAST
Don't reference the last frame.
Definition: vp8cx.h:58
vpx_fixed_buf_t rc_twopass_stats_in
Two-pass stats buffer.
Definition: vpx_encoder.h:464
Encoder configuration structure.
Definition: vpx_encoder.h:279
vpx_codec_err_t vpx_codec_decode(vpx_codec_ctx_t *ctx, const uint8_t *data, unsigned int data_sz, void *user_priv, long deadline)
Decode data.
unsigned int kf_max_dist
Keyframe maximum interval.
Definition: vpx_encoder.h:633
#define VPX_PLANE_U
Definition: vpx_image.h:113
const char * vpx_codec_iface_name(vpx_codec_iface_t *iface)
Return the name for a given interface.
@ VPX_CODEC_PSNR_PKT
Definition: vpx_encoder.h:156
int min_quantizers[12]
Definition: vpx_encoder.h:722
#define VPX_DL_BEST_QUALITY
deadline parameter analogous to VPx BEST QUALITY mode.
Definition: vpx_encoder.h:853
@ VPX_VBR
Definition: vpx_encoder.h:243
@ VP8E_SET_NOISE_SENSITIVITY
control function to set noise sensitivity
Definition: vp8cx.h:170
@ VP9E_SET_FRAME_PERIODIC_BOOST
Codec control function to enable/disable periodic Q boost.
Definition: vp8cx.h:407
long vpx_enc_frame_flags_t
Encoded Frame Flags.
Definition: vpx_encoder.h:270
unsigned int rc_buf_sz
Decoder Buffer Size.
Definition: vpx_encoder.h:550
@ VP9E_SET_GF_CBR_BOOST_PCT
Boost percentage for Golden Frame in CBR mode.
Definition: vp8cx.h:287
@ VPX_IMG_FMT_I42216
Definition: vpx_image.h:64
vpx_image_t * vpx_codec_get_frame(vpx_codec_ctx_t *ctx, vpx_codec_iter_t *iter)
Decoded frames iterator.
#define VPX_FRAME_IS_FRAGMENT
this is a fragment of the encoded frame
Definition: vpx_encoder.h:129
vpx_image_t * vpx_img_alloc(vpx_image_t *img, vpx_img_fmt_t fmt, unsigned int d_w, unsigned int d_h, unsigned int align)
Open a descriptor, allocating storage for the underlying image.
int num
Definition: vpx_encoder.h:230
#define VPX_CODEC_USE_POSTPROC
Definition: vpx_decoder.h:74
#define VPX_DL_REALTIME
deadline parameter analogous to VPx REALTIME mode.
Definition: vpx_encoder.h:849
vpx_image_t img
Definition: vp8.h:112
const char * name
Definition: vpx_codec.h:198
@ VPX_CODEC_OK
Operation completed without error.
Definition: vpx_codec.h:92
vpx_fixed_buf_t firstpass_mb_stats
Definition: vpx_encoder.h:187
unsigned int y_chroma_shift
Definition: vpx_image.h:108
unsigned int x_chroma_shift
Definition: vpx_image.h:107
Provides definitions for using VP8 or VP9 within the vpx Decoder interface.
uint8_t * data
Definition: vpx_frame_buffer.h:40
#define VP8_EFLAG_NO_UPD_ENTROPY
Disable entropy update.
Definition: vp8cx.h:116
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:170
int frame_flags[5]
Definition: vp8cx.h:732
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:318
@ VPX_CODEC_CX_FRAME_PKT
Definition: vpx_encoder.h:153
@ VP9E_SET_MIN_GF_INTERVAL
Codec control function to set minimum interval between GF/ARF frames.
Definition: vp8cx.h:502
int idx
Definition: vp8.h:120
VP9 specific reference frame data struct.
Definition: vp8.h:119
@ VPX_IMG_FMT_I44416
Definition: vpx_image.h:65
@ VPX_IMG_FMT_I422
Definition: vpx_image.h:59
unsigned int d_w
Definition: vpx_image.h:99
vp9 svc frame flag parameters.
Definition: vp8cx.h:731
unsigned char * planes[4]
Definition: vpx_image.h:116
@ VP9E_SET_MAX_GF_INTERVAL
Codec control function to set minimum interval between GF/ARF frames.
Definition: vp8cx.h:510
unsigned int rows
Definition: vp8cx.h:648
unsigned int bit_depth
Definition: vpx_image.h:96
#define VPX_TS_MAX_LAYERS
Definition: vpx_encoder.h:40
vpx_img_fmt_t fmt
Definition: vpx_image.h:89
@ VP9E_SET_SVC
Codec control function to turn on/off SVC in encoder.
Definition: vp8cx.h:424
int post_proc_flag
the types of post processing to be done, should be combination of "vp8_postproc_level"
Definition: vp8.h:91
unsigned int g_profile
Bitstream profile to use.
Definition: vpx_encoder.h:309
@ VPX_BITS_12
Definition: vpx_codec.h:220
#define VP8_EFLAG_NO_UPD_LAST
Don't update the last frame.
Definition: vp8cx.h:81
unsigned int rc_overshoot_pct
Rate control adaptation overshoot control.
Definition: vpx_encoder.h:535
#define VPX_MAX_LAYERS
Definition: vpx_encoder.h:46
#define vpx_codec_enc_init(ctx, iface, cfg, flags)
Convenience macro for vpx_codec_enc_init_ver()
Definition: vpx_encoder.h:760
@ VPX_CODEC_STATS_PKT
Definition: vpx_encoder.h:154
int64_t vpx_codec_pts_t
Time Stamp Type.
Definition: vpx_encoder.h:112
@ VPX_RC_LAST_PASS
Definition: vpx_encoder.h:238
@ VP9E_SET_FRAME_PARALLEL_DECODING
Codec control function to enable frame parallel decoding feature.
Definition: vp8cx.h:379
int scaling_factor_den[12]
Definition: vpx_encoder.h:724
@ VP9E_SET_MAX_INTER_BITRATE_PCT
Codec control function to set max data rate for Inter frames.
Definition: vp8cx.h:272
External frame buffer.
Definition: vpx_frame_buffer.h:39
vpx_ref_frame_type_t frame_type
Definition: vp8.h:111
@ VP8E_SET_STATIC_THRESHOLD
Codec control function to set the threshold for MBs treated static.
Definition: vp8cx.h:182
vpx_bit_depth_t g_bit_depth
Bit-depth of the codec.
Definition: vpx_encoder.h:335
reference frame data struct
Definition: vp8.h:110
struct vpx_rational g_timebase
Stream timebase units.
Definition: vpx_encoder.h:357
@ VPX_IMG_FMT_I420
Definition: vpx_image.h:55
@ VPX_CS_BT_601
Definition: vpx_image.h:72
double psnr[4]
Definition: vpx_encoder.h:191
#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:408
@ VP9E_SET_TILE_ROWS
Codec control function to set number of tile rows.
Definition: vp8cx.h:365
int scaling_factor_num[12]
Definition: vpx_encoder.h:723
@ VP8E_SET_SHARPNESS
Codec control function to set sharpness.
Definition: vp8cx.h:176
@ VPX_CODEC_CORRUPT_FRAME
The coded data for this stream is corrupt or incomplete.
Definition: vpx_codec.h:130
vpx_codec_er_flags_t g_error_resilient
Enable error resilient modes.
Definition: vpx_encoder.h:365
unsigned int cols
Definition: vp8cx.h:649
Image Descriptor.
Definition: vpx_image.h:88
size_t size
Definition: vpx_frame_buffer.h:41
enum vpx_enc_pass g_pass
Multi-pass Encoding Mode.
Definition: vpx_encoder.h:372
unsigned int g_h
Height of the frame.
Definition: vpx_encoder.h:327
@ VP9E_SET_ALT_REF_AQ
Codec control function to enable/disable special mode for altref adaptive quantization....
Definition: vp8cx.h:574
int stride[4]
Definition: vpx_image.h:117
@ VP9E_SET_SVC_LAYER_ID
Codec control function to set svc layer for spatial and temporal.
Definition: vp8cx.h:441
unsigned int rc_max_quantizer
Maximum (Worst Quality) Quantizer.
Definition: vpx_encoder.h:501
enum vpx_rc_mode rc_end_usage
Rate control algorithm to use.
Definition: vpx_encoder.h:457
@ VPX_CS_SMPTE_170
Definition: vpx_image.h:74
unsigned int g_lag_in_frames
Allow lagged encoding.
Definition: vpx_encoder.h:386
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.
unsigned char * roi_map
Definition: vp8cx.h:647
@ VP8E_SET_CPUUSED
Codec control function to set encoder internal speed settings.
Definition: vp8cx.h:155
#define VPX_CODEC_USE_HIGHBITDEPTH
Definition: vpx_encoder.h:96
vpx_codec_err_t
Algorithm return codes.
Definition: vpx_codec.h:90
@ VP8E_SET_CQ_LEVEL
Codec control function to set constrained quality level.
Definition: vp8cx.h:236
unsigned int rc_resize_allowed
Enable/disable spatial resampling, if supported by the codec.
Definition: vpx_encoder.h:417
@ VP9_GET_REFERENCE
Definition: vp8.h:59
#define VP8_EFLAG_NO_REF_ARF
Don't reference the alternate reference frame.
Definition: vp8cx.h:74
const char * vpx_codec_error_detail(vpx_codec_ctx_t *ctx)
Retrieve detailed error information for codec context.
@ VPX_IMG_FMT_I444
Definition: vpx_image.h:60
unsigned int w
Definition: vpx_decoder.h:91
#define VPX_EFLAG_FORCE_KF
Definition: vpx_encoder.h:271
post process flags
Definition: vp8.h:88
int delta_q[4]
Definition: vp8cx.h:653
vp9 svc layer parameters
Definition: vp8cx.h:718
@ VP9E_SET_TUNE_CONTENT
Codec control function to set content type.
Definition: vp8cx.h:451
@ VPXD_GET_LAST_QUANTIZER
Codec control function to get last decoded frame quantizer.
Definition: vp8dx.h:125
@ VP9E_SET_NOISE_SENSITIVITY
Codec control function to set noise sensitivity.
Definition: vp8cx.h:415
#define VPX_PLANE_V
Definition: vpx_image.h:114
void * priv
Definition: vpx_frame_buffer.h:42
Stream properties.
Definition: vpx_decoder.h:89
@ VP8_SET_REFERENCE
pass in an external frame into decoder to be used as reference frame
Definition: vp8.h:47
vpx_fixed_buf_t raw
Definition: vpx_encoder.h:193
unsigned int layer_target_bitrate[12]
Target bitrate for each spatial/temporal layer.
Definition: vpx_encoder.h:703
int temporal_layer_id
Definition: vp8cx.h:720
unsigned int g_input_bit_depth
Bit-depth of the input frames.
Definition: vpx_encoder.h:343
@ VP9D_GET_DISPLAY_SIZE
Definition: vp8dx.h:85
@ VPX_CQ
Definition: vpx_encoder.h:245
@ VPX_RC_FIRST_PASS
Definition: vpx_encoder.h:237
unsigned char * active_map
specify an on (1) or off (0) each 16x16 region within a frame
Definition: vp8cx.h:667
unsigned int ts_target_bitrate[5]
Target bitrate for each temporal layer.
Definition: vpx_encoder.h:670
@ VPX_IMG_FMT_I42016
Definition: vpx_image.h:63
@ VP8E_SET_ACTIVEMAP
Codec control function to pass an Active map to encoder.
Definition: vp8cx.h:136
#define VPX_FRAME_IS_KEY
Definition: vpx_encoder.h:122
Provides definitions for using VP8 or VP9 encoder algorithm within the vpx Codec Interface.
unsigned int kf_min_dist
Keyframe minimum interval.
Definition: vpx_encoder.h:624
unsigned int rc_min_quantizer
Minimum (Best Quality) Quantizer.
Definition: vpx_encoder.h:491
enum vpx_bit_depth vpx_bit_depth_t
Bit depth for codecThis enumeration determines the bit depth of the codec.
#define VPX_CODEC_USE_ERROR_CONCEALMENT
Conceal errors in decoded frames.
Definition: vpx_decoder.h:76
#define VPX_PLANE_Y
Definition: vpx_image.h:112
#define vpx_codec_dec_init(ctx, iface, cfg, flags)
Convenience macro for vpx_codec_dec_init_ver()
Definition: vpx_decoder.h:144
@ VPX_CODEC_INCAPABLE
Algorithm does not have required capability.
Definition: vpx_codec.h:104
enum vpx_img_fmt vpx_img_fmt_t
List of supported image formats.
unsigned int rc_buf_initial_sz
Decoder Buffer Initial Size.
Definition: vpx_encoder.h:559
size_t sz
Definition: vpx_encoder.h:104
@ VP8E_SET_TUNING
Codec control function to set visual tuning.
Definition: vp8cx.h:226
@ VPX_BITS_10
Definition: vpx_codec.h:219
unsigned int rows
Definition: vp8cx.h:668
@ VP9E_SET_ROW_MT
Codec control function to set row level multi-threading.
Definition: vp8cx.h:558
#define VPX_CODEC_USE_OUTPUT_PARTITION
Make the encoder output one partition at a time.
Definition: vpx_encoder.h:95
@ VP8E_SET_ARNR_TYPE
Definition: vp8cx.h:220
vpx_codec_err_t err
Definition: vpx_codec.h:200
unsigned int rc_buf_optimal_sz
Decoder Buffer Optimal Size.
Definition: vpx_encoder.h:568
@ VP8E_SET_MAX_INTRA_BITRATE_PCT
Codec control function to set Max data rate for Intra frames.
Definition: vp8cx.h:251
int spatial_layer_id
Definition: vp8cx.h:719
vpx_codec_err_t vpx_codec_set_frame_buffer_functions(vpx_codec_ctx_t *ctx, vpx_get_frame_buffer_cb_fn_t cb_get, vpx_release_frame_buffer_cb_fn_t cb_release, void *cb_priv)
Pass in external frame buffers for the decoder to use.
int deblocking_level
Definition: vp8.h:92
@ VPX_KF_AUTO
Definition: vpx_encoder.h:259
@ VPX_IMG_FMT_I440
Definition: vpx_image.h:61
unsigned int ts_layer_id[16]
Template defining the membership of frames to temporal layers.
Definition: vpx_encoder.h:695
@ VP8_COPY_REFERENCE
Definition: vp8.h:48
vpx_image_t img
Definition: vp8.h:121
@ VP8E_SET_TOKEN_PARTITIONS
Codec control function to set the number of token partitions.
Definition: vp8cx.h:188
unsigned int rc_target_bitrate
Target data rate.
Definition: vpx_encoder.h:477
unsigned int rc_2pass_vbr_maxsection_pct
Two-pass mode per-GOP maximum bitrate.
Definition: vpx_encoder.h:596
@ VP9E_SET_TILE_COLUMNS
Codec control function to set number of tile columns.
Definition: vp8cx.h:345
void * buf
Definition: vpx_encoder.h:103
int noise_level
Definition: vp8.h:93
vpx_fixed_buf_t twopass_stats
Definition: vpx_encoder.h:186
unsigned int g_threads
Maximum number of threads to use.
Definition: vpx_encoder.h:299
#define VP8_EFLAG_NO_REF_GF
Don't reference the golden frame.
Definition: vp8cx.h:66
#define vpx_codec_control(ctx, id, data)
vpx_codec_control wrapper macro
Definition: vpx_codec.h:404
#define VP8_EFLAG_NO_UPD_ARF
Don't update the alternate reference frame.
Definition: vp8cx.h:95
@ VPX_IMG_FMT_I44016
Definition: vpx_image.h:66
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.
@ VP9E_SET_SVC_REF_FRAME_CONFIG
Codec control function to set the frame flags and buffer indices for spatial layers....
Definition: vp8cx.h:533
unsigned int static_threshold[4]
Definition: vp8cx.h:656
Describes the decoder algorithm interface to applications.
Initialization Configurations.
Definition: vpx_decoder.h:107
struct vpx_codec_cx_pkt::@1::@2 frame
int den
Definition: vpx_encoder.h:231
@ VP8E_SET_ROI_MAP
Codec control function to pass an ROI map to encoder.
Definition: vp8cx.h:130
uint32_t vpx_codec_er_flags_t
Error Resilient flags.
Definition: vpx_encoder.h:137
int delta_lf[4]
Definition: vp8cx.h:654
vpx_codec_err_t vpx_codec_destroy(vpx_codec_ctx_t *ctx)
Destroy a codec instance.
vpx active region map
Definition: vp8cx.h:665
vpx_codec_err_t vpx_codec_control_(vpx_codec_ctx_t *ctx, int ctrl_id,...)
Control algorithm.
int temporal_layering_mode
Temporal layering mode indicating which temporal layering scheme to use.
Definition: vpx_encoder.h:712
@ VP9E_SET_COLOR_SPACE
Codec control function to set color space info.
Definition: vp8cx.h:482
#define VP8_EFLAG_NO_UPD_GF
Don't update the golden frame.
Definition: vp8cx.h:88
@ VPX_KF_DISABLED
Definition: vpx_encoder.h:260
#define VPX_CODEC_USE_PSNR
Initialization-time Feature Enabling.
Definition: vpx_encoder.h:93
Describes the encoder algorithm interface to applications.
@ VPX_CS_UNKNOWN
Definition: vpx_image.h:71
Rational Number.
Definition: vpx_encoder.h:229
@ VPX_RC_ONE_PASS
Definition: vpx_encoder.h:236
@ VPX_CBR
Definition: vpx_encoder.h:244
const char * vpx_codec_error(vpx_codec_ctx_t *ctx)
Retrieve error synopsis for codec context.
#define VPX_DL_GOOD_QUALITY
deadline parameter analogous to VPx GOOD QUALITY mode.
Definition: vpx_encoder.h:851
unsigned int ts_number_layers
Number of temporal coding layers.
Definition: vpx_encoder.h:663
@ VP8E_SET_GF_CBR_BOOST_PCT
Boost percentage for Golden Frame in CBR mode.
Definition: vp8cx.h:589
unsigned int rc_undershoot_pct
Rate control adaptation undershoot control.
Definition: vpx_encoder.h:520
@ VPX_CS_BT_2020
Definition: vpx_image.h:76
@ VP9E_SET_SVC_PARAMETERS
Codec control function to set parameters for SVC.
Definition: vp8cx.h:432
@ VPX_CODEC_FPMB_STATS_PKT
Definition: vpx_encoder.h:155
@ VPX_Q
Definition: vpx_encoder.h:246
@ VP8E_SET_TEMPORAL_LAYER_ID
Codec control function to set the temporal layer id.
Definition: vp8cx.h:298
vpx_codec_err_t vpx_codec_peek_stream_info(vpx_codec_iface_t *iface, const uint8_t *data, unsigned int data_sz, vpx_codec_stream_info_t *si)
Parse stream info from a buffer.
@ VP8E_SET_ARNR_MAXFRAMES
Codec control function to set the max no of frames to create arf.
Definition: vp8cx.h:211
enum vpx_kf_mode kf_mode
Keyframe placement mode.
Definition: vpx_encoder.h:615
unsigned int ts_periodicity
Length of the sequence defining frame temporal layer membership.
Definition: vpx_encoder.h:686