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