text: /*
   *  Copyright (c) 2010 The WebM project authors. All Rights Reserved.
   *
   *  Use of this source code is governed by a BSD-style license
   *  that can be found in the LICENSE file in the root of the source
   *  tree. An additional intellectual property rights grant can be found
   *  in the file PATENTS.  All contributing project authors may
   *  be found in the AUTHORS file in the root of the source tree.
   */
  
  #ifndef VP9_COMMON_VP9_ONYXC_INT_H_
  #define VP9_COMMON_VP9_ONYXC_INT_H_
  
  #include "vpx_config.h"
  #include "vpx/internal/vpx_codec_internal.h"
  #include "vp9_rtcd.h"
  #include "vp9/common/vp9_loopfilter.h"
  #include "vp9/common/vp9_entropymv.h"
  #include "vp9/common/vp9_entropy.h"
  #include "vp9/common/vp9_entropymode.h"
  #include "vp9/common/vp9_quant_common.h"
  
  #if CONFIG_VP9_POSTPROC
  #include "vp9/common/vp9_postproc.h"
  #endif
  
  #define ALLOWED_REFS_PER_FRAME 3
  
  #define NUM_REF_FRAMES_LOG2 3
  #define NUM_REF_FRAMES (1 << NUM_REF_FRAMES_LOG2)
  
  // 1 scratch frame for the new frame, 3 for scaled references on the encoder
  // TODO(jkoleszar): These 3 extra references could probably come from the
  // normal reference pool.
  #define NUM_YV12_BUFFERS (NUM_REF_FRAMES + 4)
  
  #define NUM_FRAME_CONTEXTS_LOG2 2
  #define NUM_FRAME_CONTEXTS (1 << NUM_FRAME_CONTEXTS_LOG2)
  
  typedef struct frame_contexts {
    vp9_prob y_mode_prob[BLOCK_SIZE_GROUPS][INTRA_MODES - 1];
    vp9_prob uv_mode_prob[INTRA_MODES][INTRA_MODES - 1];
    vp9_prob partition_prob[NUM_FRAME_TYPES][NUM_PARTITION_CONTEXTS]
                           [PARTITION_TYPES - 1];
    vp9_coeff_probs_model coef_probs[TX_SIZES][BLOCK_TYPES];
    vp9_prob switchable_interp_prob[SWITCHABLE_FILTERS + 1]
                                   [SWITCHABLE_FILTERS - 1];
    vp9_prob inter_mode_probs[INTER_MODE_CONTEXTS][INTER_MODES - 1];
    vp9_prob intra_inter_prob[INTRA_INTER_CONTEXTS];
    vp9_prob comp_inter_prob[COMP_INTER_CONTEXTS];
    vp9_prob single_ref_prob[REF_CONTEXTS][2];
    vp9_prob comp_ref_prob[REF_CONTEXTS];
    struct tx_probs tx_probs;
    vp9_prob mbskip_probs[MBSKIP_CONTEXTS];
    nmv_context nmvc;
  } FRAME_CONTEXT;
  
  typedef struct {
    unsigned int y_mode[BLOCK_SIZE_GROUPS][INTRA_MODES];
    unsigned int uv_mode[INTRA_MODES][INTRA_MODES];
    unsigned int partition[NUM_PARTITION_CONTEXTS][PARTITION_TYPES];
    vp9_coeff_count_model coef[TX_SIZES][BLOCK_TYPES];
    unsigned int eob_branch[TX_SIZES][BLOCK_TYPES][REF_TYPES]
                           [COEF_BANDS][PREV_COEF_CONTEXTS];
    unsigned int switchable_interp[SWITCHABLE_FILTERS + 1]
                                  [SWITCHABLE_FILTERS];
    unsigned int inter_mode[INTER_MODE_CONTEXTS][INTER_MODES];
    unsigned int intra_inter[INTRA_INTER_CONTEXTS][2];
    unsigned int comp_inter[COMP_INTER_CONTEXTS][2];
    unsigned int single_ref[REF_CONTEXTS][2][2];
    unsigned int comp_ref[REF_CONTEXTS][2];
    struct tx_counts tx;
    unsigned int mbskip[MBSKIP_CONTEXTS][2];
    nmv_context_counts mv;
  } FRAME_COUNTS;
  
  
  typedef enum {
    SINGLE_PREDICTION_ONLY = 0,
    COMP_PREDICTION_ONLY   = 1,
    HYBRID_PREDICTION      = 2,
    NB_PREDICTION_TYPES    = 3,
  } COMPPREDMODE_TYPE;
  
  typedef struct VP9Common {
    struct vpx_internal_error_info  error;
  
    DECLARE_ALIGNED(16, int16_t, y_dequant[QINDEX_RANGE][8]);
    DECLARE_ALIGNED(16, int16_t, uv_dequant[QINDEX_RANGE][8]);
  #if CONFIG_ALPHA
    DECLARE_ALIGNED(16, int16_t, a_dequant[QINDEX_RANGE][8]);
  #endif
  
    int width;
    int height;
    int display_width;
    int display_height;
    int last_width;
    int last_height;
  
    // TODO(jkoleszar): this implies chroma ss right now, but could vary per
    // plane. Revisit as part of the future change to YV12_BUFFER_CONFIG to
    // support additional planes.
    int subsampling_x;
    int subsampling_y;
  
    YV12_BUFFER_CONFIG *frame_to_show;
  
    YV12_BUFFER_CONFIG yv12_fb[NUM_YV12_BUFFERS];
    int fb_idx_ref_cnt[NUM_YV12_BUFFERS]; /* reference counts */
    int ref_frame_map[NUM_REF_FRAMES]; /* maps fb_idx to reference slot */
  
    // TODO(jkoleszar): could expand active_ref_idx to 4, with 0 as intra, and
    // roll new_fb_idx into it.
  
    // Each frame can reference ALLOWED_REFS_PER_FRAME buffers
    int active_ref_idx[ALLOWED_REFS_PER_FRAME];
    struct scale_factors active_ref_scale[ALLOWED_REFS_PER_FRAME];
    int new_fb_idx;
  
    YV12_BUFFER_CONFIG post_proc_buffer;
  
    FRAME_TYPE last_frame_type;  /* Save last frame's frame type for motion search. */
    FRAME_TYPE frame_type;
  
    int show_frame;
    int last_show_frame;
  
    // Flag signaling that the frame is encoded using only INTRA modes.
    int intra_only;
  
    // Flag signaling that the frame context should be reset to default values.
    // 0 or 1 implies don't reset, 2 reset just the context specified in the
    // frame header, 3 reset all contexts.
    int reset_frame_context;
  
    int frame_flags;
    // MBs, mb_rows/cols is in 16-pixel units; mi_rows/cols is in
    // MODE_INFO (8-pixel) units.
    int MBs;
    int mb_rows, mi_rows;
    int mb_cols, mi_cols;
    int mode_info_stride;
  
    /* profile settings */
    TX_MODE tx_mode;
  
    int base_qindex;
    int last_kf_gf_q;  /* Q used on the last GF or KF */
  
    int y_dc_delta_q;
    int uv_dc_delta_q;
    int uv_ac_delta_q;
  #if CONFIG_ALPHA
    int a_dc_delta_q;
    int a_ac_delta_q;
  #endif
  
    /* We allocate a MODE_INFO struct for each macroblock, together with
       an extra row on top and column on the left to simplify prediction. */
  
    MODE_INFO *mip; /* Base of allocated array */
    MODE_INFO *mi;  /* Corresponds to upper left visible macroblock */
    MODE_INFO *prev_mip; /* MODE_INFO array 'mip' from last decoded frame */
    MODE_INFO *prev_mi;  /* 'mi' from last frame (points into prev_mip) */
  
    MODE_INFO **mi_grid_base;
    MODE_INFO **mi_grid_visible;
    MODE_INFO **prev_mi_grid_base;
    MODE_INFO **prev_mi_grid_visible;
  
    // Persistent mb segment id map used in prediction.
    unsigned char *last_frame_seg_map;
  
    INTERPOLATIONFILTERTYPE mcomp_filter_type;
  
    loop_filter_info_n lf_info;
  
    int refresh_frame_context;    /* Two state 0 = NO, 1 = YES */
  
    int ref_frame_sign_bias[MAX_REF_FRAMES];    /* Two state 0, 1 */
  
    struct loopfilter lf;
    struct segmentation seg;
  
    /* Y,U,V */
    ENTROPY_CONTEXT *above_context[MAX_MB_PLANE];
    ENTROPY_CONTEXT left_context[MAX_MB_PLANE][16];
  
    // partition contexts
    PARTITION_CONTEXT *above_seg_context;
    PARTITION_CONTEXT left_seg_context[8];
  
    // Context probabilities for reference frame prediction
    int allow_comp_inter_inter;
    MV_REFERENCE_FRAME comp_fixed_ref;
    MV_REFERENCE_FRAME comp_var_ref[2];
    COMPPREDMODE_TYPE comp_pred_mode;
  
    FRAME_CONTEXT fc;  /* this frame entropy */
    FRAME_CONTEXT frame_contexts[NUM_FRAME_CONTEXTS];
    unsigned int  frame_context_idx; /* Context to use/update */
    FRAME_COUNTS counts;
  
    unsigned int current_video_frame;
    int version;
  
  #if CONFIG_VP9_POSTPROC
    struct postproc_state  postproc_state;
  #endif
  
    int error_resilient_mode;
    int frame_parallel_decoding_mode;
  
    int log2_tile_cols, log2_tile_rows;
    int cur_tile_mi_col_start, cur_tile_mi_col_end;
    int cur_tile_mi_row_start, cur_tile_mi_row_end;
  } VP9_COMMON;
  
  static int get_free_fb(VP9_COMMON *cm) {
    int i;
    for (i = 0; i < NUM_YV12_BUFFERS; i++)
      if (cm->fb_idx_ref_cnt[i] == 0)
        break;
  
    assert(i < NUM_YV12_BUFFERS);
    cm->fb_idx_ref_cnt[i] = 1;
    return i;
  }
  
  static void ref_cnt_fb(int *buf, int *idx, int new_idx) {
    if (buf[*idx] > 0)
      buf[*idx]--;
  
    *idx = new_idx;
  
    buf[new_idx]++;
  }
  
  static int mi_cols_aligned_to_sb(int n_mis) {
    return ALIGN_POWER_OF_TWO(n_mis, MI_BLOCK_SIZE_LOG2);
  }
  
  static INLINE void set_skip_context(VP9_COMMON *cm, MACROBLOCKD *xd,
                                      int mi_row, int mi_col) {
    const int above_idx = mi_col * 2;
    const int left_idx = (mi_row * 2) & 15;
    int i;
    for (i = 0; i < MAX_MB_PLANE; i++) {
      struct macroblockd_plane *const pd = &xd->plane[i];
      pd->above_context = cm->above_context[i] + (above_idx >> pd->subsampling_x);
      pd->left_context = cm->left_context[i] + (left_idx >> pd->subsampling_y);
    }
  }
  
  static INLINE void set_partition_seg_context(VP9_COMMON *cm, MACROBLOCKD *xd,
                                               int mi_row, int mi_col) {
    xd->above_seg_context = cm->above_seg_context + mi_col;
    xd->left_seg_context = cm->left_seg_context + (mi_row & MI_MASK);
  }
  
  // return the node index in the prob tree for binary coding
  static int check_bsize_coverage(int bs, int mi_rows, int mi_cols,
                                  int mi_row, int mi_col) {
    const int r = (mi_row + bs < mi_rows);
    const int c = (mi_col + bs < mi_cols);
  
    if (r && c)
      return 0;
  
    if (c && !r)
      return 1;  // only allow horizontal/split partition types
  
    if (r && !c)
      return 2;  // only allow vertical/split partition types
  
    return -1;
  }
  
  static void set_mi_row_col(VP9_COMMON *cm, MACROBLOCKD *xd,
                         int mi_row, int bh,
                         int mi_col, int bw) {
    xd->mb_to_top_edge    = -((mi_row * MI_SIZE) * 8);
    xd->mb_to_bottom_edge = ((cm->mi_rows - bh - mi_row) * MI_SIZE) * 8;
    xd->mb_to_left_edge   = -((mi_col * MI_SIZE) * 8);
    xd->mb_to_right_edge  = ((cm->mi_cols - bw - mi_col) * MI_SIZE) * 8;
  
    // Are edges available for intra prediction?
    xd->up_available    = (mi_row != 0);
    xd->left_available  = (mi_col > cm->cur_tile_mi_col_start);
    xd->right_available = (mi_col + bw < cm->cur_tile_mi_col_end);
  }
  
  static int get_token_alloc(int mb_rows, int mb_cols) {
    return mb_rows * mb_cols * (48 * 16 + 4);
  }
  
  static void set_prev_mi(VP9_COMMON *cm) {
    const int use_prev_in_find_mv_refs = cm->width == cm->last_width &&
                                         cm->height == cm->last_height &&
                                         !cm->error_resilient_mode &&
                                         !cm->intra_only &&
                                         cm->last_show_frame;
    // Special case: set prev_mi to NULL when the previous mode info
    // context cannot be used.
    cm->prev_mi = use_prev_in_find_mv_refs ?
                    cm->prev_mip + cm->mode_info_stride + 1 : NULL;
  }
  #endif  // VP9_COMMON_VP9_ONYXC_INT_H_
  