av1/common/guided_quadtree.h

/*
 * 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_AV1_COMMON_GUIDED_QUADTREE_H_
#define AOM_AV1_COMMON_GUIDED_QUADTREE_H_

#include <float.h>
#include "config/aom_config.h"
#include "aom/aom_integer.h"
#include "aom_ports/mem.h"
#include "av1/common/av1_common_int.h"

#ifdef __cplusplus
extern "C" {
#endif

#if CONFIG_CNN_GUIDED_QUADTREE

#define GUIDED_A_BITS 4
#define GUIDED_A_NUM_VALUES (1 << GUIDED_A_BITS)
#define GUIDED_A_MID (GUIDED_A_NUM_VALUES >> 1)
#define GUIDED_A_RANGE (GUIDED_A_NUM_VALUES - 1)
#define GUIDED_A_PAIR_BITS (GUIDED_A_BITS * 2 - 1)
#define GUIDED_QT_UNIT_SIZES_LOG2 2
#define GUIDED_QT_UNIT_SIZES (1 << GUIDED_QT_UNIT_SIZES_LOG2)

typedef enum {
  GUIDED_QT_NONE,
  GUIDED_QT_SPLIT,
  GUIDED_QT_HORZ,
  GUIDED_QT_VERT,
  GUIDED_QT_TYPES,
  GUIDED_QT_INVALID = -1
} GuidedQuadTreePartitionType;

int *get_quadparm_from_qindex(int qindex, int superres_denom, int is_intra_only,
                              int is_luma, int cnn_index);

void quad_copy(const QUADInfo *src, QUADInfo *dst, struct AV1Common *cm);

// Get the maximum possible length of unit info array based on dimensions,
// assuming each block uses split.
int quad_tree_get_max_unit_info_length(int width, int height, int unit_length);

// Get the length of split info array based on dimensions.
int quad_tree_get_split_info_length(int width, int height, int unit_length);

static INLINE int get_guided_norestore_ctx(int qindex, int superres_denom,
                                           int is_intra_only) {
  (void)qindex;
  (void)is_intra_only;
  if (is_intra_only) return 1;
  if (superres_denom != SCALE_NUMERATOR) return 1;
  return 0;
}

// Get quad tree unit size.
static INLINE int quad_tree_get_unit_size(int width, int height,
                                          int unit_index) {
  const int max_dim = AOMMAX(width, height);
  const int max_dim_pow_2_bits = 1 + get_msb(max_dim);
  const int max_dim_pow_2 = 1 << max_dim_pow_2_bits;
  const int max_unit_size = AOMMAX(AOMMIN(max_dim_pow_2, 2048), 256);
  assert(unit_index >= 0 && unit_index < GUIDED_QT_UNIT_SIZES);
  return max_unit_size >> unit_index;
}

// Allocates buffers in 'quad_info' assuming 'quad_info->unit_index',
// 'quad_info->split_info_length' and 'quad_info->unit_info_length' are already
// initialized.
void av1_alloc_quadtree_struct(struct AV1Common *cm, QUADInfo *quad_info);
// Free buffers in 'quad_info'.
void av1_free_quadtree_struct(QUADInfo *quad_info);
#endif  // CONFIG_CNN_GUIDED_QUADTREE

#ifdef __cplusplus
}  // extern "C"
#endif
#endif  // AOM_AV1_COMMON_CCSO_H_