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