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