74c356e21503635411bbe0edfec316b061a0a0d2
[ffmpeg.git] / libavfilter / vf_overlay.c
1 /*
2  * Copyright (c) 2010 Stefano Sabatini
3  * Copyright (c) 2010 Baptiste Coudurier
4  * Copyright (c) 2007 Bobby Bingham
5  *
6  * This file is part of Libav.
7  *
8  * Libav is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * Libav is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with Libav; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 /**
24  * @file
25  * overlay one video on top of another
26  */
27
28 #include "avfilter.h"
29 #include "formats.h"
30 #include "libavutil/common.h"
31 #include "libavutil/eval.h"
32 #include "libavutil/avstring.h"
33 #include "libavutil/pixdesc.h"
34 #include "libavutil/imgutils.h"
35 #include "libavutil/mathematics.h"
36 #include "internal.h"
37 #include "video.h"
38
39 static const char *const var_names[] = {
40     "E",
41     "PHI",
42     "PI",
43     "main_w",    "W", ///< width  of the main    video
44     "main_h",    "H", ///< height of the main    video
45     "overlay_w", "w", ///< width  of the overlay video
46     "overlay_h", "h", ///< height of the overlay video
47     NULL
48 };
49
50 enum var_name {
51     VAR_E,
52     VAR_PHI,
53     VAR_PI,
54     VAR_MAIN_W,    VAR_MW,
55     VAR_MAIN_H,    VAR_MH,
56     VAR_OVERLAY_W, VAR_OW,
57     VAR_OVERLAY_H, VAR_OH,
58     VAR_VARS_NB
59 };
60
61 #define MAIN    0
62 #define OVERLAY 1
63
64 typedef struct {
65     int x, y;                   ///< position of overlayed picture
66
67     AVFilterBufferRef *overpicref;
68
69     int max_plane_step[4];      ///< steps per pixel for each plane
70     int hsub, vsub;             ///< chroma subsampling values
71
72     char x_expr[256], y_expr[256];
73 } OverlayContext;
74
75 static av_cold int init(AVFilterContext *ctx, const char *args)
76 {
77     OverlayContext *over = ctx->priv;
78
79     av_strlcpy(over->x_expr, "0", sizeof(over->x_expr));
80     av_strlcpy(over->y_expr, "0", sizeof(over->y_expr));
81
82     if (args)
83         sscanf(args, "%255[^:]:%255[^:]", over->x_expr, over->y_expr);
84
85     return 0;
86 }
87
88 static av_cold void uninit(AVFilterContext *ctx)
89 {
90     OverlayContext *over = ctx->priv;
91
92     avfilter_unref_bufferp(&over->overpicref);
93 }
94
95 static int query_formats(AVFilterContext *ctx)
96 {
97     const enum PixelFormat inout_pix_fmts[] = { PIX_FMT_YUV420P,  PIX_FMT_NONE };
98     const enum PixelFormat blend_pix_fmts[] = { PIX_FMT_YUVA420P, PIX_FMT_NONE };
99     AVFilterFormats *inout_formats = ff_make_format_list(inout_pix_fmts);
100     AVFilterFormats *blend_formats = ff_make_format_list(blend_pix_fmts);
101
102     ff_formats_ref(inout_formats, &ctx->inputs [MAIN   ]->out_formats);
103     ff_formats_ref(blend_formats, &ctx->inputs [OVERLAY]->out_formats);
104     ff_formats_ref(inout_formats, &ctx->outputs[MAIN   ]->in_formats );
105
106     return 0;
107 }
108
109 static int config_input_main(AVFilterLink *inlink)
110 {
111     OverlayContext *over = inlink->dst->priv;
112     const AVPixFmtDescriptor *pix_desc = &av_pix_fmt_descriptors[inlink->format];
113
114     av_image_fill_max_pixsteps(over->max_plane_step, NULL, pix_desc);
115     over->hsub = pix_desc->log2_chroma_w;
116     over->vsub = pix_desc->log2_chroma_h;
117
118     return 0;
119 }
120
121 static int config_input_overlay(AVFilterLink *inlink)
122 {
123     AVFilterContext *ctx  = inlink->dst;
124     OverlayContext  *over = inlink->dst->priv;
125     char *expr;
126     double var_values[VAR_VARS_NB], res;
127     int ret;
128
129     /* Finish the configuration by evaluating the expressions
130        now when both inputs are configured. */
131     var_values[VAR_E  ] = M_E;
132     var_values[VAR_PHI] = M_PHI;
133     var_values[VAR_PI ] = M_PI;
134
135     var_values[VAR_MAIN_W   ] = var_values[VAR_MW] = ctx->inputs[MAIN   ]->w;
136     var_values[VAR_MAIN_H   ] = var_values[VAR_MH] = ctx->inputs[MAIN   ]->h;
137     var_values[VAR_OVERLAY_W] = var_values[VAR_OW] = ctx->inputs[OVERLAY]->w;
138     var_values[VAR_OVERLAY_H] = var_values[VAR_OH] = ctx->inputs[OVERLAY]->h;
139
140     if ((ret = av_expr_parse_and_eval(&res, (expr = over->x_expr), var_names, var_values,
141                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
142         goto fail;
143     over->x = res;
144     if ((ret = av_expr_parse_and_eval(&res, (expr = over->y_expr), var_names, var_values,
145                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)))
146         goto fail;
147     over->y = res;
148     /* x may depend on y */
149     if ((ret = av_expr_parse_and_eval(&res, (expr = over->x_expr), var_names, var_values,
150                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
151         goto fail;
152     over->x = res;
153
154     av_log(ctx, AV_LOG_VERBOSE,
155            "main w:%d h:%d fmt:%s overlay x:%d y:%d w:%d h:%d fmt:%s\n",
156            ctx->inputs[MAIN]->w, ctx->inputs[MAIN]->h,
157            av_pix_fmt_descriptors[ctx->inputs[MAIN]->format].name,
158            over->x, over->y,
159            ctx->inputs[OVERLAY]->w, ctx->inputs[OVERLAY]->h,
160            av_pix_fmt_descriptors[ctx->inputs[OVERLAY]->format].name);
161
162     if (over->x < 0 || over->y < 0 ||
163         over->x + var_values[VAR_OVERLAY_W] > var_values[VAR_MAIN_W] ||
164         over->y + var_values[VAR_OVERLAY_H] > var_values[VAR_MAIN_H]) {
165         av_log(ctx, AV_LOG_ERROR,
166                "Overlay area (%d,%d)<->(%d,%d) not within the main area (0,0)<->(%d,%d) or zero-sized\n",
167                over->x, over->y,
168                (int)(over->x + var_values[VAR_OVERLAY_W]),
169                (int)(over->y + var_values[VAR_OVERLAY_H]),
170                (int)var_values[VAR_MAIN_W], (int)var_values[VAR_MAIN_H]);
171         return AVERROR(EINVAL);
172     }
173     return 0;
174
175 fail:
176     av_log(NULL, AV_LOG_ERROR,
177            "Error when evaluating the expression '%s'\n", expr);
178     return ret;
179 }
180
181 static int config_output(AVFilterLink *outlink)
182 {
183     AVFilterContext *ctx = outlink->src;
184
185     outlink->w = ctx->inputs[MAIN]->w;
186     outlink->h = ctx->inputs[MAIN]->h;
187     outlink->time_base = ctx->inputs[MAIN]->time_base;
188
189     return 0;
190 }
191
192 static AVFilterBufferRef *get_video_buffer(AVFilterLink *link, int perms, int w, int h)
193 {
194     return ff_get_video_buffer(link->dst->outputs[0], perms, w, h);
195 }
196
197 static int start_frame(AVFilterLink *inlink, AVFilterBufferRef *inpicref)
198 {
199     AVFilterBufferRef *outpicref = avfilter_ref_buffer(inpicref, ~0);
200     AVFilterContext *ctx = inlink->dst;
201     OverlayContext *over = ctx->priv;
202
203     if (!outpicref)
204         return AVERROR(ENOMEM);
205
206     if (!over->overpicref ||
207         av_compare_ts(over->overpicref->pts, inlink->time_base,
208                       outpicref->pts, ctx->inputs[OVERLAY]->time_base) < 0) {
209         AVFilterBufferRef *old = over->overpicref;
210         over->overpicref = NULL;
211         ff_request_frame(ctx->inputs[OVERLAY]);
212         if (over->overpicref) {
213             if (old)
214                 avfilter_unref_buffer(old);
215         } else
216             over->overpicref = old;
217     }
218
219     return ff_start_frame(inlink->dst->outputs[0], outpicref);
220 }
221
222 static int start_frame_overlay(AVFilterLink *inlink, AVFilterBufferRef *inpicref)
223 {
224     AVFilterContext *ctx = inlink->dst;
225     OverlayContext *over = ctx->priv;
226
227     inlink->cur_buf  = NULL;
228     avfilter_unref_bufferp(&over->overpicref);
229     over->overpicref = inpicref;
230     return 0;
231 }
232
233 static void blend_slice(AVFilterContext *ctx,
234                         AVFilterBufferRef *dst, AVFilterBufferRef *src,
235                         int x, int y, int w, int h,
236                         int slice_y, int slice_w, int slice_h)
237 {
238     OverlayContext *over = ctx->priv;
239     int i, j, k;
240     int width, height;
241     int overlay_end_y = y+h;
242     int slice_end_y = slice_y+slice_h;
243     int end_y, start_y;
244
245     width = FFMIN(slice_w - x, w);
246     end_y = FFMIN(slice_end_y, overlay_end_y);
247     start_y = FFMAX(y, slice_y);
248     height = end_y - start_y;
249
250     if (dst->format == PIX_FMT_BGR24 || dst->format == PIX_FMT_RGB24) {
251         uint8_t *dp = dst->data[0] + x * 3 + start_y * dst->linesize[0];
252         uint8_t *sp = src->data[0];
253         int b = dst->format == PIX_FMT_BGR24 ? 2 : 0;
254         int r = dst->format == PIX_FMT_BGR24 ? 0 : 2;
255         if (slice_y > y)
256             sp += (slice_y - y) * src->linesize[0];
257         for (i = 0; i < height; i++) {
258             uint8_t *d = dp, *s = sp;
259             for (j = 0; j < width; j++) {
260                 d[r] = (d[r] * (0xff - s[3]) + s[0] * s[3] + 128) >> 8;
261                 d[1] = (d[1] * (0xff - s[3]) + s[1] * s[3] + 128) >> 8;
262                 d[b] = (d[b] * (0xff - s[3]) + s[2] * s[3] + 128) >> 8;
263                 d += 3;
264                 s += 4;
265             }
266             dp += dst->linesize[0];
267             sp += src->linesize[0];
268         }
269     } else {
270         for (i = 0; i < 3; i++) {
271             int hsub = i ? over->hsub : 0;
272             int vsub = i ? over->vsub : 0;
273             uint8_t *dp = dst->data[i] + (x >> hsub) +
274                 (start_y >> vsub) * dst->linesize[i];
275             uint8_t *sp = src->data[i];
276             uint8_t *ap = src->data[3];
277             int wp = FFALIGN(width, 1<<hsub) >> hsub;
278             int hp = FFALIGN(height, 1<<vsub) >> vsub;
279             if (slice_y > y) {
280                 sp += ((slice_y - y) >> vsub) * src->linesize[i];
281                 ap += (slice_y - y) * src->linesize[3];
282             }
283             for (j = 0; j < hp; j++) {
284                 uint8_t *d = dp, *s = sp, *a = ap;
285                 for (k = 0; k < wp; k++) {
286                     // average alpha for color components, improve quality
287                     int alpha_v, alpha_h, alpha;
288                     if (hsub && vsub && j+1 < hp && k+1 < wp) {
289                         alpha = (a[0] + a[src->linesize[3]] +
290                                  a[1] + a[src->linesize[3]+1]) >> 2;
291                     } else if (hsub || vsub) {
292                         alpha_h = hsub && k+1 < wp ?
293                             (a[0] + a[1]) >> 1 : a[0];
294                         alpha_v = vsub && j+1 < hp ?
295                             (a[0] + a[src->linesize[3]]) >> 1 : a[0];
296                         alpha = (alpha_v + alpha_h) >> 1;
297                     } else
298                         alpha = a[0];
299                     *d = (*d * (0xff - alpha) + *s++ * alpha + 128) >> 8;
300                     d++;
301                     a += 1 << hsub;
302                 }
303                 dp += dst->linesize[i];
304                 sp += src->linesize[i];
305                 ap += (1 << vsub) * src->linesize[3];
306             }
307         }
308     }
309 }
310
311 static int draw_slice(AVFilterLink *inlink, int y, int h, int slice_dir)
312 {
313     AVFilterContext *ctx = inlink->dst;
314     AVFilterLink *outlink = ctx->outputs[0];
315     AVFilterBufferRef *outpicref = inlink->cur_buf;
316     OverlayContext *over = ctx->priv;
317
318     if (over->overpicref &&
319         !(over->x >= outpicref->video->w || over->y >= outpicref->video->h ||
320           y+h < over->y || y >= over->y + over->overpicref->video->h)) {
321         blend_slice(ctx, outpicref, over->overpicref, over->x, over->y,
322                     over->overpicref->video->w, over->overpicref->video->h,
323                     y, outpicref->video->w, h);
324     }
325     return ff_draw_slice(outlink, y, h, slice_dir);
326 }
327
328 static int end_frame(AVFilterLink *inlink)
329 {
330     return ff_end_frame(inlink->dst->outputs[0]);
331 }
332
333 static int null_draw_slice(AVFilterLink *inlink, int y, int h, int slice_dir)
334 {
335     return 0;
336 }
337
338 static int null_end_frame(AVFilterLink *inlink)
339 {
340     return 0;
341 }
342
343 static int poll_frame(AVFilterLink *link)
344 {
345     AVFilterContext   *s = link->src;
346     OverlayContext *over = s->priv;
347     int ret = ff_poll_frame(s->inputs[OVERLAY]);
348
349     if (ret == AVERROR_EOF)
350         ret = !!over->overpicref;
351
352     return ret && ff_poll_frame(s->inputs[MAIN]);
353 }
354
355 AVFilter avfilter_vf_overlay = {
356     .name      = "overlay",
357     .description = NULL_IF_CONFIG_SMALL("Overlay a video source on top of the input."),
358
359     .init      = init,
360     .uninit    = uninit,
361
362     .priv_size = sizeof(OverlayContext),
363
364     .query_formats = query_formats,
365
366     .inputs    = (const AVFilterPad[]) {{ .name            = "main",
367                                           .type            = AVMEDIA_TYPE_VIDEO,
368                                           .start_frame     = start_frame,
369                                           .get_video_buffer= get_video_buffer,
370                                           .config_props    = config_input_main,
371                                           .draw_slice      = draw_slice,
372                                           .end_frame       = end_frame,
373                                           .min_perms       = AV_PERM_READ,
374                                           .rej_perms       = AV_PERM_REUSE2|AV_PERM_PRESERVE, },
375                                         { .name            = "overlay",
376                                           .type            = AVMEDIA_TYPE_VIDEO,
377                                           .start_frame     = start_frame_overlay,
378                                           .config_props    = config_input_overlay,
379                                           .draw_slice      = null_draw_slice,
380                                           .end_frame       = null_end_frame,
381                                           .min_perms       = AV_PERM_READ,
382                                           .rej_perms       = AV_PERM_REUSE2, },
383                                         { .name = NULL}},
384     .outputs   = (const AVFilterPad[]) {{ .name            = "default",
385                                           .type            = AVMEDIA_TYPE_VIDEO,
386                                           .config_props    = config_output,
387                                           .poll_frame      = poll_frame },
388                                         { .name = NULL}},
389 };