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/avassert.h"
29 #include "libavutil/avstring.h"
30 #include "libavutil/common.h"
31 #include "libavutil/eval.h"
32 #include "libavutil/opt.h"
33 #include "libavutil/pixdesc.h"
35 #include "drawutils.h"
52 typedef struct FadeContext {
55 int factor, fade_per_frame;
56 int start_frame, nb_frames;
58 unsigned int black_level, black_level_scaled;
59 uint8_t is_packed_rgb;
62 uint64_t start_time, duration;
63 enum {VF_FADE_WAITING=0, VF_FADE_FADING, VF_FADE_DONE} fade_state;
64 uint8_t color_rgba[4]; ///< fade color
65 int black_fade; ///< if color_rgba is black
68 static av_cold int init(AVFilterContext *ctx)
70 FadeContext *s = ctx->priv;
72 s->fade_per_frame = (1 << 16) / s->nb_frames;
73 s->fade_state = VF_FADE_WAITING;
75 if (s->duration != 0) {
76 // If duration (seconds) is non-zero, assume that we are not fading based on frames
77 s->nb_frames = 0; // Mostly to clean up logging
80 // Choose what to log. If both time-based and frame-based options, both lines will be in the log
81 if (s->start_frame || s->nb_frames) {
82 av_log(ctx, AV_LOG_VERBOSE,
83 "type:%s start_frame:%d nb_frames:%d alpha:%d\n",
84 s->type == FADE_IN ? "in" : "out", s->start_frame,
85 s->nb_frames,s->alpha);
87 if (s->start_time || s->duration) {
88 av_log(ctx, AV_LOG_VERBOSE,
89 "type:%s start_time:%f duration:%f alpha:%d\n",
90 s->type == FADE_IN ? "in" : "out", (s->start_time / (double)AV_TIME_BASE),
91 (s->duration / (double)AV_TIME_BASE),s->alpha);
94 s->black_fade = !memcmp(s->color_rgba, "\x00\x00\x00\xff", 4);
98 static int query_formats(AVFilterContext *ctx)
100 const FadeContext *s = ctx->priv;
101 static const enum AVPixelFormat pix_fmts[] = {
102 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV420P,
103 AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P,
104 AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
105 AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUVJ440P,
106 AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,
107 AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24,
108 AV_PIX_FMT_ARGB, AV_PIX_FMT_ABGR,
109 AV_PIX_FMT_RGBA, AV_PIX_FMT_BGRA,
112 static const enum AVPixelFormat pix_fmts_rgb[] = {
113 AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24,
114 AV_PIX_FMT_ARGB, AV_PIX_FMT_ABGR,
115 AV_PIX_FMT_RGBA, AV_PIX_FMT_BGRA,
118 AVFilterFormats *fmts_list;
121 fmts_list = ff_make_format_list(pix_fmts);
123 fmts_list = ff_make_format_list(pix_fmts_rgb);
125 return AVERROR(ENOMEM);
126 return ff_set_common_formats(ctx, fmts_list);
129 const static enum AVPixelFormat studio_level_pix_fmts[] = {
130 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV420P,
131 AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P,
136 static int config_props(AVFilterLink *inlink)
138 FadeContext *s = inlink->dst->priv;
139 const AVPixFmtDescriptor *pixdesc = av_pix_fmt_desc_get(inlink->format);
141 s->hsub = pixdesc->log2_chroma_w;
142 s->vsub = pixdesc->log2_chroma_h;
144 s->bpp = pixdesc->flags & AV_PIX_FMT_FLAG_PLANAR ?
146 av_get_bits_per_pixel(pixdesc) >> 3;
147 s->alpha &= !!(pixdesc->flags & AV_PIX_FMT_FLAG_ALPHA);
148 s->is_packed_rgb = ff_fill_rgba_map(s->rgba_map, inlink->format) >= 0;
150 /* use CCIR601/709 black level for studio-level pixel non-alpha components */
152 ff_fmt_is_in(inlink->format, studio_level_pix_fmts) && !s->alpha ? 16 : 0;
153 /* 32768 = 1 << 15, it is an integer representation
154 * of 0.5 and is for rounding. */
155 s->black_level_scaled = (s->black_level << 16) + 32768;
159 static av_always_inline void filter_rgb(FadeContext *s, const AVFrame *frame,
160 int slice_start, int slice_end,
161 int do_alpha, int step)
164 const uint8_t r_idx = s->rgba_map[R];
165 const uint8_t g_idx = s->rgba_map[G];
166 const uint8_t b_idx = s->rgba_map[B];
167 const uint8_t a_idx = s->rgba_map[A];
168 const uint8_t *c = s->color_rgba;
170 for (i = slice_start; i < slice_end; i++) {
171 uint8_t *p = frame->data[0] + i * frame->linesize[0];
172 for (j = 0; j < frame->width; j++) {
173 #define INTERP(c_name, c_idx) av_clip_uint8(((c[c_idx]<<16) + ((int)p[c_name] - (int)c[c_idx]) * s->factor + (1<<15)) >> 16)
174 p[r_idx] = INTERP(r_idx, 0);
175 p[g_idx] = INTERP(g_idx, 1);
176 p[b_idx] = INTERP(b_idx, 2);
178 p[a_idx] = INTERP(a_idx, 3);
184 static int filter_slice_rgb(AVFilterContext *ctx, void *arg, int jobnr,
187 FadeContext *s = ctx->priv;
188 AVFrame *frame = arg;
189 int slice_start = (frame->height * jobnr ) / nb_jobs;
190 int slice_end = (frame->height * (jobnr+1)) / nb_jobs;
192 if (s->alpha) filter_rgb(s, frame, slice_start, slice_end, 1, 4);
193 else if (s->bpp == 3) filter_rgb(s, frame, slice_start, slice_end, 0, 3);
194 else if (s->bpp == 4) filter_rgb(s, frame, slice_start, slice_end, 0, 4);
200 static int filter_slice_luma(AVFilterContext *ctx, void *arg, int jobnr,
203 FadeContext *s = ctx->priv;
204 AVFrame *frame = arg;
205 int slice_start = (frame->height * jobnr ) / nb_jobs;
206 int slice_end = (frame->height * (jobnr+1)) / nb_jobs;
209 for (i = slice_start; i < slice_end; i++) {
210 uint8_t *p = frame->data[0] + i * frame->linesize[0];
211 for (j = 0; j < frame->width * s->bpp; j++) {
212 /* s->factor is using 16 lower-order bits for decimal
213 * places. 32768 = 1 << 15, it is an integer representation
214 * of 0.5 and is for rounding. */
215 *p = ((*p - s->black_level) * s->factor + s->black_level_scaled) >> 16;
223 static int filter_slice_chroma(AVFilterContext *ctx, void *arg, int jobnr,
226 FadeContext *s = ctx->priv;
227 AVFrame *frame = arg;
229 const int width = FF_CEIL_RSHIFT(frame->width, s->hsub);
230 const int height= FF_CEIL_RSHIFT(frame->height, s->vsub);
231 int slice_start = (height * jobnr ) / nb_jobs;
232 int slice_end = (height * (jobnr+1)) / nb_jobs;
234 for (plane = 1; plane < 3; plane++) {
235 for (i = slice_start; i < slice_end; i++) {
236 uint8_t *p = frame->data[plane] + i * frame->linesize[plane];
237 for (j = 0; j < width; j++) {
238 /* 8421367 = ((128 << 1) + 1) << 15. It is an integer
239 * representation of 128.5. The .5 is for rounding
241 *p = ((*p - 128) * s->factor + 8421367) >> 16;
250 static int filter_slice_alpha(AVFilterContext *ctx, void *arg, int jobnr,
253 FadeContext *s = ctx->priv;
254 AVFrame *frame = arg;
255 int plane = s->is_packed_rgb ? 0 : A;
256 int slice_start = (frame->height * jobnr ) / nb_jobs;
257 int slice_end = (frame->height * (jobnr+1)) / nb_jobs;
260 for (i = slice_start; i < slice_end; i++) {
261 uint8_t *p = frame->data[plane] + i * frame->linesize[plane] + s->is_packed_rgb*s->rgba_map[A];
262 int step = s->is_packed_rgb ? 4 : 1;
263 for (j = 0; j < frame->width; j++) {
264 /* s->factor is using 16 lower-order bits for decimal
265 * places. 32768 = 1 << 15, it is an integer representation
266 * of 0.5 and is for rounding. */
267 *p = ((*p - s->black_level) * s->factor + s->black_level_scaled) >> 16;
275 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
277 AVFilterContext *ctx = inlink->dst;
278 FadeContext *s = ctx->priv;
279 double frame_timestamp = frame->pts == AV_NOPTS_VALUE ? -1 : frame->pts * av_q2d(inlink->time_base);
281 // Calculate Fade assuming this is a Fade In
282 if (s->fade_state == VF_FADE_WAITING) {
284 if (frame_timestamp >= s->start_time/(double)AV_TIME_BASE
285 && inlink->frame_count >= s->start_frame) {
286 // Time to start fading
287 s->fade_state = VF_FADE_FADING;
289 // Save start time in case we are starting based on frames and fading based on time
290 if (s->start_time == 0 && s->start_frame != 0) {
291 s->start_time = frame_timestamp*(double)AV_TIME_BASE;
294 // Save start frame in case we are starting based on time and fading based on frames
295 if (s->start_time != 0 && s->start_frame == 0) {
296 s->start_frame = inlink->frame_count;
300 if (s->fade_state == VF_FADE_FADING) {
301 if (s->duration == 0) {
302 // Fading based on frame count
303 s->factor = (inlink->frame_count - s->start_frame) * s->fade_per_frame;
304 if (inlink->frame_count > s->start_frame + s->nb_frames) {
305 s->fade_state = VF_FADE_DONE;
309 // Fading based on duration
310 s->factor = (frame_timestamp - s->start_time/(double)AV_TIME_BASE)
311 * (float) UINT16_MAX / (s->duration/(double)AV_TIME_BASE);
312 if (frame_timestamp > s->start_time/(double)AV_TIME_BASE
313 + s->duration/(double)AV_TIME_BASE) {
314 s->fade_state = VF_FADE_DONE;
318 if (s->fade_state == VF_FADE_DONE) {
319 s->factor=UINT16_MAX;
322 s->factor = av_clip_uint16(s->factor);
324 // Invert fade_factor if Fading Out
325 if (s->type == FADE_OUT) {
326 s->factor=UINT16_MAX-s->factor;
329 if (s->factor < UINT16_MAX) {
331 ctx->internal->execute(ctx, filter_slice_alpha, frame, NULL,
332 FFMIN(frame->height, ctx->graph->nb_threads));
333 } else if (s->is_packed_rgb && !s->black_fade) {
334 ctx->internal->execute(ctx, filter_slice_rgb, frame, NULL,
335 FFMIN(frame->height, ctx->graph->nb_threads));
337 /* luma, or rgb plane in case of black */
338 ctx->internal->execute(ctx, filter_slice_luma, frame, NULL,
339 FFMIN(frame->height, ctx->graph->nb_threads));
341 if (frame->data[1] && frame->data[2]) {
343 ctx->internal->execute(ctx, filter_slice_chroma, frame, NULL,
344 FFMIN(frame->height, ctx->graph->nb_threads));
349 return ff_filter_frame(inlink->dst->outputs[0], frame);
353 #define OFFSET(x) offsetof(FadeContext, x)
354 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
356 static const AVOption fade_options[] = {
357 { "type", "'in' or 'out' for fade-in/fade-out", OFFSET(type), AV_OPT_TYPE_INT, { .i64 = FADE_IN }, FADE_IN, FADE_OUT, FLAGS, "type" },
358 { "t", "'in' or 'out' for fade-in/fade-out", OFFSET(type), AV_OPT_TYPE_INT, { .i64 = FADE_IN }, FADE_IN, FADE_OUT, FLAGS, "type" },
359 { "in", "fade-in", 0, AV_OPT_TYPE_CONST, { .i64 = FADE_IN }, .unit = "type" },
360 { "out", "fade-out", 0, AV_OPT_TYPE_CONST, { .i64 = FADE_OUT }, .unit = "type" },
361 { "start_frame", "Number of the first frame to which to apply the effect.",
362 OFFSET(start_frame), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, FLAGS },
363 { "s", "Number of the first frame to which to apply the effect.",
364 OFFSET(start_frame), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, FLAGS },
365 { "nb_frames", "Number of frames to which the effect should be applied.",
366 OFFSET(nb_frames), AV_OPT_TYPE_INT, { .i64 = 25 }, 0, INT_MAX, FLAGS },
367 { "n", "Number of frames to which the effect should be applied.",
368 OFFSET(nb_frames), AV_OPT_TYPE_INT, { .i64 = 25 }, 0, INT_MAX, FLAGS },
369 { "alpha", "fade alpha if it is available on the input", OFFSET(alpha), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, 1, FLAGS },
370 { "start_time", "Number of seconds of the beginning of the effect.",
371 OFFSET(start_time), AV_OPT_TYPE_DURATION, {.i64 = 0. }, 0, INT32_MAX, FLAGS },
372 { "st", "Number of seconds of the beginning of the effect.",
373 OFFSET(start_time), AV_OPT_TYPE_DURATION, {.i64 = 0. }, 0, INT32_MAX, FLAGS },
374 { "duration", "Duration of the effect in seconds.",
375 OFFSET(duration), AV_OPT_TYPE_DURATION, {.i64 = 0. }, 0, INT32_MAX, FLAGS },
376 { "d", "Duration of the effect in seconds.",
377 OFFSET(duration), AV_OPT_TYPE_DURATION, {.i64 = 0. }, 0, INT32_MAX, FLAGS },
378 { "color", "set color", OFFSET(color_rgba), AV_OPT_TYPE_COLOR, {.str = "black"}, CHAR_MIN, CHAR_MAX, FLAGS },
379 { "c", "set color", OFFSET(color_rgba), AV_OPT_TYPE_COLOR, {.str = "black"}, CHAR_MIN, CHAR_MAX, FLAGS },
383 AVFILTER_DEFINE_CLASS(fade);
385 static const AVFilterPad avfilter_vf_fade_inputs[] = {
388 .type = AVMEDIA_TYPE_VIDEO,
389 .config_props = config_props,
390 .filter_frame = filter_frame,
396 static const AVFilterPad avfilter_vf_fade_outputs[] = {
399 .type = AVMEDIA_TYPE_VIDEO,
404 AVFilter ff_vf_fade = {
406 .description = NULL_IF_CONFIG_SMALL("Fade in/out input video."),
408 .priv_size = sizeof(FadeContext),
409 .priv_class = &fade_class,
410 .query_formats = query_formats,
411 .inputs = avfilter_vf_fade_inputs,
412 .outputs = avfilter_vf_fade_outputs,
413 .flags = AVFILTER_FLAG_SLICE_THREADS,