blob: 1cd1b246843382d0af1e0208beb9d21c61597e8c [file] [log] [blame]
/*
* Copyright (c) 2021, Alliance for Open Media. All rights reserved
*
* This source code is subject to the terms of the BSD 3-Clause Clear License
* and the Alliance for Open Media Patent License 1.0. If the BSD 3-Clause Clear
* License was not distributed with this source code in the LICENSE file, you
* can obtain it at aomedia.org/license/software-license/bsd-3-c-c/. 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
* aomedia.org/license/patent-license/.
*/
#ifndef AOM_AOM_UTIL_DEBUG_UTIL_H_
#define AOM_AOM_UTIL_DEBUG_UTIL_H_
#include "config/aom_config.h"
#include "aom_dsp/prob.h"
#ifdef __cplusplus
extern "C" {
#endif
void aom_bitstream_queue_set_frame_write(int frame_idx);
int aom_bitstream_queue_get_frame_writee(void);
void aom_bitstream_queue_set_frame_read(int frame_idx);
int aom_bitstream_queue_get_frame_read(void);
#if CONFIG_BITSTREAM_DEBUG
/* This is a debug tool used to detect bitstream error. On encoder side, it
* pushes each bit and probability into a queue before the bit is written into
* the Arithmetic coder. On decoder side, whenever a bit is read out from the
* Arithmetic coder, it pops out the reference bit and probability from the
* queue as well. If the two results do not match, this debug tool will report
* an error. This tool can be used to pin down the bitstream error precisely.
* By combining gdb's backtrace method, we can detect which module causes the
* bitstream error. */
int bitstream_queue_get_write(void);
int bitstream_queue_get_read(void);
void bitstream_queue_record_write(void);
void bitstream_queue_reset_write(void);
void bitstream_queue_pop(int *result, aom_cdf_prob *cdf, int *nsymbs);
void bitstream_queue_push(int result, const aom_cdf_prob *cdf, int nsymbs);
void bitstream_queue_set_skip_write(int skip);
void bitstream_queue_set_skip_read(int skip);
#endif // CONFIG_BITSTREAM_DEBUG
#if CONFIG_MISMATCH_DEBUG
void mismatch_move_frame_idx_w();
void mismatch_move_frame_idx_r();
void mismatch_reset_frame(int num_planes);
void mismatch_record_block_pre(const uint16_t *src, int src_stride,
int frame_offset, int plane, int pixel_c,
int pixel_r, int blk_w, int blk_h);
void mismatch_record_block_tx(const uint16_t *src, int src_stride,
int frame_offset, int plane, int pixel_c,
int pixel_r, int blk_w, int blk_h);
void mismatch_check_block_pre(const uint16_t *src, int src_stride,
int frame_offset, int plane, int pixel_c,
int pixel_r, int blk_w, int blk_h);
void mismatch_check_block_tx(const uint16_t *src, int src_stride,
int frame_offset, int plane, int pixel_c,
int pixel_r, int blk_w, int blk_h);
#endif // CONFIG_MISMATCH_DEBUG
#ifdef __cplusplus
} // extern "C"
#endif
#endif // AOM_AOM_UTIL_DEBUG_UTIL_H_