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 <stdbool.h>
16 
17 #include "av1/common/av1_common_int.h"
18 #include "av1/common/enums.h"
19 #include "av1/encoder/lookahead.h"
20 #include "av1/encoder/ratectrl.h"
21 
22 #ifdef __cplusplus
23 extern "C" {
24 #endif
25 
26 #define DOUBLE_DIVIDE_CHECK(x) ((x) < 0 ? (x)-0.000001 : (x) + 0.000001)
27 
28 #define MIN_ZERO_MOTION 0.95
29 #define MAX_SR_CODED_ERROR 40
30 #define MAX_RAW_ERR_VAR 2000
31 #define MIN_MV_IN_OUT 0.4
32 
33 #define VLOW_MOTION_THRESHOLD 950
34 struct ThreadData;
35 
43 typedef struct FIRSTPASS_STATS {
48  double frame;
54  double weight;
58  double intra_error;
66  double coded_error;
74  double pcnt_inter;
78  double pcnt_motion;
90  double pcnt_neutral;
110  double MVr;
114  double mvr_abs;
118  double MVc;
122  double mvc_abs;
126  double MVrv;
130  double MVcv;
140  double new_mv_count;
144  double duration;
149  double count;
157  int64_t is_flash;
161  double noise_var;
165  double cor_coeff;
175 
176 // We want to keep one past stats for key frame detection
177 // in test_candidate_kf()
178 #define FIRSTPASS_INFO_STATS_PAST_MIN 1
179 
180 // The size of static buffer used in FIRSTPASS_INFO.
181 #define FIRSTPASS_INFO_STATIC_BUF_SIZE \
182  (MAX_LAP_BUFFERS + FIRSTPASS_INFO_STATS_PAST_MIN)
183 
187 typedef struct {
197  FIRSTPASS_STATS static_stats_buf[FIRSTPASS_INFO_STATIC_BUF_SIZE];
215 
222 
227 
232 
237 
243 
257  FIRSTPASS_STATS *ext_stats_buf,
258  int ext_stats_buf_size);
259 
267  FIRSTPASS_INFO *firstpass_info);
268 
276 
284  FIRSTPASS_INFO *firstpass_info);
285 
295  const FIRSTPASS_STATS *input_stats);
296 
309  const FIRSTPASS_INFO *firstpass_info, int offset_from_cur);
310 
324  int offset_from_cur);
325 
339  int offset_from_cur);
340 
342 #define FC_ANIMATION_THRESH 0.15
343 enum {
344  FC_NORMAL = 0,
345  FC_GRAPHICS_ANIMATION = 1,
346  FRAME_CONTENT_TYPES = 2
347 } UENUM1BYTE(FRAME_CONTENT_TYPE);
354 typedef struct GF_GROUP {
356  // Frame update type, e.g. ARF/GF/LF/Overlay
357  FRAME_UPDATE_TYPE update_type[MAX_STATIC_GF_GROUP_LENGTH];
358  unsigned char arf_src_offset[MAX_STATIC_GF_GROUP_LENGTH];
359  // The number of frames displayed so far within the GOP at a given coding
360  // frame.
361  unsigned char cur_frame_idx[MAX_STATIC_GF_GROUP_LENGTH];
362  int layer_depth[MAX_STATIC_GF_GROUP_LENGTH];
363  int arf_boost[MAX_STATIC_GF_GROUP_LENGTH];
364  int max_layer_depth;
365  int max_layer_depth_allowed;
366  // This is currently only populated for AOM_Q mode
367  int q_val[MAX_STATIC_GF_GROUP_LENGTH];
368  int rdmult_val[MAX_STATIC_GF_GROUP_LENGTH];
369  int bit_allocation[MAX_STATIC_GF_GROUP_LENGTH];
370  // The frame coding type - inter/intra frame
371  FRAME_TYPE frame_type[MAX_STATIC_GF_GROUP_LENGTH];
372  // The reference frame buffer control - update or reset
373  REFBUF_STATE refbuf_state[MAX_STATIC_GF_GROUP_LENGTH];
374  int arf_index; // the index in the gf group of ARF, if no arf, then -1
375  int size; // The total length of a GOP
376 
377  // The offset into lookahead_ctx for choosing
378  // source of frame parallel encodes.
379  int src_offset[MAX_STATIC_GF_GROUP_LENGTH];
380  // Stores the display order hint of each frame in the current GF_GROUP.
381  int display_idx[MAX_STATIC_GF_GROUP_LENGTH];
382 
383  // The reference frame list maps the reference frame indexes to its
384  // buffer index in the decoded buffer. A value of -1 means the
385  // corresponding reference frame index doesn't point towards any
386  // previously decoded frame.
387  int8_t ref_frame_list[MAX_STATIC_GF_GROUP_LENGTH][REF_FRAMES];
388  // Update frame index
389  int update_ref_idx[MAX_STATIC_GF_GROUP_LENGTH];
390  // The map_idx of primary reference
391  int primary_ref_idx[MAX_STATIC_GF_GROUP_LENGTH];
392 
393  // Indicates the level of parallelism in frame parallel encodes.
394  // 0 : frame is independently encoded (not part of parallel encodes).
395  // 1 : frame is the first in encode order in a given parallel encode set.
396  // 2 : frame occurs later in encode order in a given parallel encode set.
397  int frame_parallel_level[MAX_STATIC_GF_GROUP_LENGTH];
398  // Indicates whether a frame should act as non-reference frame.
399  bool is_frame_non_ref[MAX_STATIC_GF_GROUP_LENGTH];
400  // Indicates whether a frame is dropped.
401  bool is_frame_dropped[MAX_STATIC_GF_GROUP_LENGTH];
402 
403  // Stores the display order hint of the frames not to be
404  // refreshed by the current frame.
405  int skip_frame_refresh[MAX_STATIC_GF_GROUP_LENGTH][REF_FRAMES];
406  // Stores the display order hint of the frame to be excluded during reference
407  // assignment.
408  int skip_frame_as_ref[MAX_STATIC_GF_GROUP_LENGTH];
410 } GF_GROUP;
413 typedef struct {
414  // Track if the last frame in a GOP has higher quality.
415  int arf_gf_boost_lst;
416 } GF_STATE;
417 
418 typedef struct {
419  FIRSTPASS_STATS *stats_in_start;
420  FIRSTPASS_STATS *stats_in_end;
421  FIRSTPASS_STATS *stats_in_buf_end;
422  FIRSTPASS_STATS *total_stats;
423  FIRSTPASS_STATS *total_left_stats;
424 } STATS_BUFFER_CTX;
425 
431 typedef struct {
433  unsigned int section_intra_rating;
434  // Circular queue of first pass stats stored for most recent frames.
435  // cpi->output_pkt_list[i].data.twopass_stats.buf points to actual data stored
436  // here.
437  FIRSTPASS_STATS *frame_stats_arr[MAX_LAP_BUFFERS + 1];
438  int frame_stats_next_idx; // Index to next unused element in frame_stats_arr.
439  STATS_BUFFER_CTX *stats_buf_ctx;
440  FIRSTPASS_INFO firstpass_info; // This is the first pass data structure
441  // intended to replace stats_in
442  int first_pass_done;
443  int64_t bits_left;
444  double modified_error_min;
445  double modified_error_max;
446  double modified_error_left;
447 
448  // Projected total bits available for a key frame group of frames
449  int64_t kf_group_bits;
450 
451  // Error score of frames still to be coded in kf group
452  double kf_group_error_left;
453 
454  // Over time correction for bits per macro block estimation
455  double bpm_factor;
456 
457  // Record of target and actual bits spent in current ARF group
458  int rolling_arf_group_target_bits;
459  int rolling_arf_group_actual_bits;
460 
461  int sr_update_lag;
462 
463  int kf_zeromotion_pct;
464  int last_kfgroup_zeromotion_pct;
465  int extend_minq;
466  int extend_maxq;
468 } TWO_PASS;
469 
473 typedef struct {
475  const FIRSTPASS_STATS *stats_in;
476  // Pointer to the stats of the current frame.
477  const FIRSTPASS_STATS *this_frame;
478  double mb_av_energy;
479  // An indication of the content type of the current frame
480  FRAME_CONTENT_TYPE fr_content_type;
481  double frame_avg_haar_energy;
484 
487 // This structure contains several key parameters to be accumulated for this
488 // frame.
489 typedef struct {
490  // Intra prediction error.
491  int64_t intra_error;
492  // Average wavelet energy computed using Discrete Wavelet Transform (DWT).
493  int64_t frame_avg_wavelet_energy;
494  // Best of intra pred error and inter pred error using last frame as ref.
495  int64_t coded_error;
496  // Best of intra pred error and inter pred error using golden frame as ref.
497  int64_t sr_coded_error;
498  // Count of motion vector.
499  int mv_count;
500  // Count of blocks that pick inter prediction (inter pred error is smaller
501  // than intra pred error).
502  int inter_count;
503  // Count of blocks that pick second ref (golden frame).
504  int second_ref_count;
505  // Count of blocks where the inter and intra are very close and very low.
506  double neutral_count;
507  // Count of blocks where intra error is very small.
508  int intra_skip_count;
509  // Start row.
510  int image_data_start_row;
511  // Count of unique non-zero motion vectors.
512  int new_mv_count;
513  // Sum of inward motion vectors.
514  int sum_in_vectors;
515  // Sum of motion vector row.
516  int sum_mvr;
517  // Sum of motion vector column.
518  int sum_mvc;
519  // Sum of absolute value of motion vector row.
520  int sum_mvr_abs;
521  // Sum of absolute value of motion vector column.
522  int sum_mvc_abs;
523  // Sum of the square of motion vector row.
524  int64_t sum_mvrs;
525  // Sum of the square of motion vector column.
526  int64_t sum_mvcs;
527  // A factor calculated using intra pred error.
528  double intra_factor;
529  // A factor that measures brightness.
530  double brightness_factor;
531 } FRAME_STATS;
532 
533 // This structure contains first pass data.
534 typedef struct {
535  // Buffer holding frame stats for all MACROBLOCKs.
536  // mb_stats[i] stores the FRAME_STATS of the ith
537  // MB in raster scan order.
538  FRAME_STATS *mb_stats;
539  // Buffer to store the prediction error of the (0,0) motion
540  // vector using the last source frame as the reference.
541  // raw_motion_err_list[i] stores the raw_motion_err of
542  // the ith MB in raster scan order.
543  int *raw_motion_err_list;
544 } FirstPassData;
545 
546 struct AV1_COMP;
547 struct EncodeFrameParams;
548 struct AV1EncoderConfig;
549 struct TileDataEnc;
550 
551 static INLINE int is_fp_wavelet_energy_invalid(
552  const FIRSTPASS_STATS *fp_stats) {
553  assert(fp_stats != NULL);
554  return (fp_stats->frame_avg_wavelet_energy < 0);
555 }
556 
557 static INLINE BLOCK_SIZE get_fp_block_size(int is_screen_content_type) {
558  return (is_screen_content_type ? BLOCK_8X8 : BLOCK_16X16);
559 }
560 
561 int av1_get_unit_rows_in_tile(const TileInfo *tile,
562  const BLOCK_SIZE fp_block_size);
563 int av1_get_unit_cols_in_tile(const TileInfo *tile,
564  const BLOCK_SIZE fp_block_size);
565 
566 void av1_first_pass_row(struct AV1_COMP *cpi, struct ThreadData *td,
567  struct TileDataEnc *tile_data, const int mb_row,
568  const BLOCK_SIZE fp_block_size);
569 void av1_end_first_pass(struct AV1_COMP *cpi);
570 
571 void av1_free_firstpass_data(FirstPassData *firstpass_data);
572 
573 void av1_twopass_zero_stats(FIRSTPASS_STATS *section);
574 void av1_accumulate_stats(FIRSTPASS_STATS *section,
575  const FIRSTPASS_STATS *frame);
596 void av1_first_pass(struct AV1_COMP *cpi, const int64_t ts_duration);
597 
598 void av1_noop_first_pass_frame(struct AV1_COMP *cpi, const int64_t ts_duration);
599 #ifdef __cplusplus
600 } // extern "C"
601 #endif
602 
603 #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:2872
contains per-frame encoding parameters decided upon by av1_encode_strategy() and passed down to av1_e...
Definition: encoder.h:3673
Data structure used for managing first pass stats.
Definition: firstpass.h:187
int cur_index
Definition: firstpass.h:226
int past_stats_count
Definition: firstpass.h:236
int future_stats_count
Definition: firstpass.h:231
int stats_buf_size
Definition: firstpass.h:206
FIRSTPASS_STATS total_stats
Definition: firstpass.h:241
int start_index
Definition: firstpass.h:214
int stats_count
Definition: firstpass.h:221
FIRSTPASS_STATS * stats_buf
Definition: firstpass.h:202
The stucture of acummulated frame stats in the first pass.
Definition: firstpass.h:43
double pcnt_neutral
Definition: firstpass.h:90
double MVr
Definition: firstpass.h:110
double MVc
Definition: firstpass.h:118
double log_intra_error
Definition: firstpass.h:169
double pcnt_second_ref
Definition: firstpass.h:84
double mvr_abs
Definition: firstpass.h:114
double pcnt_inter
Definition: firstpass.h:74
double intra_error
Definition: firstpass.h:58
double new_mv_count
Definition: firstpass.h:140
double count
Definition: firstpass.h:149
double coded_error
Definition: firstpass.h:66
double raw_error_stdev
Definition: firstpass.h:153
double pcnt_motion
Definition: firstpass.h:78
double frame
Definition: firstpass.h:48
double cor_coeff
Definition: firstpass.h:165
double mv_in_out_count
Definition: firstpass.h:136
double noise_var
Definition: firstpass.h:161
double MVcv
Definition: firstpass.h:130
double log_coded_error
Definition: firstpass.h:173
int64_t is_flash
Definition: firstpass.h:157
double inactive_zone_cols
Definition: firstpass.h:106
double frame_avg_wavelet_energy
Definition: firstpass.h:62
double duration
Definition: firstpass.h:144
double sr_coded_error
Definition: firstpass.h:70
double mvc_abs
Definition: firstpass.h:122
double intra_skip_pct
Definition: firstpass.h:98
double MVrv
Definition: firstpass.h:126
double inactive_zone_rows
Definition: firstpass.h:102
double weight
Definition: firstpass.h:54
Data related to the current GF/ARF group and the individual frames within the group.
Definition: firstpass.h:354
Frame level Two pass status and control data.
Definition: firstpass.h:473
Two pass status and control data.
Definition: firstpass.h:431