onyxc_int.h 15.2 KB
Newer Older
Jingning Han's avatar
Jingning Han committed
1 2 3 4 5 6 7 8 9 10
/*
 *  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.
 */

11 12
#ifndef VP10_COMMON_ONYXC_INT_H_
#define VP10_COMMON_ONYXC_INT_H_
Jingning Han's avatar
Jingning Han committed
13 14 15 16 17

#include "./vpx_config.h"
#include "vpx/internal/vpx_codec_internal.h"
#include "vpx_util/vpx_thread.h"
#include "./vp10_rtcd.h"
18 19 20 21 22 23 24
#include "vp10/common/alloccommon.h"
#include "vp10/common/loopfilter.h"
#include "vp10/common/entropymv.h"
#include "vp10/common/entropy.h"
#include "vp10/common/entropymode.h"
#include "vp10/common/frame_buffers.h"
#include "vp10/common/tile_common.h"
Jingning Han's avatar
Jingning Han committed
25 26 27 28 29

#ifdef __cplusplus
extern "C" {
#endif

30
#define REFS_PER_FRAME (ALTREF_FRAME - LAST_FRAME + 1)
Jingning Han's avatar
Jingning Han committed
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48

#define REF_FRAMES_LOG2 3
#define REF_FRAMES (1 << REF_FRAMES_LOG2)

// 4 scratch frames for the new frames to support a maximum of 4 cores decoding
// in parallel, 3 for scaled references on the encoder.
// TODO(hkuang): Add ondemand frame buffers instead of hardcoding the number
// of framebuffers.
// TODO(jkoleszar): These 3 extra references could probably come from the
// normal reference pool.
#define FRAME_BUFFERS (REF_FRAMES + 7)

#define FRAME_CONTEXTS_LOG2 2
#define FRAME_CONTEXTS (1 << FRAME_CONTEXTS_LOG2)

#define NUM_PING_PONG_BUFFERS 2

typedef enum {
clang-format's avatar
clang-format committed
49 50
  SINGLE_REFERENCE = 0,
  COMPOUND_REFERENCE = 1,
Jingning Han's avatar
Jingning Han committed
51
  REFERENCE_MODE_SELECT = 2,
clang-format's avatar
clang-format committed
52
  REFERENCE_MODES = 3,
Jingning Han's avatar
Jingning Han committed
53 54
} REFERENCE_MODE;

55 56 57 58 59 60
typedef enum {
  RESET_FRAME_CONTEXT_NONE = 0,
  RESET_FRAME_CONTEXT_CURRENT = 1,
  RESET_FRAME_CONTEXT_ALL = 2,
} RESET_FRAME_CONTEXT_MODE;

61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
typedef enum {
  /**
   * Don't update frame context
   */
  REFRESH_FRAME_CONTEXT_OFF,
  /**
   * Update frame context to values resulting from forward probability
   * updates signaled in the frame header
   */
  REFRESH_FRAME_CONTEXT_FORWARD,
  /**
   * Update frame context to values resulting from backward probability
   * updates based on entropy/counts in the decoded frame
   */
  REFRESH_FRAME_CONTEXT_BACKWARD,
} REFRESH_FRAME_CONTEXT_MODE;

Jingning Han's avatar
Jingning Han committed
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
typedef struct {
  int_mv mv[2];
  MV_REFERENCE_FRAME ref_frame[2];
} MV_REF;

typedef struct {
  int ref_count;
  MV_REF *mvs;
  int mi_rows;
  int mi_cols;
  vpx_codec_frame_buffer_t raw_frame_buffer;
  YV12_BUFFER_CONFIG buf;

  // The Following variables will only be used in frame parallel decode.

  // frame_worker_owner indicates which FrameWorker owns this buffer. NULL means
  // that no FrameWorker owns, or is decoding, this buffer.
  VPxWorker *frame_worker_owner;

  // row and col indicate which position frame has been decoded to in real
  // pixel unit. They are reset to -1 when decoding begins and set to INT_MAX
  // when the frame is fully decoded.
  int row;
  int col;
} RefCntBuffer;

typedef struct BufferPool {
clang-format's avatar
clang-format committed
105 106 107
// Protect BufferPool from being accessed by several FrameWorkers at
// the same time during frame parallel decode.
// TODO(hkuang): Try to use atomic variable instead of locking the whole pool.
Jingning Han's avatar
Jingning Han committed
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
#if CONFIG_MULTITHREAD
  pthread_mutex_t pool_mutex;
#endif

  // Private data associated with the frame buffer callbacks.
  void *cb_priv;

  vpx_get_frame_buffer_cb_fn_t get_fb_cb;
  vpx_release_frame_buffer_cb_fn_t release_fb_cb;

  RefCntBuffer frame_bufs[FRAME_BUFFERS];

  // Frame buffers allocated internally by the codec.
  InternalFrameBufferList int_frame_buffers;
} BufferPool;

Yaowu Xu's avatar
Yaowu Xu committed
124
typedef struct VP10Common {
clang-format's avatar
clang-format committed
125
  struct vpx_internal_error_info error;
Jingning Han's avatar
Jingning Han committed
126
  vpx_color_space_t color_space;
127
  int color_range;
Jingning Han's avatar
Jingning Han committed
128 129
  int width;
  int height;
130 131
  int render_width;
  int render_height;
Jingning Han's avatar
Jingning Han committed
132 133 134 135 136 137 138 139 140
  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;

141
#if CONFIG_VPX_HIGHBITDEPTH
Jingning Han's avatar
Jingning Han committed
142 143 144
  int use_highbitdepth;  // Marks if we need to use 16bit frame buffers.
#endif

Steinar Midtskogen's avatar
Steinar Midtskogen committed
145 146 147 148
#if CONFIG_CLPF
  int clpf;
#endif

Jingning Han's avatar
Jingning Han committed
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
  YV12_BUFFER_CONFIG *frame_to_show;
  RefCntBuffer *prev_frame;

  // TODO(hkuang): Combine this with cur_buf in macroblockd.
  RefCntBuffer *cur_frame;

  int ref_frame_map[REF_FRAMES]; /* maps fb_idx to reference slot */

  // Prepare ref_frame_map for the next frame.
  // Only used in frame parallel decode.
  int next_ref_frame_map[REF_FRAMES];

  // TODO(jkoleszar): could expand active_ref_idx to 4, with 0 as intra, and
  // roll new_fb_idx into it.

  // Each frame can reference REFS_PER_FRAME buffers
  RefBuffer frame_refs[REFS_PER_FRAME];

  int new_fb_idx;

clang-format's avatar
clang-format committed
169
  FRAME_TYPE last_frame_type; /* last frame's frame type for motion search.*/
Jingning Han's avatar
Jingning Han committed
170 171 172 173 174 175 176 177 178 179 180 181
  FRAME_TYPE frame_type;

  int show_frame;
  int last_show_frame;
  int show_existing_frame;

  // Flag signaling that the frame is encoded using only INTRA modes.
  uint8_t intra_only;
  uint8_t last_intra_only;

  int allow_high_precision_mv;

182 183
  // Flag signaling which frame contexts should be reset to default values.
  RESET_FRAME_CONTEXT_MODE reset_frame_context;
Jingning Han's avatar
Jingning Han committed
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201

  // 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 mi_stride;

  /* profile settings */
  TX_MODE tx_mode;

  int base_qindex;
  int y_dc_delta_q;
  int uv_dc_delta_q;
  int uv_ac_delta_q;
  int16_t y_dequant[MAX_SEGMENTS][2];
  int16_t uv_dequant[MAX_SEGMENTS][2];

202 203 204 205 206 207 208 209 210 211 212 213 214 215
#if CONFIG_AOM_QM
  // Global quant matrix tables
  qm_val_t *giqmatrix[NUM_QM_LEVELS][2][2][TX_SIZES];
  qm_val_t *gqmatrix[NUM_QM_LEVELS][2][2][TX_SIZES];

  // Local quant matrix tables for each frame
  qm_val_t *y_iqmatrix[MAX_SEGMENTS][2][TX_SIZES];
  qm_val_t *uv_iqmatrix[MAX_SEGMENTS][2][TX_SIZES];
  // Encoder
  qm_val_t *y_qmatrix[MAX_SEGMENTS][2][TX_SIZES];
  qm_val_t *uv_qmatrix[MAX_SEGMENTS][2][TX_SIZES];

#endif

Jingning Han's avatar
Jingning Han committed
216 217 218 219 220 221 222
  /* We allocate a MODE_INFO struct for each macroblock, together with
     an extra row on top and column on the left to simplify prediction. */
  int mi_alloc_size;
  MODE_INFO *mip; /* Base of allocated array */
  MODE_INFO *mi;  /* Corresponds to upper left visible macroblock */

  // TODO(agrange): Move prev_mi into encoder structure.
223
  // prev_mip and prev_mi will only be allocated in encoder.
Jingning Han's avatar
Jingning Han committed
224 225 226 227
  MODE_INFO *prev_mip; /* MODE_INFO array 'mip' from last decoded frame */
  MODE_INFO *prev_mi;  /* 'mi' from last frame (points into prev_mip) */

  // Separate mi functions between encoder and decoder.
Yaowu Xu's avatar
Yaowu Xu committed
228 229 230
  int (*alloc_mi)(struct VP10Common *cm, int mi_size);
  void (*free_mi)(struct VP10Common *cm);
  void (*setup_mi)(struct VP10Common *cm);
Jingning Han's avatar
Jingning Han committed
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254

  // Grid of pointers to 8x8 MODE_INFO structs.  Any 8x8 not in the visible
  // area will be NULL.
  MODE_INFO **mi_grid_base;
  MODE_INFO **mi_grid_visible;
  MODE_INFO **prev_mi_grid_base;
  MODE_INFO **prev_mi_grid_visible;

  // Whether to use previous frame's motion vectors for prediction.
  int use_prev_frame_mvs;

  // Persistent mb segment id map used in prediction.
  int seg_map_idx;
  int prev_seg_map_idx;

  uint8_t *seg_map_array[NUM_PING_PONG_BUFFERS];
  uint8_t *last_frame_seg_map;
  uint8_t *current_frame_seg_map;
  int seg_map_alloc_size;

  INTERP_FILTER interp_filter;

  loop_filter_info_n lf_info;

255 256 257
  // Flag signaling how frame contexts should be updated at the end of
  // a frame decode
  REFRESH_FRAME_CONTEXT_MODE refresh_frame_context;
Jingning Han's avatar
Jingning Han committed
258

clang-format's avatar
clang-format committed
259
  int ref_frame_sign_bias[MAX_REF_FRAMES]; /* Two state 0, 1 */
Jingning Han's avatar
Jingning Han committed
260 261 262

  struct loopfilter lf;
  struct segmentation seg;
263 264 265
#if !CONFIG_MISC_FIXES
  struct segmentation_probs segp;
#endif
Jingning Han's avatar
Jingning Han committed
266 267 268 269 270 271 272 273

  int frame_parallel_decode;  // frame-based threading.

  // Context probabilities for reference frame prediction
  MV_REFERENCE_FRAME comp_fixed_ref;
  MV_REFERENCE_FRAME comp_var_ref[2];
  REFERENCE_MODE reference_mode;

clang-format's avatar
clang-format committed
274 275 276
  FRAME_CONTEXT *fc;              /* this frame entropy */
  FRAME_CONTEXT *frame_contexts;  // FRAME_CONTEXTS
  unsigned int frame_context_idx; /* Context to use/update */
Jingning Han's avatar
Jingning Han committed
277 278 279 280 281 282 283 284 285 286 287 288
  FRAME_COUNTS counts;

  unsigned int current_video_frame;
  BITSTREAM_PROFILE profile;

  // VPX_BITS_8 in profile 0 or 1, VPX_BITS_10 or VPX_BITS_12 in profile 2 or 3.
  vpx_bit_depth_t bit_depth;
  vpx_bit_depth_t dequant_bit_depth;  // bit_depth of current dequantizer

  int error_resilient_mode;

  int log2_tile_cols, log2_tile_rows;
289
  int tile_sz_mag;
Jingning Han's avatar
Jingning Han committed
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
  int byte_alignment;
  int skip_loop_filter;

  // Private data associated with the frame buffer callbacks.
  void *cb_priv;
  vpx_get_frame_buffer_cb_fn_t get_fb_cb;
  vpx_release_frame_buffer_cb_fn_t release_fb_cb;

  // Handles memory for the codec.
  InternalFrameBufferList int_frame_buffers;

  // External BufferPool passed from outside.
  BufferPool *buffer_pool;

  PARTITION_CONTEXT *above_seg_context;
  ENTROPY_CONTEXT *above_context;
  int above_context_alloc_cols;
307 308 309 310 311

  // scratch memory for intraonly/keyframe forward updates from default tables
  // - this is intentionally not placed in FRAME_CONTEXT since it's reset upon
  // each keyframe and not used afterwards
  vpx_prob kf_y_prob[INTRA_MODES][INTRA_MODES][INTRA_MODES - 1];
Yaowu Xu's avatar
Yaowu Xu committed
312
} VP10_COMMON;
Jingning Han's avatar
Jingning Han committed
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331

// TODO(hkuang): Don't need to lock the whole pool after implementing atomic
// frame reference count.
static void lock_buffer_pool(BufferPool *const pool) {
#if CONFIG_MULTITHREAD
  pthread_mutex_lock(&pool->pool_mutex);
#else
  (void)pool;
#endif
}

static void unlock_buffer_pool(BufferPool *const pool) {
#if CONFIG_MULTITHREAD
  pthread_mutex_unlock(&pool->pool_mutex);
#else
  (void)pool;
#endif
}

Yaowu Xu's avatar
Yaowu Xu committed
332
static INLINE YV12_BUFFER_CONFIG *get_ref_frame(VP10_COMMON *cm, int index) {
clang-format's avatar
clang-format committed
333 334
  if (index < 0 || index >= REF_FRAMES) return NULL;
  if (cm->ref_frame_map[index] < 0) return NULL;
Jingning Han's avatar
Jingning Han committed
335 336 337 338
  assert(cm->ref_frame_map[index] < FRAME_BUFFERS);
  return &cm->buffer_pool->frame_bufs[cm->ref_frame_map[index]].buf;
}

Yaowu Xu's avatar
Yaowu Xu committed
339
static INLINE YV12_BUFFER_CONFIG *get_frame_new_buffer(VP10_COMMON *cm) {
Jingning Han's avatar
Jingning Han committed
340 341 342
  return &cm->buffer_pool->frame_bufs[cm->new_fb_idx].buf;
}

Yaowu Xu's avatar
Yaowu Xu committed
343
static INLINE int get_free_fb(VP10_COMMON *cm) {
Jingning Han's avatar
Jingning Han committed
344 345 346 347 348
  RefCntBuffer *const frame_bufs = cm->buffer_pool->frame_bufs;
  int i;

  lock_buffer_pool(cm->buffer_pool);
  for (i = 0; i < FRAME_BUFFERS; ++i)
clang-format's avatar
clang-format committed
349
    if (frame_bufs[i].ref_count == 0) break;
Jingning Han's avatar
Jingning Han committed
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376

  if (i != FRAME_BUFFERS) {
    frame_bufs[i].ref_count = 1;
  } else {
    // Reset i to be INVALID_IDX to indicate no free buffer found.
    i = INVALID_IDX;
  }

  unlock_buffer_pool(cm->buffer_pool);
  return i;
}

static INLINE void ref_cnt_fb(RefCntBuffer *bufs, int *idx, int new_idx) {
  const int ref_index = *idx;

  if (ref_index >= 0 && bufs[ref_index].ref_count > 0)
    bufs[ref_index].ref_count--;

  *idx = new_idx;

  bufs[new_idx].ref_count++;
}

static INLINE int mi_cols_aligned_to_sb(int n_mis) {
  return ALIGN_POWER_OF_TWO(n_mis, MI_BLOCK_SIZE_LOG2);
}

Yaowu Xu's avatar
Yaowu Xu committed
377
static INLINE int frame_is_intra_only(const VP10_COMMON *const cm) {
Jingning Han's avatar
Jingning Han committed
378 379 380
  return cm->frame_type == KEY_FRAME || cm->intra_only;
}

Yaowu Xu's avatar
Yaowu Xu committed
381
static INLINE void vp10_init_macroblockd(VP10_COMMON *cm, MACROBLOCKD *xd,
clang-format's avatar
clang-format committed
382
                                         tran_low_t *dqcoeff) {
Jingning Han's avatar
Jingning Han committed
383 384 385 386
  int i;

  for (i = 0; i < MAX_MB_PLANE; ++i) {
    xd->plane[i].dqcoeff = dqcoeff;
clang-format's avatar
clang-format committed
387 388
    xd->above_context[i] =
        cm->above_context +
Jingning Han's avatar
Jingning Han committed
389 390 391 392
        i * sizeof(*cm->above_context) * 2 * mi_cols_aligned_to_sb(cm->mi_cols);

    if (xd->plane[i].plane_type == PLANE_TYPE_Y) {
      memcpy(xd->plane[i].seg_dequant, cm->y_dequant, sizeof(cm->y_dequant));
393 394 395
#if CONFIG_AOM_QM
      memcpy(xd->plane[i].seg_iqmatrix, cm->y_iqmatrix, sizeof(cm->y_iqmatrix));
#endif
Jingning Han's avatar
Jingning Han committed
396 397
    } else {
      memcpy(xd->plane[i].seg_dequant, cm->uv_dequant, sizeof(cm->uv_dequant));
398 399 400 401
#if CONFIG_AOM_QM
      memcpy(xd->plane[i].seg_iqmatrix, cm->uv_iqmatrix,
             sizeof(cm->uv_iqmatrix));
#endif
Jingning Han's avatar
Jingning Han committed
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
    }
    xd->fc = cm->fc;
  }

  xd->above_seg_context = cm->above_seg_context;
  xd->mi_stride = cm->mi_stride;
  xd->error_info = &cm->error;
}

static INLINE void set_skip_context(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 = &xd->above_context[i][above_idx >> pd->subsampling_x];
    pd->left_context = &xd->left_context[i][left_idx >> pd->subsampling_y];
  }
}

