git.sesse.net Git - ffmpeg/blob - 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     if ((ret = av_expr_parse_and_eval(&res, (expr = s->w_expr),
 178                                       var_names, s->var_values,
 179                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
 180         goto fail_expr;
 181     s->var_values[VAR_OUT_W] = s->var_values[VAR_OW] = res;
 182     if ((ret = av_expr_parse_and_eval(&res, (expr = s->h_expr),
 183                                       var_names, s->var_values,
 184                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
 185         goto fail_expr;
 186     s->var_values[VAR_OUT_H] = s->var_values[VAR_OH] = res;
 187     /* evaluate again ow as it may depend on oh */
 188     if ((ret = av_expr_parse_and_eval(&res, (expr = s->w_expr),
 189                                       var_names, s->var_values,
 190                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
 191         goto fail_expr;
 192
 193     s->var_values[VAR_OUT_W] = s->var_values[VAR_OW] = res;
 194     if (normalize_double(&s->w, s->var_values[VAR_OUT_W]) < 0 ||
 195         normalize_double(&s->h, s->var_values[VAR_OUT_H]) < 0) {
 196         av_log(ctx, AV_LOG_ERROR,
 197                "Too big value or invalid expression for out_w/ow or out_h/oh. "
 198                "Maybe the expression for out_w:'%s' or for out_h:'%s' is self-referencing.\n",
 199                s->w_expr, s->h_expr);
 200         return AVERROR(EINVAL);
 201     }
 202
 203     if (!s->exact) {
 204         s->w &= ~((1 << s->hsub) - 1);
 205         s->h &= ~((1 << s->vsub) - 1);
 206     }
 207
 208     av_expr_free(s->x_pexpr);
 209     av_expr_free(s->y_pexpr);
 210     s->x_pexpr = s->y_pexpr = NULL;
 211     if ((ret = av_expr_parse(&s->x_pexpr, s->x_expr, var_names,
 212                              NULL, NULL, NULL, NULL, 0, ctx)) < 0 ||
 213         (ret = av_expr_parse(&s->y_pexpr, s->y_expr, var_names,
 214                              NULL, NULL, NULL, NULL, 0, ctx)) < 0)
 215         return AVERROR(EINVAL);
 216
 217     if (s->keep_aspect) {
 218         AVRational dar = av_mul_q(link->sample_aspect_ratio,
 219                                   (AVRational){ link->w, link->h });
 220         av_reduce(&s->out_sar.num, &s->out_sar.den,
 221                   dar.num * s->h, dar.den * s->w, INT_MAX);
 222     } else
 223         s->out_sar = link->sample_aspect_ratio;
 224
 225     av_log(ctx, AV_LOG_VERBOSE, "w:%d h:%d sar:%d/%d -> w:%d h:%d sar:%d/%d\n",
 226            link->w, link->h, link->sample_aspect_ratio.num, link->sample_aspect_ratio.den,
 227            s->w, s->h, s->out_sar.num, s->out_sar.den);
 228
 229     if (s->w <= 0 || s->h <= 0 ||
 230         s->w > link->w || s->h > link->h) {
 231         av_log(ctx, AV_LOG_ERROR,
 232                "Invalid too big or non positive size for width '%d' or height '%d'\n",
 233                s->w, s->h);
 234         return AVERROR(EINVAL);
 235     }
 236
 237     /* set default, required in the case the first computed value for x/y is NAN */
 238     s->x = (link->w - s->w) / 2;
 239     s->y = (link->h - s->h) / 2;
 240     if (!s->exact) {
 241         s->x &= ~((1 << s->hsub) - 1);
 242         s->y &= ~((1 << s->vsub) - 1);
 243     }
 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 *s = link->src->priv;
 254     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(link->format);
 255
 256     if (desc->flags & AV_PIX_FMT_FLAG_HWACCEL) {
 257         // Hardware frames adjust the cropping regions rather than
 258         // changing the frame size.
 259     } else {
 260         link->w = s->w;
 261         link->h = s->h;
 262     }
 263     link->sample_aspect_ratio = s->out_sar;
 264
 265     return 0;
 266 }
 267
 268 static int filter_frame(AVFilterLink *link, AVFrame *frame)
 269 {
 270     AVFilterContext *ctx = link->dst;
 271     CropContext *s = ctx->priv;
 272     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(link->format);
 273     int i;
 274
 275     s->var_values[VAR_N] = link->frame_count_out;
 276     s->var_values[VAR_T] = frame->pts == AV_NOPTS_VALUE ?
 277         NAN : frame->pts * av_q2d(link->time_base);
 278     s->var_values[VAR_POS] = frame->pkt_pos == -1 ?
 279         NAN : frame->pkt_pos;
 280     s->var_values[VAR_X] = av_expr_eval(s->x_pexpr, s->var_values, NULL);
 281     s->var_values[VAR_Y] = av_expr_eval(s->y_pexpr, s->var_values, NULL);
 282     /* It is necessary if x is expressed from y  */
 283     s->var_values[VAR_X] = av_expr_eval(s->x_pexpr, s->var_values, NULL);
 284
 285     normalize_double(&s->x, s->var_values[VAR_X]);
 286     normalize_double(&s->y, s->var_values[VAR_Y]);
 287
 288     if (s->x < 0)
 289         s->x = 0;
 290     if (s->y < 0)
 291         s->y = 0;
 292     if ((unsigned)s->x + (unsigned)s->w > link->w)
 293         s->x = link->w - s->w;
 294     if ((unsigned)s->y + (unsigned)s->h > link->h)
 295         s->y = link->h - s->h;
 296     if (!s->exact) {
 297         s->x &= ~((1 << s->hsub) - 1);
 298         s->y &= ~((1 << s->vsub) - 1);
 299     }
 300
 301     av_log(ctx, AV_LOG_TRACE, "n:%d t:%f pos:%f x:%d y:%d x+w:%d y+h:%d\n",
 302             (int)s->var_values[VAR_N], s->var_values[VAR_T], s->var_values[VAR_POS],
 303             s->x, s->y, s->x+s->w, s->y+s->h);
 304
 305     if (desc->flags & AV_PIX_FMT_FLAG_HWACCEL) {
 306         frame->crop_top   += s->y;
 307         frame->crop_left  += s->x;
 308         frame->crop_bottom = frame->height - frame->crop_top - frame->crop_bottom - s->h;
 309         frame->crop_right  = frame->width  - frame->crop_left - frame->crop_right - s->w;
 310     } else {
 311         frame->width  = s->w;
 312         frame->height = s->h;
 313
 314         frame->data[0] += s->y * frame->linesize[0];
 315         frame->data[0] += s->x * s->max_step[0];
 316
 317         if (!(desc->flags & AV_PIX_FMT_FLAG_PAL || desc->flags & FF_PSEUDOPAL)) {
 318             for (i = 1; i < 3; i ++) {
 319                 if (frame->data[i]) {
 320                     frame->data[i] += (s->y >> s->vsub) * frame->linesize[i];
 321                     frame->data[i] += (s->x * s->max_step[i]) >> s->hsub;
 322                 }
 323             }
 324         }
 325
 326         /* alpha plane */
 327         if (frame->data[3]) {
 328             frame->data[3] += s->y * frame->linesize[3];
 329             frame->data[3] += s->x * s->max_step[3];
 330         }
 331     }
 332
 333     return ff_filter_frame(link->dst->outputs[0], frame);
 334 }
 335
 336 static int process_command(AVFilterContext *ctx, const char *cmd, const char *args,
 337                            char *res, int res_len, int flags)
 338 {
 339     CropContext *s = ctx->priv;
 340     int ret;
 341
 342     if (   !strcmp(cmd, "out_w")  || !strcmp(cmd, "w")
 343         || !strcmp(cmd, "out_h")  || !strcmp(cmd, "h")
 344         || !strcmp(cmd, "x")      || !strcmp(cmd, "y")) {
 345
 346         int old_x = s->x;
 347         int old_y = s->y;
 348         int old_w = s->w;
 349         int old_h = s->h;
 350
 351         AVFilterLink *outlink = ctx->outputs[0];
 352         AVFilterLink *inlink  = ctx->inputs[0];
 353
 354         av_opt_set(s, cmd, args, 0);
 355
 356         if ((ret = config_input(inlink)) < 0) {
 357             s->x = old_x;
 358             s->y = old_y;
 359             s->w = old_w;
 360             s->h = old_h;
 361             return ret;
 362         }
 363
 364         ret = config_output(outlink);
 365
 366     } else
 367         ret = AVERROR(ENOSYS);
 368
 369     return ret;
 370 }
 371
 372 #define OFFSET(x) offsetof(CropContext, x)
 373 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
 374
 375 static const AVOption crop_options[] = {
 376     { "out_w",       "set the width crop area expression",   OFFSET(w_expr), AV_OPT_TYPE_STRING, {.str = "iw"}, CHAR_MIN, CHAR_MAX, FLAGS },
 377     { "w",           "set the width crop area expression",   OFFSET(w_expr), AV_OPT_TYPE_STRING, {.str = "iw"}, CHAR_MIN, CHAR_MAX, FLAGS },
 378     { "out_h",       "set the height crop area expression",  OFFSET(h_expr), AV_OPT_TYPE_STRING, {.str = "ih"}, CHAR_MIN, CHAR_MAX, FLAGS },
 379     { "h",           "set the height crop area expression",  OFFSET(h_expr), AV_OPT_TYPE_STRING, {.str = "ih"}, CHAR_MIN, CHAR_MAX, FLAGS },
 380     { "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 },
 381     { "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 },
 382     { "keep_aspect", "keep aspect ratio",                    OFFSET(keep_aspect), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS },
 383     { "exact",       "do exact cropping",                    OFFSET(exact),  AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS },
 384     { NULL }
 385 };
 386
 387 AVFILTER_DEFINE_CLASS(crop);
 388
 389 static const AVFilterPad avfilter_vf_crop_inputs[] = {
 390     {
 391         .name         = "default",
 392         .type         = AVMEDIA_TYPE_VIDEO,
 393         .filter_frame = filter_frame,
 394         .config_props = config_input,
 395     },
 396     { NULL }
 397 };
 398
 399 static const AVFilterPad avfilter_vf_crop_outputs[] = {
 400     {
 401         .name         = "default",
 402         .type         = AVMEDIA_TYPE_VIDEO,
 403         .config_props = config_output,
 404     },
 405     { NULL }
 406 };
 407
 408 AVFilter ff_vf_crop = {
 409     .name            = "crop",
 410     .description     = NULL_IF_CONFIG_SMALL("Crop the input video."),
 411     .priv_size       = sizeof(CropContext),
 412     .priv_class      = &crop_class,
 413     .query_formats   = query_formats,
 414     .uninit          = uninit,
 415     .inputs          = avfilter_vf_crop_inputs,
 416     .outputs         = avfilter_vf_crop_outputs,
 417     .process_command = process_command,
 418 };