Merge commit '51def31dbe5b6e857536de8fa428f263d64f3ae5'
[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 /* #define DEBUG */
27
28 #include <stdio.h>
29
30 #include "avfilter.h"
31 #include "formats.h"
32 #include "internal.h"
33 #include "video.h"
34 #include "libavutil/eval.h"
35 #include "libavutil/avstring.h"
36 #include "libavutil/internal.h"
37 #include "libavutil/libm.h"
38 #include "libavutil/imgutils.h"
39 #include "libavutil/mathematics.h"
40 #include "libavutil/opt.h"
41
42 static const char *const var_names[] = {
43     "in_w", "iw",   ///< width  of the input video
44     "in_h", "ih",   ///< height of the input video
45     "out_w", "ow",  ///< width  of the cropped video
46     "out_h", "oh",  ///< height of the cropped video
47     "a",
48     "sar",
49     "dar",
50     "hsub",
51     "vsub",
52     "x",
53     "y",
54     "n",            ///< number of frame
55     "pos",          ///< position in the file
56     "t",            ///< timestamp expressed in seconds
57     NULL
58 };
59
60 enum var_name {
61     VAR_IN_W,  VAR_IW,
62     VAR_IN_H,  VAR_IH,
63     VAR_OUT_W, VAR_OW,
64     VAR_OUT_H, VAR_OH,
65     VAR_A,
66     VAR_SAR,
67     VAR_DAR,
68     VAR_HSUB,
69     VAR_VSUB,
70     VAR_X,
71     VAR_Y,
72     VAR_N,
73     VAR_T,
74     VAR_VARS_NB
75 };
76
77 typedef struct {
78     const AVClass *class;
79     int  x;             ///< x offset of the non-cropped area with respect to the input area
80     int  y;             ///< y offset of the non-cropped area with respect to the input area
81     int  w;             ///< width of the cropped area
82     int  h;             ///< height of the cropped area
83
84     AVRational out_sar; ///< output sample aspect ratio
85     int keep_aspect;    ///< keep display aspect ratio when cropping
86
87     int max_step[4];    ///< max pixel step for each plane, expressed as a number of bytes
88     int hsub, vsub;     ///< chroma subsampling
89     char *x_expr, *y_expr, *w_expr, *h_expr;
90     AVExpr *x_pexpr, *y_pexpr;  /* parsed expressions for x and y */
91     double var_values[VAR_VARS_NB];
92 } CropContext;
93
94 #define OFFSET(x) offsetof(CropContext, x)
95 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
96
97 static const AVOption crop_options[] = {
98     { "x",           "set the x crop area expression",       OFFSET(x_expr), AV_OPT_TYPE_STRING, {.str = "(in_w-out_w)/2"}, CHAR_MIN, CHAR_MAX, FLAGS },
99     { "y",           "set the y crop area expression",       OFFSET(y_expr), AV_OPT_TYPE_STRING, {.str = "(in_h-out_h)/2"}, CHAR_MIN, CHAR_MAX, FLAGS },
100     { "out_w",       "set the width crop area expression",   OFFSET(w_expr), AV_OPT_TYPE_STRING, {.str = "iw"}, CHAR_MIN, CHAR_MAX, FLAGS },
101     { "w",           "set the width crop area expression",   OFFSET(w_expr), AV_OPT_TYPE_STRING, {.str = "iw"}, CHAR_MIN, CHAR_MAX, FLAGS },
102     { "out_h",       "set the height crop area expression",  OFFSET(h_expr), AV_OPT_TYPE_STRING, {.str = "ih"}, CHAR_MIN, CHAR_MAX, FLAGS },
103     { "h",           "set the height crop area expression",  OFFSET(h_expr), AV_OPT_TYPE_STRING, {.str = "ih"}, CHAR_MIN, CHAR_MAX, FLAGS },
104     { "keep_aspect", "keep aspect ratio",                    OFFSET(keep_aspect), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS },
105     {NULL}
106 };
107
108 AVFILTER_DEFINE_CLASS(crop);
109
110 static av_cold void uninit(AVFilterContext *ctx)
111 {
112     CropContext *crop = ctx->priv;
113
114     av_expr_free(crop->x_pexpr); crop->x_pexpr = NULL;
115     av_expr_free(crop->y_pexpr); crop->y_pexpr = NULL;
116 }
117
118 static int query_formats(AVFilterContext *ctx)
119 {
120     static const enum AVPixelFormat pix_fmts[] = {
121         AV_PIX_FMT_RGB48BE,      AV_PIX_FMT_RGB48LE,
122         AV_PIX_FMT_BGR48BE,      AV_PIX_FMT_BGR48LE,
123         AV_PIX_FMT_ARGB,         AV_PIX_FMT_RGBA,
124         AV_PIX_FMT_ABGR,         AV_PIX_FMT_BGRA,
125         AV_PIX_FMT_RGB24,        AV_PIX_FMT_BGR24,
126         AV_PIX_FMT_RGB565BE,     AV_PIX_FMT_RGB565LE,
127         AV_PIX_FMT_RGB555BE,     AV_PIX_FMT_RGB555LE,
128         AV_PIX_FMT_BGR565BE,     AV_PIX_FMT_BGR565LE,
129         AV_PIX_FMT_BGR555BE,     AV_PIX_FMT_BGR555LE,
130         AV_PIX_FMT_GRAY16BE,     AV_PIX_FMT_GRAY16LE,
131         AV_PIX_FMT_YUV420P16LE,  AV_PIX_FMT_YUV420P16BE,
132         AV_PIX_FMT_YUV422P16LE,  AV_PIX_FMT_YUV422P16BE,
133         AV_PIX_FMT_YUV444P16LE,  AV_PIX_FMT_YUV444P16BE,
134         AV_PIX_FMT_YUV444P,      AV_PIX_FMT_YUV422P,
135         AV_PIX_FMT_YUV420P,      AV_PIX_FMT_YUV411P,
136         AV_PIX_FMT_YUV410P,      AV_PIX_FMT_YUV440P,
137         AV_PIX_FMT_YUVJ444P,     AV_PIX_FMT_YUVJ422P,
138         AV_PIX_FMT_YUVJ420P,     AV_PIX_FMT_YUVJ440P,
139         AV_PIX_FMT_YUVA420P,
140         AV_PIX_FMT_RGB8,         AV_PIX_FMT_BGR8,
141         AV_PIX_FMT_RGB4_BYTE,    AV_PIX_FMT_BGR4_BYTE,
142         AV_PIX_FMT_PAL8,         AV_PIX_FMT_GRAY8,
143         AV_PIX_FMT_NONE
144     };
145
146     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
147
148     return 0;
149 }
150
151 static inline int normalize_double(int *n, double d)
152 {
153     int ret = 0;
154
155     if (isnan(d)) {
156         ret = AVERROR(EINVAL);
157     } else if (d > INT_MAX || d < INT_MIN) {
158         *n = d > INT_MAX ? INT_MAX : INT_MIN;
159         ret = AVERROR(EINVAL);
160     } else
161         *n = round(d);
162
163     return ret;
164 }
165
166 static int config_input(AVFilterLink *link)
167 {
168     AVFilterContext *ctx = link->dst;
169     CropContext *crop = ctx->priv;
170     const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(link->format);
171     int ret;
172     const char *expr;
173     double res;
174
175     crop->var_values[VAR_IN_W]  = crop->var_values[VAR_IW] = ctx->inputs[0]->w;
176     crop->var_values[VAR_IN_H]  = crop->var_values[VAR_IH] = ctx->inputs[0]->h;
177     crop->var_values[VAR_A]     = (float) link->w / link->h;
178     crop->var_values[VAR_SAR]   = link->sample_aspect_ratio.num ? av_q2d(link->sample_aspect_ratio) : 1;
179     crop->var_values[VAR_DAR]   = crop->var_values[VAR_A] * crop->var_values[VAR_SAR];
180     crop->var_values[VAR_HSUB]  = 1<<pix_desc->log2_chroma_w;
181     crop->var_values[VAR_VSUB]  = 1<<pix_desc->log2_chroma_h;
182     crop->var_values[VAR_X]     = NAN;
183     crop->var_values[VAR_Y]     = NAN;
184     crop->var_values[VAR_OUT_W] = crop->var_values[VAR_OW] = NAN;
185     crop->var_values[VAR_OUT_H] = crop->var_values[VAR_OH] = NAN;
186     crop->var_values[VAR_N]     = 0;
187     crop->var_values[VAR_T]     = NAN;
188
189     av_image_fill_max_pixsteps(crop->max_step, NULL, pix_desc);
190     crop->hsub = pix_desc->log2_chroma_w;
191     crop->vsub = pix_desc->log2_chroma_h;
192
193     if ((ret = av_expr_parse_and_eval(&res, (expr = crop->w_expr),
194                                       var_names, crop->var_values,
195                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0) goto fail_expr;
196     crop->var_values[VAR_OUT_W] = crop->var_values[VAR_OW] = res;
197     if ((ret = av_expr_parse_and_eval(&res, (expr = crop->h_expr),
198                                       var_names, crop->var_values,
199                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0) goto fail_expr;
200     crop->var_values[VAR_OUT_H] = crop->var_values[VAR_OH] = res;
201     /* evaluate again ow as it may depend on oh */
202     if ((ret = av_expr_parse_and_eval(&res, (expr = crop->w_expr),
203                                       var_names, crop->var_values,
204                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0) goto fail_expr;
205     crop->var_values[VAR_OUT_W] = crop->var_values[VAR_OW] = res;
206     if (normalize_double(&crop->w, crop->var_values[VAR_OUT_W]) < 0 ||
207         normalize_double(&crop->h, crop->var_values[VAR_OUT_H]) < 0) {
208         av_log(ctx, AV_LOG_ERROR,
209                "Too big value or invalid expression for out_w/ow or out_h/oh. "
210                "Maybe the expression for out_w:'%s' or for out_h:'%s' is self-referencing.\n",
211                crop->w_expr, crop->h_expr);
212         return AVERROR(EINVAL);
213     }
214     crop->w &= ~((1 << crop->hsub) - 1);
215     crop->h &= ~((1 << crop->vsub) - 1);
216
217     if ((ret = av_expr_parse(&crop->x_pexpr, crop->x_expr, var_names,
218                              NULL, NULL, NULL, NULL, 0, ctx)) < 0 ||
219         (ret = av_expr_parse(&crop->y_pexpr, crop->y_expr, var_names,
220                              NULL, NULL, NULL, NULL, 0, ctx)) < 0)
221         return AVERROR(EINVAL);
222
223     if (crop->keep_aspect) {
224         AVRational dar = av_mul_q(link->sample_aspect_ratio,
225                                   (AVRational){ link->w, link->h });
226         av_reduce(&crop->out_sar.num, &crop->out_sar.den,
227                   dar.num * crop->h, dar.den * crop->w, INT_MAX);
228     } else
229         crop->out_sar = link->sample_aspect_ratio;
230
231     av_log(ctx, AV_LOG_VERBOSE, "w:%d h:%d sar:%d/%d -> w:%d h:%d sar:%d/%d\n",
232            link->w, link->h, link->sample_aspect_ratio.num, link->sample_aspect_ratio.den,
233            crop->w, crop->h, crop->out_sar.num, crop->out_sar.den);
234
235     if (crop->w <= 0 || crop->h <= 0 ||
236         crop->w > link->w || crop->h > link->h) {
237         av_log(ctx, AV_LOG_ERROR,
238                "Invalid too big or non positive size for width '%d' or height '%d'\n",
239                crop->w, crop->h);
240         return AVERROR(EINVAL);
241     }
242
243     /* set default, required in the case the first computed value for x/y is NAN */
244     crop->x = (link->w - crop->w) / 2;
245     crop->y = (link->h - crop->h) / 2;
246     crop->x &= ~((1 << crop->hsub) - 1);
247     crop->y &= ~((1 << crop->vsub) - 1);
248     return 0;
249
250 fail_expr:
251     av_log(NULL, AV_LOG_ERROR, "Error when evaluating the expression '%s'\n", expr);
252     return ret;
253 }
254
255 static int config_output(AVFilterLink *link)
256 {
257     CropContext *crop = link->src->priv;
258
259     link->w = crop->w;
260     link->h = crop->h;
261     link->sample_aspect_ratio = crop->out_sar;
262
263     return 0;
264 }
265
266 static int filter_frame(AVFilterLink *link, AVFrame *frame)
267 {
268     AVFilterContext *ctx = link->dst;
269     CropContext *crop = ctx->priv;
270     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(link->format);
271     int i;
272
273     frame->width  = crop->w;
274     frame->height = crop->h;
275
276     crop->var_values[VAR_T] = frame->pts == AV_NOPTS_VALUE ?
277         NAN : frame->pts * av_q2d(link->time_base);
278     crop->var_values[VAR_X] = av_expr_eval(crop->x_pexpr, crop->var_values, NULL);
279     crop->var_values[VAR_Y] = av_expr_eval(crop->y_pexpr, crop->var_values, NULL);
280     crop->var_values[VAR_X] = av_expr_eval(crop->x_pexpr, crop->var_values, NULL);
281
282     normalize_double(&crop->x, crop->var_values[VAR_X]);
283     normalize_double(&crop->y, crop->var_values[VAR_Y]);
284
285     if (crop->x < 0) crop->x = 0;
286     if (crop->y < 0) crop->y = 0;
287     if ((unsigned)crop->x + (unsigned)crop->w > link->w) crop->x = link->w - crop->w;
288     if ((unsigned)crop->y + (unsigned)crop->h > link->h) crop->y = link->h - crop->h;
289     crop->x &= ~((1 << crop->hsub) - 1);
290     crop->y &= ~((1 << crop->vsub) - 1);
291
292     av_dlog(ctx, "n:%d t:%f x:%d y:%d x+w:%d y+h:%d\n",
293             (int)crop->var_values[VAR_N], crop->var_values[VAR_T], crop->x,
294             crop->y, crop->x+crop->w, crop->y+crop->h);
295
296     frame->data[0] += crop->y * frame->linesize[0];
297     frame->data[0] += crop->x * crop->max_step[0];
298
299     if (!(desc->flags & PIX_FMT_PAL || desc->flags & PIX_FMT_PSEUDOPAL)) {
300         for (i = 1; i < 3; i ++) {
301             if (frame->data[i]) {
302                 frame->data[i] += (crop->y >> crop->vsub) * frame->linesize[i];
303                 frame->data[i] += (crop->x * crop->max_step[i]) >> crop->hsub;
304             }
305         }
306     }
307
308     /* alpha plane */
309     if (frame->data[3]) {
310         frame->data[3] += crop->y * frame->linesize[3];
311         frame->data[3] += crop->x * crop->max_step[3];
312     }
313
314     crop->var_values[VAR_N] += 1.0;
315
316     return ff_filter_frame(link->dst->outputs[0], frame);
317 }
318
319 static const AVFilterPad avfilter_vf_crop_inputs[] = {
320     {
321         .name             = "default",
322         .type             = AVMEDIA_TYPE_VIDEO,
323         .filter_frame     = filter_frame,
324         .get_video_buffer = ff_null_get_video_buffer,
325         .config_props     = config_input,
326     },
327     { NULL }
328 };
329
330 static const AVFilterPad avfilter_vf_crop_outputs[] = {
331     {
332         .name         = "default",
333         .type         = AVMEDIA_TYPE_VIDEO,
334         .config_props = config_output,
335     },
336     { NULL }
337 };
338
339 static const char *const shorthand[] = { "w", "h", "x", "y", "keep_aspect", NULL };
340
341 AVFilter avfilter_vf_crop = {
342     .name      = "crop",
343     .description = NULL_IF_CONFIG_SMALL("Crop the input video to width:height:x:y."),
344
345     .priv_size = sizeof(CropContext),
346
347     .query_formats = query_formats,
348     .uninit        = uninit,
349
350     .inputs    = avfilter_vf_crop_inputs,
351     .outputs   = avfilter_vf_crop_outputs,
352     .priv_class = &crop_class,
353     .shorthand = shorthand,
354 };