lavfi: make avfilter_get_video_buffer() private on next bump.
[ffmpeg.git] / libavfilter / vf_pad.c
1 /*
2  * Copyright (c) 2008 vmrsss
3  * Copyright (c) 2009 Stefano Sabatini
4  *
5  * This file is part of Libav.
6  *
7  * Libav 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  * Libav 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 Libav; 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 padding filter
25  */
26
27 #include "avfilter.h"
28 #include "formats.h"
29 #include "video.h"
30 #include "libavutil/avstring.h"
31 #include "libavutil/eval.h"
32 #include "libavutil/pixdesc.h"
33 #include "libavutil/colorspace.h"
34 #include "libavutil/avassert.h"
35 #include "libavutil/imgutils.h"
36 #include "libavutil/parseutils.h"
37 #include "libavutil/mathematics.h"
38 #include "drawutils.h"
39
40 static const char *const var_names[] = {
41     "PI",
42     "PHI",
43     "E",
44     "in_w",   "iw",
45     "in_h",   "ih",
46     "out_w",  "ow",
47     "out_h",  "oh",
48     "x",
49     "y",
50     "a",
51     "hsub",
52     "vsub",
53     NULL
54 };
55
56 enum var_name {
57     VAR_PI,
58     VAR_PHI,
59     VAR_E,
60     VAR_IN_W,   VAR_IW,
61     VAR_IN_H,   VAR_IH,
62     VAR_OUT_W,  VAR_OW,
63     VAR_OUT_H,  VAR_OH,
64     VAR_X,
65     VAR_Y,
66     VAR_A,
67     VAR_HSUB,
68     VAR_VSUB,
69     VARS_NB
70 };
71
72 static int query_formats(AVFilterContext *ctx)
73 {
74     static const enum PixelFormat pix_fmts[] = {
75         PIX_FMT_ARGB,         PIX_FMT_RGBA,
76         PIX_FMT_ABGR,         PIX_FMT_BGRA,
77         PIX_FMT_RGB24,        PIX_FMT_BGR24,
78
79         PIX_FMT_YUV444P,      PIX_FMT_YUV422P,
80         PIX_FMT_YUV420P,      PIX_FMT_YUV411P,
81         PIX_FMT_YUV410P,      PIX_FMT_YUV440P,
82         PIX_FMT_YUVJ444P,     PIX_FMT_YUVJ422P,
83         PIX_FMT_YUVJ420P,     PIX_FMT_YUVJ440P,
84         PIX_FMT_YUVA420P,
85
86         PIX_FMT_NONE
87     };
88
89     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
90     return 0;
91 }
92
93 typedef struct {
94     int w, h;               ///< output dimensions, a value of 0 will result in the input size
95     int x, y;               ///< offsets of the input area with respect to the padded area
96     int in_w, in_h;         ///< width and height for the padded input video, which has to be aligned to the chroma values in order to avoid chroma issues
97
98     char w_expr[256];       ///< width  expression string
99     char h_expr[256];       ///< height expression string
100     char x_expr[256];       ///< width  expression string
101     char y_expr[256];       ///< height expression string
102
103     uint8_t color[4];       ///< color expressed either in YUVA or RGBA colorspace for the padding area
104     uint8_t *line[4];
105     int      line_step[4];
106     int hsub, vsub;         ///< chroma subsampling values
107     int needs_copy;
108 } PadContext;
109
110 static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)
111 {
112     PadContext *pad = ctx->priv;
113     char color_string[128] = "black";
114
115     av_strlcpy(pad->w_expr, "iw", sizeof(pad->w_expr));
116     av_strlcpy(pad->h_expr, "ih", sizeof(pad->h_expr));
117     av_strlcpy(pad->x_expr, "0" , sizeof(pad->w_expr));
118     av_strlcpy(pad->y_expr, "0" , sizeof(pad->h_expr));
119
120     if (args)
121         sscanf(args, "%255[^:]:%255[^:]:%255[^:]:%255[^:]:%255s",
122                pad->w_expr, pad->h_expr, pad->x_expr, pad->y_expr, color_string);
123
124     if (av_parse_color(pad->color, color_string, -1, ctx) < 0)
125         return AVERROR(EINVAL);
126
127     return 0;
128 }
129
130 static av_cold void uninit(AVFilterContext *ctx)
131 {
132     PadContext *pad = ctx->priv;
133     int i;
134
135     for (i = 0; i < 4; i++) {
136         av_freep(&pad->line[i]);
137         pad->line_step[i] = 0;
138     }
139 }
140
141 static int config_input(AVFilterLink *inlink)
142 {
143     AVFilterContext *ctx = inlink->dst;
144     PadContext *pad = ctx->priv;
145     const AVPixFmtDescriptor *pix_desc = &av_pix_fmt_descriptors[inlink->format];
146     uint8_t rgba_color[4];
147     int ret, is_packed_rgba;
148     double var_values[VARS_NB], res;
149     char *expr;
150
151     pad->hsub = pix_desc->log2_chroma_w;
152     pad->vsub = pix_desc->log2_chroma_h;
153
154     var_values[VAR_PI]    = M_PI;
155     var_values[VAR_PHI]   = M_PHI;
156     var_values[VAR_E]     = M_E;
157     var_values[VAR_IN_W]  = var_values[VAR_IW] = inlink->w;
158     var_values[VAR_IN_H]  = var_values[VAR_IH] = inlink->h;
159     var_values[VAR_OUT_W] = var_values[VAR_OW] = NAN;
160     var_values[VAR_OUT_H] = var_values[VAR_OH] = NAN;
161     var_values[VAR_A]     = (float) inlink->w / inlink->h;
162     var_values[VAR_HSUB]  = 1<<pad->hsub;
163     var_values[VAR_VSUB]  = 1<<pad->vsub;
164
165     /* evaluate width and height */
166     av_expr_parse_and_eval(&res, (expr = pad->w_expr),
167                            var_names, var_values,
168                            NULL, NULL, NULL, NULL, NULL, 0, ctx);
169     pad->w = var_values[VAR_OUT_W] = var_values[VAR_OW] = res;
170     if ((ret = av_expr_parse_and_eval(&res, (expr = pad->h_expr),
171                                       var_names, var_values,
172                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
173         goto eval_fail;
174     pad->h = var_values[VAR_OUT_H] = var_values[VAR_OH] = res;
175     /* evaluate the width again, as it may depend on the evaluated output height */
176     if ((ret = av_expr_parse_and_eval(&res, (expr = pad->w_expr),
177                                       var_names, var_values,
178                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
179         goto eval_fail;
180     pad->w = var_values[VAR_OUT_W] = var_values[VAR_OW] = res;
181
182     /* evaluate x and y */
183     av_expr_parse_and_eval(&res, (expr = pad->x_expr),
184                            var_names, var_values,
185                            NULL, NULL, NULL, NULL, NULL, 0, ctx);
186     pad->x = var_values[VAR_X] = res;
187     if ((ret = av_expr_parse_and_eval(&res, (expr = pad->y_expr),
188                                       var_names, var_values,
189                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
190         goto eval_fail;
191     pad->y = var_values[VAR_Y] = res;
192     /* evaluate x again, as it may depend on the evaluated y value */
193     if ((ret = av_expr_parse_and_eval(&res, (expr = pad->x_expr),
194                                       var_names, var_values,
195                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
196         goto eval_fail;
197     pad->x = var_values[VAR_X] = res;
198
199     /* sanity check params */
200     if (pad->w < 0 || pad->h < 0 || pad->x < 0 || pad->y < 0) {
201         av_log(ctx, AV_LOG_ERROR, "Negative values are not acceptable.\n");
202         return AVERROR(EINVAL);
203     }
204
205     if (!pad->w)
206         pad->w = inlink->w;
207     if (!pad->h)
208         pad->h = inlink->h;
209
210     pad->w &= ~((1 << pad->hsub) - 1);
211     pad->h &= ~((1 << pad->vsub) - 1);
212     pad->x &= ~((1 << pad->hsub) - 1);
213     pad->y &= ~((1 << pad->vsub) - 1);
214
215     pad->in_w = inlink->w & ~((1 << pad->hsub) - 1);
216     pad->in_h = inlink->h & ~((1 << pad->vsub) - 1);
217
218     memcpy(rgba_color, pad->color, sizeof(rgba_color));
219     ff_fill_line_with_color(pad->line, pad->line_step, pad->w, pad->color,
220                             inlink->format, rgba_color, &is_packed_rgba, NULL);
221
222     av_log(ctx, AV_LOG_INFO, "w:%d h:%d -> w:%d h:%d x:%d y:%d color:0x%02X%02X%02X%02X[%s]\n",
223            inlink->w, inlink->h, pad->w, pad->h, pad->x, pad->y,
224            pad->color[0], pad->color[1], pad->color[2], pad->color[3],
225            is_packed_rgba ? "rgba" : "yuva");
226
227     if (pad->x <  0 || pad->y <  0                      ||
228         pad->w <= 0 || pad->h <= 0                      ||
229         (unsigned)pad->x + (unsigned)inlink->w > pad->w ||
230         (unsigned)pad->y + (unsigned)inlink->h > pad->h) {
231         av_log(ctx, AV_LOG_ERROR,
232                "Input area %d:%d:%d:%d not within the padded area 0:0:%d:%d or zero-sized\n",
233                pad->x, pad->y, pad->x + inlink->w, pad->y + inlink->h, pad->w, pad->h);
234         return AVERROR(EINVAL);
235     }
236
237     return 0;
238
239 eval_fail:
240     av_log(NULL, AV_LOG_ERROR,
241            "Error when evaluating the expression '%s'\n", expr);
242     return ret;
243
244 }
245
246 static int config_output(AVFilterLink *outlink)
247 {
248     PadContext *pad = outlink->src->priv;
249
250     outlink->w = pad->w;
251     outlink->h = pad->h;
252     return 0;
253 }
254
255 static AVFilterBufferRef *get_video_buffer(AVFilterLink *inlink, int perms, int w, int h)
256 {
257     PadContext *pad = inlink->dst->priv;
258
259     AVFilterBufferRef *picref = ff_get_video_buffer(inlink->dst->outputs[0], perms,
260                                                     w + (pad->w - pad->in_w),
261                                                     h + (pad->h - pad->in_h));
262     int plane;
263
264     picref->video->w = w;
265     picref->video->h = h;
266
267     for (plane = 0; plane < 4 && picref->data[plane]; plane++) {
268         int hsub = (plane == 1 || plane == 2) ? pad->hsub : 0;
269         int vsub = (plane == 1 || plane == 2) ? pad->vsub : 0;
270
271         picref->data[plane] += (pad->x >> hsub) * pad->line_step[plane] +
272             (pad->y >> vsub) * picref->linesize[plane];
273     }
274
275     return picref;
276 }
277
278 static int does_clip(PadContext *pad, AVFilterBufferRef *outpicref, int plane, int hsub, int vsub, int x, int y)
279 {
280     int64_t x_in_buf, y_in_buf;
281
282     x_in_buf =  outpicref->data[plane] - outpicref->buf->data[plane]
283              +  (x >> hsub) * pad      ->line_step[plane]
284              +  (y >> vsub) * outpicref->linesize [plane];
285
286     if(x_in_buf < 0 || x_in_buf % pad->line_step[plane])
287         return 1;
288     x_in_buf /= pad->line_step[plane];
289
290     av_assert0(outpicref->buf->linesize[plane]>0); //while reference can use negative linesize the main buffer should not
291
292     y_in_buf = x_in_buf / outpicref->buf->linesize[plane];
293     x_in_buf %= outpicref->buf->linesize[plane];
294
295     if(   y_in_buf<<vsub >= outpicref->buf->h
296        || x_in_buf<<hsub >= outpicref->buf->w)
297         return 1;
298     return 0;
299 }
300
301 static void start_frame(AVFilterLink *inlink, AVFilterBufferRef *inpicref)
302 {
303     PadContext *pad = inlink->dst->priv;
304     AVFilterBufferRef *outpicref = avfilter_ref_buffer(inpicref, ~0);
305     int plane;
306
307     for (plane = 0; plane < 4 && outpicref->data[plane]; plane++) {
308         int hsub = (plane == 1 || plane == 2) ? pad->hsub : 0;
309         int vsub = (plane == 1 || plane == 2) ? pad->vsub : 0;
310
311         av_assert0(outpicref->buf->w>0 && outpicref->buf->h>0);
312
313         if(outpicref->format != outpicref->buf->format) //unsupported currently
314             break;
315
316         outpicref->data[plane] -=   (pad->x  >> hsub) * pad      ->line_step[plane]
317                                   + (pad->y  >> vsub) * outpicref->linesize [plane];
318
319         if(   does_clip(pad, outpicref, plane, hsub, vsub, 0, 0)
320            || does_clip(pad, outpicref, plane, hsub, vsub, 0, pad->h-1)
321            || does_clip(pad, outpicref, plane, hsub, vsub, pad->w-1, 0)
322            || does_clip(pad, outpicref, plane, hsub, vsub, pad->w-1, pad->h-1)
323           )
324             break;
325     }
326     pad->needs_copy= plane < 4 && outpicref->data[plane];
327     if(pad->needs_copy){
328         av_log(inlink->dst, AV_LOG_DEBUG, "Direct padding impossible allocating new frame\n");
329         avfilter_unref_buffer(outpicref);
330         outpicref = ff_get_video_buffer(inlink->dst->outputs[0], AV_PERM_WRITE | AV_PERM_NEG_LINESIZES,
331                                         FFMAX(inlink->w, pad->w),
332                                         FFMAX(inlink->h, pad->h));
333         avfilter_copy_buffer_ref_props(outpicref, inpicref);
334     }
335
336     inlink->dst->outputs[0]->out_buf = outpicref;
337
338     outpicref->video->w = pad->w;
339     outpicref->video->h = pad->h;
340
341     ff_start_frame(inlink->dst->outputs[0], outpicref);
342 }
343
344 static void end_frame(AVFilterLink *link)
345 {
346     ff_end_frame(link->dst->outputs[0]);
347     avfilter_unref_buffer(link->cur_buf);
348 }
349
350 static void draw_send_bar_slice(AVFilterLink *link, int y, int h, int slice_dir, int before_slice)
351 {
352     PadContext *pad = link->dst->priv;
353     int bar_y, bar_h = 0;
354
355     if        (slice_dir * before_slice ==  1 && y == pad->y) {
356         /* top bar */
357         bar_y = 0;
358         bar_h = pad->y;
359     } else if (slice_dir * before_slice == -1 && (y + h) == (pad->y + pad->in_h)) {
360         /* bottom bar */
361         bar_y = pad->y + pad->in_h;
362         bar_h = pad->h - pad->in_h - pad->y;
363     }
364
365     if (bar_h) {
366         ff_draw_rectangle(link->dst->outputs[0]->out_buf->data,
367                           link->dst->outputs[0]->out_buf->linesize,
368                           pad->line, pad->line_step, pad->hsub, pad->vsub,
369                           0, bar_y, pad->w, bar_h);
370         ff_draw_slice(link->dst->outputs[0], bar_y, bar_h, slice_dir);
371     }
372 }
373
374 static void draw_slice(AVFilterLink *link, int y, int h, int slice_dir)
375 {
376     PadContext *pad = link->dst->priv;
377     AVFilterBufferRef *outpic = link->dst->outputs[0]->out_buf;
378     AVFilterBufferRef *inpic = link->cur_buf;
379
380     y += pad->y;
381
382     y &= ~((1 << pad->vsub) - 1);
383     h &= ~((1 << pad->vsub) - 1);
384
385     if (!h)
386         return;
387     draw_send_bar_slice(link, y, h, slice_dir, 1);
388
389     /* left border */
390     ff_draw_rectangle(outpic->data, outpic->linesize, pad->line, pad->line_step,
391                       pad->hsub, pad->vsub, 0, y, pad->x, h);
392
393     if(pad->needs_copy){
394         ff_copy_rectangle(outpic->data, outpic->linesize,
395                           inpic->data, inpic->linesize, pad->line_step,
396                           pad->hsub, pad->vsub,
397                           pad->x, y, y-pad->y, inpic->video->w, h);
398     }
399
400     /* right border */
401     ff_draw_rectangle(outpic->data, outpic->linesize,
402                       pad->line, pad->line_step, pad->hsub, pad->vsub,
403                       pad->x + pad->in_w, y, pad->w - pad->x - pad->in_w, h);
404     ff_draw_slice(link->dst->outputs[0], y, h, slice_dir);
405
406     draw_send_bar_slice(link, y, h, slice_dir, -1);
407 }
408
409 AVFilter avfilter_vf_pad = {
410     .name          = "pad",
411     .description   = NULL_IF_CONFIG_SMALL("Pad input image to width:height[:x:y[:color]] (default x and y: 0, default color: black)."),
412
413     .priv_size     = sizeof(PadContext),
414     .init          = init,
415     .uninit        = uninit,
416     .query_formats = query_formats,
417
418     .inputs    = (AVFilterPad[]) {{ .name             = "default",
419                                     .type             = AVMEDIA_TYPE_VIDEO,
420                                     .config_props     = config_input,
421                                     .get_video_buffer = get_video_buffer,
422                                     .start_frame      = start_frame,
423                                     .draw_slice       = draw_slice,
424                                     .end_frame        = end_frame, },
425                                   { .name = NULL}},
426
427     .outputs   = (AVFilterPad[]) {{ .name             = "default",
428                                     .type             = AVMEDIA_TYPE_VIDEO,
429                                     .config_props     = config_output, },
430                                   { .name = NULL}},
431 };