drawtext: add 'fix_bounds' option on coords fixing
[libav.git] / libavfilter / vf_drawtext.c
CommitLineData
a5b64584
SS
1/*
2 * Copyright (c) 2011 Stefano Sabatini
3 * Copyright (c) 2010 S.N. Hemanth Meenakshisundaram
4 * Copyright (c) 2003 Gustavo Sverzut Barbieri <gsbarbieri@yahoo.com.br>
5 *
5ac4952a 6 * This file is part of Libav.
a5b64584 7 *
5ac4952a 8 * Libav is free software; you can redistribute it and/or
a5b64584
SS
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 *
5ac4952a 13 * Libav is distributed in the hope that it will be useful,
a5b64584
SS
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
5ac4952a 19 * License along with Libav; if not, write to the Free Software
a5b64584
SS
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 */
22
23/**
24 * @file
124e2884 25 * drawtext filter, based on the original vhook/drawtext.c
a5b64584
SS
26 * filter by Gustavo Sverzut Barbieri
27 */
28
29#include <sys/time.h>
30#include <time.h>
31
32#include "libavutil/colorspace.h"
33#include "libavutil/file.h"
2cf74eca 34#include "libavutil/eval.h"
a5b64584 35#include "libavutil/opt.h"
2cf74eca 36#include "libavutil/mathematics.h"
f5edfc9e 37#include "libavutil/random_seed.h"
a5b64584
SS
38#include "libavutil/parseutils.h"
39#include "libavutil/pixdesc.h"
40#include "libavutil/tree.h"
f5edfc9e 41#include "libavutil/lfg.h"
a5b64584
SS
42#include "avfilter.h"
43#include "drawutils.h"
44
45#undef time
46
47#include <ft2build.h>
48#include <freetype/config/ftheader.h>
49#include FT_FREETYPE_H
50#include FT_GLYPH_H
51
2cf74eca
LB
52static const char *var_names[] = {
53 "E",
54 "PHI",
55 "PI",
56 "main_w", "W", ///< width of the main video
57 "main_h", "H", ///< height of the main video
58 "text_w", "w", ///< width of the overlay text
59 "text_h", "h", ///< height of the overlay text
60 "x",
61 "y",
62 "n", ///< number of processed frames
63 "t", ///< timestamp expressed in seconds
64 NULL
65};
66
f5edfc9e
LB
67static const char *fun2_names[] = {
68 "rand",
69};
70
71static double drand(void *opaque, double min, double max)
72{
78212cef 73 return min + (max-min) / UINT_MAX * av_lfg_get(opaque);
f5edfc9e
LB
74}
75
76typedef double (*eval_func2)(void *, double a, double b);
77
78static const eval_func2 fun2[] = {
79 drand,
80 NULL
81};
82
2cf74eca
LB
83enum var_name {
84 VAR_E,
85 VAR_PHI,
86 VAR_PI,
87 VAR_MAIN_W, VAR_MW,
88 VAR_MAIN_H, VAR_MH,
89 VAR_TEXT_W, VAR_TW,
90 VAR_TEXT_H, VAR_TH,
91 VAR_X,
92 VAR_Y,
93 VAR_N,
94 VAR_T,
95 VAR_VARS_NB
96};
97
a5b64584
SS
98typedef struct {
99 const AVClass *class;
100 uint8_t *fontfile; ///< font to be used
101 uint8_t *text; ///< text to be drawn
3fd53def
SS
102 uint8_t *expanded_text; ///< used to contain the strftime()-expanded text
103 size_t expanded_text_size; ///< size in bytes of the expanded_text buffer
a5b64584
SS
104 int ft_load_flags; ///< flags used for loading fonts, see FT_LOAD_*
105 FT_Vector *positions; ///< positions for each element in the text
3fd53def 106 size_t nb_positions; ///< number of elements of positions array
a5b64584 107 char *textfile; ///< file with text to be drawn
a2fb4bcb
LB
108 int x, y; ///< position to start drawing text
109 int w, h; ///< dimension of the text block
c5420f10 110 int shadowx, shadowy;
a5b64584
SS
111 unsigned int fontsize; ///< font size to use
112 char *fontcolor_string; ///< font color as string
113 char *boxcolor_string; ///< box color as string
c5420f10 114 char *shadowcolor_string; ///< shadow color as string
a5b64584
SS
115 uint8_t fontcolor[4]; ///< foreground color
116 uint8_t boxcolor[4]; ///< background color
c5420f10 117 uint8_t shadowcolor[4]; ///< shadow color
a5b64584
SS
118 uint8_t fontcolor_rgba[4]; ///< foreground color in RGBA
119 uint8_t boxcolor_rgba[4]; ///< background color in RGBA
c5420f10 120 uint8_t shadowcolor_rgba[4]; ///< shadow color in RGBA
a5b64584
SS
121
122 short int draw_box; ///< draw box around text - true or false
123 int use_kerning; ///< font kerning is used - true/false
124 int tabsize; ///< tab size
e496c45d 125 int fix_bounds; ///< do we let it go out of frame bounds - t/f
a5b64584
SS
126
127 FT_Library library; ///< freetype font library handle
128 FT_Face face; ///< freetype font face handle
129 struct AVTreeNode *glyphs; ///< rendered glyphs, stored using the UTF-32 char code
130 int hsub, vsub; ///< chroma subsampling values
131 int is_packed_rgb;
132 int pixel_step[4]; ///< distance in bytes between the component of each pixel
133 uint8_t rgba_map[4]; ///< map RGBA offsets to the positions in the packed RGBA format
134 uint8_t *box_line[4]; ///< line used for filling the box background
2cf74eca
LB
135 char *x_expr, *y_expr;
136 AVExpr *x_pexpr, *y_pexpr; ///< parsed expressions for x and y
137 double var_values[VAR_VARS_NB];
73585620
LB
138 char *d_expr;
139 AVExpr *d_pexpr;
2cf74eca 140 int draw; ///< set to zero to prevent drawing
f5edfc9e 141 AVLFG prng; ///< random
a5b64584
SS
142} DrawTextContext;
143
144#define OFFSET(x) offsetof(DrawTextContext, x)
145
146static const AVOption drawtext_options[]= {
145f741e
AK
147{"fontfile", "set font file", OFFSET(fontfile), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX },
148{"text", "set text", OFFSET(text), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX },
149{"textfile", "set text file", OFFSET(textfile), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX },
150{"fontcolor","set foreground color", OFFSET(fontcolor_string), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX },
151{"boxcolor", "set box color", OFFSET(boxcolor_string), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX },
152{"shadowcolor", "set shadow color", OFFSET(shadowcolor_string), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX },
153{"box", "set box", OFFSET(draw_box), AV_OPT_TYPE_INT, {.dbl=0}, 0, 1 },
154{"fontsize", "set font size", OFFSET(fontsize), AV_OPT_TYPE_INT, {.dbl=16}, 1, 72 },
2cf74eca
LB
155{"x", "set x", OFFSET(x_expr), AV_OPT_TYPE_STRING, {.str="0"}, CHAR_MIN, CHAR_MAX },
156{"y", "set y", OFFSET(y_expr), AV_OPT_TYPE_STRING, {.str="0"}, CHAR_MIN, CHAR_MAX },
145f741e
AK
157{"shadowx", "set x", OFFSET(shadowx), AV_OPT_TYPE_INT, {.dbl=0}, INT_MIN, INT_MAX },
158{"shadowy", "set y", OFFSET(shadowy), AV_OPT_TYPE_INT, {.dbl=0}, INT_MIN, INT_MAX },
159{"tabsize", "set tab size", OFFSET(tabsize), AV_OPT_TYPE_INT, {.dbl=4}, 0, INT_MAX },
73585620 160{"draw", "if false do not draw", OFFSET(d_expr), AV_OPT_TYPE_STRING, {.str="1"}, CHAR_MIN, CHAR_MAX },
e496c45d
AU
161{"fix_bounds", "if true, check and fix text coords to avoid clipping",
162 OFFSET(fix_bounds), AV_OPT_TYPE_INT, {.dbl=1}, 0, 1 },
a5b64584
SS
163
164/* FT_LOAD_* flags */
145f741e
AK
165{"ft_load_flags", "set font loading flags for libfreetype", OFFSET(ft_load_flags), AV_OPT_TYPE_FLAGS, {.dbl=FT_LOAD_DEFAULT|FT_LOAD_RENDER}, 0, INT_MAX, 0, "ft_load_flags" },
166{"default", "set default", 0, AV_OPT_TYPE_CONST, {FT_LOAD_DEFAULT}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
167{"no_scale", "set no_scale", 0, AV_OPT_TYPE_CONST, {FT_LOAD_NO_SCALE}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
168{"no_hinting", "set no_hinting", 0, AV_OPT_TYPE_CONST, {FT_LOAD_NO_HINTING}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
169{"render", "set render", 0, AV_OPT_TYPE_CONST, {FT_LOAD_RENDER}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
170{"no_bitmap", "set no_bitmap", 0, AV_OPT_TYPE_CONST, {FT_LOAD_NO_BITMAP}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
171{"vertical_layout", "set vertical_layout", 0, AV_OPT_TYPE_CONST, {FT_LOAD_VERTICAL_LAYOUT}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
172{"force_autohint", "set force_autohint", 0, AV_OPT_TYPE_CONST, {FT_LOAD_FORCE_AUTOHINT}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
173{"crop_bitmap", "set crop_bitmap", 0, AV_OPT_TYPE_CONST, {FT_LOAD_CROP_BITMAP}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
174{"pedantic", "set pedantic", 0, AV_OPT_TYPE_CONST, {FT_LOAD_PEDANTIC}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
175{"ignore_global_advance_width", "set ignore_global_advance_width", 0, AV_OPT_TYPE_CONST, {FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
176{"no_recurse", "set no_recurse", 0, AV_OPT_TYPE_CONST, {FT_LOAD_NO_RECURSE}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
177{"ignore_transform", "set ignore_transform", 0, AV_OPT_TYPE_CONST, {FT_LOAD_IGNORE_TRANSFORM}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
178{"monochrome", "set monochrome", 0, AV_OPT_TYPE_CONST, {FT_LOAD_MONOCHROME}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
179{"linear_design", "set linear_design", 0, AV_OPT_TYPE_CONST, {FT_LOAD_LINEAR_DESIGN}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
180{"no_autohint", "set no_autohint", 0, AV_OPT_TYPE_CONST, {FT_LOAD_NO_AUTOHINT}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
a5b64584
SS
181{NULL},
182};
183
184static const char *drawtext_get_name(void *ctx)
185{
186 return "drawtext";
187}
188
189static const AVClass drawtext_class = {
190 "DrawTextContext",
191 drawtext_get_name,
192 drawtext_options
193};
194
195#undef __FTERRORS_H__
196#define FT_ERROR_START_LIST {
197#define FT_ERRORDEF(e, v, s) { (e), (s) },
198#define FT_ERROR_END_LIST { 0, NULL } };
199
200struct ft_error
201{
202 int err;
203 const char *err_msg;
204} static ft_errors[] =
205#include FT_ERRORS_H
206
207#define FT_ERRMSG(e) ft_errors[e].err_msg
208
209typedef struct {
210 FT_Glyph *glyph;
211 uint32_t code;
212 FT_Bitmap bitmap; ///< array holding bitmaps of font
213 FT_BBox bbox;
214 int advance;
215 int bitmap_left;
216 int bitmap_top;
217} Glyph;
218
219static int glyph_cmp(void *key, const void *b)
220{
221 const Glyph *a = key, *bb = b;
222 int64_t diff = (int64_t)a->code - (int64_t)bb->code;
223 return diff > 0 ? 1 : diff < 0 ? -1 : 0;
224}
225
226/**
227 * Load glyphs corresponding to the UTF-32 codepoint code.
228 */
229static int load_glyph(AVFilterContext *ctx, Glyph **glyph_ptr, uint32_t code)
230{
231 DrawTextContext *dtext = ctx->priv;
232 Glyph *glyph;
233 struct AVTreeNode *node = NULL;
234 int ret;
235
236 /* load glyph into dtext->face->glyph */
237 if (FT_Load_Char(dtext->face, code, dtext->ft_load_flags))
238 return AVERROR(EINVAL);
239
240 /* save glyph */
241 if (!(glyph = av_mallocz(sizeof(*glyph))) ||
242 !(glyph->glyph = av_mallocz(sizeof(*glyph->glyph)))) {
243 ret = AVERROR(ENOMEM);
244 goto error;
245 }
246 glyph->code = code;
247
248 if (FT_Get_Glyph(dtext->face->glyph, glyph->glyph)) {
249 ret = AVERROR(EINVAL);
250 goto error;
251 }
252
253 glyph->bitmap = dtext->face->glyph->bitmap;
254 glyph->bitmap_left = dtext->face->glyph->bitmap_left;
255 glyph->bitmap_top = dtext->face->glyph->bitmap_top;
256 glyph->advance = dtext->face->glyph->advance.x >> 6;
257
258 /* measure text height to calculate text_height (or the maximum text height) */
259 FT_Glyph_Get_CBox(*glyph->glyph, ft_glyph_bbox_pixels, &glyph->bbox);
260
261 /* cache the newly created glyph */
262 if (!(node = av_mallocz(av_tree_node_size))) {
263 ret = AVERROR(ENOMEM);
264 goto error;
265 }
266 av_tree_insert(&dtext->glyphs, glyph, glyph_cmp, &node);
267
268 if (glyph_ptr)
269 *glyph_ptr = glyph;
270 return 0;
271
272error:
273 if (glyph)
274 av_freep(&glyph->glyph);
275 av_freep(&glyph);
276 av_freep(&node);
277 return ret;
278}
279
280static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)
281{
282 int err;
283 DrawTextContext *dtext = ctx->priv;
284 Glyph *glyph;
285
286 dtext->class = &drawtext_class;
79eff913 287 av_opt_set_defaults(dtext);
a5b64584
SS
288 dtext->fontcolor_string = av_strdup("black");
289 dtext->boxcolor_string = av_strdup("white");
c5420f10 290 dtext->shadowcolor_string = av_strdup("black");
a5b64584
SS
291
292 if ((err = (av_set_options_string(dtext, args, "=", ":"))) < 0) {
293 av_log(ctx, AV_LOG_ERROR, "Error parsing options string: '%s'\n", args);
294 return err;
295 }
296
297 if (!dtext->fontfile) {
298 av_log(ctx, AV_LOG_ERROR, "No font filename provided\n");
299 return AVERROR(EINVAL);
300 }
301
302 if (dtext->textfile) {
303 uint8_t *textbuf;
304 size_t textbuf_size;
305
306 if (dtext->text) {
307 av_log(ctx, AV_LOG_ERROR,
308 "Both text and text file provided. Please provide only one\n");
309 return AVERROR(EINVAL);
310 }
311 if ((err = av_file_map(dtext->textfile, &textbuf, &textbuf_size, 0, ctx)) < 0) {
312 av_log(ctx, AV_LOG_ERROR,
313 "The text file '%s' could not be read or is empty\n",
314 dtext->textfile);
315 return err;
316 }
317
318 if (!(dtext->text = av_malloc(textbuf_size+1)))
319 return AVERROR(ENOMEM);
320 memcpy(dtext->text, textbuf, textbuf_size);
321 dtext->text[textbuf_size] = 0;
322 av_file_unmap(textbuf, textbuf_size);
323 }
324
325 if (!dtext->text) {
326 av_log(ctx, AV_LOG_ERROR,
327 "Either text or a valid file must be provided\n");
328 return AVERROR(EINVAL);
329 }
330
331 if ((err = av_parse_color(dtext->fontcolor_rgba, dtext->fontcolor_string, -1, ctx))) {
332 av_log(ctx, AV_LOG_ERROR,
333 "Invalid font color '%s'\n", dtext->fontcolor_string);
334 return err;
335 }
336
337 if ((err = av_parse_color(dtext->boxcolor_rgba, dtext->boxcolor_string, -1, ctx))) {
338 av_log(ctx, AV_LOG_ERROR,
339 "Invalid box color '%s'\n", dtext->boxcolor_string);
340 return err;
341 }
342
c5420f10
MN
343 if ((err = av_parse_color(dtext->shadowcolor_rgba, dtext->shadowcolor_string, -1, ctx))) {
344 av_log(ctx, AV_LOG_ERROR,
345 "Invalid shadow color '%s'\n", dtext->shadowcolor_string);
346 return err;
347 }
348
a5b64584
SS
349 if ((err = FT_Init_FreeType(&(dtext->library)))) {
350 av_log(ctx, AV_LOG_ERROR,
351 "Could not load FreeType: %s\n", FT_ERRMSG(err));
352 return AVERROR(EINVAL);
353 }
354
355 /* load the face, and set up the encoding, which is by default UTF-8 */
356 if ((err = FT_New_Face(dtext->library, dtext->fontfile, 0, &dtext->face))) {
357 av_log(ctx, AV_LOG_ERROR, "Could not load fontface from file '%s': %s\n",
358 dtext->fontfile, FT_ERRMSG(err));
359 return AVERROR(EINVAL);
360 }
361 if ((err = FT_Set_Pixel_Sizes(dtext->face, 0, dtext->fontsize))) {
362 av_log(ctx, AV_LOG_ERROR, "Could not set font size to %d pixels: %s\n",
363 dtext->fontsize, FT_ERRMSG(err));
364 return AVERROR(EINVAL);
365 }
366
367 dtext->use_kerning = FT_HAS_KERNING(dtext->face);
368
369 /* load the fallback glyph with code 0 */
370 load_glyph(ctx, NULL, 0);
371
372 /* set the tabsize in pixels */
373 if ((err = load_glyph(ctx, &glyph, ' ') < 0)) {
374 av_log(ctx, AV_LOG_ERROR, "Could not set tabsize.\n");
375 return err;
376 }
377 dtext->tabsize *= glyph->advance;
378
379#if !HAVE_LOCALTIME_R
380 av_log(ctx, AV_LOG_WARNING, "strftime() expansion unavailable!\n");
381#endif
382
383 return 0;
384}
385
386static int query_formats(AVFilterContext *ctx)
387{
388 static const enum PixelFormat pix_fmts[] = {
389 PIX_FMT_ARGB, PIX_FMT_RGBA,
390 PIX_FMT_ABGR, PIX_FMT_BGRA,
391 PIX_FMT_RGB24, PIX_FMT_BGR24,
392 PIX_FMT_YUV420P, PIX_FMT_YUV444P,
393 PIX_FMT_YUV422P, PIX_FMT_YUV411P,
394 PIX_FMT_YUV410P, PIX_FMT_YUV440P,
395 PIX_FMT_NONE
396 };
397
398 avfilter_set_common_formats(ctx, avfilter_make_format_list(pix_fmts));
399 return 0;
400}
401
402static int glyph_enu_free(void *opaque, void *elem)
403{
404 av_free(elem);
405 return 0;
406}
407
408static av_cold void uninit(AVFilterContext *ctx)
409{
410 DrawTextContext *dtext = ctx->priv;
411 int i;
412
413 av_freep(&dtext->fontfile);
414 av_freep(&dtext->text);
3fd53def 415 av_freep(&dtext->expanded_text);
a5b64584
SS
416 av_freep(&dtext->fontcolor_string);
417 av_freep(&dtext->boxcolor_string);
418 av_freep(&dtext->positions);
c5420f10 419 av_freep(&dtext->shadowcolor_string);
a5b64584
SS
420 av_tree_enumerate(dtext->glyphs, NULL, NULL, glyph_enu_free);
421 av_tree_destroy(dtext->glyphs);
422 dtext->glyphs = 0;
423 FT_Done_Face(dtext->face);
424 FT_Done_FreeType(dtext->library);
425
426 for (i = 0; i < 4; i++) {
427 av_freep(&dtext->box_line[i]);
428 dtext->pixel_step[i] = 0;
429 }
430
431}
432
ec11ff84
LB
433static inline int is_newline(uint32_t c)
434{
d4b63054 435 return c == '\n' || c == '\r' || c == '\f' || c == '\v';
ec11ff84
LB
436}
437
2cf74eca 438static int dtext_prepare_text(AVFilterContext *ctx)
ec11ff84
LB
439{
440 DrawTextContext *dtext = ctx->priv;
441 uint32_t code = 0, prev_code = 0;
442 int x = 0, y = 0, i = 0, ret;
443 int text_height, baseline;
444 char *text = dtext->text;
445 uint8_t *p;
446 int str_w = 0, len;
447 int y_min = 32000, y_max = -32000;
448 FT_Vector delta;
449 Glyph *glyph = NULL, *prev_glyph = NULL;
450 Glyph dummy = { 0 };
2cf74eca
LB
451 int width = ctx->inputs[0]->w;
452 int height = ctx->inputs[0]->h;
ec11ff84
LB
453
454#if HAVE_LOCALTIME_R
455 time_t now = time(0);
456 struct tm ltime;
457 uint8_t *buf = dtext->expanded_text;
458 int buf_size = dtext->expanded_text_size;
459
460 if (!buf)
461 buf_size = 2*strlen(dtext->text)+1;
462
463 localtime_r(&now, &ltime);
464
465 while ((buf = av_realloc(buf, buf_size))) {
466 *buf = 1;
467 if (strftime(buf, buf_size, dtext->text, &ltime) != 0 || *buf == 0)
468 break;
469 buf_size *= 2;
470 }
471
472 if (!buf)
473 return AVERROR(ENOMEM);
474 text = dtext->expanded_text = buf;
475 dtext->expanded_text_size = buf_size;
476#endif
477
478 if ((len = strlen(text)) > dtext->nb_positions) {
479 FT_Vector *p = av_realloc(dtext->positions,
480 len * sizeof(*dtext->positions));
481 if (!p) {
482 av_freep(dtext->positions);
483 dtext->nb_positions = 0;
484 return AVERROR(ENOMEM);
485 } else {
486 dtext->positions = p;
487 dtext->nb_positions = len;
488 }
489 }
490
491 /* load and cache glyphs */
492 for (i = 0, p = text; *p; i++) {
493 GET_UTF8(code, *p++, continue;);
494
495 /* get glyph */
496 dummy.code = code;
497 glyph = av_tree_find(dtext->glyphs, &dummy, glyph_cmp, NULL);
e7f0bc8c 498 if (!glyph) {
ec11ff84 499 ret = load_glyph(ctx, &glyph, code);
e7f0bc8c
AU
500 if (ret)
501 return ret;
502 }
ec11ff84
LB
503
504 y_min = FFMIN(glyph->bbox.yMin, y_min);
505 y_max = FFMAX(glyph->bbox.yMax, y_max);
506 }
507 text_height = y_max - y_min;
508 baseline = y_max;
509
510 /* compute and save position for each glyph */
511 glyph = NULL;
512 for (i = 0, p = text; *p; i++) {
513 GET_UTF8(code, *p++, continue;);
514
515 /* skip the \n in the sequence \r\n */
516 if (prev_code == '\r' && code == '\n')
517 continue;
518
519 prev_code = code;
520 if (is_newline(code)) {
521 str_w = FFMAX(str_w, x - dtext->x);
522 y += text_height;
523 x = 0;
524 continue;
525 }
526
527 /* get glyph */
528 prev_glyph = glyph;
529 dummy.code = code;
530 glyph = av_tree_find(dtext->glyphs, &dummy, glyph_cmp, NULL);
531
532 /* kerning */
533 if (dtext->use_kerning && prev_glyph && glyph->code) {
534 FT_Get_Kerning(dtext->face, prev_glyph->code, glyph->code,
535 ft_kerning_default, &delta);
536 x += delta.x >> 6;
537 }
538
539 if (x + glyph->bbox.xMax >= width) {
540 str_w = FFMAX(str_w, x);
541 y += text_height;
542 x = 0;
543 }
544
545 /* save position */
546 dtext->positions[i].x = x + glyph->bitmap_left;
547 dtext->positions[i].y = y - glyph->bitmap_top + baseline;
548 if (code == '\t') x = (x / dtext->tabsize + 1)*dtext->tabsize;
549 else x += glyph->advance;
550 }
551
552 str_w = FFMIN(width - 1, FFMAX(str_w, x));
553 y = FFMIN(y + text_height, height - 1);
554
555 dtext->w = str_w;
2b43dfce 556 dtext->var_values[VAR_TEXT_W] = dtext->var_values[VAR_TW] = dtext->w;
ec11ff84 557 dtext->h = y;
2b43dfce 558 dtext->var_values[VAR_TEXT_H] = dtext->var_values[VAR_TH] = dtext->h;
ec11ff84
LB
559
560 return 0;
561}
562
563
a5b64584
SS
564static int config_input(AVFilterLink *inlink)
565{
ec11ff84
LB
566 AVFilterContext *ctx = inlink->dst;
567 DrawTextContext *dtext = ctx->priv;
a5b64584
SS
568 const AVPixFmtDescriptor *pix_desc = &av_pix_fmt_descriptors[inlink->format];
569 int ret;
570
571 dtext->hsub = pix_desc->log2_chroma_w;
572 dtext->vsub = pix_desc->log2_chroma_h;
573
2cf74eca
LB
574 dtext->var_values[VAR_E ] = M_E;
575 dtext->var_values[VAR_PHI] = M_PHI;
576 dtext->var_values[VAR_PI ] = M_PI;
577
578 dtext->var_values[VAR_MAIN_W] =
579 dtext->var_values[VAR_MW] = ctx->inputs[0]->w;
580 dtext->var_values[VAR_MAIN_H] =
581 dtext->var_values[VAR_MH] = ctx->inputs[0]->h;
582
583 dtext->var_values[VAR_X] = 0;
584 dtext->var_values[VAR_Y] = 0;
585 dtext->var_values[VAR_N] = 0;
586 dtext->var_values[VAR_T] = NAN;
587
f5edfc9e 588 av_lfg_init(&dtext->prng, av_get_random_seed());
2cf74eca
LB
589
590 if ((ret = av_expr_parse(&dtext->x_pexpr, dtext->x_expr, var_names,
f5edfc9e 591 NULL, NULL, fun2_names, fun2, 0, ctx)) < 0 ||
2cf74eca 592 (ret = av_expr_parse(&dtext->y_pexpr, dtext->y_expr, var_names,
f5edfc9e 593 NULL, NULL, fun2_names, fun2, 0, ctx)) < 0 ||
73585620 594 (ret = av_expr_parse(&dtext->d_pexpr, dtext->d_expr, var_names,
f5edfc9e 595 NULL, NULL, fun2_names, fun2, 0, ctx)) < 0)
2cf74eca
LB
596 return AVERROR(EINVAL);
597
a5b64584
SS
598 if ((ret =
599 ff_fill_line_with_color(dtext->box_line, dtext->pixel_step,
600 inlink->w, dtext->boxcolor,
601 inlink->format, dtext->boxcolor_rgba,
602 &dtext->is_packed_rgb, dtext->rgba_map)) < 0)
603 return ret;
604
605 if (!dtext->is_packed_rgb) {
606 uint8_t *rgba = dtext->fontcolor_rgba;
607 dtext->fontcolor[0] = RGB_TO_Y_CCIR(rgba[0], rgba[1], rgba[2]);
608 dtext->fontcolor[1] = RGB_TO_U_CCIR(rgba[0], rgba[1], rgba[2], 0);
609 dtext->fontcolor[2] = RGB_TO_V_CCIR(rgba[0], rgba[1], rgba[2], 0);
610 dtext->fontcolor[3] = rgba[3];
c5420f10
MN
611 rgba = dtext->shadowcolor_rgba;
612 dtext->shadowcolor[0] = RGB_TO_Y_CCIR(rgba[0], rgba[1], rgba[2]);
613 dtext->shadowcolor[1] = RGB_TO_U_CCIR(rgba[0], rgba[1], rgba[2], 0);
614 dtext->shadowcolor[2] = RGB_TO_V_CCIR(rgba[0], rgba[1], rgba[2], 0);
615 dtext->shadowcolor[3] = rgba[3];
a5b64584
SS
616 }
617
2cf74eca
LB
618 dtext->draw = 1;
619
620 return dtext_prepare_text(ctx);
a5b64584
SS
621}
622
623#define GET_BITMAP_VAL(r, c) \
624 bitmap->pixel_mode == FT_PIXEL_MODE_MONO ? \
625 (bitmap->buffer[(r) * bitmap->pitch + ((c)>>3)] & (0x80 >> ((c)&7))) * 255 : \
626 bitmap->buffer[(r) * bitmap->pitch + (c)]
627
628#define SET_PIXEL_YUV(picref, yuva_color, val, x, y, hsub, vsub) { \
629 luma_pos = ((x) ) + ((y) ) * picref->linesize[0]; \
3953a880
MN
630 alpha = yuva_color[3] * (val) * 129; \
631 picref->data[0][luma_pos] = (alpha * yuva_color[0] + (255*255*129 - alpha) * picref->data[0][luma_pos] ) >> 23; \
a5b81c31
MN
632 if (((x) & ((1<<(hsub)) - 1)) == 0 && ((y) & ((1<<(vsub)) - 1)) == 0) {\
633 chroma_pos1 = ((x) >> (hsub)) + ((y) >> (vsub)) * picref->linesize[1]; \
634 chroma_pos2 = ((x) >> (hsub)) + ((y) >> (vsub)) * picref->linesize[2]; \
635 picref->data[1][chroma_pos1] = (alpha * yuva_color[1] + (255*255*129 - alpha) * picref->data[1][chroma_pos1]) >> 23; \
636 picref->data[2][chroma_pos2] = (alpha * yuva_color[2] + (255*255*129 - alpha) * picref->data[2][chroma_pos2]) >> 23; \
637 }\
a5b64584
SS
638}
639
640static inline int draw_glyph_yuv(AVFilterBufferRef *picref, FT_Bitmap *bitmap, unsigned int x,
641 unsigned int y, unsigned int width, unsigned int height,
642 const uint8_t yuva_color[4], int hsub, int vsub)
643{
644 int r, c, alpha;
645 unsigned int luma_pos, chroma_pos1, chroma_pos2;
965fdda0 646 uint8_t src_val;
a5b64584
SS
647
648 for (r = 0; r < bitmap->rows && r+y < height; r++) {
649 for (c = 0; c < bitmap->width && c+x < width; c++) {
a5b64584
SS
650 /* get intensity value in the glyph bitmap (source) */
651 src_val = GET_BITMAP_VAL(r, c);
652 if (!src_val)
653 continue;
654
655 SET_PIXEL_YUV(picref, yuva_color, src_val, c+x, y+r, hsub, vsub);
656 }
657 }
658
659 return 0;
660}
661
662#define SET_PIXEL_RGB(picref, rgba_color, val, x, y, pixel_step, r_off, g_off, b_off, a_off) { \
663 p = picref->data[0] + (x) * pixel_step + ((y) * picref->linesize[0]); \
3953a880
MN
664 alpha = rgba_color[3] * (val) * 129; \
665 *(p+r_off) = (alpha * rgba_color[0] + (255*255*129 - alpha) * *(p+r_off)) >> 23; \
666 *(p+g_off) = (alpha * rgba_color[1] + (255*255*129 - alpha) * *(p+g_off)) >> 23; \
667 *(p+b_off) = (alpha * rgba_color[2] + (255*255*129 - alpha) * *(p+b_off)) >> 23; \
a5b64584
SS
668}
669
670static inline int draw_glyph_rgb(AVFilterBufferRef *picref, FT_Bitmap *bitmap,
671 unsigned int x, unsigned int y,
672 unsigned int width, unsigned int height, int pixel_step,
673 const uint8_t rgba_color[4], const uint8_t rgba_map[4])
674{
675 int r, c, alpha;
676 uint8_t *p;
965fdda0 677 uint8_t src_val;
a5b64584
SS
678
679 for (r = 0; r < bitmap->rows && r+y < height; r++) {
680 for (c = 0; c < bitmap->width && c+x < width; c++) {
a5b64584
SS
681 /* get intensity value in the glyph bitmap (source) */
682 src_val = GET_BITMAP_VAL(r, c);
683 if (!src_val)
684 continue;
685
686 SET_PIXEL_RGB(picref, rgba_color, src_val, c+x, y+r, pixel_step,
687 rgba_map[0], rgba_map[1], rgba_map[2], rgba_map[3]);
688 }
689 }
690
691 return 0;
692}
693
694static inline void drawbox(AVFilterBufferRef *picref, unsigned int x, unsigned int y,
695 unsigned int width, unsigned int height,
696 uint8_t *line[4], int pixel_step[4], uint8_t color[4],
697 int hsub, int vsub, int is_rgba_packed, uint8_t rgba_map[4])
698{
699 int i, j, alpha;
700
701 if (color[3] != 0xFF) {
702 if (is_rgba_packed) {
703 uint8_t *p;
704 for (j = 0; j < height; j++)
705 for (i = 0; i < width; i++)
706 SET_PIXEL_RGB(picref, color, 255, i+x, y+j, pixel_step[0],
707 rgba_map[0], rgba_map[1], rgba_map[2], rgba_map[3]);
708 } else {
709 unsigned int luma_pos, chroma_pos1, chroma_pos2;
710 for (j = 0; j < height; j++)
711 for (i = 0; i < width; i++)
712 SET_PIXEL_YUV(picref, color, 255, i+x, y+j, hsub, vsub);
713 }
714 } else {
715 ff_draw_rectangle(picref->data, picref->linesize,
716 line, pixel_step, hsub, vsub,
717 x, y, width, height);
718 }
719}
720
e73127a4 721static int draw_glyphs(DrawTextContext *dtext, AVFilterBufferRef *picref,
c5420f10 722 int width, int height, const uint8_t rgbcolor[4], const uint8_t yuvcolor[4], int x, int y)
e73127a4 723{
3fd53def 724 char *text = HAVE_LOCALTIME_R ? dtext->expanded_text : dtext->text;
e73127a4
MN
725 uint32_t code = 0;
726 int i;
727 uint8_t *p;
728 Glyph *glyph = NULL;
729
730 for (i = 0, p = text; *p; i++) {
731 Glyph dummy = { 0 };
732 GET_UTF8(code, *p++, continue;);
733
734 /* skip new line chars, just go to new line */
735 if (code == '\n' || code == '\r' || code == '\t')
736 continue;
737
738 dummy.code = code;
739 glyph = av_tree_find(dtext->glyphs, &dummy, (void *)glyph_cmp, NULL);
740
741 if (glyph->bitmap.pixel_mode != FT_PIXEL_MODE_MONO &&
742 glyph->bitmap.pixel_mode != FT_PIXEL_MODE_GRAY)
743 return AVERROR(EINVAL);
744
745 if (dtext->is_packed_rgb) {
746 draw_glyph_rgb(picref, &glyph->bitmap,
c5420f10
MN
747 dtext->positions[i].x+x, dtext->positions[i].y+y, width, height,
748 dtext->pixel_step[0], rgbcolor, dtext->rgba_map);
e73127a4
MN
749 } else {
750 draw_glyph_yuv(picref, &glyph->bitmap,
c5420f10
MN
751 dtext->positions[i].x+x, dtext->positions[i].y+y, width, height,
752 yuvcolor, dtext->hsub, dtext->vsub);
e73127a4
MN
753 }
754 }
755
756 return 0;
757}
758
a2fb4bcb
LB
759static int draw_text(AVFilterContext *ctx, AVFilterBufferRef *picref,
760 int width, int height)
761{
762 DrawTextContext *dtext = ctx->priv;
763 int ret;
764
a5b64584
SS
765 /* draw box */
766 if (dtext->draw_box)
a2fb4bcb 767 drawbox(picref, dtext->x, dtext->y, dtext->w, dtext->h,
a5b64584 768 dtext->box_line, dtext->pixel_step, dtext->boxcolor,
a2fb4bcb
LB
769 dtext->hsub, dtext->vsub, dtext->is_packed_rgb,
770 dtext->rgba_map);
a5b64584 771
c5420f10 772 if (dtext->shadowx || dtext->shadowy) {
a2fb4bcb
LB
773 if ((ret = draw_glyphs(dtext, picref, width, height,
774 dtext->shadowcolor_rgba,
775 dtext->shadowcolor,
776 dtext->x + dtext->shadowx,
777 dtext->y + dtext->shadowy)) < 0)
c5420f10
MN
778 return ret;
779 }
780
a2fb4bcb
LB
781 if ((ret = draw_glyphs(dtext, picref, width, height,
782 dtext->fontcolor_rgba,
783 dtext->fontcolor,
784 dtext->x,
785 dtext->y)) < 0)
e73127a4 786 return ret;
a5b64584
SS
787
788 return 0;
789}
790
791static void null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir) { }
792
2cf74eca
LB
793static inline int normalize_double(int *n, double d)
794{
795 int ret = 0;
796
797 if (isnan(d)) {
798 ret = AVERROR(EINVAL);
799 } else if (d > INT_MAX || d < INT_MIN) {
800 *n = d > INT_MAX ? INT_MAX : INT_MIN;
801 ret = AVERROR(EINVAL);
802 } else
803 *n = round(d);
804
805 return ret;
806}
807
808static void start_frame(AVFilterLink *inlink, AVFilterBufferRef *inpicref)
809{
810 AVFilterContext *ctx = inlink->dst;
811 DrawTextContext *dtext = ctx->priv;
73585620 812 int fail = 0;
2cf74eca
LB
813
814 if (dtext_prepare_text(ctx) < 0) {
815 av_log(ctx, AV_LOG_ERROR, "Can't draw text\n");
73585620 816 fail = 1;
2cf74eca
LB
817 }
818
819 dtext->var_values[VAR_T] = inpicref->pts == AV_NOPTS_VALUE ?
820 NAN : inpicref->pts * av_q2d(inlink->time_base);
821 dtext->var_values[VAR_X] =
f5edfc9e 822 av_expr_eval(dtext->x_pexpr, dtext->var_values, &dtext->prng);
2cf74eca 823 dtext->var_values[VAR_Y] =
f5edfc9e 824 av_expr_eval(dtext->y_pexpr, dtext->var_values, &dtext->prng);
2cf74eca 825 dtext->var_values[VAR_X] =
f5edfc9e 826 av_expr_eval(dtext->x_pexpr, dtext->var_values, &dtext->prng);
2cf74eca 827
73585620 828 dtext->draw = fail ? 0 :
f5edfc9e 829 av_expr_eval(dtext->d_pexpr, dtext->var_values, &dtext->prng);
73585620 830
2cf74eca
LB
831 normalize_double(&dtext->x, dtext->var_values[VAR_X]);
832 normalize_double(&dtext->y, dtext->var_values[VAR_Y]);
833
e496c45d
AU
834 if (dtext->fix_bounds) {
835 if (dtext->x < 0) dtext->x = 0;
836 if (dtext->y < 0) dtext->y = 0;
837 if ((unsigned)dtext->x + (unsigned)dtext->w > inlink->w)
838 dtext->x = inlink->w - dtext->w;
839 if ((unsigned)dtext->y + (unsigned)dtext->h > inlink->h)
840 dtext->y = inlink->h - dtext->h;
841 }
2cf74eca
LB
842
843 dtext->x &= ~((1 << dtext->hsub) - 1);
844 dtext->y &= ~((1 << dtext->vsub) - 1);
845
846 av_dlog(ctx, "n:%d t:%f x:%d y:%d x+w:%d y+h:%d\n",
847 (int)dtext->var_values[VAR_N], dtext->var_values[VAR_T],
848 dtext->x, dtext->y, dtext->x+dtext->w, dtext->y+dtext->h);
849
850 avfilter_start_frame(inlink->dst->outputs[0], inpicref);
851}
852
a5b64584
SS
853static void end_frame(AVFilterLink *inlink)
854{
855 AVFilterLink *outlink = inlink->dst->outputs[0];
856 AVFilterBufferRef *picref = inlink->cur_buf;
2cf74eca
LB
857 DrawTextContext *dtext = inlink->dst->priv;
858
859 if (dtext->draw)
ec11ff84 860 draw_text(inlink->dst, picref, picref->video->w, picref->video->h);
a5b64584 861
2cf74eca
LB
862 dtext->var_values[VAR_N] += 1.0;
863
a5b64584
SS
864 avfilter_draw_slice(outlink, 0, picref->video->h, 1);
865 avfilter_end_frame(outlink);
866}
867
868AVFilter avfilter_vf_drawtext = {
869 .name = "drawtext",
870 .description = NULL_IF_CONFIG_SMALL("Draw text on top of video frames using libfreetype library."),
871 .priv_size = sizeof(DrawTextContext),
872 .init = init,
873 .uninit = uninit,
874 .query_formats = query_formats,
875
876 .inputs = (AVFilterPad[]) {{ .name = "default",
877 .type = AVMEDIA_TYPE_VIDEO,
878 .get_video_buffer = avfilter_null_get_video_buffer,
2cf74eca 879 .start_frame = start_frame,
a5b64584
SS
880 .draw_slice = null_draw_slice,
881 .end_frame = end_frame,
882 .config_props = config_input,
883 .min_perms = AV_PERM_WRITE |
884 AV_PERM_READ,
885 .rej_perms = AV_PERM_PRESERVE },
886 { .name = NULL}},
887 .outputs = (AVFilterPad[]) {{ .name = "default",
888 .type = AVMEDIA_TYPE_VIDEO, },
889 { .name = NULL}},
890};