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