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 /* #define DEBUG */
  27
  28 #include <stdio.h>
  29
  30 #include "avfilter.h"
  31 #include "formats.h"
  32 #include "internal.h"
  33 #include "video.h"
  34 #include "libavutil/eval.h"
  35 #include "libavutil/avstring.h"
  36 #include "libavutil/internal.h"
  37 #include "libavutil/libm.h"
  38 #include "libavutil/imgutils.h"
  39 #include "libavutil/mathematics.h"
  40 #include "libavutil/opt.h"
  41
  42 static const char *const var_names[] = {
  43     "in_w", "iw",   ///< width  of the input video
  44     "in_h", "ih",   ///< height of the input video
  45     "out_w", "ow",  ///< width  of the cropped video
  46     "out_h", "oh",  ///< height of the cropped video
  47     "a",
  48     "sar",
  49     "dar",
  50     "hsub",
  51     "vsub",
  52     "x",
  53     "y",
  54     "n",            ///< number of frame
  55     "pos",          ///< position in the file
  56     "t",            ///< timestamp expressed in seconds
  57     NULL
  58 };
  59
  60 enum var_name {
  61     VAR_IN_W,  VAR_IW,
  62     VAR_IN_H,  VAR_IH,
  63     VAR_OUT_W, VAR_OW,
  64     VAR_OUT_H, VAR_OH,
  65     VAR_A,
  66     VAR_SAR,
  67     VAR_DAR,
  68     VAR_HSUB,
  69     VAR_VSUB,
  70     VAR_X,
  71     VAR_Y,
  72     VAR_N,
  73     VAR_T,
  74     VAR_VARS_NB
  75 };
  76
  77 typedef struct {
  78     const AVClass *class;
  79     int  x;             ///< x offset of the non-cropped area with respect to the input area
  80     int  y;             ///< y offset of the non-cropped area with respect to the input area
  81     int  w;             ///< width of the cropped area
  82     int  h;             ///< height of the cropped area
  83
  84     AVRational out_sar; ///< output sample aspect ratio
  85     int keep_aspect;    ///< keep display aspect ratio when cropping
  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 #define OFFSET(x) offsetof(CropContext, x)
  95 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
  96
  97 static const AVOption crop_options[] = {
  98     { "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 },
  99     { "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 },
 100     { "out_w",       "set the width crop area expression",   OFFSET(w_expr), AV_OPT_TYPE_STRING, {.str = "iw"}, CHAR_MIN, CHAR_MAX, FLAGS },
 101     { "w",           "set the width crop area expression",   OFFSET(w_expr), AV_OPT_TYPE_STRING, {.str = "iw"}, CHAR_MIN, CHAR_MAX, FLAGS },
 102     { "out_h",       "set the height crop area expression",  OFFSET(h_expr), AV_OPT_TYPE_STRING, {.str = "ih"}, CHAR_MIN, CHAR_MAX, FLAGS },
 103     { "h",           "set the height crop area expression",  OFFSET(h_expr), AV_OPT_TYPE_STRING, {.str = "ih"}, CHAR_MIN, CHAR_MAX, FLAGS },
 104     { "keep_aspect", "keep aspect ratio",                    OFFSET(keep_aspect), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS },
 105     {NULL}
 106 };
 107
 108 AVFILTER_DEFINE_CLASS(crop);
 109
 110 static av_cold int init(AVFilterContext *ctx, const char *args)
 111 {
 112     CropContext *crop = ctx->priv;
 113     static const char *shorthand[] = { "w", "h", "x", "y", "keep_aspect", NULL };
 114
 115     crop->class = &crop_class;
 116     av_opt_set_defaults(crop);
 117
 118     return av_opt_set_from_string(crop, args, shorthand, "=", ":");
 119 }
 120
 121 static av_cold void uninit(AVFilterContext *ctx)
 122 {
 123     CropContext *crop = ctx->priv;
 124
 125     av_expr_free(crop->x_pexpr); crop->x_pexpr = NULL;
 126     av_expr_free(crop->y_pexpr); crop->y_pexpr = NULL;
 127     av_opt_free(crop);
 128 }
 129
 130 static int query_formats(AVFilterContext *ctx)
 131 {
 132     static const enum AVPixelFormat pix_fmts[] = {
 133         AV_PIX_FMT_RGB48BE,      AV_PIX_FMT_RGB48LE,
 134         AV_PIX_FMT_BGR48BE,      AV_PIX_FMT_BGR48LE,
 135         AV_PIX_FMT_ARGB,         AV_PIX_FMT_RGBA,
 136         AV_PIX_FMT_ABGR,         AV_PIX_FMT_BGRA,
 137         AV_PIX_FMT_RGB24,        AV_PIX_FMT_BGR24,
 138         AV_PIX_FMT_RGB565BE,     AV_PIX_FMT_RGB565LE,
 139         AV_PIX_FMT_RGB555BE,     AV_PIX_FMT_RGB555LE,
 140         AV_PIX_FMT_BGR565BE,     AV_PIX_FMT_BGR565LE,
 141         AV_PIX_FMT_BGR555BE,     AV_PIX_FMT_BGR555LE,
 142         AV_PIX_FMT_GRAY16BE,     AV_PIX_FMT_GRAY16LE,
 143         AV_PIX_FMT_YUV420P16LE,  AV_PIX_FMT_YUV420P16BE,
 144         AV_PIX_FMT_YUV422P16LE,  AV_PIX_FMT_YUV422P16BE,
 145         AV_PIX_FMT_YUV444P16LE,  AV_PIX_FMT_YUV444P16BE,
 146         AV_PIX_FMT_YUV444P,      AV_PIX_FMT_YUV422P,
 147         AV_PIX_FMT_YUV420P,      AV_PIX_FMT_YUV411P,
 148         AV_PIX_FMT_YUV410P,      AV_PIX_FMT_YUV440P,
 149         AV_PIX_FMT_YUVJ444P,     AV_PIX_FMT_YUVJ422P,
 150         AV_PIX_FMT_YUVJ420P,     AV_PIX_FMT_YUVJ440P,
 151         AV_PIX_FMT_YUVA420P,
 152         AV_PIX_FMT_RGB8,         AV_PIX_FMT_BGR8,
 153         AV_PIX_FMT_RGB4_BYTE,    AV_PIX_FMT_BGR4_BYTE,
 154         AV_PIX_FMT_PAL8,         AV_PIX_FMT_GRAY8,
 155         AV_PIX_FMT_NONE
 156     };
 157
 158     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
 159
 160     return 0;
 161 }
 162
 163 static inline int normalize_double(int *n, double d)
 164 {
 165     int ret = 0;
 166
 167     if (isnan(d)) {
 168         ret = AVERROR(EINVAL);
 169     } else if (d > INT_MAX || d < INT_MIN) {
 170         *n = d > INT_MAX ? INT_MAX : INT_MIN;
 171         ret = AVERROR(EINVAL);
 172     } else
 173         *n = round(d);
 174
 175     return ret;
 176 }
 177
 178 static int config_input(AVFilterLink *link)
 179 {
 180     AVFilterContext *ctx = link->dst;
 181     CropContext *crop = ctx->priv;
 182     const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(link->format);
 183     int ret;
 184     const char *expr;
 185     double res;
 186
 187     crop->var_values[VAR_IN_W]  = crop->var_values[VAR_IW] = ctx->inputs[0]->w;
 188     crop->var_values[VAR_IN_H]  = crop->var_values[VAR_IH] = ctx->inputs[0]->h;
 189     crop->var_values[VAR_A]     = (float) link->w / link->h;
 190     crop->var_values[VAR_SAR]   = link->sample_aspect_ratio.num ? av_q2d(link->sample_aspect_ratio) : 1;
 191     crop->var_values[VAR_DAR]   = crop->var_values[VAR_A] * crop->var_values[VAR_SAR];
 192     crop->var_values[VAR_HSUB]  = 1<<pix_desc->log2_chroma_w;
 193     crop->var_values[VAR_VSUB]  = 1<<pix_desc->log2_chroma_h;
 194     crop->var_values[VAR_X]     = NAN;
 195     crop->var_values[VAR_Y]     = NAN;
 196     crop->var_values[VAR_OUT_W] = crop->var_values[VAR_OW] = NAN;
 197     crop->var_values[VAR_OUT_H] = crop->var_values[VAR_OH] = NAN;
 198     crop->var_values[VAR_N]     = 0;
 199     crop->var_values[VAR_T]     = NAN;
 200
 201     av_image_fill_max_pixsteps(crop->max_step, NULL, pix_desc);
 202     crop->hsub = pix_desc->log2_chroma_w;
 203     crop->vsub = pix_desc->log2_chroma_h;
 204
 205     if ((ret = av_expr_parse_and_eval(&res, (expr = crop->w_expr),
 206                                       var_names, crop->var_values,
 207                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0) goto fail_expr;
 208     crop->var_values[VAR_OUT_W] = crop->var_values[VAR_OW] = res;
 209     if ((ret = av_expr_parse_and_eval(&res, (expr = crop->h_expr),
 210                                       var_names, crop->var_values,
 211                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0) goto fail_expr;
 212     crop->var_values[VAR_OUT_H] = crop->var_values[VAR_OH] = res;
 213     /* evaluate again ow as it may depend on oh */
 214     if ((ret = av_expr_parse_and_eval(&res, (expr = crop->w_expr),
 215                                       var_names, crop->var_values,
 216                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0) goto fail_expr;
 217     crop->var_values[VAR_OUT_W] = crop->var_values[VAR_OW] = res;
 218     if (normalize_double(&crop->w, crop->var_values[VAR_OUT_W]) < 0 ||
 219         normalize_double(&crop->h, crop->var_values[VAR_OUT_H]) < 0) {
 220         av_log(ctx, AV_LOG_ERROR,
 221                "Too big value or invalid expression for out_w/ow or out_h/oh. "
 222                "Maybe the expression for out_w:'%s' or for out_h:'%s' is self-referencing.\n",
 223                crop->w_expr, crop->h_expr);
 224         return AVERROR(EINVAL);
 225     }
 226     crop->w &= ~((1 << crop->hsub) - 1);
 227     crop->h &= ~((1 << crop->vsub) - 1);
 228
 229     if ((ret = av_expr_parse(&crop->x_pexpr, crop->x_expr, var_names,
 230                              NULL, NULL, NULL, NULL, 0, ctx)) < 0 ||
 231         (ret = av_expr_parse(&crop->y_pexpr, crop->y_expr, var_names,
 232                              NULL, NULL, NULL, NULL, 0, ctx)) < 0)
 233         return AVERROR(EINVAL);
 234
 235     if (crop->keep_aspect) {
 236         AVRational dar = av_mul_q(link->sample_aspect_ratio,
 237                                   (AVRational){ link->w, link->h });
 238         av_reduce(&crop->out_sar.num, &crop->out_sar.den,
 239                   dar.num * crop->h, dar.den * crop->w, INT_MAX);
 240     } else
 241         crop->out_sar = link->sample_aspect_ratio;
 242
 243     av_log(ctx, AV_LOG_VERBOSE, "w:%d h:%d sar:%d/%d -> w:%d h:%d sar:%d/%d\n",
 244            link->w, link->h, link->sample_aspect_ratio.num, link->sample_aspect_ratio.den,
 245            crop->w, crop->h, crop->out_sar.num, crop->out_sar.den);
 246
 247     if (crop->w <= 0 || crop->h <= 0 ||
 248         crop->w > link->w || crop->h > link->h) {
 249         av_log(ctx, AV_LOG_ERROR,
 250                "Invalid too big or non positive size for width '%d' or height '%d'\n",
 251                crop->w, crop->h);
 252         return AVERROR(EINVAL);
 253     }
 254
 255     /* set default, required in the case the first computed value for x/y is NAN */
 256     crop->x = (link->w - crop->w) / 2;
 257     crop->y = (link->h - crop->h) / 2;
 258     crop->x &= ~((1 << crop->hsub) - 1);
 259     crop->y &= ~((1 << crop->vsub) - 1);
 260     return 0;
 261
 262 fail_expr:
 263     av_log(NULL, AV_LOG_ERROR, "Error when evaluating the expression '%s'\n", expr);
 264     return ret;
 265 }
 266
 267 static int config_output(AVFilterLink *link)
 268 {
 269     CropContext *crop = link->src->priv;
 270
 271     link->w = crop->w;
 272     link->h = crop->h;
 273     link->sample_aspect_ratio = crop->out_sar;
 274
 275     return 0;
 276 }
 277
 278 static int filter_frame(AVFilterLink *link, AVFrame *frame)
 279 {
 280     AVFilterContext *ctx = link->dst;
 281     CropContext *crop = ctx->priv;
 282     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(link->format);
 283     int i;
 284
 285     frame->width  = crop->w;
 286     frame->height = crop->h;
 287
 288     crop->var_values[VAR_T] = frame->pts == AV_NOPTS_VALUE ?
 289         NAN : frame->pts * av_q2d(link->time_base);
 290     crop->var_values[VAR_X] = av_expr_eval(crop->x_pexpr, crop->var_values, NULL);
 291     crop->var_values[VAR_Y] = av_expr_eval(crop->y_pexpr, crop->var_values, NULL);
 292     crop->var_values[VAR_X] = av_expr_eval(crop->x_pexpr, crop->var_values, NULL);
 293
 294     normalize_double(&crop->x, crop->var_values[VAR_X]);
 295     normalize_double(&crop->y, crop->var_values[VAR_Y]);
 296
 297     if (crop->x < 0) crop->x = 0;
 298     if (crop->y < 0) crop->y = 0;
 299     if ((unsigned)crop->x + (unsigned)crop->w > link->w) crop->x = link->w - crop->w;
 300     if ((unsigned)crop->y + (unsigned)crop->h > link->h) crop->y = link->h - crop->h;
 301     crop->x &= ~((1 << crop->hsub) - 1);
 302     crop->y &= ~((1 << crop->vsub) - 1);
 303
 304     av_dlog(ctx, "n:%d t:%f x:%d y:%d x+w:%d y+h:%d\n",
 305             (int)crop->var_values[VAR_N], crop->var_values[VAR_T], crop->x,
 306             crop->y, crop->x+crop->w, crop->y+crop->h);
 307
 308     frame->data[0] += crop->y * frame->linesize[0];
 309     frame->data[0] += crop->x * crop->max_step[0];
 310
 311     if (!(desc->flags & PIX_FMT_PAL || desc->flags & PIX_FMT_PSEUDOPAL)) {
 312         for (i = 1; i < 3; i ++) {
 313             if (frame->data[i]) {
 314                 frame->data[i] += (crop->y >> crop->vsub) * frame->linesize[i];
 315                 frame->data[i] += (crop->x * crop->max_step[i]) >> crop->hsub;
 316             }
 317         }
 318     }
 319
 320     /* alpha plane */
 321     if (frame->data[3]) {
 322         frame->data[3] += crop->y * frame->linesize[3];
 323         frame->data[3] += crop->x * crop->max_step[3];
 324     }
 325
 326     crop->var_values[VAR_N] += 1.0;
 327
 328     return ff_filter_frame(link->dst->outputs[0], frame);
 329 }
 330
 331 static const AVFilterPad avfilter_vf_crop_inputs[] = {
 332     {
 333         .name             = "default",
 334         .type             = AVMEDIA_TYPE_VIDEO,
 335         .filter_frame     = filter_frame,
 336         .get_video_buffer = ff_null_get_video_buffer,
 337         .config_props     = config_input,
 338     },
 339     { NULL }
 340 };
 341
 342 static const AVFilterPad avfilter_vf_crop_outputs[] = {
 343     {
 344         .name         = "default",
 345         .type         = AVMEDIA_TYPE_VIDEO,
 346         .config_props = config_output,
 347     },
 348     { NULL }
 349 };
 350
 351 AVFilter avfilter_vf_crop = {
 352     .name      = "crop",
 353     .description = NULL_IF_CONFIG_SMALL("Crop the input video to width:height:x:y."),
 354
 355     .priv_size = sizeof(CropContext),
 356
 357     .query_formats = query_formats,
 358     .init          = init,
 359     .uninit        = uninit,
 360
 361     .inputs    = avfilter_vf_crop_inputs,
 362     .outputs   = avfilter_vf_crop_outputs,
 363     .priv_class = &crop_class,
 364 };