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