static INLINE int calc_mi_size(int len) {
  // len is in mi units.
  return len + MI_BLOCK_SIZE;
}

static INLINE void set_mi_row_col(MACROBLOCKD *xd, const TileInfo *const tile,
clang-format's avatar
clang-format committed
428
                                  int mi_row, int bh, int mi_col, int bw,
Jingning Han's avatar
Jingning Han committed
429
                                  int mi_rows, int mi_cols) {
clang-format's avatar
clang-format committed
430
  xd->mb_to_top_edge = -((mi_row * MI_SIZE) * 8);
Jingning Han's avatar
Jingning Han committed
431
  xd->mb_to_bottom_edge = ((mi_rows - bh - mi_row) * MI_SIZE) * 8;
clang-format's avatar
clang-format committed
432 433
  xd->mb_to_left_edge = -((mi_col * MI_SIZE) * 8);
  xd->mb_to_right_edge = ((mi_cols - bw - mi_col) * MI_SIZE) * 8;
Jingning Han's avatar
Jingning Han committed
434 435

  // Are edges available for intra prediction?
clang-format's avatar
clang-format committed
436 437
  xd->up_available = (mi_row != 0);
  xd->left_available = (mi_col > tile->mi_col_start);
Jingning Han's avatar
Jingning Han committed
438 439
  if (xd->up_available) {
    xd->above_mi = xd->mi[-xd->mi_stride];
440
    // above_mi may be NULL in encoder's first pass.
Jingning Han's avatar
Jingning Han committed
441 442 443 444 445 446 447 448
    xd->above_mbmi = xd->above_mi ? &xd->above_mi->mbmi : NULL;
  } else {
    xd->above_mi = NULL;
    xd->above_mbmi = NULL;
  }

  if (xd->left_available) {
    xd->left_mi = xd->mi[-1];
449
    // left_mi may be NULL in encoder's first pass.
Jingning Han's avatar
Jingning Han committed
450 451 452 453 454 455 456
    xd->left_mbmi = xd->left_mi ? &xd->left_mi->mbmi : NULL;
  } else {
    xd->left_mi = NULL;
    xd->left_mbmi = NULL;
  }
}

