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