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/avassert.h"
  29 #include "libavutil/avstring.h"
  30 #include "libavutil/common.h"
  31 #include "libavutil/eval.h"
  32 #include "libavutil/opt.h"
  33 #include "libavutil/pixdesc.h"
  34 #include "avfilter.h"
  35 #include "drawutils.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 #define FADE_IN  0
  50 #define FADE_OUT 1
  51
  52 typedef struct FadeContext {
  53     const AVClass *class;
  54     int type;
  55     int factor, fade_per_frame;
  56     int start_frame, nb_frames;
  57     int hsub, vsub, bpp;
  58     unsigned int black_level, black_level_scaled;
  59     uint8_t is_rgb;
  60     uint8_t is_packed_rgb;
  61     uint8_t rgba_map[4];
  62     int alpha;
  63     int is_planar;
  64     uint64_t start_time, duration;
  65     enum {VF_FADE_WAITING=0, VF_FADE_FADING, VF_FADE_DONE} fade_state;
  66     uint8_t color_rgba[4];  ///< fade color
  67     int black_fade;         ///< if color_rgba is black
  68 } FadeContext;
  69
  70 static av_cold int init(AVFilterContext *ctx)
  71 {
  72     FadeContext *s = ctx->priv;
  73
  74     s->fade_per_frame = (1 << 16) / s->nb_frames;
  75     s->fade_state = VF_FADE_WAITING;
  76
  77     if (s->duration != 0) {
  78         // If duration (seconds) is non-zero, assume that we are not fading based on frames
  79         s->nb_frames = 0; // Mostly to clean up logging
  80     }
  81
  82     // Choose what to log. If both time-based and frame-based options, both lines will be in the log
  83     if (s->start_frame || s->nb_frames) {
  84         av_log(ctx, AV_LOG_VERBOSE,
  85                "type:%s start_frame:%d nb_frames:%d alpha:%d\n",
  86                s->type == FADE_IN ? "in" : "out", s->start_frame,
  87                s->nb_frames,s->alpha);
  88     }
  89     if (s->start_time || s->duration) {
  90         av_log(ctx, AV_LOG_VERBOSE,
  91                "type:%s start_time:%f duration:%f alpha:%d\n",
  92                s->type == FADE_IN ? "in" : "out", (s->start_time / (double)AV_TIME_BASE),
  93                (s->duration / (double)AV_TIME_BASE),s->alpha);
  94     }
  95
  96     s->black_fade = !memcmp(s->color_rgba, "\x00\x00\x00\xff", 4);
  97     return 0;
  98 }
  99
 100 static int query_formats(AVFilterContext *ctx)
 101 {
 102     const FadeContext *s = ctx->priv;
 103     static const enum AVPixelFormat pix_fmts[] = {
 104         AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P,
 105         AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV410P,
 106         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
 107         AV_PIX_FMT_YUV440P,  AV_PIX_FMT_YUVJ440P,
 108         AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,
 109         AV_PIX_FMT_RGB24,    AV_PIX_FMT_BGR24,
 110         AV_PIX_FMT_ARGB,     AV_PIX_FMT_ABGR,
 111         AV_PIX_FMT_RGBA,     AV_PIX_FMT_BGRA,
 112         AV_PIX_FMT_GBRP,     AV_PIX_FMT_GBRAP,
 113         AV_PIX_FMT_NONE
 114     };
 115     static const enum AVPixelFormat pix_fmts_rgb[] = {
 116         AV_PIX_FMT_RGB24,    AV_PIX_FMT_BGR24,
 117         AV_PIX_FMT_ARGB,     AV_PIX_FMT_ABGR,
 118         AV_PIX_FMT_RGBA,     AV_PIX_FMT_BGRA,
 119         AV_PIX_FMT_GBRP,
 120         AV_PIX_FMT_NONE
 121     };
 122     static const enum AVPixelFormat pix_fmts_alpha[] = {
 123         AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,
 124         AV_PIX_FMT_ARGB,     AV_PIX_FMT_ABGR,
 125         AV_PIX_FMT_RGBA,     AV_PIX_FMT_BGRA,
 126         AV_PIX_FMT_GBRAP,
 127         AV_PIX_FMT_NONE
 128     };
 129     static const enum AVPixelFormat pix_fmts_rgba[] = {
 130         AV_PIX_FMT_ARGB,     AV_PIX_FMT_ABGR,
 131         AV_PIX_FMT_RGBA,     AV_PIX_FMT_BGRA,
 132         AV_PIX_FMT_GBRAP,
 133         AV_PIX_FMT_NONE
 134     };
 135     AVFilterFormats *fmts_list;
 136
 137     if (s->alpha) {
 138         if (s->black_fade)
 139             fmts_list = ff_make_format_list(pix_fmts_alpha);
 140         else
 141             fmts_list = ff_make_format_list(pix_fmts_rgba);
 142     } else {
 143         if (s->black_fade)
 144             fmts_list = ff_make_format_list(pix_fmts);
 145         else
 146             fmts_list = ff_make_format_list(pix_fmts_rgb);
 147     }
 148     if (!fmts_list)
 149         return AVERROR(ENOMEM);
 150     return ff_set_common_formats(ctx, fmts_list);
 151 }
 152
 153 const static enum AVPixelFormat studio_level_pix_fmts[] = {
 154     AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P,
 155     AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV410P,
 156     AV_PIX_FMT_YUV440P,
 157     AV_PIX_FMT_NONE
 158 };
 159
 160 static int config_props(AVFilterLink *inlink)
 161 {
 162     FadeContext *s = inlink->dst->priv;
 163     const AVPixFmtDescriptor *pixdesc = av_pix_fmt_desc_get(inlink->format);
 164
 165     s->hsub = pixdesc->log2_chroma_w;
 166     s->vsub = pixdesc->log2_chroma_h;
 167
 168     ff_fill_rgba_map(s->rgba_map, inlink->format);
 169
 170     s->bpp = pixdesc->flags & AV_PIX_FMT_FLAG_PLANAR ?
 171              1 :
 172              av_get_bits_per_pixel(pixdesc) >> 3;
 173     s->alpha &= !!(pixdesc->flags & AV_PIX_FMT_FLAG_ALPHA);
 174     s->is_planar = pixdesc->flags & AV_PIX_FMT_FLAG_PLANAR;
 175     s->is_rgb = pixdesc->flags & AV_PIX_FMT_FLAG_RGB;
 176     s->is_packed_rgb = !s->is_planar && s->is_rgb;
 177
 178     /* use CCIR601/709 black level for studio-level pixel non-alpha components */
 179     s->black_level =
 180             ff_fmt_is_in(inlink->format, studio_level_pix_fmts) && !s->alpha ? 16 : 0;
 181     /* 32768 = 1 << 15, it is an integer representation
 182      * of 0.5 and is for rounding. */
 183     s->black_level_scaled = (s->black_level << 16) + 32768;
 184     return 0;
 185 }
 186
 187 static av_always_inline void filter_rgb(FadeContext *s, const AVFrame *frame,
 188                                         int slice_start, int slice_end,
 189                                         int do_alpha, int step)
 190 {
 191     int i, j;
 192     const uint8_t r_idx  = s->rgba_map[R];
 193     const uint8_t g_idx  = s->rgba_map[G];
 194     const uint8_t b_idx  = s->rgba_map[B];
 195     const uint8_t a_idx  = s->rgba_map[A];
 196     const uint8_t *c = s->color_rgba;
 197
 198     for (i = slice_start; i < slice_end; i++) {
 199         uint8_t *p = frame->data[0] + i * frame->linesize[0];
 200         for (j = 0; j < frame->width; j++) {
 201 #define INTERP(c_name, c_idx) av_clip_uint8(((c[c_idx]<<16) + ((int)p[c_name] - (int)c[c_idx]) * s->factor + (1<<15)) >> 16)
 202             p[r_idx] = INTERP(r_idx, 0);
 203             p[g_idx] = INTERP(g_idx, 1);
 204             p[b_idx] = INTERP(b_idx, 2);
 205             if (do_alpha)
 206                 p[a_idx] = INTERP(a_idx, 3);
 207             p += step;
 208         }
 209     }
 210 }
 211
 212 static av_always_inline void filter_rgb_planar(FadeContext *s, const AVFrame *frame,
 213                                                int slice_start, int slice_end,
 214                                                int do_alpha)
 215 {
 216     int i, j;
 217     const uint8_t *c = s->color_rgba;
 218
 219     for (i = slice_start; i < slice_end; i++) {
 220         uint8_t *pg = frame->data[0] + i * frame->linesize[0];
 221         uint8_t *pb = frame->data[1] + i * frame->linesize[1];
 222         uint8_t *pr = frame->data[2] + i * frame->linesize[2];
 223         uint8_t *pa = frame->data[3] + i * frame->linesize[3];
 224         for (j = 0; j < frame->width; j++) {
 225 #define INTERPP(c_name, c_idx) av_clip_uint8(((c[c_idx]<<16) + ((int)c_name - (int)c[c_idx]) * s->factor + (1<<15)) >> 16)
 226             pr[j] = INTERPP(pr[j], 1);
 227             pg[j] = INTERPP(pg[j], 0);
 228             pb[j] = INTERPP(pb[j], 2);
 229             if (do_alpha)
 230                 pa[j] = INTERPP(pa[j], 3);
 231         }
 232     }
 233 }
 234
 235 static int filter_slice_rgb(AVFilterContext *ctx, void *arg, int jobnr,
 236                             int nb_jobs)
 237 {
 238     FadeContext *s = ctx->priv;
 239     AVFrame *frame = arg;
 240     int slice_start = (frame->height *  jobnr   ) / nb_jobs;
 241     int slice_end   = (frame->height * (jobnr+1)) / nb_jobs;
 242
 243     if      (s->is_planar && s->alpha)
 244                           filter_rgb_planar(s, frame, slice_start, slice_end, 1);
 245     else if (s->is_planar)
 246                           filter_rgb_planar(s, frame, slice_start, slice_end, 0);
 247     else if (s->alpha)    filter_rgb(s, frame, slice_start, slice_end, 1, 4);
 248     else if (s->bpp == 3) filter_rgb(s, frame, slice_start, slice_end, 0, 3);
 249     else if (s->bpp == 4) filter_rgb(s, frame, slice_start, slice_end, 0, 4);
 250     else                  av_assert0(0);
 251
 252     return 0;
 253 }
 254
 255 static int filter_slice_luma(AVFilterContext *ctx, void *arg, int jobnr,
 256                              int nb_jobs)
 257 {
 258     FadeContext *s = ctx->priv;
 259     AVFrame *frame = arg;
 260     int slice_start = (frame->height *  jobnr   ) / nb_jobs;
 261     int slice_end   = (frame->height * (jobnr+1)) / nb_jobs;
 262     int i, j;
 263
 264     for (int k = 0; k < 1 + 2 * (s->is_planar && s->is_rgb); k++) {
 265         for (i = slice_start; i < slice_end; i++) {
 266             uint8_t *p = frame->data[k] + i * frame->linesize[k];
 267             for (j = 0; j < frame->width * s->bpp; j++) {
 268                 /* s->factor is using 16 lower-order bits for decimal
 269                  * places. 32768 = 1 << 15, it is an integer representation
 270                  * of 0.5 and is for rounding. */
 271                 *p = ((*p - s->black_level) * s->factor + s->black_level_scaled) >> 16;
 272                 p++;
 273             }
 274         }
 275     }
 276
 277     return 0;
 278 }
 279
 280 static int filter_slice_chroma(AVFilterContext *ctx, void *arg, int jobnr,
 281                                int nb_jobs)
 282 {
 283     FadeContext *s = ctx->priv;
 284     AVFrame *frame = arg;
 285     int i, j, plane;
 286     const int width = AV_CEIL_RSHIFT(frame->width, s->hsub);
 287     const int height= AV_CEIL_RSHIFT(frame->height, s->vsub);
 288     int slice_start = (height *  jobnr   ) / nb_jobs;
 289     int slice_end   = FFMIN(((height * (jobnr+1)) / nb_jobs), frame->height);
 290
 291     for (plane = 1; plane < 3; plane++) {
 292         for (i = slice_start; i < slice_end; i++) {
 293             uint8_t *p = frame->data[plane] + i * frame->linesize[plane];
 294             for (j = 0; j < width; j++) {
 295                 /* 8421367 = ((128 << 1) + 1) << 15. It is an integer
 296                  * representation of 128.5. The .5 is for rounding
 297                  * purposes. */
 298                 *p = ((*p - 128) * s->factor + 8421367) >> 16;
 299                 p++;
 300             }
 301         }
 302     }
 303
 304     return 0;
 305 }
 306
 307 static int filter_slice_alpha(AVFilterContext *ctx, void *arg, int jobnr,
 308                               int nb_jobs)
 309 {
 310     FadeContext *s = ctx->priv;
 311     AVFrame *frame = arg;
 312     int plane = s->is_packed_rgb ? 0 : A;
 313     int slice_start = (frame->height *  jobnr   ) / nb_jobs;
 314     int slice_end   = (frame->height * (jobnr+1)) / nb_jobs;
 315     int i, j;
 316
 317     for (i = slice_start; i < slice_end; i++) {
 318         uint8_t *p = frame->data[plane] + i * frame->linesize[plane] + s->is_packed_rgb*s->rgba_map[A];
 319         int step = s->is_packed_rgb ? 4 : 1;
 320         for (j = 0; j < frame->width; j++) {
 321             /* s->factor is using 16 lower-order bits for decimal
 322              * places. 32768 = 1 << 15, it is an integer representation
 323              * of 0.5 and is for rounding. */
 324             *p = ((*p - s->black_level) * s->factor + s->black_level_scaled) >> 16;
 325             p += step;
 326         }
 327     }
 328
 329     return 0;
 330 }
 331
 332 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
 333 {
 334     AVFilterContext *ctx = inlink->dst;
 335     FadeContext *s       = ctx->priv;
 336     double frame_timestamp = frame->pts == AV_NOPTS_VALUE ? -1 : frame->pts * av_q2d(inlink->time_base);
 337
 338     // Calculate Fade assuming this is a Fade In
 339     if (s->fade_state == VF_FADE_WAITING) {
 340         s->factor=0;
 341         if (frame_timestamp >= s->start_time/(double)AV_TIME_BASE
 342             && inlink->frame_count_out >= s->start_frame) {
 343             // Time to start fading
 344             s->fade_state = VF_FADE_FADING;
 345
 346             // Save start time in case we are starting based on frames and fading based on time
 347             if (s->start_time == 0 && s->start_frame != 0) {
 348                 s->start_time = frame_timestamp*(double)AV_TIME_BASE;
 349             }
 350
 351             // Save start frame in case we are starting based on time and fading based on frames
 352             if (s->start_time != 0 && s->start_frame == 0) {
 353                 s->start_frame = inlink->frame_count_out;
 354             }
 355         }
 356     }
 357     if (s->fade_state == VF_FADE_FADING) {
 358         if (s->duration == 0) {
 359             // Fading based on frame count
 360             s->factor = (inlink->frame_count_out - s->start_frame) * s->fade_per_frame;
 361             if (inlink->frame_count_out > s->start_frame + s->nb_frames) {
 362                 s->fade_state = VF_FADE_DONE;
 363             }
 364
 365         } else {
 366             // Fading based on duration
 367             s->factor = (frame_timestamp - s->start_time/(double)AV_TIME_BASE)
 368                             * (float) UINT16_MAX / (s->duration/(double)AV_TIME_BASE);
 369             if (frame_timestamp > s->start_time/(double)AV_TIME_BASE
 370                                   + s->duration/(double)AV_TIME_BASE) {
 371                 s->fade_state = VF_FADE_DONE;
 372             }
 373         }
 374     }
 375     if (s->fade_state == VF_FADE_DONE) {
 376         s->factor=UINT16_MAX;
 377     }
 378
 379     s->factor = av_clip_uint16(s->factor);
 380
 381     // Invert fade_factor if Fading Out
 382     if (s->type == FADE_OUT) {
 383         s->factor=UINT16_MAX-s->factor;
 384     }
 385
 386     if (s->factor < UINT16_MAX) {
 387         if (s->alpha) {
 388             ctx->internal->execute(ctx, filter_slice_alpha, frame, NULL,
 389                                 FFMIN(frame->height, ff_filter_get_nb_threads(ctx)));
 390         } else if (s->is_rgb && !s->black_fade) {
 391             ctx->internal->execute(ctx, filter_slice_rgb, frame, NULL,
 392                                    FFMIN(frame->height, ff_filter_get_nb_threads(ctx)));
 393         } else {
 394             /* luma, or rgb plane in case of black */
 395             ctx->internal->execute(ctx, filter_slice_luma, frame, NULL,
 396                                 FFMIN(frame->height, ff_filter_get_nb_threads(ctx)));
 397
 398             if (frame->data[1] && frame->data[2] && !s->is_rgb) {
 399                 /* chroma planes */
 400                 ctx->internal->execute(ctx, filter_slice_chroma, frame, NULL,
 401                                     FFMIN(frame->height, ff_filter_get_nb_threads(ctx)));
 402             }
 403         }
 404     }
 405
 406     return ff_filter_frame(inlink->dst->outputs[0], frame);
 407 }
 408
 409
 410 #define OFFSET(x) offsetof(FadeContext, x)
 411 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
 412
 413 static const AVOption fade_options[] = {
 414     { "type", "set the fade direction", OFFSET(type), AV_OPT_TYPE_INT, { .i64 = FADE_IN }, FADE_IN, FADE_OUT, FLAGS, "type" },
 415     { "t",    "set the fade direction", OFFSET(type), AV_OPT_TYPE_INT, { .i64 = FADE_IN }, FADE_IN, FADE_OUT, FLAGS, "type" },
 416         { "in",  "fade-in",  0, AV_OPT_TYPE_CONST, { .i64 = FADE_IN },  .flags = FLAGS, .unit = "type" },
 417         { "out", "fade-out", 0, AV_OPT_TYPE_CONST, { .i64 = FADE_OUT }, .flags = FLAGS, .unit = "type" },
 418     { "start_frame", "Number of the first frame to which to apply the effect.",
 419                                                     OFFSET(start_frame), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, FLAGS },
 420     { "s",           "Number of the first frame to which to apply the effect.",
 421                                                     OFFSET(start_frame), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, FLAGS },
 422     { "nb_frames",   "Number of frames to which the effect should be applied.",
 423                                                     OFFSET(nb_frames),   AV_OPT_TYPE_INT, { .i64 = 25 }, 1, INT_MAX, FLAGS },
 424     { "n",           "Number of frames to which the effect should be applied.",
 425                                                     OFFSET(nb_frames),   AV_OPT_TYPE_INT, { .i64 = 25 }, 1, INT_MAX, FLAGS },
 426     { "alpha",       "fade alpha if it is available on the input", OFFSET(alpha),       AV_OPT_TYPE_BOOL, {.i64 = 0    }, 0,       1, FLAGS },
 427     { "start_time",  "Number of seconds of the beginning of the effect.",
 428                                                     OFFSET(start_time),  AV_OPT_TYPE_DURATION, {.i64 = 0. }, 0, INT64_MAX, FLAGS },
 429     { "st",          "Number of seconds of the beginning of the effect.",
 430                                                     OFFSET(start_time),  AV_OPT_TYPE_DURATION, {.i64 = 0. }, 0, INT64_MAX, FLAGS },
 431     { "duration",    "Duration of the effect in seconds.",
 432                                                     OFFSET(duration),    AV_OPT_TYPE_DURATION, {.i64 = 0. }, 0, INT64_MAX, FLAGS },
 433     { "d",           "Duration of the effect in seconds.",
 434                                                     OFFSET(duration),    AV_OPT_TYPE_DURATION, {.i64 = 0. }, 0, INT64_MAX, FLAGS },
 435     { "color",       "set color",                   OFFSET(color_rgba),  AV_OPT_TYPE_COLOR,    {.str = "black"}, CHAR_MIN, CHAR_MAX, FLAGS },
 436     { "c",           "set color",                   OFFSET(color_rgba),  AV_OPT_TYPE_COLOR,    {.str = "black"}, CHAR_MIN, CHAR_MAX, FLAGS },
 437     { NULL }
 438 };
 439
 440 AVFILTER_DEFINE_CLASS(fade);
 441
 442 static const AVFilterPad avfilter_vf_fade_inputs[] = {
 443     {
 444         .name           = "default",
 445         .type           = AVMEDIA_TYPE_VIDEO,
 446         .config_props   = config_props,
 447         .filter_frame   = filter_frame,
 448         .needs_writable = 1,
 449     },
 450     { NULL }
 451 };
 452
 453 static const AVFilterPad avfilter_vf_fade_outputs[] = {
 454     {
 455         .name = "default",
 456         .type = AVMEDIA_TYPE_VIDEO,
 457     },
 458     { NULL }
 459 };
 460
 461 AVFilter ff_vf_fade = {
 462     .name          = "fade",
 463     .description   = NULL_IF_CONFIG_SMALL("Fade in/out input video."),
 464     .init          = init,
 465     .priv_size     = sizeof(FadeContext),
 466     .priv_class    = &fade_class,
 467     .query_formats = query_formats,
 468     .inputs        = avfilter_vf_fade_inputs,
 469     .outputs       = avfilter_vf_fade_outputs,
 470     .flags         = AVFILTER_FLAG_SLICE_THREADS,
 471 };