yading@10: /*
yading@10:  * Copyright (c) 2010 Brandon Mintern
yading@10:  * Copyright (c) 2007 Bobby Bingham
yading@10:  *
yading@10:  * This file is part of FFmpeg.
yading@10:  *
yading@10:  * FFmpeg is free software; you can redistribute it and/or
yading@10:  * modify it under the terms of the GNU Lesser General Public
yading@10:  * License as published by the Free Software Foundation; either
yading@10:  * version 2.1 of the License, or (at your option) any later version.
yading@10:  *
yading@10:  * FFmpeg is distributed in the hope that it will be useful,
yading@10:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
yading@10:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
yading@10:  * Lesser General Public License for more details.
yading@10:  *
yading@10:  * You should have received a copy of the GNU Lesser General Public
yading@10:  * License along with FFmpeg; if not, write to the Free Software
yading@10:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
yading@10:  */
yading@10: 
yading@10: /**
yading@10:  * @file
yading@10:  * video fade filter
yading@10:  * based heavily on vf_negate.c by Bobby Bingham
yading@10:  */
yading@10: 
yading@10: #include "libavutil/avstring.h"
yading@10: #include "libavutil/common.h"
yading@10: #include "libavutil/eval.h"
yading@10: #include "libavutil/opt.h"
yading@10: #include "libavutil/pixdesc.h"
yading@10: #include "avfilter.h"
yading@10: #include "drawutils.h"
yading@10: #include "internal.h"
yading@10: #include "formats.h"
yading@10: #include "internal.h"
yading@10: #include "video.h"
yading@10: 
yading@10: #define R 0
yading@10: #define G 1
yading@10: #define B 2
yading@10: #define A 3
yading@10: 
yading@10: #define Y 0
yading@10: #define U 1
yading@10: #define V 2
yading@10: 
yading@10: #define FADE_IN  0
yading@10: #define FADE_OUT 1
yading@10: 
yading@10: typedef struct {
yading@10:     const AVClass *class;
yading@10:     int type;
yading@10:     int factor, fade_per_frame;
yading@10:     int start_frame, nb_frames;
yading@10:     unsigned int frame_index, stop_frame;
yading@10:     int hsub, vsub, bpp;
yading@10:     unsigned int black_level, black_level_scaled;
yading@10:     uint8_t is_packed_rgb;
yading@10:     uint8_t rgba_map[4];
yading@10:     int alpha;
yading@10: 
yading@10: } FadeContext;
yading@10: 
yading@10: static av_cold int init(AVFilterContext *ctx)
yading@10: {
yading@10:     FadeContext *fade = ctx->priv;
yading@10: 
yading@10:     fade->fade_per_frame = (1 << 16) / fade->nb_frames;
yading@10:     if (fade->type == FADE_IN) {
yading@10:         fade->factor = 0;
yading@10:     } else if (fade->type == FADE_OUT) {
yading@10:         fade->fade_per_frame = -fade->fade_per_frame;
yading@10:         fade->factor = (1 << 16);
yading@10:     }
yading@10:     fade->stop_frame = fade->start_frame + fade->nb_frames;
yading@10: 
yading@10:     av_log(ctx, AV_LOG_VERBOSE,
yading@10:            "type:%s start_frame:%d nb_frames:%d alpha:%d\n",
yading@10:            fade->type == FADE_IN ? "in" : "out", fade->start_frame,
yading@10:            fade->nb_frames, fade->alpha);
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: static int query_formats(AVFilterContext *ctx)
yading@10: {
yading@10:     static const enum AVPixelFormat pix_fmts[] = {
yading@10:         AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P,
yading@10:         AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV410P,
yading@10:         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
yading@10:         AV_PIX_FMT_YUV440P,  AV_PIX_FMT_YUVJ440P,
yading@10:         AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,
yading@10:         AV_PIX_FMT_RGB24,    AV_PIX_FMT_BGR24,
yading@10:         AV_PIX_FMT_ARGB,     AV_PIX_FMT_ABGR,
yading@10:         AV_PIX_FMT_RGBA,     AV_PIX_FMT_BGRA,
yading@10:         AV_PIX_FMT_NONE
yading@10:     };
yading@10: 
yading@10:     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: const static enum AVPixelFormat studio_level_pix_fmts[] = {
yading@10:     AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P,
yading@10:     AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV410P,
yading@10:     AV_PIX_FMT_YUV440P,
yading@10:     AV_PIX_FMT_NONE
yading@10: };
yading@10: 
yading@10: static int config_props(AVFilterLink *inlink)
yading@10: {
yading@10:     FadeContext *fade = inlink->dst->priv;
yading@10:     const AVPixFmtDescriptor *pixdesc = av_pix_fmt_desc_get(inlink->format);
yading@10: 
yading@10:     fade->hsub = pixdesc->log2_chroma_w;
yading@10:     fade->vsub = pixdesc->log2_chroma_h;
yading@10: 
yading@10:     fade->bpp = av_get_bits_per_pixel(pixdesc) >> 3;
yading@10:     fade->alpha &= pixdesc->flags & PIX_FMT_ALPHA;
yading@10:     fade->is_packed_rgb = ff_fill_rgba_map(fade->rgba_map, inlink->format) >= 0;
yading@10: 
yading@10:     /* use CCIR601/709 black level for studio-level pixel non-alpha components */
yading@10:     fade->black_level =
yading@10:             ff_fmt_is_in(inlink->format, studio_level_pix_fmts) && !fade->alpha ? 16 : 0;
yading@10:     /* 32768 = 1 << 15, it is an integer representation
yading@10:      * of 0.5 and is for rounding. */
yading@10:     fade->black_level_scaled = (fade->black_level << 16) + 32768;
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: static void fade_plane(int y, int h, int w,
yading@10:                        int fade_factor, int black_level, int black_level_scaled,
yading@10:                        uint8_t offset, uint8_t step, int bytes_per_plane,
yading@10:                        uint8_t *data, int line_size)
yading@10: {
yading@10:     uint8_t *p;
yading@10:     int i, j;
yading@10: 
yading@10:     /* luma, alpha or rgb plane */
yading@10:     for (i = 0; i < h; i++) {
yading@10:         p = data + offset + (y+i) * line_size;
yading@10:         for (j = 0; j < w * bytes_per_plane; j++) {
yading@10:             /* fade->factor is using 16 lower-order bits for decimal places. */
yading@10:             *p = ((*p - black_level) * fade_factor + black_level_scaled) >> 16;
yading@10:             p+=step;
yading@10:         }
yading@10:     }
yading@10: }
yading@10: 
yading@10: static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
yading@10: {
yading@10:     FadeContext *fade = inlink->dst->priv;
yading@10:     uint8_t *p;
yading@10:     int i, j, plane;
yading@10: 
yading@10:     if (fade->factor < UINT16_MAX) {
yading@10:         if (fade->alpha) {
yading@10:             // alpha only
yading@10:             plane = fade->is_packed_rgb ? 0 : A; // alpha is on plane 0 for packed formats
yading@10:                                                  // or plane 3 for planar formats
yading@10:             fade_plane(0, frame->height, inlink->w,
yading@10:                        fade->factor, fade->black_level, fade->black_level_scaled,
yading@10:                        fade->is_packed_rgb ? fade->rgba_map[A] : 0, // alpha offset for packed formats
yading@10:                        fade->is_packed_rgb ? 4 : 1,                 // pixstep for 8 bit packed formats
yading@10:                        1, frame->data[plane], frame->linesize[plane]);
yading@10:         } else {
yading@10:             /* luma or rgb plane */
yading@10:             fade_plane(0, frame->height, inlink->w,
yading@10:                        fade->factor, fade->black_level, fade->black_level_scaled,
yading@10:                        0, 1, // offset & pixstep for Y plane or RGB packed format
yading@10:                        fade->bpp, frame->data[0], frame->linesize[0]);
yading@10:             if (frame->data[1] && frame->data[2]) {
yading@10:                 /* chroma planes */
yading@10:                 for (plane = 1; plane < 3; plane++) {
yading@10:                     for (i = 0; i < frame->height; i++) {
yading@10:                         p = frame->data[plane] + (i >> fade->vsub) * frame->linesize[plane];
yading@10:                         for (j = 0; j < inlink->w >> fade->hsub; j++) {
yading@10:                             /* 8421367 = ((128 << 1) + 1) << 15. It is an integer
yading@10:                              * representation of 128.5. The .5 is for rounding
yading@10:                              * purposes. */
yading@10:                             *p = ((*p - 128) * fade->factor + 8421367) >> 16;
yading@10:                             p++;
yading@10:                         }
yading@10:                     }
yading@10:                 }
yading@10:             }
yading@10:         }
yading@10:     }
yading@10: 
yading@10:     if (fade->frame_index >= fade->start_frame &&
yading@10:         fade->frame_index <= fade->stop_frame)
yading@10:         fade->factor += fade->fade_per_frame;
yading@10:     fade->factor = av_clip_uint16(fade->factor);
yading@10:     fade->frame_index++;
yading@10: 
yading@10:     return ff_filter_frame(inlink->dst->outputs[0], frame);
yading@10: }
yading@10: 
yading@10: 
yading@10: #define OFFSET(x) offsetof(FadeContext, x)
yading@10: #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
yading@10: 
yading@10: static const AVOption fade_options[] = {
yading@10:     { "type", "'in' or 'out' for fade-in/fade-out", OFFSET(type), AV_OPT_TYPE_INT, { .i64 = FADE_IN }, FADE_IN, FADE_OUT, FLAGS, "type" },
yading@10:     { "t",    "'in' or 'out' for fade-in/fade-out", OFFSET(type), AV_OPT_TYPE_INT, { .i64 = FADE_IN }, FADE_IN, FADE_OUT, FLAGS, "type" },
yading@10:         { "in",  "fade-in",  0, AV_OPT_TYPE_CONST, { .i64 = FADE_IN },  .unit = "type" },
yading@10:         { "out", "fade-out", 0, AV_OPT_TYPE_CONST, { .i64 = FADE_OUT }, .unit = "type" },
yading@10:     { "start_frame", "Number of the first frame to which to apply the effect.",
yading@10:                                                     OFFSET(start_frame), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, FLAGS },
yading@10:     { "s",           "Number of the first frame to which to apply the effect.",
yading@10:                                                     OFFSET(start_frame), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, FLAGS },
yading@10:     { "nb_frames",   "Number of frames to which the effect should be applied.",
yading@10:                                                     OFFSET(nb_frames),   AV_OPT_TYPE_INT, { .i64 = 25 }, 0, INT_MAX, FLAGS },
yading@10:     { "n",           "Number of frames to which the effect should be applied.",
yading@10:                                                     OFFSET(nb_frames),   AV_OPT_TYPE_INT, { .i64 = 25 }, 0, INT_MAX, FLAGS },
yading@10:     { "alpha",       "fade alpha if it is available on the input", OFFSET(alpha),       AV_OPT_TYPE_INT, {.i64 = 0    }, 0,       1, FLAGS },
yading@10:     { NULL },
yading@10: };
yading@10: 
yading@10: AVFILTER_DEFINE_CLASS(fade);
yading@10: 
yading@10: static const AVFilterPad avfilter_vf_fade_inputs[] = {
yading@10:     {
yading@10:         .name             = "default",
yading@10:         .type             = AVMEDIA_TYPE_VIDEO,
yading@10:         .config_props     = config_props,
yading@10:         .get_video_buffer = ff_null_get_video_buffer,
yading@10:         .filter_frame     = filter_frame,
yading@10:         .needs_writable   = 1,
yading@10:     },
yading@10:     { NULL }
yading@10: };
yading@10: 
yading@10: static const AVFilterPad avfilter_vf_fade_outputs[] = {
yading@10:     {
yading@10:         .name = "default",
yading@10:         .type = AVMEDIA_TYPE_VIDEO,
yading@10:     },
yading@10:     { NULL }
yading@10: };
yading@10: 
yading@10: AVFilter avfilter_vf_fade = {
yading@10:     .name          = "fade",
yading@10:     .description   = NULL_IF_CONFIG_SMALL("Fade in/out input video."),
yading@10:     .init          = init,
yading@10:     .priv_size     = sizeof(FadeContext),
yading@10:     .priv_class    = &fade_class,
yading@10:     .query_formats = query_formats,
yading@10: 
yading@10:     .inputs    = avfilter_vf_fade_inputs,
yading@10:     .outputs   = avfilter_vf_fade_outputs,
yading@10: };