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