libavfilter/vf_fade.c

   1 /*
   2  * Copyright (c) 2010 Brandon Mintern
   3  * Copyright (c) 2007 Bobby Bingham
   4  *
   5  * This file is part of Libav.
   6  *
   7  * Libav 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  * Libav 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 Libav; 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/pixdesc.h"
  29 #include "avfilter.h"
  30 #include "formats.h"
  31 #include "video.h"
  32
  33 typedef struct {
  34     int factor, fade_per_frame;
  35     unsigned int frame_index, start_frame, stop_frame;
  36     int hsub, vsub, bpp;
  37 } FadeContext;
  38
  39 static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)
  40 {
  41     FadeContext *fade = ctx->priv;
  42     unsigned int nb_frames;
  43     char in_out[4];
  44
  45     if (!args ||
  46         sscanf(args, " %3[^:]:%u:%u", in_out, &fade->start_frame, &nb_frames) != 3) {
  47         av_log(ctx, AV_LOG_ERROR,
  48                "Expected 3 arguments '(in|out):#:#':'%s'\n", args);
  49         return AVERROR(EINVAL);
  50     }
  51
  52     nb_frames = nb_frames ? nb_frames : 1;
  53     fade->fade_per_frame = (1 << 16) / nb_frames;
  54     if (!strcmp(in_out, "in"))
  55         fade->factor = 0;
  56     else if (!strcmp(in_out, "out")) {
  57         fade->fade_per_frame = -fade->fade_per_frame;
  58         fade->factor = (1 << 16);
  59     } else {
  60         av_log(ctx, AV_LOG_ERROR,
  61                "first argument must be 'in' or 'out':'%s'\n", in_out);
  62         return AVERROR(EINVAL);
  63     }
  64     fade->stop_frame = fade->start_frame + nb_frames;
  65
  66     av_log(ctx, AV_LOG_INFO,
  67            "type:%s start_frame:%d nb_frames:%d\n",
  68            in_out, fade->start_frame, nb_frames);
  69     return 0;
  70 }
  71
  72 static int query_formats(AVFilterContext *ctx)
  73 {
  74     static const enum PixelFormat pix_fmts[] = {
  75         PIX_FMT_YUV444P,  PIX_FMT_YUV422P,  PIX_FMT_YUV420P,
  76         PIX_FMT_YUV411P,  PIX_FMT_YUV410P,
  77         PIX_FMT_YUVJ444P, PIX_FMT_YUVJ422P, PIX_FMT_YUVJ420P,
  78         PIX_FMT_YUV440P,  PIX_FMT_YUVJ440P,
  79         PIX_FMT_RGB24,    PIX_FMT_BGR24,
  80         PIX_FMT_NONE
  81     };
  82
  83     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
  84     return 0;
  85 }
  86
  87 static int config_props(AVFilterLink *inlink)
  88 {
  89     FadeContext *fade = inlink->dst->priv;
  90     const AVPixFmtDescriptor *pixdesc = &av_pix_fmt_descriptors[inlink->format];
  91
  92     fade->hsub = pixdesc->log2_chroma_w;
  93     fade->vsub = pixdesc->log2_chroma_h;
  94
  95     fade->bpp = av_get_bits_per_pixel(pixdesc) >> 3;
  96     return 0;
  97 }
  98
  99 static void draw_slice(AVFilterLink *inlink, int y, int h, int slice_dir)
 100 {
 101     FadeContext *fade = inlink->dst->priv;
 102     AVFilterBufferRef *outpic = inlink->cur_buf;
 103     uint8_t *p;
 104     int i, j, plane;
 105
 106     if (fade->factor < UINT16_MAX) {
 107         /* luma or rgb plane */
 108         for (i = 0; i < h; i++) {
 109             p = outpic->data[0] + (y+i) * outpic->linesize[0];
 110             for (j = 0; j < inlink->w * fade->bpp; j++) {
 111                 /* fade->factor is using 16 lower-order bits for decimal
 112                  * places. 32768 = 1 << 15, it is an integer representation
 113                  * of 0.5 and is for rounding. */
 114                 *p = (*p * fade->factor + 32768) >> 16;
 115                 p++;
 116             }
 117         }
 118
 119         if (outpic->data[1] && outpic->data[2]) {
 120             /* chroma planes */
 121             for (plane = 1; plane < 3; plane++) {
 122                 for (i = 0; i < h; i++) {
 123                     p = outpic->data[plane] + ((y+i) >> fade->vsub) * outpic->linesize[plane];
 124                     for (j = 0; j < inlink->w >> fade->hsub; j++) {
 125                         /* 8421367 = ((128 << 1) + 1) << 15. It is an integer
 126                          * representation of 128.5. The .5 is for rounding
 127                          * purposes. */
 128                         *p = ((*p - 128) * fade->factor + 8421367) >> 16;
 129                         p++;
 130                     }
 131                 }
 132             }
 133         }
 134     }
 135
 136     avfilter_draw_slice(inlink->dst->outputs[0], y, h, slice_dir);
 137 }
 138
 139 static void end_frame(AVFilterLink *inlink)
 140 {
 141     FadeContext *fade = inlink->dst->priv;
 142
 143     avfilter_end_frame(inlink->dst->outputs[0]);
 144
 145     if (fade->frame_index >= fade->start_frame &&
 146         fade->frame_index <= fade->stop_frame)
 147         fade->factor += fade->fade_per_frame;
 148     fade->factor = av_clip_uint16(fade->factor);
 149     fade->frame_index++;
 150 }
 151
 152 AVFilter avfilter_vf_fade = {
 153     .name          = "fade",
 154     .description   = NULL_IF_CONFIG_SMALL("Fade in/out input video"),
 155     .init          = init,
 156     .priv_size     = sizeof(FadeContext),
 157     .query_formats = query_formats,
 158
 159     .inputs    = (AVFilterPad[]) {{ .name            = "default",
 160                                     .type            = AVMEDIA_TYPE_VIDEO,
 161                                     .config_props    = config_props,
 162                                     .get_video_buffer = ff_null_get_video_buffer,
 163                                     .start_frame      = ff_null_start_frame,
 164                                     .draw_slice      = draw_slice,
 165                                     .end_frame       = end_frame,
 166                                     .min_perms       = AV_PERM_READ | AV_PERM_WRITE,
 167                                     .rej_perms       = AV_PERM_PRESERVE, },
 168                                   { .name = NULL}},
 169     .outputs   = (AVFilterPad[]) {{ .name            = "default",
 170                                     .type            = AVMEDIA_TYPE_VIDEO, },
 171                                   { .name = NULL}},
 172 };