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