lavfi/subtitles: zero-init AVSubtitle.
[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/avstring.h"
29 #include "libavutil/common.h"
30 #include "libavutil/eval.h"
31 #include "libavutil/opt.h"
32 #include "libavutil/pixdesc.h"
33 #include "avfilter.h"
34 #include "drawutils.h"
35 #include "internal.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 } FadeContext;
66
67 static av_cold int init(AVFilterContext *ctx)
68 {
69     FadeContext *fade = ctx->priv;
70
71     fade->fade_per_frame = (1 << 16) / fade->nb_frames;
72     fade->fade_state = VF_FADE_WAITING;
73
74     if (fade->duration != 0) {
75         // If duration (seconds) is non-zero, assume that we are not fading based on frames
76         fade->nb_frames = 0; // Mostly to clean up logging
77     }
78
79     // Choose what to log. If both time-based and frame-based options, both lines will be in the log
80     if (fade->start_frame || fade->nb_frames) {
81         av_log(ctx, AV_LOG_VERBOSE,
82                "type:%s start_frame:%d nb_frames:%d alpha:%d\n",
83                fade->type == FADE_IN ? "in" : "out", fade->start_frame,
84                fade->nb_frames,fade->alpha);
85     }
86     if (fade->start_time || fade->duration) {
87         av_log(ctx, AV_LOG_VERBOSE,
88                "type:%s start_time:%f duration:%f alpha:%d\n",
89                fade->type == FADE_IN ? "in" : "out", (fade->start_time / (double)AV_TIME_BASE),
90                (fade->duration / (double)AV_TIME_BASE),fade->alpha);
91     }
92
93     return 0;
94 }
95
96 static int query_formats(AVFilterContext *ctx)
97 {
98     static const enum AVPixelFormat pix_fmts[] = {
99         AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P,
100         AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV410P,
101         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
102         AV_PIX_FMT_YUV440P,  AV_PIX_FMT_YUVJ440P,
103         AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,
104         AV_PIX_FMT_RGB24,    AV_PIX_FMT_BGR24,
105         AV_PIX_FMT_ARGB,     AV_PIX_FMT_ABGR,
106         AV_PIX_FMT_RGBA,     AV_PIX_FMT_BGRA,
107         AV_PIX_FMT_NONE
108     };
109
110     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
111     return 0;
112 }
113
114 const static enum AVPixelFormat studio_level_pix_fmts[] = {
115     AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P,
116     AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV410P,
117     AV_PIX_FMT_YUV440P,
118     AV_PIX_FMT_NONE
119 };
120
121 static int config_props(AVFilterLink *inlink)
122 {
123     FadeContext *fade = inlink->dst->priv;
124     const AVPixFmtDescriptor *pixdesc = av_pix_fmt_desc_get(inlink->format);
125
126     fade->hsub = pixdesc->log2_chroma_w;
127     fade->vsub = pixdesc->log2_chroma_h;
128
129     fade->bpp = av_get_bits_per_pixel(pixdesc) >> 3;
130     fade->alpha &= pixdesc->flags & PIX_FMT_ALPHA;
131     fade->is_packed_rgb = ff_fill_rgba_map(fade->rgba_map, inlink->format) >= 0;
132
133     /* use CCIR601/709 black level for studio-level pixel non-alpha components */
134     fade->black_level =
135             ff_fmt_is_in(inlink->format, studio_level_pix_fmts) && !fade->alpha ? 16 : 0;
136     /* 32768 = 1 << 15, it is an integer representation
137      * of 0.5 and is for rounding. */
138     fade->black_level_scaled = (fade->black_level << 16) + 32768;
139     return 0;
140 }
141
142 static void fade_plane(int y, int h, int w,
143                        int fade_factor, int black_level, int black_level_scaled,
144                        uint8_t offset, uint8_t step, int bytes_per_plane,
145                        uint8_t *data, int line_size)
146 {
147     uint8_t *p;
148     int i, j;
149
150     /* luma, alpha or rgb plane */
151     for (i = 0; i < h; i++) {
152         p = data + offset + (y+i) * line_size;
153         for (j = 0; j < w * bytes_per_plane; j++) {
154             /* fade->factor is using 16 lower-order bits for decimal places. */
155             *p = ((*p - black_level) * fade_factor + black_level_scaled) >> 16;
156             p+=step;
157         }
158     }
159 }
160
161 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
162 {
163     FadeContext *fade = inlink->dst->priv;
164     uint8_t *p;
165     int i, j, plane;
166     double frame_timestamp = frame->pts == AV_NOPTS_VALUE ? -1 : frame->pts * av_q2d(inlink->time_base);
167
168     // Calculate Fade assuming this is a Fade In
169     if (fade->fade_state == VF_FADE_WAITING) {
170         fade->factor=0;
171         if ((frame_timestamp >= (fade->start_time/(double)AV_TIME_BASE))
172             && (fade->frame_index >= fade->start_frame)) {
173             // Time to start fading
174             fade->fade_state = VF_FADE_FADING;
175
176             // Save start time in case we are starting based on frames and fading based on time
177             if ((fade->start_time == 0) && (fade->start_frame != 0)) {
178                 fade->start_time = frame_timestamp*(double)AV_TIME_BASE;
179             }
180
181             // Save start frame in case we are starting based on time and fading based on frames
182             if ((fade->start_time != 0) && (fade->start_frame == 0)) {
183                 fade->start_frame = fade->frame_index;
184             }
185         }
186     }
187     if (fade->fade_state == VF_FADE_FADING) {
188         if (fade->duration == 0) {
189             // Fading based on frame count
190             fade->factor = (fade->frame_index - fade->start_frame) * fade->fade_per_frame;
191             if (fade->frame_index > (fade->start_frame + fade->nb_frames)) {
192                 fade->fade_state = VF_FADE_DONE;
193             }
194
195         } else {
196             // Fading based on duration
197             fade->factor = (frame_timestamp - (fade->start_time/(double)AV_TIME_BASE))
198                             * (float) UINT16_MAX / (fade->duration/(double)AV_TIME_BASE);
199             if (frame_timestamp > ((fade->start_time/(double)AV_TIME_BASE)
200                                     + (fade->duration/(double)AV_TIME_BASE))) {
201                 fade->fade_state = VF_FADE_DONE;
202             }
203         }
204     }
205     if (fade->fade_state == VF_FADE_DONE) {
206         fade->factor=UINT16_MAX;
207     }
208
209     fade->factor = av_clip_uint16(fade->factor);
210
211     // Invert fade_factor if Fading Out
212     if (fade->type == 1) {
213         fade->factor=UINT16_MAX-fade->factor;
214     }
215
216     if (fade->factor < UINT16_MAX) {
217         if (fade->alpha) {
218             // alpha only
219             plane = fade->is_packed_rgb ? 0 : A; // alpha is on plane 0 for packed formats
220                                                  // or plane 3 for planar formats
221             fade_plane(0, frame->height, inlink->w,
222                        fade->factor, fade->black_level, fade->black_level_scaled,
223                        fade->is_packed_rgb ? fade->rgba_map[A] : 0, // alpha offset for packed formats
224                        fade->is_packed_rgb ? 4 : 1,                 // pixstep for 8 bit packed formats
225                        1, frame->data[plane], frame->linesize[plane]);
226         } else {
227             /* luma or rgb plane */
228             fade_plane(0, frame->height, inlink->w,
229                        fade->factor, fade->black_level, fade->black_level_scaled,
230                        0, 1, // offset & pixstep for Y plane or RGB packed format
231                        fade->bpp, frame->data[0], frame->linesize[0]);
232             if (frame->data[1] && frame->data[2]) {
233                 /* chroma planes */
234                 for (plane = 1; plane < 3; plane++) {
235                     for (i = 0; i < frame->height; i++) {
236                         p = frame->data[plane] + (i >> fade->vsub) * frame->linesize[plane];
237                         for (j = 0; j < inlink->w >> fade->hsub; j++) {
238                             /* 8421367 = ((128 << 1) + 1) << 15. It is an integer
239                              * representation of 128.5. The .5 is for rounding
240                              * purposes. */
241                             *p = ((*p - 128) * fade->factor + 8421367) >> 16;
242                             p++;
243                         }
244                     }
245                 }
246             }
247         }
248     }
249
250     fade->frame_index++;
251
252     return ff_filter_frame(inlink->dst->outputs[0], frame);
253 }
254
255
256 #define OFFSET(x) offsetof(FadeContext, x)
257 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
258
259 static const AVOption fade_options[] = {
260     { "type", "'in' or 'out' for fade-in/fade-out", OFFSET(type), AV_OPT_TYPE_INT, { .i64 = FADE_IN }, FADE_IN, FADE_OUT, FLAGS, "type" },
261     { "t",    "'in' or 'out' for fade-in/fade-out", OFFSET(type), AV_OPT_TYPE_INT, { .i64 = FADE_IN }, FADE_IN, FADE_OUT, FLAGS, "type" },
262         { "in",  "fade-in",  0, AV_OPT_TYPE_CONST, { .i64 = FADE_IN },  .unit = "type" },
263         { "out", "fade-out", 0, AV_OPT_TYPE_CONST, { .i64 = FADE_OUT }, .unit = "type" },
264     { "start_frame", "Number of the first frame to which to apply the effect.",
265                                                     OFFSET(start_frame), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, FLAGS },
266     { "s",           "Number of the first frame to which to apply the effect.",
267                                                     OFFSET(start_frame), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, FLAGS },
268     { "nb_frames",   "Number of frames to which the effect should be applied.",
269                                                     OFFSET(nb_frames),   AV_OPT_TYPE_INT, { .i64 = 25 }, 0, INT_MAX, FLAGS },
270     { "n",           "Number of frames to which the effect should be applied.",
271                                                     OFFSET(nb_frames),   AV_OPT_TYPE_INT, { .i64 = 25 }, 0, INT_MAX, FLAGS },
272     { "alpha",       "fade alpha if it is available on the input", OFFSET(alpha),       AV_OPT_TYPE_INT, {.i64 = 0    }, 0,       1, FLAGS },
273     { "start_time",  "Number of seconds of the beginning of the effect.",
274                                                     OFFSET(start_time),  AV_OPT_TYPE_DURATION, {.i64 = 0. }, 0, INT32_MAX, FLAGS },
275     { "st",          "Number of seconds of the beginning of the effect.",
276                                                     OFFSET(start_time),  AV_OPT_TYPE_DURATION, {.i64 = 0. }, 0, INT32_MAX, FLAGS },
277     { "duration",    "Duration of the effect in seconds.",
278                                                     OFFSET(duration),    AV_OPT_TYPE_DURATION, {.i64 = 0. }, 0, INT32_MAX, FLAGS },
279     { "d",           "Duration of the effect in seconds.",
280                                                     OFFSET(duration),    AV_OPT_TYPE_DURATION, {.i64 = 0. }, 0, INT32_MAX, FLAGS },
281     { NULL },
282 };
283
284 AVFILTER_DEFINE_CLASS(fade);
285
286 static const AVFilterPad avfilter_vf_fade_inputs[] = {
287     {
288         .name             = "default",
289         .type             = AVMEDIA_TYPE_VIDEO,
290         .config_props     = config_props,
291         .get_video_buffer = ff_null_get_video_buffer,
292         .filter_frame     = filter_frame,
293         .needs_writable   = 1,
294     },
295     { NULL }
296 };
297
298 static const AVFilterPad avfilter_vf_fade_outputs[] = {
299     {
300         .name = "default",
301         .type = AVMEDIA_TYPE_VIDEO,
302     },
303     { NULL }
304 };
305
306 AVFilter avfilter_vf_fade = {
307     .name          = "fade",
308     .description   = NULL_IF_CONFIG_SMALL("Fade in/out input video."),
309     .init          = init,
310     .priv_size     = sizeof(FadeContext),
311     .priv_class    = &fade_class,
312     .query_formats = query_formats,
313
314     .inputs    = avfilter_vf_fade_inputs,
315     .outputs   = avfilter_vf_fade_outputs,
316 };