AOMedia AV1 Codec
aom_encoder.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2016, Alliance for Open Media. All rights reserved
3 *
4 * This source code is subject to the terms of the BSD 2 Clause License and
5 * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
6 * was not distributed with this source code in the LICENSE file, you can
7 * obtain it at www.aomedia.org/license/software. If the Alliance for Open
8 * Media Patent License 1.0 was not distributed with this source code in the
9 * PATENTS file, you can obtain it at www.aomedia.org/license/patent.
10 */
11#ifndef AOM_AOM_AOM_ENCODER_H_
12#define AOM_AOM_AOM_ENCODER_H_
13
29#ifdef __cplusplus
30extern "C" {
31#endif
32
33#include "aom/aom_codec.h"
35
44#define AOM_ENCODER_ABI_VERSION \
45 (10 + AOM_CODEC_ABI_VERSION + AOM_EXT_PART_ABI_VERSION)
56#define AOM_CODEC_CAP_PSNR 0x10000
60#define AOM_CODEC_CAP_HIGHBITDEPTH 0x40000
61
69#define AOM_CODEC_USE_PSNR 0x10000
71#define AOM_CODEC_USE_HIGHBITDEPTH 0x40000
77typedef struct aom_fixed_buf {
78 void *buf;
79 size_t sz;
88typedef uint32_t aom_codec_er_flags_t;
90#define AOM_ERROR_RESILIENT_DEFAULT 0x1
91
105
111typedef struct aom_codec_cx_pkt {
113 union {
114 struct {
115 void *buf;
116 size_t sz;
120 unsigned long duration;
131 struct aom_psnr_pkt {
132 unsigned int samples[4];
133 uint64_t sse[4];
134 double psnr[4];
137 unsigned int samples_hbd[4];
140 uint64_t sse_hbd[4];
143 double psnr_hbd[4];
153typedef struct aom_rational {
154 int num;
155 int den;
171};
172
179};
180
192 AOM_KF_DISABLED = 0
194
196typedef enum {
208 AOM_SUPERRES_AUTO,
210
216typedef struct cfg_options {
220 unsigned int init_by_cfg_file;
224 unsigned int super_block_size;
228 unsigned int max_partition_size;
232 unsigned int min_partition_size;
248 unsigned int disable_flip_idtx;
252 unsigned int disable_cdef;
256 unsigned int disable_lr;
260 unsigned int disable_obmc;
292 unsigned int disable_palette;
296 unsigned int disable_intrabc;
300 unsigned int disable_cfl;
324 unsigned int disable_tx_64x64;
358
368#define AOM_EFLAG_FORCE_KF (1 << 0)
369
376typedef struct aom_codec_enc_cfg {
377 /*
378 * generic settings (g)
379 */
380
388 unsigned int g_usage;
389
396 unsigned int g_threads;
397
406 unsigned int g_profile;
415 unsigned int g_w;
416
424 unsigned int g_h;
425
429 unsigned int g_limit;
430
437
444
452
459 unsigned int g_input_bit_depth;
460
474
482
489
502 unsigned int g_lag_in_frames;
503
504 /*
505 * rate control settings (rc)
506 */
507
525
533 unsigned int rc_resize_mode;
534
542
550
558
570
580
589
598
608
615
622
627 unsigned int rc_target_bitrate;
628
629 /*
630 * quantizer settings
631 */
632
641 unsigned int rc_min_quantizer;
642
651 unsigned int rc_max_quantizer;
652
653 /*
654 * bitrate tolerance
655 */
656
664 unsigned int rc_undershoot_pct;
665
673 unsigned int rc_overshoot_pct;
674
675 /*
676 * decoder buffer model parameters
677 */
678
688 unsigned int rc_buf_sz;
689
697 unsigned int rc_buf_initial_sz;
698
706 unsigned int rc_buf_optimal_sz;
707
708 /*
709 * 2 pass rate control parameters
710 */
711
721
728
735
736 /*
737 * keyframing settings (kf)
738 */
739
744
752
760 unsigned int kf_min_dist;
761
769 unsigned int kf_max_dist;
770
776 unsigned int sframe_dist;
777
791 unsigned int sframe_mode;
792
799 unsigned int large_scale_tile;
800
806 unsigned int monochrome;
807
816
823 unsigned int save_as_annexb;
824
832
840
845#define MAX_TILE_WIDTHS 64 // maximum tile width array length
846
853
858#define MAX_TILE_HEIGHTS 64 // maximum tile height array length
859
866
880
885#define FIXED_QP_OFFSET_COUNT 5
886
902
932 aom_codec_iface_t *iface,
933 const aom_codec_enc_cfg_t *cfg,
934 aom_codec_flags_t flags, int ver);
935
940#define aom_codec_enc_init(ctx, iface, cfg, flags) \
941 aom_codec_enc_init_ver(ctx, iface, cfg, flags, AOM_ENCODER_ABI_VERSION)
942
966 unsigned int usage);
967
983 const aom_codec_enc_cfg_t *cfg);
984
1009
1011#define AOM_USAGE_GOOD_QUALITY (0)
1013#define AOM_USAGE_REALTIME (1)
1015#define AOM_USAGE_ALL_INTRA (2)
1016
1045 aom_codec_pts_t pts, unsigned long duration,
1046 aom_enc_frame_flags_t flags);
1047
1092 const aom_fixed_buf_t *buf,
1093 unsigned int pad_before,
1094 unsigned int pad_after);
1095
1120 aom_codec_iter_t *iter);
1121
1135
1137#ifdef __cplusplus
1138}
1139#endif
1140#endif // AOM_AOM_AOM_ENCODER_H_
Describes the codec algorithm interface to applications.
#define MAX_TILE_WIDTHS
Maximum number of tile widths in tile widths array.
Definition aom_encoder.h:845
#define MAX_TILE_HEIGHTS
Maximum number of tile heights in tile heights array.
Definition aom_encoder.h:858
#define FIXED_QP_OFFSET_COUNT
Number of fixed QP offsets.
Definition aom_encoder.h:885
Provides function pointer definitions for the external partition.
enum aom_bit_depth aom_bit_depth_t
Bit depth for codecThis enumeration determines the bit depth of the codec.
long aom_codec_flags_t
Initialization-time Feature Enabling.
Definition aom_codec.h:228
const struct aom_codec_iface aom_codec_iface_t
Codec interface structure.
Definition aom_codec.h:254
int64_t aom_codec_pts_t
Time Stamp Type.
Definition aom_codec.h:235
aom_codec_err_t
Algorithm return codes.
Definition aom_codec.h:155
const void * aom_codec_iter_t
Iterator.
Definition aom_codec.h:288
uint32_t aom_codec_frame_flags_t
Compressed Frame Flags.
Definition aom_codec.h:270
aom_superres_mode
Frame super-resolution mode.
Definition aom_encoder.h:196
aom_codec_err_t aom_codec_enc_init_ver(aom_codec_ctx_t *ctx, aom_codec_iface_t *iface, const aom_codec_enc_cfg_t *cfg, aom_codec_flags_t flags, int ver)
Initialize an encoder instance.
const aom_codec_cx_pkt_t * aom_codec_get_cx_data(aom_codec_ctx_t *ctx, aom_codec_iter_t *iter)
Encoded data iterator.
struct aom_codec_cx_pkt aom_codec_cx_pkt_t
Encoder output packet.
uint32_t aom_codec_er_flags_t
Error Resilient flags.
Definition aom_encoder.h:88
aom_codec_err_t aom_codec_set_cx_data_buf(aom_codec_ctx_t *ctx, const aom_fixed_buf_t *buf, unsigned int pad_before, unsigned int pad_after)
Set compressed data output buffer.
aom_codec_err_t aom_codec_encode(aom_codec_ctx_t *ctx, const aom_image_t *img, aom_codec_pts_t pts, unsigned long duration, aom_enc_frame_flags_t flags)
Encode a frame.
aom_rc_mode
Rate control mode.
Definition aom_encoder.h:174
const aom_image_t * aom_codec_get_preview_frame(aom_codec_ctx_t *ctx)
Get Preview Frame.
aom_enc_pass
Multi-pass Encoding Pass.
Definition aom_encoder.h:165
struct aom_rational aom_rational_t
Rational Number.
struct aom_fixed_buf aom_fixed_buf_t
Generic fixed size buffer structure.
aom_codec_err_t aom_codec_enc_config_default(aom_codec_iface_t *iface, aom_codec_enc_cfg_t *cfg, unsigned int usage)
Get the default configuration for a usage.
struct cfg_options cfg_options_t
Encoder Config Options.
aom_kf_mode
Keyframe placement mode.
Definition aom_encoder.h:189
long aom_enc_frame_flags_t
Encoded Frame Flags.
Definition aom_encoder.h:366
aom_fixed_buf_t * aom_codec_get_global_headers(aom_codec_ctx_t *ctx)
Get global stream headers.
struct aom_codec_enc_cfg aom_codec_enc_cfg_t
Encoder configuration structure.
aom_codec_err_t aom_codec_enc_config_set(aom_codec_ctx_t *ctx, const aom_codec_enc_cfg_t *cfg)
Set or change configuration.
aom_codec_cx_pkt_kind
Encoder output packet variants.
Definition aom_encoder.h:98
@ AOM_SUPERRES_RANDOM
Definition aom_encoder.h:202
@ AOM_SUPERRES_QTHRESH
Definition aom_encoder.h:205
@ AOM_SUPERRES_NONE
Definition aom_encoder.h:198
@ AOM_SUPERRES_FIXED
Definition aom_encoder.h:200
@ AOM_CBR
Definition aom_encoder.h:176
@ AOM_CQ
Definition aom_encoder.h:177
@ AOM_VBR
Definition aom_encoder.h:175
@ AOM_Q
Definition aom_encoder.h:178
@ AOM_RC_ONE_PASS
Definition aom_encoder.h:166
@ AOM_RC_SECOND_PASS
Definition aom_encoder.h:168
@ AOM_RC_LAST_PASS
Definition aom_encoder.h:170
@ AOM_RC_THIRD_PASS
Definition aom_encoder.h:169
@ AOM_RC_FIRST_PASS
Definition aom_encoder.h:167
@ AOM_KF_FIXED
Definition aom_encoder.h:190
@ AOM_KF_AUTO
Definition aom_encoder.h:191
@ AOM_KF_DISABLED
Definition aom_encoder.h:192
@ AOM_CODEC_PSNR_PKT
Definition aom_encoder.h:102
@ AOM_CODEC_CUSTOM_PKT
Definition aom_encoder.h:103
@ AOM_CODEC_CX_FRAME_PKT
Definition aom_encoder.h:99
@ AOM_CODEC_STATS_PKT
Definition aom_encoder.h:100
@ AOM_CODEC_FPMB_STATS_PKT
Definition aom_encoder.h:101
Codec context structure.
Definition aom_codec.h:298
Encoder output packet.
Definition aom_encoder.h:111
unsigned long duration
duration to show frame (in timebase units)
Definition aom_encoder.h:120
size_t sz
Definition aom_encoder.h:116
enum aom_codec_cx_pkt_kind kind
Definition aom_encoder.h:112
double psnr[4]
Definition aom_encoder.h:134
aom_fixed_buf_t twopass_stats
Definition aom_encoder.h:129
aom_fixed_buf_t raw
Definition aom_encoder.h:145
union aom_codec_cx_pkt::@1 data
aom_codec_pts_t pts
time stamp to show frame (in timebase units)
Definition aom_encoder.h:118
struct aom_codec_cx_pkt::@1::@2 frame
aom_fixed_buf_t firstpass_mb_stats
Definition aom_encoder.h:130
size_t vis_frame_size
size of the visible frame in this packet
Definition aom_encoder.h:127
aom_codec_frame_flags_t flags
Definition aom_encoder.h:121
int partition_id
the partition id defines the decoding order of the partitions. Only applicable when "output partition...
Definition aom_encoder.h:125
void * buf
Definition aom_encoder.h:115
Encoder configuration structure.
Definition aom_encoder.h:376
unsigned int g_input_bit_depth
Bit-depth of the input frames.
Definition aom_encoder.h:459
unsigned int g_forced_max_frame_height
Forced maximum height of the frame.
Definition aom_encoder.h:443
unsigned int rc_dropframe_thresh
Temporal resampling configuration, if supported by the codec.
Definition aom_encoder.h:524
unsigned int rc_resize_denominator
Frame resize denominator.
Definition aom_encoder.h:541
struct aom_rational g_timebase
Stream timebase units.
Definition aom_encoder.h:473
int tile_width_count
Number of explicit tile widths specified.
Definition aom_encoder.h:831
unsigned int g_usage
Algorithm specific "usage" value.
Definition aom_encoder.h:388
unsigned int rc_buf_sz
Decoder Buffer Size.
Definition aom_encoder.h:688
unsigned int full_still_picture_hdr
full_still_picture_hdr
Definition aom_encoder.h:815
unsigned int g_h
Height of the frame.
Definition aom_encoder.h:424
aom_superres_mode rc_superres_mode
Frame super-resolution scaling mode.
Definition aom_encoder.h:557
int fixed_qp_offsets[5]
Array of fixed QP offsets.
Definition aom_encoder.h:901
enum aom_kf_mode kf_mode
Keyframe placement mode.
Definition aom_encoder.h:751
aom_fixed_buf_t rc_firstpass_mb_stats_in
first pass mb stats buffer.
Definition aom_encoder.h:621
enum aom_rc_mode rc_end_usage
Rate control algorithm to use.
Definition aom_encoder.h:607
unsigned int rc_superres_kf_denominator
Keyframe super-resolution denominator.
Definition aom_encoder.h:579
unsigned int g_threads
Maximum number of threads to use.
Definition aom_encoder.h:396
unsigned int rc_2pass_vbr_maxsection_pct
Two-pass mode per-GOP maximum bitrate.
Definition aom_encoder.h:734
unsigned int rc_resize_kf_denominator
Keyframe resize denominator.
Definition aom_encoder.h:549
unsigned int kf_min_dist
Keyframe minimum interval.
Definition aom_encoder.h:760
unsigned int g_lag_in_frames
Allow lagged encoding.
Definition aom_encoder.h:502
unsigned int use_fixed_qp_offsets
Whether encoder should use fixed QP offsets.
Definition aom_encoder.h:879
unsigned int rc_2pass_vbr_minsection_pct
Two-pass mode per-GOP minimum bitrate.
Definition aom_encoder.h:727
unsigned int rc_2pass_vbr_bias_pct
Two-pass mode CBR/VBR bias.
Definition aom_encoder.h:720
unsigned int rc_superres_qthresh
Frame super-resolution q threshold.
Definition aom_encoder.h:588
unsigned int rc_buf_initial_sz
Decoder Buffer Initial Size.
Definition aom_encoder.h:697
unsigned int g_profile
Bitstream profile to use.
Definition aom_encoder.h:406
unsigned int g_limit
Max number of frames to encode.
Definition aom_encoder.h:429
unsigned int monochrome
Monochrome mode.
Definition aom_encoder.h:806
aom_bit_depth_t g_bit_depth
Bit-depth of the codec.
Definition aom_encoder.h:451
int tile_heights[64]
Array of specified tile heights.
Definition aom_encoder.h:865
unsigned int g_w
Width of the frame.
Definition aom_encoder.h:415
unsigned int g_forced_max_frame_width
Forced maximum width of the frame.
Definition aom_encoder.h:436
unsigned int rc_undershoot_pct
Rate control adaptation undershoot control.
Definition aom_encoder.h:664
unsigned int kf_max_dist
Keyframe maximum interval.
Definition aom_encoder.h:769
aom_codec_er_flags_t g_error_resilient
Enable error resilient modes.
Definition aom_encoder.h:481
unsigned int rc_max_quantizer
Maximum (Worst Quality) Quantizer.
Definition aom_encoder.h:651
unsigned int rc_superres_denominator
Frame super-resolution denominator.
Definition aom_encoder.h:569
unsigned int rc_buf_optimal_sz
Decoder Buffer Optimal Size.
Definition aom_encoder.h:706
unsigned int rc_min_quantizer
Minimum (Best Quality) Quantizer.
Definition aom_encoder.h:641
unsigned int sframe_dist
sframe interval
Definition aom_encoder.h:776
unsigned int sframe_mode
sframe insertion mode
Definition aom_encoder.h:791
enum aom_enc_pass g_pass
Multi-pass Encoding Mode.
Definition aom_encoder.h:488
int fwd_kf_enabled
Option to enable forward reference key frame.
Definition aom_encoder.h:743
int tile_widths[64]
Array of specified tile widths.
Definition aom_encoder.h:852
unsigned int rc_target_bitrate
Target data rate.
Definition aom_encoder.h:627
unsigned int rc_resize_mode
Mode for spatial resampling, if supported by the codec.
Definition aom_encoder.h:533
unsigned int rc_overshoot_pct
Rate control adaptation overshoot control.
Definition aom_encoder.h:673
aom_fixed_buf_t rc_twopass_stats_in
Two-pass stats buffer.
Definition aom_encoder.h:614
unsigned int save_as_annexb
Bitstream syntax mode.
Definition aom_encoder.h:823
unsigned int rc_superres_kf_qthresh
Keyframe super-resolution q threshold.
Definition aom_encoder.h:597
cfg_options_t encoder_cfg
Options defined per config file.
Definition aom_encoder.h:906
int tile_height_count
Number of explicit tile heights specified.
Definition aom_encoder.h:839
unsigned int large_scale_tile
Tile coding mode.
Definition aom_encoder.h:799
Generic fixed size buffer structure.
Definition aom_encoder.h:77
size_t sz
Definition aom_encoder.h:79
void * buf
Definition aom_encoder.h:78
Image Descriptor.
Definition aom_image.h:171
Rational Number.
Definition aom_encoder.h:153
int num
Definition aom_encoder.h:154
int den
Definition aom_encoder.h:155
Encoder Config Options.
Definition aom_encoder.h:216
unsigned int disable_tx_64x64
disable 64x64 transform
Definition aom_encoder.h:324
unsigned int reduced_reference_set
use reduced reference frame set
Definition aom_encoder.h:352
unsigned int disable_palette
disable Palette
Definition aom_encoder.h:292
unsigned int disable_inter_intra_comp
disable inter/intra compound
Definition aom_encoder.h:280
unsigned int disable_ab_partition_type
disable AB Shape partition type
Definition aom_encoder.h:236
unsigned int disable_warp_motion
disable Warped Motion
Definition aom_encoder.h:264
unsigned int disable_lr
disable Loop Restoration Filter
Definition aom_encoder.h:256
unsigned int disable_1to4_partition_type
disable 1:4/4:1 partition type
Definition aom_encoder.h:244
unsigned int disable_intra_angle_delta
disable intra angle delta
Definition aom_encoder.h:316
unsigned int min_partition_size
min partition size 8, 16, 32, 64, 128
Definition aom_encoder.h:232
unsigned int disable_smooth_intra
disable intra smooth mode
Definition aom_encoder.h:304
unsigned int disable_ref_frame_mv
disable ref frame MV
Definition aom_encoder.h:348
unsigned int reduced_tx_type_set
use reduced transform type set
Definition aom_encoder.h:356
unsigned int disable_one_sided_comp
disable one sided compound
Definition aom_encoder.h:288
unsigned int max_partition_size
max partition size 8, 16, 32, 64, 128
Definition aom_encoder.h:228
unsigned int disable_trellis_quant
disable trellis quantization
Definition aom_encoder.h:344
unsigned int disable_inter_intra_wedge
disable inter/intra wedge comp
Definition aom_encoder.h:336
unsigned int disable_rect_partition_type
disable rectangular partition type
Definition aom_encoder.h:240
unsigned int disable_smooth_inter_intra
disable smooth inter/intra
Definition aom_encoder.h:328
unsigned int disable_intrabc
disable Intra Block Copy
Definition aom_encoder.h:296
unsigned int disable_obmc
disable OBMC
Definition aom_encoder.h:260
unsigned int init_by_cfg_file
Indicate init by cfg file 0 or 1.
Definition aom_encoder.h:220
unsigned int disable_flip_idtx
disable flip and identity transform type
Definition aom_encoder.h:248
unsigned int disable_intra_edge_filter
disable intra edge filter
Definition aom_encoder.h:320
unsigned int disable_dual_filter
disable dual filter
Definition aom_encoder.h:312
unsigned int disable_global_motion
disable global motion
Definition aom_encoder.h:268
unsigned int disable_cfl
disable chroma from luma
Definition aom_encoder.h:300
unsigned int disable_diff_wtd_comp
disable diff weighted compound
Definition aom_encoder.h:276
unsigned int disable_inter_inter_wedge
disable inter/inter wedge comp
Definition aom_encoder.h:332
unsigned int super_block_size
Superblock size 0, 64 or 128.
Definition aom_encoder.h:224
unsigned int disable_filter_intra
disable filter intra
Definition aom_encoder.h:308
unsigned int disable_masked_comp
disable masked compound
Definition aom_encoder.h:284
unsigned int disable_cdef
disable CDEF filter
Definition aom_encoder.h:252
unsigned int disable_paeth_intra
disable paeth intra
Definition aom_encoder.h:340
unsigned int disable_dist_wtd_comp
disable dist weighted compound
Definition aom_encoder.h:272