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