lavfi/drawutils: make ff_draw_color() accept a const rgba map
[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/eval.h"
30 #include "libavutil/opt.h"
31 #include "libavutil/pixdesc.h"
32 #include "avfilter.h"
33 #include "drawutils.h"
34 #include "internal.h"
35 #include "formats.h"
36 #include "internal.h"
37 #include "video.h"
38
39 #define R 0
40 #define G 1
41 #define B 2
42 #define A 3
43
44 #define Y 0
45 #define U 1
46 #define V 2
47
48 typedef struct {
49     const AVClass *class;
50     int factor, fade_per_frame;
51     unsigned int frame_index, start_frame, stop_frame, nb_frames;
52     int hsub, vsub, bpp;
53     unsigned int black_level, black_level_scaled;
54     uint8_t is_packed_rgb;
55     uint8_t rgba_map[4];
56     int alpha;
57
58     char *type;
59 } FadeContext;
60
61 #define OFFSET(x) offsetof(FadeContext, x)
62
63 static const AVOption fade_options[] = {
64     { "type",        "set the fade direction",                     OFFSET(type),        AV_OPT_TYPE_STRING, {.str = "in" }, CHAR_MIN, CHAR_MAX },
65     { "t",           "set the fade direction",                     OFFSET(type),        AV_OPT_TYPE_STRING, {.str = "in" }, CHAR_MIN, CHAR_MAX },
66     { "start_frame", "set expression of frame to start fading",    OFFSET(start_frame), AV_OPT_TYPE_INT, {.dbl = 0    }, 0, INT_MAX },
67     { "s",           "set expression of frame to start fading",    OFFSET(start_frame), AV_OPT_TYPE_INT, {.dbl = 0    }, 0, INT_MAX },
68     { "nb_frames",   "set expression for fade duration in frames", OFFSET(nb_frames),   AV_OPT_TYPE_INT, {.dbl = 25   }, 0, INT_MAX },
69     { "n",           "set expression for fade duration in frames", OFFSET(nb_frames),   AV_OPT_TYPE_INT, {.dbl = 25   }, 0, INT_MAX },
70     { "alpha",       "fade alpha if it is available on the input", OFFSET(alpha),       AV_OPT_TYPE_INT, {.dbl = 0    }, 0,       1 },
71     {NULL},
72 };
73
74 AVFILTER_DEFINE_CLASS(fade);
75
76 static av_cold int init(AVFilterContext *ctx, const char *args)
77 {
78     FadeContext *fade = ctx->priv;
79     int ret = 0;
80     char *args1, *expr, *bufptr = NULL;
81
82     fade->class = &fade_class;
83     av_opt_set_defaults(fade);
84
85     if (!(args1 = av_strdup(args))) {
86         ret = AVERROR(ENOMEM);
87         goto end;
88     }
89
90     if (expr = av_strtok(args1, ":", &bufptr)) {
91         av_free(fade->type);
92         if (!(fade->type = av_strdup(expr))) {
93             ret = AVERROR(ENOMEM);
94             goto end;
95         }
96     }
97     if (expr = av_strtok(NULL, ":", &bufptr)) {
98         if ((ret = av_opt_set(fade, "start_frame", expr, 0)) < 0) {
99             av_log(ctx, AV_LOG_ERROR,
100                    "Invalid value '%s' for start_frame option\n", expr);
101             return ret;
102         }
103     }
104     if (expr = av_strtok(NULL, ":", &bufptr)) {
105         if ((ret = av_opt_set(fade, "nb_frames", expr, 0)) < 0) {
106             av_log(ctx, AV_LOG_ERROR,
107                    "Invalid value '%s' for nb_frames option\n", expr);
108             return ret;
109         }
110     }
111
112     if (bufptr && (ret = av_set_options_string(fade, bufptr, "=", ":")) < 0)
113         goto end;
114
115     fade->fade_per_frame = (1 << 16) / fade->nb_frames;
116     if (!strcmp(fade->type, "in"))
117         fade->factor = 0;
118     else if (!strcmp(fade->type, "out")) {
119         fade->fade_per_frame = -fade->fade_per_frame;
120         fade->factor = (1 << 16);
121     } else {
122         av_log(ctx, AV_LOG_ERROR,
123                "Type argument must be 'in' or 'out' but '%s' was specified\n", fade->type);
124         ret = AVERROR(EINVAL);
125         goto end;
126     }
127     fade->stop_frame = fade->start_frame + fade->nb_frames;
128
129     av_log(ctx, AV_LOG_VERBOSE,
130            "type:%s start_frame:%d nb_frames:%d alpha:%d\n",
131            fade->type, fade->start_frame, fade->nb_frames, fade->alpha);
132
133 end:
134     av_free(args1);
135     return ret;
136 }
137
138 static av_cold void uninit(AVFilterContext *ctx)
139 {
140     FadeContext *fade = ctx->priv;
141
142     av_freep(&fade->type);
143 }
144
145 static int query_formats(AVFilterContext *ctx)
146 {
147     static const enum PixelFormat pix_fmts[] = {
148         PIX_FMT_YUV444P,  PIX_FMT_YUV422P,  PIX_FMT_YUV420P,
149         PIX_FMT_YUV411P,  PIX_FMT_YUV410P,
150         PIX_FMT_YUVJ444P, PIX_FMT_YUVJ422P, PIX_FMT_YUVJ420P,
151         PIX_FMT_YUV440P,  PIX_FMT_YUVJ440P,
152         PIX_FMT_YUVA420P,
153         PIX_FMT_RGB24,    PIX_FMT_BGR24,
154         PIX_FMT_ARGB,     PIX_FMT_ABGR,
155         PIX_FMT_RGBA,     PIX_FMT_BGRA,
156         PIX_FMT_NONE
157     };
158
159     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
160     return 0;
161 }
162
163 const static enum PixelFormat studio_level_pix_fmts[] = {
164     PIX_FMT_YUV444P,  PIX_FMT_YUV422P,  PIX_FMT_YUV420P,
165     PIX_FMT_YUV411P,  PIX_FMT_YUV410P,
166     PIX_FMT_YUV440P,
167     PIX_FMT_NONE
168 };
169
170 static enum PixelFormat alpha_pix_fmts[] = {
171     PIX_FMT_YUVA420P,
172     PIX_FMT_ARGB, PIX_FMT_ABGR,
173     PIX_FMT_RGBA, PIX_FMT_BGRA,
174     PIX_FMT_NONE
175 };
176
177 static int config_props(AVFilterLink *inlink)
178 {
179     FadeContext *fade = inlink->dst->priv;
180     const AVPixFmtDescriptor *pixdesc = &av_pix_fmt_descriptors[inlink->format];
181
182     fade->hsub = pixdesc->log2_chroma_w;
183     fade->vsub = pixdesc->log2_chroma_h;
184
185     fade->bpp = av_get_bits_per_pixel(pixdesc) >> 3;
186     fade->alpha = fade->alpha ? ff_fmt_is_in(inlink->format, alpha_pix_fmts) : 0;
187     fade->is_packed_rgb = ff_fill_rgba_map(fade->rgba_map, inlink->format) >= 0;
188
189     /* use CCIR601/709 black level for studio-level pixel non-alpha components */
190     fade->black_level =
191             ff_fmt_is_in(inlink->format, studio_level_pix_fmts) && !fade->alpha ? 16 : 0;
192     /* 32768 = 1 << 15, it is an integer representation
193      * of 0.5 and is for rounding. */
194     fade->black_level_scaled = (fade->black_level << 16) + 32768;
195     return 0;
196 }
197
198 static void fade_plane(int y, int h, int w,
199                        int fade_factor, int black_level, int black_level_scaled,
200                        uint8_t offset, uint8_t step, int bytes_per_plane,
201                        uint8_t *data, int line_size)
202 {
203     uint8_t *p;
204     int i, j;
205
206     /* luma, alpha or rgb plane */
207     for (i = 0; i < h; i++) {
208         p = data + offset + (y+i) * line_size;
209         for (j = 0; j < w * bytes_per_plane; j++) {
210             /* fade->factor is using 16 lower-order bits for decimal places. */
211             *p = ((*p - black_level) * fade_factor + black_level_scaled) >> 16;
212             p+=step;
213         }
214     }
215 }
216
217 static int draw_slice(AVFilterLink *inlink, int y, int h, int slice_dir)
218 {
219     FadeContext *fade = inlink->dst->priv;
220     AVFilterBufferRef *outpic = inlink->cur_buf;
221     uint8_t *p;
222     int i, j, plane;
223
224     if (fade->factor < UINT16_MAX) {
225         if (fade->alpha) {
226             // alpha only
227             plane = fade->is_packed_rgb ? 0 : A; // alpha is on plane 0 for packed formats
228                                                  // or plane 3 for planar formats
229             fade_plane(y, h, inlink->w,
230                        fade->factor, fade->black_level, fade->black_level_scaled,
231                        fade->is_packed_rgb ? fade->rgba_map[A] : 0, // alpha offset for packed formats
232                        fade->is_packed_rgb ? 4 : 1,                 // pixstep for 8 bit packed formats
233                        1, outpic->data[plane], outpic->linesize[plane]);
234         } else {
235             /* luma or rgb plane */
236             fade_plane(y, h, inlink->w,
237                        fade->factor, fade->black_level, fade->black_level_scaled,
238                        0, 1, // offset & pixstep for Y plane or RGB packed format
239                        fade->bpp, outpic->data[0], outpic->linesize[0]);
240             if (outpic->data[1] && outpic->data[2]) {
241                 /* chroma planes */
242                 for (plane = 1; plane < 3; plane++) {
243                     for (i = 0; i < h; i++) {
244                         p = outpic->data[plane] + ((y+i) >> fade->vsub) * outpic->linesize[plane];
245                         for (j = 0; j < inlink->w >> fade->hsub; j++) {
246                             /* 8421367 = ((128 << 1) + 1) << 15. It is an integer
247                              * representation of 128.5. The .5 is for rounding
248                              * purposes. */
249                             *p = ((*p - 128) * fade->factor + 8421367) >> 16;
250                             p++;
251                         }
252                     }
253                 }
254             }
255         }
256     }
257
258     return ff_draw_slice(inlink->dst->outputs[0], y, h, slice_dir);
259 }
260
261 static int end_frame(AVFilterLink *inlink)
262 {
263     FadeContext *fade = inlink->dst->priv;
264     int ret;
265
266     ret = ff_end_frame(inlink->dst->outputs[0]);
267
268     if (fade->frame_index >= fade->start_frame &&
269         fade->frame_index <= fade->stop_frame)
270         fade->factor += fade->fade_per_frame;
271     fade->factor = av_clip_uint16(fade->factor);
272     fade->frame_index++;
273
274     return ret;
275 }
276
277 AVFilter avfilter_vf_fade = {
278     .name          = "fade",
279     .description   = NULL_IF_CONFIG_SMALL("Fade in/out input video."),
280     .init          = init,
281     .uninit        = uninit,
282     .priv_size     = sizeof(FadeContext),
283     .query_formats = query_formats,
284
285     .inputs    = (const AVFilterPad[]) {{ .name            = "default",
286                                           .type            = AVMEDIA_TYPE_VIDEO,
287                                           .config_props    = config_props,
288                                           .get_video_buffer = ff_null_get_video_buffer,
289                                           .start_frame      = ff_null_start_frame,
290                                           .draw_slice      = draw_slice,
291                                           .end_frame       = end_frame,
292                                           .min_perms       = AV_PERM_READ | AV_PERM_WRITE,
293                                           .rej_perms       = AV_PERM_PRESERVE, },
294                                         { .name = NULL}},
295     .outputs   = (const AVFilterPad[]) {{ .name            = "default",
296                                           .type            = AVMEDIA_TYPE_VIDEO, },
297                                         { .name = NULL}},
298 };