avfilter/fade: add color option.
[ffmpeg.git] / 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/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"
34 #include "avfilter.h"
35 #include "drawutils.h"
36 #include "formats.h"
37 #include "internal.h"
38 #include "video.h"
39
40 #define R 0
41 #define G 1
42 #define B 2
43 #define A 3
44
45 #define Y 0
46 #define U 1
47 #define V 2
48
49 #define FADE_IN  0
50 #define FADE_OUT 1
51
52 typedef struct {
53     const AVClass *class;
54     int type;
55     int factor, fade_per_frame;
56     int start_frame, nb_frames;
57     unsigned int frame_index;
58     int hsub, vsub, bpp;
59     unsigned int black_level, black_level_scaled;
60     uint8_t is_packed_rgb;
61     uint8_t rgba_map[4];
62     int alpha;
63     uint64_t start_time, duration;
64     enum {VF_FADE_WAITING=0, VF_FADE_FADING, VF_FADE_DONE} fade_state;
65     uint8_t color_rgba[4];  ///< fade color
66     int black_fade;         ///< if color_rgba is black
67 } FadeContext;
68
69 static av_cold int init(AVFilterContext *ctx)
70 {
71     FadeContext *s = ctx->priv;
72
73     s->fade_per_frame = (1 << 16) / s->nb_frames;
74     s->fade_state = VF_FADE_WAITING;
75
76     if (s->duration != 0) {
77         // If duration (seconds) is non-zero, assume that we are not fading based on frames
78         s->nb_frames = 0; // Mostly to clean up logging
79     }
80
81     // Choose what to log. If both time-based and frame-based options, both lines will be in the log
82     if (s->start_frame || s->nb_frames) {
83         av_log(ctx, AV_LOG_VERBOSE,
84                "type:%s start_frame:%d nb_frames:%d alpha:%d\n",
85                s->type == FADE_IN ? "in" : "out", s->start_frame,
86                s->nb_frames,s->alpha);
87     }
88     if (s->start_time || s->duration) {
89         av_log(ctx, AV_LOG_VERBOSE,
90                "type:%s start_time:%f duration:%f alpha:%d\n",
91                s->type == FADE_IN ? "in" : "out", (s->start_time / (double)AV_TIME_BASE),
92                (s->duration / (double)AV_TIME_BASE),s->alpha);
93     }
94
95     s->black_fade = !memcmp(s->color_rgba, "\x00\x00\x00\xff", 4);
96     return 0;
97 }
98
99 static int query_formats(AVFilterContext *ctx)
100 {
101     const FadeContext *s = ctx->priv;
102     static const enum AVPixelFormat pix_fmts[] = {
103         AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P,
104         AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV410P,
105         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
106         AV_PIX_FMT_YUV440P,  AV_PIX_FMT_YUVJ440P,
107         AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,
108         AV_PIX_FMT_RGB24,    AV_PIX_FMT_BGR24,
109         AV_PIX_FMT_ARGB,     AV_PIX_FMT_ABGR,
110         AV_PIX_FMT_RGBA,     AV_PIX_FMT_BGRA,
111         AV_PIX_FMT_NONE
112     };
113     static const enum AVPixelFormat pix_fmts_rgb[] = {
114         AV_PIX_FMT_RGB24,    AV_PIX_FMT_BGR24,
115         AV_PIX_FMT_ARGB,     AV_PIX_FMT_ABGR,
116         AV_PIX_FMT_RGBA,     AV_PIX_FMT_BGRA,
117         AV_PIX_FMT_NONE
118     };
119
120     if (s->black_fade)
121         ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
122     else
123         ff_set_common_formats(ctx, ff_make_format_list(pix_fmts_rgb));
124     return 0;
125 }
126
127 const static enum AVPixelFormat studio_level_pix_fmts[] = {
128     AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P,
129     AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV410P,
130     AV_PIX_FMT_YUV440P,
131     AV_PIX_FMT_NONE
132 };
133
134 static int config_props(AVFilterLink *inlink)
135 {
136     FadeContext *s = inlink->dst->priv;
137     const AVPixFmtDescriptor *pixdesc = av_pix_fmt_desc_get(inlink->format);
138
139     s->hsub = pixdesc->log2_chroma_w;
140     s->vsub = pixdesc->log2_chroma_h;
141
142     s->bpp = av_get_bits_per_pixel(pixdesc) >> 3;
143     s->alpha &= !!(pixdesc->flags & AV_PIX_FMT_FLAG_ALPHA);
144     s->is_packed_rgb = ff_fill_rgba_map(s->rgba_map, inlink->format) >= 0;
145
146     /* use CCIR601/709 black level for studio-level pixel non-alpha components */
147     s->black_level =
148             ff_fmt_is_in(inlink->format, studio_level_pix_fmts) && !s->alpha ? 16 : 0;
149     /* 32768 = 1 << 15, it is an integer representation
150      * of 0.5 and is for rounding. */
151     s->black_level_scaled = (s->black_level << 16) + 32768;
152     return 0;
153 }
154
155 static av_always_inline void filter_rgb(FadeContext *s, const AVFrame *frame,
156                                         int slice_start, int slice_end,
157                                         int do_alpha, int step)
158 {
159     int i, j;
160     const uint8_t r_idx  = s->rgba_map[R];
161     const uint8_t g_idx  = s->rgba_map[G];
162     const uint8_t b_idx  = s->rgba_map[B];
163     const uint8_t a_idx  = s->rgba_map[A];
164     const uint8_t *c = s->color_rgba;
165
166     for (i = slice_start; i < slice_end; i++) {
167         uint8_t *p = frame->data[0] + i * frame->linesize[0];
168         for (j = 0; j < frame->width; j++) {
169 #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)
170             p[r_idx] = INTERP(r_idx, 0);
171             p[g_idx] = INTERP(g_idx, 1);
172             p[b_idx] = INTERP(b_idx, 2);
173             if (do_alpha)
174                 p[a_idx] = INTERP(a_idx, 3);
175             p += step;
176         }
177     }
178 }
179
180 static int filter_slice_rgb(AVFilterContext *ctx, void *arg, int jobnr,
181                             int nb_jobs)
182 {
183     FadeContext *s = ctx->priv;
184     AVFrame *frame = arg;
185     int slice_start = (frame->height *  jobnr   ) / nb_jobs;
186     int slice_end   = (frame->height * (jobnr+1)) / nb_jobs;
187
188     if      (s->alpha)    filter_rgb(s, frame, slice_start, slice_end, 1, 4);
189     else if (s->bpp == 3) filter_rgb(s, frame, slice_start, slice_end, 0, 3);
190     else if (s->bpp == 4) filter_rgb(s, frame, slice_start, slice_end, 0, 4);
191     else                  av_assert0(0);
192
193     return 0;
194 }
195
196 static int filter_slice_luma(AVFilterContext *ctx, void *arg, int jobnr,
197                              int nb_jobs)
198 {
199     FadeContext *s = ctx->priv;
200     AVFrame *frame = arg;
201     int slice_start = (frame->height *  jobnr   ) / nb_jobs;
202     int slice_end   = (frame->height * (jobnr+1)) / nb_jobs;
203     int i, j;
204
205     for (i = slice_start; i < slice_end; i++) {
206         uint8_t *p = frame->data[0] + i * frame->linesize[0];
207         for (j = 0; j < frame->width * s->bpp; j++) {
208             /* s->factor is using 16 lower-order bits for decimal
209              * places. 32768 = 1 << 15, it is an integer representation
210              * of 0.5 and is for rounding. */
211             *p = ((*p - s->black_level) * s->factor + s->black_level_scaled) >> 16;
212             p++;
213         }
214     }
215
216     return 0;
217 }
218
219 static int filter_slice_chroma(AVFilterContext *ctx, void *arg, int jobnr,
220                                int nb_jobs)
221 {
222     FadeContext *s = ctx->priv;
223     AVFrame *frame = arg;
224     int i, j, plane;
225     const int width = FF_CEIL_RSHIFT(frame->width, s->hsub);
226     const int height= FF_CEIL_RSHIFT(frame->height, s->vsub);
227     int slice_start = (height *  jobnr   ) / nb_jobs;
228     int slice_end   = (height * (jobnr+1)) / nb_jobs;
229
230     for (plane = 1; plane < 3; plane++) {
231         for (i = slice_start; i < slice_end; i++) {
232             uint8_t *p = frame->data[plane] + i * frame->linesize[plane];
233             for (j = 0; j < width; j++) {
234                 /* 8421367 = ((128 << 1) + 1) << 15. It is an integer
235                  * representation of 128.5. The .5 is for rounding
236                  * purposes. */
237                 *p = ((*p - 128) * s->factor + 8421367) >> 16;
238                 p++;
239             }
240         }
241     }
242
243     return 0;
244 }
245
246 static int filter_slice_alpha(AVFilterContext *ctx, void *arg, int jobnr,
247                               int nb_jobs)
248 {
249     FadeContext *s = ctx->priv;
250     AVFrame *frame = arg;
251     int plane = s->is_packed_rgb ? 0 : A;
252     int slice_start = (frame->height *  jobnr   ) / nb_jobs;
253     int slice_end   = (frame->height * (jobnr+1)) / nb_jobs;
254     int i, j;
255
256     for (i = slice_start; i < slice_end; i++) {
257         uint8_t *p = frame->data[plane] + i * frame->linesize[plane] + s->is_packed_rgb*s->rgba_map[A];
258         int step = s->is_packed_rgb ? 4 : 1;
259         for (j = 0; j < frame->width; j++) {
260             /* s->factor is using 16 lower-order bits for decimal
261              * places. 32768 = 1 << 15, it is an integer representation
262              * of 0.5 and is for rounding. */
263             *p = ((*p - s->black_level) * s->factor + s->black_level_scaled) >> 16;
264             p += step;
265         }
266     }
267
268     return 0;
269 }
270
271 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
272 {
273     AVFilterContext *ctx = inlink->dst;
274     FadeContext *s       = ctx->priv;
275     double frame_timestamp = frame->pts == AV_NOPTS_VALUE ? -1 : frame->pts * av_q2d(inlink->time_base);
276
277     // Calculate Fade assuming this is a Fade In
278     if (s->fade_state == VF_FADE_WAITING) {
279         s->factor=0;
280         if ((frame_timestamp >= (s->start_time/(double)AV_TIME_BASE))
281             && (s->frame_index >= s->start_frame)) {
282             // Time to start fading
283             s->fade_state = VF_FADE_FADING;
284
285             // Save start time in case we are starting based on frames and fading based on time
286             if ((s->start_time == 0) && (s->start_frame != 0)) {
287                 s->start_time = frame_timestamp*(double)AV_TIME_BASE;
288             }
289
290             // Save start frame in case we are starting based on time and fading based on frames
291             if ((s->start_time != 0) && (s->start_frame == 0)) {
292                 s->start_frame = s->frame_index;
293             }
294         }
295     }
296     if (s->fade_state == VF_FADE_FADING) {
297         if (s->duration == 0) {
298             // Fading based on frame count
299             s->factor = (s->frame_index - s->start_frame) * s->fade_per_frame;
300             if (s->frame_index > (s->start_frame + s->nb_frames)) {
301                 s->fade_state = VF_FADE_DONE;
302             }
303
304         } else {
305             // Fading based on duration
306             s->factor = (frame_timestamp - (s->start_time/(double)AV_TIME_BASE))
307                             * (float) UINT16_MAX / (s->duration/(double)AV_TIME_BASE);
308             if (frame_timestamp > ((s->start_time/(double)AV_TIME_BASE)
309                                     + (s->duration/(double)AV_TIME_BASE))) {
310                 s->fade_state = VF_FADE_DONE;
311             }
312         }
313     }
314     if (s->fade_state == VF_FADE_DONE) {
315         s->factor=UINT16_MAX;
316     }
317
318     s->factor = av_clip_uint16(s->factor);
319
320     // Invert fade_factor if Fading Out
321     if (s->type == 1) {
322         s->factor=UINT16_MAX-s->factor;
323     }
324
325     if (s->factor < UINT16_MAX) {
326         if (s->alpha) {
327             ctx->internal->execute(ctx, filter_slice_alpha, frame, NULL,
328                                 FFMIN(frame->height, ctx->graph->nb_threads));
329         } else if (s->is_packed_rgb && !s->black_fade) {
330             ctx->internal->execute(ctx, filter_slice_rgb, frame, NULL,
331                                    FFMIN(frame->height, ctx->graph->nb_threads));
332         } else {
333             /* luma, or rgb plane in case of black */
334             ctx->internal->execute(ctx, filter_slice_luma, frame, NULL,
335                                 FFMIN(frame->height, ctx->graph->nb_threads));
336
337             if (frame->data[1] && frame->data[2]) {
338                 /* chroma planes */
339                 ctx->internal->execute(ctx, filter_slice_chroma, frame, NULL,
340                                     FFMIN(frame->height, ctx->graph->nb_threads));
341             }
342         }
343     }
344
345     s->frame_index++;
346
347     return ff_filter_frame(inlink->dst->outputs[0], frame);
348 }
349
350
351 #define OFFSET(x) offsetof(FadeContext, x)
352 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
353
354 static const AVOption fade_options[] = {
355     { "type", "'in' or 'out' for fade-in/fade-out", OFFSET(type), AV_OPT_TYPE_INT, { .i64 = FADE_IN }, FADE_IN, FADE_OUT, FLAGS, "type" },
356     { "t",    "'in' or 'out' for fade-in/fade-out", OFFSET(type), AV_OPT_TYPE_INT, { .i64 = FADE_IN }, FADE_IN, FADE_OUT, FLAGS, "type" },
357         { "in",  "fade-in",  0, AV_OPT_TYPE_CONST, { .i64 = FADE_IN },  .unit = "type" },
358         { "out", "fade-out", 0, AV_OPT_TYPE_CONST, { .i64 = FADE_OUT }, .unit = "type" },
359     { "start_frame", "Number of the first frame to which to apply the effect.",
360                                                     OFFSET(start_frame), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, FLAGS },
361     { "s",           "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     { "nb_frames",   "Number of frames to which the effect should be applied.",
364                                                     OFFSET(nb_frames),   AV_OPT_TYPE_INT, { .i64 = 25 }, 0, INT_MAX, FLAGS },
365     { "n",           "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     { "alpha",       "fade alpha if it is available on the input", OFFSET(alpha),       AV_OPT_TYPE_INT, {.i64 = 0    }, 0,       1, FLAGS },
368     { "start_time",  "Number of seconds of the beginning of the effect.",
369                                                     OFFSET(start_time),  AV_OPT_TYPE_DURATION, {.i64 = 0. }, 0, INT32_MAX, FLAGS },
370     { "st",          "Number of seconds of the beginning of the effect.",
371                                                     OFFSET(start_time),  AV_OPT_TYPE_DURATION, {.i64 = 0. }, 0, INT32_MAX, FLAGS },
372     { "duration",    "Duration of the effect in seconds.",
373                                                     OFFSET(duration),    AV_OPT_TYPE_DURATION, {.i64 = 0. }, 0, INT32_MAX, FLAGS },
374     { "d",           "Duration of the effect in seconds.",
375                                                     OFFSET(duration),    AV_OPT_TYPE_DURATION, {.i64 = 0. }, 0, INT32_MAX, FLAGS },
376     { "color",       "set color",                   OFFSET(color_rgba),  AV_OPT_TYPE_COLOR,    {.str = "black"}, CHAR_MIN, CHAR_MAX, FLAGS },
377     { "c",           "set color",                   OFFSET(color_rgba),  AV_OPT_TYPE_COLOR,    {.str = "black"}, CHAR_MIN, CHAR_MAX, FLAGS },
378     { NULL }
379 };
380
381 AVFILTER_DEFINE_CLASS(fade);
382
383 static const AVFilterPad avfilter_vf_fade_inputs[] = {
384     {
385         .name           = "default",
386         .type           = AVMEDIA_TYPE_VIDEO,
387         .config_props   = config_props,
388         .filter_frame   = filter_frame,
389         .needs_writable = 1,
390     },
391     { NULL }
392 };
393
394 static const AVFilterPad avfilter_vf_fade_outputs[] = {
395     {
396         .name = "default",
397         .type = AVMEDIA_TYPE_VIDEO,
398     },
399     { NULL }
400 };
401
402 AVFilter ff_vf_fade = {
403     .name          = "fade",
404     .description   = NULL_IF_CONFIG_SMALL("Fade in/out input video."),
405     .init          = init,
406     .priv_size     = sizeof(FadeContext),
407     .priv_class    = &fade_class,
408     .query_formats = query_formats,
409     .inputs        = avfilter_vf_fade_inputs,
410     .outputs       = avfilter_vf_fade_outputs,
411     .flags         = AVFILTER_FLAG_SLICE_THREADS,
412 };