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