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 Libav.
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.
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.
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
25 * drawtext filter, based on the original vhook/drawtext.c
26 * filter by Gustavo Sverzut Barbieri
31 #include <sys/types.h>
37 #if CONFIG_LIBFONTCONFIG
38 #include <fontconfig/fontconfig.h>
41 #include "libavutil/colorspace.h"
42 #include "libavutil/common.h"
43 #include "libavutil/file.h"
44 #include "libavutil/eval.h"
45 #include "libavutil/opt.h"
46 #include "libavutil/mathematics.h"
47 #include "libavutil/random_seed.h"
48 #include "libavutil/parseutils.h"
49 #include "libavutil/pixdesc.h"
50 #include "libavutil/time_internal.h"
51 #include "libavutil/tree.h"
52 #include "libavutil/lfg.h"
54 #include "drawutils.h"
60 #include FT_FREETYPE_H
63 static const char *const var_names[] = {
67 "main_w", "W", ///< width of the main video
68 "main_h", "H", ///< height of the main video
69 "text_w", "w", ///< width of the overlay text
70 "text_h", "h", ///< height of the overlay text
73 "n", ///< number of processed frames
74 "t", ///< timestamp expressed in seconds
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[] = {
109 typedef struct DrawTextContext {
110 const AVClass *class;
111 #if CONFIG_LIBFONTCONFIG
112 uint8_t *font; ///< font to be used
114 uint8_t *fontfile; ///< font to be used
115 uint8_t *text; ///< text to be drawn
116 uint8_t *expanded_text; ///< used to contain the strftime()-expanded text
117 size_t expanded_text_size; ///< size in bytes of the expanded_text buffer
118 int ft_load_flags; ///< flags used for loading fonts, see FT_LOAD_*
119 FT_Vector *positions; ///< positions for each element in the text
120 size_t nb_positions; ///< number of elements of positions array
121 char *textfile; ///< file with text to be drawn
122 int x, y; ///< position to start drawing text
123 int w, h; ///< dimension of the text block
124 int shadowx, shadowy;
125 unsigned int fontsize; ///< font size to use
126 char *fontcolor_string; ///< font color as string
127 char *boxcolor_string; ///< box color as string
128 char *shadowcolor_string; ///< shadow color as string
129 uint8_t fontcolor[4]; ///< foreground color
130 uint8_t boxcolor[4]; ///< background color
131 uint8_t shadowcolor[4]; ///< shadow color
132 uint8_t fontcolor_rgba[4]; ///< foreground color in RGBA
133 uint8_t boxcolor_rgba[4]; ///< background color in RGBA
134 uint8_t shadowcolor_rgba[4]; ///< shadow color in RGBA
136 short int draw_box; ///< draw box around text - true or false
137 int use_kerning; ///< font kerning is used - true/false
138 int tabsize; ///< tab size
139 int fix_bounds; ///< do we let it go out of frame bounds - t/f
141 FT_Library library; ///< freetype font library handle
142 FT_Face face; ///< freetype font face handle
143 struct AVTreeNode *glyphs; ///< rendered glyphs, stored using the UTF-32 char code
144 int hsub, vsub; ///< chroma subsampling values
146 int pixel_step[4]; ///< distance in bytes between the component of each pixel
147 uint8_t rgba_map[4]; ///< map RGBA offsets to the positions in the packed RGBA format
148 uint8_t *box_line[4]; ///< line used for filling the box background
149 char *x_expr, *y_expr;
150 AVExpr *x_pexpr, *y_pexpr; ///< parsed expressions for x and y
151 double var_values[VAR_VARS_NB];
154 int draw; ///< set to zero to prevent drawing
158 AVLFG prng; ///< random
161 #define OFFSET(x) offsetof(DrawTextContext, x)
162 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM
164 static const AVOption drawtext_options[]= {
165 #if CONFIG_LIBFONTCONFIG
166 { "font", "Font name", OFFSET(font), AV_OPT_TYPE_STRING, { .str = "Sans" }, .flags = FLAGS },
168 { "fontfile", NULL, OFFSET(fontfile), AV_OPT_TYPE_STRING, .flags = FLAGS },
169 { "text", NULL, OFFSET(text), AV_OPT_TYPE_STRING, .flags = FLAGS },
170 { "textfile", NULL, OFFSET(textfile), AV_OPT_TYPE_STRING, .flags = FLAGS },
171 { "fontcolor", NULL, OFFSET(fontcolor_string), AV_OPT_TYPE_STRING, { .str = "black" }, .flags = FLAGS },
172 { "boxcolor", NULL, OFFSET(boxcolor_string), AV_OPT_TYPE_STRING, { .str = "white" }, .flags = FLAGS },
173 { "shadowcolor", NULL, OFFSET(shadowcolor_string), AV_OPT_TYPE_STRING, { .str = "black" }, .flags = FLAGS },
174 { "box", NULL, OFFSET(draw_box), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, FLAGS },
175 { "fontsize", NULL, OFFSET(fontsize), AV_OPT_TYPE_INT, { .i64 = 16 }, 1, 1024, FLAGS },
176 { "x", NULL, OFFSET(x_expr), AV_OPT_TYPE_STRING, { .str = "0" }, .flags = FLAGS },
177 { "y", NULL, OFFSET(y_expr), AV_OPT_TYPE_STRING, { .str = "0" }, .flags = FLAGS },
178 { "shadowx", NULL, OFFSET(shadowx), AV_OPT_TYPE_INT, { .i64 = 0 }, INT_MIN, INT_MAX, FLAGS },
179 { "shadowy", NULL, OFFSET(shadowy), AV_OPT_TYPE_INT, { .i64 = 0 }, INT_MIN, INT_MAX, FLAGS },
180 { "tabsize", NULL, OFFSET(tabsize), AV_OPT_TYPE_INT, { .i64 = 4 }, 0, INT_MAX, FLAGS },
181 { "draw", "if false do not draw", OFFSET(d_expr), AV_OPT_TYPE_STRING, { .str = "1" }, .flags = FLAGS },
182 { "alpha", "apply alpha while rendering", OFFSET(a_expr), AV_OPT_TYPE_STRING, { .str = "1" }, .flags = FLAGS },
183 { "fix_bounds", "if true, check and fix text coords to avoid clipping",
184 OFFSET(fix_bounds), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, FLAGS },
186 /* FT_LOAD_* flags */
187 { "ft_load_flags", "set font loading flags for libfreetype", OFFSET(ft_load_flags), AV_OPT_TYPE_FLAGS, { .i64 = FT_LOAD_DEFAULT | FT_LOAD_RENDER}, 0, INT_MAX, FLAGS, "ft_load_flags" },
188 { "default", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_DEFAULT }, .flags = FLAGS, .unit = "ft_load_flags" },
189 { "no_scale", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_SCALE }, .flags = FLAGS, .unit = "ft_load_flags" },
190 { "no_hinting", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_HINTING }, .flags = FLAGS, .unit = "ft_load_flags" },
191 { "render", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_RENDER }, .flags = FLAGS, .unit = "ft_load_flags" },
192 { "no_bitmap", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_BITMAP }, .flags = FLAGS, .unit = "ft_load_flags" },
193 { "vertical_layout", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_VERTICAL_LAYOUT }, .flags = FLAGS, .unit = "ft_load_flags" },
194 { "force_autohint", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_FORCE_AUTOHINT }, .flags = FLAGS, .unit = "ft_load_flags" },
195 { "crop_bitmap", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_CROP_BITMAP }, .flags = FLAGS, .unit = "ft_load_flags" },
196 { "pedantic", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_PEDANTIC }, .flags = FLAGS, .unit = "ft_load_flags" },
197 { "ignore_global_advance_width", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH }, .flags = FLAGS, .unit = "ft_load_flags" },
198 { "no_recurse", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_RECURSE }, .flags = FLAGS, .unit = "ft_load_flags" },
199 { "ignore_transform", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_IGNORE_TRANSFORM }, .flags = FLAGS, .unit = "ft_load_flags" },
200 { "monochrome", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_MONOCHROME }, .flags = FLAGS, .unit = "ft_load_flags" },
201 { "linear_design", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_LINEAR_DESIGN }, .flags = FLAGS, .unit = "ft_load_flags" },
202 { "no_autohint", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_AUTOHINT }, .flags = FLAGS, .unit = "ft_load_flags" },
206 static const char *drawtext_get_name(void *ctx)
211 static const AVClass drawtext_class = {
217 #undef __FTERRORS_H__
218 #define FT_ERROR_START_LIST {
219 #define FT_ERRORDEF(e, v, s) { (e), (s) },
220 #define FT_ERROR_END_LIST { 0, NULL } };
226 } static ft_errors[] =
229 #define FT_ERRMSG(e) ft_errors[e].err_msg
231 typedef struct Glyph {
234 FT_Bitmap bitmap; ///< array holding bitmaps of font
241 static int glyph_cmp(void *key, const void *b)
243 const Glyph *a = key, *bb = b;
244 int64_t diff = (int64_t)a->code - (int64_t)bb->code;
245 return diff > 0 ? 1 : diff < 0 ? -1 : 0;
249 * Load glyphs corresponding to the UTF-32 codepoint code.
251 static int load_glyph(AVFilterContext *ctx, Glyph **glyph_ptr, uint32_t code)
253 DrawTextContext *s = ctx->priv;
255 struct AVTreeNode *node = NULL;
258 /* load glyph into s->face->glyph */
259 if (FT_Load_Char(s->face, code, s->ft_load_flags))
260 return AVERROR(EINVAL);
263 if (!(glyph = av_mallocz(sizeof(*glyph))) ||
264 !(glyph->glyph = av_mallocz(sizeof(*glyph->glyph)))) {
265 ret = AVERROR(ENOMEM);
270 if (FT_Get_Glyph(s->face->glyph, glyph->glyph)) {
271 ret = AVERROR(EINVAL);
275 glyph->bitmap = s->face->glyph->bitmap;
276 glyph->bitmap_left = s->face->glyph->bitmap_left;
277 glyph->bitmap_top = s->face->glyph->bitmap_top;
278 glyph->advance = s->face->glyph->advance.x >> 6;
280 /* measure text height to calculate text_height (or the maximum text height) */
281 FT_Glyph_Get_CBox(*glyph->glyph, ft_glyph_bbox_pixels, &glyph->bbox);
283 /* cache the newly created glyph */
284 if (!(node = av_tree_node_alloc())) {
285 ret = AVERROR(ENOMEM);
288 av_tree_insert(&s->glyphs, glyph, glyph_cmp, &node);
296 av_freep(&glyph->glyph);
302 static int parse_font(AVFilterContext *ctx)
304 DrawTextContext *s = ctx->priv;
305 #if !CONFIG_LIBFONTCONFIG
307 av_log(ctx, AV_LOG_ERROR, "No font filename provided\n");
308 return AVERROR(EINVAL);
313 FcPattern *pat, *best;
314 FcResult result = FcResultMatch;
318 int err = AVERROR(ENOENT);
324 return AVERROR_UNKNOWN;
326 if (!(pat = FcPatternCreate()))
327 return AVERROR(ENOMEM);
329 FcPatternAddString(pat, FC_FAMILY, s->font);
330 FcPatternAddBool(pat, FC_OUTLINE, FcTrue);
331 FcPatternAddDouble(pat, FC_SIZE, (double)s->fontsize);
333 FcDefaultSubstitute(pat);
335 if (!FcConfigSubstitute(NULL, pat, FcMatchPattern)) {
336 FcPatternDestroy(pat);
337 return AVERROR(ENOMEM);
340 best = FcFontMatch(NULL, pat, &result);
341 FcPatternDestroy(pat);
343 if (!best || result == FcResultNoMatch) {
344 av_log(ctx, AV_LOG_ERROR,
345 "Cannot find a valid font for the family %s\n",
350 if (FcPatternGetBool(best, FC_OUTLINE, 0, &fc_bool) != FcResultMatch ||
352 av_log(ctx, AV_LOG_ERROR, "Outline not available for %s\n",
357 if (FcPatternGetString(best, FC_FAMILY, 0, &fc_string) != FcResultMatch) {
358 av_log(ctx, AV_LOG_ERROR, "No matches for %s\n",
363 if (FcPatternGetString(best, FC_FILE, 0, &fc_string) != FcResultMatch) {
364 av_log(ctx, AV_LOG_ERROR, "No file path for %s\n",
369 s->fontfile = av_strdup(fc_string);
371 err = AVERROR(ENOMEM);
376 FcPatternDestroy(best);
381 static av_cold int init(AVFilterContext *ctx)
384 DrawTextContext *s = ctx->priv;
387 if ((err = parse_font(ctx)) < 0)
395 av_log(ctx, AV_LOG_ERROR,
396 "Both text and text file provided. Please provide only one\n");
397 return AVERROR(EINVAL);
399 if ((err = av_file_map(s->textfile, &textbuf, &textbuf_size, 0, ctx)) < 0) {
400 av_log(ctx, AV_LOG_ERROR,
401 "The text file '%s' could not be read or is empty\n",
406 if (textbuf_size > SIZE_MAX - 1 ||
407 !(s->text = av_malloc(textbuf_size + 1))) {
408 av_file_unmap(textbuf, textbuf_size);
409 return AVERROR(ENOMEM);
411 memcpy(s->text, textbuf, textbuf_size);
412 s->text[textbuf_size] = 0;
413 av_file_unmap(textbuf, textbuf_size);
417 av_log(ctx, AV_LOG_ERROR,
418 "Either text or a valid file must be provided\n");
419 return AVERROR(EINVAL);
422 if ((err = av_parse_color(s->fontcolor_rgba, s->fontcolor_string, -1, ctx))) {
423 av_log(ctx, AV_LOG_ERROR,
424 "Invalid font color '%s'\n", s->fontcolor_string);
428 if ((err = av_parse_color(s->boxcolor_rgba, s->boxcolor_string, -1, ctx))) {
429 av_log(ctx, AV_LOG_ERROR,
430 "Invalid box color '%s'\n", s->boxcolor_string);
434 if ((err = av_parse_color(s->shadowcolor_rgba, s->shadowcolor_string, -1, ctx))) {
435 av_log(ctx, AV_LOG_ERROR,
436 "Invalid shadow color '%s'\n", s->shadowcolor_string);
440 if ((err = FT_Init_FreeType(&(s->library)))) {
441 av_log(ctx, AV_LOG_ERROR,
442 "Could not load FreeType: %s\n", FT_ERRMSG(err));
443 return AVERROR(EINVAL);
446 /* load the face, and set up the encoding, which is by default UTF-8 */
447 if ((err = FT_New_Face(s->library, s->fontfile, 0, &s->face))) {
448 av_log(ctx, AV_LOG_ERROR, "Could not load fontface from file '%s': %s\n",
449 s->fontfile, FT_ERRMSG(err));
450 return AVERROR(EINVAL);
452 if ((err = FT_Set_Pixel_Sizes(s->face, 0, s->fontsize))) {
453 av_log(ctx, AV_LOG_ERROR, "Could not set font size to %d pixels: %s\n",
454 s->fontsize, FT_ERRMSG(err));
455 return AVERROR(EINVAL);
458 s->use_kerning = FT_HAS_KERNING(s->face);
460 /* load the fallback glyph with code 0 */
461 load_glyph(ctx, NULL, 0);
463 /* set the tabsize in pixels */
464 if ((err = load_glyph(ctx, &glyph, ' ') < 0)) {
465 av_log(ctx, AV_LOG_ERROR, "Could not set tabsize.\n");
468 s->tabsize *= glyph->advance;
473 static int query_formats(AVFilterContext *ctx)
475 static const enum AVPixelFormat pix_fmts[] = {
476 AV_PIX_FMT_ARGB, AV_PIX_FMT_RGBA,
477 AV_PIX_FMT_ABGR, AV_PIX_FMT_BGRA,
478 AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24,
479 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV444P,
480 AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV411P,
481 AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV440P,
485 ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
489 static int glyph_enu_free(void *opaque, void *elem)
495 static av_cold void uninit(AVFilterContext *ctx)
497 DrawTextContext *s = ctx->priv;
500 av_expr_free(s->x_pexpr);
501 av_expr_free(s->y_pexpr);
502 av_expr_free(s->d_pexpr);
503 s->x_pexpr = s->y_pexpr = s->d_pexpr = NULL;
504 av_freep(&s->expanded_text);
505 av_freep(&s->positions);
506 av_tree_enumerate(s->glyphs, NULL, NULL, glyph_enu_free);
507 av_tree_destroy(s->glyphs);
509 FT_Done_Face(s->face);
510 FT_Done_FreeType(s->library);
512 for (i = 0; i < 4; i++) {
513 av_freep(&s->box_line[i]);
514 s->pixel_step[i] = 0;
519 static inline int is_newline(uint32_t c)
521 return c == '\n' || c == '\r' || c == '\f' || c == '\v';
524 static int expand_strftime(DrawTextContext *s)
527 time_t now = time(0);
528 uint8_t *buf = s->expanded_text;
529 int buf_size = s->expanded_text_size;
532 buf_size = 2 * strlen(s->text) + 1;
534 localtime_r(&now, <ime);
536 while ((buf = av_realloc(buf, buf_size))) {
538 if (strftime(buf, buf_size, s->text, <ime) != 0 || *buf == 0)
544 return AVERROR(ENOMEM);
545 s->expanded_text = buf;
546 s->expanded_text_size = buf_size;
551 static int dtext_prepare_text(AVFilterContext *ctx)
553 DrawTextContext *s = ctx->priv;
554 uint32_t code = 0, prev_code = 0;
555 int x = 0, y = 0, i = 0, ret;
556 int text_height, baseline;
560 int y_min = 32000, y_max = -32000;
562 Glyph *glyph = NULL, *prev_glyph = NULL;
564 int width = ctx->inputs[0]->w;
565 int height = ctx->inputs[0]->h;
567 ret = expand_strftime(s);
571 text = s->expanded_text ? s->expanded_text : s->text;
573 if ((len = strlen(text)) > s->nb_positions) {
574 FT_Vector *p = av_realloc(s->positions,
575 len * sizeof(*s->positions));
577 av_freep(s->positions);
579 return AVERROR(ENOMEM);
582 s->nb_positions = len;
586 /* load and cache glyphs */
587 for (i = 0, p = text; *p; i++) {
588 GET_UTF8(code, *p++, continue;);
592 glyph = av_tree_find(s->glyphs, &dummy, glyph_cmp, NULL);
594 ret = load_glyph(ctx, &glyph, code);
599 y_min = FFMIN(glyph->bbox.yMin, y_min);
600 y_max = FFMAX(glyph->bbox.yMax, y_max);
602 text_height = y_max - y_min;
605 /* compute and save position for each glyph */
607 for (i = 0, p = text; *p; i++) {
608 GET_UTF8(code, *p++, continue;);
610 /* skip the \n in the sequence \r\n */
611 if (prev_code == '\r' && code == '\n')
615 if (is_newline(code)) {
616 str_w = FFMAX(str_w, x - s->x);
625 glyph = av_tree_find(s->glyphs, &dummy, glyph_cmp, NULL);
628 if (s->use_kerning && prev_glyph && glyph->code) {
629 FT_Get_Kerning(s->face, prev_glyph->code, glyph->code,
630 ft_kerning_default, &delta);
634 if (x + glyph->bbox.xMax >= width) {
635 str_w = FFMAX(str_w, x);
641 s->positions[i].x = x + glyph->bitmap_left;
642 s->positions[i].y = y - glyph->bitmap_top + baseline;
643 if (code == '\t') x = (x / s->tabsize + 1)*s->tabsize;
644 else x += glyph->advance;
647 str_w = FFMIN(width - 1, FFMAX(str_w, x));
648 y = FFMIN(y + text_height, height - 1);
651 s->var_values[VAR_TEXT_W] = s->var_values[VAR_TW] = s->w;
653 s->var_values[VAR_TEXT_H] = s->var_values[VAR_TH] = s->h;
659 static int config_input(AVFilterLink *inlink)
661 AVFilterContext *ctx = inlink->dst;
662 DrawTextContext *s = ctx->priv;
663 const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(inlink->format);
666 s->hsub = pix_desc->log2_chroma_w;
667 s->vsub = pix_desc->log2_chroma_h;
669 s->var_values[VAR_E ] = M_E;
670 s->var_values[VAR_PHI] = M_PHI;
671 s->var_values[VAR_PI ] = M_PI;
673 s->var_values[VAR_MAIN_W] =
674 s->var_values[VAR_MW] = ctx->inputs[0]->w;
675 s->var_values[VAR_MAIN_H] =
676 s->var_values[VAR_MH] = ctx->inputs[0]->h;
678 s->var_values[VAR_X] = 0;
679 s->var_values[VAR_Y] = 0;
680 s->var_values[VAR_T] = NAN;
682 av_lfg_init(&s->prng, av_get_random_seed());
684 av_expr_free(s->x_pexpr);
685 av_expr_free(s->y_pexpr);
686 av_expr_free(s->d_pexpr);
687 s->x_pexpr = s->y_pexpr = s->d_pexpr = NULL;
688 if ((ret = av_expr_parse(&s->x_pexpr, s->x_expr, var_names,
689 NULL, NULL, fun2_names, fun2, 0, ctx)) < 0 ||
690 (ret = av_expr_parse(&s->y_pexpr, s->y_expr, var_names,
691 NULL, NULL, fun2_names, fun2, 0, ctx)) < 0 ||
692 (ret = av_expr_parse(&s->d_pexpr, s->d_expr, var_names,
693 NULL, NULL, fun2_names, fun2, 0, ctx)) < 0 ||
694 (ret = av_expr_parse(&s->a_pexpr, s->a_expr, var_names,
695 NULL, NULL, fun2_names, fun2, 0, ctx)) < 0)
696 return AVERROR(EINVAL);
699 ff_fill_line_with_color(s->box_line, s->pixel_step,
700 inlink->w, s->boxcolor,
701 inlink->format, s->boxcolor_rgba,
702 &s->is_packed_rgb, s->rgba_map)) < 0)
705 if (!s->is_packed_rgb) {
706 uint8_t *rgba = s->fontcolor_rgba;
707 s->fontcolor[0] = RGB_TO_Y_CCIR(rgba[0], rgba[1], rgba[2]);
708 s->fontcolor[1] = RGB_TO_U_CCIR(rgba[0], rgba[1], rgba[2], 0);
709 s->fontcolor[2] = RGB_TO_V_CCIR(rgba[0], rgba[1], rgba[2], 0);
710 s->fontcolor[3] = rgba[3];
711 rgba = s->shadowcolor_rgba;
712 s->shadowcolor[0] = RGB_TO_Y_CCIR(rgba[0], rgba[1], rgba[2]);
713 s->shadowcolor[1] = RGB_TO_U_CCIR(rgba[0], rgba[1], rgba[2], 0);
714 s->shadowcolor[2] = RGB_TO_V_CCIR(rgba[0], rgba[1], rgba[2], 0);
715 s->shadowcolor[3] = rgba[3];
720 return dtext_prepare_text(ctx);
723 #define GET_BITMAP_VAL(r, c) \
724 bitmap->pixel_mode == FT_PIXEL_MODE_MONO ? \
725 (bitmap->buffer[(r) * bitmap->pitch + ((c)>>3)] & (0x80 >> ((c)&7))) * 255 : \
726 bitmap->buffer[(r) * bitmap->pitch + (c)]
728 #define SET_PIXEL_YUV(frame, yuva_color, val, x, y, hsub, vsub) { \
729 luma_pos = ((x) ) + ((y) ) * frame->linesize[0]; \
730 alpha = yuva_color[3] * alpha_mul * (val) * 129 / 255; \
731 frame->data[0][luma_pos] = (alpha * yuva_color[0] + (255*255*129 - alpha) * frame->data[0][luma_pos] ) >> 23; \
732 if (((x) & ((1<<(hsub)) - 1)) == 0 && ((y) & ((1<<(vsub)) - 1)) == 0) {\
733 chroma_pos1 = ((x) >> (hsub)) + ((y) >> (vsub)) * frame->linesize[1]; \
734 chroma_pos2 = ((x) >> (hsub)) + ((y) >> (vsub)) * frame->linesize[2]; \
735 frame->data[1][chroma_pos1] = (alpha * yuva_color[1] + (255*255*129 - alpha) * frame->data[1][chroma_pos1]) >> 23; \
736 frame->data[2][chroma_pos2] = (alpha * yuva_color[2] + (255*255*129 - alpha) * frame->data[2][chroma_pos2]) >> 23; \
740 static inline int draw_glyph_yuv(AVFrame *frame, FT_Bitmap *bitmap, unsigned int x,
741 unsigned int y, unsigned int width, unsigned int height,
742 const uint8_t yuva_color[4], int hsub, int vsub,
746 unsigned int luma_pos, chroma_pos1, chroma_pos2;
749 for (r = 0; r < bitmap->rows && r+y < height; r++) {
750 for (c = 0; c < bitmap->width && c+x < width; c++) {
751 /* get intensity value in the glyph bitmap (source) */
752 src_val = GET_BITMAP_VAL(r, c);
756 SET_PIXEL_YUV(frame, yuva_color, src_val, c+x, y+r, hsub, vsub);
763 #define SET_PIXEL_RGB(frame, rgba_color, val, x, y, pixel_step, r_off, g_off, b_off, a_off) { \
764 p = frame->data[0] + (x) * pixel_step + ((y) * frame->linesize[0]); \
765 alpha = rgba_color[3] * alpha_mul * (val) * 129 / 255; \
766 *(p+r_off) = (alpha * rgba_color[0] + (255*255*129 - alpha) * *(p+r_off)) >> 23; \
767 *(p+g_off) = (alpha * rgba_color[1] + (255*255*129 - alpha) * *(p+g_off)) >> 23; \
768 *(p+b_off) = (alpha * rgba_color[2] + (255*255*129 - alpha) * *(p+b_off)) >> 23; \
771 static inline int draw_glyph_rgb(AVFrame *frame, FT_Bitmap *bitmap,
772 unsigned int x, unsigned int y,
773 unsigned int width, unsigned int height, int pixel_step,
774 const uint8_t rgba_color[4], const uint8_t rgba_map[4],
781 for (r = 0; r < bitmap->rows && r+y < height; r++) {
782 for (c = 0; c < bitmap->width && c+x < width; c++) {
783 /* get intensity value in the glyph bitmap (source) */
784 src_val = GET_BITMAP_VAL(r, c);
788 SET_PIXEL_RGB(frame, rgba_color, src_val, c+x, y+r, pixel_step,
789 rgba_map[0], rgba_map[1], rgba_map[2], rgba_map[3]);
796 static inline void drawbox(AVFrame *frame, unsigned int x, unsigned int y,
797 unsigned int width, unsigned int height,
798 uint8_t *line[4], int pixel_step[4], uint8_t color[4],
799 int hsub, int vsub, int is_rgba_packed, uint8_t rgba_map[4],
804 if (color[3] != 0xFF || alpha_mul != 0xFF) {
805 if (is_rgba_packed) {
807 for (j = 0; j < height; j++)
808 for (i = 0; i < width; i++)
809 SET_PIXEL_RGB(frame, color, 255, i+x, y+j, pixel_step[0],
810 rgba_map[0], rgba_map[1], rgba_map[2], rgba_map[3]);
812 unsigned int luma_pos, chroma_pos1, chroma_pos2;
813 for (j = 0; j < height; j++)
814 for (i = 0; i < width; i++)
815 SET_PIXEL_YUV(frame, color, 255, i+x, y+j, hsub, vsub);
818 ff_draw_rectangle(frame->data, frame->linesize,
819 line, pixel_step, hsub, vsub,
820 x, y, width, height);
824 static int draw_glyphs(DrawTextContext *s, AVFrame *frame,
825 int width, int height,
826 const uint8_t rgbcolor[4], const uint8_t yuvcolor[4],
829 char *text = s->expanded_text;
835 for (i = 0, p = text; *p; i++) {
837 GET_UTF8(code, *p++, continue;);
839 /* skip new line chars, just go to new line */
840 if (code == '\n' || code == '\r' || code == '\t')
844 glyph = av_tree_find(s->glyphs, &dummy, (void *)glyph_cmp, NULL);
846 if (glyph->bitmap.pixel_mode != FT_PIXEL_MODE_MONO &&
847 glyph->bitmap.pixel_mode != FT_PIXEL_MODE_GRAY)
848 return AVERROR(EINVAL);
850 if (s->is_packed_rgb) {
851 draw_glyph_rgb(frame, &glyph->bitmap,
852 s->positions[i].x+x, s->positions[i].y+y, width, height,
853 s->pixel_step[0], rgbcolor, s->rgba_map, s->alpha);
855 draw_glyph_yuv(frame, &glyph->bitmap,
856 s->positions[i].x+x, s->positions[i].y+y, width, height,
857 yuvcolor, s->hsub, s->vsub, s->alpha);
864 static int draw_text(AVFilterContext *ctx, AVFrame *frame,
865 int width, int height)
867 DrawTextContext *s = ctx->priv;
872 drawbox(frame, s->x, s->y, s->w, s->h,
873 s->box_line, s->pixel_step, s->boxcolor,
874 s->hsub, s->vsub, s->is_packed_rgb,
875 s->rgba_map, s->alpha);
877 if (s->shadowx || s->shadowy) {
878 if ((ret = draw_glyphs(s, frame, width, height,
882 s->y + s->shadowy)) < 0)
886 if ((ret = draw_glyphs(s, frame, width, height,
896 static inline int normalize_double(int *n, double d)
901 ret = AVERROR(EINVAL);
902 } else if (d > INT_MAX || d < INT_MIN) {
903 *n = d > INT_MAX ? INT_MAX : INT_MIN;
904 ret = AVERROR(EINVAL);
911 static void update_alpha(DrawTextContext *s)
913 double alpha = av_expr_eval(s->a_pexpr, s->var_values, &s->prng);
923 s->alpha = 256 * alpha;
926 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
928 AVFilterContext *ctx = inlink->dst;
929 DrawTextContext *s = ctx->priv;
932 if ((ret = dtext_prepare_text(ctx)) < 0) {
933 av_log(ctx, AV_LOG_ERROR, "Can't draw text\n");
934 av_frame_free(&frame);
938 s->var_values[VAR_T] = frame->pts == AV_NOPTS_VALUE ?
939 NAN : frame->pts * av_q2d(inlink->time_base);
940 s->var_values[VAR_X] =
941 av_expr_eval(s->x_pexpr, s->var_values, &s->prng);
942 s->var_values[VAR_Y] =
943 av_expr_eval(s->y_pexpr, s->var_values, &s->prng);
944 s->var_values[VAR_X] =
945 av_expr_eval(s->x_pexpr, s->var_values, &s->prng);
947 s->draw = av_expr_eval(s->d_pexpr, s->var_values, &s->prng);
951 normalize_double(&s->x, s->var_values[VAR_X]);
952 normalize_double(&s->y, s->var_values[VAR_Y]);
955 if (s->x < 0) s->x = 0;
956 if (s->y < 0) s->y = 0;
957 if ((unsigned)s->x + (unsigned)s->w > inlink->w)
958 s->x = inlink->w - s->w;
959 if ((unsigned)s->y + (unsigned)s->h > inlink->h)
960 s->y = inlink->h - s->h;
963 s->x &= ~((1 << s->hsub) - 1);
964 s->y &= ~((1 << s->vsub) - 1);
966 av_log(ctx, AV_LOG_TRACE, "n:%d t:%f x:%d y:%d x+w:%d y+h:%d\n",
967 (int)s->var_values[VAR_N], s->var_values[VAR_T],
968 s->x, s->y, s->x+s->w, s->y+s->h);
971 draw_text(inlink->dst, frame, frame->width, frame->height);
973 s->var_values[VAR_N] += 1.0;
975 return ff_filter_frame(inlink->dst->outputs[0], frame);
978 static const AVFilterPad avfilter_vf_drawtext_inputs[] = {
981 .type = AVMEDIA_TYPE_VIDEO,
982 .get_video_buffer = ff_null_get_video_buffer,
983 .filter_frame = filter_frame,
984 .config_props = config_input,
990 static const AVFilterPad avfilter_vf_drawtext_outputs[] = {
993 .type = AVMEDIA_TYPE_VIDEO,
998 AVFilter ff_vf_drawtext = {
1000 .description = NULL_IF_CONFIG_SMALL("Draw text on top of video frames using libfreetype library."),
1001 .priv_size = sizeof(DrawTextContext),
1002 .priv_class = &drawtext_class,
1005 .query_formats = query_formats,
1007 .inputs = avfilter_vf_drawtext_inputs,
1008 .outputs = avfilter_vf_drawtext_outputs,