2 * Copyright (c) 2010 Brandon Mintern
3 * Copyright (c) 2007 Bobby Bingham
5 * This file is part of FFmpeg.
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.
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.
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
25 * based heavily on vf_negate.c by Bobby Bingham
28 #include "libavutil/avstring.h"
29 #include "libavutil/common.h"
30 #include "libavutil/eval.h"
31 #include "libavutil/opt.h"
32 #include "libavutil/pixdesc.h"
34 #include "drawutils.h"
51 int factor, fade_per_frame;
52 unsigned int frame_index, start_frame, stop_frame, nb_frames;
54 unsigned int black_level, black_level_scaled;
55 uint8_t is_packed_rgb;
62 #define OFFSET(x) offsetof(FadeContext, x)
63 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
65 static const AVOption fade_options[] = {
66 { "type", "set the fade direction", OFFSET(type), AV_OPT_TYPE_STRING, {.str = "in" }, CHAR_MIN, CHAR_MAX, FLAGS },
67 { "t", "set the fade direction", OFFSET(type), AV_OPT_TYPE_STRING, {.str = "in" }, CHAR_MIN, CHAR_MAX, FLAGS },
68 { "start_frame", "set expression of frame to start fading", OFFSET(start_frame), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, FLAGS },
69 { "s", "set expression of frame to start fading", OFFSET(start_frame), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, FLAGS },
70 { "nb_frames", "set expression for fade duration in frames", OFFSET(nb_frames), AV_OPT_TYPE_INT, {.i64 = 25 }, 0, INT_MAX, FLAGS },
71 { "n", "set expression for fade duration in frames", OFFSET(nb_frames), AV_OPT_TYPE_INT, {.i64 = 25 }, 0, INT_MAX, FLAGS },
72 { "alpha", "fade alpha if it is available on the input", OFFSET(alpha), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, 1, FLAGS },
76 AVFILTER_DEFINE_CLASS(fade);
78 static av_cold int init(AVFilterContext *ctx, const char *args)
80 FadeContext *fade = ctx->priv;
81 static const char *shorthand[] = { "type", "start_frame", "nb_frames", NULL };
84 fade->class = &fade_class;
85 av_opt_set_defaults(fade);
87 if ((ret = av_opt_set_from_string(fade, args, shorthand, "=", ":")) < 0)
90 fade->fade_per_frame = (1 << 16) / fade->nb_frames;
91 if (!strcmp(fade->type, "in"))
93 else if (!strcmp(fade->type, "out")) {
94 fade->fade_per_frame = -fade->fade_per_frame;
95 fade->factor = (1 << 16);
97 av_log(ctx, AV_LOG_ERROR,
98 "Type argument must be 'in' or 'out' but '%s' was specified\n", fade->type);
99 return AVERROR(EINVAL);
101 fade->stop_frame = fade->start_frame + fade->nb_frames;
103 av_log(ctx, AV_LOG_VERBOSE,
104 "type:%s start_frame:%d nb_frames:%d alpha:%d\n",
105 fade->type, fade->start_frame, fade->nb_frames, fade->alpha);
109 static av_cold void uninit(AVFilterContext *ctx)
111 FadeContext *fade = ctx->priv;
116 static int query_formats(AVFilterContext *ctx)
118 static const enum AVPixelFormat pix_fmts[] = {
119 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV420P,
120 AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P,
121 AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
122 AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUVJ440P,
123 AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,
124 AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24,
125 AV_PIX_FMT_ARGB, AV_PIX_FMT_ABGR,
126 AV_PIX_FMT_RGBA, AV_PIX_FMT_BGRA,
130 ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
134 const static enum AVPixelFormat studio_level_pix_fmts[] = {
135 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV420P,
136 AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P,
141 static int config_props(AVFilterLink *inlink)
143 FadeContext *fade = inlink->dst->priv;
144 const AVPixFmtDescriptor *pixdesc = av_pix_fmt_desc_get(inlink->format);
146 fade->hsub = pixdesc->log2_chroma_w;
147 fade->vsub = pixdesc->log2_chroma_h;
149 fade->bpp = av_get_bits_per_pixel(pixdesc) >> 3;
150 fade->alpha &= pixdesc->flags & PIX_FMT_ALPHA;
151 fade->is_packed_rgb = ff_fill_rgba_map(fade->rgba_map, inlink->format) >= 0;
153 /* use CCIR601/709 black level for studio-level pixel non-alpha components */
155 ff_fmt_is_in(inlink->format, studio_level_pix_fmts) && !fade->alpha ? 16 : 0;
156 /* 32768 = 1 << 15, it is an integer representation
157 * of 0.5 and is for rounding. */
158 fade->black_level_scaled = (fade->black_level << 16) + 32768;
162 static void fade_plane(int y, int h, int w,
163 int fade_factor, int black_level, int black_level_scaled,
164 uint8_t offset, uint8_t step, int bytes_per_plane,
165 uint8_t *data, int line_size)
170 /* luma, alpha or rgb plane */
171 for (i = 0; i < h; i++) {
172 p = data + offset + (y+i) * line_size;
173 for (j = 0; j < w * bytes_per_plane; j++) {
174 /* fade->factor is using 16 lower-order bits for decimal places. */
175 *p = ((*p - black_level) * fade_factor + black_level_scaled) >> 16;
181 static int filter_frame(AVFilterLink *inlink, AVFilterBufferRef *frame)
183 FadeContext *fade = inlink->dst->priv;
187 if (fade->factor < UINT16_MAX) {
190 plane = fade->is_packed_rgb ? 0 : A; // alpha is on plane 0 for packed formats
191 // or plane 3 for planar formats
192 fade_plane(0, frame->video->h, inlink->w,
193 fade->factor, fade->black_level, fade->black_level_scaled,
194 fade->is_packed_rgb ? fade->rgba_map[A] : 0, // alpha offset for packed formats
195 fade->is_packed_rgb ? 4 : 1, // pixstep for 8 bit packed formats
196 1, frame->data[plane], frame->linesize[plane]);
198 /* luma or rgb plane */
199 fade_plane(0, frame->video->h, inlink->w,
200 fade->factor, fade->black_level, fade->black_level_scaled,
201 0, 1, // offset & pixstep for Y plane or RGB packed format
202 fade->bpp, frame->data[0], frame->linesize[0]);
203 if (frame->data[1] && frame->data[2]) {
205 for (plane = 1; plane < 3; plane++) {
206 for (i = 0; i < frame->video->h; i++) {
207 p = frame->data[plane] + (i >> fade->vsub) * frame->linesize[plane];
208 for (j = 0; j < inlink->w >> fade->hsub; j++) {
209 /* 8421367 = ((128 << 1) + 1) << 15. It is an integer
210 * representation of 128.5. The .5 is for rounding
212 *p = ((*p - 128) * fade->factor + 8421367) >> 16;
221 if (fade->frame_index >= fade->start_frame &&
222 fade->frame_index <= fade->stop_frame)
223 fade->factor += fade->fade_per_frame;
224 fade->factor = av_clip_uint16(fade->factor);
227 return ff_filter_frame(inlink->dst->outputs[0], frame);
230 static const AVFilterPad avfilter_vf_fade_inputs[] = {
233 .type = AVMEDIA_TYPE_VIDEO,
234 .config_props = config_props,
235 .get_video_buffer = ff_null_get_video_buffer,
236 .filter_frame = filter_frame,
237 .min_perms = AV_PERM_READ | AV_PERM_WRITE,
242 static const AVFilterPad avfilter_vf_fade_outputs[] = {
245 .type = AVMEDIA_TYPE_VIDEO,
250 AVFilter avfilter_vf_fade = {
252 .description = NULL_IF_CONFIG_SMALL("Fade in/out input video."),
255 .priv_size = sizeof(FadeContext),
256 .query_formats = query_formats,
258 .inputs = avfilter_vf_fade_inputs,
259 .outputs = avfilter_vf_fade_outputs,
260 .priv_class = &fade_class,