AOMedia Codec SDK
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"
34 
43 #define AOM_ENCODER_ABI_VERSION \
44  (8 + AOM_CODEC_ABI_VERSION)
55 #define AOM_CODEC_CAP_PSNR 0x10000
59 #define AOM_CODEC_CAP_HIGHBITDEPTH 0x40000
60 
68 #define AOM_CODEC_USE_PSNR 0x10000
70 #define AOM_CODEC_USE_HIGHBITDEPTH 0x40000
76 typedef struct aom_fixed_buf {
77  void *buf;
78  size_t sz;
88 typedef uint32_t aom_codec_frame_flags_t;
89 #define AOM_FRAME_IS_KEY 0x1
92 #define AOM_FRAME_IS_DROPPABLE 0x2
94 #define AOM_FRAME_IS_INTRAONLY 0x10
96 #define AOM_FRAME_IS_SWITCH 0x20
98 #define AOM_FRAME_IS_ERROR_RESILIENT 0x40
100 #define AOM_FRAME_IS_DELAYED_RANDOM_ACCESS_POINT 0x80
101 
108 typedef uint32_t aom_codec_er_flags_t;
110 #define AOM_ERROR_RESILIENT_DEFAULT 0x1
111 
123  AOM_CODEC_CUSTOM_PKT = 256
124 };
125 
131 typedef struct aom_codec_cx_pkt {
133  union {
134  struct {
135  void *buf;
136  size_t sz;
140  unsigned long duration;
148  } frame;
151  struct aom_psnr_pkt {
152  unsigned int samples[4];
153  uint64_t sse[4];
154  double psnr[4];
155  } psnr;
158  /* This packet size is fixed to allow codecs to extend this
159  * interface without having to manage storage for raw packets,
160  * i.e., if it's smaller than 128 bytes, you can store in the
161  * packet list directly.
162  */
163  char pad[128 - sizeof(enum aom_codec_cx_pkt_kind)];
164  } data;
171 typedef struct aom_rational {
172  int num;
173  int den;
181 };
182 
189 };
190 
202  AOM_KF_DISABLED = 0
203 };
204 
210 typedef struct cfg_options {
214  unsigned int init_by_cfg_file;
218  unsigned int super_block_size;
222  unsigned int max_partition_size;
226  unsigned int min_partition_size;
242  unsigned int disable_flip_idtx;
246  unsigned int disable_cdef;
250  unsigned int disable_lr;
254  unsigned int disable_obmc;
258  unsigned int disable_warp_motion;
262  unsigned int disable_global_motion;
266  unsigned int disable_dist_wtd_comp;
270  unsigned int disable_diff_wtd_comp;
278  unsigned int disable_masked_comp;
286  unsigned int disable_palette;
290  unsigned int disable_intrabc;
294  unsigned int disable_cfl;
298  unsigned int disable_smooth_intra;
302  unsigned int disable_filter_intra;
306  unsigned int disable_dual_filter;
318  unsigned int disable_tx_64x64;
334  unsigned int disable_paeth_intra;
338  unsigned int disable_trellis_quant;
342  unsigned int disable_ref_frame_mv;
346  unsigned int reduced_reference_set;
350  unsigned int reduced_tx_type_set;
352 
361 #define AOM_EFLAG_FORCE_KF (1 << 0)
369 typedef struct aom_codec_enc_cfg {
370  /*
371  * generic settings (g)
372  */
373 
381  unsigned int g_usage;
382 
389  unsigned int g_threads;
390 
399  unsigned int g_profile;
408  unsigned int g_w;
409 
417  unsigned int g_h;
418 
422  unsigned int g_limit;
423 
430 
437 
445 
452  unsigned int g_input_bit_depth;
453 
466  struct aom_rational g_timebase;
467 
475 
481  enum aom_enc_pass g_pass;
482 
495  unsigned int g_lag_in_frames;
496 
497  /*
498  * rate control settings (rc)
499  */
500 
517  unsigned int rc_dropframe_thresh;
518 
526  unsigned int rc_resize_mode;
527 
534  unsigned int rc_resize_denominator;
535 
543 
552  unsigned int rc_superres_mode;
553 
565 
575 
583  unsigned int rc_superres_qthresh;
584 
593 
603 
610 
617 
622  unsigned int rc_target_bitrate;
623 
624  /*
625  * quantizer settings
626  */
627 
636  unsigned int rc_min_quantizer;
637 
646  unsigned int rc_max_quantizer;
647 
648  /*
649  * bitrate tolerance
650  */
651 
662  unsigned int rc_undershoot_pct;
663 
674  unsigned int rc_overshoot_pct;
675 
676  /*
677  * decoder buffer model parameters
678  */
679 
689  unsigned int rc_buf_sz;
690 
698  unsigned int rc_buf_initial_sz;
699 
707  unsigned int rc_buf_optimal_sz;
708 
709  /*
710  * 2 pass rate control parameters
711  */
712 
721  unsigned int rc_2pass_vbr_bias_pct;
722 
729 
736 
737  /*
738  * keyframing settings (kf)
739  */
740 
745 
752  enum aom_kf_mode kf_mode;
753 
761  unsigned int kf_min_dist;
762 
770  unsigned int kf_max_dist;
771 
777  unsigned int sframe_dist;
778 
792  unsigned int sframe_mode;
793 
800  unsigned int large_scale_tile;
801 
807  unsigned int monochrome;
808 
817 
824  unsigned int save_as_annexb;
825 
833 
841 
846 #define MAX_TILE_WIDTHS 64 // maximum tile width array length
847 
854 
859 #define MAX_TILE_HEIGHTS 64 // maximum tile height array length
860 
867 
880  unsigned int use_fixed_qp_offsets;
881 
886 #define FIXED_QP_OFFSET_COUNT 5
887 
903 
933  aom_codec_iface_t *iface,
934  const aom_codec_enc_cfg_t *cfg,
935  aom_codec_flags_t flags, int ver);
936 
941 #define aom_codec_enc_init(ctx, iface, cfg, flags) \
942  aom_codec_enc_init_ver(ctx, iface, cfg, flags, AOM_ENCODER_ABI_VERSION)
943 
966  aom_codec_enc_cfg_t *cfg,
967  unsigned int usage);
968 
984  const aom_codec_enc_cfg_t *cfg);
985 
1010 
1012 #define AOM_USAGE_GOOD_QUALITY (0)
1014 #define AOM_USAGE_REALTIME (1)
1015 
1041  aom_codec_pts_t pts, unsigned long duration,
1042  aom_enc_frame_flags_t flags);
1043 
1088  const aom_fixed_buf_t *buf,
1089  unsigned int pad_before,
1090  unsigned int pad_after);
1091 
1116  aom_codec_iter_t *iter);
1117 
1131 
1133 #ifdef __cplusplus
1134 }
1135 #endif
1136 #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:846
#define MAX_TILE_HEIGHTS
Maximum number of tile heights in tile heights array.
Definition: aom_encoder.h:859
#define FIXED_QP_OFFSET_COUNT
Number of fixed QP offsets.
Definition: aom_encoder.h:886
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:174
const struct aom_codec_iface aom_codec_iface_t
Codec interface structure.
Definition: aom_codec.h:196
int64_t aom_codec_pts_t
Time Stamp Type.
Definition: aom_codec.h:181
aom_codec_err_t
Algorithm return codes.
Definition: aom_codec.h:101
const void * aom_codec_iter_t
Iterator.
Definition: aom_codec.h:209
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:108
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:184
aom_enc_pass
Multi-pass Encoding Pass.
Definition: aom_encoder.h:177
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:199
long aom_enc_frame_flags_t
Encoded Frame Flags.
Definition: aom_encoder.h:360
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.
uint32_t aom_codec_frame_flags_t
Compressed Frame Flags.
Definition: aom_encoder.h:88
aom_codec_cx_pkt_kind
Encoder output packet variants.
Definition: aom_encoder.h:118
@ AOM_CBR
Definition: aom_encoder.h:186
@ AOM_CQ
Definition: aom_encoder.h:187
@ AOM_VBR
Definition: aom_encoder.h:185
@ AOM_Q
Definition: aom_encoder.h:188
@ AOM_RC_ONE_PASS
Definition: aom_encoder.h:178
@ AOM_RC_LAST_PASS
Definition: aom_encoder.h:180
@ AOM_RC_FIRST_PASS
Definition: aom_encoder.h:179
@ AOM_KF_FIXED
Definition: aom_encoder.h:200
@ AOM_KF_AUTO
Definition: aom_encoder.h:201
@ AOM_KF_DISABLED
Definition: aom_encoder.h:202
@ AOM_CODEC_PSNR_PKT
Definition: aom_encoder.h:122
@ AOM_CODEC_CUSTOM_PKT
Definition: aom_encoder.h:123
@ AOM_CODEC_CX_FRAME_PKT
Definition: aom_encoder.h:119
@ AOM_CODEC_STATS_PKT
Definition: aom_encoder.h:120
@ AOM_CODEC_FPMB_STATS_PKT
Definition: aom_encoder.h:121
Codec context structure.
Definition: aom_codec.h:219
Encoder output packet.
Definition: aom_encoder.h:131
unsigned long duration
duration to show frame (in timebase units)
Definition: aom_encoder.h:140
size_t sz
Definition: aom_encoder.h:136
enum aom_codec_cx_pkt_kind kind
Definition: aom_encoder.h:132
double psnr[4]
Definition: aom_encoder.h:154
aom_fixed_buf_t twopass_stats
Definition: aom_encoder.h:149
aom_fixed_buf_t raw
Definition: aom_encoder.h:156
union aom_codec_cx_pkt::@1 data
aom_codec_pts_t pts
time stamp to show frame (in timebase units)
Definition: aom_encoder.h:138
struct aom_codec_cx_pkt::@1::@2 frame
aom_fixed_buf_t firstpass_mb_stats
Definition: aom_encoder.h:150
size_t vis_frame_size
size of the visible frame in this packet
Definition: aom_encoder.h:147
char pad[128 - sizeof(enum aom_codec_cx_pkt_kind)]
Definition: aom_encoder.h:163
aom_codec_frame_flags_t flags
Definition: aom_encoder.h:141
int partition_id
the partition id defines the decoding order of the partitions. Only applicable when "output partition...
Definition: aom_encoder.h:145
unsigned int samples[4]
Definition: aom_encoder.h:152
void * buf
Definition: aom_encoder.h:135
uint64_t sse[4]
Definition: aom_encoder.h:153
Encoder configuration structure.
Definition: aom_encoder.h:369
unsigned int g_input_bit_depth
Bit-depth of the input frames.
Definition: aom_encoder.h:452
unsigned int g_forced_max_frame_height
Forced maximum height of the frame.
Definition: aom_encoder.h:436
unsigned int rc_dropframe_thresh
Temporal resampling configuration, if supported by the codec.
Definition: aom_encoder.h:517
unsigned int rc_resize_denominator
Frame resize denominator.
Definition: aom_encoder.h:534
struct aom_rational g_timebase
Stream timebase units.
Definition: aom_encoder.h:466
int tile_width_count
Number of explicit tile widths specified.
Definition: aom_encoder.h:832
unsigned int g_usage
Algorithm specific "usage" value.
Definition: aom_encoder.h:381
unsigned int rc_buf_sz
Decoder Buffer Size.
Definition: aom_encoder.h:689
unsigned int full_still_picture_hdr
full_still_picture_hdr
Definition: aom_encoder.h:816
unsigned int g_h
Height of the frame.
Definition: aom_encoder.h:417
int fixed_qp_offsets[5]
Array of fixed QP offsets.
Definition: aom_encoder.h:902
enum aom_kf_mode kf_mode
Keyframe placement mode.
Definition: aom_encoder.h:752
aom_fixed_buf_t rc_firstpass_mb_stats_in
first pass mb stats buffer.
Definition: aom_encoder.h:616
enum aom_rc_mode rc_end_usage
Rate control algorithm to use.
Definition: aom_encoder.h:602
unsigned int rc_superres_kf_denominator
Keyframe super-resolution denominator.
Definition: aom_encoder.h:574
unsigned int g_threads
Maximum number of threads to use.
Definition: aom_encoder.h:389
unsigned int rc_2pass_vbr_maxsection_pct
Two-pass mode per-GOP maximum bitrate.
Definition: aom_encoder.h:735
unsigned int rc_resize_kf_denominator
Keyframe resize denominator.
Definition: aom_encoder.h:542
unsigned int kf_min_dist
Keyframe minimum interval.
Definition: aom_encoder.h:761
unsigned int g_lag_in_frames
Allow lagged encoding.
Definition: aom_encoder.h:495
unsigned int use_fixed_qp_offsets
Whether encoder should use fixed QP offsets.
Definition: aom_encoder.h:880
unsigned int rc_2pass_vbr_minsection_pct
Two-pass mode per-GOP minimum bitrate.
Definition: aom_encoder.h:728
unsigned int rc_2pass_vbr_bias_pct
Two-pass mode CBR/VBR bias.
Definition: aom_encoder.h:721
unsigned int rc_superres_qthresh
Frame super-resolution q threshold.
Definition: aom_encoder.h:583
unsigned int rc_buf_initial_sz
Decoder Buffer Initial Size.
Definition: aom_encoder.h:698
unsigned int rc_superres_mode
Frame super-resolution scaling mode.
Definition: aom_encoder.h:552
unsigned int g_profile
Bitstream profile to use.
Definition: aom_encoder.h:399
unsigned int g_limit
Max number of frames to encode.
Definition: aom_encoder.h:422
unsigned int monochrome
Monochrome mode.
Definition: aom_encoder.h:807
aom_bit_depth_t g_bit_depth
Bit-depth of the codec.
Definition: aom_encoder.h:444
int tile_heights[64]
Array of specified tile heights.
Definition: aom_encoder.h:866
unsigned int g_w
Width of the frame.
Definition: aom_encoder.h:408
unsigned int g_forced_max_frame_width
Forced maximum width of the frame.
Definition: aom_encoder.h:429
unsigned int rc_undershoot_pct
Rate control adaptation undershoot control.
Definition: aom_encoder.h:662
unsigned int kf_max_dist
Keyframe maximum interval.
Definition: aom_encoder.h:770
aom_codec_er_flags_t g_error_resilient
Enable error resilient modes.
Definition: aom_encoder.h:474
unsigned int rc_max_quantizer
Maximum (Worst Quality) Quantizer.
Definition: aom_encoder.h:646
unsigned int rc_superres_denominator
Frame super-resolution denominator.
Definition: aom_encoder.h:564
unsigned int rc_buf_optimal_sz
Decoder Buffer Optimal Size.
Definition: aom_encoder.h:707
unsigned int rc_min_quantizer
Minimum (Best Quality) Quantizer.
Definition: aom_encoder.h:636
unsigned int sframe_dist
sframe interval
Definition: aom_encoder.h:777
unsigned int sframe_mode
sframe insertion mode
Definition: aom_encoder.h:792
enum aom_enc_pass g_pass
Multi-pass Encoding Mode.
Definition: aom_encoder.h:481
int fwd_kf_enabled
Option to enable forward reference key frame.
Definition: aom_encoder.h:744
int tile_widths[64]
Array of specified tile widths.
Definition: aom_encoder.h:853
unsigned int rc_target_bitrate
Target data rate.
Definition: aom_encoder.h:622
unsigned int rc_resize_mode
Mode for spatial resampling, if supported by the codec.
Definition: aom_encoder.h:526
unsigned int rc_overshoot_pct
Rate control adaptation overshoot control.
Definition: aom_encoder.h:674
aom_fixed_buf_t rc_twopass_stats_in
Two-pass stats buffer.
Definition: aom_encoder.h:609
unsigned int save_as_annexb
Bitstream syntax mode.
Definition: aom_encoder.h:824
unsigned int rc_superres_kf_qthresh
Keyframe super-resolution q threshold.
Definition: aom_encoder.h:592
cfg_options_t encoder_cfg
Options defined per config file.
Definition: aom_encoder.h:907
int tile_height_count
Number of explicit tile heights specified.
Definition: aom_encoder.h:840
unsigned int large_scale_tile
Tile coding mode.
Definition: aom_encoder.h:800
Generic fixed size buffer structure.
Definition: aom_encoder.h:76
size_t sz
Definition: aom_encoder.h:78
void * buf
Definition: aom_encoder.h:77
Image Descriptor.
Definition: aom_image.h:171
Rational Number.
Definition: aom_encoder.h:171
int num
Definition: aom_encoder.h:172
int den
Definition: aom_encoder.h:173
Encoder Config Options.
Definition: aom_encoder.h:210
unsigned int disable_tx_64x64
disable 64x64 transform
Definition: aom_encoder.h:318
unsigned int reduced_reference_set
use reduced reference frame set
Definition: aom_encoder.h:346
unsigned int disable_palette
disable Palette
Definition: aom_encoder.h:286
unsigned int disable_inter_intra_comp
disable inter/intra compound
Definition: aom_encoder.h:274
unsigned int disable_ab_partition_type
disable AB Shape partition type
Definition: aom_encoder.h:230
unsigned int disable_warp_motion
disable Warped Motion
Definition: aom_encoder.h:258
unsigned int disable_lr
disable Loop Restoration Filter
Definition: aom_encoder.h:250
unsigned int disable_1to4_partition_type
disable 1:4/4:1 partition type
Definition: aom_encoder.h:238
unsigned int disable_intra_angle_delta
disable intra angle delta
Definition: aom_encoder.h:310
unsigned int min_partition_size
min partition size 8, 16, 32, 64, 128
Definition: aom_encoder.h:226
unsigned int disable_smooth_intra
disable intra smooth mode
Definition: aom_encoder.h:298
unsigned int disable_ref_frame_mv
disable ref frame MV
Definition: aom_encoder.h:342
unsigned int reduced_tx_type_set
use reduced transform type set
Definition: aom_encoder.h:350
unsigned int disable_one_sided_comp
disable one sided compound
Definition: aom_encoder.h:282
unsigned int max_partition_size
max partition size 8, 16, 32, 64, 128
Definition: aom_encoder.h:222
unsigned int disable_trellis_quant
disable trellis quantization
Definition: aom_encoder.h:338
unsigned int disable_inter_intra_wedge
disable inter/intra wedge comp
Definition: aom_encoder.h:330
unsigned int disable_rect_partition_type
disable rectangular partition type
Definition: aom_encoder.h:234
unsigned int disable_smooth_inter_intra
disable smooth inter/intra
Definition: aom_encoder.h:322
unsigned int disable_intrabc
disable Intra Block Copy
Definition: aom_encoder.h:290
unsigned int disable_obmc
disable OBMC
Definition: aom_encoder.h:254
unsigned int init_by_cfg_file
Indicate init by cfg file 0 or 1.
Definition: aom_encoder.h:214
unsigned int disable_flip_idtx
disable flip and identity transform type
Definition: aom_encoder.h:242
unsigned int disable_intra_edge_filter
disable intra edge filter
Definition: aom_encoder.h:314
unsigned int disable_dual_filter
disable dual filter
Definition: aom_encoder.h:306
unsigned int disable_global_motion
disable global motion
Definition: aom_encoder.h:262
unsigned int disable_cfl
disable chroma from luma
Definition: aom_encoder.h:294
unsigned int disable_diff_wtd_comp
disable diff weighted compound
Definition: aom_encoder.h:270
unsigned int disable_inter_inter_wedge
disable inter/inter wedge comp
Definition: aom_encoder.h:326
unsigned int super_block_size
Superblock size 0, 64 or 128.
Definition: aom_encoder.h:218
unsigned int disable_filter_intra
disable filter intra
Definition: aom_encoder.h:302
unsigned int disable_masked_comp
disable masked compound
Definition: aom_encoder.h:278
unsigned int disable_cdef
disable CDEF filter
Definition: aom_encoder.h:246
unsigned int disable_paeth_intra
disable paeth intra
Definition: aom_encoder.h:334
unsigned int disable_dist_wtd_comp
disable dist weighted compound
Definition: aom_encoder.h:266