vp10/common/onyxc_int.h

   1 /*
   2  *  Copyright (c) 2010 The WebM project authors. All Rights Reserved.
   3  *
   4  *  Use of this source code is governed by a BSD-style license
   5  *  that can be found in the LICENSE file in the root of the source
   6  *  tree. An additional intellectual property rights grant can be found
   7  *  in the file PATENTS.  All contributing project authors may
   8  *  be found in the AUTHORS file in the root of the source tree.
   9  */
  10
  11 #ifndef VP10_COMMON_ONYXC_INT_H_
  12 #define VP10_COMMON_ONYXC_INT_H_
  13
  14 #include "./vpx_config.h"
  15 #include "vpx/internal/vpx_codec_internal.h"
  16 #include "vpx_util/vpx_thread.h"
  17 #include "./vp10_rtcd.h"
  18 #include "vp10/common/alloccommon.h"
  19 #include "vp10/common/loopfilter.h"
  20 #include "vp10/common/entropymv.h"
  21 #include "vp10/common/entropy.h"
  22 #include "vp10/common/entropymode.h"
  23 #include "vp10/common/frame_buffers.h"
  24 #include "vp10/common/quant_common.h"
  25 #include "vp10/common/tile_common.h"
  26
  27 #if CONFIG_VP9_POSTPROC
  28 #include "vp10/common/postproc.h"
  29 #endif
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 #define REFS_PER_FRAME (ALTREF_FRAME - LAST_FRAME + 1)
  36
  37 #define REF_FRAMES_LOG2 3
  38 #define REF_FRAMES (1 << REF_FRAMES_LOG2)
  39
  40 // 4 scratch frames for the new frames to support a maximum of 4 cores decoding
  41 // in parallel, 3 for scaled references on the encoder.
  42 // TODO(hkuang): Add ondemand frame buffers instead of hardcoding the number
  43 // of framebuffers.
  44 // TODO(jkoleszar): These 3 extra references could probably come from the
  45 // normal reference pool.
  46 #define FRAME_BUFFERS (REF_FRAMES + 7)
  47
  48 #define FRAME_CONTEXTS_LOG2 2
  49 #define FRAME_CONTEXTS (1 << FRAME_CONTEXTS_LOG2)
  50
  51 #define NUM_PING_PONG_BUFFERS 2
  52
  53 typedef enum {
  54   SINGLE_REFERENCE      = 0,
  55   COMPOUND_REFERENCE    = 1,
  56   REFERENCE_MODE_SELECT = 2,
  57   REFERENCE_MODES       = 3,
  58 } REFERENCE_MODE;
  59
  60 typedef enum {
  61   RESET_FRAME_CONTEXT_NONE = 0,
  62   RESET_FRAME_CONTEXT_CURRENT = 1,
  63   RESET_FRAME_CONTEXT_ALL = 2,
  64 } RESET_FRAME_CONTEXT_MODE;
  65
  66 typedef struct {
  67   int_mv mv[2];
  68   MV_REFERENCE_FRAME ref_frame[2];
  69 } MV_REF;
  70
  71 typedef struct {
  72   int ref_count;
  73   MV_REF *mvs;
  74   int mi_rows;
  75   int mi_cols;
  76   vpx_codec_frame_buffer_t raw_frame_buffer;
  77   YV12_BUFFER_CONFIG buf;
  78
  79   // The Following variables will only be used in frame parallel decode.
  80
  81   // frame_worker_owner indicates which FrameWorker owns this buffer. NULL means
  82   // that no FrameWorker owns, or is decoding, this buffer.
  83   VPxWorker *frame_worker_owner;
  84
  85   // row and col indicate which position frame has been decoded to in real
  86   // pixel unit. They are reset to -1 when decoding begins and set to INT_MAX
  87   // when the frame is fully decoded.
  88   int row;
  89   int col;
  90 } RefCntBuffer;
  91
  92 typedef struct BufferPool {
  93   // Protect BufferPool from being accessed by several FrameWorkers at
  94   // the same time during frame parallel decode.
  95   // TODO(hkuang): Try to use atomic variable instead of locking the whole pool.
  96 #if CONFIG_MULTITHREAD
  97   pthread_mutex_t pool_mutex;
  98 #endif
  99
 100   // Private data associated with the frame buffer callbacks.
 101   void *cb_priv;
 102
 103   vpx_get_frame_buffer_cb_fn_t get_fb_cb;
 104   vpx_release_frame_buffer_cb_fn_t release_fb_cb;
 105
 106   RefCntBuffer frame_bufs[FRAME_BUFFERS];
 107
 108   // Frame buffers allocated internally by the codec.
 109   InternalFrameBufferList int_frame_buffers;
 110 } BufferPool;
 111
 112 typedef struct VP10Common {
 113   struct vpx_internal_error_info  error;
 114   vpx_color_space_t color_space;
 115   int width;
 116   int height;
 117   int display_width;
 118   int display_height;
 119   int last_width;
 120   int last_height;
 121
 122   // TODO(jkoleszar): this implies chroma ss right now, but could vary per
 123   // plane. Revisit as part of the future change to YV12_BUFFER_CONFIG to
 124   // support additional planes.
 125   int subsampling_x;
 126   int subsampling_y;
 127
 128 #if CONFIG_VP9_HIGHBITDEPTH
 129   int use_highbitdepth;  // Marks if we need to use 16bit frame buffers.
 130 #endif
 131
 132   YV12_BUFFER_CONFIG *frame_to_show;
 133   RefCntBuffer *prev_frame;
 134
 135   // TODO(hkuang): Combine this with cur_buf in macroblockd.
 136   RefCntBuffer *cur_frame;
 137
 138   int ref_frame_map[REF_FRAMES]; /* maps fb_idx to reference slot */
 139
 140   // Prepare ref_frame_map for the next frame.
 141   // Only used in frame parallel decode.
 142   int next_ref_frame_map[REF_FRAMES];
 143
 144   // TODO(jkoleszar): could expand active_ref_idx to 4, with 0 as intra, and
 145   // roll new_fb_idx into it.
 146
 147   // Each frame can reference REFS_PER_FRAME buffers
 148   RefBuffer frame_refs[REFS_PER_FRAME];
 149
 150   int new_fb_idx;
 151
 152 #if CONFIG_VP9_POSTPROC
 153   YV12_BUFFER_CONFIG post_proc_buffer;
 154   YV12_BUFFER_CONFIG post_proc_buffer_int;
 155 #endif
 156
 157   FRAME_TYPE last_frame_type;  /* last frame's frame type for motion search.*/
 158   FRAME_TYPE frame_type;
 159
 160   int show_frame;
 161   int last_show_frame;
 162   int show_existing_frame;
 163
 164   // Flag signaling that the frame is encoded using only INTRA modes.
 165   uint8_t intra_only;
 166   uint8_t last_intra_only;
 167
 168   int allow_high_precision_mv;
 169
 170   // Flag signaling which frame contexts should be reset to default values.
 171   RESET_FRAME_CONTEXT_MODE reset_frame_context;
 172
 173   // MBs, mb_rows/cols is in 16-pixel units; mi_rows/cols is in
 174   // MODE_INFO (8-pixel) units.
 175   int MBs;
 176   int mb_rows, mi_rows;
 177   int mb_cols, mi_cols;
 178   int mi_stride;
 179
 180   /* profile settings */
 181   TX_MODE tx_mode;
 182
 183   int base_qindex;
 184   int y_dc_delta_q;
 185   int uv_dc_delta_q;
 186   int uv_ac_delta_q;
 187   int16_t y_dequant[MAX_SEGMENTS][2];
 188   int16_t uv_dequant[MAX_SEGMENTS][2];
 189
 190   /* We allocate a MODE_INFO struct for each macroblock, together with
 191      an extra row on top and column on the left to simplify prediction. */
 192   int mi_alloc_size;
 193   MODE_INFO *mip; /* Base of allocated array */
 194   MODE_INFO *mi;  /* Corresponds to upper left visible macroblock */
 195
 196   // TODO(agrange): Move prev_mi into encoder structure.
 197   // prev_mip and prev_mi will only be allocated in VP9 encoder.
 198   MODE_INFO *prev_mip; /* MODE_INFO array 'mip' from last decoded frame */
 199   MODE_INFO *prev_mi;  /* 'mi' from last frame (points into prev_mip) */
 200
 201   // Separate mi functions between encoder and decoder.
 202   int (*alloc_mi)(struct VP10Common *cm, int mi_size);
 203   void (*free_mi)(struct VP10Common *cm);
 204   void (*setup_mi)(struct VP10Common *cm);
 205
 206   // Grid of pointers to 8x8 MODE_INFO structs.  Any 8x8 not in the visible
 207   // area will be NULL.
 208   MODE_INFO **mi_grid_base;
 209   MODE_INFO **mi_grid_visible;
 210   MODE_INFO **prev_mi_grid_base;
 211   MODE_INFO **prev_mi_grid_visible;
 212
 213   // Whether to use previous frame's motion vectors for prediction.
 214   int use_prev_frame_mvs;
 215
 216   // Persistent mb segment id map used in prediction.
 217   int seg_map_idx;
 218   int prev_seg_map_idx;
 219
 220   uint8_t *seg_map_array[NUM_PING_PONG_BUFFERS];
 221   uint8_t *last_frame_seg_map;
 222   uint8_t *current_frame_seg_map;
 223   int seg_map_alloc_size;
 224
 225   INTERP_FILTER interp_filter;
 226
 227   loop_filter_info_n lf_info;
 228
 229   int refresh_frame_context;    /* Two state 0 = NO, 1 = YES */
 230
 231   int ref_frame_sign_bias[MAX_REF_FRAMES];    /* Two state 0, 1 */
 232
 233   struct loopfilter lf;
 234   struct segmentation seg;
 235
 236   int frame_parallel_decode;  // frame-based threading.
 237
 238   // Context probabilities for reference frame prediction
 239   MV_REFERENCE_FRAME comp_fixed_ref;
 240   MV_REFERENCE_FRAME comp_var_ref[2];
 241   REFERENCE_MODE reference_mode;
 242
 243   FRAME_CONTEXT *fc;  /* this frame entropy */
 244   FRAME_CONTEXT *frame_contexts;   // FRAME_CONTEXTS
 245   unsigned int  frame_context_idx; /* Context to use/update */
 246   FRAME_COUNTS counts;
 247
 248   unsigned int current_video_frame;
 249   BITSTREAM_PROFILE profile;
 250
 251   // VPX_BITS_8 in profile 0 or 1, VPX_BITS_10 or VPX_BITS_12 in profile 2 or 3.
 252   vpx_bit_depth_t bit_depth;
 253   vpx_bit_depth_t dequant_bit_depth;  // bit_depth of current dequantizer
 254
 255 #if CONFIG_VP9_POSTPROC
 256   struct postproc_state  postproc_state;
 257 #endif
 258
 259   int error_resilient_mode;
 260   int frame_parallel_decoding_mode;
 261
 262   int log2_tile_cols, log2_tile_rows;
 263   int byte_alignment;
 264   int skip_loop_filter;
 265
 266   // Private data associated with the frame buffer callbacks.
 267   void *cb_priv;
 268   vpx_get_frame_buffer_cb_fn_t get_fb_cb;
 269   vpx_release_frame_buffer_cb_fn_t release_fb_cb;
 270
 271   // Handles memory for the codec.
 272   InternalFrameBufferList int_frame_buffers;
 273
 274   // External BufferPool passed from outside.
 275   BufferPool *buffer_pool;
 276
 277   PARTITION_CONTEXT *above_seg_context;
 278   ENTROPY_CONTEXT *above_context;
 279   int above_context_alloc_cols;
 280 } VP10_COMMON;
 281
 282 // TODO(hkuang): Don't need to lock the whole pool after implementing atomic
 283 // frame reference count.
 284 static void lock_buffer_pool(BufferPool *const pool) {
 285 #if CONFIG_MULTITHREAD
 286   pthread_mutex_lock(&pool->pool_mutex);
 287 #else
 288   (void)pool;
 289 #endif
 290 }
 291
 292 static void unlock_buffer_pool(BufferPool *const pool) {
 293 #if CONFIG_MULTITHREAD
 294   pthread_mutex_unlock(&pool->pool_mutex);
 295 #else
 296   (void)pool;
 297 #endif
 298 }
 299
 300 static INLINE YV12_BUFFER_CONFIG *get_ref_frame(VP10_COMMON *cm, int index) {
 301   if (index < 0 || index >= REF_FRAMES)
 302     return NULL;
 303   if (cm->ref_frame_map[index] < 0)
 304     return NULL;
 305   assert(cm->ref_frame_map[index] < FRAME_BUFFERS);
 306   return &cm->buffer_pool->frame_bufs[cm->ref_frame_map[index]].buf;
 307 }
 308
 309 static INLINE YV12_BUFFER_CONFIG *get_frame_new_buffer(VP10_COMMON *cm) {
 310   return &cm->buffer_pool->frame_bufs[cm->new_fb_idx].buf;
 311 }
 312
 313 static INLINE int get_free_fb(VP10_COMMON *cm) {
 314   RefCntBuffer *const frame_bufs = cm->buffer_pool->frame_bufs;
 315   int i;
 316
 317   lock_buffer_pool(cm->buffer_pool);
 318   for (i = 0; i < FRAME_BUFFERS; ++i)
 319     if (frame_bufs[i].ref_count == 0)
 320       break;
 321
 322   if (i != FRAME_BUFFERS) {
 323     frame_bufs[i].ref_count = 1;
 324   } else {
 325     // Reset i to be INVALID_IDX to indicate no free buffer found.
 326     i = INVALID_IDX;
 327   }
 328
 329   unlock_buffer_pool(cm->buffer_pool);
 330   return i;
 331 }
 332
 333 static INLINE void ref_cnt_fb(RefCntBuffer *bufs, int *idx, int new_idx) {
 334   const int ref_index = *idx;
 335
 336   if (ref_index >= 0 && bufs[ref_index].ref_count > 0)
 337     bufs[ref_index].ref_count--;
 338
 339   *idx = new_idx;
 340
 341   bufs[new_idx].ref_count++;
 342 }
 343
 344 static INLINE int mi_cols_aligned_to_sb(int n_mis) {
 345   return ALIGN_POWER_OF_TWO(n_mis, MI_BLOCK_SIZE_LOG2);
 346 }
 347
 348 static INLINE int frame_is_intra_only(const VP10_COMMON *const cm) {
 349   return cm->frame_type == KEY_FRAME || cm->intra_only;
 350 }
 351
 352 static INLINE void set_partition_probs(const VP10_COMMON *const cm,
 353                                        MACROBLOCKD *const xd) {
 354   xd->partition_probs =
 355       frame_is_intra_only(cm) ?
 356           &vp10_kf_partition_probs[0] :
 357           (const vpx_prob (*)[PARTITION_TYPES - 1])cm->fc->partition_prob;
 358 }
 359
 360 static INLINE void vp10_init_macroblockd(VP10_COMMON *cm, MACROBLOCKD *xd,
 361                                         tran_low_t *dqcoeff) {
 362   int i;
 363
 364   for (i = 0; i < MAX_MB_PLANE; ++i) {
 365     xd->plane[i].dqcoeff = dqcoeff;
 366     xd->above_context[i] = cm->above_context +
 367         i * sizeof(*cm->above_context) * 2 * mi_cols_aligned_to_sb(cm->mi_cols);
 368
 369     if (xd->plane[i].plane_type == PLANE_TYPE_Y) {
 370       memcpy(xd->plane[i].seg_dequant, cm->y_dequant, sizeof(cm->y_dequant));
 371     } else {
 372       memcpy(xd->plane[i].seg_dequant, cm->uv_dequant, sizeof(cm->uv_dequant));
 373     }
 374     xd->fc = cm->fc;
 375     xd->frame_parallel_decoding_mode = cm->frame_parallel_decoding_mode;
 376   }
 377
 378   xd->above_seg_context = cm->above_seg_context;
 379   xd->mi_stride = cm->mi_stride;
 380   xd->error_info = &cm->error;
 381
 382   set_partition_probs(cm, xd);
 383 }
 384
 385 static INLINE const vpx_prob* get_partition_probs(const MACROBLOCKD *xd,
 386                                                   int ctx) {
 387   return xd->partition_probs[ctx];
 388 }
 389
 390 static INLINE void set_skip_context(MACROBLOCKD *xd, int mi_row, int mi_col) {
 391   const int above_idx = mi_col * 2;
 392   const int left_idx = (mi_row * 2) & 15;
 393   int i;
 394   for (i = 0; i < MAX_MB_PLANE; ++i) {
 395     struct macroblockd_plane *const pd = &xd->plane[i];
 396     pd->above_context = &xd->above_context[i][above_idx >> pd->subsampling_x];
 397     pd->left_context = &xd->left_context[i][left_idx >> pd->subsampling_y];
 398   }
 399 }
 400
 401 static INLINE int calc_mi_size(int len) {
 402   // len is in mi units.
 403   return len + MI_BLOCK_SIZE;
 404 }
 405
 406 static INLINE void set_mi_row_col(MACROBLOCKD *xd, const TileInfo *const tile,
 407                                   int mi_row, int bh,
 408                                   int mi_col, int bw,
 409                                   int mi_rows, int mi_cols) {
 410   xd->mb_to_top_edge    = -((mi_row * MI_SIZE) * 8);
 411   xd->mb_to_bottom_edge = ((mi_rows - bh - mi_row) * MI_SIZE) * 8;
 412   xd->mb_to_left_edge   = -((mi_col * MI_SIZE) * 8);
 413   xd->mb_to_right_edge  = ((mi_cols - bw - mi_col) * MI_SIZE) * 8;
 414
 415   // Are edges available for intra prediction?
 416   xd->up_available    = (mi_row != 0);
 417   xd->left_available  = (mi_col > tile->mi_col_start);
 418   if (xd->up_available) {
 419     xd->above_mi = xd->mi[-xd->mi_stride];
 420     // above_mi may be NULL in VP9 encoder's first pass.
 421     xd->above_mbmi = xd->above_mi ? &xd->above_mi->mbmi : NULL;
 422   } else {
 423     xd->above_mi = NULL;
 424     xd->above_mbmi = NULL;
 425   }
 426
 427   if (xd->left_available) {
 428     xd->left_mi = xd->mi[-1];
 429     // left_mi may be NULL in VP9 encoder's first pass.
 430     xd->left_mbmi = xd->left_mi ? &xd->left_mi->mbmi : NULL;
 431   } else {
 432     xd->left_mi = NULL;
 433     xd->left_mbmi = NULL;
 434   }
 435 }
 436
 437 static INLINE void update_partition_context(MACROBLOCKD *xd,
 438                                             int mi_row, int mi_col,
 439                                             BLOCK_SIZE subsize,
 440                                             BLOCK_SIZE bsize) {
 441   PARTITION_CONTEXT *const above_ctx = xd->above_seg_context + mi_col;
 442   PARTITION_CONTEXT *const left_ctx = xd->left_seg_context + (mi_row & MI_MASK);
 443
 444   // num_4x4_blocks_wide_lookup[bsize] / 2
 445   const int bs = num_8x8_blocks_wide_lookup[bsize];
 446
 447   // update the partition context at the end notes. set partition bits
 448   // of block sizes larger than the current one to be one, and partition
 449   // bits of smaller block sizes to be zero.
 450   memset(above_ctx, partition_context_lookup[subsize].above, bs);
 451   memset(left_ctx, partition_context_lookup[subsize].left, bs);
 452 }
 453
 454 static INLINE int partition_plane_context(const MACROBLOCKD *xd,
 455                                           int mi_row, int mi_col,
 456                                           BLOCK_SIZE bsize) {
 457   const PARTITION_CONTEXT *above_ctx = xd->above_seg_context + mi_col;
 458   const PARTITION_CONTEXT *left_ctx = xd->left_seg_context + (mi_row & MI_MASK);
 459   const int bsl = mi_width_log2_lookup[bsize];
 460   int above = (*above_ctx >> bsl) & 1 , left = (*left_ctx >> bsl) & 1;
 461
 462   assert(b_width_log2_lookup[bsize] == b_height_log2_lookup[bsize]);
 463   assert(bsl >= 0);
 464
 465   return (left * 2 + above) + bsl * PARTITION_PLOFFSET;
 466 }
 467
 468 #ifdef __cplusplus
 469 }  // extern "C"
 470 #endif
 471
 472 #endif  // VP10_COMMON_ONYXC_INT_H_