Remove commented-out debug #define cruft
[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 #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     "E",
42     "PHI",
43     "PI",
44     "in_w", "iw",   ///< width  of the input video
45     "in_h", "ih",   ///< height of the input video
46     "out_w", "ow",  ///< width  of the cropped video
47     "out_h", "oh",  ///< height of the cropped video
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_E,
58     VAR_PHI,
59     VAR_PI,
60     VAR_IN_W,  VAR_IW,
61     VAR_IN_H,  VAR_IH,
62     VAR_OUT_W, VAR_OW,
63     VAR_OUT_H, VAR_OH,
64     VAR_X,
65     VAR_Y,
66     VAR_N,
67     VAR_T,
68     VAR_VARS_NB
69 };
70
71 typedef struct {
72     const AVClass *class;
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, *y_expr, *ow_expr, *oh_expr;
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 void uninit(AVFilterContext *ctx)
119 {
120     CropContext *crop = ctx->priv;
121
122     av_expr_free(crop->x_pexpr); crop->x_pexpr = NULL;
123     av_expr_free(crop->y_pexpr); crop->y_pexpr = NULL;
124 }
125
126 static inline int normalize_double(int *n, double d)
127 {
128     int ret = 0;
129
130     if (isnan(d)) {
131         ret = AVERROR(EINVAL);
132     } else if (d > INT_MAX || d < INT_MIN) {
133         *n = d > INT_MAX ? INT_MAX : INT_MIN;
134         ret = AVERROR(EINVAL);
135     } else
136         *n = round(d);
137
138     return ret;
139 }
140
141 static int config_input(AVFilterLink *link)
142 {
143     AVFilterContext *ctx = link->dst;
144     CropContext *crop = ctx->priv;
145     const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(link->format);
146     int ret;
147     const char *expr;
148     double res;
149
150     crop->var_values[VAR_E]     = M_E;
151     crop->var_values[VAR_PHI]   = M_PHI;
152     crop->var_values[VAR_PI]    = M_PI;
153     crop->var_values[VAR_IN_W]  = crop->var_values[VAR_IW] = ctx->inputs[0]->w;
154     crop->var_values[VAR_IN_H]  = crop->var_values[VAR_IH] = ctx->inputs[0]->h;
155     crop->var_values[VAR_X]     = NAN;
156     crop->var_values[VAR_Y]     = NAN;
157     crop->var_values[VAR_OUT_W] = crop->var_values[VAR_OW] = NAN;
158     crop->var_values[VAR_OUT_H] = crop->var_values[VAR_OH] = NAN;
159     crop->var_values[VAR_N]     = 0;
160     crop->var_values[VAR_T]     = NAN;
161
162     av_image_fill_max_pixsteps(crop->max_step, NULL, pix_desc);
163     crop->hsub = pix_desc->log2_chroma_w;
164     crop->vsub = pix_desc->log2_chroma_h;
165
166     if ((ret = av_expr_parse_and_eval(&res, (expr = crop->ow_expr),
167                                       var_names, crop->var_values,
168                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0) goto fail_expr;
169     crop->var_values[VAR_OUT_W] = crop->var_values[VAR_OW] = res;
170     if ((ret = av_expr_parse_and_eval(&res, (expr = crop->oh_expr),
171                                       var_names, crop->var_values,
172                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0) goto fail_expr;
173     crop->var_values[VAR_OUT_H] = crop->var_values[VAR_OH] = res;
174     /* evaluate again ow as it may depend on oh */
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 (normalize_double(&crop->w, crop->var_values[VAR_OUT_W]) < 0 ||
180         normalize_double(&crop->h, crop->var_values[VAR_OUT_H]) < 0) {
181         av_log(ctx, AV_LOG_ERROR,
182                "Too big value or invalid expression for out_w/ow or out_h/oh. "
183                "Maybe the expression for out_w:'%s' or for out_h:'%s' is self-referencing.\n",
184                crop->ow_expr, crop->oh_expr);
185         return AVERROR(EINVAL);
186     }
187     crop->w &= ~((1 << crop->hsub) - 1);
188     crop->h &= ~((1 << crop->vsub) - 1);
189
190     if ((ret = av_expr_parse(&crop->x_pexpr, crop->x_expr, var_names,
191                              NULL, NULL, NULL, NULL, 0, ctx)) < 0 ||
192         (ret = av_expr_parse(&crop->y_pexpr, crop->y_expr, var_names,
193                              NULL, NULL, NULL, NULL, 0, ctx)) < 0)
194         return AVERROR(EINVAL);
195
196     av_log(ctx, AV_LOG_VERBOSE, "w:%d h:%d -> w:%d h:%d\n",
197            link->w, link->h, crop->w, crop->h);
198
199     if (crop->w <= 0 || crop->h <= 0 ||
200         crop->w > link->w || crop->h > link->h) {
201         av_log(ctx, AV_LOG_ERROR,
202                "Invalid too big or non positive size for width '%d' or height '%d'\n",
203                crop->w, crop->h);
204         return AVERROR(EINVAL);
205     }
206
207     /* set default, required in the case the first computed value for x/y is NAN */
208     crop->x = (link->w - crop->w) / 2;
209     crop->y = (link->h - crop->h) / 2;
210     crop->x &= ~((1 << crop->hsub) - 1);
211     crop->y &= ~((1 << crop->vsub) - 1);
212     return 0;
213
214 fail_expr:
215     av_log(NULL, AV_LOG_ERROR, "Error when evaluating the expression '%s'\n", expr);
216     return ret;
217 }
218
219 static int config_output(AVFilterLink *link)
220 {
221     CropContext *crop = link->src->priv;
222
223     link->w = crop->w;
224     link->h = crop->h;
225
226     return 0;
227 }
228
229 static int filter_frame(AVFilterLink *link, AVFrame *frame)
230 {
231     AVFilterContext *ctx = link->dst;
232     CropContext *crop = ctx->priv;
233     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(link->format);
234     int i;
235
236     frame->width  = crop->w;
237     frame->height = crop->h;
238
239     crop->var_values[VAR_T] = frame->pts == AV_NOPTS_VALUE ?
240         NAN : frame->pts * av_q2d(link->time_base);
241     crop->var_values[VAR_X] = av_expr_eval(crop->x_pexpr, crop->var_values, NULL);
242     crop->var_values[VAR_Y] = av_expr_eval(crop->y_pexpr, crop->var_values, NULL);
243     crop->var_values[VAR_X] = av_expr_eval(crop->x_pexpr, crop->var_values, NULL);
244
245     normalize_double(&crop->x, crop->var_values[VAR_X]);
246     normalize_double(&crop->y, crop->var_values[VAR_Y]);
247
248     if (crop->x < 0) crop->x = 0;
249     if (crop->y < 0) crop->y = 0;
250     if ((unsigned)crop->x + (unsigned)crop->w > link->w) crop->x = link->w - crop->w;
251     if ((unsigned)crop->y + (unsigned)crop->h > link->h) crop->y = link->h - crop->h;
252     crop->x &= ~((1 << crop->hsub) - 1);
253     crop->y &= ~((1 << crop->vsub) - 1);
254
255     av_dlog(ctx, "n:%d t:%f x:%d y:%d x+w:%d y+h:%d\n",
256             (int)crop->var_values[VAR_N], crop->var_values[VAR_T], crop->x,
257             crop->y, crop->x+crop->w, crop->y+crop->h);
258
259     frame->data[0] += crop->y * frame->linesize[0];
260     frame->data[0] += crop->x * crop->max_step[0];
261
262     if (!(desc->flags & AV_PIX_FMT_FLAG_PAL || desc->flags & AV_PIX_FMT_FLAG_PSEUDOPAL)) {
263         for (i = 1; i < 3; i ++) {
264             if (frame->data[i]) {
265                 frame->data[i] += (crop->y >> crop->vsub) * frame->linesize[i];
266                 frame->data[i] += (crop->x * crop->max_step[i]) >> crop->hsub;
267             }
268         }
269     }
270
271     /* alpha plane */
272     if (frame->data[3]) {
273         frame->data[3] += crop->y * frame->linesize[3];
274         frame->data[3] += crop->x * crop->max_step[3];
275     }
276
277     crop->var_values[VAR_N] += 1.0;
278
279     return ff_filter_frame(link->dst->outputs[0], frame);
280 }
281
282 #define OFFSET(x) offsetof(CropContext, x)
283 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM
284 static const AVOption options[] = {
285     { "out_w", "Output video width",  OFFSET(ow_expr), AV_OPT_TYPE_STRING, { .str = "iw" },                 .flags = FLAGS },
286     { "out_h", "Output video height", OFFSET(oh_expr), AV_OPT_TYPE_STRING, { .str = "ih" },                 .flags = FLAGS },
287     { "x",     "Horizontal position in the input video of the left edge of the cropped output video",
288                                       OFFSET(x_expr),  AV_OPT_TYPE_STRING, { .str = "(in_w - out_w) / 2" }, .flags = FLAGS },
289     { "y",     "Vertical position in the input video of the top edge of the cropped output video",
290                                       OFFSET(y_expr),  AV_OPT_TYPE_STRING, { .str = "(in_h - out_h) / 2" }, .flags = FLAGS },
291     { NULL },
292 };
293
294 static const AVClass crop_class = {
295     .class_name = "crop",
296     .item_name  = av_default_item_name,
297     .option     = options,
298     .version    = LIBAVUTIL_VERSION_INT,
299 };
300
301 static const AVFilterPad avfilter_vf_crop_inputs[] = {
302     {
303         .name             = "default",
304         .type             = AVMEDIA_TYPE_VIDEO,
305         .filter_frame     = filter_frame,
306         .get_video_buffer = ff_null_get_video_buffer,
307         .config_props     = config_input,
308     },
309     { NULL }
310 };
311
312 static const AVFilterPad avfilter_vf_crop_outputs[] = {
313     {
314         .name         = "default",
315         .type         = AVMEDIA_TYPE_VIDEO,
316         .config_props = config_output,
317     },
318     { NULL }
319 };
320
321 AVFilter avfilter_vf_crop = {
322     .name      = "crop",
323     .description = NULL_IF_CONFIG_SMALL("Crop the input video to width:height:x:y."),
324
325     .priv_size = sizeof(CropContext),
326     .priv_class = &crop_class,
327
328     .query_formats = query_formats,
329     .uninit        = uninit,
330
331     .inputs    = avfilter_vf_crop_inputs,
332     .outputs   = avfilter_vf_crop_outputs,
333 };