| 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;
62 double frame_avg_wavelet_energy;
66 double coded_error;
70 double sr_coded_error;
74 double lt_coded_error;
78 double pcnt_inter;
82 double pcnt_motion;
88 double pcnt_second_ref;
94 double pcnt_neutral;
102 double intra_skip_pct;
106 double inactive_zone_rows;
110 double inactive_zone_cols;
114 double MVr;
118 double mvr_abs;
122 double MVc;
126 double mvc_abs;
130 double MVrv;
134 double MVcv;
140 double mv_in_out_count;
144 double new_mv_count;
148 double duration;
153 double count;
157 double raw_error_stdev;
161 int64_t is_flash;
165 double noise_var;
169 double cor_coeff;
173 double log_intra_error;
177 double log_coded_error;
178} FIRSTPASS_STATS;
179
180// We want to keep one past stats for key frame detection
181// in test_candidate_kf()
182#define FIRSTPASS_INFO_STATS_PAST_MIN 1
183
184// The size of static buffer used in FIRSTPASS_INFO.
185#define FIRSTPASS_INFO_STATIC_BUF_SIZE \
186 (MAX_LAP_BUFFERS + FIRSTPASS_INFO_STATS_PAST_MIN)
187
191 typedef struct {
201 FIRSTPASS_STATS static_stats_buf[FIRSTPASS_INFO_STATIC_BUF_SIZE];
206 FIRSTPASS_STATS *stats_buf;
210 int stats_buf_size;
218 int start_index;
219
225 int stats_count;
226
230 int cur_index;
231
235 int future_stats_count;
236
240 int past_stats_count;
241
245 FIRSTPASS_STATS total_stats;
246} FIRSTPASS_INFO;
247
260 aom_codec_err_t av1_firstpass_info_init(FIRSTPASS_INFO *firstpass_info,
261 FIRSTPASS_STATS *ext_stats_buf,
262 int ext_stats_buf_size);
263
270 aom_codec_err_t av1_firstpass_info_move_cur_index(
271 FIRSTPASS_INFO *firstpass_info);
272
279 aom_codec_err_t av1_firstpass_info_pop(FIRSTPASS_INFO *firstpass_info);
280
287 aom_codec_err_t av1_firstpass_info_move_cur_index_and_pop(
288 FIRSTPASS_INFO *firstpass_info);
289
298 aom_codec_err_t av1_firstpass_info_push(FIRSTPASS_INFO *firstpass_info,
299 const FIRSTPASS_STATS *input_stats);
300
312 const FIRSTPASS_STATS *av1_firstpass_info_peek(
313 const FIRSTPASS_INFO *firstpass_info, int offset_from_cur);
314
327 int av1_firstpass_info_future_count(const FIRSTPASS_INFO *firstpass_info,
328 int offset_from_cur);
329
331#define FC_ANIMATION_THRESH 0.15
332 enum {
333 FC_NORMAL = 0,
334 FC_GRAPHICS_ANIMATION = 1,
335 FRAME_CONTENT_TYPES = 2
336} UENUM1BYTE(FRAME_CONTENT_TYPE);
338
343 typedef struct GF_GROUP {
345 // Frame update type, e.g. ARF/GF/LF/Overlay
346 FRAME_UPDATE_TYPE update_type[MAX_STATIC_GF_GROUP_LENGTH];
347 unsigned char arf_src_offset[MAX_STATIC_GF_GROUP_LENGTH];
348 // The number of frames displayed so far within the GOP at a given coding
349 // frame.
350 unsigned char cur_frame_idx[MAX_STATIC_GF_GROUP_LENGTH];
351 int layer_depth[MAX_STATIC_GF_GROUP_LENGTH];
352 int arf_boost[MAX_STATIC_GF_GROUP_LENGTH];
353 int max_layer_depth;
354 int max_layer_depth_allowed;
355 // This is currently only populated for AOM_Q mode
356 int q_val[MAX_STATIC_GF_GROUP_LENGTH];
357 int rdmult_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
366 // The offset into lookahead_ctx for choosing
367 // source of frame parallel encodes.
368 int src_offset[MAX_STATIC_GF_GROUP_LENGTH];
369 // Stores the display order hint of each frame in the current GF_GROUP.
370 int display_idx[MAX_STATIC_GF_GROUP_LENGTH];
371
372 // The reference frame list maps the reference frame indexes to its
373 // buffer index in the decoded buffer. A value of -1 means the
374 // corresponding reference frame index doesn't point towards any
375 // previously decoded frame.
376 int8_t ref_frame_list[MAX_STATIC_GF_GROUP_LENGTH][REF_FRAMES];
377 // Update frame index
378 int update_ref_idx[MAX_STATIC_GF_GROUP_LENGTH];
379 // The map_idx of primary reference
380 int primary_ref_idx[MAX_STATIC_GF_GROUP_LENGTH];
381
382 // Indicates the level of parallelism in frame parallel encodes.
383 // 0 : frame is independently encoded (not part of parallel encodes).
384 // 1 : frame is the first in encode order in a given parallel encode set.
385 // 2 : frame occurs later in encode order in a given parallel encode set.
386 int frame_parallel_level[MAX_STATIC_GF_GROUP_LENGTH];
387 // Indicates whether a frame should act as non-reference frame.
388 bool is_frame_non_ref[MAX_STATIC_GF_GROUP_LENGTH];
389 // Indicates whether a frame is dropped.
390 bool is_frame_dropped[MAX_STATIC_GF_GROUP_LENGTH];
391
392 // Stores the display order hint of the frames not to be
393 // refreshed by the current frame.
394 int skip_frame_refresh[MAX_STATIC_GF_GROUP_LENGTH][REF_FRAMES];
395 // Stores the display order hint of the frame to be excluded during reference
396 // assignment.
397 int skip_frame_as_ref[MAX_STATIC_GF_GROUP_LENGTH];
398 // Indicates whether a switch frame is due.
399 bool is_sframe_due;
400 // Indicates whether the ref frame map is overridden by the external rate
401 // control.
402 int use_ext_ref_frame_map[MAX_STATIC_GF_GROUP_LENGTH];
404} GF_GROUP;
405
406
407 typedef struct {
408 // Track if the last frame in a GOP has higher quality.
409 int arf_gf_boost_lst;
410} GF_STATE;
411
412 typedef struct {
413 FIRSTPASS_STATS *stats_in_start;
414 FIRSTPASS_STATS *stats_in_end;
415 FIRSTPASS_STATS *stats_in_buf_end;
416 FIRSTPASS_STATS *total_stats;
417 FIRSTPASS_STATS *total_left_stats;
418} STATS_BUFFER_CTX;
419
421
425 typedef struct {
427 unsigned int section_intra_rating;
428 // Circular queue of first pass stats stored for most recent frames.
429 // cpi->output_pkt_list[i].data.twopass_stats.buf points to actual data stored
430 // here.
431 FIRSTPASS_STATS *frame_stats_arr[MAX_LAP_BUFFERS + 1];
432 int frame_stats_next_idx; // Index to next unused element in frame_stats_arr.
433 STATS_BUFFER_CTX *stats_buf_ctx;
434 FIRSTPASS_INFO firstpass_info; // This is the first pass data structure
435 // intended to replace stats_in
436 int first_pass_done;
437 int64_t bits_left;
438 double modified_error_min;
439 double modified_error_max;
440 double modified_error_left;
441
442 // Projected total bits available for a key frame group of frames
443 int64_t kf_group_bits;
444
445 // Error score of frames still to be coded in kf group
446 double kf_group_error_left;
447
448 // Over time correction for bits per macro block estimation
449 double bpm_factor;
450
451 // Record of target and actual bits spent in current ARF group
452 int rolling_arf_group_target_bits;
453 int rolling_arf_group_actual_bits;
454
455 int sr_update_lag;
456
457 int kf_zeromotion_pct;
458 int last_kfgroup_zeromotion_pct;
459 int extend_minq;
460 int extend_maxq;
462} TWO_PASS;
463
467 typedef struct {
469 const FIRSTPASS_STATS *stats_in;
470 // Pointer to the stats of the current frame.
471 const FIRSTPASS_STATS *this_frame;
472 double mb_av_energy;
473 // An indication of the content type of the current frame
474 FRAME_CONTENT_TYPE fr_content_type;
475 double frame_avg_haar_energy;
477} TWO_PASS_FRAME;
478
480
481// This structure contains several key parameters to be accumulated for this
482// frame.
483 typedef struct {
484 // Intra prediction error.
485 int64_t intra_error;
486 // Average wavelet energy computed using Discrete Wavelet Transform (DWT).
487 int64_t frame_avg_wavelet_energy;
488 // Best of intra pred error and inter pred error using last frame as ref.
489 int64_t coded_error;
490 // Best of intra pred error and inter pred error using golden frame as ref.
491 int64_t sr_coded_error;
492 // Best of coded error using long term reference.
493 int64_t lt_coded_error;
494
495 // Count of motion vector.
496 int mv_count;
497 // Count of blocks that pick inter prediction (inter pred error is smaller
498 // than intra pred error).
499 int inter_count;
500 // Count of blocks that pick second ref (golden frame).
501 int second_ref_count;
502 // Count of blocks where the inter and intra are very close and very low.
503 double neutral_count;
504 // Count of blocks where intra error is very small.
505 int intra_skip_count;
506 // Start row.
507 int image_data_start_row;
508 // Count of unique non-zero motion vectors.
509 int new_mv_count;
510 // Sum of inward motion vectors.
511 int sum_in_vectors;
512 // Sum of motion vector row.
513 int sum_mvr;
514 // Sum of motion vector column.
515 int sum_mvc;
516 // Sum of absolute value of motion vector row.
517 int sum_mvr_abs;
518 // Sum of absolute value of motion vector column.
519 int sum_mvc_abs;
520 // Sum of the square of motion vector row.
521 int64_t sum_mvrs;
522 // Sum of the square of motion vector column.
523 int64_t sum_mvcs;
524 // A factor calculated using intra pred error.
525 double intra_factor;
526 // A factor that measures brightness.
527 double brightness_factor;
528} FRAME_STATS;
529
530// This structure contains first pass data.
531 typedef struct {
532 // Buffer holding frame stats for all MACROBLOCKs.
533 // mb_stats[i] stores the FRAME_STATS of the ith
534 // MB in raster scan order.
535 FRAME_STATS *mb_stats;
536 // Buffer to store the prediction error of the (0,0) motion
537 // vector using the last source frame as the reference.
538 // raw_motion_err_list[i] stores the raw_motion_err of
539 // the ith MB in raster scan order.
540 int *raw_motion_err_list;
541} FirstPassData;
542
543 struct AV1_COMP;
544 struct EncodeFrameParams;
545 struct AV1EncoderConfig;
546 struct TileDataEnc;
547
548 static inline int is_fp_wavelet_energy_invalid(
549 const FIRSTPASS_STATS *fp_stats) {
550 assert(fp_stats != NULL);
551 return (fp_stats->frame_avg_wavelet_energy < 0);
552}
553
554 static inline BLOCK_SIZE get_fp_block_size(int is_screen_content_type) {
555 return (is_screen_content_type ? BLOCK_8X8 : BLOCK_16X16);
556}
557
558 int av1_get_unit_rows_in_tile(const TileInfo *tile,
559 const BLOCK_SIZE fp_block_size);
560 int av1_get_unit_cols_in_tile(const TileInfo *tile,
561 const BLOCK_SIZE fp_block_size);
562
563 void av1_first_pass_row(struct AV1_COMP *cpi, struct ThreadData *td,
564 struct TileDataEnc *tile_data, const int mb_row,
565 const BLOCK_SIZE fp_block_size);
566 void av1_end_first_pass(struct AV1_COMP *cpi);
567
568 void av1_free_firstpass_data(FirstPassData *firstpass_data);
569
570 void av1_twopass_zero_stats(FIRSTPASS_STATS *section);
571 void av1_accumulate_stats(FIRSTPASS_STATS *section,
572 const FIRSTPASS_STATS *frame);
574
593 void av1_first_pass(struct AV1_COMP *cpi, const int64_t ts_duration);
594
595 void av1_noop_first_pass_frame(struct AV1_COMP *cpi, const int64_t ts_duration);
596#ifdef __cplusplus
597} // extern "C"
598#endif
599
600#endif // AOM_AV1_ENCODER_FIRSTPASS_H_
enums.h
aom_codec_err_t
aom_codec_err_t
Algorithm return codes.
Definition aom_codec.h:155
av1_firstpass_info_push
aom_codec_err_t av1_firstpass_info_push(FIRSTPASS_INFO *firstpass_info, const FIRSTPASS_STATS *input_stats)
Push a stats into firstpass_info.
av1_firstpass_info_peek
const FIRSTPASS_STATS * av1_firstpass_info_peek(const FIRSTPASS_INFO *firstpass_info, int offset_from_cur)
Peek at a stats from firstpass_info.
av1_firstpass_info_move_cur_index
aom_codec_err_t av1_firstpass_info_move_cur_index(FIRSTPASS_INFO *firstpass_info)
Move cur_index by 1.
av1_first_pass
void av1_first_pass(struct AV1_COMP *cpi, const int64_t ts_duration)
AV1 first pass encoding.
av1_firstpass_info_pop
aom_codec_err_t av1_firstpass_info_pop(FIRSTPASS_INFO *firstpass_info)
Pop a stats from firstpass_info.
av1_firstpass_info_init
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.
av1_firstpass_info_move_cur_index_and_pop
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.
av1_firstpass_info_future_count
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...
lookahead.h
Describes look ahead buffer operations.
AV1EncoderConfig
Main encoder configuration data structure.
Definition encoder.h:934
AV1_COMP
Top level encoder structure.
Definition encoder.h:2897
EncodeFrameParams
contains per-frame encoding parameters decided upon by av1_encode_strategy() and passed down to av1_e...
Definition encoder.h:3747
FIRSTPASS_INFO
Data structure used for managing first pass stats.
Definition firstpass.h:191
FIRSTPASS_INFO::cur_index
int cur_index
Definition firstpass.h:230
FIRSTPASS_INFO::static_stats_buf
FIRSTPASS_STATS static_stats_buf[(MAX_LAP_BUFFERS+1)]
Definition firstpass.h:201
FIRSTPASS_INFO::past_stats_count
int past_stats_count
Definition firstpass.h:240
FIRSTPASS_INFO::future_stats_count
int future_stats_count
Definition firstpass.h:235
FIRSTPASS_INFO::stats_buf_size
int stats_buf_size
Definition firstpass.h:210
FIRSTPASS_INFO::total_stats
FIRSTPASS_STATS total_stats
Definition firstpass.h:245
FIRSTPASS_INFO::start_index
int start_index
Definition firstpass.h:218
FIRSTPASS_INFO::stats_count
int stats_count
Definition firstpass.h:225
FIRSTPASS_INFO::stats_buf
FIRSTPASS_STATS * stats_buf
Definition firstpass.h:206
FIRSTPASS_STATS
The stucture of acummulated frame stats in the first pass.
Definition firstpass.h:43
FIRSTPASS_STATS::pcnt_neutral
double pcnt_neutral
Definition firstpass.h:94
FIRSTPASS_STATS::MVr
double MVr
Definition firstpass.h:114
FIRSTPASS_STATS::MVc
double MVc
Definition firstpass.h:122
FIRSTPASS_STATS::log_intra_error
double log_intra_error
Definition firstpass.h:173
FIRSTPASS_STATS::pcnt_second_ref
double pcnt_second_ref
Definition firstpass.h:88
FIRSTPASS_STATS::mvr_abs
double mvr_abs
Definition firstpass.h:118
FIRSTPASS_STATS::pcnt_inter
double pcnt_inter
Definition firstpass.h:78
FIRSTPASS_STATS::intra_error
double intra_error
Definition firstpass.h:58
FIRSTPASS_STATS::new_mv_count
double new_mv_count
Definition firstpass.h:144
FIRSTPASS_STATS::count
double count
Definition firstpass.h:153
FIRSTPASS_STATS::lt_coded_error
double lt_coded_error
Definition firstpass.h:74
FIRSTPASS_STATS::coded_error
double coded_error
Definition firstpass.h:66
FIRSTPASS_STATS::raw_error_stdev
double raw_error_stdev
Definition firstpass.h:157
FIRSTPASS_STATS::pcnt_motion
double pcnt_motion
Definition firstpass.h:82
FIRSTPASS_STATS::frame
double frame
Definition firstpass.h:48
FIRSTPASS_STATS::cor_coeff
double cor_coeff
Definition firstpass.h:169
FIRSTPASS_STATS::mv_in_out_count
double mv_in_out_count
Definition firstpass.h:140
FIRSTPASS_STATS::noise_var
double noise_var
Definition firstpass.h:165
FIRSTPASS_STATS::MVcv
double MVcv
Definition firstpass.h:134
FIRSTPASS_STATS::log_coded_error
double log_coded_error
Definition firstpass.h:177
FIRSTPASS_STATS::is_flash
int64_t is_flash
Definition firstpass.h:161
FIRSTPASS_STATS::inactive_zone_cols
double inactive_zone_cols
Definition firstpass.h:110
FIRSTPASS_STATS::frame_avg_wavelet_energy
double frame_avg_wavelet_energy
Definition firstpass.h:62
FIRSTPASS_STATS::duration
double duration
Definition firstpass.h:148
FIRSTPASS_STATS::sr_coded_error
double sr_coded_error
Definition firstpass.h:70
FIRSTPASS_STATS::mvc_abs
double mvc_abs
Definition firstpass.h:126
FIRSTPASS_STATS::intra_skip_pct
double intra_skip_pct
Definition firstpass.h:102
FIRSTPASS_STATS::MVrv
double MVrv
Definition firstpass.h:130
FIRSTPASS_STATS::inactive_zone_rows
double inactive_zone_rows
Definition firstpass.h:106
FIRSTPASS_STATS::weight
double weight
Definition firstpass.h:54
GF_GROUP
Data related to the current GF/ARF group and the individual frames within the group.
Definition firstpass.h:343
TWO_PASS_FRAME
Frame level Two pass status and control data.
Definition firstpass.h:467
TWO_PASS
Two pass status and control data.
Definition firstpass.h:425