git.sesse.net Git - ffmpeg/blob - libavfilter/vf_fade.c

   1 /*
   2  * Copyright (c) 2010 Brandon Mintern
   3  * Copyright (c) 2007 Bobby Bingham
   4  *
   5  * This file is part of FFmpeg.
   6  *
   7  * FFmpeg is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * FFmpeg is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with FFmpeg; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 /**
  23  * @file
  24  * video fade filter
  25  * based heavily on vf_negate.c by Bobby Bingham
  26  */
  27
  28 #include "libavutil/avstring.h"
  29 #include "libavutil/common.h"
  30 #include "libavutil/eval.h"
  31 #include "libavutil/opt.h"
  32 #include "libavutil/pixdesc.h"
  33 #include "avfilter.h"
  34 #include "drawutils.h"
  35 #include "internal.h"
  36 #include "formats.h"
  37 #include "internal.h"
  38 #include "video.h"
  39
  40 #define R 0
  41 #define G 1
  42 #define B 2
  43 #define A 3
  44
  45 #define Y 0
  46 #define U 1
  47 #define V 2
  48
  49 typedef struct {
  50     const AVClass *class;
  51     int factor, fade_per_frame;
  52     unsigned int frame_index, start_frame, stop_frame, nb_frames;
  53     int hsub, vsub, bpp;
  54     unsigned int black_level, black_level_scaled;
  55     uint8_t is_packed_rgb;
  56     uint8_t rgba_map[4];
  57     int alpha;
  58
  59     char *type;
  60 } FadeContext;
  61
  62 #define OFFSET(x) offsetof(FadeContext, x)
  63 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
  64
  65 static const AVOption fade_options[] = {
  66     { "type",        "set the fade direction",                     OFFSET(type),        AV_OPT_TYPE_STRING, {.str = "in" }, CHAR_MIN, CHAR_MAX, FLAGS },
  67     { "t",           "set the fade direction",                     OFFSET(type),        AV_OPT_TYPE_STRING, {.str = "in" }, CHAR_MIN, CHAR_MAX, FLAGS },
  68     { "start_frame", "set expression of frame to start fading",    OFFSET(start_frame), AV_OPT_TYPE_INT, {.i64 = 0    }, 0, INT_MAX, FLAGS },
  69     { "s",           "set expression of frame to start fading",    OFFSET(start_frame), AV_OPT_TYPE_INT, {.i64 = 0    }, 0, INT_MAX, FLAGS },
  70     { "nb_frames",   "set expression for fade duration in frames", OFFSET(nb_frames),   AV_OPT_TYPE_INT, {.i64 = 25   }, 0, INT_MAX, FLAGS },
  71     { "n",           "set expression for fade duration in frames", OFFSET(nb_frames),   AV_OPT_TYPE_INT, {.i64 = 25   }, 0, INT_MAX, FLAGS },
  72     { "alpha",       "fade alpha if it is available on the input", OFFSET(alpha),       AV_OPT_TYPE_INT, {.i64 = 0    }, 0,       1, FLAGS },
  73     {NULL},
  74 };
  75
  76 AVFILTER_DEFINE_CLASS(fade);
  77
  78 static av_cold int init(AVFilterContext *ctx, const char *args)
  79 {
  80     FadeContext *fade = ctx->priv;
  81     int ret = 0;
  82     char *args1, *expr, *bufptr = NULL;
  83
  84     fade->class = &fade_class;
  85     av_opt_set_defaults(fade);
  86
  87     if (!(args1 = av_strdup(args))) {
  88         ret = AVERROR(ENOMEM);
  89         goto end;
  90     }
  91
  92     if (expr = av_strtok(args1, ":", &bufptr)) {
  93         av_free(fade->type);
  94         if (!(fade->type = av_strdup(expr))) {
  95             ret = AVERROR(ENOMEM);
  96             goto end;
  97         }
  98     }
  99     if (expr = av_strtok(NULL, ":", &bufptr)) {
 100         if ((ret = av_opt_set(fade, "start_frame", expr, 0)) < 0) {
 101             av_log(ctx, AV_LOG_ERROR,
 102                    "Invalid value '%s' for start_frame option\n", expr);
 103             goto end;
 104         }
 105     }
 106     if (expr = av_strtok(NULL, ":", &bufptr)) {
 107         if ((ret = av_opt_set(fade, "nb_frames", expr, 0)) < 0) {
 108             av_log(ctx, AV_LOG_ERROR,
 109                    "Invalid value '%s' for nb_frames option\n", expr);
 110             goto end;
 111         }
 112     }
 113
 114     if (bufptr && (ret = av_set_options_string(fade, bufptr, "=", ":")) < 0)
 115         goto end;
 116
 117     fade->fade_per_frame = (1 << 16) / fade->nb_frames;
 118     if (!strcmp(fade->type, "in"))
 119         fade->factor = 0;
 120     else if (!strcmp(fade->type, "out")) {
 121         fade->fade_per_frame = -fade->fade_per_frame;
 122         fade->factor = (1 << 16);
 123     } else {
 124         av_log(ctx, AV_LOG_ERROR,
 125                "Type argument must be 'in' or 'out' but '%s' was specified\n", fade->type);
 126         ret = AVERROR(EINVAL);
 127         goto end;
 128     }
 129     fade->stop_frame = fade->start_frame + fade->nb_frames;
 130
 131     av_log(ctx, AV_LOG_VERBOSE,
 132            "type:%s start_frame:%d nb_frames:%d alpha:%d\n",
 133            fade->type, fade->start_frame, fade->nb_frames, fade->alpha);
 134
 135 end:
 136     av_free(args1);
 137     return ret;
 138 }
 139
 140 static av_cold void uninit(AVFilterContext *ctx)
 141 {
 142     FadeContext *fade = ctx->priv;
 143
 144     av_freep(&fade->type);
 145 }
 146
 147 static int query_formats(AVFilterContext *ctx)
 148 {
 149     static const enum AVPixelFormat pix_fmts[] = {
 150         AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P,
 151         AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV410P,
 152         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
 153         AV_PIX_FMT_YUV440P,  AV_PIX_FMT_YUVJ440P,
 154         AV_PIX_FMT_YUVA420P,
 155         AV_PIX_FMT_RGB24,    AV_PIX_FMT_BGR24,
 156         AV_PIX_FMT_ARGB,     AV_PIX_FMT_ABGR,
 157         AV_PIX_FMT_RGBA,     AV_PIX_FMT_BGRA,
 158         AV_PIX_FMT_NONE
 159     };
 160
 161     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
 162     return 0;
 163 }
 164
 165 const static enum AVPixelFormat studio_level_pix_fmts[] = {
 166     AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P,
 167     AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV410P,
 168     AV_PIX_FMT_YUV440P,
 169     AV_PIX_FMT_NONE
 170 };
 171
 172 static enum AVPixelFormat alpha_pix_fmts[] = {
 173     AV_PIX_FMT_YUVA420P,
 174     AV_PIX_FMT_ARGB, AV_PIX_FMT_ABGR,
 175     AV_PIX_FMT_RGBA, AV_PIX_FMT_BGRA,
 176     AV_PIX_FMT_NONE
 177 };
 178
 179 static int config_props(AVFilterLink *inlink)
 180 {
 181     FadeContext *fade = inlink->dst->priv;
 182     const AVPixFmtDescriptor *pixdesc = av_pix_fmt_desc_get(inlink->format);
 183
 184     fade->hsub = pixdesc->log2_chroma_w;
 185     fade->vsub = pixdesc->log2_chroma_h;
 186
 187     fade->bpp = av_get_bits_per_pixel(pixdesc) >> 3;
 188     fade->alpha = fade->alpha ? ff_fmt_is_in(inlink->format, alpha_pix_fmts) : 0;
 189     fade->is_packed_rgb = ff_fill_rgba_map(fade->rgba_map, inlink->format) >= 0;
 190
 191     /* use CCIR601/709 black level for studio-level pixel non-alpha components */
 192     fade->black_level =
 193             ff_fmt_is_in(inlink->format, studio_level_pix_fmts) && !fade->alpha ? 16 : 0;
 194     /* 32768 = 1 << 15, it is an integer representation
 195      * of 0.5 and is for rounding. */
 196     fade->black_level_scaled = (fade->black_level << 16) + 32768;
 197     return 0;
 198 }
 199
 200 static void fade_plane(int y, int h, int w,
 201                        int fade_factor, int black_level, int black_level_scaled,
 202                        uint8_t offset, uint8_t step, int bytes_per_plane,
 203                        uint8_t *data, int line_size)
 204 {
 205     uint8_t *p;
 206     int i, j;
 207
 208     /* luma, alpha or rgb plane */
 209     for (i = 0; i < h; i++) {
 210         p = data + offset + (y+i) * line_size;
 211         for (j = 0; j < w * bytes_per_plane; j++) {
 212             /* fade->factor is using 16 lower-order bits for decimal places. */
 213             *p = ((*p - black_level) * fade_factor + black_level_scaled) >> 16;
 214             p+=step;
 215         }
 216     }
 217 }
 218
 219 static int filter_frame(AVFilterLink *inlink, AVFilterBufferRef *frame)
 220 {
 221     FadeContext *fade = inlink->dst->priv;
 222     uint8_t *p;
 223     int i, j, plane;
 224
 225     if (fade->factor < UINT16_MAX) {
 226         if (fade->alpha) {
 227             // alpha only
 228             plane = fade->is_packed_rgb ? 0 : A; // alpha is on plane 0 for packed formats
 229                                                  // or plane 3 for planar formats
 230             fade_plane(0, frame->video->h, inlink->w,
 231                        fade->factor, fade->black_level, fade->black_level_scaled,
 232                        fade->is_packed_rgb ? fade->rgba_map[A] : 0, // alpha offset for packed formats
 233                        fade->is_packed_rgb ? 4 : 1,                 // pixstep for 8 bit packed formats
 234                        1, frame->data[plane], frame->linesize[plane]);
 235         } else {
 236             /* luma or rgb plane */
 237             fade_plane(0, frame->video->h, inlink->w,
 238                        fade->factor, fade->black_level, fade->black_level_scaled,
 239                        0, 1, // offset & pixstep for Y plane or RGB packed format
 240                        fade->bpp, frame->data[0], frame->linesize[0]);
 241             if (frame->data[1] && frame->data[2]) {
 242                 /* chroma planes */
 243                 for (plane = 1; plane < 3; plane++) {
 244                     for (i = 0; i < frame->video->h; i++) {
 245                         p = frame->data[plane] + (i >> fade->vsub) * frame->linesize[plane];
 246                         for (j = 0; j < inlink->w >> fade->hsub; j++) {
 247                             /* 8421367 = ((128 << 1) + 1) << 15. It is an integer
 248                              * representation of 128.5. The .5 is for rounding
 249                              * purposes. */
 250                             *p = ((*p - 128) * fade->factor + 8421367) >> 16;
 251                             p++;
 252                         }
 253                     }
 254                 }
 255             }
 256         }
 257     }
 258
 259     if (fade->frame_index >= fade->start_frame &&
 260         fade->frame_index <= fade->stop_frame)
 261         fade->factor += fade->fade_per_frame;
 262     fade->factor = av_clip_uint16(fade->factor);
 263     fade->frame_index++;
 264
 265     return ff_filter_frame(inlink->dst->outputs[0], frame);
 266 }
 267
 268 static const AVFilterPad avfilter_vf_fade_inputs[] = {
 269     {
 270         .name             = "default",
 271         .type             = AVMEDIA_TYPE_VIDEO,
 272         .config_props     = config_props,
 273         .get_video_buffer = ff_null_get_video_buffer,
 274         .filter_frame     = filter_frame,
 275         .min_perms        = AV_PERM_READ | AV_PERM_WRITE,
 276     },
 277     { NULL }
 278 };
 279
 280 static const AVFilterPad avfilter_vf_fade_outputs[] = {
 281     {
 282         .name = "default",
 283         .type = AVMEDIA_TYPE_VIDEO,
 284     },
 285     { NULL }
 286 };
 287
 288 AVFilter avfilter_vf_fade = {
 289     .name          = "fade",
 290     .description   = NULL_IF_CONFIG_SMALL("Fade in/out input video."),
 291     .init          = init,
 292     .uninit        = uninit,
 293     .priv_size     = sizeof(FadeContext),
 294     .query_formats = query_formats,
 295
 296     .inputs    = avfilter_vf_fade_inputs,
 297     .outputs   = avfilter_vf_fade_outputs,
 298     .priv_class = &fade_class,
 299 };