avcodec/cbs_av1: avoid reading trailing bits when obu type is OBU_TILE_LIST
[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 #include <stdio.h>
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/internal.h"
35 #include "libavutil/libm.h"
36 #include "libavutil/imgutils.h"
37 #include "libavutil/mathematics.h"
38 #include "libavutil/opt.h"
39
40 static const char *const var_names[] = {
41     "in_w", "iw",   ///< width  of the input video
42     "in_h", "ih",   ///< height of the input video
43     "out_w", "ow",  ///< width  of the cropped video
44     "out_h", "oh",  ///< height of the cropped video
45     "a",
46     "sar",
47     "dar",
48     "hsub",
49     "vsub",
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_IN_W,  VAR_IW,
60     VAR_IN_H,  VAR_IH,
61     VAR_OUT_W, VAR_OW,
62     VAR_OUT_H, VAR_OH,
63     VAR_A,
64     VAR_SAR,
65     VAR_DAR,
66     VAR_HSUB,
67     VAR_VSUB,
68     VAR_X,
69     VAR_Y,
70     VAR_N,
71     VAR_POS,
72     VAR_T,
73     VAR_VARS_NB
74 };
75
76 typedef struct CropContext {
77     const AVClass *class;
78     int  x;             ///< x offset of the non-cropped area with respect to the input area
79     int  y;             ///< y offset of the non-cropped area with respect to the input area
80     int  w;             ///< width of the cropped area
81     int  h;             ///< height of the cropped area
82
83     AVRational out_sar; ///< output sample aspect ratio
84     int keep_aspect;    ///< keep display aspect ratio when cropping
85     int exact;          ///< exact cropping, for subsampled formats
86
87     int max_step[4];    ///< max pixel step for each plane, expressed as a number of bytes
88     int hsub, vsub;     ///< chroma subsampling
89     char *x_expr, *y_expr, *w_expr, *h_expr;
90     AVExpr *x_pexpr, *y_pexpr;  /* parsed expressions for x and y */
91     double var_values[VAR_VARS_NB];
92 } CropContext;
93
94 static int query_formats(AVFilterContext *ctx)
95 {
96     AVFilterFormats *formats = NULL;
97     int fmt, ret;
98
99     for (fmt = 0; av_pix_fmt_desc_get(fmt); fmt++) {
100         const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(fmt);
101         if (desc->flags & AV_PIX_FMT_FLAG_BITSTREAM)
102             continue;
103         if (!(desc->flags & AV_PIX_FMT_FLAG_HWACCEL)) {
104             // Not usable if there is any subsampling but the format is
105             // not planar (e.g. YUYV422).
106             if ((desc->log2_chroma_w || desc->log2_chroma_h) &&
107                 !(desc->flags & AV_PIX_FMT_FLAG_PLANAR))
108                 continue;
109         }
110         ret = ff_add_format(&formats, fmt);
111         if (ret < 0)
112             return ret;
113     }
114
115     return ff_set_common_formats(ctx, formats);
116 }
117
118 static av_cold void uninit(AVFilterContext *ctx)
119 {
120     CropContext *s = ctx->priv;
121
122     av_expr_free(s->x_pexpr);
123     s->x_pexpr = NULL;
124     av_expr_free(s->y_pexpr);
125     s->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 = lrint(d);
139
140     return ret;
141 }
142
143 static int config_input(AVFilterLink *link)
144 {
145     AVFilterContext *ctx = link->dst;
146     CropContext *s = 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     s->var_values[VAR_IN_W]  = s->var_values[VAR_IW] = ctx->inputs[0]->w;
153     s->var_values[VAR_IN_H]  = s->var_values[VAR_IH] = ctx->inputs[0]->h;
154     s->var_values[VAR_A]     = (float) link->w / link->h;
155     s->var_values[VAR_SAR]   = link->sample_aspect_ratio.num ? av_q2d(link->sample_aspect_ratio) : 1;
156     s->var_values[VAR_DAR]   = s->var_values[VAR_A] * s->var_values[VAR_SAR];
157     s->var_values[VAR_HSUB]  = 1<<pix_desc->log2_chroma_w;
158     s->var_values[VAR_VSUB]  = 1<<pix_desc->log2_chroma_h;
159     s->var_values[VAR_X]     = NAN;
160     s->var_values[VAR_Y]     = NAN;
161     s->var_values[VAR_OUT_W] = s->var_values[VAR_OW] = NAN;
162     s->var_values[VAR_OUT_H] = s->var_values[VAR_OH] = NAN;
163     s->var_values[VAR_N]     = 0;
164     s->var_values[VAR_T]     = NAN;
165     s->var_values[VAR_POS]   = NAN;
166
167     av_image_fill_max_pixsteps(s->max_step, NULL, pix_desc);
168
169     if (pix_desc->flags & AV_PIX_FMT_FLAG_HWACCEL) {
170         s->hsub = 1;
171         s->vsub = 1;
172     } else {
173         s->hsub = pix_desc->log2_chroma_w;
174         s->vsub = pix_desc->log2_chroma_h;
175     }
176
177     av_expr_parse_and_eval(&res, (expr = s->w_expr),
178                            var_names, s->var_values,
179                            NULL, NULL, NULL, NULL, NULL, 0, ctx);
180     s->var_values[VAR_OUT_W] = s->var_values[VAR_OW] = res;
181     if ((ret = av_expr_parse_and_eval(&res, (expr = s->h_expr),
182                                       var_names, s->var_values,
183                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
184         goto fail_expr;
185     s->var_values[VAR_OUT_H] = s->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 = s->w_expr),
188                                       var_names, s->var_values,
189                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
190         goto fail_expr;
191
192     s->var_values[VAR_OUT_W] = s->var_values[VAR_OW] = res;
193     if (normalize_double(&s->w, s->var_values[VAR_OUT_W]) < 0 ||
194         normalize_double(&s->h, s->var_values[VAR_OUT_H]) < 0) {
195         av_log(ctx, AV_LOG_ERROR,
196                "Too big value or invalid expression for out_w/ow or out_h/oh. "
197                "Maybe the expression for out_w:'%s' or for out_h:'%s' is self-referencing.\n",
198                s->w_expr, s->h_expr);
199         return AVERROR(EINVAL);
200     }
201
202     if (!s->exact) {
203         s->w &= ~((1 << s->hsub) - 1);
204         s->h &= ~((1 << s->vsub) - 1);
205     }
206
207     av_expr_free(s->x_pexpr);
208     av_expr_free(s->y_pexpr);
209     s->x_pexpr = s->y_pexpr = NULL;
210     if ((ret = av_expr_parse(&s->x_pexpr, s->x_expr, var_names,
211                              NULL, NULL, NULL, NULL, 0, ctx)) < 0 ||
212         (ret = av_expr_parse(&s->y_pexpr, s->y_expr, var_names,
213                              NULL, NULL, NULL, NULL, 0, ctx)) < 0)
214         return AVERROR(EINVAL);
215
216     if (s->keep_aspect) {
217         AVRational dar = av_mul_q(link->sample_aspect_ratio,
218                                   (AVRational){ link->w, link->h });
219         av_reduce(&s->out_sar.num, &s->out_sar.den,
220                   dar.num * s->h, dar.den * s->w, INT_MAX);
221     } else
222         s->out_sar = link->sample_aspect_ratio;
223
224     av_log(ctx, AV_LOG_VERBOSE, "w:%d h:%d sar:%d/%d -> w:%d h:%d sar:%d/%d\n",
225            link->w, link->h, link->sample_aspect_ratio.num, link->sample_aspect_ratio.den,
226            s->w, s->h, s->out_sar.num, s->out_sar.den);
227
228     if (s->w <= 0 || s->h <= 0 ||
229         s->w > link->w || s->h > link->h) {
230         av_log(ctx, AV_LOG_ERROR,
231                "Invalid too big or non positive size for width '%d' or height '%d'\n",
232                s->w, s->h);
233         return AVERROR(EINVAL);
234     }
235
236     /* set default, required in the case the first computed value for x/y is NAN */
237     s->x = (link->w - s->w) / 2;
238     s->y = (link->h - s->h) / 2;
239     if (!s->exact) {
240         s->x &= ~((1 << s->hsub) - 1);
241         s->y &= ~((1 << s->vsub) - 1);
242     }
243     return 0;
244
245 fail_expr:
246     av_log(ctx, AV_LOG_ERROR, "Error when evaluating the expression '%s'\n", expr);
247     return ret;
248 }
249
250 static int config_output(AVFilterLink *link)
251 {
252     CropContext *s = link->src->priv;
253     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(link->format);
254
255     if (desc->flags & AV_PIX_FMT_FLAG_HWACCEL) {
256         // Hardware frames adjust the cropping regions rather than
257         // changing the frame size.
258     } else {
259         link->w = s->w;
260         link->h = s->h;
261     }
262     link->sample_aspect_ratio = s->out_sar;
263
264     return 0;
265 }
266
267 static int filter_frame(AVFilterLink *link, AVFrame *frame)
268 {
269     AVFilterContext *ctx = link->dst;
270     CropContext *s = ctx->priv;
271     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(link->format);
272     int i;
273
274     s->var_values[VAR_N] = link->frame_count_out;
275     s->var_values[VAR_T] = frame->pts == AV_NOPTS_VALUE ?
276         NAN : frame->pts * av_q2d(link->time_base);
277     s->var_values[VAR_POS] = frame->pkt_pos == -1 ?
278         NAN : frame->pkt_pos;
279     s->var_values[VAR_X] = av_expr_eval(s->x_pexpr, s->var_values, NULL);
280     s->var_values[VAR_Y] = av_expr_eval(s->y_pexpr, s->var_values, NULL);
281     /* It is necessary if x is expressed from y  */
282     s->var_values[VAR_X] = av_expr_eval(s->x_pexpr, s->var_values, NULL);
283
284     normalize_double(&s->x, s->var_values[VAR_X]);
285     normalize_double(&s->y, s->var_values[VAR_Y]);
286
287     if (s->x < 0)
288         s->x = 0;
289     if (s->y < 0)
290         s->y = 0;
291     if ((unsigned)s->x + (unsigned)s->w > link->w)
292         s->x = link->w - s->w;
293     if ((unsigned)s->y + (unsigned)s->h > link->h)
294         s->y = link->h - s->h;
295     if (!s->exact) {
296         s->x &= ~((1 << s->hsub) - 1);
297         s->y &= ~((1 << s->vsub) - 1);
298     }
299
300     av_log(ctx, AV_LOG_TRACE, "n:%d t:%f pos:%f x:%d y:%d x+w:%d y+h:%d\n",
301             (int)s->var_values[VAR_N], s->var_values[VAR_T], s->var_values[VAR_POS],
302             s->x, s->y, s->x+s->w, s->y+s->h);
303
304     if (desc->flags & AV_PIX_FMT_FLAG_HWACCEL) {
305         frame->crop_top   += s->y;
306         frame->crop_left  += s->x;
307         frame->crop_bottom = frame->height - frame->crop_top - frame->crop_bottom - s->h;
308         frame->crop_right  = frame->width  - frame->crop_left - frame->crop_right - s->w;
309     } else {
310         frame->width  = s->w;
311         frame->height = s->h;
312
313         frame->data[0] += s->y * frame->linesize[0];
314         frame->data[0] += s->x * s->max_step[0];
315
316         if (!(desc->flags & AV_PIX_FMT_FLAG_PAL || desc->flags & FF_PSEUDOPAL)) {
317             for (i = 1; i < 3; i ++) {
318                 if (frame->data[i]) {
319                     frame->data[i] += (s->y >> s->vsub) * frame->linesize[i];
320                     frame->data[i] += (s->x * s->max_step[i]) >> s->hsub;
321                 }
322             }
323         }
324
325         /* alpha plane */
326         if (frame->data[3]) {
327             frame->data[3] += s->y * frame->linesize[3];
328             frame->data[3] += s->x * s->max_step[3];
329         }
330     }
331
332     return ff_filter_frame(link->dst->outputs[0], frame);
333 }
334
335 static int process_command(AVFilterContext *ctx, const char *cmd, const char *args,
336                            char *res, int res_len, int flags)
337 {
338     CropContext *s = ctx->priv;
339     int ret;
340
341     if (   !strcmp(cmd, "out_w")  || !strcmp(cmd, "w")
342         || !strcmp(cmd, "out_h")  || !strcmp(cmd, "h")
343         || !strcmp(cmd, "x")      || !strcmp(cmd, "y")) {
344
345         int old_x = s->x;
346         int old_y = s->y;
347         int old_w = s->w;
348         int old_h = s->h;
349
350         AVFilterLink *outlink = ctx->outputs[0];
351         AVFilterLink *inlink  = ctx->inputs[0];
352
353         av_opt_set(s, cmd, args, 0);
354
355         if ((ret = config_input(inlink)) < 0) {
356             s->x = old_x;
357             s->y = old_y;
358             s->w = old_w;
359             s->h = old_h;
360             return ret;
361         }
362
363         ret = config_output(outlink);
364
365     } else
366         ret = AVERROR(ENOSYS);
367
368     return ret;
369 }
370
371 #define OFFSET(x) offsetof(CropContext, x)
372 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
373
374 static const AVOption crop_options[] = {
375     { "out_w",       "set the width crop area expression",   OFFSET(w_expr), AV_OPT_TYPE_STRING, {.str = "iw"}, CHAR_MIN, CHAR_MAX, FLAGS },
376     { "w",           "set the width crop area expression",   OFFSET(w_expr), AV_OPT_TYPE_STRING, {.str = "iw"}, CHAR_MIN, CHAR_MAX, FLAGS },
377     { "out_h",       "set the height crop area expression",  OFFSET(h_expr), AV_OPT_TYPE_STRING, {.str = "ih"}, CHAR_MIN, CHAR_MAX, FLAGS },
378     { "h",           "set the height crop area expression",  OFFSET(h_expr), AV_OPT_TYPE_STRING, {.str = "ih"}, CHAR_MIN, CHAR_MAX, FLAGS },
379     { "x",           "set the x crop area expression",       OFFSET(x_expr), AV_OPT_TYPE_STRING, {.str = "(in_w-out_w)/2"}, CHAR_MIN, CHAR_MAX, FLAGS },
380     { "y",           "set the y crop area expression",       OFFSET(y_expr), AV_OPT_TYPE_STRING, {.str = "(in_h-out_h)/2"}, CHAR_MIN, CHAR_MAX, FLAGS },
381     { "keep_aspect", "keep aspect ratio",                    OFFSET(keep_aspect), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS },
382     { "exact",       "do exact cropping",                    OFFSET(exact),  AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS },
383     { NULL }
384 };
385
386 AVFILTER_DEFINE_CLASS(crop);
387
388 static const AVFilterPad avfilter_vf_crop_inputs[] = {
389     {
390         .name         = "default",
391         .type         = AVMEDIA_TYPE_VIDEO,
392         .filter_frame = filter_frame,
393         .config_props = config_input,
394     },
395     { NULL }
396 };
397
398 static const AVFilterPad avfilter_vf_crop_outputs[] = {
399     {
400         .name         = "default",
401         .type         = AVMEDIA_TYPE_VIDEO,
402         .config_props = config_output,
403     },
404     { NULL }
405 };
406
407 AVFilter ff_vf_crop = {
408     .name            = "crop",
409     .description     = NULL_IF_CONFIG_SMALL("Crop the input video."),
410     .priv_size       = sizeof(CropContext),
411     .priv_class      = &crop_class,
412     .query_formats   = query_formats,
413     .uninit          = uninit,
414     .inputs          = avfilter_vf_crop_inputs,
415     .outputs         = avfilter_vf_crop_outputs,
416     .process_command = process_command,
417 };