AOMedia AV1 Codec: av1/encoder/firstpass.h Source File

| 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
21extern "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
32struct ThreadData;
33
41 typedef struct FIRSTPASS_STATS {
46 double frame;
52 double weight;
56 double intra_error;
60 double frame_avg_wavelet_energy;
64 double coded_error;
68 double sr_coded_error;
72 double pcnt_inter;
76 double pcnt_motion;
82 double pcnt_second_ref;
88 double pcnt_neutral;
96 double intra_skip_pct;
100 double inactive_zone_rows;
104 double inactive_zone_cols;
108 double MVr;
112 double mvr_abs;
116 double MVc;
120 double mvc_abs;
124 double MVrv;
128 double MVcv;
134 double mv_in_out_count;
138 double new_mv_count;
142 double duration;
147 double count;
151 double raw_error_stdev;
155 int64_t is_flash;
159 double noise_var;
163 double cor_coeff;
164} FIRSTPASS_STATS;
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];
192 FIRSTPASS_STATS *stats_buf;
196 int stats_buf_size;
204 int start_index;
205
211 int stats_count;
212
216 int cur_index;
217
221 int future_stats_count;
222
226 int past_stats_count;
227
231 FIRSTPASS_STATS total_stats;
232} FIRSTPASS_INFO;
233
246 aom_codec_err_t av1_firstpass_info_init(FIRSTPASS_INFO *firstpass_info,
247 FIRSTPASS_STATS *ext_stats_buf,
248 int ext_stats_buf_size);
249
256 aom_codec_err_t av1_firstpass_info_move_cur_index(
257 FIRSTPASS_INFO *firstpass_info);
258
265 aom_codec_err_t av1_firstpass_info_pop(FIRSTPASS_INFO *firstpass_info);
266
273 aom_codec_err_t av1_firstpass_info_move_cur_index_and_pop(
274 FIRSTPASS_INFO *firstpass_info);
275
284 aom_codec_err_t av1_firstpass_info_push(FIRSTPASS_INFO *firstpass_info,
285 const FIRSTPASS_STATS *input_stats);
286
298 const FIRSTPASS_STATS *av1_firstpass_info_peek(
299 const FIRSTPASS_INFO *firstpass_info, int offset_from_cur);
300
313 int av1_firstpass_info_future_count(const FIRSTPASS_INFO *firstpass_info,
314 int offset_from_cur);
315
328 int av1_firstpass_info_past_count(const FIRSTPASS_INFO *firstpass_info,
329 int offset_from_cur);
330
332#define FC_ANIMATION_THRESH 0.15
333enum {
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
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 // 0 : frame is a reference frame.
389 // 1 : frame is a non-reference frame.
390 int is_frame_non_ref[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];
399} GF_GROUP;
402typedef struct {
403 // Track if the last frame in a GOP has higher quality.
404 int arf_gf_boost_lst;
405} GF_STATE;
406
407typedef struct {
408 FIRSTPASS_STATS *stats_in_start;
409 FIRSTPASS_STATS *stats_in_end;
410 FIRSTPASS_STATS *stats_in_buf_end;
411 FIRSTPASS_STATS *total_stats;
412 FIRSTPASS_STATS *total_left_stats;
413} STATS_BUFFER_CTX;
414
420 typedef struct {
422 unsigned int section_intra_rating;
423 // Circular queue of first pass stats stored for most recent frames.
424 // cpi->output_pkt_list[i].data.twopass_stats.buf points to actual data stored
425 // here.
426 FIRSTPASS_STATS *frame_stats_arr[MAX_LAP_BUFFERS + 1];
427 int frame_stats_next_idx; // Index to next unused element in frame_stats_arr.
428 STATS_BUFFER_CTX *stats_buf_ctx;
429 FIRSTPASS_INFO firstpass_info; // This is the first pass data structure
430 // intended to replace stats_in
431 int first_pass_done;
432 int64_t bits_left;
433 double modified_error_min;
434 double modified_error_max;
435 double modified_error_left;
436
437 // Projected total bits available for a key frame group of frames
438 int64_t kf_group_bits;
439
440 // Error score of frames still to be coded in kf group
441 double kf_group_error_left;
442
443 // Over time correction for bits per macro block estimation
444 double bpm_factor;
445
446 // Record of target and actual bits spent in current ARF group
447 int rolling_arf_group_target_bits;
448 int rolling_arf_group_actual_bits;
449
450 int sr_update_lag;
451
452 int kf_zeromotion_pct;
453 int last_kfgroup_zeromotion_pct;
454 int extend_minq;
455 int extend_maxq;
456 int extend_minq_fast;
458} TWO_PASS;
459
463 typedef struct {
465 const FIRSTPASS_STATS *stats_in;
466 // Pointer to the stats of the current frame.
467 const FIRSTPASS_STATS *this_frame;
468 double mb_av_energy;
469 // An indication of the content type of the current frame
470 FRAME_CONTENT_TYPE fr_content_type;
471 double frame_avg_haar_energy;
473} TWO_PASS_FRAME;
474
477// This structure contains several key parameters to be accumulated for this
478// frame.
479typedef struct {
480 // Intra prediction error.
481 int64_t intra_error;
482 // Average wavelet energy computed using Discrete Wavelet Transform (DWT).
483 int64_t frame_avg_wavelet_energy;
484 // Best of intra pred error and inter pred error using last frame as ref.
485 int64_t coded_error;
486 // Best of intra pred error and inter pred error using golden frame as ref.
487 int64_t sr_coded_error;
488 // Count of motion vector.
489 int mv_count;
490 // Count of blocks that pick inter prediction (inter pred error is smaller
491 // than intra pred error).
492 int inter_count;
493 // Count of blocks that pick second ref (golden frame).
494 int second_ref_count;
495 // Count of blocks where the inter and intra are very close and very low.
496 double neutral_count;
497 // Count of blocks where intra error is very small.
498 int intra_skip_count;
499 // Start row.
500 int image_data_start_row;
501 // Count of unique non-zero motion vectors.
502 int new_mv_count;
503 // Sum of inward motion vectors.
504 int sum_in_vectors;
505 // Sum of motion vector row.
506 int sum_mvr;
507 // Sum of motion vector column.
508 int sum_mvc;
509 // Sum of absolute value of motion vector row.
510 int sum_mvr_abs;
511 // Sum of absolute value of motion vector column.
512 int sum_mvc_abs;
513 // Sum of the square of motion vector row.
514 int64_t sum_mvrs;
515 // Sum of the square of motion vector column.
516 int64_t sum_mvcs;
517 // A factor calculated using intra pred error.
518 double intra_factor;
519 // A factor that measures brightness.
520 double brightness_factor;
521} FRAME_STATS;
522
523// This structure contains first pass data.
524typedef struct {
525 // Buffer holding frame stats for all MACROBLOCKs.
526 // mb_stats[i] stores the FRAME_STATS of the ith
527 // MB in raster scan order.
528 FRAME_STATS *mb_stats;
529 // Buffer to store the prediction error of the (0,0) motion
530 // vector using the last source frame as the reference.
531 // raw_motion_err_list[i] stores the raw_motion_err of
532 // the ith MB in raster scan order.
533 int *raw_motion_err_list;
534} FirstPassData;
535
536struct AV1_COMP;
537struct EncodeFrameParams;
538struct AV1EncoderConfig;
539struct TileDataEnc;
540
541static INLINE int is_fp_wavelet_energy_invalid(
542 const FIRSTPASS_STATS *fp_stats) {
543 assert(fp_stats != NULL);
544 return (fp_stats->frame_avg_wavelet_energy < 0);
545}
546
547static INLINE BLOCK_SIZE get_fp_block_size(int is_screen_content_type) {
548 return (is_screen_content_type ? BLOCK_8X8 : BLOCK_16X16);
549}
550
551int av1_get_unit_rows_in_tile(const TileInfo *tile,
552 const BLOCK_SIZE fp_block_size);
553int av1_get_unit_cols_in_tile(const TileInfo *tile,
554 const BLOCK_SIZE fp_block_size);
555
556void av1_first_pass_row(struct AV1_COMP *cpi, struct ThreadData *td,
557 struct TileDataEnc *tile_data, const int mb_row,
558 const BLOCK_SIZE fp_block_size);
559void av1_end_first_pass(struct AV1_COMP *cpi);
560
561void av1_twopass_zero_stats(FIRSTPASS_STATS *section);
562void av1_accumulate_stats(FIRSTPASS_STATS *section,
563 const FIRSTPASS_STATS *frame);
584 void av1_first_pass(struct AV1_COMP *cpi, const int64_t ts_duration);
585
586void av1_noop_first_pass_frame(struct AV1_COMP *cpi, const int64_t ts_duration);
587#ifdef __cplusplus
588} // extern "C"
589#endif
590
591#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_past_count
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...
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.
FIRSTPASS_INFO
Data structure used for managing first pass stats.
Definition: firstpass.h:177
FIRSTPASS_INFO::cur_index
int cur_index
Definition: firstpass.h:216
FIRSTPASS_INFO::past_stats_count
int past_stats_count
Definition: firstpass.h:226
FIRSTPASS_INFO::future_stats_count
int future_stats_count
Definition: firstpass.h:221
FIRSTPASS_INFO::stats_buf_size
int stats_buf_size
Definition: firstpass.h:196
FIRSTPASS_INFO::total_stats
FIRSTPASS_STATS total_stats
Definition: firstpass.h:231
FIRSTPASS_INFO::start_index
int start_index
Definition: firstpass.h:204
FIRSTPASS_INFO::stats_count
int stats_count
Definition: firstpass.h:211
FIRSTPASS_INFO::stats_buf
FIRSTPASS_STATS * stats_buf
Definition: firstpass.h:192
FIRSTPASS_STATS
The stucture of acummulated frame stats in the first pass.
Definition: firstpass.h:41
FIRSTPASS_STATS::pcnt_neutral
double pcnt_neutral
Definition: firstpass.h:88
FIRSTPASS_STATS::MVr
double MVr
Definition: firstpass.h:108
FIRSTPASS_STATS::MVc
double MVc
Definition: firstpass.h:116
FIRSTPASS_STATS::pcnt_second_ref
double pcnt_second_ref
Definition: firstpass.h:82
FIRSTPASS_STATS::mvr_abs
double mvr_abs
Definition: firstpass.h:112
FIRSTPASS_STATS::pcnt_inter
double pcnt_inter
Definition: firstpass.h:72
FIRSTPASS_STATS::intra_error
double intra_error
Definition: firstpass.h:56
FIRSTPASS_STATS::new_mv_count
double new_mv_count
Definition: firstpass.h:138
FIRSTPASS_STATS::count
double count
Definition: firstpass.h:147
FIRSTPASS_STATS::coded_error
double coded_error
Definition: firstpass.h:64
FIRSTPASS_STATS::raw_error_stdev
double raw_error_stdev
Definition: firstpass.h:151
FIRSTPASS_STATS::pcnt_motion
double pcnt_motion
Definition: firstpass.h:76
FIRSTPASS_STATS::frame
double frame
Definition: firstpass.h:46
FIRSTPASS_STATS::cor_coeff
double cor_coeff
Definition: firstpass.h:163
FIRSTPASS_STATS::mv_in_out_count
double mv_in_out_count
Definition: firstpass.h:134
FIRSTPASS_STATS::noise_var
double noise_var
Definition: firstpass.h:159
FIRSTPASS_STATS::MVcv
double MVcv
Definition: firstpass.h:128
FIRSTPASS_STATS::is_flash
int64_t is_flash
Definition: firstpass.h:155
FIRSTPASS_STATS::inactive_zone_cols
double inactive_zone_cols
Definition: firstpass.h:104
FIRSTPASS_STATS::frame_avg_wavelet_energy
double frame_avg_wavelet_energy
Definition: firstpass.h:60
FIRSTPASS_STATS::duration
double duration
Definition: firstpass.h:142
FIRSTPASS_STATS::sr_coded_error
double sr_coded_error
Definition: firstpass.h:68
FIRSTPASS_STATS::mvc_abs
double mvc_abs
Definition: firstpass.h:120
FIRSTPASS_STATS::intra_skip_pct
double intra_skip_pct
Definition: firstpass.h:96
FIRSTPASS_STATS::MVrv
double MVrv
Definition: firstpass.h:124
FIRSTPASS_STATS::inactive_zone_rows
double inactive_zone_rows
Definition: firstpass.h:100
FIRSTPASS_STATS::weight
double weight
Definition: firstpass.h:52
GF_GROUP
Data related to the current GF/ARF group and the individual frames within the group.
Definition: firstpass.h:344
TWO_PASS_FRAME
Frame level Two pass status and control data.
Definition: firstpass.h:463
TWO_PASS
Two pass status and control data.
Definition: firstpass.h:420