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, {.dbl = 0 }, 0, INT_MAX, FLAGS },
69 { "s", "set expression of frame to start fading", OFFSET(start_frame), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, FLAGS },
70 { "nb_frames", "set expression for fade duration in frames", OFFSET(nb_frames), AV_OPT_TYPE_INT, {.dbl = 25 }, 0, INT_MAX, FLAGS },
71 { "n", "set expression for fade duration in frames", OFFSET(nb_frames), AV_OPT_TYPE_INT, {.dbl = 25 }, 0, INT_MAX, FLAGS },
72 { "alpha", "fade alpha if it is available on the input", OFFSET(alpha), AV_OPT_TYPE_INT, {.dbl = 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;
82 char *args1, *expr, *bufptr = NULL;
84 fade->class = &fade_class;
85 av_opt_set_defaults(fade);
87 if (!(args1 = av_strdup(args))) {
88 ret = AVERROR(ENOMEM);
92 if (expr = av_strtok(args1, ":", &bufptr)) {
94 if (!(fade->type = av_strdup(expr))) {
95 ret = AVERROR(ENOMEM);
99 if (expr = av_strtok(NULL, ":", &bufptr)) {
100 if ((ret = av_opt_set(fade, "start_frame", expr, 0)) < 0) {
101 av_log(ctx, AV_LOG_ERROR,
102 "Invalid value '%s' for start_frame option\n", expr);
106 if (expr = av_strtok(NULL, ":", &bufptr)) {
107 if ((ret = av_opt_set(fade, "nb_frames", expr, 0)) < 0) {
108 av_log(ctx, AV_LOG_ERROR,
109 "Invalid value '%s' for nb_frames option\n", expr);
114 if (bufptr && (ret = av_set_options_string(fade, bufptr, "=", ":")) < 0)
117 fade->fade_per_frame = (1 << 16) / fade->nb_frames;
118 if (!strcmp(fade->type, "in"))
120 else if (!strcmp(fade->type, "out")) {
121 fade->fade_per_frame = -fade->fade_per_frame;
122 fade->factor = (1 << 16);
124 av_log(ctx, AV_LOG_ERROR,
125 "Type argument must be 'in' or 'out' but '%s' was specified\n", fade->type);
126 ret = AVERROR(EINVAL);
129 fade->stop_frame = fade->start_frame + fade->nb_frames;
131 av_log(ctx, AV_LOG_VERBOSE,
132 "type:%s start_frame:%d nb_frames:%d alpha:%d\n",
133 fade->type, fade->start_frame, fade->nb_frames, fade->alpha);
140 static av_cold void uninit(AVFilterContext *ctx)
142 FadeContext *fade = ctx->priv;
144 av_freep(&fade->type);
147 static int query_formats(AVFilterContext *ctx)
149 static const enum PixelFormat pix_fmts[] = {
150 PIX_FMT_YUV444P, PIX_FMT_YUV422P, PIX_FMT_YUV420P,
151 PIX_FMT_YUV411P, PIX_FMT_YUV410P,
152 PIX_FMT_YUVJ444P, PIX_FMT_YUVJ422P, PIX_FMT_YUVJ420P,
153 PIX_FMT_YUV440P, PIX_FMT_YUVJ440P,
155 PIX_FMT_RGB24, PIX_FMT_BGR24,
156 PIX_FMT_ARGB, PIX_FMT_ABGR,
157 PIX_FMT_RGBA, PIX_FMT_BGRA,
161 ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
165 const static enum PixelFormat studio_level_pix_fmts[] = {
166 PIX_FMT_YUV444P, PIX_FMT_YUV422P, PIX_FMT_YUV420P,
167 PIX_FMT_YUV411P, PIX_FMT_YUV410P,
172 static enum PixelFormat alpha_pix_fmts[] = {
174 PIX_FMT_ARGB, PIX_FMT_ABGR,
175 PIX_FMT_RGBA, PIX_FMT_BGRA,
179 static int config_props(AVFilterLink *inlink)
181 FadeContext *fade = inlink->dst->priv;
182 const AVPixFmtDescriptor *pixdesc = &av_pix_fmt_descriptors[inlink->format];
184 fade->hsub = pixdesc->log2_chroma_w;
185 fade->vsub = pixdesc->log2_chroma_h;
187 fade->bpp = av_get_bits_per_pixel(pixdesc) >> 3;
188 fade->alpha = fade->alpha ? ff_fmt_is_in(inlink->format, alpha_pix_fmts) : 0;
189 fade->is_packed_rgb = ff_fill_rgba_map(fade->rgba_map, inlink->format) >= 0;
191 /* use CCIR601/709 black level for studio-level pixel non-alpha components */
193 ff_fmt_is_in(inlink->format, studio_level_pix_fmts) && !fade->alpha ? 16 : 0;
194 /* 32768 = 1 << 15, it is an integer representation
195 * of 0.5 and is for rounding. */
196 fade->black_level_scaled = (fade->black_level << 16) + 32768;
200 static void fade_plane(int y, int h, int w,
201 int fade_factor, int black_level, int black_level_scaled,
202 uint8_t offset, uint8_t step, int bytes_per_plane,
203 uint8_t *data, int line_size)
208 /* luma, alpha or rgb plane */
209 for (i = 0; i < h; i++) {
210 p = data + offset + (y+i) * line_size;
211 for (j = 0; j < w * bytes_per_plane; j++) {
212 /* fade->factor is using 16 lower-order bits for decimal places. */
213 *p = ((*p - black_level) * fade_factor + black_level_scaled) >> 16;
219 static int draw_slice(AVFilterLink *inlink, int y, int h, int slice_dir)
221 FadeContext *fade = inlink->dst->priv;
222 AVFilterBufferRef *outpic = inlink->cur_buf;
226 if (fade->factor < UINT16_MAX) {
229 plane = fade->is_packed_rgb ? 0 : A; // alpha is on plane 0 for packed formats
230 // or plane 3 for planar formats
231 fade_plane(y, h, inlink->w,
232 fade->factor, fade->black_level, fade->black_level_scaled,
233 fade->is_packed_rgb ? fade->rgba_map[A] : 0, // alpha offset for packed formats
234 fade->is_packed_rgb ? 4 : 1, // pixstep for 8 bit packed formats
235 1, outpic->data[plane], outpic->linesize[plane]);
237 /* luma or rgb plane */
238 fade_plane(y, h, inlink->w,
239 fade->factor, fade->black_level, fade->black_level_scaled,
240 0, 1, // offset & pixstep for Y plane or RGB packed format
241 fade->bpp, outpic->data[0], outpic->linesize[0]);
242 if (outpic->data[1] && outpic->data[2]) {
244 for (plane = 1; plane < 3; plane++) {
245 for (i = 0; i < h; i++) {
246 p = outpic->data[plane] + ((y+i) >> fade->vsub) * outpic->linesize[plane];
247 for (j = 0; j < inlink->w >> fade->hsub; j++) {
248 /* 8421367 = ((128 << 1) + 1) << 15. It is an integer
249 * representation of 128.5. The .5 is for rounding
251 *p = ((*p - 128) * fade->factor + 8421367) >> 16;
260 return ff_draw_slice(inlink->dst->outputs[0], y, h, slice_dir);
263 static int end_frame(AVFilterLink *inlink)
265 FadeContext *fade = inlink->dst->priv;
268 ret = ff_end_frame(inlink->dst->outputs[0]);
270 if (fade->frame_index >= fade->start_frame &&
271 fade->frame_index <= fade->stop_frame)
272 fade->factor += fade->fade_per_frame;
273 fade->factor = av_clip_uint16(fade->factor);
279 AVFilter avfilter_vf_fade = {
281 .description = NULL_IF_CONFIG_SMALL("Fade in/out input video."),
284 .priv_size = sizeof(FadeContext),
285 .query_formats = query_formats,
287 .inputs = (const AVFilterPad[]) {{ .name = "default",
288 .type = AVMEDIA_TYPE_VIDEO,
289 .config_props = config_props,
290 .get_video_buffer = ff_null_get_video_buffer,
291 .start_frame = ff_null_start_frame,
292 .draw_slice = draw_slice,
293 .end_frame = end_frame,
294 .min_perms = AV_PERM_READ | AV_PERM_WRITE },
296 .outputs = (const AVFilterPad[]) {{ .name = "default",
297 .type = AVMEDIA_TYPE_VIDEO, },
299 .priv_class = &fade_class,