lavfi: check all avfilter_ref_buffer() calls for errors.
[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/eval.h"
31 #include "libavutil/avstring.h"
32 #include "libavutil/pixdesc.h"
33 #include "libavutil/imgutils.h"
34 #include "libavutil/mathematics.h"
35 #include "internal.h"
36 #include "video.h"
37
38 static const char *const var_names[] = {
39     "E",
40     "PHI",
41     "PI",
42     "main_w",    "W", ///< width  of the main    video
43     "main_h",    "H", ///< height of the main    video
44     "overlay_w", "w", ///< width  of the overlay video
45     "overlay_h", "h", ///< height of the overlay video
46     NULL
47 };
48
49 enum var_name {
50     VAR_E,
51     VAR_PHI,
52     VAR_PI,
53     VAR_MAIN_W,    VAR_MW,
54     VAR_MAIN_H,    VAR_MH,
55     VAR_OVERLAY_W, VAR_OW,
56     VAR_OVERLAY_H, VAR_OH,
57     VAR_VARS_NB
58 };
59
60 #define MAIN    0
61 #define OVERLAY 1
62
63 typedef struct {
64     int x, y;                   ///< position of overlayed picture
65
66     AVFilterBufferRef *overpicref;
67
68     int max_plane_step[4];      ///< steps per pixel for each plane
69     int hsub, vsub;             ///< chroma subsampling values
70
71     char x_expr[256], y_expr[256];
72 } OverlayContext;
73
74 static av_cold int init(AVFilterContext *ctx, const char *args)
75 {
76     OverlayContext *over = ctx->priv;
77
78     av_strlcpy(over->x_expr, "0", sizeof(over->x_expr));
79     av_strlcpy(over->y_expr, "0", sizeof(over->y_expr));
80
81     if (args)
82         sscanf(args, "%255[^:]:%255[^:]", over->x_expr, over->y_expr);
83
84     return 0;
85 }
86
87 static av_cold void uninit(AVFilterContext *ctx)
88 {
89     OverlayContext *over = ctx->priv;
90
91     avfilter_unref_bufferp(&over->overpicref);
92 }
93
94 static int query_formats(AVFilterContext *ctx)
95 {
96     const enum PixelFormat inout_pix_fmts[] = { PIX_FMT_YUV420P,  PIX_FMT_NONE };
97     const enum PixelFormat blend_pix_fmts[] = { PIX_FMT_YUVA420P, PIX_FMT_NONE };
98     AVFilterFormats *inout_formats = ff_make_format_list(inout_pix_fmts);
99     AVFilterFormats *blend_formats = ff_make_format_list(blend_pix_fmts);
100
101     ff_formats_ref(inout_formats, &ctx->inputs [MAIN   ]->out_formats);
102     ff_formats_ref(blend_formats, &ctx->inputs [OVERLAY]->out_formats);
103     ff_formats_ref(inout_formats, &ctx->outputs[MAIN   ]->in_formats );
104
105     return 0;
106 }
107
108 static int config_input_main(AVFilterLink *inlink)
109 {
110     OverlayContext *over = inlink->dst->priv;
111     const AVPixFmtDescriptor *pix_desc = &av_pix_fmt_descriptors[inlink->format];
112
113     av_image_fill_max_pixsteps(over->max_plane_step, NULL, pix_desc);
114     over->hsub = pix_desc->log2_chroma_w;
115     over->vsub = pix_desc->log2_chroma_h;
116
117     return 0;
118 }
119
120 static int config_input_overlay(AVFilterLink *inlink)
121 {
122     AVFilterContext *ctx  = inlink->dst;
123     OverlayContext  *over = inlink->dst->priv;
124     char *expr;
125     double var_values[VAR_VARS_NB], res;
126     int ret;
127
128     /* Finish the configuration by evaluating the expressions
129        now when both inputs are configured. */
130     var_values[VAR_E  ] = M_E;
131     var_values[VAR_PHI] = M_PHI;
132     var_values[VAR_PI ] = M_PI;
133
134     var_values[VAR_MAIN_W   ] = var_values[VAR_MW] = ctx->inputs[MAIN   ]->w;
135     var_values[VAR_MAIN_H   ] = var_values[VAR_MH] = ctx->inputs[MAIN   ]->h;
136     var_values[VAR_OVERLAY_W] = var_values[VAR_OW] = ctx->inputs[OVERLAY]->w;
137     var_values[VAR_OVERLAY_H] = var_values[VAR_OH] = ctx->inputs[OVERLAY]->h;
138
139     if ((ret = av_expr_parse_and_eval(&res, (expr = over->x_expr), var_names, var_values,
140                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
141         goto fail;
142     over->x = res;
143     if ((ret = av_expr_parse_and_eval(&res, (expr = over->y_expr), var_names, var_values,
144                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)))
145         goto fail;
146     over->y = res;
147     /* x may depend on y */
148     if ((ret = av_expr_parse_and_eval(&res, (expr = over->x_expr), var_names, var_values,
149                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
150         goto fail;
151     over->x = res;
152
153     av_log(ctx, AV_LOG_VERBOSE,
154            "main w:%d h:%d fmt:%s overlay x:%d y:%d w:%d h:%d fmt:%s\n",
155            ctx->inputs[MAIN]->w, ctx->inputs[MAIN]->h,
156            av_pix_fmt_descriptors[ctx->inputs[MAIN]->format].name,
157            over->x, over->y,
158            ctx->inputs[OVERLAY]->w, ctx->inputs[OVERLAY]->h,
159            av_pix_fmt_descriptors[ctx->inputs[OVERLAY]->format].name);
160
161     if (over->x < 0 || over->y < 0 ||
162         over->x + var_values[VAR_OVERLAY_W] > var_values[VAR_MAIN_W] ||
163         over->y + var_values[VAR_OVERLAY_H] > var_values[VAR_MAIN_H]) {
164         av_log(ctx, AV_LOG_ERROR,
165                "Overlay area (%d,%d)<->(%d,%d) not within the main area (0,0)<->(%d,%d) or zero-sized\n",
166                over->x, over->y,
167                (int)(over->x + var_values[VAR_OVERLAY_W]),
168                (int)(over->y + var_values[VAR_OVERLAY_H]),
169                (int)var_values[VAR_MAIN_W], (int)var_values[VAR_MAIN_H]);
170         return AVERROR(EINVAL);
171     }
172     return 0;
173
174 fail:
175     av_log(NULL, AV_LOG_ERROR,
176            "Error when evaluating the expression '%s'\n", expr);
177     return ret;
178 }
179
180 static int config_output(AVFilterLink *outlink)
181 {
182     AVFilterContext *ctx = outlink->src;
183     int exact;
184     // common timebase computation:
185     AVRational tb1 = ctx->inputs[MAIN   ]->time_base;
186     AVRational tb2 = ctx->inputs[OVERLAY]->time_base;
187     AVRational *tb = &ctx->outputs[0]->time_base;
188     exact = av_reduce(&tb->num, &tb->den,
189                       av_gcd((int64_t)tb1.num * tb2.den,
190                              (int64_t)tb2.num * tb1.den),
191                       (int64_t)tb1.den * tb2.den, INT_MAX);
192     av_log(ctx, AV_LOG_VERBOSE,
193            "main_tb:%d/%d overlay_tb:%d/%d -> tb:%d/%d exact:%d\n",
194            tb1.num, tb1.den, tb2.num, tb2.den, tb->num, tb->den, exact);
195     if (!exact)
196         av_log(ctx, AV_LOG_WARNING,
197                "Timestamp conversion inexact, timestamp information loss may occurr\n");
198
199     outlink->w = ctx->inputs[MAIN]->w;
200     outlink->h = ctx->inputs[MAIN]->h;
201
202     return 0;
203 }
204
205 static AVFilterBufferRef *get_video_buffer(AVFilterLink *link, int perms, int w, int h)
206 {
207     return ff_get_video_buffer(link->dst->outputs[0], perms, w, h);
208 }
209
210 static int start_frame(AVFilterLink *inlink, AVFilterBufferRef *inpicref)
211 {
212     AVFilterBufferRef *outpicref = avfilter_ref_buffer(inpicref, ~0);
213     AVFilterContext *ctx = inlink->dst;
214     OverlayContext *over = ctx->priv;
215
216     if (!outpicref)
217         return AVERROR(ENOMEM);
218
219     outpicref->pts = av_rescale_q(outpicref->pts, ctx->inputs[MAIN]->time_base,
220                                   ctx->outputs[0]->time_base);
221
222     if (!over->overpicref || over->overpicref->pts < outpicref->pts) {
223         AVFilterBufferRef *old = over->overpicref;
224         over->overpicref = NULL;
225         ff_request_frame(ctx->inputs[OVERLAY]);
226         if (over->overpicref) {
227             if (old)
228                 avfilter_unref_buffer(old);
229         } else
230             over->overpicref = old;
231     }
232
233     return ff_start_frame(inlink->dst->outputs[0], outpicref);
234 }
235
236 static int start_frame_overlay(AVFilterLink *inlink, AVFilterBufferRef *inpicref)
237 {
238     AVFilterContext *ctx = inlink->dst;
239     OverlayContext *over = ctx->priv;
240
241     over->overpicref = inpicref;
242     over->overpicref->pts = av_rescale_q(inpicref->pts, ctx->inputs[OVERLAY]->time_base,
243                                          ctx->outputs[0]->time_base);
244     return 0;
245 }
246
247 static void blend_slice(AVFilterContext *ctx,
248                         AVFilterBufferRef *dst, AVFilterBufferRef *src,
249                         int x, int y, int w, int h,
250                         int slice_y, int slice_w, int slice_h)
251 {
252     OverlayContext *over = ctx->priv;
253     int i, j, k;
254     int width, height;
255     int overlay_end_y = y+h;
256     int slice_end_y = slice_y+slice_h;
257     int end_y, start_y;
258
259     width = FFMIN(slice_w - x, w);
260     end_y = FFMIN(slice_end_y, overlay_end_y);
261     start_y = FFMAX(y, slice_y);
262     height = end_y - start_y;
263
264     if (dst->format == PIX_FMT_BGR24 || dst->format == PIX_FMT_RGB24) {
265         uint8_t *dp = dst->data[0] + x * 3 + start_y * dst->linesize[0];
266         uint8_t *sp = src->data[0];
267         int b = dst->format == PIX_FMT_BGR24 ? 2 : 0;
268         int r = dst->format == PIX_FMT_BGR24 ? 0 : 2;
269         if (slice_y > y)
270             sp += (slice_y - y) * src->linesize[0];
271         for (i = 0; i < height; i++) {
272             uint8_t *d = dp, *s = sp;
273             for (j = 0; j < width; j++) {
274                 d[r] = (d[r] * (0xff - s[3]) + s[0] * s[3] + 128) >> 8;
275                 d[1] = (d[1] * (0xff - s[3]) + s[1] * s[3] + 128) >> 8;
276                 d[b] = (d[b] * (0xff - s[3]) + s[2] * s[3] + 128) >> 8;
277                 d += 3;
278                 s += 4;
279             }
280             dp += dst->linesize[0];
281             sp += src->linesize[0];
282         }
283     } else {
284         for (i = 0; i < 3; i++) {
285             int hsub = i ? over->hsub : 0;
286             int vsub = i ? over->vsub : 0;
287             uint8_t *dp = dst->data[i] + (x >> hsub) +
288                 (start_y >> vsub) * dst->linesize[i];
289             uint8_t *sp = src->data[i];
290             uint8_t *ap = src->data[3];
291             int wp = FFALIGN(width, 1<<hsub) >> hsub;
292             int hp = FFALIGN(height, 1<<vsub) >> vsub;
293             if (slice_y > y) {
294                 sp += ((slice_y - y) >> vsub) * src->linesize[i];
295                 ap += (slice_y - y) * src->linesize[3];
296             }
297             for (j = 0; j < hp; j++) {
298                 uint8_t *d = dp, *s = sp, *a = ap;
299                 for (k = 0; k < wp; k++) {
300                     // average alpha for color components, improve quality
301                     int alpha_v, alpha_h, alpha;
302                     if (hsub && vsub && j+1 < hp && k+1 < wp) {
303                         alpha = (a[0] + a[src->linesize[3]] +
304                                  a[1] + a[src->linesize[3]+1]) >> 2;
305                     } else if (hsub || vsub) {
306                         alpha_h = hsub && k+1 < wp ?
307                             (a[0] + a[1]) >> 1 : a[0];
308                         alpha_v = vsub && j+1 < hp ?
309                             (a[0] + a[src->linesize[3]]) >> 1 : a[0];
310                         alpha = (alpha_v + alpha_h) >> 1;
311                     } else
312                         alpha = a[0];
313                     *d = (*d * (0xff - alpha) + *s++ * alpha + 128) >> 8;
314                     d++;
315                     a += 1 << hsub;
316                 }
317                 dp += dst->linesize[i];
318                 sp += src->linesize[i];
319                 ap += (1 << vsub) * src->linesize[3];
320             }
321         }
322     }
323 }
324
325 static int draw_slice(AVFilterLink *inlink, int y, int h, int slice_dir)
326 {
327     AVFilterContext *ctx = inlink->dst;
328     AVFilterLink *outlink = ctx->outputs[0];
329     AVFilterBufferRef *outpicref = inlink->cur_buf;
330     OverlayContext *over = ctx->priv;
331
332     if (over->overpicref &&
333         !(over->x >= outpicref->video->w || over->y >= outpicref->video->h ||
334           y+h < over->y || y >= over->y + over->overpicref->video->h)) {
335         blend_slice(ctx, outpicref, over->overpicref, over->x, over->y,
336                     over->overpicref->video->w, over->overpicref->video->h,
337                     y, outpicref->video->w, h);
338     }
339     return ff_draw_slice(outlink, y, h, slice_dir);
340 }
341
342 static int end_frame(AVFilterLink *inlink)
343 {
344     return ff_end_frame(inlink->dst->outputs[0]);
345 }
346
347 static int null_draw_slice(AVFilterLink *inlink, int y, int h, int slice_dir)
348 {
349     return 0;
350 }
351
352 static int null_end_frame(AVFilterLink *inlink)
353 {
354     return 0;
355 }
356
357 static int poll_frame(AVFilterLink *link)
358 {
359     AVFilterContext   *s = link->src;
360     OverlayContext *over = s->priv;
361     int ret = ff_poll_frame(s->inputs[OVERLAY]);
362
363     if (ret == AVERROR_EOF)
364         ret = !!over->overpicref;
365
366     return ret && ff_poll_frame(s->inputs[MAIN]);
367 }
368
369 AVFilter avfilter_vf_overlay = {
370     .name      = "overlay",
371     .description = NULL_IF_CONFIG_SMALL("Overlay a video source on top of the input."),
372
373     .init      = init,
374     .uninit    = uninit,
375
376     .priv_size = sizeof(OverlayContext),
377
378     .query_formats = query_formats,
379
380     .inputs    = (const AVFilterPad[]) {{ .name            = "main",
381                                           .type            = AVMEDIA_TYPE_VIDEO,
382                                           .start_frame     = start_frame,
383                                           .get_video_buffer= get_video_buffer,
384                                           .config_props    = config_input_main,
385                                           .draw_slice      = draw_slice,
386                                           .end_frame       = end_frame,
387                                           .min_perms       = AV_PERM_READ,
388                                           .rej_perms       = AV_PERM_REUSE2|AV_PERM_PRESERVE, },
389                                         { .name            = "overlay",
390                                           .type            = AVMEDIA_TYPE_VIDEO,
391                                           .start_frame     = start_frame_overlay,
392                                           .config_props    = config_input_overlay,
393                                           .draw_slice      = null_draw_slice,
394                                           .end_frame       = null_end_frame,
395                                           .min_perms       = AV_PERM_READ,
396                                           .rej_perms       = AV_PERM_REUSE2, },
397                                         { .name = NULL}},
398     .outputs   = (const AVFilterPad[]) {{ .name            = "default",
399                                           .type            = AVMEDIA_TYPE_VIDEO,
400                                           .config_props    = config_output,
401                                           .poll_frame      = poll_frame },
402                                         { .name = NULL}},
403 };