avfilter/vf_cropdetect: Unroll 3 & 4 bytes per sample loop
[ffmpeg.git] / libavfilter / vf_cropdetect.c
1 /*
2  * Copyright (c) 2002 A'rpi
3  * This file is part of FFmpeg.
4  *
5  * FFmpeg is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * FFmpeg is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with FFmpeg; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19
20 /**
21  * @file
22  * border detection filter
23  * Ported from MPlayer libmpcodecs/vf_cropdetect.c.
24  */
25
26 #include "libavutil/imgutils.h"
27 #include "libavutil/internal.h"
28 #include "libavutil/opt.h"
29
30 #include "avfilter.h"
31 #include "formats.h"
32 #include "internal.h"
33 #include "video.h"
34
35 typedef struct CropDetectContext {
36     const AVClass *class;
37     int x1, y1, x2, y2;
38     int limit;
39     int round;
40     int reset_count;
41     int frame_nb;
42     int max_pixsteps[4];
43     int max_outliers;
44 } CropDetectContext;
45
46 static int query_formats(AVFilterContext *ctx)
47 {
48     static const enum AVPixelFormat pix_fmts[] = {
49         AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUVJ420P,
50         AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVJ422P,
51         AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVJ444P,
52         AV_PIX_FMT_YUV411P, AV_PIX_FMT_GRAY8,
53         AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV410P,
54         AV_PIX_FMT_NV12,    AV_PIX_FMT_NV21,
55         AV_PIX_FMT_RGB24,   AV_PIX_FMT_BGR24,
56         AV_PIX_FMT_RGBA,    AV_PIX_FMT_BGRA,
57         AV_PIX_FMT_NONE
58     };
59
60     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
61     return 0;
62 }
63
64 static int checkline(void *ctx, const unsigned char *src, int stride, int len, int bpp)
65 {
66     int total = 0;
67     int div = len;
68
69     switch (bpp) {
70     case 1:
71         while (len >= 8) {
72             total += src[       0] + src[  stride] + src[2*stride] + src[3*stride]
73                   +  src[4*stride] + src[5*stride] + src[6*stride] + src[7*stride];
74             src += 8*stride;
75             len -= 8;
76         }
77         while (--len >= 0) {
78             total += src[0];
79             src += stride;
80         }
81         break;
82     case 3:
83     case 4:
84         while (len >= 4) {
85             total += src[0]        + src[1         ] + src[2         ]
86                   +  src[  stride] + src[1+  stride] + src[2+  stride];
87                   +  src[2*stride] + src[1+2*stride] + src[2+2*stride];
88                   +  src[3*stride] + src[1+3*stride] + src[2+3*stride];
89             src += 4*stride;
90             len -= 4;
91         }
92         while (--len >= 0) {
93             total += src[0] + src[1] + src[2];
94             src += stride;
95         }
96         div *= 3;
97         break;
98     }
99     total /= div;
100
101     av_log(ctx, AV_LOG_DEBUG, "total:%d\n", total);
102     return total;
103 }
104
105 static av_cold int init(AVFilterContext *ctx)
106 {
107     CropDetectContext *s = ctx->priv;
108
109     s->frame_nb = -2;
110
111     av_log(ctx, AV_LOG_VERBOSE, "limit:%d round:%d reset_count:%d\n",
112            s->limit, s->round, s->reset_count);
113
114     return 0;
115 }
116
117 static int config_input(AVFilterLink *inlink)
118 {
119     AVFilterContext *ctx = inlink->dst;
120     CropDetectContext *s = ctx->priv;
121
122     av_image_fill_max_pixsteps(s->max_pixsteps, NULL,
123                                av_pix_fmt_desc_get(inlink->format));
124
125     s->x1 = inlink->w - 1;
126     s->y1 = inlink->h - 1;
127     s->x2 = 0;
128     s->y2 = 0;
129
130     return 0;
131 }
132
133 #define SET_META(key, value) \
134     av_dict_set_int(metadata, key, value, 0)
135
136 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
137 {
138     AVFilterContext *ctx = inlink->dst;
139     CropDetectContext *s = ctx->priv;
140     int bpp = s->max_pixsteps[0];
141     int w, h, x, y, shrink_by;
142     AVDictionary **metadata;
143     int outliers, last_y;
144
145     // ignore first 2 frames - they may be empty
146     if (++s->frame_nb > 0) {
147         metadata = avpriv_frame_get_metadatap(frame);
148
149         // Reset the crop area every reset_count frames, if reset_count is > 0
150         if (s->reset_count > 0 && s->frame_nb > s->reset_count) {
151             s->x1 = frame->width  - 1;
152             s->y1 = frame->height - 1;
153             s->x2 = 0;
154             s->y2 = 0;
155             s->frame_nb = 1;
156         }
157
158 #define FIND(DST, FROM, NOEND, INC, STEP0, STEP1, LEN) \
159         outliers = 0;\
160         for (last_y = y = FROM; NOEND; y = y INC) {\
161             if (checkline(ctx, frame->data[0] + STEP0 * y, STEP1, LEN, bpp) > s->limit) {\
162                 if (++outliers > s->max_outliers) { \
163                     DST = last_y;\
164                     break;\
165                 }\
166             } else\
167                 last_y = y INC;\
168         }
169
170         FIND(s->y1,                 0,               y < s->y1, +1, frame->linesize[0], bpp, frame->width);
171         FIND(s->y2, frame->height - 1, y > FFMAX(s->y2, s->y1), -1, frame->linesize[0], bpp, frame->width);
172         FIND(s->x1,                 0,               y < s->x1, +1, bpp, frame->linesize[0], frame->height);
173         FIND(s->x2,  frame->width - 1, y > FFMAX(s->x2, s->x1), -1, bpp, frame->linesize[0], frame->height);
174
175
176         // round x and y (up), important for yuv colorspaces
177         // make sure they stay rounded!
178         x = (s->x1+1) & ~1;
179         y = (s->y1+1) & ~1;
180
181         w = s->x2 - x + 1;
182         h = s->y2 - y + 1;
183
184         // w and h must be divisible by 2 as well because of yuv
185         // colorspace problems.
186         if (s->round <= 1)
187             s->round = 16;
188         if (s->round % 2)
189             s->round *= 2;
190
191         shrink_by = w % s->round;
192         w -= shrink_by;
193         x += (shrink_by/2 + 1) & ~1;
194
195         shrink_by = h % s->round;
196         h -= shrink_by;
197         y += (shrink_by/2 + 1) & ~1;
198
199         SET_META("lavfi.cropdetect.x1", s->x1);
200         SET_META("lavfi.cropdetect.x2", s->x2);
201         SET_META("lavfi.cropdetect.y1", s->y1);
202         SET_META("lavfi.cropdetect.y2", s->y2);
203         SET_META("lavfi.cropdetect.w",  w);
204         SET_META("lavfi.cropdetect.h",  h);
205         SET_META("lavfi.cropdetect.x",  x);
206         SET_META("lavfi.cropdetect.y",  y);
207
208         av_log(ctx, AV_LOG_INFO,
209                "x1:%d x2:%d y1:%d y2:%d w:%d h:%d x:%d y:%d pts:%"PRId64" t:%f crop=%d:%d:%d:%d\n",
210                s->x1, s->x2, s->y1, s->y2, w, h, x, y, frame->pts,
211                frame->pts == AV_NOPTS_VALUE ? -1 : frame->pts * av_q2d(inlink->time_base),
212                w, h, x, y);
213     }
214
215     return ff_filter_frame(inlink->dst->outputs[0], frame);
216 }
217
218 #define OFFSET(x) offsetof(CropDetectContext, x)
219 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
220
221 static const AVOption cropdetect_options[] = {
222     { "limit", "Threshold below which the pixel is considered black", OFFSET(limit),       AV_OPT_TYPE_INT, { .i64 = 24 }, 0, 255, FLAGS },
223     { "round", "Value by which the width/height should be divisible", OFFSET(round),       AV_OPT_TYPE_INT, { .i64 = 16 }, 0, INT_MAX, FLAGS },
224     { "reset", "Recalculate the crop area after this many frames",    OFFSET(reset_count), AV_OPT_TYPE_INT, { .i64 = 0 },  0, INT_MAX, FLAGS },
225     { "reset_count", "Recalculate the crop area after this many frames",OFFSET(reset_count),AV_OPT_TYPE_INT,{ .i64 = 0 },  0, INT_MAX, FLAGS },
226     { "max_outliers", "Threshold count of outliers",                  OFFSET(max_outliers),AV_OPT_TYPE_INT, { .i64 = 0 },  0, INT_MAX, FLAGS },
227     { NULL }
228 };
229
230 AVFILTER_DEFINE_CLASS(cropdetect);
231
232 static const AVFilterPad avfilter_vf_cropdetect_inputs[] = {
233     {
234         .name         = "default",
235         .type         = AVMEDIA_TYPE_VIDEO,
236         .config_props = config_input,
237         .filter_frame = filter_frame,
238     },
239     { NULL }
240 };
241
242 static const AVFilterPad avfilter_vf_cropdetect_outputs[] = {
243     {
244         .name = "default",
245         .type = AVMEDIA_TYPE_VIDEO
246     },
247     { NULL }
248 };
249
250 AVFilter ff_vf_cropdetect = {
251     .name          = "cropdetect",
252     .description   = NULL_IF_CONFIG_SMALL("Auto-detect crop size."),
253     .priv_size     = sizeof(CropDetectContext),
254     .priv_class    = &cropdetect_class,
255     .init          = init,
256     .query_formats = query_formats,
257     .inputs        = avfilter_vf_cropdetect_inputs,
258     .outputs       = avfilter_vf_cropdetect_outputs,
259     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
260 };