Merge commit 'b9dfee9fa259dfc885508179a359dccc9e7840bd'
[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, stop_frame;
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
64 } FadeContext;
65
66 static av_cold int init(AVFilterContext *ctx, const char *args)
67 {
68     FadeContext *fade = ctx->priv;
69
70     fade->fade_per_frame = (1 << 16) / fade->nb_frames;
71     if (fade->type == FADE_IN) {
72         fade->factor = 0;
73     } else if (fade->type == FADE_OUT) {
74         fade->fade_per_frame = -fade->fade_per_frame;
75         fade->factor = (1 << 16);
76     }
77     fade->stop_frame = fade->start_frame + fade->nb_frames;
78
79     av_log(ctx, AV_LOG_VERBOSE,
80            "type:%s start_frame:%d nb_frames:%d alpha:%d\n",
81            fade->type == FADE_IN ? "in" : "out", fade->start_frame,
82            fade->nb_frames, fade->alpha);
83     return 0;
84 }
85
86 static int query_formats(AVFilterContext *ctx)
87 {
88     static const enum AVPixelFormat pix_fmts[] = {
89         AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P,
90         AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV410P,
91         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
92         AV_PIX_FMT_YUV440P,  AV_PIX_FMT_YUVJ440P,
93         AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,
94         AV_PIX_FMT_RGB24,    AV_PIX_FMT_BGR24,
95         AV_PIX_FMT_ARGB,     AV_PIX_FMT_ABGR,
96         AV_PIX_FMT_RGBA,     AV_PIX_FMT_BGRA,
97         AV_PIX_FMT_NONE
98     };
99
100     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
101     return 0;
102 }
103
104 const static enum AVPixelFormat studio_level_pix_fmts[] = {
105     AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P,
106     AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV410P,
107     AV_PIX_FMT_YUV440P,
108     AV_PIX_FMT_NONE
109 };
110
111 static int config_props(AVFilterLink *inlink)
112 {
113     FadeContext *fade = inlink->dst->priv;
114     const AVPixFmtDescriptor *pixdesc = av_pix_fmt_desc_get(inlink->format);
115
116     fade->hsub = pixdesc->log2_chroma_w;
117     fade->vsub = pixdesc->log2_chroma_h;
118
119     fade->bpp = av_get_bits_per_pixel(pixdesc) >> 3;
120     fade->alpha &= pixdesc->flags & PIX_FMT_ALPHA;
121     fade->is_packed_rgb = ff_fill_rgba_map(fade->rgba_map, inlink->format) >= 0;
122
123     /* use CCIR601/709 black level for studio-level pixel non-alpha components */
124     fade->black_level =
125             ff_fmt_is_in(inlink->format, studio_level_pix_fmts) && !fade->alpha ? 16 : 0;
126     /* 32768 = 1 << 15, it is an integer representation
127      * of 0.5 and is for rounding. */
128     fade->black_level_scaled = (fade->black_level << 16) + 32768;
129     return 0;
130 }
131
132 static void fade_plane(int y, int h, int w,
133                        int fade_factor, int black_level, int black_level_scaled,
134                        uint8_t offset, uint8_t step, int bytes_per_plane,
135                        uint8_t *data, int line_size)
136 {
137     uint8_t *p;
138     int i, j;
139
140     /* luma, alpha or rgb plane */
141     for (i = 0; i < h; i++) {
142         p = data + offset + (y+i) * line_size;
143         for (j = 0; j < w * bytes_per_plane; j++) {
144             /* fade->factor is using 16 lower-order bits for decimal places. */
145             *p = ((*p - black_level) * fade_factor + black_level_scaled) >> 16;
146             p+=step;
147         }
148     }
149 }
150
151 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
152 {
153     FadeContext *fade = inlink->dst->priv;
154     uint8_t *p;
155     int i, j, plane;
156
157     if (fade->factor < UINT16_MAX) {
158         if (fade->alpha) {
159             // alpha only
160             plane = fade->is_packed_rgb ? 0 : A; // alpha is on plane 0 for packed formats
161                                                  // or plane 3 for planar formats
162             fade_plane(0, frame->height, inlink->w,
163                        fade->factor, fade->black_level, fade->black_level_scaled,
164                        fade->is_packed_rgb ? fade->rgba_map[A] : 0, // alpha offset for packed formats
165                        fade->is_packed_rgb ? 4 : 1,                 // pixstep for 8 bit packed formats
166                        1, frame->data[plane], frame->linesize[plane]);
167         } else {
168             /* luma or rgb plane */
169             fade_plane(0, frame->height, inlink->w,
170                        fade->factor, fade->black_level, fade->black_level_scaled,
171                        0, 1, // offset & pixstep for Y plane or RGB packed format
172                        fade->bpp, frame->data[0], frame->linesize[0]);
173             if (frame->data[1] && frame->data[2]) {
174                 /* chroma planes */
175                 for (plane = 1; plane < 3; plane++) {
176                     for (i = 0; i < frame->height; i++) {
177                         p = frame->data[plane] + (i >> fade->vsub) * frame->linesize[plane];
178                         for (j = 0; j < inlink->w >> fade->hsub; j++) {
179                             /* 8421367 = ((128 << 1) + 1) << 15. It is an integer
180                              * representation of 128.5. The .5 is for rounding
181                              * purposes. */
182                             *p = ((*p - 128) * fade->factor + 8421367) >> 16;
183                             p++;
184                         }
185                     }
186                 }
187             }
188         }
189     }
190
191     if (fade->frame_index >= fade->start_frame &&
192         fade->frame_index <= fade->stop_frame)
193         fade->factor += fade->fade_per_frame;
194     fade->factor = av_clip_uint16(fade->factor);
195     fade->frame_index++;
196
197     return ff_filter_frame(inlink->dst->outputs[0], frame);
198 }
199
200
201 #define OFFSET(x) offsetof(FadeContext, x)
202 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
203
204 static const AVOption fade_options[] = {
205     { "type", "'in' or 'out' for fade-in/fade-out", OFFSET(type), AV_OPT_TYPE_INT, { .i64 = FADE_IN }, FADE_IN, FADE_OUT, FLAGS, "type" },
206     { "t",    "'in' or 'out' for fade-in/fade-out", OFFSET(type), AV_OPT_TYPE_INT, { .i64 = FADE_IN }, FADE_IN, FADE_OUT, FLAGS, "type" },
207         { "in",  "fade-in",  0, AV_OPT_TYPE_CONST, { .i64 = FADE_IN },  .unit = "type" },
208         { "out", "fade-out", 0, AV_OPT_TYPE_CONST, { .i64 = FADE_OUT }, .unit = "type" },
209     { "start_frame", "Number of the first frame to which to apply the effect.",
210                                                     OFFSET(start_frame), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, FLAGS },
211     { "s",           "Number of the first frame to which to apply the effect.",
212                                                     OFFSET(start_frame), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, FLAGS },
213     { "nb_frames",   "Number of frames to which the effect should be applied.",
214                                                     OFFSET(nb_frames),   AV_OPT_TYPE_INT, { .i64 = 25 }, 0, INT_MAX, FLAGS },
215     { "n",           "Number of frames to which the effect should be applied.",
216                                                     OFFSET(nb_frames),   AV_OPT_TYPE_INT, { .i64 = 25 }, 0, INT_MAX, FLAGS },
217     { "alpha",       "fade alpha if it is available on the input", OFFSET(alpha),       AV_OPT_TYPE_INT, {.i64 = 0    }, 0,       1, FLAGS },
218     { NULL },
219 };
220
221 AVFILTER_DEFINE_CLASS(fade);
222
223 static const AVFilterPad avfilter_vf_fade_inputs[] = {
224     {
225         .name             = "default",
226         .type             = AVMEDIA_TYPE_VIDEO,
227         .config_props     = config_props,
228         .get_video_buffer = ff_null_get_video_buffer,
229         .filter_frame     = filter_frame,
230         .needs_writable   = 1,
231     },
232     { NULL }
233 };
234
235 static const AVFilterPad avfilter_vf_fade_outputs[] = {
236     {
237         .name = "default",
238         .type = AVMEDIA_TYPE_VIDEO,
239     },
240     { NULL }
241 };
242
243 AVFilter avfilter_vf_fade = {
244     .name          = "fade",
245     .description   = NULL_IF_CONFIG_SMALL("Fade in/out input video."),
246     .init          = init,
247     .priv_size     = sizeof(FadeContext),
248     .priv_class    = &fade_class,
249     .query_formats = query_formats,
250
251     .inputs    = avfilter_vf_fade_inputs,
252     .outputs   = avfilter_vf_fade_outputs,
253 };