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>
6 * This file is part of FFmpeg.
8 * FFmpeg 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.
13 * FFmpeg 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.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with FFmpeg; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 * drawtext filter, based on the original vhook/drawtext.c
26 * filter by Gustavo Sverzut Barbieri
33 #include "libavutil/avstring.h"
34 #include "libavutil/file.h"
35 #include "libavutil/eval.h"
36 #include "libavutil/opt.h"
37 #include "libavutil/random_seed.h"
38 #include "libavutil/parseutils.h"
39 #include "libavutil/timecode.h"
40 #include "libavutil/tree.h"
41 #include "libavutil/lfg.h"
43 #include "drawutils.h"
51 #include <freetype/config/ftheader.h>
52 #include FT_FREETYPE_H
55 #include <fontconfig/fontconfig.h>
58 static const char *const var_names[] = {
61 "line_h", "lh", ///< line height, same as max_glyph_h
62 "main_h", "h", "H", ///< height of the input video
63 "main_w", "w", "W", ///< width of the input video
64 "max_glyph_a", "ascent", ///< max glyph ascent
65 "max_glyph_d", "descent", ///< min glyph descent
66 "max_glyph_h", ///< max glyph height
67 "max_glyph_w", ///< max glyph width
68 "n", ///< number of frame
70 "t", ///< timestamp expressed in seconds
71 "text_h", "th", ///< height of the rendered text
72 "text_w", "tw", ///< width of the rendered text
78 static const char *const fun2_names[] = {
82 static double drand(void *opaque, double min, double max)
84 return min + (max-min) / UINT_MAX * av_lfg_get(opaque);
87 typedef double (*eval_func2)(void *, double a, double b);
89 static const eval_func2 fun2[] = {
98 VAR_MAIN_H, VAR_h, VAR_H,
99 VAR_MAIN_W, VAR_w, VAR_W,
100 VAR_MAX_GLYPH_A, VAR_ASCENT,
101 VAR_MAX_GLYPH_D, VAR_DESCENT,
115 const AVClass *class;
116 int reinit; ///< tells if the filter is being reinited
117 uint8_t *fontfile; ///< font to be used
118 uint8_t *text; ///< text to be drawn
119 uint8_t *expanded_text; ///< used to contain the strftime()-expanded text
120 size_t expanded_text_size; ///< size in bytes of the expanded_text buffer
121 int ft_load_flags; ///< flags used for loading fonts, see FT_LOAD_*
122 FT_Vector *positions; ///< positions for each element in the text
123 size_t nb_positions; ///< number of elements of positions array
124 char *textfile; ///< file with text to be drawn
125 int x; ///< x position to start drawing text
126 int y; ///< y position to start drawing text
127 int max_glyph_w; ///< max glyph width
128 int max_glyph_h; ///< max glyph height
129 int shadowx, shadowy;
130 unsigned int fontsize; ///< font size to use
131 char *fontcolor_string; ///< font color as string
132 char *boxcolor_string; ///< box color as string
133 char *shadowcolor_string; ///< shadow color as string
135 short int draw_box; ///< draw box around text - true or false
136 int use_kerning; ///< font kerning is used - true/false
137 int tabsize; ///< tab size
138 int fix_bounds; ///< do we let it go out of frame bounds - t/f
141 FFDrawColor fontcolor; ///< foreground color
142 FFDrawColor shadowcolor; ///< shadow color
143 FFDrawColor boxcolor; ///< background color
145 FT_Library library; ///< freetype font library handle
146 FT_Face face; ///< freetype font face handle
147 struct AVTreeNode *glyphs; ///< rendered glyphs, stored using the UTF-32 char code
148 char *x_expr; ///< expression for x position
149 char *y_expr; ///< expression for y position
150 AVExpr *x_pexpr, *y_pexpr; ///< parsed expressions for x and y
151 int64_t basetime; ///< base pts time in the real world for display
152 double var_values[VAR_VARS_NB];
153 char *draw_expr; ///< expression for draw
154 AVExpr *draw_pexpr; ///< parsed expression for draw
155 int draw; ///< set to zero to prevent drawing
156 AVLFG prng; ///< random
157 char *tc_opt_string; ///< specified timecode option string
158 AVRational tc_rate; ///< frame rate for timecode
159 AVTimecode tc; ///< timecode context
160 int tc24hmax; ///< 1 if timecode is wrapped to 24 hours, 0 otherwise
164 #define OFFSET(x) offsetof(DrawTextContext, x)
166 static const AVOption drawtext_options[]= {
167 {"fontfile", "set font file", OFFSET(fontfile), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX },
168 {"text", "set text", OFFSET(text), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX },
169 {"textfile", "set text file", OFFSET(textfile), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX },
170 {"fontcolor", "set foreground color", OFFSET(fontcolor_string), AV_OPT_TYPE_STRING, {.str="black"}, CHAR_MIN, CHAR_MAX },
171 {"boxcolor", "set box color", OFFSET(boxcolor_string), AV_OPT_TYPE_STRING, {.str="white"}, CHAR_MIN, CHAR_MAX },
172 {"shadowcolor", "set shadow color", OFFSET(shadowcolor_string), AV_OPT_TYPE_STRING, {.str="black"}, CHAR_MIN, CHAR_MAX },
173 {"box", "set box", OFFSET(draw_box), AV_OPT_TYPE_INT, {.dbl=0}, 0, 1 },
174 {"fontsize", "set font size", OFFSET(fontsize), AV_OPT_TYPE_INT, {.dbl=0}, 0, INT_MAX },
175 {"x", "set x expression", OFFSET(x_expr), AV_OPT_TYPE_STRING, {.str="0"}, CHAR_MIN, CHAR_MAX },
176 {"y", "set y expression", OFFSET(y_expr), AV_OPT_TYPE_STRING, {.str="0"}, CHAR_MIN, CHAR_MAX },
177 {"shadowx", "set x", OFFSET(shadowx), AV_OPT_TYPE_INT, {.dbl=0}, INT_MIN, INT_MAX },
178 {"shadowy", "set y", OFFSET(shadowy), AV_OPT_TYPE_INT, {.dbl=0}, INT_MIN, INT_MAX },
179 {"tabsize", "set tab size", OFFSET(tabsize), AV_OPT_TYPE_INT, {.dbl=4}, 0, INT_MAX },
180 {"basetime", "set base time", OFFSET(basetime), AV_OPT_TYPE_INT64, {.dbl=AV_NOPTS_VALUE}, INT64_MIN, INT64_MAX },
181 {"draw", "if false do not draw", OFFSET(draw_expr), AV_OPT_TYPE_STRING, {.str="1"}, CHAR_MIN, CHAR_MAX },
182 {"timecode", "set initial timecode", OFFSET(tc_opt_string), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX },
183 {"tc24hmax", "set 24 hours max (timecode only)", OFFSET(tc24hmax), AV_OPT_TYPE_INT, {.dbl=0}, 0, 1 },
184 {"timecode_rate", "set rate (timecode only)", OFFSET(tc_rate), AV_OPT_TYPE_RATIONAL, {.dbl=0}, 0, INT_MAX },
185 {"r", "set rate (timecode only)", OFFSET(tc_rate), AV_OPT_TYPE_RATIONAL, {.dbl=0}, 0, INT_MAX },
186 {"rate", "set rate (timecode only)", OFFSET(tc_rate), AV_OPT_TYPE_RATIONAL, {.dbl=0}, 0, INT_MAX },
187 {"fix_bounds", "if true, check and fix text coords to avoid clipping",
188 OFFSET(fix_bounds), AV_OPT_TYPE_INT, {.dbl=1}, 0, 1 },
190 /* FT_LOAD_* flags */
191 {"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" },
192 {"default", "set default", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_DEFAULT}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
193 {"no_scale", "set no_scale", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_NO_SCALE}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
194 {"no_hinting", "set no_hinting", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_NO_HINTING}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
195 {"render", "set render", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_RENDER}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
196 {"no_bitmap", "set no_bitmap", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_NO_BITMAP}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
197 {"vertical_layout", "set vertical_layout", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_VERTICAL_LAYOUT}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
198 {"force_autohint", "set force_autohint", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_FORCE_AUTOHINT}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
199 {"crop_bitmap", "set crop_bitmap", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_CROP_BITMAP}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
200 {"pedantic", "set pedantic", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_PEDANTIC}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
201 {"ignore_global_advance_width", "set ignore_global_advance_width", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
202 {"no_recurse", "set no_recurse", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_NO_RECURSE}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
203 {"ignore_transform", "set ignore_transform", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_IGNORE_TRANSFORM}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
204 {"monochrome", "set monochrome", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_MONOCHROME}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
205 {"linear_design", "set linear_design", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_LINEAR_DESIGN}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
206 {"no_autohint", "set no_autohint", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_NO_AUTOHINT}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
210 AVFILTER_DEFINE_CLASS(drawtext);
212 #undef __FTERRORS_H__
213 #define FT_ERROR_START_LIST {
214 #define FT_ERRORDEF(e, v, s) { (e), (s) },
215 #define FT_ERROR_END_LIST { 0, NULL } };
221 } static ft_errors[] =
224 #define FT_ERRMSG(e) ft_errors[e].err_msg
229 FT_Bitmap bitmap; ///< array holding bitmaps of font
236 static int glyph_cmp(void *key, const void *b)
238 const Glyph *a = key, *bb = b;
239 int64_t diff = (int64_t)a->code - (int64_t)bb->code;
240 return diff > 0 ? 1 : diff < 0 ? -1 : 0;
244 * Load glyphs corresponding to the UTF-32 codepoint code.
246 static int load_glyph(AVFilterContext *ctx, Glyph **glyph_ptr, uint32_t code)
248 DrawTextContext *dtext = ctx->priv;
250 struct AVTreeNode *node = NULL;
253 /* load glyph into dtext->face->glyph */
254 if (FT_Load_Char(dtext->face, code, dtext->ft_load_flags))
255 return AVERROR(EINVAL);
258 if (!(glyph = av_mallocz(sizeof(*glyph))) ||
259 !(glyph->glyph = av_mallocz(sizeof(*glyph->glyph)))) {
260 ret = AVERROR(ENOMEM);
265 if (FT_Get_Glyph(dtext->face->glyph, glyph->glyph)) {
266 ret = AVERROR(EINVAL);
270 glyph->bitmap = dtext->face->glyph->bitmap;
271 glyph->bitmap_left = dtext->face->glyph->bitmap_left;
272 glyph->bitmap_top = dtext->face->glyph->bitmap_top;
273 glyph->advance = dtext->face->glyph->advance.x >> 6;
275 /* measure text height to calculate text_height (or the maximum text height) */
276 FT_Glyph_Get_CBox(*glyph->glyph, ft_glyph_bbox_pixels, &glyph->bbox);
278 /* cache the newly created glyph */
279 if (!(node = av_mallocz(av_tree_node_size))) {
280 ret = AVERROR(ENOMEM);
283 av_tree_insert(&dtext->glyphs, glyph, glyph_cmp, &node);
291 av_freep(&glyph->glyph);
297 static int load_font_file(AVFilterContext *ctx, const char *path, int index,
300 DrawTextContext *dtext = ctx->priv;
303 err = FT_New_Face(dtext->library, path, index, &dtext->face);
305 *error = FT_ERRMSG(err);
306 return AVERROR(EINVAL);
311 #if CONFIG_FONTCONFIG
312 static int load_font_fontconfig(AVFilterContext *ctx, const char **error)
314 DrawTextContext *dtext = ctx->priv;
315 FcConfig *fontconfig;
316 FcPattern *pattern, *fpat;
317 FcResult result = FcResultMatch;
322 fontconfig = FcInitLoadConfigAndFonts();
324 *error = "impossible to init fontconfig\n";
325 return AVERROR(EINVAL);
327 pattern = FcNameParse(dtext->fontfile ? dtext->fontfile :
328 (uint8_t *)(intptr_t)"default");
330 *error = "could not parse fontconfig pattern";
331 return AVERROR(EINVAL);
333 if (!FcConfigSubstitute(fontconfig, pattern, FcMatchPattern)) {
334 *error = "could not substitue fontconfig options"; /* very unlikely */
335 return AVERROR(EINVAL);
337 FcDefaultSubstitute(pattern);
338 fpat = FcFontMatch(fontconfig, pattern, &result);
339 if (!fpat || result != FcResultMatch) {
340 *error = "impossible to find a matching font";
341 return AVERROR(EINVAL);
343 if (FcPatternGetString (fpat, FC_FILE, 0, &filename) != FcResultMatch ||
344 FcPatternGetInteger(fpat, FC_INDEX, 0, &index ) != FcResultMatch ||
345 FcPatternGetDouble (fpat, FC_SIZE, 0, &size ) != FcResultMatch) {
346 *error = "impossible to find font information";
347 return AVERROR(EINVAL);
349 av_log(ctx, AV_LOG_INFO, "Using \"%s\"\n", filename);
350 if (!dtext->fontsize)
351 dtext->fontsize = size + 0.5;
352 err = load_font_file(ctx, filename, index, error);
355 FcPatternDestroy(fpat);
356 FcPatternDestroy(pattern);
357 FcConfigDestroy(fontconfig);
362 static int load_font(AVFilterContext *ctx)
364 DrawTextContext *dtext = ctx->priv;
366 const char *error = "unknown error\n";
368 /* load the face, and set up the encoding, which is by default UTF-8 */
369 err = load_font_file(ctx, dtext->fontfile, 0, &error);
372 #if CONFIG_FONTCONFIG
373 err = load_font_fontconfig(ctx, &error);
377 av_log(ctx, AV_LOG_ERROR, "Could not load font \"%s\": %s\n",
378 dtext->fontfile, error);
382 static av_cold int init(AVFilterContext *ctx, const char *args)
385 DrawTextContext *dtext = ctx->priv;
388 dtext->class = &drawtext_class;
389 av_opt_set_defaults(dtext);
391 if ((err = av_set_options_string(dtext, args, "=", ":")) < 0) {
392 av_log(ctx, AV_LOG_ERROR, "Error parsing options string: '%s'\n", args);
396 if (!dtext->fontfile && !CONFIG_FONTCONFIG) {
397 av_log(ctx, AV_LOG_ERROR, "No font filename provided\n");
398 return AVERROR(EINVAL);
401 if (dtext->textfile) {
406 av_log(ctx, AV_LOG_ERROR,
407 "Both text and text file provided. Please provide only one\n");
408 return AVERROR(EINVAL);
410 if ((err = av_file_map(dtext->textfile, &textbuf, &textbuf_size, 0, ctx)) < 0) {
411 av_log(ctx, AV_LOG_ERROR,
412 "The text file '%s' could not be read or is empty\n",
417 if (!(dtext->text = av_malloc(textbuf_size+1)))
418 return AVERROR(ENOMEM);
419 memcpy(dtext->text, textbuf, textbuf_size);
420 dtext->text[textbuf_size] = 0;
421 av_file_unmap(textbuf, textbuf_size);
424 if (dtext->tc_opt_string) {
425 int ret = av_timecode_init_from_string(&dtext->tc, dtext->tc_rate,
426 dtext->tc_opt_string, ctx);
430 dtext->tc.flags |= AV_TIMECODE_FLAG_24HOURSMAX;
432 dtext->text = av_strdup("");
436 av_log(ctx, AV_LOG_ERROR,
437 "Either text, a valid file or a timecode must be provided\n");
438 return AVERROR(EINVAL);
441 if ((err = av_parse_color(dtext->fontcolor.rgba, dtext->fontcolor_string, -1, ctx))) {
442 av_log(ctx, AV_LOG_ERROR,
443 "Invalid font color '%s'\n", dtext->fontcolor_string);
447 if ((err = av_parse_color(dtext->boxcolor.rgba, dtext->boxcolor_string, -1, ctx))) {
448 av_log(ctx, AV_LOG_ERROR,
449 "Invalid box color '%s'\n", dtext->boxcolor_string);
453 if ((err = av_parse_color(dtext->shadowcolor.rgba, dtext->shadowcolor_string, -1, ctx))) {
454 av_log(ctx, AV_LOG_ERROR,
455 "Invalid shadow color '%s'\n", dtext->shadowcolor_string);
459 if ((err = FT_Init_FreeType(&(dtext->library)))) {
460 av_log(ctx, AV_LOG_ERROR,
461 "Could not load FreeType: %s\n", FT_ERRMSG(err));
462 return AVERROR(EINVAL);
465 err = load_font(ctx);
468 if (!dtext->fontsize)
469 dtext->fontsize = 16;
470 if ((err = FT_Set_Pixel_Sizes(dtext->face, 0, dtext->fontsize))) {
471 av_log(ctx, AV_LOG_ERROR, "Could not set font size to %d pixels: %s\n",
472 dtext->fontsize, FT_ERRMSG(err));
473 return AVERROR(EINVAL);
476 dtext->use_kerning = FT_HAS_KERNING(dtext->face);
478 /* load the fallback glyph with code 0 */
479 load_glyph(ctx, NULL, 0);
481 /* set the tabsize in pixels */
482 if ((err = load_glyph(ctx, &glyph, ' ')) < 0) {
483 av_log(ctx, AV_LOG_ERROR, "Could not set tabsize.\n");
486 dtext->tabsize *= glyph->advance;
491 static int query_formats(AVFilterContext *ctx)
493 ff_set_common_formats(ctx, ff_draw_supported_pixel_formats(0));
497 static int glyph_enu_free(void *opaque, void *elem)
501 FT_Done_Glyph(*glyph->glyph);
502 av_freep(&glyph->glyph);
507 static av_cold void uninit(AVFilterContext *ctx)
509 DrawTextContext *dtext = ctx->priv;
511 av_expr_free(dtext->x_pexpr); dtext->x_pexpr = NULL;
512 av_expr_free(dtext->y_pexpr); dtext->y_pexpr = NULL;
513 av_expr_free(dtext->draw_pexpr); dtext->draw_pexpr = NULL;
516 av_freep(&dtext->positions);
517 dtext->nb_positions = 0;
519 av_tree_enumerate(dtext->glyphs, NULL, NULL, glyph_enu_free);
520 av_tree_destroy(dtext->glyphs);
521 dtext->glyphs = NULL;
523 FT_Done_Face(dtext->face);
524 FT_Done_FreeType(dtext->library);
527 static inline int is_newline(uint32_t c)
529 return c == '\n' || c == '\r' || c == '\f' || c == '\v';
532 static int config_input(AVFilterLink *inlink)
534 AVFilterContext *ctx = inlink->dst;
535 DrawTextContext *dtext = ctx->priv;
538 ff_draw_init(&dtext->dc, inlink->format, 0);
539 ff_draw_color(&dtext->dc, &dtext->fontcolor, dtext->fontcolor.rgba);
540 ff_draw_color(&dtext->dc, &dtext->shadowcolor, dtext->shadowcolor.rgba);
541 ff_draw_color(&dtext->dc, &dtext->boxcolor, dtext->boxcolor.rgba);
543 dtext->var_values[VAR_w] = dtext->var_values[VAR_W] = dtext->var_values[VAR_MAIN_W] = inlink->w;
544 dtext->var_values[VAR_h] = dtext->var_values[VAR_H] = dtext->var_values[VAR_MAIN_H] = inlink->h;
545 dtext->var_values[VAR_SAR] = inlink->sample_aspect_ratio.num ? av_q2d(inlink->sample_aspect_ratio) : 1;
546 dtext->var_values[VAR_DAR] = (double)inlink->w / inlink->h * dtext->var_values[VAR_SAR];
547 dtext->var_values[VAR_HSUB] = 1 << dtext->dc.hsub_max;
548 dtext->var_values[VAR_VSUB] = 1 << dtext->dc.vsub_max;
549 dtext->var_values[VAR_X] = NAN;
550 dtext->var_values[VAR_Y] = NAN;
552 dtext->var_values[VAR_N] = 0;
553 dtext->var_values[VAR_T] = NAN;
555 av_lfg_init(&dtext->prng, av_get_random_seed());
557 if ((ret = av_expr_parse(&dtext->x_pexpr, dtext->x_expr, var_names,
558 NULL, NULL, fun2_names, fun2, 0, ctx)) < 0 ||
559 (ret = av_expr_parse(&dtext->y_pexpr, dtext->y_expr, var_names,
560 NULL, NULL, fun2_names, fun2, 0, ctx)) < 0 ||
561 (ret = av_expr_parse(&dtext->draw_pexpr, dtext->draw_expr, var_names,
562 NULL, NULL, fun2_names, fun2, 0, ctx)) < 0)
564 return AVERROR(EINVAL);
569 static int command(AVFilterContext *ctx, const char *cmd, const char *arg, char *res, int res_len, int flags)
571 DrawTextContext *dtext = ctx->priv;
573 if (!strcmp(cmd, "reinit")) {
577 if ((ret = init(ctx, arg)) < 0)
579 return config_input(ctx->inputs[0]);
582 return AVERROR(ENOSYS);
585 static int draw_glyphs(DrawTextContext *dtext, AVFilterBufferRef *picref,
586 int width, int height, const uint8_t rgbcolor[4], FFDrawColor *color, int x, int y)
588 char *text = dtext->expanded_text;
594 for (i = 0, p = text; *p; i++) {
596 GET_UTF8(code, *p++, continue;);
598 /* skip new line chars, just go to new line */
599 if (code == '\n' || code == '\r' || code == '\t')
603 glyph = av_tree_find(dtext->glyphs, &dummy, (void *)glyph_cmp, NULL);
605 if (glyph->bitmap.pixel_mode != FT_PIXEL_MODE_MONO &&
606 glyph->bitmap.pixel_mode != FT_PIXEL_MODE_GRAY)
607 return AVERROR(EINVAL);
609 x1 = dtext->positions[i].x+dtext->x+x;
610 y1 = dtext->positions[i].y+dtext->y+y;
612 ff_blend_mask(&dtext->dc, color,
613 picref->data, picref->linesize, width, height,
614 glyph->bitmap.buffer, glyph->bitmap.pitch,
615 glyph->bitmap.width, glyph->bitmap.rows,
616 glyph->bitmap.pixel_mode == FT_PIXEL_MODE_MONO ? 0 : 3,
623 static int draw_text(AVFilterContext *ctx, AVFilterBufferRef *picref,
624 int width, int height)
626 DrawTextContext *dtext = ctx->priv;
627 uint32_t code = 0, prev_code = 0;
628 int x = 0, y = 0, i = 0, ret;
629 int max_text_line_w = 0, len;
631 char *text = dtext->text;
633 int y_min = 32000, y_max = -32000;
634 int x_min = 32000, x_max = -32000;
636 Glyph *glyph = NULL, *prev_glyph = NULL;
639 time_t now = time(0);
641 uint8_t *buf = dtext->expanded_text;
642 int buf_size = dtext->expanded_text_size;
644 if(dtext->basetime != AV_NOPTS_VALUE)
645 now= picref->pts*av_q2d(ctx->inputs[0]->time_base) + dtext->basetime/1000000;
648 buf_size = 2*strlen(dtext->text)+1;
649 buf = av_malloc(buf_size);
653 localtime_r(&now, <ime);
655 if(strchr(dtext->text, '%'))
656 ltime= *localtime(&now);
661 if (strftime(buf, buf_size, dtext->text, <ime) != 0 || *buf == 0)
664 } while ((buf = av_realloc(buf, buf_size)));
666 if (dtext->tc_opt_string) {
667 char tcbuf[AV_TIMECODE_STR_SIZE];
668 av_timecode_make_string(&dtext->tc, tcbuf, dtext->frame_id++);
669 buf = av_asprintf("%s%s", dtext->text, tcbuf);
673 return AVERROR(ENOMEM);
674 text = dtext->expanded_text = buf;
675 dtext->expanded_text_size = buf_size;
676 if ((len = strlen(text)) > dtext->nb_positions) {
677 if (!(dtext->positions =
678 av_realloc(dtext->positions, len*sizeof(*dtext->positions))))
679 return AVERROR(ENOMEM);
680 dtext->nb_positions = len;
686 /* load and cache glyphs */
687 for (i = 0, p = text; *p; i++) {
688 GET_UTF8(code, *p++, continue;);
692 glyph = av_tree_find(dtext->glyphs, &dummy, glyph_cmp, NULL);
694 load_glyph(ctx, &glyph, code);
697 y_min = FFMIN(glyph->bbox.yMin, y_min);
698 y_max = FFMAX(glyph->bbox.yMax, y_max);
699 x_min = FFMIN(glyph->bbox.xMin, x_min);
700 x_max = FFMAX(glyph->bbox.xMax, x_max);
702 dtext->max_glyph_h = y_max - y_min;
703 dtext->max_glyph_w = x_max - x_min;
705 /* compute and save position for each glyph */
707 for (i = 0, p = text; *p; i++) {
708 GET_UTF8(code, *p++, continue;);
710 /* skip the \n in the sequence \r\n */
711 if (prev_code == '\r' && code == '\n')
715 if (is_newline(code)) {
716 max_text_line_w = FFMAX(max_text_line_w, x);
717 y += dtext->max_glyph_h;
725 glyph = av_tree_find(dtext->glyphs, &dummy, glyph_cmp, NULL);
728 if (dtext->use_kerning && prev_glyph && glyph->code) {
729 FT_Get_Kerning(dtext->face, prev_glyph->code, glyph->code,
730 ft_kerning_default, &delta);
735 dtext->positions[i].x = x + glyph->bitmap_left;
736 dtext->positions[i].y = y - glyph->bitmap_top + y_max;
737 if (code == '\t') x = (x / dtext->tabsize + 1)*dtext->tabsize;
738 else x += glyph->advance;
741 max_text_line_w = FFMAX(x, max_text_line_w);
743 dtext->var_values[VAR_TW] = dtext->var_values[VAR_TEXT_W] = max_text_line_w;
744 dtext->var_values[VAR_TH] = dtext->var_values[VAR_TEXT_H] = y + dtext->max_glyph_h;
746 dtext->var_values[VAR_MAX_GLYPH_W] = dtext->max_glyph_w;
747 dtext->var_values[VAR_MAX_GLYPH_H] = dtext->max_glyph_h;
748 dtext->var_values[VAR_MAX_GLYPH_A] = dtext->var_values[VAR_ASCENT ] = y_max;
749 dtext->var_values[VAR_MAX_GLYPH_D] = dtext->var_values[VAR_DESCENT] = y_min;
751 dtext->var_values[VAR_LINE_H] = dtext->var_values[VAR_LH] = dtext->max_glyph_h;
753 dtext->x = dtext->var_values[VAR_X] = av_expr_eval(dtext->x_pexpr, dtext->var_values, &dtext->prng);
754 dtext->y = dtext->var_values[VAR_Y] = av_expr_eval(dtext->y_pexpr, dtext->var_values, &dtext->prng);
755 dtext->x = dtext->var_values[VAR_X] = av_expr_eval(dtext->x_pexpr, dtext->var_values, &dtext->prng);
756 dtext->draw = av_expr_eval(dtext->draw_pexpr, dtext->var_values, &dtext->prng);
761 box_w = FFMIN(width - 1 , max_text_line_w);
762 box_h = FFMIN(height - 1, y + dtext->max_glyph_h);
766 ff_blend_rectangle(&dtext->dc, &dtext->boxcolor,
767 picref->data, picref->linesize, width, height,
768 dtext->x, dtext->y, box_w, box_h);
770 if (dtext->shadowx || dtext->shadowy) {
771 if ((ret = draw_glyphs(dtext, picref, width, height, dtext->shadowcolor.rgba,
772 &dtext->shadowcolor, dtext->shadowx, dtext->shadowy)) < 0)
776 if ((ret = draw_glyphs(dtext, picref, width, height, dtext->fontcolor.rgba,
777 &dtext->fontcolor, 0, 0)) < 0)
783 static void null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir) { }
785 static void end_frame(AVFilterLink *inlink)
787 AVFilterContext *ctx = inlink->dst;
788 AVFilterLink *outlink = ctx->outputs[0];
789 DrawTextContext *dtext = ctx->priv;
790 AVFilterBufferRef *picref = inlink->cur_buf;
792 dtext->var_values[VAR_T] = picref->pts == AV_NOPTS_VALUE ?
793 NAN : picref->pts * av_q2d(inlink->time_base);
795 draw_text(ctx, picref, picref->video->w, picref->video->h);
797 av_log(ctx, AV_LOG_DEBUG, "n:%d t:%f text_w:%d text_h:%d x:%d y:%d\n",
798 (int)dtext->var_values[VAR_N], dtext->var_values[VAR_T],
799 (int)dtext->var_values[VAR_TEXT_W], (int)dtext->var_values[VAR_TEXT_H],
802 dtext->var_values[VAR_N] += 1.0;
804 ff_draw_slice(outlink, 0, picref->video->h, 1);
805 ff_end_frame(outlink);
808 AVFilter avfilter_vf_drawtext = {
810 .description = NULL_IF_CONFIG_SMALL("Draw text on top of video frames using libfreetype library."),
811 .priv_size = sizeof(DrawTextContext),
814 .query_formats = query_formats,
816 .inputs = (const AVFilterPad[]) {{ .name = "default",
817 .type = AVMEDIA_TYPE_VIDEO,
818 .get_video_buffer = ff_null_get_video_buffer,
819 .start_frame = ff_null_start_frame,
820 .draw_slice = null_draw_slice,
821 .end_frame = end_frame,
822 .config_props = config_input,
823 .min_perms = AV_PERM_WRITE |
825 .rej_perms = AV_PERM_PRESERVE },
827 .outputs = (const AVFilterPad[]) {{ .name = "default",
828 .type = AVMEDIA_TYPE_VIDEO, },
830 .process_command = command,