457 458 459 460 461 462 463 464 465 466
static INLINE const vpx_prob *get_y_mode_probs(const VP10_COMMON *cm,
                                               const MODE_INFO *mi,
                                               const MODE_INFO *above_mi,
                                               const MODE_INFO *left_mi,
                                               int block) {
  const PREDICTION_MODE above = vp10_above_block_mode(mi, above_mi, block);
  const PREDICTION_MODE left = vp10_left_block_mode(mi, left_mi, block);
  return cm->kf_y_prob[above][left];
}

clang-format's avatar
clang-format committed
467 468
static INLINE void update_partition_context(MACROBLOCKD *xd, int mi_row,
                                            int mi_col, BLOCK_SIZE subsize,
Jingning Han's avatar
Jingning Han committed
469 470 471 472 473 474 475 476 477 478 479 480 481 482
                                            BLOCK_SIZE bsize) {
  PARTITION_CONTEXT *const above_ctx = xd->above_seg_context + mi_col;
  PARTITION_CONTEXT *const left_ctx = xd->left_seg_context + (mi_row & MI_MASK);

  // num_4x4_blocks_wide_lookup[bsize] / 2
  const int bs = num_8x8_blocks_wide_lookup[bsize];

  // update the partition context at the end notes. set partition bits
  // of block sizes larger than the current one to be one, and partition
  // bits of smaller block sizes to be zero.
  memset(above_ctx, partition_context_lookup[subsize].above, bs);
  memset(left_ctx, partition_context_lookup[subsize].left, bs);
}

clang-format's avatar
clang-format committed
483 484
static INLINE int partition_plane_context(const MACROBLOCKD *xd, int mi_row,
                                          int mi_col, BLOCK_SIZE bsize) {
Jingning Han's avatar
Jingning Han committed
485 486 487
  const PARTITION_CONTEXT *above_ctx = xd->above_seg_context + mi_col;
  const PARTITION_CONTEXT *left_ctx = xd->left_seg_context + (mi_row & MI_MASK);
  const int bsl = mi_width_log2_lookup[bsize];
clang-format's avatar
clang-format committed
488
  int above = (*above_ctx >> bsl) & 1, left = (*left_ctx >> bsl) & 1;
Jingning Han's avatar
Jingning Han committed
489 490 491 492 493 494 495 496 497 498 499

  assert(b_width_log2_lookup[bsize] == b_height_log2_lookup[bsize]);
  assert(bsl >= 0);

  return (left * 2 + above) + bsl * PARTITION_PLOFFSET;
}

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

500
#endif  // VP10_COMMON_ONYXC_INT_H_