avfilter/phase: add some constness for RO data pointers.
[ffmpeg.git] / libavfilter / vf_phase.c
1 /*
2  * Copyright (c) 2004 Ville Saari
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License along
17  * with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #include "libavutil/avassert.h"
22 #include "libavutil/imgutils.h"
23 #include "libavutil/pixdesc.h"
24 #include "libavutil/opt.h"
25 #include "avfilter.h"
26 #include "formats.h"
27 #include "internal.h"
28 #include "video.h"
29
30 enum PhaseMode {
31     PROGRESSIVE,
32     TOP_FIRST,
33     BOTTOM_FIRST,
34     TOP_FIRST_ANALYZE,
35     BOTTOM_FIRST_ANALYZE,
36     ANALYZE,
37     FULL_ANALYZE,
38     AUTO,
39     AUTO_ANALYZE
40 };
41
42 typedef struct PhaseContext {
43     const AVClass *class;
44     enum PhaseMode mode;
45     AVFrame *frame; /* previous frame */
46     int nb_planes;
47     int planeheight[4];
48     int linesize[4];
49 } PhaseContext;
50
51 #define OFFSET(x) offsetof(PhaseContext, x)
52 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
53 #define CONST(name, help, val, unit) { name, help, 0, AV_OPT_TYPE_CONST, {.i64=val}, 0, 0, FLAGS, unit }
54
55 static const AVOption phase_options[] = {
56     { "mode", "set phase mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=AUTO_ANALYZE}, PROGRESSIVE, AUTO_ANALYZE, FLAGS, "mode" },
57     CONST("p", "progressive",          PROGRESSIVE,          "mode"),
58     CONST("t", "top first",            TOP_FIRST,            "mode"),
59     CONST("b", "bottom first",         BOTTOM_FIRST,         "mode"),
60     CONST("T", "top first analyze",    TOP_FIRST_ANALYZE,    "mode"),
61     CONST("B", "bottom first analyze", BOTTOM_FIRST_ANALYZE, "mode"),
62     CONST("u", "analyze",              ANALYZE,              "mode"),
63     CONST("U", "full analyze",         FULL_ANALYZE,         "mode"),
64     CONST("a", "auto",                 AUTO,                 "mode"),
65     CONST("A", "auto analyze",         AUTO_ANALYZE,         "mode"),
66     { NULL }
67 };
68
69 AVFILTER_DEFINE_CLASS(phase);
70
71 static int query_formats(AVFilterContext *ctx)
72 {
73     static const enum AVPixelFormat pix_fmts[] = {
74         AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA420P,
75         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_YUVJ422P,AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ411P,
76         AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P,
77         AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP, AV_PIX_FMT_GRAY8, AV_PIX_FMT_NONE
78     };
79
80     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
81     return 0;
82 }
83
84 static int config_input(AVFilterLink *inlink)
85 {
86     PhaseContext *s = inlink->dst->priv;
87     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
88     int ret;
89
90     if ((ret = av_image_fill_linesizes(s->linesize, inlink->format, inlink->w)) < 0)
91         return ret;
92
93     s->planeheight[1] = s->planeheight[2] = FF_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
94     s->planeheight[0] = s->planeheight[3] = inlink->h;
95
96     s->nb_planes = av_pix_fmt_count_planes(inlink->format);
97
98     return 0;
99 }
100
101 /*
102  * This macro interpolates the value of both fields at a point halfway
103  * between lines and takes the squared difference. In field resolution
104  * the point is a quarter pixel below a line in one field and a quarter
105  * pixel above a line in other.
106  *
107  * (The result is actually multiplied by 25)
108  */
109 #define DIFF(a, as, b, bs) (t = ((*a - b[bs]) << 2) + a[as << 1] - b[-bs], t * t)
110
111 /*
112  * Find which field combination has the smallest average squared difference
113  * between the fields.
114  */
115 static enum PhaseMode analyze_plane(void *ctx, enum PhaseMode mode, AVFrame *old, AVFrame *new)
116 {
117     double bdiff, tdiff, pdiff, scale;
118     const int ns = new->linesize[0];
119     const int os = old->linesize[0];
120     const uint8_t *nptr = new->data[0];
121     const uint8_t *optr = old->data[0];
122     const int h = new->height;
123     const int w = new->width;
124     int bdif, tdif, pdif;
125     const uint8_t *end, *rend;
126     int top, t;
127
128     if (mode == AUTO) {
129         mode = new->interlaced_frame ? new->top_field_first ?
130                TOP_FIRST : BOTTOM_FIRST : PROGRESSIVE;
131     } else if (mode == AUTO_ANALYZE) {
132         mode = new->interlaced_frame ? new->top_field_first ?
133                TOP_FIRST_ANALYZE : BOTTOM_FIRST_ANALYZE : FULL_ANALYZE;
134     }
135
136     if (mode <= BOTTOM_FIRST) {
137         bdiff = pdiff = tdiff = 65536.0;
138     } else {
139         bdiff = pdiff = tdiff = 0.0;
140
141         for (end = nptr + (h - 2) * ns, nptr += ns, optr += os, top = 0;
142              nptr < end; nptr += ns - w, optr += os - w, top ^= 1) {
143             pdif = tdif = bdif = 0;
144
145             switch (mode) {
146             case TOP_FIRST_ANALYZE:
147                 if (top) {
148                     for (rend = nptr + w; nptr < rend; nptr++, optr++) {
149                         pdif += DIFF(nptr, ns, nptr, ns);
150                         tdif += DIFF(nptr, ns, optr, os);
151                     }
152                 } else {
153                     for (rend = nptr + w; nptr < rend; nptr++, optr++) {
154                         pdif += DIFF(nptr, ns, nptr, ns);
155                         tdif += DIFF(optr, os, nptr, ns);
156                     }
157                 }
158                 break;
159             case BOTTOM_FIRST_ANALYZE:
160                 if (top) {
161                     for (rend = nptr + w; nptr < rend; nptr++, optr++) {
162                         pdif += DIFF(nptr, ns, nptr, ns);
163                         bdif += DIFF(optr, os, nptr, ns);
164                     }
165                 } else {
166                     for (rend = nptr + w; nptr < rend; nptr++, optr++) {
167                         pdif += DIFF(nptr, ns, nptr, ns);
168                         bdif += DIFF(nptr, ns, optr, os);
169                     }
170                 }
171                 break;
172             case ANALYZE:
173                 if (top) {
174                     for (rend = nptr + w; nptr < rend; nptr++, optr++) {
175                         tdif += DIFF(nptr, ns, optr, os);
176                         bdif += DIFF(optr, os, nptr, ns);
177                     }
178                 } else {
179                     for (rend = nptr + w; nptr < rend; nptr++, optr++) {
180                         bdif += DIFF(nptr, ns, optr, os);
181                         tdif += DIFF(optr, os, nptr, ns);
182                     }
183                 }
184                 break;
185             case FULL_ANALYZE:
186                 if (top) {
187                     for (rend = nptr + w; nptr < rend; nptr++, optr++) {
188                         pdif += DIFF(nptr, ns, nptr, ns);
189                         tdif += DIFF(nptr, ns, optr, os);
190                         bdif += DIFF(optr, os, nptr, ns);
191                     }
192                 } else {
193                     for (rend = nptr + w; nptr < rend; nptr++, optr++) {
194                         pdif += DIFF(nptr, ns, nptr, ns);
195                         bdif += DIFF(nptr, ns, optr, os);
196                         tdif += DIFF(optr, os, nptr, ns);
197                     }
198                 }
199                 break;
200             default:
201                 av_assert0(0);
202             }
203
204             pdiff += (double)pdif;
205             tdiff += (double)tdif;
206             bdiff += (double)bdif;
207         }
208
209         scale = 1.0 / (w * (h - 3)) / 25.0;
210         pdiff *= scale;
211         tdiff *= scale;
212         bdiff *= scale;
213
214         if (mode == TOP_FIRST_ANALYZE) {
215             bdiff = 65536.0;
216         } else if (mode == BOTTOM_FIRST_ANALYZE) {
217             tdiff = 65536.0;
218         } else if (mode == ANALYZE) {
219             pdiff = 65536.0;
220         }
221
222         if (bdiff < pdiff && bdiff < tdiff) {
223             mode = BOTTOM_FIRST;
224         } else if (tdiff < pdiff && tdiff < bdiff) {
225             mode = TOP_FIRST;
226         } else {
227             mode = PROGRESSIVE;
228         }
229     }
230
231     av_log(ctx, AV_LOG_DEBUG, "mode=%c tdiff=%f bdiff=%f pdiff=%f\n",
232            mode == BOTTOM_FIRST ? 'b' : mode == TOP_FIRST ? 't' : 'p',
233            tdiff, bdiff, pdiff);
234     return mode;
235 }
236
237 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
238 {
239     AVFilterContext *ctx = inlink->dst;
240     AVFilterLink *outlink = ctx->outputs[0];
241     PhaseContext *s = ctx->priv;
242     enum PhaseMode mode;
243     int plane, top, y;
244     AVFrame *out;
245
246     if (ctx->is_disabled) {
247         av_frame_free(&s->frame);
248         /* we keep a reference to the previous frame so the filter can start
249          * being useful as soon as it's not disabled, avoiding the 1-frame
250          * delay. */
251         s->frame = av_frame_clone(in);
252         return ff_filter_frame(outlink, in);
253     }
254
255     out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
256     if (!out) {
257         av_frame_free(&in);
258         return AVERROR(ENOMEM);
259     }
260     av_frame_copy_props(out, in);
261
262     if (!s->frame) {
263         s->frame = in;
264         mode = PROGRESSIVE;
265     } else {
266         mode = analyze_plane(ctx, s->mode, s->frame, in);
267     }
268
269     for (plane = 0; plane < s->nb_planes; plane++) {
270         const uint8_t *buf = s->frame->data[plane];
271         const uint8_t *from = in->data[plane];
272         uint8_t *to = out->data[plane];
273
274         for (y = 0, top = 1; y < s->planeheight[plane]; y++, top ^= 1) {
275             memcpy(to, mode == (top ? BOTTOM_FIRST : TOP_FIRST) ? buf : from, s->linesize[plane]);
276
277             buf += s->frame->linesize[plane];
278             from += in->linesize[plane];
279             to += out->linesize[plane];
280         }
281     }
282
283     if (in != s->frame)
284         av_frame_free(&s->frame);
285     s->frame = in;
286     return ff_filter_frame(outlink, out);
287 }
288
289 static av_cold void uninit(AVFilterContext *ctx)
290 {
291     PhaseContext *s = ctx->priv;
292
293     av_frame_free(&s->frame);
294 }
295
296 static const AVFilterPad phase_inputs[] = {
297     {
298         .name         = "default",
299         .type         = AVMEDIA_TYPE_VIDEO,
300         .filter_frame = filter_frame,
301         .config_props = config_input,
302     },
303     { NULL }
304 };
305
306 static const AVFilterPad phase_outputs[] = {
307     {
308         .name = "default",
309         .type = AVMEDIA_TYPE_VIDEO,
310     },
311     { NULL }
312 };
313
314 AVFilter ff_vf_phase = {
315     .name          = "phase",
316     .description   = NULL_IF_CONFIG_SMALL("Phase shift fields."),
317     .priv_size     = sizeof(PhaseContext),
318     .priv_class    = &phase_class,
319     .uninit        = uninit,
320     .query_formats = query_formats,
321     .inputs        = phase_inputs,
322     .outputs       = phase_outputs,
323     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL,
324 };