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
12#ifndef VP9_COMMON_VP9_BLOCKD_H_
13#define VP9_COMMON_VP9_BLOCKD_H_
14
15#include "./vpx_config.h"
16
17#include "vpx_ports/mem.h"
18#include "vpx_scale/yv12config.h"
19
20#include "vp9/common/vp9_common.h"
21#include "vp9/common/vp9_common_data.h"
22#include "vp9/common/vp9_enums.h"
23#include "vp9/common/vp9_filter.h"
24#include "vp9/common/vp9_mv.h"
25#include "vp9/common/vp9_scale.h"
26#include "vp9/common/vp9_seg_common.h"
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
32#define BLOCK_SIZE_GROUPS 4
33#define SKIP_CONTEXTS 3
34#define INTER_MODE_CONTEXTS 7
35
36/* Segment Feature Masks */
37#define MAX_MV_REF_CANDIDATES 2
38
39#define INTRA_INTER_CONTEXTS 4
40#define COMP_INTER_CONTEXTS 5
41#define REF_CONTEXTS 5
42
43typedef enum {
44  PLANE_TYPE_Y  = 0,
45  PLANE_TYPE_UV = 1,
46  PLANE_TYPES
47} PLANE_TYPE;
48
49typedef char ENTROPY_CONTEXT;
50
51typedef char PARTITION_CONTEXT;
52
53static INLINE int combine_entropy_contexts(ENTROPY_CONTEXT a,
54                                           ENTROPY_CONTEXT b) {
55  return (a != 0) + (b != 0);
56}
57
58typedef enum {
59  KEY_FRAME = 0,
60  INTER_FRAME = 1,
61  FRAME_TYPES,
62} FRAME_TYPE;
63
64typedef enum {
65  DC_PRED,         // Average of above and left pixels
66  V_PRED,          // Vertical
67  H_PRED,          // Horizontal
68  D45_PRED,        // Directional 45  deg = round(arctan(1/1) * 180/pi)
69  D135_PRED,       // Directional 135 deg = 180 - 45
70  D117_PRED,       // Directional 117 deg = 180 - 63
71  D153_PRED,       // Directional 153 deg = 180 - 27
72  D207_PRED,       // Directional 207 deg = 180 + 27
73  D63_PRED,        // Directional 63  deg = round(arctan(2/1) * 180/pi)
74  TM_PRED,         // True-motion
75  NEARESTMV,
76  NEARMV,
77  ZEROMV,
78  NEWMV,
79  MB_MODE_COUNT
80} MB_PREDICTION_MODE;
81
82static INLINE int is_inter_mode(MB_PREDICTION_MODE mode) {
83  return mode >= NEARESTMV && mode <= NEWMV;
84}
85
86#define INTRA_MODES (TM_PRED + 1)
87
88#define INTER_MODES (1 + NEWMV - NEARESTMV)
89
90#define INTER_OFFSET(mode) ((mode) - NEARESTMV)
91
92/* For keyframes, intra block modes are predicted by the (already decoded)
93   modes for the Y blocks to the left and above us; for interframes, there
94   is a single probability table. */
95
96typedef struct {
97  MB_PREDICTION_MODE as_mode;
98  int_mv as_mv[2];  // first, second inter predictor motion vectors
99} b_mode_info;
100
101typedef enum {
102  NONE = -1,
103  INTRA_FRAME = 0,
104  LAST_FRAME = 1,
105  GOLDEN_FRAME = 2,
106  ALTREF_FRAME = 3,
107  MAX_REF_FRAMES = 4
108} MV_REFERENCE_FRAME;
109
110static INLINE int b_width_log2(BLOCK_SIZE sb_type) {
111  return b_width_log2_lookup[sb_type];
112}
113static INLINE int b_height_log2(BLOCK_SIZE sb_type) {
114  return b_height_log2_lookup[sb_type];
115}
116
117static INLINE int mi_width_log2(BLOCK_SIZE sb_type) {
118  return mi_width_log2_lookup[sb_type];
119}
120
121// This structure now relates to 8x8 block regions.
122typedef struct {
123  // Common for both INTER and INTRA blocks
124  BLOCK_SIZE sb_type;
125  MB_PREDICTION_MODE mode;
126  TX_SIZE tx_size;
127  uint8_t skip;
128  uint8_t segment_id;
129  uint8_t seg_id_predicted;  // valid only when temporal_update is enabled
130
131  // Only for INTRA blocks
132  MB_PREDICTION_MODE uv_mode;
133
134  // Only for INTER blocks
135  MV_REFERENCE_FRAME ref_frame[2];
136  int_mv mv[2];
137  int_mv ref_mvs[MAX_REF_FRAMES][MAX_MV_REF_CANDIDATES];
138  uint8_t mode_context[MAX_REF_FRAMES];
139  INTERP_FILTER interp_filter;
140} MB_MODE_INFO;
141
142typedef struct {
143  MB_MODE_INFO mbmi;
144  b_mode_info bmi[4];
145} MODE_INFO;
146
147static INLINE MB_PREDICTION_MODE get_y_mode(const MODE_INFO *mi, int block) {
148  return mi->mbmi.sb_type < BLOCK_8X8 ? mi->bmi[block].as_mode
149                                      : mi->mbmi.mode;
150}
151
152static INLINE int is_inter_block(const MB_MODE_INFO *mbmi) {
153  return mbmi->ref_frame[0] > INTRA_FRAME;
154}
155
156static INLINE int has_second_ref(const MB_MODE_INFO *mbmi) {
157  return mbmi->ref_frame[1] > INTRA_FRAME;
158}
159
160MB_PREDICTION_MODE vp9_left_block_mode(const MODE_INFO *cur_mi,
161                                       const MODE_INFO *left_mi, int b);
162
163MB_PREDICTION_MODE vp9_above_block_mode(const MODE_INFO *cur_mi,
164                                        const MODE_INFO *above_mi, int b);
165
166enum mv_precision {
167  MV_PRECISION_Q3,
168  MV_PRECISION_Q4
169};
170
171#if CONFIG_ALPHA
172enum { MAX_MB_PLANE = 4 };
173#else
174enum { MAX_MB_PLANE = 3 };
175#endif
176
177struct buf_2d {
178  uint8_t *buf;
179  int stride;
180};
181
182struct macroblockd_plane {
183  int16_t *dqcoeff;
184  PLANE_TYPE plane_type;
185  int subsampling_x;
186  int subsampling_y;
187  struct buf_2d dst;
188  struct buf_2d pre[2];
189  const int16_t *dequant;
190  ENTROPY_CONTEXT *above_context;
191  ENTROPY_CONTEXT *left_context;
192};
193
194#define BLOCK_OFFSET(x, i) ((x) + (i) * 16)
195
196typedef struct RefBuffer {
197  // TODO(dkovalev): idx is not really required and should be removed, now it
198  // is used in vp9_onyxd_if.c
199  int idx;
200  YV12_BUFFER_CONFIG *buf;
201  struct scale_factors sf;
202} RefBuffer;
203
204typedef struct macroblockd {
205  struct macroblockd_plane plane[MAX_MB_PLANE];
206
207  int mi_stride;
208
209  // A NULL indicates that the 8x8 is not part of the image
210  MODE_INFO **mi;
211
212  int up_available;
213  int left_available;
214
215  /* Distance of MB away from frame edges */
216  int mb_to_left_edge;
217  int mb_to_right_edge;
218  int mb_to_top_edge;
219  int mb_to_bottom_edge;
220
221  /* pointers to reference frames */
222  RefBuffer *block_refs[2];
223
224  /* pointer to current frame */
225  const YV12_BUFFER_CONFIG *cur_buf;
226
227  /* mc buffer */
228  DECLARE_ALIGNED(16, uint8_t, mc_buf[80 * 2 * 80 * 2]);
229
230  int lossless;
231  /* Inverse transform function pointers. */
232  void (*itxm_add)(const int16_t *input, uint8_t *dest, int stride, int eob);
233
234  int corrupted;
235
236  DECLARE_ALIGNED(16, int16_t, dqcoeff[MAX_MB_PLANE][64 * 64]);
237
238  ENTROPY_CONTEXT *above_context[MAX_MB_PLANE];
239  ENTROPY_CONTEXT left_context[MAX_MB_PLANE][16];
240
241  PARTITION_CONTEXT *above_seg_context;
242  PARTITION_CONTEXT left_seg_context[8];
243} MACROBLOCKD;
244
245static INLINE BLOCK_SIZE get_subsize(BLOCK_SIZE bsize,
246                                     PARTITION_TYPE partition) {
247  const BLOCK_SIZE subsize = subsize_lookup[partition][bsize];
248  assert(subsize < BLOCK_SIZES);
249  return subsize;
250}
251
252extern const TX_TYPE intra_mode_to_tx_type_lookup[INTRA_MODES];
253
254static INLINE TX_TYPE get_tx_type(PLANE_TYPE plane_type,
255                                  const MACROBLOCKD *xd) {
256  const MB_MODE_INFO *const mbmi = &xd->mi[0]->mbmi;
257
258  if (plane_type != PLANE_TYPE_Y || is_inter_block(mbmi))
259    return DCT_DCT;
260  return intra_mode_to_tx_type_lookup[mbmi->mode];
261}
262
263static INLINE TX_TYPE get_tx_type_4x4(PLANE_TYPE plane_type,
264                                      const MACROBLOCKD *xd, int ib) {
265  const MODE_INFO *const mi = xd->mi[0];
266
267  if (plane_type != PLANE_TYPE_Y || xd->lossless || is_inter_block(&mi->mbmi))
268    return DCT_DCT;
269
270  return intra_mode_to_tx_type_lookup[get_y_mode(mi, ib)];
271}
272
273void vp9_setup_block_planes(MACROBLOCKD *xd, int ss_x, int ss_y);
274
275static INLINE TX_SIZE get_uv_tx_size_impl(TX_SIZE y_tx_size, BLOCK_SIZE bsize) {
276  if (bsize < BLOCK_8X8) {
277    return TX_4X4;
278  } else {
279    // TODO(dkovalev): Assuming YUV420 (ss_x == 1, ss_y == 1)
280    const BLOCK_SIZE plane_bsize = ss_size_lookup[bsize][1][1];
281    return MIN(y_tx_size, max_txsize_lookup[plane_bsize]);
282  }
283}
284
285static INLINE TX_SIZE get_uv_tx_size(const MB_MODE_INFO *mbmi) {
286  return get_uv_tx_size_impl(mbmi->tx_size, mbmi->sb_type);
287}
288
289static INLINE BLOCK_SIZE get_plane_block_size(BLOCK_SIZE bsize,
290    const struct macroblockd_plane *pd) {
291  BLOCK_SIZE bs = ss_size_lookup[bsize][pd->subsampling_x][pd->subsampling_y];
292  assert(bs < BLOCK_SIZES);
293  return bs;
294}
295
296typedef void (*foreach_transformed_block_visitor)(int plane, int block,
297                                                  BLOCK_SIZE plane_bsize,
298                                                  TX_SIZE tx_size,
299                                                  void *arg);
300
301void vp9_foreach_transformed_block_in_plane(
302    const MACROBLOCKD *const xd, BLOCK_SIZE bsize, int plane,
303    foreach_transformed_block_visitor visit, void *arg);
304
305
306void vp9_foreach_transformed_block(
307    const MACROBLOCKD* const xd, BLOCK_SIZE bsize,
308    foreach_transformed_block_visitor visit, void *arg);
309
310static INLINE void txfrm_block_to_raster_xy(BLOCK_SIZE plane_bsize,
311                                            TX_SIZE tx_size, int block,
312                                            int *x, int *y) {
313  const int bwl = b_width_log2(plane_bsize);
314  const int tx_cols_log2 = bwl - tx_size;
315  const int tx_cols = 1 << tx_cols_log2;
316  const int raster_mb = block >> (tx_size << 1);
317  *x = (raster_mb & (tx_cols - 1)) << tx_size;
318  *y = (raster_mb >> tx_cols_log2) << tx_size;
319}
320
321void vp9_set_contexts(const MACROBLOCKD *xd, struct macroblockd_plane *pd,
322                      BLOCK_SIZE plane_bsize, TX_SIZE tx_size, int has_eob,
323                      int aoff, int loff);
324
325#ifdef __cplusplus
326}  // extern "C"
327#endif
328
329#endif  // VP9_COMMON_VP9_BLOCKD_H_
330