1 /*
2 * Copyright (c) 2016, Alliance for Open Media. All rights reserved
3 *
4 * This source code is subject to the terms of the BSD 2 Clause License and
5 * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
6 * was not distributed with this source code in the LICENSE file, you can
7 * obtain it at www.aomedia.org/license/software. If the Alliance for Open
8 * Media Patent License 1.0 was not distributed with this source code in the
9 * PATENTS file, you can obtain it at www.aomedia.org/license/patent.
10 */
11
12 #ifndef AOM_AV1_COMMON_CFL_H_
13 #define AOM_AV1_COMMON_CFL_H_
14
15 #include "av1/common/av1_common_int.h"
16 #include "av1/common/blockd.h"
17
18 // Can we use CfL for the current block?
is_cfl_allowed(const MACROBLOCKD * xd)19 static INLINE CFL_ALLOWED_TYPE is_cfl_allowed(const MACROBLOCKD *xd) {
20 const MB_MODE_INFO *mbmi = xd->mi[0];
21 const BLOCK_SIZE bsize = mbmi->bsize;
22 assert(bsize < BLOCK_SIZES_ALL);
23 if (xd->lossless[mbmi->segment_id]) {
24 // In lossless, CfL is available when the partition size is equal to the
25 // transform size.
26 const int ssx = xd->plane[AOM_PLANE_U].subsampling_x;
27 const int ssy = xd->plane[AOM_PLANE_U].subsampling_y;
28 const int plane_bsize = get_plane_block_size(bsize, ssx, ssy);
29 return (CFL_ALLOWED_TYPE)(plane_bsize == BLOCK_4X4);
30 }
31 // Spec: CfL is available to luma partitions lesser than or equal to 32x32
32 return (CFL_ALLOWED_TYPE)(block_size_wide[bsize] <= 32 &&
33 block_size_high[bsize] <= 32);
34 }
35
36 // Do we need to save the luma pixels from the current block,
37 // for a possible future CfL prediction?
store_cfl_required(const AV1_COMMON * cm,const MACROBLOCKD * xd)38 static INLINE CFL_ALLOWED_TYPE store_cfl_required(const AV1_COMMON *cm,
39 const MACROBLOCKD *xd) {
40 const MB_MODE_INFO *mbmi = xd->mi[0];
41
42 if (cm->seq_params->monochrome) return CFL_DISALLOWED;
43
44 if (!xd->is_chroma_ref) {
45 // For non-chroma-reference blocks, we should always store the luma pixels,
46 // in case the corresponding chroma-reference block uses CfL.
47 // Note that this can only happen for block sizes which are <8 on
48 // their shortest side, as otherwise they would be chroma reference
49 // blocks.
50 return CFL_ALLOWED;
51 }
52
53 // If this block has chroma information, we know whether we're
54 // actually going to perform a CfL prediction
55 return (CFL_ALLOWED_TYPE)(!is_inter_block(mbmi) &&
56 mbmi->uv_mode == UV_CFL_PRED);
57 }
58
get_scaled_luma_q0(int alpha_q3,int16_t pred_buf_q3)59 static INLINE int get_scaled_luma_q0(int alpha_q3, int16_t pred_buf_q3) {
60 int scaled_luma_q6 = alpha_q3 * pred_buf_q3;
61 return ROUND_POWER_OF_TWO_SIGNED(scaled_luma_q6, 6);
62 }
63
get_cfl_pred_type(int plane)64 static INLINE CFL_PRED_TYPE get_cfl_pred_type(int plane) {
65 assert(plane > 0);
66 return (CFL_PRED_TYPE)(plane - 1);
67 }
68
clear_cfl_dc_pred_cache_flags(CFL_CTX * cfl)69 static INLINE void clear_cfl_dc_pred_cache_flags(CFL_CTX *cfl) {
70 cfl->use_dc_pred_cache = false;
71 cfl->dc_pred_is_cached[CFL_PRED_U] = false;
72 cfl->dc_pred_is_cached[CFL_PRED_V] = false;
73 }
74
75 void av1_cfl_predict_block(MACROBLOCKD *const xd, uint8_t *dst, int dst_stride,
76 TX_SIZE tx_size, int plane);
77
78 void cfl_store_block(MACROBLOCKD *const xd, BLOCK_SIZE bsize, TX_SIZE tx_size);
79
80 void cfl_store_tx(MACROBLOCKD *const xd, int row, int col, TX_SIZE tx_size,
81 BLOCK_SIZE bsize);
82
83 void cfl_store_dc_pred(MACROBLOCKD *const xd, const uint8_t *input,
84 CFL_PRED_TYPE pred_plane, int width);
85
86 void cfl_load_dc_pred(MACROBLOCKD *const xd, uint8_t *dst, int dst_stride,
87 TX_SIZE tx_size, CFL_PRED_TYPE pred_plane);
88
89 // Allows the CFL_SUBSAMPLE function to switch types depending on the bitdepth.
90 #define CFL_lbd_TYPE uint8_t *cfl_type
91 #define CFL_hbd_TYPE uint16_t *cfl_type
92
93 // Declare a size-specific wrapper for the size-generic function. The compiler
94 // will inline the size generic function in here, the advantage is that the size
95 // will be constant allowing for loop unrolling and other constant propagated
96 // goodness.
97 #define CFL_SUBSAMPLE(arch, sub, bd, width, height) \
98 void cfl_subsample_##bd##_##sub##_##width##x##height##_##arch( \
99 const CFL_##bd##_TYPE, int input_stride, uint16_t *output_q3) { \
100 cfl_luma_subsampling_##sub##_##bd##_##arch(cfl_type, input_stride, \
101 output_q3, width, height); \
102 }
103
104 // Declare size-specific wrappers for all valid CfL sizes.
105 #define CFL_SUBSAMPLE_FUNCTIONS(arch, sub, bd) \
106 CFL_SUBSAMPLE(arch, sub, bd, 4, 4) \
107 CFL_SUBSAMPLE(arch, sub, bd, 8, 8) \
108 CFL_SUBSAMPLE(arch, sub, bd, 16, 16) \
109 CFL_SUBSAMPLE(arch, sub, bd, 32, 32) \
110 CFL_SUBSAMPLE(arch, sub, bd, 4, 8) \
111 CFL_SUBSAMPLE(arch, sub, bd, 8, 4) \
112 CFL_SUBSAMPLE(arch, sub, bd, 8, 16) \
113 CFL_SUBSAMPLE(arch, sub, bd, 16, 8) \
114 CFL_SUBSAMPLE(arch, sub, bd, 16, 32) \
115 CFL_SUBSAMPLE(arch, sub, bd, 32, 16) \
116 CFL_SUBSAMPLE(arch, sub, bd, 4, 16) \
117 CFL_SUBSAMPLE(arch, sub, bd, 16, 4) \
118 CFL_SUBSAMPLE(arch, sub, bd, 8, 32) \
119 CFL_SUBSAMPLE(arch, sub, bd, 32, 8) \
120 cfl_subsample_##bd##_fn cfl_get_luma_subsampling_##sub##_##bd##_##arch( \
121 TX_SIZE tx_size) { \
122 CFL_SUBSAMPLE_FUNCTION_ARRAY(arch, sub, bd) \
123 return subfn_##sub[tx_size]; \
124 }
125
126 // Declare an architecture-specific array of function pointers for size-specific
127 // wrappers.
128 #define CFL_SUBSAMPLE_FUNCTION_ARRAY(arch, sub, bd) \
129 static const cfl_subsample_##bd##_fn subfn_##sub[TX_SIZES_ALL] = { \
130 cfl_subsample_##bd##_##sub##_4x4_##arch, /* 4x4 */ \
131 cfl_subsample_##bd##_##sub##_8x8_##arch, /* 8x8 */ \
132 cfl_subsample_##bd##_##sub##_16x16_##arch, /* 16x16 */ \
133 cfl_subsample_##bd##_##sub##_32x32_##arch, /* 32x32 */ \
134 NULL, /* 64x64 (invalid CFL size) */ \
135 cfl_subsample_##bd##_##sub##_4x8_##arch, /* 4x8 */ \
136 cfl_subsample_##bd##_##sub##_8x4_##arch, /* 8x4 */ \
137 cfl_subsample_##bd##_##sub##_8x16_##arch, /* 8x16 */ \
138 cfl_subsample_##bd##_##sub##_16x8_##arch, /* 16x8 */ \
139 cfl_subsample_##bd##_##sub##_16x32_##arch, /* 16x32 */ \
140 cfl_subsample_##bd##_##sub##_32x16_##arch, /* 32x16 */ \
141 NULL, /* 32x64 (invalid CFL size) */ \
142 NULL, /* 64x32 (invalid CFL size) */ \
143 cfl_subsample_##bd##_##sub##_4x16_##arch, /* 4x16 */ \
144 cfl_subsample_##bd##_##sub##_16x4_##arch, /* 16x4 */ \
145 cfl_subsample_##bd##_##sub##_8x32_##arch, /* 8x32 */ \
146 cfl_subsample_##bd##_##sub##_32x8_##arch, /* 32x8 */ \
147 NULL, /* 16x64 (invalid CFL size) */ \
148 NULL, /* 64x16 (invalid CFL size) */ \
149 };
150
151 // The RTCD script does not support passing in an array, so we wrap it in this
152 // function.
153 #if CONFIG_AV1_HIGHBITDEPTH
154 #define CFL_GET_SUBSAMPLE_FUNCTION(arch) \
155 CFL_SUBSAMPLE_FUNCTIONS(arch, 420, lbd) \
156 CFL_SUBSAMPLE_FUNCTIONS(arch, 422, lbd) \
157 CFL_SUBSAMPLE_FUNCTIONS(arch, 444, lbd) \
158 CFL_SUBSAMPLE_FUNCTIONS(arch, 420, hbd) \
159 CFL_SUBSAMPLE_FUNCTIONS(arch, 422, hbd) \
160 CFL_SUBSAMPLE_FUNCTIONS(arch, 444, hbd)
161 #else
162 #define CFL_GET_SUBSAMPLE_FUNCTION(arch) \
163 CFL_SUBSAMPLE_FUNCTIONS(arch, 420, lbd) \
164 CFL_SUBSAMPLE_FUNCTIONS(arch, 422, lbd) \
165 CFL_SUBSAMPLE_FUNCTIONS(arch, 444, lbd)
166 #endif
167
168 // Declare a size-specific wrapper for the size-generic function. The compiler
169 // will inline the size generic function in here, the advantage is that the size
170 // will be constant allowing for loop unrolling and other constant propagated
171 // goodness.
172 #define CFL_SUB_AVG_X(arch, width, height, round_offset, num_pel_log2) \
173 void cfl_subtract_average_##width##x##height##_##arch(const uint16_t *src, \
174 int16_t *dst) { \
175 subtract_average_##arch(src, dst, width, height, round_offset, \
176 num_pel_log2); \
177 }
178
179 // Declare size-specific wrappers for all valid CfL sizes.
180 #define CFL_SUB_AVG_FN(arch) \
181 CFL_SUB_AVG_X(arch, 4, 4, 8, 4) \
182 CFL_SUB_AVG_X(arch, 4, 8, 16, 5) \
183 CFL_SUB_AVG_X(arch, 4, 16, 32, 6) \
184 CFL_SUB_AVG_X(arch, 8, 4, 16, 5) \
185 CFL_SUB_AVG_X(arch, 8, 8, 32, 6) \
186 CFL_SUB_AVG_X(arch, 8, 16, 64, 7) \
187 CFL_SUB_AVG_X(arch, 8, 32, 128, 8) \
188 CFL_SUB_AVG_X(arch, 16, 4, 32, 6) \
189 CFL_SUB_AVG_X(arch, 16, 8, 64, 7) \
190 CFL_SUB_AVG_X(arch, 16, 16, 128, 8) \
191 CFL_SUB_AVG_X(arch, 16, 32, 256, 9) \
192 CFL_SUB_AVG_X(arch, 32, 8, 128, 8) \
193 CFL_SUB_AVG_X(arch, 32, 16, 256, 9) \
194 CFL_SUB_AVG_X(arch, 32, 32, 512, 10) \
195 cfl_subtract_average_fn cfl_get_subtract_average_fn_##arch( \
196 TX_SIZE tx_size) { \
197 static const cfl_subtract_average_fn sub_avg[TX_SIZES_ALL] = { \
198 cfl_subtract_average_4x4_##arch, /* 4x4 */ \
199 cfl_subtract_average_8x8_##arch, /* 8x8 */ \
200 cfl_subtract_average_16x16_##arch, /* 16x16 */ \
201 cfl_subtract_average_32x32_##arch, /* 32x32 */ \
202 NULL, /* 64x64 (invalid CFL size) */ \
203 cfl_subtract_average_4x8_##arch, /* 4x8 */ \
204 cfl_subtract_average_8x4_##arch, /* 8x4 */ \
205 cfl_subtract_average_8x16_##arch, /* 8x16 */ \
206 cfl_subtract_average_16x8_##arch, /* 16x8 */ \
207 cfl_subtract_average_16x32_##arch, /* 16x32 */ \
208 cfl_subtract_average_32x16_##arch, /* 32x16 */ \
209 NULL, /* 32x64 (invalid CFL size) */ \
210 NULL, /* 64x32 (invalid CFL size) */ \
211 cfl_subtract_average_4x16_##arch, /* 4x16 (invalid CFL size) */ \
212 cfl_subtract_average_16x4_##arch, /* 16x4 (invalid CFL size) */ \
213 cfl_subtract_average_8x32_##arch, /* 8x32 (invalid CFL size) */ \
214 cfl_subtract_average_32x8_##arch, /* 32x8 (invalid CFL size) */ \
215 NULL, /* 16x64 (invalid CFL size) */ \
216 NULL, /* 64x16 (invalid CFL size) */ \
217 }; \
218 /* Modulo TX_SIZES_ALL to ensure that an attacker won't be able to */ \
219 /* index the function pointer array out of bounds. */ \
220 return sub_avg[tx_size % TX_SIZES_ALL]; \
221 }
222
223 // For VSX SIMD optimization, the C versions of width == 4 subtract are
224 // faster than the VSX. As such, the VSX code calls the C versions.
225 void cfl_subtract_average_4x4_c(const uint16_t *src, int16_t *dst);
226 void cfl_subtract_average_4x8_c(const uint16_t *src, int16_t *dst);
227 void cfl_subtract_average_4x16_c(const uint16_t *src, int16_t *dst);
228
229 #define CFL_PREDICT_lbd(arch, width, height) \
230 void cfl_predict_lbd_##width##x##height##_##arch( \
231 const int16_t *pred_buf_q3, uint8_t *dst, int dst_stride, \
232 int alpha_q3) { \
233 cfl_predict_lbd_##arch(pred_buf_q3, dst, dst_stride, alpha_q3, width, \
234 height); \
235 }
236
237 #if CONFIG_AV1_HIGHBITDEPTH
238 #define CFL_PREDICT_hbd(arch, width, height) \
239 void cfl_predict_hbd_##width##x##height##_##arch( \
240 const int16_t *pred_buf_q3, uint16_t *dst, int dst_stride, int alpha_q3, \
241 int bd) { \
242 cfl_predict_hbd_##arch(pred_buf_q3, dst, dst_stride, alpha_q3, bd, width, \
243 height); \
244 }
245 #endif
246
247 // This wrapper exists because clang format does not like calling macros with
248 // lowercase letters.
249 #define CFL_PREDICT_X(arch, width, height, bd) \
250 CFL_PREDICT_##bd(arch, width, height)
251
252 #define CFL_PREDICT_FN(arch, bd) \
253 CFL_PREDICT_X(arch, 4, 4, bd) \
254 CFL_PREDICT_X(arch, 4, 8, bd) \
255 CFL_PREDICT_X(arch, 4, 16, bd) \
256 CFL_PREDICT_X(arch, 8, 4, bd) \
257 CFL_PREDICT_X(arch, 8, 8, bd) \
258 CFL_PREDICT_X(arch, 8, 16, bd) \
259 CFL_PREDICT_X(arch, 8, 32, bd) \
260 CFL_PREDICT_X(arch, 16, 4, bd) \
261 CFL_PREDICT_X(arch, 16, 8, bd) \
262 CFL_PREDICT_X(arch, 16, 16, bd) \
263 CFL_PREDICT_X(arch, 16, 32, bd) \
264 CFL_PREDICT_X(arch, 32, 8, bd) \
265 CFL_PREDICT_X(arch, 32, 16, bd) \
266 CFL_PREDICT_X(arch, 32, 32, bd) \
267 cfl_predict_##bd##_fn cfl_get_predict_##bd##_fn_##arch(TX_SIZE tx_size) { \
268 static const cfl_predict_##bd##_fn pred[TX_SIZES_ALL] = { \
269 cfl_predict_##bd##_4x4_##arch, /* 4x4 */ \
270 cfl_predict_##bd##_8x8_##arch, /* 8x8 */ \
271 cfl_predict_##bd##_16x16_##arch, /* 16x16 */ \
272 cfl_predict_##bd##_32x32_##arch, /* 32x32 */ \
273 NULL, /* 64x64 (invalid CFL size) */ \
274 cfl_predict_##bd##_4x8_##arch, /* 4x8 */ \
275 cfl_predict_##bd##_8x4_##arch, /* 8x4 */ \
276 cfl_predict_##bd##_8x16_##arch, /* 8x16 */ \
277 cfl_predict_##bd##_16x8_##arch, /* 16x8 */ \
278 cfl_predict_##bd##_16x32_##arch, /* 16x32 */ \
279 cfl_predict_##bd##_32x16_##arch, /* 32x16 */ \
280 NULL, /* 32x64 (invalid CFL size) */ \
281 NULL, /* 64x32 (invalid CFL size) */ \
282 cfl_predict_##bd##_4x16_##arch, /* 4x16 */ \
283 cfl_predict_##bd##_16x4_##arch, /* 16x4 */ \
284 cfl_predict_##bd##_8x32_##arch, /* 8x32 */ \
285 cfl_predict_##bd##_32x8_##arch, /* 32x8 */ \
286 NULL, /* 16x64 (invalid CFL size) */ \
287 NULL, /* 64x16 (invalid CFL size) */ \
288 }; \
289 /* Modulo TX_SIZES_ALL to ensure that an attacker won't be able to */ \
290 /* index the function pointer array out of bounds. */ \
291 return pred[tx_size % TX_SIZES_ALL]; \
292 }
293
294 #endif // AOM_AV1_COMMON_CFL_H_
295