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/eval.h"
  30 #include "libavutil/opt.h"
  31 #include "libavutil/pixdesc.h"
  32 #include "avfilter.h"
  33 #include "drawutils.h"
  34 #include "internal.h"
  35 #include "formats.h"
  36 #include "internal.h"
  37 #include "video.h"
  38
  39 #define R 0
  40 #define G 1
  41 #define B 2
  42 #define A 3
  43
  44 #define Y 0
  45 #define U 1
  46 #define V 2
  47
  48 typedef struct {
  49     const AVClass *class;
  50     int factor, fade_per_frame;
  51     unsigned int frame_index, start_frame, stop_frame, nb_frames;
  52     int hsub, vsub, bpp;
  53     unsigned int black_level, black_level_scaled;
  54     uint8_t is_packed_rgb;
  55     uint8_t rgba_map[4];
  56     int alpha;
  57
  58     char *type;
  59 } FadeContext;
  60
  61 #define OFFSET(x) offsetof(FadeContext, x)
  62
  63 static const AVOption fade_options[] = {
  64     { "type",        "set the fade direction",                     OFFSET(type),        AV_OPT_TYPE_STRING, {.str = "in" }, CHAR_MIN, CHAR_MAX },
  65     { "t",           "set the fade direction",                     OFFSET(type),        AV_OPT_TYPE_STRING, {.str = "in" }, CHAR_MIN, CHAR_MAX },
  66     { "start_frame", "set expression of frame to start fading",    OFFSET(start_frame), AV_OPT_TYPE_INT, {.dbl = 0    }, 0, INT_MAX },
  67     { "s",           "set expression of frame to start fading",    OFFSET(start_frame), AV_OPT_TYPE_INT, {.dbl = 0    }, 0, INT_MAX },
  68     { "nb_frames",   "set expression for fade duration in frames", OFFSET(nb_frames),   AV_OPT_TYPE_INT, {.dbl = 25   }, 0, INT_MAX },
  69     { "n",           "set expression for fade duration in frames", OFFSET(nb_frames),   AV_OPT_TYPE_INT, {.dbl = 25   }, 0, INT_MAX },
  70     { "alpha",       "fade alpha if it is available on the input", OFFSET(alpha),       AV_OPT_TYPE_INT, {.dbl = 0    }, 0,       1 },
  71     {NULL},
  72 };
  73
  74 static const AVClass fade_class = {
  75     .class_name = "fade",
  76     .item_name  = av_default_item_name,
  77     .option     = fade_options,
  78     .version    = LIBAVUTIL_VERSION_INT,
  79     .category   = AV_CLASS_CATEGORY_FILTER,
  80 };
  81
  82 static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)
  83 {
  84     FadeContext *fade = ctx->priv;
  85     int ret = 0;
  86     char *args1, *expr, *bufptr = NULL;
  87
  88     fade->class = &fade_class;
  89     av_opt_set_defaults(fade);
  90
  91     if (!(args1 = av_strdup(args))) {
  92         ret = AVERROR(ENOMEM);
  93         goto end;
  94     }
  95
  96     if (expr = av_strtok(args1, ":", &bufptr)) {
  97         av_free(fade->type);
  98         if (!(fade->type = av_strdup(expr))) {
  99             ret = AVERROR(ENOMEM);
 100             goto end;
 101         }
 102     }
 103     if (expr = av_strtok(NULL, ":", &bufptr)) {
 104         if ((ret = av_opt_set(fade, "start_frame", expr, 0)) < 0) {
 105             av_log(ctx, AV_LOG_ERROR,
 106                    "Invalid value '%s' for start_frame option\n", expr);
 107             return ret;
 108         }
 109     }
 110     if (expr = av_strtok(NULL, ":", &bufptr)) {
 111         if ((ret = av_opt_set(fade, "nb_frames", expr, 0)) < 0) {
 112             av_log(ctx, AV_LOG_ERROR,
 113                    "Invalid value '%s' for nb_frames option\n", expr);
 114             return ret;
 115         }
 116     }
 117
 118     if (bufptr && (ret = av_set_options_string(fade, bufptr, "=", ":")) < 0)
 119         goto end;
 120
 121     fade->fade_per_frame = (1 << 16) / fade->nb_frames;
 122     if (!strcmp(fade->type, "in"))
 123         fade->factor = 0;
 124     else if (!strcmp(fade->type, "out")) {
 125         fade->fade_per_frame = -fade->fade_per_frame;
 126         fade->factor = (1 << 16);
 127     } else {
 128         av_log(ctx, AV_LOG_ERROR,
 129                "Type argument must be 'in' or 'out' but '%s' was specified\n", fade->type);
 130         ret = AVERROR(EINVAL);
 131         goto end;
 132     }
 133     fade->stop_frame = fade->start_frame + fade->nb_frames;
 134
 135     av_log(ctx, AV_LOG_INFO,
 136            "type:%s start_frame:%d nb_frames:%d alpha:%d\n",
 137            fade->type, fade->start_frame, fade->nb_frames, fade->alpha);
 138
 139 end:
 140     av_free(args1);
 141     return ret;
 142 }
 143
 144 static av_cold void uninit(AVFilterContext *ctx)
 145 {
 146     FadeContext *fade = ctx->priv;
 147
 148     av_freep(&fade->type);
 149 }
 150
 151 static int query_formats(AVFilterContext *ctx)
 152 {
 153     static const enum PixelFormat pix_fmts[] = {
 154         PIX_FMT_YUV444P,  PIX_FMT_YUV422P,  PIX_FMT_YUV420P,
 155         PIX_FMT_YUV411P,  PIX_FMT_YUV410P,
 156         PIX_FMT_YUVJ444P, PIX_FMT_YUVJ422P, PIX_FMT_YUVJ420P,
 157         PIX_FMT_YUV440P,  PIX_FMT_YUVJ440P,
 158         PIX_FMT_YUVA420P,
 159         PIX_FMT_RGB24,    PIX_FMT_BGR24,
 160         PIX_FMT_ARGB,     PIX_FMT_ABGR,
 161         PIX_FMT_RGBA,     PIX_FMT_BGRA,
 162         PIX_FMT_NONE
 163     };
 164
 165     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
 166     return 0;
 167 }
 168
 169 const static enum PixelFormat studio_level_pix_fmts[] = {
 170     PIX_FMT_YUV444P,  PIX_FMT_YUV422P,  PIX_FMT_YUV420P,
 171     PIX_FMT_YUV411P,  PIX_FMT_YUV410P,
 172     PIX_FMT_YUV440P,
 173     PIX_FMT_NONE
 174 };
 175
 176 static enum PixelFormat alpha_pix_fmts[] = {
 177     PIX_FMT_YUVA420P,
 178     PIX_FMT_ARGB, PIX_FMT_ABGR,
 179     PIX_FMT_RGBA, PIX_FMT_BGRA,
 180     PIX_FMT_NONE
 181 };
 182
 183 static int config_props(AVFilterLink *inlink)
 184 {
 185     FadeContext *fade = inlink->dst->priv;
 186     const AVPixFmtDescriptor *pixdesc = &av_pix_fmt_descriptors[inlink->format];
 187
 188     fade->hsub = pixdesc->log2_chroma_w;
 189     fade->vsub = pixdesc->log2_chroma_h;
 190
 191     fade->bpp = av_get_bits_per_pixel(pixdesc) >> 3;
 192     fade->alpha = fade->alpha ? ff_fmt_is_in(inlink->format, alpha_pix_fmts) : 0;
 193     fade->is_packed_rgb = ff_fill_rgba_map(fade->rgba_map, inlink->format) >= 0;
 194
 195     /* use CCIR601/709 black level for studio-level pixel non-alpha components */
 196     fade->black_level =
 197             ff_fmt_is_in(inlink->format, studio_level_pix_fmts) && !fade->alpha ? 16 : 0;
 198     /* 32768 = 1 << 15, it is an integer representation
 199      * of 0.5 and is for rounding. */
 200     fade->black_level_scaled = (fade->black_level << 16) + 32768;
 201     return 0;
 202 }
 203
 204 static void fade_plane(int y, int h, int w,
 205                        int fade_factor, int black_level, int black_level_scaled,
 206                        uint8_t offset, uint8_t step, int bytes_per_plane,
 207                        uint8_t *data, int line_size)
 208 {
 209     uint8_t *p;
 210     int i, j;
 211
 212     /* luma, alpha or rgb plane */
 213     for (i = 0; i < h; i++) {
 214         p = data + offset + (y+i) * line_size;
 215         for (j = 0; j < w * bytes_per_plane; j++) {
 216             /* fade->factor is using 16 lower-order bits for decimal places. */
 217             *p = ((*p - black_level) * fade_factor + black_level_scaled) >> 16;
 218             p+=step;
 219         }
 220     }
 221 }
 222
 223 static void draw_slice(AVFilterLink *inlink, int y, int h, int slice_dir)
 224 {
 225     FadeContext *fade = inlink->dst->priv;
 226     AVFilterBufferRef *outpic = inlink->cur_buf;
 227     uint8_t *p;
 228     int i, j, plane;
 229
 230     if (fade->factor < UINT16_MAX) {
 231         if (fade->alpha) {
 232             // alpha only
 233             plane = fade->is_packed_rgb ? 0 : A; // alpha is on plane 0 for packed formats
 234                                                  // or plane 3 for planar formats
 235             fade_plane(y, h, inlink->w,
 236                        fade->factor, fade->black_level, fade->black_level_scaled,
 237                        fade->is_packed_rgb ? fade->rgba_map[A] : 0, // alpha offset for packed formats
 238                        fade->is_packed_rgb ? 4 : 1,                 // pixstep for 8 bit packed formats
 239                        1, outpic->data[plane], outpic->linesize[plane]);
 240         } else {
 241             /* luma or rgb plane */
 242             fade_plane(y, h, inlink->w,
 243                        fade->factor, fade->black_level, fade->black_level_scaled,
 244                        0, 1, // offset & pixstep for Y plane or RGB packed format
 245                        fade->bpp, outpic->data[0], outpic->linesize[0]);
 246             if (outpic->data[1] && outpic->data[2]) {
 247                 /* chroma planes */
 248                 for (plane = 1; plane < 3; plane++) {
 249                     for (i = 0; i < h; i++) {
 250                         p = outpic->data[plane] + ((y+i) >> fade->vsub) * outpic->linesize[plane];
 251                         for (j = 0; j < inlink->w >> fade->hsub; j++) {
 252                             /* 8421367 = ((128 << 1) + 1) << 15. It is an integer
 253                              * representation of 128.5. The .5 is for rounding
 254                              * purposes. */
 255                             *p = ((*p - 128) * fade->factor + 8421367) >> 16;
 256                             p++;
 257                         }
 258                     }
 259                 }
 260             }
 261         }
 262     }
 263
 264     ff_draw_slice(inlink->dst->outputs[0], y, h, slice_dir);
 265 }
 266
 267 static void end_frame(AVFilterLink *inlink)
 268 {
 269     FadeContext *fade = inlink->dst->priv;
 270
 271     ff_end_frame(inlink->dst->outputs[0]);
 272
 273     if (fade->frame_index >= fade->start_frame &&
 274         fade->frame_index <= fade->stop_frame)
 275         fade->factor += fade->fade_per_frame;
 276     fade->factor = av_clip_uint16(fade->factor);
 277     fade->frame_index++;
 278 }
 279
 280 AVFilter avfilter_vf_fade = {
 281     .name          = "fade",
 282     .description   = NULL_IF_CONFIG_SMALL("Fade in/out input video."),
 283     .init          = init,
 284     .uninit        = uninit,
 285     .priv_size     = sizeof(FadeContext),
 286     .query_formats = query_formats,
 287
 288     .inputs    = (const AVFilterPad[]) {{ .name      = "default",
 289                                     .type            = AVMEDIA_TYPE_VIDEO,
 290                                     .config_props    = config_props,
 291                                     .get_video_buffer = ff_null_get_video_buffer,
 292                                     .start_frame      = ff_null_start_frame,
 293                                     .draw_slice      = draw_slice,
 294                                     .end_frame       = end_frame,
 295                                     .min_perms       = AV_PERM_READ | AV_PERM_WRITE,
 296                                     .rej_perms       = AV_PERM_PRESERVE, },
 297                                   { .name = NULL}},
 298     .outputs   = (const AVFilterPad[]) {{ .name      = "default",
 299                                     .type            = AVMEDIA_TYPE_VIDEO, },
 300                                   { .name = NULL}},
 301 };