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