avfilter/xbr: remove unused mask
[ffmpeg.git] / libavfilter / vf_xbr.c
1 /*
2  * This file is part of FFmpeg.
3  *
4  * Copyright (c) 2011, 2012 Hyllian/Jararaca <sergiogdb@gmail.com>
5  * Copyright (c) 2014 Arwa Arif <arwaarif1994@gmail.com>
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * XBR Filter is used for depixelization of image.
25  * This is based on Hyllian's xBR shader.
26  *
27  * @see http://www.libretro.com/forums/viewtopic.php?f=6&t=134
28  * @see https://github.com/yoyofr/iFBA/blob/master/fba_src/src/intf/video/scalers/xbr.cpp
29  */
30
31 #include "libavutil/opt.h"
32 #include "libavutil/avassert.h"
33 #include "libavutil/pixdesc.h"
34 #include "internal.h"
35
36 #define LB_MASK       0x00FEFEFE
37 #define RED_BLUE_MASK 0x00FF00FF
38 #define GREEN_MASK    0x0000FF00
39
40 typedef int (*xbrfunc_t)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
41
42 typedef struct {
43     const AVClass *class;
44     int n;
45     xbrfunc_t func;
46     uint32_t rgbtoyuv[1<<24];
47 } XBRContext;
48
49 typedef struct ThreadData {
50     AVFrame *in, *out;
51     const uint32_t *rgbtoyuv;
52 } ThreadData;
53
54 #define OFFSET(x) offsetof(XBRContext, x)
55 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
56 static const AVOption xbr_options[] = {
57     { "n", "set scale factor", OFFSET(n), AV_OPT_TYPE_INT, {.i64 = 3}, 2, 4, .flags = FLAGS },
58     { NULL }
59 };
60
61 AVFILTER_DEFINE_CLASS(xbr);
62
63 static uint32_t pixel_diff(uint32_t x, uint32_t y, const uint32_t *r2y)
64 {
65 #define YMASK 0xff0000
66 #define UMASK 0x00ff00
67 #define VMASK 0x0000ff
68
69     uint32_t yuv1 = r2y[x & 0xffffff];
70     uint32_t yuv2 = r2y[y & 0xffffff];
71
72     return (abs((yuv1 & YMASK) - (yuv2 & YMASK)) >> 16) +
73            (abs((yuv1 & UMASK) - (yuv2 & UMASK)) >>  8) +
74            abs((yuv1 & VMASK) - (yuv2 & VMASK));
75 }
76
77 #define ALPHA_BLEND_128_W(dst, src) dst = ((src & LB_MASK) >> 1) + ((dst & LB_MASK) >> 1)
78 #define ALPHA_BLEND_BASE(a, b, m, s) (  (RED_BLUE_MASK & (((a) & RED_BLUE_MASK) + (((((b) & RED_BLUE_MASK) - ((a) & RED_BLUE_MASK)) * (m)) >> (s)))) \
79                                       | (GREEN_MASK    & (((a) & GREEN_MASK)    + (((((b) & GREEN_MASK)    - ((a) & GREEN_MASK))    * (m)) >> (s)))))
80 #define ALPHA_BLEND_32_W(dst, src)  dst = ALPHA_BLEND_BASE(dst, src, 1, 3)
81 #define ALPHA_BLEND_64_W(dst, src)  dst = ALPHA_BLEND_BASE(dst, src, 1, 2)
82 #define ALPHA_BLEND_192_W(dst, src) dst = ALPHA_BLEND_BASE(dst, src, 3, 2)
83 #define ALPHA_BLEND_224_W(dst, src) dst = ALPHA_BLEND_BASE(dst, src, 7, 3)
84
85 #define df(A, B) pixel_diff(A, B, r2y)
86 #define eq(A, B) (df(A, B) < 155)
87
88 #define FILT2(PE, PI, PH, PF, PG, PC, PD, PB, PA, G5, C4, G0, D0, C1, B1, F4, I4, H5, I5, A0, A1,   \
89               N0, N1, N2, N3) do {                                                                  \
90     if (PE != PH && PE != PF) {                                                                     \
91         const unsigned e = df(PE,PC) + df(PE,PG) + df(PI,H5) + df(PI,F4) + (df(PH,PF)<<2);          \
92         const unsigned i = df(PH,PD) + df(PH,I5) + df(PF,I4) + df(PF,PB) + (df(PE,PI)<<2);          \
93         if (e < i && (!eq(PF,PB) && !eq(PH,PD) || eq(PE,PI)                                         \
94                       && (!eq(PF,I4) && !eq(PH,I5))                                                 \
95                       || eq(PE,PG) || eq(PE,PC))) {                                                 \
96             const unsigned ke = df(PF,PG);                                                          \
97             const unsigned ki = df(PH,PC);                                                          \
98             const int left    = ke<<1 <= ki && PE != PG && PD != PG;                                \
99             const int up      = ke >= ki<<1 && PE != PC && PB != PC;                                \
100             const unsigned px = df(PE,PF) <= df(PE,PH) ? PF : PH;                                   \
101             if (left && up) {                                                                       \
102                 ALPHA_BLEND_224_W(E[N3], px);                                                       \
103                 ALPHA_BLEND_64_W( E[N2], px);                                                       \
104                 E[N1] = E[N2];                                                                      \
105             } else if (left) {                                                                      \
106                 ALPHA_BLEND_192_W(E[N3], px);                                                       \
107                 ALPHA_BLEND_64_W( E[N2], px);                                                       \
108             } else if (up) {                                                                        \
109                 ALPHA_BLEND_192_W(E[N3], px);                                                       \
110                 ALPHA_BLEND_64_W( E[N1], px);                                                       \
111             } else { /* diagonal */                                                                 \
112                 ALPHA_BLEND_128_W(E[N3], px);                                                       \
113             }                                                                                       \
114         } else if (e <= i) {                                                                        \
115             ALPHA_BLEND_128_W( E[N3], ((df(PE,PF) <= df(PE,PH)) ? PF : PH));                        \
116         }                                                                                           \
117     }                                                                                               \
118 } while (0)
119
120 #define FILT3(PE, PI, PH, PF, PG, PC, PD, PB, PA, G5, C4, G0, D0, C1, B1, F4, I4, H5, I5, A0, A1,   \
121               N0, N1, N2, N3, N4, N5, N6, N7, N8) do {                                              \
122     if (PE != PH && PE != PF) {                                                                     \
123         const unsigned e = df(PE,PC) + df(PE,PG) + df(PI,H5) + df(PI,F4) + (df(PH,PF)<<2);          \
124         const unsigned i = df(PH,PD) + df(PH,I5) + df(PF,I4) + df(PF,PB) + (df(PE,PI)<<2);          \
125         if (e < i && (!eq(PF,PB) && !eq(PF,PC) || !eq(PH,PD) && !eq(PH,PG) || eq(PE,PI)             \
126                       && (!eq(PF,F4) && !eq(PF,I4) || !eq(PH,H5) && !eq(PH,I5))                     \
127                       || eq(PE,PG) || eq(PE,PC))) {                                                 \
128             const unsigned ke = df(PF,PG);                                                          \
129             const unsigned ki = df(PH,PC);                                                          \
130             const int left    = ke<<1 <= ki && PE != PG && PD != PG;                                \
131             const int up      = ke >= ki<<1 && PE != PC && PB != PC;                                \
132             const unsigned px = df(PE,PF) <= df(PE,PH) ? PF : PH;                                   \
133             if (left && up) {                                                                       \
134                 ALPHA_BLEND_192_W(E[N7], px);                                                       \
135                 ALPHA_BLEND_64_W( E[N6], px);                                                       \
136                 E[N5] = E[N7];                                                                      \
137                 E[N2] = E[N6];                                                                      \
138                 E[N8] = px;                                                                         \
139             } else if (left) {                                                                      \
140                 ALPHA_BLEND_192_W(E[N7], px);                                                       \
141                 ALPHA_BLEND_64_W( E[N5], px);                                                       \
142                 ALPHA_BLEND_64_W( E[N6], px);                                                       \
143                 E[N8] = px;                                                                         \
144             } else if (up) {                                                                        \
145                 ALPHA_BLEND_192_W(E[N5], px);                                                       \
146                 ALPHA_BLEND_64_W( E[N7], px);                                                       \
147                 ALPHA_BLEND_64_W( E[N2], px);                                                       \
148                 E[N8] = px;                                                                         \
149             } else { /* diagonal */                                                                 \
150                 ALPHA_BLEND_224_W(E[N8], px);                                                       \
151                 ALPHA_BLEND_32_W( E[N5], px);                                                       \
152                 ALPHA_BLEND_32_W( E[N7], px);                                                       \
153             }                                                                                       \
154         } else if (e <= i) {                                                                        \
155             ALPHA_BLEND_128_W(E[N8], ((df(PE,PF) <= df(PE,PH)) ? PF : PH));                         \
156         }                                                                                           \
157     }                                                                                               \
158 } while (0)
159
160 #define FILT4(PE, PI, PH, PF, PG, PC, PD, PB, PA, G5, C4, G0, D0, C1, B1, F4, I4, H5, I5, A0, A1,   \
161               N15, N14, N11, N3, N7, N10, N13, N12, N9, N6, N2, N1, N5, N8, N4, N0) do {            \
162     if (PE != PH && PE != PF) {                                                                     \
163         const unsigned e = df(PE,PC) + df(PE,PG) + df(PI,H5) + df(PI,F4) + (df(PH,PF)<<2);          \
164         const unsigned i = df(PH,PD) + df(PH,I5) + df(PF,I4) + df(PF,PB) + (df(PE,PI)<<2);          \
165         if (e < i && (!eq(PF,PB) && !eq(PH,PD) || eq(PE,PI)                                         \
166                       && (!eq(PF,I4) && !eq(PH,I5))                                                 \
167                       || eq(PE,PG) || eq(PE,PC))) {                                                 \
168             const unsigned ke = df(PF,PG);                                                          \
169             const unsigned ki = df(PH,PC);                                                          \
170             const int left    = ke<<1 <= ki && PE != PG && PD != PG;                                \
171             const int up      = ke >= ki<<1 && PE != PC && PB != PC;                                \
172             const unsigned px = df(PE,PF) <= df(PE,PH) ? PF : PH;                                   \
173             if (left && up) {                                                                       \
174                 ALPHA_BLEND_192_W(E[N13], px);                                                      \
175                 ALPHA_BLEND_64_W( E[N12], px);                                                      \
176                 E[N15] = E[N14] = E[N11] = px;                                                      \
177                 E[N10] = E[N3]  = E[N12];                                                           \
178                 E[N7]  = E[N13];                                                                    \
179             } else if (left) {                                                                      \
180                 ALPHA_BLEND_192_W(E[N11], px);                                                      \
181                 ALPHA_BLEND_192_W(E[N13], px);                                                      \
182                 ALPHA_BLEND_64_W( E[N10], px);                                                      \
183                 ALPHA_BLEND_64_W( E[N12], px);                                                      \
184                 E[N14] = px;                                                                        \
185                 E[N15] = px;                                                                        \
186             } else if (up) {                                                                        \
187                 ALPHA_BLEND_192_W(E[N14], px);                                                      \
188                 ALPHA_BLEND_192_W(E[N7 ], px);                                                      \
189                 ALPHA_BLEND_64_W( E[N10], px);                                                      \
190                 ALPHA_BLEND_64_W( E[N3 ], px);                                                      \
191                 E[N11] = px;                                                                        \
192                 E[N15] = px;                                                                        \
193             } else { /* diagonal */                                                                 \
194                 ALPHA_BLEND_128_W(E[N11], px);                                                      \
195                 ALPHA_BLEND_128_W(E[N14], px);                                                      \
196                 E[N15] = px;                                                                        \
197             }                                                                                       \
198         } else if (e <= i) {                                                                        \
199             ALPHA_BLEND_128_W( E[N15], ((df(PE,PF) <= df(PE,PH)) ? PF : PH));                       \
200         }                                                                                           \
201     }                                                                                               \
202 } while (0)
203
204 static av_always_inline void xbr_filter(const ThreadData *td, int jobnr, int nb_jobs, int n)
205 {
206     int x, y;
207     const AVFrame *input = td->in;
208     AVFrame *output = td->out;
209     const uint32_t *r2y = td->rgbtoyuv;
210     const int slice_start = (input->height *  jobnr   ) / nb_jobs;
211     const int slice_end   = (input->height * (jobnr+1)) / nb_jobs;
212     const int nl = output->linesize[0] >> 2;
213     const int nl1 = nl + nl;
214     const int nl2 = nl1 + nl;
215
216     for (y = slice_start; y < slice_end; y++) {
217
218         uint32_t *E = (uint32_t *)(output->data[0] + y * output->linesize[0] * n);
219         const uint32_t *sa2 = (uint32_t *)(input->data[0] + y * input->linesize[0] - 8); /* center */
220         const uint32_t *sa1 = sa2 - (input->linesize[0]>>2); /* up x1 */
221         const uint32_t *sa0 = sa1 - (input->linesize[0]>>2); /* up x2 */
222         const uint32_t *sa3 = sa2 + (input->linesize[0]>>2); /* down x1 */
223         const uint32_t *sa4 = sa3 + (input->linesize[0]>>2); /* down x2 */
224
225         if (y <= 1) {
226             sa0 = sa1;
227             if (y == 0) {
228                 sa0 = sa1 = sa2;
229             }
230         }
231
232         if (y >= input->height - 2) {
233             sa4 = sa3;
234             if (y == input->height - 1) {
235                 sa4 = sa3 = sa2;
236             }
237         }
238
239         for (x = 0; x < input->width; x++) {
240             const uint32_t B1 = sa0[2];
241             const uint32_t PB = sa1[2];
242             const uint32_t PE = sa2[2];
243             const uint32_t PH = sa3[2];
244             const uint32_t H5 = sa4[2];
245
246             const int pprev = 2 - (x > 0);
247             const uint32_t A1 = sa0[pprev];
248             const uint32_t PA = sa1[pprev];
249             const uint32_t PD = sa2[pprev];
250             const uint32_t PG = sa3[pprev];
251             const uint32_t G5 = sa4[pprev];
252
253             const int pprev2 = pprev - (x > 1);
254             const uint32_t A0 = sa1[pprev2];
255             const uint32_t D0 = sa2[pprev2];
256             const uint32_t G0 = sa3[pprev2];
257
258             const int pnext = 3 - (x == input->width - 1);
259             const uint32_t C1 = sa0[pnext];
260             const uint32_t PC = sa1[pnext];
261             const uint32_t PF = sa2[pnext];
262             const uint32_t PI = sa3[pnext];
263             const uint32_t I5 = sa4[pnext];
264
265             const int pnext2 = pnext + 1 - (x >= input->width - 2);
266             const uint32_t C4 = sa1[pnext2];
267             const uint32_t F4 = sa2[pnext2];
268             const uint32_t I4 = sa3[pnext2];
269
270             if (n == 2) {
271                 E[0]  = E[1]      =     // 0, 1
272                 E[nl] = E[nl + 1] = PE; // 2, 3
273
274                 FILT2(PE, PI, PH, PF, PG, PC, PD, PB, PA, G5, C4, G0, D0, C1, B1, F4, I4, H5, I5, A0, A1, 0, 1, nl, nl+1);
275                 FILT2(PE, PC, PF, PB, PI, PA, PH, PD, PG, I4, A1, I5, H5, A0, D0, B1, C1, F4, C4, G5, G0, nl, 0, nl+1, 1);
276                 FILT2(PE, PA, PB, PD, PC, PG, PF, PH, PI, C1, G0, C4, F4, G5, H5, D0, A0, B1, A1, I4, I5, nl+1, nl, 1, 0);
277                 FILT2(PE, PG, PD, PH, PA, PI, PB, PF, PC, A0, I5, A1, B1, I4, F4, H5, G5, D0, G0, C1, C4, 1, nl+1, 0, nl);
278             } else if (n == 3) {
279                 E[0]   = E[1]     = E[2]     =     // 0, 1, 2
280                 E[nl]  = E[nl+1]  = E[nl+2]  =     // 3, 4, 5
281                 E[nl1] = E[nl1+1] = E[nl1+2] = PE; // 6, 7, 8
282
283                 FILT3(PE, PI, PH, PF, PG, PC, PD, PB, PA, G5, C4, G0, D0, C1, B1, F4, I4, H5, I5, A0, A1, 0, 1, 2, nl, nl+1, nl+2, nl1, nl1+1, nl1+2);
284                 FILT3(PE, PC, PF, PB, PI, PA, PH, PD, PG, I4, A1, I5, H5, A0, D0, B1, C1, F4, C4, G5, G0, nl1, nl, 0, nl1+1, nl+1, 1, nl1+2, nl+2, 2);
285                 FILT3(PE, PA, PB, PD, PC, PG, PF, PH, PI, C1, G0, C4, F4, G5, H5, D0, A0, B1, A1, I4, I5, nl1+2, nl1+1, nl1, nl+2, nl+1, nl, 2, 1, 0);
286                 FILT3(PE, PG, PD, PH, PA, PI, PB, PF, PC, A0, I5, A1, B1, I4, F4, H5, G5, D0, G0, C1, C4, 2, nl+2, nl1+2, 1, nl+1, nl1+1, 0, nl, nl1);
287             } else if (n == 4) {
288                 E[0]   = E[1]     = E[2]     = E[3]     =     //  0,  1,  2,  3
289                 E[nl]  = E[nl+1]  = E[nl+2]  = E[nl+3]  =     //  4,  5,  6,  7
290                 E[nl1] = E[nl1+1] = E[nl1+2] = E[nl1+3] =     //  8,  9, 10, 11
291                 E[nl2] = E[nl2+1] = E[nl2+2] = E[nl2+3] = PE; // 12, 13, 14, 15
292
293                 FILT4(PE, PI, PH, PF, PG, PC, PD, PB, PA, G5, C4, G0, D0, C1, B1, F4, I4, H5, I5, A0, A1, nl2+3, nl2+2, nl1+3, 3, nl+3, nl1+2, nl2+1, nl2, nl1+1, nl+2, 2, 1, nl+1, nl1, nl, 0);
294                 FILT4(PE, PC, PF, PB, PI, PA, PH, PD, PG, I4, A1, I5, H5, A0, D0, B1, C1, F4, C4, G5, G0, 3, nl+3, 2, 0, 1, nl+2, nl1+3, nl2+3, nl1+2, nl+1, nl, nl1, nl1+1, nl2+2, nl2+1, nl2);
295                 FILT4(PE, PA, PB, PD, PC, PG, PF, PH, PI, C1, G0, C4, F4, G5, H5, D0, A0, B1, A1, I4, I5, 0, 1, nl, nl2, nl1, nl+1, 2, 3, nl+2, nl1+1, nl2+1, nl2+2, nl1+2, nl+3, nl1+3, nl2+3);
296                 FILT4(PE, PG, PD, PH, PA, PI, PB, PF, PC, A0, I5, A1, B1, I4, F4, H5, G5, D0, G0, C1, C4, nl2, nl1, nl2+1, nl2+3, nl2+2, nl1+1, nl, 0, nl+1, nl1+2, nl1+3, nl+3, nl+2, 1, 2, 3);
297             }
298
299             sa0 += 1;
300             sa1 += 1;
301             sa2 += 1;
302             sa3 += 1;
303             sa4 += 1;
304
305             E += n;
306         }
307     }
308 }
309
310 #define XBR_FUNC(size) \
311 static int xbr##size##x(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs) \
312 { \
313     xbr_filter(arg, jobnr, nb_jobs, size); \
314     return 0; \
315 }
316
317 XBR_FUNC(2)
318 XBR_FUNC(3)
319 XBR_FUNC(4)
320
321
322 static int config_output(AVFilterLink *outlink)
323 {
324     AVFilterContext *ctx = outlink->src;
325     XBRContext *xbr = ctx->priv;
326     AVFilterLink *inlink = ctx->inputs[0];
327
328     outlink->w = inlink->w * xbr->n;
329     outlink->h = inlink->h * xbr->n;
330     return 0;
331 }
332
333 static int query_formats(AVFilterContext *ctx)
334 {
335     static const enum AVPixelFormat pix_fmts[] = {
336         AV_PIX_FMT_0RGB32, AV_PIX_FMT_NONE,
337     };
338
339     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
340     return 0;
341 }
342
343 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
344 {
345     AVFilterContext *ctx = inlink->dst;
346     AVFilterLink *outlink = ctx->outputs[0];
347     XBRContext *xbr = ctx->priv;
348     ThreadData td;
349
350     AVFrame *out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
351     if (!out) {
352         av_frame_free(&in);
353         return AVERROR(ENOMEM);
354     }
355
356     av_frame_copy_props(out, in);
357
358     td.in = in;
359     td.out = out;
360     td.rgbtoyuv = xbr->rgbtoyuv;
361     ctx->internal->execute(ctx, xbr->func, &td, NULL, FFMIN(inlink->h, ctx->graph->nb_threads));
362
363     out->width  = outlink->w;
364     out->height = outlink->h;
365
366     av_frame_free(&in);
367     return ff_filter_frame(outlink, out);
368 }
369
370 static int init(AVFilterContext *ctx)
371 {
372     XBRContext *xbr = ctx->priv;
373     static const xbrfunc_t xbrfuncs[] = {xbr2x, xbr3x, xbr4x};
374
375     uint32_t c;
376     int bg, rg, g;
377
378     for (bg = -255; bg < 256; bg++) {
379         for (rg = -255; rg < 256; rg++) {
380             const uint32_t u = (uint32_t)((-169*rg + 500*bg)/1000) + 128;
381             const uint32_t v = (uint32_t)(( 500*rg -  81*bg)/1000) + 128;
382             int startg = FFMAX3(-bg, -rg, 0);
383             int endg = FFMIN3(255-bg, 255-rg, 255);
384             uint32_t y = (uint32_t)(( 299*rg + 1000*startg + 114*bg)/1000);
385             c = bg + (rg<<16) + 0x010101 * startg;
386             for (g = startg; g <= endg; g++) {
387                 xbr->rgbtoyuv[c] = ((y++) << 16) + (u << 8) + v;
388                 c+= 0x010101;
389             }
390         }
391     }
392
393     xbr->func = xbrfuncs[xbr->n - 2];
394     return 0;
395 }
396
397 static const AVFilterPad xbr_inputs[] = {
398     {
399         .name         = "default",
400         .type         = AVMEDIA_TYPE_VIDEO,
401         .filter_frame = filter_frame,
402     },
403     { NULL }
404 };
405
406 static const AVFilterPad xbr_outputs[] = {
407     {
408         .name         = "default",
409         .type         = AVMEDIA_TYPE_VIDEO,
410         .config_props = config_output,
411     },
412     { NULL }
413 };
414
415 AVFilter ff_vf_xbr = {
416     .name          = "xbr",
417     .description   = NULL_IF_CONFIG_SMALL("Scale the input using xBR algorithm."),
418     .inputs        = xbr_inputs,
419     .outputs       = xbr_outputs,
420     .query_formats = query_formats,
421     .priv_size     = sizeof(XBRContext),
422     .priv_class    = &xbr_class,
423     .init          = init,
424     .flags         = AVFILTER_FLAG_SLICE_THREADS,
425 };