Source code
Revision control
Copy as Markdown
Other Tools
/*
* Copyright (c) 2016, Alliance for Open Media. All rights reserved.
*
* This source code is subject to the terms of the BSD 2 Clause License and
* the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
* was not distributed with this source code in the LICENSE file, you can
* obtain it at www.aomedia.org/license/software. If the Alliance for Open
* Media Patent License 1.0 was not distributed with this source code in the
* PATENTS file, you can obtain it at www.aomedia.org/license/patent.
*/
#ifndef AOM_AV1_ENCODER_FIRSTPASS_H_
#define AOM_AV1_ENCODER_FIRSTPASS_H_
#include <stdbool.h>
#include "av1/common/av1_common_int.h"
#include "av1/common/enums.h"
#include "av1/encoder/lookahead.h"
#include "av1/encoder/ratectrl.h"
#ifdef __cplusplus
extern "C" {
#endif
#define DOUBLE_DIVIDE_CHECK(x) ((x) < 0 ? (x)-0.000001 : (x) + 0.000001)
#define MIN_ZERO_MOTION 0.95
#define MAX_SR_CODED_ERROR 40
#define MAX_RAW_ERR_VAR 2000
#define MIN_MV_IN_OUT 0.4
#define VLOW_MOTION_THRESHOLD 950
struct ThreadData;
/*!
* \brief The stucture of acummulated frame stats in the first pass.
*
* Errors (coded_error, intra_error, etc.) and counters (new_mv_count) are
* normalized to each MB. MV related stats (MVc, MVr, etc.) are normalized to
* the frame width and height. See function normalize_firstpass_stats.
*/
typedef struct FIRSTPASS_STATS {
/*!
* Frame number in display order, if stats are for a single frame.
* No real meaning for a collection of frames.
*/
double frame;
/*!
* Weight assigned to this frame (or total weight for the collection of
* frames) currently based on intra factor and brightness factor. This is used
* to distribute bits betweeen easier and harder frames.
*/
double weight;
/*!
* Intra prediction error.
*/
double intra_error;
/*!
* Average wavelet energy computed using Discrete Wavelet Transform (DWT).
*/
double frame_avg_wavelet_energy;
/*!
* Best of intra pred error and inter pred error using last frame as ref.
*/
double coded_error;
/*!
* Best of intra pred error and inter pred error using golden frame as ref.
*/
double sr_coded_error;
/*!
* Percentage of blocks with inter pred error < intra pred error.
*/
double pcnt_inter;
/*!
* Percentage of blocks using (inter prediction and) non-zero motion vectors.
*/
double pcnt_motion;
/*!
* Percentage of blocks where golden frame was better than last or intra:
* inter pred error using golden frame < inter pred error using last frame and
* inter pred error using golden frame < intra pred error
*/
double pcnt_second_ref;
/*!
* Percentage of blocks where intra and inter prediction errors were very
* close. Note that this is a 'weighted count', that is, the so blocks may be
* weighted by how close the two errors were.
*/
double pcnt_neutral;
/*!
* Percentage of blocks that have almost no intra error residual
* (i.e. are in effect completely flat and untextured in the intra
* domain). In natural videos this is uncommon, but it is much more
* common in animations, graphics and screen content, so may be used
* as a signal to detect these types of content.
*/
double intra_skip_pct;
/*!
* Image mask rows top and bottom.
*/
double inactive_zone_rows;
/*!
* Image mask columns at left and right edges.
*/
double inactive_zone_cols;
/*!
* Average of row motion vectors.
*/
double MVr;
/*!
* Mean of absolute value of row motion vectors.
*/
double mvr_abs;
/*!
* Mean of column motion vectors.
*/
double MVc;
/*!
* Mean of absolute value of column motion vectors.
*/
double mvc_abs;
/*!
* Variance of row motion vectors.
*/
double MVrv;
/*!
* Variance of column motion vectors.
*/
double MVcv;
/*!
* Value in range [-1,1] indicating fraction of row and column motion vectors
* that point inwards (negative MV value) or outwards (positive MV value).
* For example, value of 1 indicates, all row/column MVs are inwards.
*/
double mv_in_out_count;
/*!
* Count of unique non-zero motion vectors.
*/
double new_mv_count;
/*!
* Duration of the frame / collection of frames.
*/
double duration;
/*!
* 1.0 if stats are for a single frame, OR
* Number of frames in this collection for which the stats are accumulated.
*/
double count;
/*!
* standard deviation for (0, 0) motion prediction error
*/
double raw_error_stdev;
/*!
* Whether the frame contains a flash
*/
int64_t is_flash;
/*!
* Estimated noise variance
*/
double noise_var;
/*!
* Correlation coefficient with the previous frame
*/
double cor_coeff;
/*!
* log of intra_error
*/
double log_intra_error;
/*!
* log of coded_error
*/
double log_coded_error;
} FIRSTPASS_STATS;
// We want to keep one past stats for key frame detection
// in test_candidate_kf()
#define FIRSTPASS_INFO_STATS_PAST_MIN 1
// The size of static buffer used in FIRSTPASS_INFO.
#define FIRSTPASS_INFO_STATIC_BUF_SIZE \
(MAX_LAP_BUFFERS + FIRSTPASS_INFO_STATS_PAST_MIN)
/*!
* \brief Data structure used for managing first pass stats
*/
typedef struct {
/*!
* A static buffer that will be used when no ext_stats_buf is assigned. The
* ext_stats_buf is assigned through av1_firstpass_info_init() when the user
* already has a pre-existing firstpass stats that is stored in an external
* buffer. The ext_stats_buf is usually used in two pass mode. When using one
* pass mode, we generate "firstpass" stats and encode the video in the same
* pass. In this scenario, the stats will be pushed and popped from
* static_stats_buf.
*/
FIRSTPASS_STATS static_stats_buf[FIRSTPASS_INFO_STATIC_BUF_SIZE];
/*!
* A pointer to first pass stats.
* Note that this buffer will be used as ring buffer.
*/
FIRSTPASS_STATS *stats_buf;
/*!
* size of stats_buf
*/
int stats_buf_size;
/*!
* start index of the available frame stats
* Note that start_index doesn't always point to
* current frame's stats because we need to
* keep past stats as well. To access current
* frame's stats, please use cur_index.
*/
int start_index;
/*!
* count available stats stored in stats_buf
* the following condition should stay true
* stats_count = future_stats_count + past_stats_count
*/
int stats_count;
/*!
* index of the current frame's stats
*/
int cur_index;
/*!
* count available future stats including current stats
*/
int future_stats_count;
/*!
* count available past stats EXCLUDING current stats
*/
int past_stats_count;
/*!
* Accumulation of the stats being pushed into firstpass_info
*/
FIRSTPASS_STATS total_stats;
} FIRSTPASS_INFO;
/*!\brief Init firstpass_info
*
* If using ext_stats_buf, the buffer needs to stay available during encoding
* process.
*
* \ingroup rate_control
* \param[out] firstpass_info struct of firstpass_info.
* \param[in] ext_stats_buf external stats buffer. Pass in NULL if
* choose to use internal static_stats_buf.
* \param[in] ext_stats_buf_size external stats buffer size. Pass in 0 if
* choose to use internal static_stats_buf. \return status
*/
aom_codec_err_t av1_firstpass_info_init(FIRSTPASS_INFO *firstpass_info,
FIRSTPASS_STATS *ext_stats_buf,
int ext_stats_buf_size);
/*!\brief Move cur_index by 1
*
* \ingroup rate_control
* \param[out] firstpass_info struct of firstpass_info.
* \return status
*/
aom_codec_err_t av1_firstpass_info_move_cur_index(
FIRSTPASS_INFO *firstpass_info);
/*!\brief Pop a stats from firstpass_info
*
* \ingroup rate_control
* \param[out] firstpass_info struct of firstpass_info.
* \return status
*/
aom_codec_err_t av1_firstpass_info_pop(FIRSTPASS_INFO *firstpass_info);
/*!\brief Move cur_index by 1 and pop a stats from firstpass_info
*
* \ingroup rate_control
* \param[out] firstpass_info struct of firstpass_info.
* \return status
*/
aom_codec_err_t av1_firstpass_info_move_cur_index_and_pop(
FIRSTPASS_INFO *firstpass_info);
/*!\brief Push a stats into firstpass_info
*
* Note that the input stats will be copied into firstpass_info.
* \ingroup rate_control
* \param[out] firstpass_info struct of firstpass_info.
* \param[in] input_stats input stats
* \return status
*/
aom_codec_err_t av1_firstpass_info_push(FIRSTPASS_INFO *firstpass_info,
const FIRSTPASS_STATS *input_stats);
/*!\brief Peek at a stats from firstpass_info
*
* The target index is as follows.
* (cur_index + offset_from_cur) % firstpass_info->stats_buf_size
*
* \ingroup rate_control
* \param[in] firstpass_info struct of firstpass_info.
* \param[in] offset_from_cur index offset from cur_index.
* \return pointer to the stats. The pointer will be NULL if
* stats_index_offset is invalid.
*/
const FIRSTPASS_STATS *av1_firstpass_info_peek(
const FIRSTPASS_INFO *firstpass_info, int offset_from_cur);
/*!\brief Count the future stats from the target in firstpass_info
* Note that the target stats will be counted as well.
* The target index is as follows.
* (cur_index + offset_from_cur) % firstpass_info->stats_buf_size
*
* \ingroup rate_control
* \param[in] firstpass_info struct of firstpass_info.
* \param[in] offset_from_cur target stats's inffset
* from cur_index.
* \return Number of stats in the future after the target stats
* including itself.
*/
int av1_firstpass_info_future_count(const FIRSTPASS_INFO *firstpass_info,
int offset_from_cur);
/*!\cond */
#define FC_ANIMATION_THRESH 0.15
enum {
FC_NORMAL = 0,
FC_GRAPHICS_ANIMATION = 1,
FRAME_CONTENT_TYPES = 2
} UENUM1BYTE(FRAME_CONTENT_TYPE);
/*!\endcond */
/*!
* \brief Data related to the current GF/ARF group and the
* individual frames within the group
*/
typedef struct GF_GROUP {
/*!\cond */
// Frame update type, e.g. ARF/GF/LF/Overlay
FRAME_UPDATE_TYPE update_type[MAX_STATIC_GF_GROUP_LENGTH];
unsigned char arf_src_offset[MAX_STATIC_GF_GROUP_LENGTH];
// The number of frames displayed so far within the GOP at a given coding
// frame.
unsigned char cur_frame_idx[MAX_STATIC_GF_GROUP_LENGTH];
int layer_depth[MAX_STATIC_GF_GROUP_LENGTH];
int arf_boost[MAX_STATIC_GF_GROUP_LENGTH];
int max_layer_depth;
int max_layer_depth_allowed;
// This is currently only populated for AOM_Q mode
int q_val[MAX_STATIC_GF_GROUP_LENGTH];
int rdmult_val[MAX_STATIC_GF_GROUP_LENGTH];
int bit_allocation[MAX_STATIC_GF_GROUP_LENGTH];
// The frame coding type - inter/intra frame
FRAME_TYPE frame_type[MAX_STATIC_GF_GROUP_LENGTH];
// The reference frame buffer control - update or reset
REFBUF_STATE refbuf_state[MAX_STATIC_GF_GROUP_LENGTH];
int arf_index; // the index in the gf group of ARF, if no arf, then -1
int size; // The total length of a GOP
// The offset into lookahead_ctx for choosing
// source of frame parallel encodes.
int src_offset[MAX_STATIC_GF_GROUP_LENGTH];
// Stores the display order hint of each frame in the current GF_GROUP.
int display_idx[MAX_STATIC_GF_GROUP_LENGTH];
// The reference frame list maps the reference frame indexes to its
// buffer index in the decoded buffer. A value of -1 means the
// corresponding reference frame index doesn't point towards any
// previously decoded frame.
int8_t ref_frame_list[MAX_STATIC_GF_GROUP_LENGTH][REF_FRAMES];
// Update frame index
int update_ref_idx[MAX_STATIC_GF_GROUP_LENGTH];
// The map_idx of primary reference
int primary_ref_idx[MAX_STATIC_GF_GROUP_LENGTH];
// Indicates the level of parallelism in frame parallel encodes.
// 0 : frame is independently encoded (not part of parallel encodes).
// 1 : frame is the first in encode order in a given parallel encode set.
// 2 : frame occurs later in encode order in a given parallel encode set.
int frame_parallel_level[MAX_STATIC_GF_GROUP_LENGTH];
// Indicates whether a frame should act as non-reference frame.
bool is_frame_non_ref[MAX_STATIC_GF_GROUP_LENGTH];
// Indicates whether a frame is dropped.
bool is_frame_dropped[MAX_STATIC_GF_GROUP_LENGTH];
// Stores the display order hint of the frames not to be
// refreshed by the current frame.
int skip_frame_refresh[MAX_STATIC_GF_GROUP_LENGTH][REF_FRAMES];
// Stores the display order hint of the frame to be excluded during reference
// assignment.
int skip_frame_as_ref[MAX_STATIC_GF_GROUP_LENGTH];
/*!\endcond */
} GF_GROUP;
/*!\cond */
typedef struct {
// Track if the last frame in a GOP has higher quality.
int arf_gf_boost_lst;
} GF_STATE;
typedef struct {
FIRSTPASS_STATS *stats_in_start;
FIRSTPASS_STATS *stats_in_end;
FIRSTPASS_STATS *stats_in_buf_end;
FIRSTPASS_STATS *total_stats;
FIRSTPASS_STATS *total_left_stats;
} STATS_BUFFER_CTX;
/*!\endcond */
/*!
* \brief Two pass status and control data.
*/
typedef struct {
/*!\cond */
unsigned int section_intra_rating;
// Circular queue of first pass stats stored for most recent frames.
// cpi->output_pkt_list[i].data.twopass_stats.buf points to actual data stored
// here.
FIRSTPASS_STATS *frame_stats_arr[MAX_LAP_BUFFERS + 1];
int frame_stats_next_idx; // Index to next unused element in frame_stats_arr.
STATS_BUFFER_CTX *stats_buf_ctx;
FIRSTPASS_INFO firstpass_info; // This is the first pass data structure
// intended to replace stats_in
int first_pass_done;
int64_t bits_left;
double modified_error_min;
double modified_error_max;
double modified_error_left;
// Projected total bits available for a key frame group of frames
int64_t kf_group_bits;
// Error score of frames still to be coded in kf group
double kf_group_error_left;
// Over time correction for bits per macro block estimation
double bpm_factor;
// Record of target and actual bits spent in current ARF group
int rolling_arf_group_target_bits;
int rolling_arf_group_actual_bits;
int sr_update_lag;
int kf_zeromotion_pct;
int last_kfgroup_zeromotion_pct;
int extend_minq;
int extend_maxq;
/*!\endcond */
} TWO_PASS;
/*!
* \brief Frame level Two pass status and control data.
*/
typedef struct {
/*!\cond */
const FIRSTPASS_STATS *stats_in;
// Pointer to the stats of the current frame.
const FIRSTPASS_STATS *this_frame;
double mb_av_energy;
// An indication of the content type of the current frame
FRAME_CONTENT_TYPE fr_content_type;
double frame_avg_haar_energy;
/*!\endcond */
} TWO_PASS_FRAME;
/*!\cond */
// This structure contains several key parameters to be accumulated for this
// frame.
typedef struct {
// Intra prediction error.
int64_t intra_error;
// Average wavelet energy computed using Discrete Wavelet Transform (DWT).
int64_t frame_avg_wavelet_energy;
// Best of intra pred error and inter pred error using last frame as ref.
int64_t coded_error;
// Best of intra pred error and inter pred error using golden frame as ref.
int64_t sr_coded_error;
// Count of motion vector.
int mv_count;
// Count of blocks that pick inter prediction (inter pred error is smaller
// than intra pred error).
int inter_count;
// Count of blocks that pick second ref (golden frame).
int second_ref_count;
// Count of blocks where the inter and intra are very close and very low.
double neutral_count;
// Count of blocks where intra error is very small.
int intra_skip_count;
// Start row.
int image_data_start_row;
// Count of unique non-zero motion vectors.
int new_mv_count;
// Sum of inward motion vectors.
int sum_in_vectors;
// Sum of motion vector row.
int sum_mvr;
// Sum of motion vector column.
int sum_mvc;
// Sum of absolute value of motion vector row.
int sum_mvr_abs;
// Sum of absolute value of motion vector column.
int sum_mvc_abs;
// Sum of the square of motion vector row.
int64_t sum_mvrs;
// Sum of the square of motion vector column.
int64_t sum_mvcs;
// A factor calculated using intra pred error.
double intra_factor;
// A factor that measures brightness.
double brightness_factor;
} FRAME_STATS;
// This structure contains first pass data.
typedef struct {
// Buffer holding frame stats for all MACROBLOCKs.
// mb_stats[i] stores the FRAME_STATS of the ith
// MB in raster scan order.
FRAME_STATS *mb_stats;
// Buffer to store the prediction error of the (0,0) motion
// vector using the last source frame as the reference.
// raw_motion_err_list[i] stores the raw_motion_err of
// the ith MB in raster scan order.
int *raw_motion_err_list;
} FirstPassData;
struct AV1_COMP;
struct EncodeFrameParams;
struct AV1EncoderConfig;
struct TileDataEnc;
static inline int is_fp_wavelet_energy_invalid(
const FIRSTPASS_STATS *fp_stats) {
assert(fp_stats != NULL);
return (fp_stats->frame_avg_wavelet_energy < 0);
}
static inline BLOCK_SIZE get_fp_block_size(int is_screen_content_type) {
return (is_screen_content_type ? BLOCK_8X8 : BLOCK_16X16);
}
int av1_get_unit_rows_in_tile(const TileInfo *tile,
const BLOCK_SIZE fp_block_size);
int av1_get_unit_cols_in_tile(const TileInfo *tile,
const BLOCK_SIZE fp_block_size);
void av1_first_pass_row(struct AV1_COMP *cpi, struct ThreadData *td,
struct TileDataEnc *tile_data, const int mb_row,
const BLOCK_SIZE fp_block_size);
void av1_end_first_pass(struct AV1_COMP *cpi);
void av1_free_firstpass_data(FirstPassData *firstpass_data);
void av1_twopass_zero_stats(FIRSTPASS_STATS *section);
void av1_accumulate_stats(FIRSTPASS_STATS *section,
const FIRSTPASS_STATS *frame);
/*!\endcond */
/*!\brief AV1 first pass encoding.
*
* \ingroup rate_control
* This function is the first encoding pass for the two pass encoding mode.
* It encodes the whole video and collect essential information.
* Two pass encoding is an encoding mode in the reference software (libaom)
* of AV1 for high performance encoding. The first pass is a fast encoding
* process to collect essential information to help the second pass make
* encoding decisions and improve coding quality. The collected stats is used
* in rate control, for example, to determine frame cut, the position of
* alternative reference frame (ARF), etc.
*
* \param[in] cpi Top-level encoder structure
* \param[in] ts_duration Duration of the frame / collection of frames
*
* \remark Nothing is returned. Instead, the "TWO_PASS" structure inside "cpi"
* is modified to store information computed in this function.
*/
void av1_first_pass(struct AV1_COMP *cpi, const int64_t ts_duration);
void av1_noop_first_pass_frame(struct AV1_COMP *cpi, const int64_t ts_duration);
#ifdef __cplusplus
} // extern "C"
#endif
#endif // AOM_AV1_ENCODER_FIRSTPASS_H_