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/bprint.h"
35 #include "libavutil/common.h"
36 #include "libavutil/file.h"
37 #include "libavutil/eval.h"
38 #include "libavutil/opt.h"
39 #include "libavutil/random_seed.h"
40 #include "libavutil/parseutils.h"
41 #include "libavutil/timecode.h"
42 #include "libavutil/tree.h"
43 #include "libavutil/lfg.h"
45 #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
79 static const char *const fun2_names[] = {
83 static double drand(void *opaque, double min, double max)
85 return min + (max-min) / UINT_MAX * av_lfg_get(opaque);
88 typedef double (*eval_func2)(void *, double a, double b);
90 static const eval_func2 fun2[] = {
99 VAR_MAIN_H, VAR_h, VAR_H,
100 VAR_MAIN_W, VAR_w, VAR_W,
101 VAR_MAX_GLYPH_A, VAR_ASCENT,
102 VAR_MAX_GLYPH_D, VAR_DESCENT,
116 enum expansion_mode {
123 const AVClass *class;
124 enum expansion_mode exp_mode; ///< expansion mode to use for the text
125 int reinit; ///< tells if the filter is being reinited
126 uint8_t *fontfile; ///< font to be used
127 uint8_t *text; ///< text to be drawn
128 AVBPrint expanded_text; ///< used to contain the expanded text
129 int ft_load_flags; ///< flags used for loading fonts, see FT_LOAD_*
130 FT_Vector *positions; ///< positions for each element in the text
131 size_t nb_positions; ///< number of elements of positions array
132 char *textfile; ///< file with text to be drawn
133 int x; ///< x position to start drawing text
134 int y; ///< y position to start drawing text
135 int max_glyph_w; ///< max glyph width
136 int max_glyph_h; ///< max glyph height
137 int shadowx, shadowy;
138 unsigned int fontsize; ///< font size to use
140 short int draw_box; ///< draw box around text - true or false
141 int use_kerning; ///< font kerning is used - true/false
142 int tabsize; ///< tab size
143 int fix_bounds; ///< do we let it go out of frame bounds - t/f
146 FFDrawColor fontcolor; ///< foreground color
147 FFDrawColor shadowcolor; ///< shadow color
148 FFDrawColor boxcolor; ///< background color
150 FT_Library library; ///< freetype font library handle
151 FT_Face face; ///< freetype font face handle
152 struct AVTreeNode *glyphs; ///< rendered glyphs, stored using the UTF-32 char code
153 char *x_expr; ///< expression for x position
154 char *y_expr; ///< expression for y position
155 AVExpr *x_pexpr, *y_pexpr; ///< parsed expressions for x and y
156 int64_t basetime; ///< base pts time in the real world for display
157 double var_values[VAR_VARS_NB];
158 #if FF_API_DRAWTEXT_OLD_TIMELINE
159 char *draw_expr; ///< expression for draw
160 AVExpr *draw_pexpr; ///< parsed expression for draw
161 int draw; ///< set to zero to prevent drawing
163 AVLFG prng; ///< random
164 char *tc_opt_string; ///< specified timecode option string
165 AVRational tc_rate; ///< frame rate for timecode
166 AVTimecode tc; ///< timecode context
167 int tc24hmax; ///< 1 if timecode is wrapped to 24 hours, 0 otherwise
168 int reload; ///< reload text file for each frame
169 int start_number; ///< starting frame number for n/frame_num var
170 AVDictionary *metadata;
173 #define OFFSET(x) offsetof(DrawTextContext, x)
174 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
176 static const AVOption drawtext_options[]= {
177 {"fontfile", "set font file", OFFSET(fontfile), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX, FLAGS},
178 {"text", "set text", OFFSET(text), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX, FLAGS},
179 {"textfile", "set text file", OFFSET(textfile), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX, FLAGS},
180 {"fontcolor", "set foreground color", OFFSET(fontcolor.rgba), AV_OPT_TYPE_COLOR, {.str="black"}, CHAR_MIN, CHAR_MAX, FLAGS},
181 {"boxcolor", "set box color", OFFSET(boxcolor.rgba), AV_OPT_TYPE_COLOR, {.str="white"}, CHAR_MIN, CHAR_MAX, FLAGS},
182 {"shadowcolor", "set shadow color", OFFSET(shadowcolor.rgba), AV_OPT_TYPE_COLOR, {.str="black"}, CHAR_MIN, CHAR_MAX, FLAGS},
183 {"box", "set box", OFFSET(draw_box), AV_OPT_TYPE_INT, {.i64=0}, 0, 1 , FLAGS},
184 {"fontsize", "set font size", OFFSET(fontsize), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX , FLAGS},
185 {"x", "set x expression", OFFSET(x_expr), AV_OPT_TYPE_STRING, {.str="0"}, CHAR_MIN, CHAR_MAX, FLAGS},
186 {"y", "set y expression", OFFSET(y_expr), AV_OPT_TYPE_STRING, {.str="0"}, CHAR_MIN, CHAR_MAX, FLAGS},
187 {"shadowx", "set x", OFFSET(shadowx), AV_OPT_TYPE_INT, {.i64=0}, INT_MIN, INT_MAX , FLAGS},
188 {"shadowy", "set y", OFFSET(shadowy), AV_OPT_TYPE_INT, {.i64=0}, INT_MIN, INT_MAX , FLAGS},
189 {"tabsize", "set tab size", OFFSET(tabsize), AV_OPT_TYPE_INT, {.i64=4}, 0, INT_MAX , FLAGS},
190 {"basetime", "set base time", OFFSET(basetime), AV_OPT_TYPE_INT64, {.i64=AV_NOPTS_VALUE}, INT64_MIN, INT64_MAX , FLAGS},
191 #if FF_API_DRAWTEXT_OLD_TIMELINE
192 {"draw", "if false do not draw (deprecated)", OFFSET(draw_expr), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX, FLAGS},
195 {"expansion", "set the expansion mode", OFFSET(exp_mode), AV_OPT_TYPE_INT, {.i64=EXP_NORMAL}, 0, 2, FLAGS, "expansion"},
196 {"none", "set no expansion", OFFSET(exp_mode), AV_OPT_TYPE_CONST, {.i64=EXP_NONE}, 0, 0, FLAGS, "expansion"},
197 {"normal", "set normal expansion", OFFSET(exp_mode), AV_OPT_TYPE_CONST, {.i64=EXP_NORMAL}, 0, 0, FLAGS, "expansion"},
198 {"strftime", "set strftime expansion (deprecated)", OFFSET(exp_mode), AV_OPT_TYPE_CONST, {.i64=EXP_STRFTIME}, 0, 0, FLAGS, "expansion"},
200 {"timecode", "set initial timecode", OFFSET(tc_opt_string), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX, FLAGS},
201 {"tc24hmax", "set 24 hours max (timecode only)", OFFSET(tc24hmax), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS},
202 {"timecode_rate", "set rate (timecode only)", OFFSET(tc_rate), AV_OPT_TYPE_RATIONAL, {.dbl=0}, 0, INT_MAX, FLAGS},
203 {"r", "set rate (timecode only)", OFFSET(tc_rate), AV_OPT_TYPE_RATIONAL, {.dbl=0}, 0, INT_MAX, FLAGS},
204 {"rate", "set rate (timecode only)", OFFSET(tc_rate), AV_OPT_TYPE_RATIONAL, {.dbl=0}, 0, INT_MAX, FLAGS},
205 {"reload", "reload text file for each frame", OFFSET(reload), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS},
206 {"fix_bounds", "if true, check and fix text coords to avoid clipping", OFFSET(fix_bounds), AV_OPT_TYPE_INT, {.i64=1}, 0, 1, FLAGS},
207 {"start_number", "start frame number for n/frame_num variable", OFFSET(start_number), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, FLAGS},
209 /* FT_LOAD_* flags */
210 { "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" },
211 { "default", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_DEFAULT }, .flags = FLAGS, .unit = "ft_load_flags" },
212 { "no_scale", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_SCALE }, .flags = FLAGS, .unit = "ft_load_flags" },
213 { "no_hinting", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_HINTING }, .flags = FLAGS, .unit = "ft_load_flags" },
214 { "render", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_RENDER }, .flags = FLAGS, .unit = "ft_load_flags" },
215 { "no_bitmap", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_BITMAP }, .flags = FLAGS, .unit = "ft_load_flags" },
216 { "vertical_layout", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_VERTICAL_LAYOUT }, .flags = FLAGS, .unit = "ft_load_flags" },
217 { "force_autohint", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_FORCE_AUTOHINT }, .flags = FLAGS, .unit = "ft_load_flags" },
218 { "crop_bitmap", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_CROP_BITMAP }, .flags = FLAGS, .unit = "ft_load_flags" },
219 { "pedantic", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_PEDANTIC }, .flags = FLAGS, .unit = "ft_load_flags" },
220 { "ignore_global_advance_width", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH }, .flags = FLAGS, .unit = "ft_load_flags" },
221 { "no_recurse", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_RECURSE }, .flags = FLAGS, .unit = "ft_load_flags" },
222 { "ignore_transform", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_IGNORE_TRANSFORM }, .flags = FLAGS, .unit = "ft_load_flags" },
223 { "monochrome", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_MONOCHROME }, .flags = FLAGS, .unit = "ft_load_flags" },
224 { "linear_design", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_LINEAR_DESIGN }, .flags = FLAGS, .unit = "ft_load_flags" },
225 { "no_autohint", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_AUTOHINT }, .flags = FLAGS, .unit = "ft_load_flags" },
229 AVFILTER_DEFINE_CLASS(drawtext);
231 #undef __FTERRORS_H__
232 #define FT_ERROR_START_LIST {
233 #define FT_ERRORDEF(e, v, s) { (e), (s) },
234 #define FT_ERROR_END_LIST { 0, NULL } };
240 } static ft_errors[] =
243 #define FT_ERRMSG(e) ft_errors[e].err_msg
248 FT_Bitmap bitmap; ///< array holding bitmaps of font
255 static int glyph_cmp(void *key, const void *b)
257 const Glyph *a = key, *bb = b;
258 int64_t diff = (int64_t)a->code - (int64_t)bb->code;
259 return diff > 0 ? 1 : diff < 0 ? -1 : 0;
263 * Load glyphs corresponding to the UTF-32 codepoint code.
265 static int load_glyph(AVFilterContext *ctx, Glyph **glyph_ptr, uint32_t code)
267 DrawTextContext *s = ctx->priv;
269 struct AVTreeNode *node = NULL;
272 /* load glyph into s->face->glyph */
273 if (FT_Load_Char(s->face, code, s->ft_load_flags))
274 return AVERROR(EINVAL);
277 if (!(glyph = av_mallocz(sizeof(*glyph))) ||
278 !(glyph->glyph = av_mallocz(sizeof(*glyph->glyph)))) {
279 ret = AVERROR(ENOMEM);
284 if (FT_Get_Glyph(s->face->glyph, glyph->glyph)) {
285 ret = AVERROR(EINVAL);
289 glyph->bitmap = s->face->glyph->bitmap;
290 glyph->bitmap_left = s->face->glyph->bitmap_left;
291 glyph->bitmap_top = s->face->glyph->bitmap_top;
292 glyph->advance = s->face->glyph->advance.x >> 6;
294 /* measure text height to calculate text_height (or the maximum text height) */
295 FT_Glyph_Get_CBox(*glyph->glyph, ft_glyph_bbox_pixels, &glyph->bbox);
297 /* cache the newly created glyph */
298 if (!(node = av_tree_node_alloc())) {
299 ret = AVERROR(ENOMEM);
302 av_tree_insert(&s->glyphs, glyph, glyph_cmp, &node);
310 av_freep(&glyph->glyph);
316 static int load_font_file(AVFilterContext *ctx, const char *path, int index,
319 DrawTextContext *s = ctx->priv;
322 err = FT_New_Face(s->library, path, index, &s->face);
324 *error = FT_ERRMSG(err);
325 return AVERROR(EINVAL);
330 #if CONFIG_FONTCONFIG
331 static int load_font_fontconfig(AVFilterContext *ctx, const char **error)
333 DrawTextContext *s = ctx->priv;
334 FcConfig *fontconfig;
335 FcPattern *pattern, *fpat;
336 FcResult result = FcResultMatch;
341 fontconfig = FcInitLoadConfigAndFonts();
343 *error = "impossible to init fontconfig\n";
344 return AVERROR(EINVAL);
346 pattern = FcNameParse(s->fontfile ? s->fontfile :
347 (uint8_t *)(intptr_t)"default");
349 *error = "could not parse fontconfig pattern";
350 return AVERROR(EINVAL);
352 if (!FcConfigSubstitute(fontconfig, pattern, FcMatchPattern)) {
353 *error = "could not substitue fontconfig options"; /* very unlikely */
354 return AVERROR(EINVAL);
356 FcDefaultSubstitute(pattern);
357 fpat = FcFontMatch(fontconfig, pattern, &result);
358 if (!fpat || result != FcResultMatch) {
359 *error = "impossible to find a matching font";
360 return AVERROR(EINVAL);
362 if (FcPatternGetString (fpat, FC_FILE, 0, &filename) != FcResultMatch ||
363 FcPatternGetInteger(fpat, FC_INDEX, 0, &index ) != FcResultMatch ||
364 FcPatternGetDouble (fpat, FC_SIZE, 0, &size ) != FcResultMatch) {
365 *error = "impossible to find font information";
366 return AVERROR(EINVAL);
368 av_log(ctx, AV_LOG_INFO, "Using \"%s\"\n", filename);
370 s->fontsize = size + 0.5;
371 err = load_font_file(ctx, filename, index, error);
374 FcPatternDestroy(fpat);
375 FcPatternDestroy(pattern);
376 FcConfigDestroy(fontconfig);
381 static int load_font(AVFilterContext *ctx)
383 DrawTextContext *s = ctx->priv;
385 const char *error = "unknown error\n";
387 /* load the face, and set up the encoding, which is by default UTF-8 */
388 err = load_font_file(ctx, s->fontfile, 0, &error);
391 #if CONFIG_FONTCONFIG
392 err = load_font_fontconfig(ctx, &error);
396 av_log(ctx, AV_LOG_ERROR, "Could not load font \"%s\": %s\n",
401 static int load_textfile(AVFilterContext *ctx)
403 DrawTextContext *s = ctx->priv;
408 if ((err = av_file_map(s->textfile, &textbuf, &textbuf_size, 0, ctx)) < 0) {
409 av_log(ctx, AV_LOG_ERROR,
410 "The text file '%s' could not be read or is empty\n",
415 if (!(s->text = av_realloc(s->text, textbuf_size + 1)))
416 return AVERROR(ENOMEM);
417 memcpy(s->text, textbuf, textbuf_size);
418 s->text[textbuf_size] = 0;
419 av_file_unmap(textbuf, textbuf_size);
424 static av_cold int init(AVFilterContext *ctx)
427 DrawTextContext *s = ctx->priv;
430 #if FF_API_DRAWTEXT_OLD_TIMELINE
432 av_log(ctx, AV_LOG_WARNING, "'draw' option is deprecated and will be removed soon, "
433 "you are encouraged to use the generic timeline support through the 'enable' option\n");
436 if (!s->fontfile && !CONFIG_FONTCONFIG) {
437 av_log(ctx, AV_LOG_ERROR, "No font filename provided\n");
438 return AVERROR(EINVAL);
443 av_log(ctx, AV_LOG_ERROR,
444 "Both text and text file provided. Please provide only one\n");
445 return AVERROR(EINVAL);
447 if ((err = load_textfile(ctx)) < 0)
451 if (s->reload && !s->textfile)
452 av_log(ctx, AV_LOG_WARNING, "No file to reload\n");
454 if (s->tc_opt_string) {
455 int ret = av_timecode_init_from_string(&s->tc, s->tc_rate,
456 s->tc_opt_string, ctx);
460 s->tc.flags |= AV_TIMECODE_FLAG_24HOURSMAX;
462 s->text = av_strdup("");
466 av_log(ctx, AV_LOG_ERROR,
467 "Either text, a valid file or a timecode must be provided\n");
468 return AVERROR(EINVAL);
471 if ((err = FT_Init_FreeType(&(s->library)))) {
472 av_log(ctx, AV_LOG_ERROR,
473 "Could not load FreeType: %s\n", FT_ERRMSG(err));
474 return AVERROR(EINVAL);
477 err = load_font(ctx);
482 if ((err = FT_Set_Pixel_Sizes(s->face, 0, s->fontsize))) {
483 av_log(ctx, AV_LOG_ERROR, "Could not set font size to %d pixels: %s\n",
484 s->fontsize, FT_ERRMSG(err));
485 return AVERROR(EINVAL);
488 s->use_kerning = FT_HAS_KERNING(s->face);
490 /* load the fallback glyph with code 0 */
491 load_glyph(ctx, NULL, 0);
493 /* set the tabsize in pixels */
494 if ((err = load_glyph(ctx, &glyph, ' ')) < 0) {
495 av_log(ctx, AV_LOG_ERROR, "Could not set tabsize.\n");
498 s->tabsize *= glyph->advance;
500 if (s->exp_mode == EXP_STRFTIME &&
501 (strchr(s->text, '%') || strchr(s->text, '\\')))
502 av_log(ctx, AV_LOG_WARNING, "expansion=strftime is deprecated.\n");
504 av_bprint_init(&s->expanded_text, 0, AV_BPRINT_SIZE_UNLIMITED);
509 static int query_formats(AVFilterContext *ctx)
511 ff_set_common_formats(ctx, ff_draw_supported_pixel_formats(0));
515 static int glyph_enu_free(void *opaque, void *elem)
519 FT_Done_Glyph(*glyph->glyph);
520 av_freep(&glyph->glyph);
525 static av_cold void uninit(AVFilterContext *ctx)
527 DrawTextContext *s = ctx->priv;
529 av_expr_free(s->x_pexpr);
530 av_expr_free(s->y_pexpr);
531 #if FF_API_DRAWTEXT_OLD_TIMELINE
532 av_expr_free(s->draw_pexpr);
533 s->x_pexpr = s->y_pexpr = s->draw_pexpr = NULL;
535 av_freep(&s->positions);
539 av_tree_enumerate(s->glyphs, NULL, NULL, glyph_enu_free);
540 av_tree_destroy(s->glyphs);
543 FT_Done_Face(s->face);
544 FT_Done_FreeType(s->library);
546 av_bprint_finalize(&s->expanded_text, NULL);
549 static inline int is_newline(uint32_t c)
551 return c == '\n' || c == '\r' || c == '\f' || c == '\v';
554 static int config_input(AVFilterLink *inlink)
556 AVFilterContext *ctx = inlink->dst;
557 DrawTextContext *s = ctx->priv;
560 ff_draw_init(&s->dc, inlink->format, 0);
561 ff_draw_color(&s->dc, &s->fontcolor, s->fontcolor.rgba);
562 ff_draw_color(&s->dc, &s->shadowcolor, s->shadowcolor.rgba);
563 ff_draw_color(&s->dc, &s->boxcolor, s->boxcolor.rgba);
565 s->var_values[VAR_w] = s->var_values[VAR_W] = s->var_values[VAR_MAIN_W] = inlink->w;
566 s->var_values[VAR_h] = s->var_values[VAR_H] = s->var_values[VAR_MAIN_H] = inlink->h;
567 s->var_values[VAR_SAR] = inlink->sample_aspect_ratio.num ? av_q2d(inlink->sample_aspect_ratio) : 1;
568 s->var_values[VAR_DAR] = (double)inlink->w / inlink->h * s->var_values[VAR_SAR];
569 s->var_values[VAR_HSUB] = 1 << s->dc.hsub_max;
570 s->var_values[VAR_VSUB] = 1 << s->dc.vsub_max;
571 s->var_values[VAR_X] = NAN;
572 s->var_values[VAR_Y] = NAN;
573 s->var_values[VAR_T] = NAN;
575 av_lfg_init(&s->prng, av_get_random_seed());
577 av_expr_free(s->x_pexpr);
578 av_expr_free(s->y_pexpr);
579 #if FF_API_DRAWTEXT_OLD_TIMELINE
580 av_expr_free(s->draw_pexpr);
581 s->x_pexpr = s->y_pexpr = s->draw_pexpr = NULL;
583 s->x_pexpr = s->y_pexpr = NULL;
586 if ((ret = av_expr_parse(&s->x_pexpr, s->x_expr, var_names,
587 NULL, NULL, fun2_names, fun2, 0, ctx)) < 0 ||
588 (ret = av_expr_parse(&s->y_pexpr, s->y_expr, var_names,
589 NULL, NULL, fun2_names, fun2, 0, ctx)) < 0)
591 return AVERROR(EINVAL);
592 #if FF_API_DRAWTEXT_OLD_TIMELINE
594 (ret = av_expr_parse(&s->draw_pexpr, s->draw_expr, var_names,
595 NULL, NULL, fun2_names, fun2, 0, ctx)) < 0)
602 static int command(AVFilterContext *ctx, const char *cmd, const char *arg, char *res, int res_len, int flags)
604 DrawTextContext *s = ctx->priv;
606 if (!strcmp(cmd, "reinit")) {
610 if ((ret = init(ctx)) < 0)
612 return config_input(ctx->inputs[0]);
615 return AVERROR(ENOSYS);
618 static int func_pict_type(AVFilterContext *ctx, AVBPrint *bp,
619 char *fct, unsigned argc, char **argv, int tag)
621 DrawTextContext *s = ctx->priv;
623 av_bprintf(bp, "%c", av_get_picture_type_char(s->var_values[VAR_PICT_TYPE]));
627 static int func_pts(AVFilterContext *ctx, AVBPrint *bp,
628 char *fct, unsigned argc, char **argv, int tag)
630 DrawTextContext *s = ctx->priv;
632 av_bprintf(bp, "%.6f", s->var_values[VAR_T]);
636 static int func_frame_num(AVFilterContext *ctx, AVBPrint *bp,
637 char *fct, unsigned argc, char **argv, int tag)
639 DrawTextContext *s = ctx->priv;
641 av_bprintf(bp, "%d", (int)s->var_values[VAR_N]);
645 static int func_metadata(AVFilterContext *ctx, AVBPrint *bp,
646 char *fct, unsigned argc, char **argv, int tag)
648 DrawTextContext *s = ctx->priv;
649 AVDictionaryEntry *e = av_dict_get(s->metadata, argv[0], NULL, 0);
652 av_bprintf(bp, "%s", e->value);
656 #if !HAVE_LOCALTIME_R
657 static void localtime_r(const time_t *t, struct tm *tm)
663 static int func_strftime(AVFilterContext *ctx, AVBPrint *bp,
664 char *fct, unsigned argc, char **argv, int tag)
666 const char *fmt = argc ? argv[0] : "%Y-%m-%d %H:%M:%S";
672 localtime_r(&now, &tm);
675 av_bprint_strftime(bp, fmt, &tm);
679 static int func_eval_expr(AVFilterContext *ctx, AVBPrint *bp,
680 char *fct, unsigned argc, char **argv, int tag)
682 DrawTextContext *s = ctx->priv;
686 ret = av_expr_parse_and_eval(&res, argv[0], var_names, s->var_values,
687 NULL, NULL, fun2_names, fun2,
690 av_log(ctx, AV_LOG_ERROR,
691 "Expression '%s' for the expr text expansion function is not valid\n",
694 av_bprintf(bp, "%f", res);
699 static const struct drawtext_function {
701 unsigned argc_min, argc_max;
702 int tag; /**< opaque argument to func */
703 int (*func)(AVFilterContext *, AVBPrint *, char *, unsigned, char **, int);
705 { "expr", 1, 1, 0, func_eval_expr },
706 { "e", 1, 1, 0, func_eval_expr },
707 { "pict_type", 0, 0, 0, func_pict_type },
708 { "pts", 0, 0, 0, func_pts },
709 { "gmtime", 0, 1, 'G', func_strftime },
710 { "localtime", 0, 1, 'L', func_strftime },
711 { "frame_num", 0, 0, 0, func_frame_num },
712 { "n", 0, 0, 0, func_frame_num },
713 { "metadata", 1, 1, 0, func_metadata },
716 static int eval_function(AVFilterContext *ctx, AVBPrint *bp, char *fct,
717 unsigned argc, char **argv)
721 for (i = 0; i < FF_ARRAY_ELEMS(functions); i++) {
722 if (strcmp(fct, functions[i].name))
724 if (argc < functions[i].argc_min) {
725 av_log(ctx, AV_LOG_ERROR, "%%{%s} requires at least %d arguments\n",
726 fct, functions[i].argc_min);
727 return AVERROR(EINVAL);
729 if (argc > functions[i].argc_max) {
730 av_log(ctx, AV_LOG_ERROR, "%%{%s} requires at most %d arguments\n",
731 fct, functions[i].argc_max);
732 return AVERROR(EINVAL);
736 if (i >= FF_ARRAY_ELEMS(functions)) {
737 av_log(ctx, AV_LOG_ERROR, "%%{%s} is not known\n", fct);
738 return AVERROR(EINVAL);
740 return functions[i].func(ctx, bp, fct, argc, argv, functions[i].tag);
743 static int expand_function(AVFilterContext *ctx, AVBPrint *bp, char **rtext)
745 const char *text = *rtext;
746 char *argv[16] = { NULL };
747 unsigned argc = 0, i;
751 av_log(ctx, AV_LOG_ERROR, "Stray %% near '%s'\n", text);
752 return AVERROR(EINVAL);
756 if (!(argv[argc++] = av_get_token(&text, ":}"))) {
757 ret = AVERROR(ENOMEM);
761 av_log(ctx, AV_LOG_ERROR, "Unterminated %%{} near '%s'\n", *rtext);
762 ret = AVERROR(EINVAL);
765 if (argc == FF_ARRAY_ELEMS(argv))
766 av_freep(&argv[--argc]); /* error will be caught later */
772 if ((ret = eval_function(ctx, bp, argv[0], argc - 1, argv + 1)) < 0)
775 *rtext = (char *)text + 1;
778 for (i = 0; i < argc; i++)
783 static int expand_text(AVFilterContext *ctx)
785 DrawTextContext *s = ctx->priv;
786 char *text = s->text;
787 AVBPrint *bp = &s->expanded_text;
792 if (*text == '\\' && text[1]) {
793 av_bprint_chars(bp, text[1], 1);
795 } else if (*text == '%') {
797 if ((ret = expand_function(ctx, bp, &text)) < 0)
800 av_bprint_chars(bp, *text, 1);
804 if (!av_bprint_is_complete(bp))
805 return AVERROR(ENOMEM);
809 static int draw_glyphs(DrawTextContext *s, AVFrame *frame,
810 int width, int height, const uint8_t rgbcolor[4], FFDrawColor *color, int x, int y)
812 char *text = s->expanded_text.str;
818 for (i = 0, p = text; *p; i++) {
820 GET_UTF8(code, *p++, continue;);
822 /* skip new line chars, just go to new line */
823 if (code == '\n' || code == '\r' || code == '\t')
827 glyph = av_tree_find(s->glyphs, &dummy, (void *)glyph_cmp, NULL);
829 if (glyph->bitmap.pixel_mode != FT_PIXEL_MODE_MONO &&
830 glyph->bitmap.pixel_mode != FT_PIXEL_MODE_GRAY)
831 return AVERROR(EINVAL);
833 x1 = s->positions[i].x+s->x+x;
834 y1 = s->positions[i].y+s->y+y;
836 ff_blend_mask(&s->dc, color,
837 frame->data, frame->linesize, width, height,
838 glyph->bitmap.buffer, glyph->bitmap.pitch,
839 glyph->bitmap.width, glyph->bitmap.rows,
840 glyph->bitmap.pixel_mode == FT_PIXEL_MODE_MONO ? 0 : 3,
847 static int draw_text(AVFilterContext *ctx, AVFrame *frame,
848 int width, int height)
850 DrawTextContext *s = ctx->priv;
851 AVFilterLink *inlink = ctx->inputs[0];
853 uint32_t code = 0, prev_code = 0;
854 int x = 0, y = 0, i = 0, ret;
855 int max_text_line_w = 0, len;
859 int y_min = 32000, y_max = -32000;
860 int x_min = 32000, x_max = -32000;
862 Glyph *glyph = NULL, *prev_glyph = NULL;
865 time_t now = time(0);
867 AVBPrint *bp = &s->expanded_text;
871 if(s->basetime != AV_NOPTS_VALUE)
872 now= frame->pts*av_q2d(ctx->inputs[0]->time_base) + s->basetime/1000000;
874 switch (s->exp_mode) {
876 av_bprintf(bp, "%s", s->text);
879 if ((ret = expand_text(ctx)) < 0)
883 localtime_r(&now, <ime);
884 av_bprint_strftime(bp, s->text, <ime);
888 if (s->tc_opt_string) {
889 char tcbuf[AV_TIMECODE_STR_SIZE];
890 av_timecode_make_string(&s->tc, tcbuf, inlink->frame_count);
892 av_bprintf(bp, "%s%s", s->text, tcbuf);
895 if (!av_bprint_is_complete(bp))
896 return AVERROR(ENOMEM);
897 text = s->expanded_text.str;
898 if ((len = s->expanded_text.len) > s->nb_positions) {
900 av_realloc(s->positions, len*sizeof(*s->positions))))
901 return AVERROR(ENOMEM);
902 s->nb_positions = len;
908 /* load and cache glyphs */
909 for (i = 0, p = text; *p; i++) {
910 GET_UTF8(code, *p++, continue;);
914 glyph = av_tree_find(s->glyphs, &dummy, glyph_cmp, NULL);
916 load_glyph(ctx, &glyph, code);
919 y_min = FFMIN(glyph->bbox.yMin, y_min);
920 y_max = FFMAX(glyph->bbox.yMax, y_max);
921 x_min = FFMIN(glyph->bbox.xMin, x_min);
922 x_max = FFMAX(glyph->bbox.xMax, x_max);
924 s->max_glyph_h = y_max - y_min;
925 s->max_glyph_w = x_max - x_min;
927 /* compute and save position for each glyph */
929 for (i = 0, p = text; *p; i++) {
930 GET_UTF8(code, *p++, continue;);
932 /* skip the \n in the sequence \r\n */
933 if (prev_code == '\r' && code == '\n')
937 if (is_newline(code)) {
939 max_text_line_w = FFMAX(max_text_line_w, x);
948 glyph = av_tree_find(s->glyphs, &dummy, glyph_cmp, NULL);
951 if (s->use_kerning && prev_glyph && glyph->code) {
952 FT_Get_Kerning(s->face, prev_glyph->code, glyph->code,
953 ft_kerning_default, &delta);
958 s->positions[i].x = x + glyph->bitmap_left;
959 s->positions[i].y = y - glyph->bitmap_top + y_max;
960 if (code == '\t') x = (x / s->tabsize + 1)*s->tabsize;
961 else x += glyph->advance;
964 max_text_line_w = FFMAX(x, max_text_line_w);
966 s->var_values[VAR_TW] = s->var_values[VAR_TEXT_W] = max_text_line_w;
967 s->var_values[VAR_TH] = s->var_values[VAR_TEXT_H] = y + s->max_glyph_h;
969 s->var_values[VAR_MAX_GLYPH_W] = s->max_glyph_w;
970 s->var_values[VAR_MAX_GLYPH_H] = s->max_glyph_h;
971 s->var_values[VAR_MAX_GLYPH_A] = s->var_values[VAR_ASCENT ] = y_max;
972 s->var_values[VAR_MAX_GLYPH_D] = s->var_values[VAR_DESCENT] = y_min;
974 s->var_values[VAR_LINE_H] = s->var_values[VAR_LH] = s->max_glyph_h;
976 s->x = s->var_values[VAR_X] = av_expr_eval(s->x_pexpr, s->var_values, &s->prng);
977 s->y = s->var_values[VAR_Y] = av_expr_eval(s->y_pexpr, s->var_values, &s->prng);
978 s->x = s->var_values[VAR_X] = av_expr_eval(s->x_pexpr, s->var_values, &s->prng);
979 #if FF_API_DRAWTEXT_OLD_TIMELINE
981 s->draw = av_expr_eval(s->draw_pexpr, s->var_values, &s->prng);
986 if (ctx->is_disabled)
990 box_w = FFMIN(width - 1 , max_text_line_w);
991 box_h = FFMIN(height - 1, y + s->max_glyph_h);
995 ff_blend_rectangle(&s->dc, &s->boxcolor,
996 frame->data, frame->linesize, width, height,
997 s->x, s->y, box_w, box_h);
999 if (s->shadowx || s->shadowy) {
1000 if ((ret = draw_glyphs(s, frame, width, height, s->shadowcolor.rgba,
1001 &s->shadowcolor, s->shadowx, s->shadowy)) < 0)
1005 if ((ret = draw_glyphs(s, frame, width, height, s->fontcolor.rgba,
1006 &s->fontcolor, 0, 0)) < 0)
1012 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
1014 AVFilterContext *ctx = inlink->dst;
1015 AVFilterLink *outlink = ctx->outputs[0];
1016 DrawTextContext *s = ctx->priv;
1020 if ((ret = load_textfile(ctx)) < 0)
1023 s->var_values[VAR_N] = inlink->frame_count+s->start_number;
1024 s->var_values[VAR_T] = frame->pts == AV_NOPTS_VALUE ?
1025 NAN : frame->pts * av_q2d(inlink->time_base);
1027 s->var_values[VAR_PICT_TYPE] = frame->pict_type;
1028 s->metadata = av_frame_get_metadata(frame);
1030 draw_text(ctx, frame, frame->width, frame->height);
1032 av_log(ctx, AV_LOG_DEBUG, "n:%d t:%f text_w:%d text_h:%d x:%d y:%d\n",
1033 (int)s->var_values[VAR_N], s->var_values[VAR_T],
1034 (int)s->var_values[VAR_TEXT_W], (int)s->var_values[VAR_TEXT_H],
1037 return ff_filter_frame(outlink, frame);
1040 static const AVFilterPad avfilter_vf_drawtext_inputs[] = {
1043 .type = AVMEDIA_TYPE_VIDEO,
1044 .filter_frame = filter_frame,
1045 .config_props = config_input,
1046 .needs_writable = 1,
1051 static const AVFilterPad avfilter_vf_drawtext_outputs[] = {
1054 .type = AVMEDIA_TYPE_VIDEO,
1059 AVFilter ff_vf_drawtext = {
1061 .description = NULL_IF_CONFIG_SMALL("Draw text on top of video frames using libfreetype library."),
1062 .priv_size = sizeof(DrawTextContext),
1063 .priv_class = &drawtext_class,
1066 .query_formats = query_formats,
1067 .inputs = avfilter_vf_drawtext_inputs,
1068 .outputs = avfilter_vf_drawtext_outputs,
1069 .process_command = command,
1070 #if FF_API_DRAWTEXT_OLD_TIMELINE
1071 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL,
1073 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,