Fix crop->var_values[VAR_T] computation in the crop filter.
[ffmpeg.git] / libavfilter / vf_crop.c
1 /*
2  * copyright (c) 2007 Bobby Bingham
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 Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 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 GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along 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 /**
22  * @file
23  * video crop filter
24  */
25
26 #include "avfilter.h"
27 #include "libavutil/eval.h"
28 #include "libavutil/avstring.h"
29 #include "libavutil/libm.h"
30 #include "libavcore/imgutils.h"
31
32 static const char *var_names[] = {
33     "E",
34     "PHI",
35     "PI",
36     "in_w", "iw",   ///< width  of the input video
37     "in_h", "ih",   ///< height of the input video
38     "out_w", "ow",  ///< width  of the cropped video
39     "out_h", "oh",  ///< height of the cropped video
40     "x",
41     "y",
42     "n",            ///< number of frame
43     "pos",          ///< position in the file
44     "t",            ///< timestamp expressed in seconds
45     NULL
46 };
47
48 enum var_name {
49     VAR_E,
50     VAR_PHI,
51     VAR_PI,
52     VAR_IN_W,  VAR_IW,
53     VAR_IN_H,  VAR_IH,
54     VAR_OUT_W, VAR_OW,
55     VAR_OUT_H, VAR_OH,
56     VAR_X,
57     VAR_Y,
58     VAR_N,
59     VAR_POS,
60     VAR_T,
61     VAR_VARS_NB
62 };
63
64 typedef struct {
65     int  x;             ///< x offset of the non-cropped area with respect to the input area
66     int  y;             ///< y offset of the non-cropped area with respect to the input area
67     int  w;             ///< width of the cropped area
68     int  h;             ///< height of the cropped area
69
70     int max_step[4];    ///< max pixel step for each plane, expressed as a number of bytes
71     int hsub, vsub;     ///< chroma subsampling
72     char x_expr[256], y_expr[256], ow_expr[256], oh_expr[256];
73     AVExpr *x_pexpr, *y_pexpr;  /* parsed expressions for x and y */
74     double var_values[VAR_VARS_NB];
75 } CropContext;
76
77 static int query_formats(AVFilterContext *ctx)
78 {
79     static const enum PixelFormat pix_fmts[] = {
80         PIX_FMT_RGB48BE,      PIX_FMT_RGB48LE,
81         PIX_FMT_ARGB,         PIX_FMT_RGBA,
82         PIX_FMT_ABGR,         PIX_FMT_BGRA,
83         PIX_FMT_RGB24,        PIX_FMT_BGR24,
84         PIX_FMT_RGB565BE,     PIX_FMT_RGB565LE,
85         PIX_FMT_RGB555BE,     PIX_FMT_RGB555LE,
86         PIX_FMT_BGR565BE,     PIX_FMT_BGR565LE,
87         PIX_FMT_BGR555BE,     PIX_FMT_BGR555LE,
88         PIX_FMT_GRAY16BE,     PIX_FMT_GRAY16LE,
89         PIX_FMT_YUV420P16LE,  PIX_FMT_YUV420P16BE,
90         PIX_FMT_YUV422P16LE,  PIX_FMT_YUV422P16BE,
91         PIX_FMT_YUV444P16LE,  PIX_FMT_YUV444P16BE,
92         PIX_FMT_YUV444P,      PIX_FMT_YUV422P,
93         PIX_FMT_YUV420P,      PIX_FMT_YUV411P,
94         PIX_FMT_YUV410P,      PIX_FMT_YUV440P,
95         PIX_FMT_YUVJ444P,     PIX_FMT_YUVJ422P,
96         PIX_FMT_YUVJ420P,     PIX_FMT_YUVJ440P,
97         PIX_FMT_YUVA420P,
98         PIX_FMT_RGB8,         PIX_FMT_BGR8,
99         PIX_FMT_RGB4_BYTE,    PIX_FMT_BGR4_BYTE,
100         PIX_FMT_PAL8,         PIX_FMT_GRAY8,
101         PIX_FMT_NONE
102     };
103
104     avfilter_set_common_formats(ctx, avfilter_make_format_list(pix_fmts));
105
106     return 0;
107 }
108
109 static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)
110 {
111     CropContext *crop = ctx->priv;
112
113     av_strlcpy(crop->ow_expr, "iw", sizeof(crop->ow_expr));
114     av_strlcpy(crop->oh_expr, "ih", sizeof(crop->oh_expr));
115     av_strlcpy(crop->x_expr, "(in_w-out_w)/2", sizeof(crop->x_expr));
116     av_strlcpy(crop->y_expr, "(in_h-out_h)/2", sizeof(crop->y_expr));
117
118     if (args)
119         sscanf(args, "%255[^:]:%255[^:]:%255[^:]:%255[^:]", crop->ow_expr, crop->oh_expr, crop->x_expr, crop->y_expr);
120
121     return 0;
122 }
123
124 static av_cold void uninit(AVFilterContext *ctx)
125 {
126     CropContext *crop = ctx->priv;
127
128     av_free_expr(crop->x_pexpr); crop->x_pexpr = NULL;
129     av_free_expr(crop->y_pexpr); crop->y_pexpr = NULL;
130 }
131
132 static inline int normalize_double(int *n, double d)
133 {
134     int ret = 0;
135
136     if (isnan(d)) {
137         ret = AVERROR(EINVAL);
138     } else if (d > INT_MAX || d < INT_MIN) {
139         *n = d > INT_MAX ? INT_MAX : INT_MIN;
140         ret = AVERROR(EINVAL);
141     } else
142         *n = round(d);
143
144     return ret;
145 }
146
147 static int config_input(AVFilterLink *link)
148 {
149     AVFilterContext *ctx = link->dst;
150     CropContext *crop = ctx->priv;
151     const AVPixFmtDescriptor *pix_desc = &av_pix_fmt_descriptors[link->format];
152     int ret;
153     const char *expr;
154     double res;
155
156     crop->var_values[VAR_E]     = M_E;
157     crop->var_values[VAR_PHI]   = M_PHI;
158     crop->var_values[VAR_PI]    = M_PI;
159     crop->var_values[VAR_IN_W]  = crop->var_values[VAR_IW] = ctx->inputs[0]->w;
160     crop->var_values[VAR_IN_H]  = crop->var_values[VAR_IH] = ctx->inputs[0]->h;
161     crop->var_values[VAR_X]     = NAN;
162     crop->var_values[VAR_Y]     = NAN;
163     crop->var_values[VAR_OUT_W] = crop->var_values[VAR_OW] = NAN;
164     crop->var_values[VAR_OUT_H] = crop->var_values[VAR_OH] = NAN;
165     crop->var_values[VAR_N]     = 0;
166     crop->var_values[VAR_T]     = NAN;
167     crop->var_values[VAR_POS]   = NAN;
168
169     av_image_fill_max_pixsteps(crop->max_step, NULL, pix_desc);
170     crop->hsub = av_pix_fmt_descriptors[link->format].log2_chroma_w;
171     crop->vsub = av_pix_fmt_descriptors[link->format].log2_chroma_h;
172
173     if ((ret = av_parse_and_eval_expr(&res, (expr = crop->ow_expr),
174                                       var_names, crop->var_values,
175                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0) goto fail_expr;
176     crop->var_values[VAR_OUT_W] = crop->var_values[VAR_OW] = res;
177     if ((ret = av_parse_and_eval_expr(&res, (expr = crop->oh_expr),
178                                       var_names, crop->var_values,
179                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0) goto fail_expr;
180     crop->var_values[VAR_OUT_H] = crop->var_values[VAR_OH] = res;
181     /* evaluate again ow as it may depend on oh */
182     if ((ret = av_parse_and_eval_expr(&res, (expr = crop->ow_expr),
183                                       var_names, crop->var_values,
184                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0) goto fail_expr;
185     crop->var_values[VAR_OUT_W] = crop->var_values[VAR_OW] = res;
186     if (normalize_double(&crop->w, crop->var_values[VAR_OUT_W]) < 0 ||
187         normalize_double(&crop->h, crop->var_values[VAR_OUT_H]) < 0) {
188         av_log(ctx, AV_LOG_ERROR,
189                "Too big value or invalid expression for out_w/ow or out_h/oh. "
190                "Maybe the expression for out_w:'%s' or for out_h:'%s' is self-referencing.\n",
191                crop->ow_expr, crop->oh_expr);
192         return AVERROR(EINVAL);
193     }
194     crop->w &= ~((1 << crop->hsub) - 1);
195     crop->h &= ~((1 << crop->vsub) - 1);
196
197     if ((ret = av_parse_expr(&crop->x_pexpr, crop->x_expr, var_names,
198                              NULL, NULL, NULL, NULL, 0, ctx)) < 0 ||
199         (ret = av_parse_expr(&crop->y_pexpr, crop->y_expr, var_names,
200                              NULL, NULL, NULL, NULL, 0, ctx)) < 0)
201         return AVERROR(EINVAL);
202
203     if (crop->w <= 0 || crop->h <= 0 ||
204         crop->w > link->w || crop->h > link->h) {
205         av_log(ctx, AV_LOG_ERROR,
206                "Invalid too big or non positive size for width '%d' or height '%d'\n",
207                crop->w, crop->h);
208         return AVERROR(EINVAL);
209     }
210
211     /* set default, required in the case the first computed value for x/y is NAN */
212     crop->x = (link->w - crop->w) / 2;
213     crop->y = (link->h - crop->h) / 2;
214     crop->x &= ~((1 << crop->hsub) - 1);
215     crop->y &= ~((1 << crop->vsub) - 1);
216     return 0;
217
218 fail_expr:
219     av_log(NULL, AV_LOG_ERROR, "Error when evaluating the expression '%s'\n", expr);
220     return ret;
221 }
222
223 static int config_output(AVFilterLink *link)
224 {
225     CropContext *crop = link->src->priv;
226
227     link->w = crop->w;
228     link->h = crop->h;
229
230     return 0;
231 }
232
233 static void start_frame(AVFilterLink *link, AVFilterBufferRef *picref)
234 {
235     AVFilterContext *ctx = link->dst;
236     CropContext *crop = ctx->priv;
237     AVFilterBufferRef *ref2 = avfilter_ref_buffer(picref, ~0);
238     int i;
239
240     picref->video->w = crop->w;
241     picref->video->h = crop->h;
242
243     crop->var_values[VAR_T] = picref->pts == AV_NOPTS_VALUE ?
244         NAN : picref->pts * av_q2d(link->time_base);
245     crop->var_values[VAR_POS] = picref->pos == -1 ? NAN : picref->pos;
246     crop->var_values[VAR_X] = av_eval_expr(crop->x_pexpr, crop->var_values, NULL);
247     crop->var_values[VAR_Y] = av_eval_expr(crop->y_pexpr, crop->var_values, NULL);
248     crop->var_values[VAR_X] = av_eval_expr(crop->x_pexpr, crop->var_values, NULL);
249
250     normalize_double(&crop->x, crop->var_values[VAR_X]);
251     normalize_double(&crop->y, crop->var_values[VAR_Y]);
252
253     if (crop->x < 0) crop->x = 0;
254     if (crop->y < 0) crop->y = 0;
255     if ((unsigned)crop->x + (unsigned)crop->w > link->w) crop->x = link->w - crop->w;
256     if ((unsigned)crop->y + (unsigned)crop->h > link->h) crop->y = link->h - crop->h;
257     crop->x &= ~((1 << crop->hsub) - 1);
258     crop->y &= ~((1 << crop->vsub) - 1);
259
260     av_log(ctx, AV_LOG_DEBUG,
261            "n:%d t:%f x:%d y:%d x+w:%d y+h:%d\n",
262            (int)crop->var_values[VAR_N], crop->var_values[VAR_T], crop->x, crop->y, crop->x+crop->w, crop->y+crop->h);
263
264     ref2->data[0] += crop->y * ref2->linesize[0];
265     ref2->data[0] += crop->x * crop->max_step[0];
266
267     if (!(av_pix_fmt_descriptors[link->format].flags & PIX_FMT_PAL)) {
268         for (i = 1; i < 3; i ++) {
269             if (ref2->data[i]) {
270                 ref2->data[i] += (crop->y >> crop->vsub) * ref2->linesize[i];
271                 ref2->data[i] += (crop->x * crop->max_step[i]) >> crop->hsub;
272             }
273         }
274     }
275
276     /* alpha plane */
277     if (ref2->data[3]) {
278         ref2->data[3] += crop->y * ref2->linesize[3];
279         ref2->data[3] += crop->x * crop->max_step[3];
280     }
281
282     avfilter_start_frame(link->dst->outputs[0], ref2);
283 }
284
285 static void draw_slice(AVFilterLink *link, int y, int h, int slice_dir)
286 {
287     AVFilterContext *ctx = link->dst;
288     CropContext *crop = ctx->priv;
289
290     if (y >= crop->y + crop->h || y + h <= crop->y)
291         return;
292
293     if (y < crop->y) {
294         h -= crop->y - y;
295         y  = crop->y;
296     }
297     if (y + h > crop->y + crop->h)
298         h = crop->y + crop->h - y;
299
300     avfilter_draw_slice(ctx->outputs[0], y - crop->y, h, slice_dir);
301 }
302
303 static void end_frame(AVFilterLink *link)
304 {
305     CropContext *crop = link->dst->priv;
306
307     crop->var_values[VAR_N] += 1.0;
308     avfilter_unref_buffer(link->cur_buf);
309     avfilter_end_frame(link->dst->outputs[0]);
310 }
311
312 AVFilter avfilter_vf_crop = {
313     .name      = "crop",
314     .description = NULL_IF_CONFIG_SMALL("Crop the input video to width:height:x:y."),
315
316     .priv_size = sizeof(CropContext),
317
318     .query_formats = query_formats,
319     .init          = init,
320     .uninit        = uninit,
321
322     .inputs    = (AVFilterPad[]) {{ .name             = "default",
323                                     .type             = AVMEDIA_TYPE_VIDEO,
324                                     .start_frame      = start_frame,
325                                     .draw_slice       = draw_slice,
326                                     .end_frame        = end_frame,
327                                     .get_video_buffer = avfilter_null_get_video_buffer,
328                                     .config_props     = config_input, },
329                                   { .name = NULL}},
330     .outputs   = (AVFilterPad[]) {{ .name             = "default",
331                                     .type             = AVMEDIA_TYPE_VIDEO,
332                                     .config_props     = config_output, },
333                                   { .name = NULL}},
334 };