2 * Copyright (c) 2010 The WebM project authors. All Rights Reserved.
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.
11 #ifndef VP10_COMMON_ONYXC_INT_H_
12 #define VP10_COMMON_ONYXC_INT_H_
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"
27 #if CONFIG_VP9_POSTPROC
28 #include "vp10/common/postproc.h"
35 #define REFS_PER_FRAME (ALTREF_FRAME - LAST_FRAME + 1)
37 #define REF_FRAMES_LOG2 3
38 #define REF_FRAMES (1 << REF_FRAMES_LOG2)
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
44 // TODO(jkoleszar): These 3 extra references could probably come from the
45 // normal reference pool.
46 #define FRAME_BUFFERS (REF_FRAMES + 7)
48 #define FRAME_CONTEXTS_LOG2 2
49 #define FRAME_CONTEXTS (1 << FRAME_CONTEXTS_LOG2)
51 #define NUM_PING_PONG_BUFFERS 2
55 COMPOUND_REFERENCE = 1,
56 REFERENCE_MODE_SELECT = 2,
61 RESET_FRAME_CONTEXT_NONE = 0,
62 RESET_FRAME_CONTEXT_CURRENT = 1,
63 RESET_FRAME_CONTEXT_ALL = 2,
64 } RESET_FRAME_CONTEXT_MODE;
68 * Don't update frame context
70 REFRESH_FRAME_CONTEXT_OFF,
72 * Update frame context to values resulting from forward probability
73 * updates signaled in the frame header
75 REFRESH_FRAME_CONTEXT_FORWARD,
77 * Update frame context to values resulting from backward probability
78 * updates based on entropy/counts in the decoded frame
80 REFRESH_FRAME_CONTEXT_BACKWARD,
81 } REFRESH_FRAME_CONTEXT_MODE;
85 MV_REFERENCE_FRAME ref_frame[2];
93 vpx_codec_frame_buffer_t raw_frame_buffer;
94 YV12_BUFFER_CONFIG buf;
96 // The Following variables will only be used in frame parallel decode.
98 // frame_worker_owner indicates which FrameWorker owns this buffer. NULL means
99 // that no FrameWorker owns, or is decoding, this buffer.
100 VPxWorker *frame_worker_owner;
102 // row and col indicate which position frame has been decoded to in real
103 // pixel unit. They are reset to -1 when decoding begins and set to INT_MAX
104 // when the frame is fully decoded.
109 typedef struct BufferPool {
110 // Protect BufferPool from being accessed by several FrameWorkers at
111 // the same time during frame parallel decode.
112 // TODO(hkuang): Try to use atomic variable instead of locking the whole pool.
113 #if CONFIG_MULTITHREAD
114 pthread_mutex_t pool_mutex;
117 // Private data associated with the frame buffer callbacks.
120 vpx_get_frame_buffer_cb_fn_t get_fb_cb;
121 vpx_release_frame_buffer_cb_fn_t release_fb_cb;
123 RefCntBuffer frame_bufs[FRAME_BUFFERS];
125 // Frame buffers allocated internally by the codec.
126 InternalFrameBufferList int_frame_buffers;
129 typedef struct VP10Common {
130 struct vpx_internal_error_info error;
131 vpx_color_space_t color_space;
140 // TODO(jkoleszar): this implies chroma ss right now, but could vary per
141 // plane. Revisit as part of the future change to YV12_BUFFER_CONFIG to
142 // support additional planes.
146 #if CONFIG_VP9_HIGHBITDEPTH
147 int use_highbitdepth; // Marks if we need to use 16bit frame buffers.
150 YV12_BUFFER_CONFIG *frame_to_show;
151 RefCntBuffer *prev_frame;
153 // TODO(hkuang): Combine this with cur_buf in macroblockd.
154 RefCntBuffer *cur_frame;
156 int ref_frame_map[REF_FRAMES]; /* maps fb_idx to reference slot */
158 // Prepare ref_frame_map for the next frame.
159 // Only used in frame parallel decode.
160 int next_ref_frame_map[REF_FRAMES];
162 // TODO(jkoleszar): could expand active_ref_idx to 4, with 0 as intra, and
163 // roll new_fb_idx into it.
165 // Each frame can reference REFS_PER_FRAME buffers
166 RefBuffer frame_refs[REFS_PER_FRAME];
170 #if CONFIG_VP9_POSTPROC
171 YV12_BUFFER_CONFIG post_proc_buffer;
172 YV12_BUFFER_CONFIG post_proc_buffer_int;
175 FRAME_TYPE last_frame_type; /* last frame's frame type for motion search.*/
176 FRAME_TYPE frame_type;
180 int show_existing_frame;
182 // Flag signaling that the frame is encoded using only INTRA modes.
184 uint8_t last_intra_only;
186 int allow_high_precision_mv;
188 int allow_screen_content_tools;
190 // Flag signaling which frame contexts should be reset to default values.
191 RESET_FRAME_CONTEXT_MODE reset_frame_context;
193 // MBs, mb_rows/cols is in 16-pixel units; mi_rows/cols is in
194 // MODE_INFO (8-pixel) units.
196 int mb_rows, mi_rows;
197 int mb_cols, mi_cols;
200 /* profile settings */
207 int16_t y_dequant[MAX_SEGMENTS][2];
208 int16_t uv_dequant[MAX_SEGMENTS][2];
210 /* We allocate a MODE_INFO struct for each macroblock, together with
211 an extra row on top and column on the left to simplify prediction. */
213 MODE_INFO *mip; /* Base of allocated array */
214 MODE_INFO *mi; /* Corresponds to upper left visible macroblock */
216 // TODO(agrange): Move prev_mi into encoder structure.
217 // prev_mip and prev_mi will only be allocated in VP9 encoder.
218 MODE_INFO *prev_mip; /* MODE_INFO array 'mip' from last decoded frame */
219 MODE_INFO *prev_mi; /* 'mi' from last frame (points into prev_mip) */
221 // Separate mi functions between encoder and decoder.
222 int (*alloc_mi)(struct VP10Common *cm, int mi_size);
223 void (*free_mi)(struct VP10Common *cm);
224 void (*setup_mi)(struct VP10Common *cm);
226 // Grid of pointers to 8x8 MODE_INFO structs. Any 8x8 not in the visible
227 // area will be NULL.
228 MODE_INFO **mi_grid_base;
229 MODE_INFO **mi_grid_visible;
230 MODE_INFO **prev_mi_grid_base;
231 MODE_INFO **prev_mi_grid_visible;
233 // Whether to use previous frame's motion vectors for prediction.
234 int use_prev_frame_mvs;
236 // Persistent mb segment id map used in prediction.
238 int prev_seg_map_idx;
240 uint8_t *seg_map_array[NUM_PING_PONG_BUFFERS];
241 uint8_t *last_frame_seg_map;
242 uint8_t *current_frame_seg_map;
243 int seg_map_alloc_size;
245 INTERP_FILTER interp_filter;
247 loop_filter_info_n lf_info;
249 // Flag signaling how frame contexts should be updated at the end of
251 REFRESH_FRAME_CONTEXT_MODE refresh_frame_context;
253 int ref_frame_sign_bias[MAX_REF_FRAMES]; /* Two state 0, 1 */
255 struct loopfilter lf;
256 struct segmentation seg;
257 #if !CONFIG_MISC_FIXES
258 struct segmentation_probs segp;
261 int frame_parallel_decode; // frame-based threading.
263 // Context probabilities for reference frame prediction
264 MV_REFERENCE_FRAME comp_fixed_ref;
265 MV_REFERENCE_FRAME comp_var_ref[2];
266 REFERENCE_MODE reference_mode;
268 FRAME_CONTEXT *fc; /* this frame entropy */
269 FRAME_CONTEXT *frame_contexts; // FRAME_CONTEXTS
270 unsigned int frame_context_idx; /* Context to use/update */
273 unsigned int current_video_frame;
274 BITSTREAM_PROFILE profile;
276 // VPX_BITS_8 in profile 0 or 1, VPX_BITS_10 or VPX_BITS_12 in profile 2 or 3.
277 vpx_bit_depth_t bit_depth;
278 vpx_bit_depth_t dequant_bit_depth; // bit_depth of current dequantizer
280 #if CONFIG_VP9_POSTPROC
281 struct postproc_state postproc_state;
284 int error_resilient_mode;
286 int log2_tile_cols, log2_tile_rows;
289 int skip_loop_filter;
291 // Private data associated with the frame buffer callbacks.
293 vpx_get_frame_buffer_cb_fn_t get_fb_cb;
294 vpx_release_frame_buffer_cb_fn_t release_fb_cb;
296 // Handles memory for the codec.
297 InternalFrameBufferList int_frame_buffers;
299 // External BufferPool passed from outside.
300 BufferPool *buffer_pool;
302 PARTITION_CONTEXT *above_seg_context;
303 ENTROPY_CONTEXT *above_context;
304 int above_context_alloc_cols;
307 // TODO(hkuang): Don't need to lock the whole pool after implementing atomic
308 // frame reference count.
309 static void lock_buffer_pool(BufferPool *const pool) {
310 #if CONFIG_MULTITHREAD
311 pthread_mutex_lock(&pool->pool_mutex);
317 static void unlock_buffer_pool(BufferPool *const pool) {
318 #if CONFIG_MULTITHREAD
319 pthread_mutex_unlock(&pool->pool_mutex);
325 static INLINE YV12_BUFFER_CONFIG *get_ref_frame(VP10_COMMON *cm, int index) {
326 if (index < 0 || index >= REF_FRAMES)
328 if (cm->ref_frame_map[index] < 0)
330 assert(cm->ref_frame_map[index] < FRAME_BUFFERS);
331 return &cm->buffer_pool->frame_bufs[cm->ref_frame_map[index]].buf;
334 static INLINE YV12_BUFFER_CONFIG *get_frame_new_buffer(VP10_COMMON *cm) {
335 return &cm->buffer_pool->frame_bufs[cm->new_fb_idx].buf;
338 static INLINE int get_free_fb(VP10_COMMON *cm) {
339 RefCntBuffer *const frame_bufs = cm->buffer_pool->frame_bufs;
342 lock_buffer_pool(cm->buffer_pool);
343 for (i = 0; i < FRAME_BUFFERS; ++i)
344 if (frame_bufs[i].ref_count == 0)
347 if (i != FRAME_BUFFERS) {
348 frame_bufs[i].ref_count = 1;
350 // Reset i to be INVALID_IDX to indicate no free buffer found.
354 unlock_buffer_pool(cm->buffer_pool);
358 static INLINE void ref_cnt_fb(RefCntBuffer *bufs, int *idx, int new_idx) {
359 const int ref_index = *idx;
361 if (ref_index >= 0 && bufs[ref_index].ref_count > 0)
362 bufs[ref_index].ref_count--;
366 bufs[new_idx].ref_count++;
369 static INLINE int mi_cols_aligned_to_sb(int n_mis) {
370 return ALIGN_POWER_OF_TWO(n_mis, MI_BLOCK_SIZE_LOG2);
373 static INLINE int frame_is_intra_only(const VP10_COMMON *const cm) {
374 return cm->frame_type == KEY_FRAME || cm->intra_only;
377 static INLINE void set_partition_probs(const VP10_COMMON *const cm,
378 MACROBLOCKD *const xd) {
379 xd->partition_probs =
380 frame_is_intra_only(cm) ?
381 &vp10_kf_partition_probs[0] :
382 (const vpx_prob (*)[PARTITION_TYPES - 1])cm->fc->partition_prob;
385 static INLINE void vp10_init_macroblockd(VP10_COMMON *cm, MACROBLOCKD *xd,
386 tran_low_t *dqcoeff) {
389 for (i = 0; i < MAX_MB_PLANE; ++i) {
390 xd->plane[i].dqcoeff = dqcoeff;
391 xd->above_context[i] = cm->above_context +
392 i * sizeof(*cm->above_context) * 2 * mi_cols_aligned_to_sb(cm->mi_cols);
394 if (xd->plane[i].plane_type == PLANE_TYPE_Y) {
395 memcpy(xd->plane[i].seg_dequant, cm->y_dequant, sizeof(cm->y_dequant));
397 memcpy(xd->plane[i].seg_dequant, cm->uv_dequant, sizeof(cm->uv_dequant));
402 xd->above_seg_context = cm->above_seg_context;
403 xd->mi_stride = cm->mi_stride;
404 xd->error_info = &cm->error;
406 set_partition_probs(cm, xd);
409 static INLINE const vpx_prob* get_partition_probs(const MACROBLOCKD *xd,
411 return xd->partition_probs[ctx];
414 static INLINE void set_skip_context(MACROBLOCKD *xd, int mi_row, int mi_col) {
415 const int above_idx = mi_col * 2;
416 const int left_idx = (mi_row * 2) & 15;
418 for (i = 0; i < MAX_MB_PLANE; ++i) {
419 struct macroblockd_plane *const pd = &xd->plane[i];
420 pd->above_context = &xd->above_context[i][above_idx >> pd->subsampling_x];
421 pd->left_context = &xd->left_context[i][left_idx >> pd->subsampling_y];
425 static INLINE int calc_mi_size(int len) {
426 // len is in mi units.
427 return len + MI_BLOCK_SIZE;
430 static INLINE void set_mi_row_col(MACROBLOCKD *xd, const TileInfo *const tile,
433 int mi_rows, int mi_cols) {
434 xd->mb_to_top_edge = -((mi_row * MI_SIZE) * 8);
435 xd->mb_to_bottom_edge = ((mi_rows - bh - mi_row) * MI_SIZE) * 8;
436 xd->mb_to_left_edge = -((mi_col * MI_SIZE) * 8);
437 xd->mb_to_right_edge = ((mi_cols - bw - mi_col) * MI_SIZE) * 8;
439 // Are edges available for intra prediction?
440 xd->up_available = (mi_row != 0);
441 xd->left_available = (mi_col > tile->mi_col_start);
442 if (xd->up_available) {
443 xd->above_mi = xd->mi[-xd->mi_stride];
444 // above_mi may be NULL in VP9 encoder's first pass.
445 xd->above_mbmi = xd->above_mi ? &xd->above_mi->mbmi : NULL;
448 xd->above_mbmi = NULL;
451 if (xd->left_available) {
452 xd->left_mi = xd->mi[-1];
453 // left_mi may be NULL in VP9 encoder's first pass.
454 xd->left_mbmi = xd->left_mi ? &xd->left_mi->mbmi : NULL;
457 xd->left_mbmi = NULL;
461 static INLINE void update_partition_context(MACROBLOCKD *xd,
462 int mi_row, int mi_col,
465 PARTITION_CONTEXT *const above_ctx = xd->above_seg_context + mi_col;
466 PARTITION_CONTEXT *const left_ctx = xd->left_seg_context + (mi_row & MI_MASK);
468 // num_4x4_blocks_wide_lookup[bsize] / 2
469 const int bs = num_8x8_blocks_wide_lookup[bsize];
471 // update the partition context at the end notes. set partition bits
472 // of block sizes larger than the current one to be one, and partition
473 // bits of smaller block sizes to be zero.
474 memset(above_ctx, partition_context_lookup[subsize].above, bs);
475 memset(left_ctx, partition_context_lookup[subsize].left, bs);
478 static INLINE int partition_plane_context(const MACROBLOCKD *xd,
479 int mi_row, int mi_col,
481 const PARTITION_CONTEXT *above_ctx = xd->above_seg_context + mi_col;
482 const PARTITION_CONTEXT *left_ctx = xd->left_seg_context + (mi_row & MI_MASK);
483 const int bsl = mi_width_log2_lookup[bsize];
484 int above = (*above_ctx >> bsl) & 1 , left = (*left_ctx >> bsl) & 1;
486 assert(b_width_log2_lookup[bsize] == b_height_log2_lookup[bsize]);
489 return (left * 2 + above) + bsl * PARTITION_PLOFFSET;
496 #endif // VP10_COMMON_ONYXC_INT_H_