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 {
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 bit_allocation[MAX_STATIC_GF_GROUP_LENGTH];
359  // The frame coding type - inter/intra frame
360  FRAME_TYPE frame_type[MAX_STATIC_GF_GROUP_LENGTH];
361  // The reference frame buffer control - update or reset
362  REFBUF_STATE refbuf_state[MAX_STATIC_GF_GROUP_LENGTH];
363  int arf_index; // the index in the gf group of ARF, if no arf, then -1
364  int size; // The total length of a GOP
365  // Indicates the level of parallelism in frame parallel encodes.
366  // 0 : frame is independently encoded (not part of parallel encodes).
367  // 1 : frame is the first in encode order in a given parallel encode set.
368  // 2 : frame occurs later in encode order in a given parallel encode set.
369  int frame_parallel_level[MAX_STATIC_GF_GROUP_LENGTH];
370  // Indicates whether a frame should act as non-reference frame.
371  // 0 : frame is a reference frame.
372  // 1 : frame is a non-reference frame.
373  int is_frame_non_ref[MAX_STATIC_GF_GROUP_LENGTH];
374 
375  // The offset into lookahead_ctx for choosing
376  // source of frame parallel encodes.
377  int src_offset[MAX_STATIC_GF_GROUP_LENGTH];
378 #if CONFIG_FRAME_PARALLEL_ENCODE
379 #if CONFIG_FRAME_PARALLEL_ENCODE_2
380  // Stores the display order hint of each frame in the current GF_GROUP.
381  int display_idx[MAX_STATIC_GF_GROUP_LENGTH];
382  // Stores the display order hint of the frames not to be
383  // refreshed by the current frame.
384  int skip_frame_refresh[MAX_STATIC_GF_GROUP_LENGTH][REF_FRAMES];
385  // Stores the display order hint of the frame to be excluded during reference
386  // assignment.
387  int skip_frame_as_ref[MAX_STATIC_GF_GROUP_LENGTH];
388 #endif // CONFIG_FRAME_PARALLEL_ENCODE_2
389 #endif // CONFIG_FRAME_PARALLEL_ENCODE
391 } GF_GROUP;
394 typedef struct {
395  // Track if the last frame in a GOP has higher quality.
396  int arf_gf_boost_lst;
397 } GF_STATE;
398 
399 typedef struct {
400  FIRSTPASS_STATS *stats_in_start;
401  FIRSTPASS_STATS *stats_in_end;
402  FIRSTPASS_STATS *stats_in_buf_end;
403  FIRSTPASS_STATS *total_stats;
404  FIRSTPASS_STATS *total_left_stats;
405 } STATS_BUFFER_CTX;
406 
412 typedef struct {
414  unsigned int section_intra_rating;
415  // Circular queue of first pass stats stored for most recent frames.
416  // cpi->output_pkt_list[i].data.twopass_stats.buf points to actual data stored
417  // here.
418  FIRSTPASS_STATS *frame_stats_arr[MAX_LAP_BUFFERS + 1];
419  int frame_stats_next_idx; // Index to next unused element in frame_stats_arr.
420  STATS_BUFFER_CTX *stats_buf_ctx;
421  FIRSTPASS_INFO firstpass_info; // This is the first pass data structure
422  // intended to replace stats_in
423  int first_pass_done;
424  int64_t bits_left;
425  double modified_error_min;
426  double modified_error_max;
427  double modified_error_left;
428 
429  // Projected total bits available for a key frame group of frames
430  int64_t kf_group_bits;
431 
432  // Error score of frames still to be coded in kf group
433  double kf_group_error_left;
434 
435  // Over time correction for bits per macro block estimation
436  double bpm_factor;
437 
438  // Record of target and actual bits spent in current ARF group
439  int rolling_arf_group_target_bits;
440  int rolling_arf_group_actual_bits;
441 
442  int sr_update_lag;
443 
444  int kf_zeromotion_pct;
445  int last_kfgroup_zeromotion_pct;
446  int extend_minq;
447  int extend_maxq;
448  int extend_minq_fast;
450 } TWO_PASS;
451 
455 typedef struct {
457  const FIRSTPASS_STATS *stats_in;
458  // Pointer to the stats of the current frame.
459  const FIRSTPASS_STATS *this_frame;
460  double mb_av_energy;
461  // An indication of the content type of the current frame
462  FRAME_CONTENT_TYPE fr_content_type;
463  double frame_avg_haar_energy;
466 
469 // This structure contains several key parameters to be accumulated for this
470 // frame.
471 typedef struct {
472  // Intra prediction error.
473  int64_t intra_error;
474  // Average wavelet energy computed using Discrete Wavelet Transform (DWT).
475  int64_t frame_avg_wavelet_energy;
476  // Best of intra pred error and inter pred error using last frame as ref.
477  int64_t coded_error;
478  // Best of intra pred error and inter pred error using golden frame as ref.
479  int64_t sr_coded_error;
480  // Count of motion vector.
481  int mv_count;
482  // Count of blocks that pick inter prediction (inter pred error is smaller
483  // than intra pred error).
484  int inter_count;
485  // Count of blocks that pick second ref (golden frame).
486  int second_ref_count;
487  // Count of blocks where the inter and intra are very close and very low.
488  double neutral_count;
489  // Count of blocks where intra error is very small.
490  int intra_skip_count;
491  // Start row.
492  int image_data_start_row;
493  // Count of unique non-zero motion vectors.
494  int new_mv_count;
495  // Sum of inward motion vectors.
496  int sum_in_vectors;
497  // Sum of motion vector row.
498  int sum_mvr;
499  // Sum of motion vector column.
500  int sum_mvc;
501  // Sum of absolute value of motion vector row.
502  int sum_mvr_abs;
503  // Sum of absolute value of motion vector column.
504  int sum_mvc_abs;
505  // Sum of the square of motion vector row.
506  int64_t sum_mvrs;
507  // Sum of the square of motion vector column.
508  int64_t sum_mvcs;
509  // A factor calculated using intra pred error.
510  double intra_factor;
511  // A factor that measures brightness.
512  double brightness_factor;
513 } FRAME_STATS;
514 
515 // This structure contains first pass data.
516 typedef struct {
517  // Buffer holding frame stats for all MACROBLOCKs.
518  // mb_stats[i] stores the FRAME_STATS of the ith
519  // MB in raster scan order.
520  FRAME_STATS *mb_stats;
521  // Buffer to store the prediction error of the (0,0) motion
522  // vector using the last source frame as the reference.
523  // raw_motion_err_list[i] stores the raw_motion_err of
524  // the ith MB in raster scan order.
525  int *raw_motion_err_list;
526 } FirstPassData;
527 
528 struct AV1_COMP;
529 struct EncodeFrameParams;
530 struct AV1EncoderConfig;
531 struct TileDataEnc;
532 
533 static INLINE int is_fp_wavelet_energy_invalid(
534  const FIRSTPASS_STATS *fp_stats) {
535  assert(fp_stats != NULL);
536  return (fp_stats->frame_avg_wavelet_energy < 0);
537 }
538 
539 static INLINE BLOCK_SIZE get_fp_block_size(int is_screen_content_type) {
540  return (is_screen_content_type ? BLOCK_8X8 : BLOCK_16X16);
541 }
542 
543 int av1_get_unit_rows_in_tile(const TileInfo *tile,
544  const BLOCK_SIZE fp_block_size);
545 int av1_get_unit_cols_in_tile(const TileInfo *tile,
546  const BLOCK_SIZE fp_block_size);
547 
548 void av1_first_pass_row(struct AV1_COMP *cpi, struct ThreadData *td,
549  struct TileDataEnc *tile_data, const int mb_row,
550  const BLOCK_SIZE fp_block_size);
551 void av1_end_first_pass(struct AV1_COMP *cpi);
552 
553 void av1_twopass_zero_stats(FIRSTPASS_STATS *section);
554 void av1_accumulate_stats(FIRSTPASS_STATS *section,
555  const FIRSTPASS_STATS *frame);
576 void av1_first_pass(struct AV1_COMP *cpi, const int64_t ts_duration);
577 
578 void av1_noop_first_pass_frame(struct AV1_COMP *cpi, const int64_t ts_duration);
579 #ifdef __cplusplus
580 } // extern "C"
581 #endif
582 
583 #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:909
Top level encoder structure.
Definition: encoder.h:2664
contains per-frame encoding parameters decided upon by av1_encode_strategy() and passed down to av1_e...
Definition: encoder.h:3356
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:455
Two pass status and control data.
Definition: firstpass.h:412