AOMedia AV1 Codec
firstpass.h
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 
12 #ifndef AOM_AV1_ENCODER_FIRSTPASS_H_
13 #define AOM_AV1_ENCODER_FIRSTPASS_H_
14 
15 #include "av1/common/av1_common_int.h"
16 #include "av1/common/enums.h"
17 #include "av1/encoder/lookahead.h"
18 #include "av1/encoder/ratectrl.h"
19 
20 #ifdef __cplusplus
21 extern "C" {
22 #endif
23 
24 #define DOUBLE_DIVIDE_CHECK(x) ((x) < 0 ? (x)-0.000001 : (x) + 0.000001)
25 
26 #define MIN_ZERO_MOTION 0.95
27 #define MAX_SR_CODED_ERROR 40
28 #define MAX_RAW_ERR_VAR 2000
29 #define MIN_MV_IN_OUT 0.4
30 
31 #define VLOW_MOTION_THRESHOLD 950
32 struct ThreadData;
33 
41 typedef struct FIRSTPASS_STATS {
46  double frame;
52  double weight;
56  double intra_error;
64  double coded_error;
72  double pcnt_inter;
76  double pcnt_motion;
88  double pcnt_neutral;
108  double MVr;
112  double mvr_abs;
116  double MVc;
120  double mvc_abs;
124  double MVrv;
128  double MVcv;
138  double new_mv_count;
142  double duration;
147  double count;
155  int64_t is_flash;
159  double noise_var;
163  double cor_coeff;
165 
166 // We want to keep one past stats for key frame detection
167 // in test_candidate_kf()
168 #define FIRSTPASS_INFO_STATS_PAST_MIN 1
169 
170 // The size of static buffer used in FIRSTPASS_INFO.
171 #define FIRSTPASS_INFO_STATIC_BUF_SIZE \
172  (MAX_LAP_BUFFERS + FIRSTPASS_INFO_STATS_PAST_MIN)
173 
177 typedef struct {
187  FIRSTPASS_STATS static_stats_buf[FIRSTPASS_INFO_STATIC_BUF_SIZE];
205 
212 
217 
222 
227 
233 
247  FIRSTPASS_STATS *ext_stats_buf,
248  int ext_stats_buf_size);
249 
257  FIRSTPASS_INFO *firstpass_info);
258 
266 
274  FIRSTPASS_INFO *firstpass_info);
275 
285  const FIRSTPASS_STATS *input_stats);
286 
299  const FIRSTPASS_INFO *firstpass_info, int offset_from_cur);
300 
314  int offset_from_cur);
315 
329  int offset_from_cur);
330 
332 #define FC_ANIMATION_THRESH 0.15
333 enum {
334  FC_NORMAL = 0,
335  FC_GRAPHICS_ANIMATION = 1,
336  FRAME_CONTENT_TYPES = 2
337 } UENUM1BYTE(FRAME_CONTENT_TYPE);
344 typedef struct GF_GROUP {
346  // Frame update type, e.g. ARF/GF/LF/Overlay
347  FRAME_UPDATE_TYPE update_type[MAX_STATIC_GF_GROUP_LENGTH];
348  unsigned char arf_src_offset[MAX_STATIC_GF_GROUP_LENGTH];
349  // The number of frames displayed so far within the GOP at a given coding
350  // frame.
351  unsigned char cur_frame_idx[MAX_STATIC_GF_GROUP_LENGTH];
352  int layer_depth[MAX_STATIC_GF_GROUP_LENGTH];
353  int arf_boost[MAX_STATIC_GF_GROUP_LENGTH];
354  int max_layer_depth;
355  int max_layer_depth_allowed;
356  // This is currently only populated for AOM_Q mode
357  int q_val[MAX_STATIC_GF_GROUP_LENGTH];
358  int rdmult_val[MAX_STATIC_GF_GROUP_LENGTH];
359  int bit_allocation[MAX_STATIC_GF_GROUP_LENGTH];
360  // The frame coding type - inter/intra frame
361  FRAME_TYPE frame_type[MAX_STATIC_GF_GROUP_LENGTH];
362  // The reference frame buffer control - update or reset
363  REFBUF_STATE refbuf_state[MAX_STATIC_GF_GROUP_LENGTH];
364  int arf_index; // the index in the gf group of ARF, if no arf, then -1
365  int size; // The total length of a GOP
366 
367  // The offset into lookahead_ctx for choosing
368  // source of frame parallel encodes.
369  int src_offset[MAX_STATIC_GF_GROUP_LENGTH];
370  // Stores the display order hint of each frame in the current GF_GROUP.
371  int display_idx[MAX_STATIC_GF_GROUP_LENGTH];
372 
373  // The reference frame list maps the reference frame indexes to its
374  // buffer index in the decoded buffer. A value of -1 means the
375  // corresponding reference frame index doesn't point towards any
376  // previously decoded frame.
377  int8_t ref_frame_list[MAX_STATIC_GF_GROUP_LENGTH][REF_FRAMES];
378  // Update frame index
379  int update_ref_idx[MAX_STATIC_GF_GROUP_LENGTH];
380  // The map_idx of primary reference
381  int primary_ref_idx[MAX_STATIC_GF_GROUP_LENGTH];
382 
383  // Indicates the level of parallelism in frame parallel encodes.
384  // 0 : frame is independently encoded (not part of parallel encodes).
385  // 1 : frame is the first in encode order in a given parallel encode set.
386  // 2 : frame occurs later in encode order in a given parallel encode set.
387  int frame_parallel_level[MAX_STATIC_GF_GROUP_LENGTH];
388  // Indicates whether a frame should act as non-reference frame.
389  // 0 : frame is a reference frame.
390  // 1 : frame is a non-reference frame.
391  int is_frame_non_ref[MAX_STATIC_GF_GROUP_LENGTH];
392 
393  // Stores the display order hint of the frames not to be
394  // refreshed by the current frame.
395  int skip_frame_refresh[MAX_STATIC_GF_GROUP_LENGTH][REF_FRAMES];
396  // Stores the display order hint of the frame to be excluded during reference
397  // assignment.
398  int skip_frame_as_ref[MAX_STATIC_GF_GROUP_LENGTH];
400 } GF_GROUP;
403 typedef struct {
404  // Track if the last frame in a GOP has higher quality.
405  int arf_gf_boost_lst;
406 } GF_STATE;
407 
408 typedef struct {
409  FIRSTPASS_STATS *stats_in_start;
410  FIRSTPASS_STATS *stats_in_end;
411  FIRSTPASS_STATS *stats_in_buf_end;
412  FIRSTPASS_STATS *total_stats;
413  FIRSTPASS_STATS *total_left_stats;
414 } STATS_BUFFER_CTX;
415 
421 typedef struct {
423  unsigned int section_intra_rating;
424  // Circular queue of first pass stats stored for most recent frames.
425  // cpi->output_pkt_list[i].data.twopass_stats.buf points to actual data stored
426  // here.
427  FIRSTPASS_STATS *frame_stats_arr[MAX_LAP_BUFFERS + 1];
428  int frame_stats_next_idx; // Index to next unused element in frame_stats_arr.
429  STATS_BUFFER_CTX *stats_buf_ctx;
430  FIRSTPASS_INFO firstpass_info; // This is the first pass data structure
431  // intended to replace stats_in
432  int first_pass_done;
433  int64_t bits_left;
434  double modified_error_min;
435  double modified_error_max;
436  double modified_error_left;
437 
438  // Projected total bits available for a key frame group of frames
439  int64_t kf_group_bits;
440 
441  // Error score of frames still to be coded in kf group
442  double kf_group_error_left;
443 
444  // Over time correction for bits per macro block estimation
445  double bpm_factor;
446 
447  // Record of target and actual bits spent in current ARF group
448  int rolling_arf_group_target_bits;
449  int rolling_arf_group_actual_bits;
450 
451  int sr_update_lag;
452 
453  int kf_zeromotion_pct;
454  int last_kfgroup_zeromotion_pct;
455  int extend_minq;
456  int extend_maxq;
457  int extend_minq_fast;
459 } TWO_PASS;
460 
464 typedef struct {
466  const FIRSTPASS_STATS *stats_in;
467  // Pointer to the stats of the current frame.
468  const FIRSTPASS_STATS *this_frame;
469  double mb_av_energy;
470  // An indication of the content type of the current frame
471  FRAME_CONTENT_TYPE fr_content_type;
472  double frame_avg_haar_energy;
475 
478 // This structure contains several key parameters to be accumulated for this
479 // frame.
480 typedef struct {
481  // Intra prediction error.
482  int64_t intra_error;
483  // Average wavelet energy computed using Discrete Wavelet Transform (DWT).
484  int64_t frame_avg_wavelet_energy;
485  // Best of intra pred error and inter pred error using last frame as ref.
486  int64_t coded_error;
487  // Best of intra pred error and inter pred error using golden frame as ref.
488  int64_t sr_coded_error;
489  // Count of motion vector.
490  int mv_count;
491  // Count of blocks that pick inter prediction (inter pred error is smaller
492  // than intra pred error).
493  int inter_count;
494  // Count of blocks that pick second ref (golden frame).
495  int second_ref_count;
496  // Count of blocks where the inter and intra are very close and very low.
497  double neutral_count;
498  // Count of blocks where intra error is very small.
499  int intra_skip_count;
500  // Start row.
501  int image_data_start_row;
502  // Count of unique non-zero motion vectors.
503  int new_mv_count;
504  // Sum of inward motion vectors.
505  int sum_in_vectors;
506  // Sum of motion vector row.
507  int sum_mvr;
508  // Sum of motion vector column.
509  int sum_mvc;
510  // Sum of absolute value of motion vector row.
511  int sum_mvr_abs;
512  // Sum of absolute value of motion vector column.
513  int sum_mvc_abs;
514  // Sum of the square of motion vector row.
515  int64_t sum_mvrs;
516  // Sum of the square of motion vector column.
517  int64_t sum_mvcs;
518  // A factor calculated using intra pred error.
519  double intra_factor;
520  // A factor that measures brightness.
521  double brightness_factor;
522 } FRAME_STATS;
523 
524 // This structure contains first pass data.
525 typedef struct {
526  // Buffer holding frame stats for all MACROBLOCKs.
527  // mb_stats[i] stores the FRAME_STATS of the ith
528  // MB in raster scan order.
529  FRAME_STATS *mb_stats;
530  // Buffer to store the prediction error of the (0,0) motion
531  // vector using the last source frame as the reference.
532  // raw_motion_err_list[i] stores the raw_motion_err of
533  // the ith MB in raster scan order.
534  int *raw_motion_err_list;
535 } FirstPassData;
536 
537 struct AV1_COMP;
538 struct EncodeFrameParams;
539 struct AV1EncoderConfig;
540 struct TileDataEnc;
541 
542 static INLINE int is_fp_wavelet_energy_invalid(
543  const FIRSTPASS_STATS *fp_stats) {
544  assert(fp_stats != NULL);
545  return (fp_stats->frame_avg_wavelet_energy < 0);
546 }
547 
548 static INLINE BLOCK_SIZE get_fp_block_size(int is_screen_content_type) {
549  return (is_screen_content_type ? BLOCK_8X8 : BLOCK_16X16);
550 }
551 
552 int av1_get_unit_rows_in_tile(const TileInfo *tile,
553  const BLOCK_SIZE fp_block_size);
554 int av1_get_unit_cols_in_tile(const TileInfo *tile,
555  const BLOCK_SIZE fp_block_size);
556 
557 void av1_first_pass_row(struct AV1_COMP *cpi, struct ThreadData *td,
558  struct TileDataEnc *tile_data, const int mb_row,
559  const BLOCK_SIZE fp_block_size);
560 void av1_end_first_pass(struct AV1_COMP *cpi);
561 
562 void av1_twopass_zero_stats(FIRSTPASS_STATS *section);
563 void av1_accumulate_stats(FIRSTPASS_STATS *section,
564  const FIRSTPASS_STATS *frame);
585 void av1_first_pass(struct AV1_COMP *cpi, const int64_t ts_duration);
586 
587 void av1_noop_first_pass_frame(struct AV1_COMP *cpi, const int64_t ts_duration);
588 #ifdef __cplusplus
589 } // extern "C"
590 #endif
591 
592 #endif // AOM_AV1_ENCODER_FIRSTPASS_H_
aom_codec_err_t
Algorithm return codes.
Definition: aom_codec.h:155
aom_codec_err_t av1_firstpass_info_push(FIRSTPASS_INFO *firstpass_info, const FIRSTPASS_STATS *input_stats)
Push a stats into firstpass_info.
aom_codec_err_t av1_firstpass_info_move_cur_index(FIRSTPASS_INFO *firstpass_info)
Move cur_index by 1.
void av1_first_pass(struct AV1_COMP *cpi, const int64_t ts_duration)
AV1 first pass encoding.
aom_codec_err_t av1_firstpass_info_pop(FIRSTPASS_INFO *firstpass_info)
Pop a stats from firstpass_info.
aom_codec_err_t av1_firstpass_info_init(FIRSTPASS_INFO *firstpass_info, FIRSTPASS_STATS *ext_stats_buf, int ext_stats_buf_size)
Init firstpass_info.
int av1_firstpass_info_past_count(const FIRSTPASS_INFO *firstpass_info, int offset_from_cur)
Count the past stats before the target in firstpass_info Note that the target stats will NOT be count...
aom_codec_err_t av1_firstpass_info_move_cur_index_and_pop(FIRSTPASS_INFO *firstpass_info)
Move cur_index by 1 and pop a stats from firstpass_info.
const FIRSTPASS_STATS * av1_firstpass_info_peek(const FIRSTPASS_INFO *firstpass_info, int offset_from_cur)
Peek at a stats from firstpass_info.
int av1_firstpass_info_future_count(const FIRSTPASS_INFO *firstpass_info, int offset_from_cur)
Count the future stats from the target in firstpass_info Note that the target stats will be counted a...
Describes look ahead buffer operations.
Main encoder configuration data structure.
Definition: encoder.h:915
Top level encoder structure.
Definition: encoder.h:2759
contains per-frame encoding parameters decided upon by av1_encode_strategy() and passed down to av1_e...
Definition: encoder.h:3482
Data structure used for managing first pass stats.
Definition: firstpass.h:177
int cur_index
Definition: firstpass.h:216
int past_stats_count
Definition: firstpass.h:226
int future_stats_count
Definition: firstpass.h:221
int stats_buf_size
Definition: firstpass.h:196
FIRSTPASS_STATS total_stats
Definition: firstpass.h:231
int start_index
Definition: firstpass.h:204
int stats_count
Definition: firstpass.h:211
FIRSTPASS_STATS * stats_buf
Definition: firstpass.h:192
The stucture of acummulated frame stats in the first pass.
Definition: firstpass.h:41
double pcnt_neutral
Definition: firstpass.h:88
double MVr
Definition: firstpass.h:108
double MVc
Definition: firstpass.h:116
double pcnt_second_ref
Definition: firstpass.h:82
double mvr_abs
Definition: firstpass.h:112
double pcnt_inter
Definition: firstpass.h:72
double intra_error
Definition: firstpass.h:56
double new_mv_count
Definition: firstpass.h:138
double count
Definition: firstpass.h:147
double coded_error
Definition: firstpass.h:64
double raw_error_stdev
Definition: firstpass.h:151
double pcnt_motion
Definition: firstpass.h:76
double frame
Definition: firstpass.h:46
double cor_coeff
Definition: firstpass.h:163
double mv_in_out_count
Definition: firstpass.h:134
double noise_var
Definition: firstpass.h:159
double MVcv
Definition: firstpass.h:128
int64_t is_flash
Definition: firstpass.h:155
double inactive_zone_cols
Definition: firstpass.h:104
double frame_avg_wavelet_energy
Definition: firstpass.h:60
double duration
Definition: firstpass.h:142
double sr_coded_error
Definition: firstpass.h:68
double mvc_abs
Definition: firstpass.h:120
double intra_skip_pct
Definition: firstpass.h:96
double MVrv
Definition: firstpass.h:124
double inactive_zone_rows
Definition: firstpass.h:100
double weight
Definition: firstpass.h:52
Data related to the current GF/ARF group and the individual frames within the group.
Definition: firstpass.h:344
Frame level Two pass status and control data.
Definition: firstpass.h:464
Two pass status and control data.
Definition: firstpass.h:421