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
30 extern "C" {
31 #endif
32 
33 #include "aom/aom_codec.h"
35 
54 #define AOM_ENCODER_ABI_VERSION \
55  (10 + AOM_CODEC_ABI_VERSION + /*AOM_EXT_PART_ABI_VERSION=*/3)
56 
66 #define AOM_CODEC_CAP_PSNR 0x10000
70 #define AOM_CODEC_CAP_HIGHBITDEPTH 0x40000
71 
79 #define AOM_CODEC_USE_PSNR 0x10000
80 #define AOM_CODEC_USE_HIGHBITDEPTH 0x40000
86 typedef struct aom_fixed_buf {
87  void *buf;
88  size_t sz;
97 typedef uint32_t aom_codec_er_flags_t;
99 #define AOM_ERROR_RESILIENT_DEFAULT 0x1
100 
112  AOM_CODEC_CUSTOM_PKT = 256
113 };
114 
120 typedef struct aom_codec_cx_pkt {
122  union {
123  struct {
124  void *buf;
125  size_t sz;
129  unsigned long duration;
137  } frame;
140  struct aom_psnr_pkt {
141  unsigned int samples[4];
142  uint64_t sse[4];
143  double psnr[4];
146  unsigned int samples_hbd[4];
149  uint64_t sse_hbd[4];
152  double psnr_hbd[4];
153  } psnr;
155  } data;
162 typedef struct aom_rational {
163  int num;
164  int den;
180 };
181 
188 };
189 
201  AOM_KF_DISABLED = 0
202 };
203 
205 typedef enum {
217  AOM_SUPERRES_AUTO,
219 
225 typedef struct cfg_options {
229  unsigned int init_by_cfg_file;
233  unsigned int super_block_size;
237  unsigned int max_partition_size;
241  unsigned int min_partition_size;
257  unsigned int disable_flip_idtx;
261  unsigned int disable_cdef;
265  unsigned int disable_lr;
269  unsigned int disable_obmc;
273  unsigned int disable_warp_motion;
277  unsigned int disable_global_motion;
281  unsigned int disable_dist_wtd_comp;
285  unsigned int disable_diff_wtd_comp;
293  unsigned int disable_masked_comp;
301  unsigned int disable_palette;
305  unsigned int disable_intrabc;
309  unsigned int disable_cfl;
313  unsigned int disable_smooth_intra;
317  unsigned int disable_filter_intra;
321  unsigned int disable_dual_filter;
333  unsigned int disable_tx_64x64;
349  unsigned int disable_paeth_intra;
353  unsigned int disable_trellis_quant;
357  unsigned int disable_ref_frame_mv;
361  unsigned int reduced_reference_set;
365  unsigned int reduced_tx_type_set;
367 
377 #define AOM_EFLAG_FORCE_KF (1 << 0)
378 
385 typedef struct aom_codec_enc_cfg {
386  /*
387  * generic settings (g)
388  */
389 
397  unsigned int g_usage;
398 
405  unsigned int g_threads;
406 
415  unsigned int g_profile;
424  unsigned int g_w;
425 
433  unsigned int g_h;
434 
443  unsigned int g_limit;
444 
451 
458 
466 
473  unsigned int g_input_bit_depth;
474 
487  struct aom_rational g_timebase;
488 
496 
502  enum aom_enc_pass g_pass;
503 
516  unsigned int g_lag_in_frames;
517 
518  /*
519  * rate control settings (rc)
520  */
521 
538  unsigned int rc_dropframe_thresh;
539 
547  unsigned int rc_resize_mode;
548 
555  unsigned int rc_resize_denominator;
556 
564 
572 
584 
594 
602  unsigned int rc_superres_qthresh;
603 
612 
622 
629 
636 
641  unsigned int rc_target_bitrate;
642 
643  /*
644  * quantizer settings
645  */
646 
655  unsigned int rc_min_quantizer;
656 
665  unsigned int rc_max_quantizer;
666 
667  /*
668  * bitrate tolerance
669  */
670 
678  unsigned int rc_undershoot_pct;
679 
687  unsigned int rc_overshoot_pct;
688 
689  /*
690  * decoder buffer model parameters
691  */
692 
702  unsigned int rc_buf_sz;
703 
711  unsigned int rc_buf_initial_sz;
712 
720  unsigned int rc_buf_optimal_sz;
721 
722  /*
723  * 2 pass rate control parameters
724  */
725 
734  unsigned int rc_2pass_vbr_bias_pct;
735 
742 
749 
750  /*
751  * keyframing settings (kf)
752  */
753 
758 
765  enum aom_kf_mode kf_mode;
766 
774  unsigned int kf_min_dist;
775 
783  unsigned int kf_max_dist;
784 
790  unsigned int sframe_dist;
791 
805  unsigned int sframe_mode;
806 
813  unsigned int large_scale_tile;
814 
820  unsigned int monochrome;
821 
832 
839  unsigned int save_as_annexb;
840 
848 
856 
861 #define MAX_TILE_WIDTHS 64 // maximum tile width array length
862 
869 
874 #define MAX_TILE_HEIGHTS 64 // maximum tile height array length
875 
882 
890  unsigned int use_fixed_qp_offsets;
891 
897 
930  aom_codec_iface_t *iface,
931  const aom_codec_enc_cfg_t *cfg,
932  aom_codec_flags_t flags, int ver);
933 
938 #define aom_codec_enc_init(ctx, iface, cfg, flags) \
939  aom_codec_enc_init_ver(ctx, iface, cfg, flags, AOM_ENCODER_ABI_VERSION)
940 
963  aom_codec_enc_cfg_t *cfg,
964  unsigned int usage);
965 
981  const aom_codec_enc_cfg_t *cfg);
982 
1007 
1009 #define AOM_USAGE_GOOD_QUALITY 0u
1011 #define AOM_USAGE_REALTIME 1u
1013 #define AOM_USAGE_ALL_INTRA 2u
1014 
1049  aom_codec_pts_t pts, unsigned long duration,
1050  aom_enc_frame_flags_t flags);
1051 
1096  const aom_fixed_buf_t *buf,
1097  unsigned int pad_before,
1098  unsigned int pad_after);
1099 
1124  aom_codec_iter_t *iter);
1125 
1139 
1141 #ifdef __cplusplus
1142 }
1143 #endif
1144 #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:861
#define MAX_TILE_HEIGHTS
Maximum number of tile heights in tile heights array.
Definition: aom_encoder.h:874
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:205
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.
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:97
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:183
aom_enc_pass
Multi-pass Encoding Pass.
Definition: aom_encoder.h:174
aom_fixed_buf_t * aom_codec_get_global_headers(aom_codec_ctx_t *ctx)
Get global stream headers.
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:198
long aom_enc_frame_flags_t
Encoded Frame Flags.
Definition: aom_encoder.h:375
const aom_image_t * aom_codec_get_preview_frame(aom_codec_ctx_t *ctx)
Get Preview Frame.
struct aom_codec_enc_cfg aom_codec_enc_cfg_t
Encoder configuration structure.
const aom_codec_cx_pkt_t * aom_codec_get_cx_data(aom_codec_ctx_t *ctx, aom_codec_iter_t *iter)
Encoded data iterator.
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:107
@ AOM_SUPERRES_RANDOM
Definition: aom_encoder.h:211
@ AOM_SUPERRES_QTHRESH
Definition: aom_encoder.h:214
@ AOM_SUPERRES_NONE
Definition: aom_encoder.h:207
@ AOM_SUPERRES_FIXED
Definition: aom_encoder.h:209
@ AOM_CBR
Definition: aom_encoder.h:185
@ AOM_CQ
Definition: aom_encoder.h:186
@ AOM_VBR
Definition: aom_encoder.h:184
@ AOM_Q
Definition: aom_encoder.h:187
@ AOM_RC_ONE_PASS
Definition: aom_encoder.h:175
@ AOM_RC_SECOND_PASS
Definition: aom_encoder.h:177
@ AOM_RC_LAST_PASS
Definition: aom_encoder.h:179
@ AOM_RC_THIRD_PASS
Definition: aom_encoder.h:178
@ AOM_RC_FIRST_PASS
Definition: aom_encoder.h:176
@ AOM_KF_FIXED
Definition: aom_encoder.h:199
@ AOM_KF_AUTO
Definition: aom_encoder.h:200
@ AOM_KF_DISABLED
Definition: aom_encoder.h:201
@ AOM_CODEC_PSNR_PKT
Definition: aom_encoder.h:111
@ AOM_CODEC_CUSTOM_PKT
Definition: aom_encoder.h:112
@ AOM_CODEC_CX_FRAME_PKT
Definition: aom_encoder.h:108
@ AOM_CODEC_STATS_PKT
Definition: aom_encoder.h:109
@ AOM_CODEC_FPMB_STATS_PKT
Definition: aom_encoder.h:110
Codec context structure.
Definition: aom_codec.h:298
Encoder output packet.
Definition: aom_encoder.h:120
unsigned long duration
duration to show frame (in timebase units)
Definition: aom_encoder.h:129
size_t sz
Definition: aom_encoder.h:125
enum aom_codec_cx_pkt_kind kind
Definition: aom_encoder.h:121
uint64_t sse_hbd[4]
sum squared error, total/y/u/v when input bit-depth < stream bit-depth.
Definition: aom_encoder.h:149
double psnr[4]
Definition: aom_encoder.h:143
aom_fixed_buf_t twopass_stats
Definition: aom_encoder.h:138
aom_fixed_buf_t raw
Definition: aom_encoder.h:154
double psnr_hbd[4]
PSNR, total/y/u/v when input bit-depth < stream bit-depth.
Definition: aom_encoder.h:152
union aom_codec_cx_pkt::@1 data
aom_codec_pts_t pts
time stamp to show frame (in timebase units)
Definition: aom_encoder.h:127
struct aom_codec_cx_pkt::@1::@2 frame
aom_fixed_buf_t firstpass_mb_stats
Definition: aom_encoder.h:139
size_t vis_frame_size
size of the visible frame in this packet
Definition: aom_encoder.h:136
aom_codec_frame_flags_t flags
Definition: aom_encoder.h:130
unsigned int samples_hbd[4]
Number of samples, total/y/u/v when input bit-depth < stream bit-depth.
Definition: aom_encoder.h:146
int partition_id
the partition id defines the decoding order of the partitions. Only applicable when "output partition...
Definition: aom_encoder.h:134
unsigned int samples[4]
Definition: aom_encoder.h:141
void * buf
Definition: aom_encoder.h:124
uint64_t sse[4]
Definition: aom_encoder.h:142
Encoder configuration structure.
Definition: aom_encoder.h:385
unsigned int g_input_bit_depth
Bit-depth of the input frames.
Definition: aom_encoder.h:473
unsigned int g_forced_max_frame_height
Forced maximum height of the frame.
Definition: aom_encoder.h:457
unsigned int rc_dropframe_thresh
Temporal resampling configuration, if supported by the codec.
Definition: aom_encoder.h:538
unsigned int rc_resize_denominator
Frame resize denominator.
Definition: aom_encoder.h:555
struct aom_rational g_timebase
Stream timebase units.
Definition: aom_encoder.h:487
int tile_width_count
Number of explicit tile widths specified.
Definition: aom_encoder.h:847
unsigned int g_usage
Algorithm specific "usage" value.
Definition: aom_encoder.h:397
unsigned int rc_buf_sz
Decoder Buffer Size.
Definition: aom_encoder.h:702
unsigned int full_still_picture_hdr
full_still_picture_hdr
Definition: aom_encoder.h:831
unsigned int g_h
Height of the frame.
Definition: aom_encoder.h:433
aom_superres_mode rc_superres_mode
Frame super-resolution scaling mode.
Definition: aom_encoder.h:571
int fixed_qp_offsets[5]
Deprecated and ignored. DO NOT USE.
Definition: aom_encoder.h:896
enum aom_kf_mode kf_mode
Keyframe placement mode.
Definition: aom_encoder.h:765
aom_fixed_buf_t rc_firstpass_mb_stats_in
first pass mb stats buffer.
Definition: aom_encoder.h:635
enum aom_rc_mode rc_end_usage
Rate control algorithm to use.
Definition: aom_encoder.h:621
unsigned int rc_superres_kf_denominator
Keyframe super-resolution denominator.
Definition: aom_encoder.h:593
unsigned int g_threads
Maximum number of threads to use.
Definition: aom_encoder.h:405
unsigned int rc_2pass_vbr_maxsection_pct
Two-pass mode per-GOP maximum bitrate.
Definition: aom_encoder.h:748
unsigned int rc_resize_kf_denominator
Keyframe resize denominator.
Definition: aom_encoder.h:563
unsigned int kf_min_dist
Keyframe minimum interval.
Definition: aom_encoder.h:774
unsigned int g_lag_in_frames
Allow lagged encoding.
Definition: aom_encoder.h:516
unsigned int use_fixed_qp_offsets
Whether encoder should use fixed QP offsets.
Definition: aom_encoder.h:890
unsigned int rc_2pass_vbr_minsection_pct
Two-pass mode per-GOP minimum bitrate.
Definition: aom_encoder.h:741
unsigned int rc_2pass_vbr_bias_pct
Two-pass mode CBR/VBR bias.
Definition: aom_encoder.h:734
unsigned int rc_superres_qthresh
Frame super-resolution q threshold.
Definition: aom_encoder.h:602
unsigned int rc_buf_initial_sz
Decoder Buffer Initial Size.
Definition: aom_encoder.h:711
unsigned int g_profile
Bitstream profile to use.
Definition: aom_encoder.h:415
unsigned int g_limit
Max number of frames to encode.
Definition: aom_encoder.h:443
unsigned int monochrome
Monochrome mode.
Definition: aom_encoder.h:820
aom_bit_depth_t g_bit_depth
Bit-depth of the codec.
Definition: aom_encoder.h:465
int tile_heights[64]
Array of specified tile heights.
Definition: aom_encoder.h:881
unsigned int g_w
Width of the frame.
Definition: aom_encoder.h:424
unsigned int g_forced_max_frame_width
Forced maximum width of the frame.
Definition: aom_encoder.h:450
unsigned int rc_undershoot_pct
Rate control adaptation undershoot control.
Definition: aom_encoder.h:678
unsigned int kf_max_dist
Keyframe maximum interval.
Definition: aom_encoder.h:783
aom_codec_er_flags_t g_error_resilient
Enable error resilient modes.
Definition: aom_encoder.h:495
unsigned int rc_max_quantizer
Maximum (Worst Quality) Quantizer.
Definition: aom_encoder.h:665
unsigned int rc_superres_denominator
Frame super-resolution denominator.
Definition: aom_encoder.h:583
unsigned int rc_buf_optimal_sz
Decoder Buffer Optimal Size.
Definition: aom_encoder.h:720
unsigned int rc_min_quantizer
Minimum (Best Quality) Quantizer.
Definition: aom_encoder.h:655
unsigned int sframe_dist
sframe interval
Definition: aom_encoder.h:790
unsigned int sframe_mode
sframe insertion mode
Definition: aom_encoder.h:805
enum aom_enc_pass g_pass
Multi-pass Encoding Mode.
Definition: aom_encoder.h:502
int fwd_kf_enabled
Option to enable forward reference key frame.
Definition: aom_encoder.h:757
int tile_widths[64]
Array of specified tile widths.
Definition: aom_encoder.h:868
unsigned int rc_target_bitrate
Target data rate.
Definition: aom_encoder.h:641
unsigned int rc_resize_mode
Mode for spatial resampling, if supported by the codec.
Definition: aom_encoder.h:547
unsigned int rc_overshoot_pct
Rate control adaptation overshoot control.
Definition: aom_encoder.h:687
aom_fixed_buf_t rc_twopass_stats_in
Two-pass stats buffer.
Definition: aom_encoder.h:628
unsigned int save_as_annexb
Bitstream syntax mode.
Definition: aom_encoder.h:839
unsigned int rc_superres_kf_qthresh
Keyframe super-resolution q threshold.
Definition: aom_encoder.h:611
cfg_options_t encoder_cfg
Options defined per config file.
Definition: aom_encoder.h:901
int tile_height_count
Number of explicit tile heights specified.
Definition: aom_encoder.h:855
unsigned int large_scale_tile
Tile coding mode.
Definition: aom_encoder.h:813
Generic fixed size buffer structure.
Definition: aom_encoder.h:86
size_t sz
Definition: aom_encoder.h:88
void * buf
Definition: aom_encoder.h:87
Image Descriptor.
Definition: aom_image.h:180
Rational Number.
Definition: aom_encoder.h:162
int num
Definition: aom_encoder.h:163
int den
Definition: aom_encoder.h:164
Encoder Config Options.
Definition: aom_encoder.h:225
unsigned int disable_tx_64x64
disable 64x64 transform
Definition: aom_encoder.h:333
unsigned int reduced_reference_set
use reduced reference frame set
Definition: aom_encoder.h:361
unsigned int disable_palette
disable Palette
Definition: aom_encoder.h:301
unsigned int disable_inter_intra_comp
disable inter/intra compound
Definition: aom_encoder.h:289
unsigned int disable_ab_partition_type
disable AB Shape partition type
Definition: aom_encoder.h:245
unsigned int disable_warp_motion
disable Warped Motion
Definition: aom_encoder.h:273
unsigned int disable_lr
disable Loop Restoration Filter
Definition: aom_encoder.h:265
unsigned int disable_1to4_partition_type
disable 1:4/4:1 partition type
Definition: aom_encoder.h:253
unsigned int disable_intra_angle_delta
disable intra angle delta
Definition: aom_encoder.h:325
unsigned int min_partition_size
min partition size 8, 16, 32, 64, 128
Definition: aom_encoder.h:241
unsigned int disable_smooth_intra
disable intra smooth mode
Definition: aom_encoder.h:313
unsigned int disable_ref_frame_mv
disable ref frame MV
Definition: aom_encoder.h:357
unsigned int reduced_tx_type_set
use reduced transform type set
Definition: aom_encoder.h:365
unsigned int disable_one_sided_comp
disable one sided compound
Definition: aom_encoder.h:297
unsigned int max_partition_size
max partition size 8, 16, 32, 64, 128
Definition: aom_encoder.h:237
unsigned int disable_trellis_quant
disable trellis quantization
Definition: aom_encoder.h:353
unsigned int disable_inter_intra_wedge
disable inter/intra wedge comp
Definition: aom_encoder.h:345
unsigned int disable_rect_partition_type
disable rectangular partition type
Definition: aom_encoder.h:249
unsigned int disable_smooth_inter_intra
disable smooth inter/intra
Definition: aom_encoder.h:337
unsigned int disable_intrabc
disable Intra Block Copy
Definition: aom_encoder.h:305
unsigned int disable_obmc
disable OBMC
Definition: aom_encoder.h:269
unsigned int init_by_cfg_file
Indicate init by cfg file 0 or 1.
Definition: aom_encoder.h:229
unsigned int disable_flip_idtx
disable flip and identity transform type
Definition: aom_encoder.h:257
unsigned int disable_intra_edge_filter
disable intra edge filter
Definition: aom_encoder.h:329
unsigned int disable_dual_filter
disable dual filter
Definition: aom_encoder.h:321
unsigned int disable_global_motion
disable global motion
Definition: aom_encoder.h:277
unsigned int disable_cfl
disable chroma from luma
Definition: aom_encoder.h:309
unsigned int disable_diff_wtd_comp
disable diff weighted compound
Definition: aom_encoder.h:285
unsigned int disable_inter_inter_wedge
disable inter/inter wedge comp
Definition: aom_encoder.h:341
unsigned int super_block_size
Superblock size 0, 64 or 128.
Definition: aom_encoder.h:233
unsigned int disable_filter_intra
disable filter intra
Definition: aom_encoder.h:317
unsigned int disable_masked_comp
disable masked compound
Definition: aom_encoder.h:293
unsigned int disable_cdef
disable CDEF filter
Definition: aom_encoder.h:261
unsigned int disable_paeth_intra
disable paeth intra
Definition: aom_encoder.h:349
unsigned int disable_dist_wtd_comp
disable dist weighted compound
Definition: aom_encoder.h:281