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
34 #include <sys/types.h>
39 #if CONFIG_LIBFONTCONFIG
40 #include <fontconfig/fontconfig.h>
43 #include "libavutil/avstring.h"
44 #include "libavutil/bprint.h"
45 #include "libavutil/common.h"
46 #include "libavutil/file.h"
47 #include "libavutil/eval.h"
48 #include "libavutil/opt.h"
49 #include "libavutil/random_seed.h"
50 #include "libavutil/parseutils.h"
51 #include "libavutil/timecode.h"
52 #include "libavutil/tree.h"
53 #include "libavutil/lfg.h"
55 #include "drawutils.h"
61 #include FT_FREETYPE_H
65 static const char *const var_names[] = {
68 "line_h", "lh", ///< line height, same as max_glyph_h
69 "main_h", "h", "H", ///< height of the input video
70 "main_w", "w", "W", ///< width of the input video
71 "max_glyph_a", "ascent", ///< max glyph ascent
72 "max_glyph_d", "descent", ///< min glyph descent
73 "max_glyph_h", ///< max glyph height
74 "max_glyph_w", ///< max glyph width
75 "n", ///< number of frame
77 "t", ///< timestamp expressed in seconds
78 "text_h", "th", ///< height of the rendered text
79 "text_w", "tw", ///< width of the rendered text
86 static const char *const fun2_names[] = {
90 static double drand(void *opaque, double min, double max)
92 return min + (max-min) / UINT_MAX * av_lfg_get(opaque);
95 typedef double (*eval_func2)(void *, double a, double b);
97 static const eval_func2 fun2[] = {
106 VAR_MAIN_H, VAR_h, VAR_H,
107 VAR_MAIN_W, VAR_w, VAR_W,
108 VAR_MAX_GLYPH_A, VAR_ASCENT,
109 VAR_MAX_GLYPH_D, VAR_DESCENT,
123 enum expansion_mode {
129 typedef struct DrawTextContext {
130 const AVClass *class;
131 enum expansion_mode exp_mode; ///< expansion mode to use for the text
132 int reinit; ///< tells if the filter is being reinited
133 #if CONFIG_LIBFONTCONFIG
134 uint8_t *font; ///< font to be used
136 uint8_t *fontfile; ///< font to be used
137 uint8_t *text; ///< text to be drawn
138 AVBPrint expanded_text; ///< used to contain the expanded text
139 int ft_load_flags; ///< flags used for loading fonts, see FT_LOAD_*
140 FT_Vector *positions; ///< positions for each element in the text
141 size_t nb_positions; ///< number of elements of positions array
142 char *textfile; ///< file with text to be drawn
143 int x; ///< x position to start drawing text
144 int y; ///< y position to start drawing text
145 int max_glyph_w; ///< max glyph width
146 int max_glyph_h; ///< max glyph height
147 int shadowx, shadowy;
148 int borderw; ///< border width
149 unsigned int fontsize; ///< font size to use
151 short int draw_box; ///< draw box around text - true or false
152 int use_kerning; ///< font kerning is used - true/false
153 int tabsize; ///< tab size
154 int fix_bounds; ///< do we let it go out of frame bounds - t/f
157 FFDrawColor fontcolor; ///< foreground color
158 FFDrawColor shadowcolor; ///< shadow color
159 FFDrawColor bordercolor; ///< border color
160 FFDrawColor boxcolor; ///< background color
162 FT_Library library; ///< freetype font library handle
163 FT_Face face; ///< freetype font face handle
164 FT_Stroker stroker; ///< freetype stroker handle
165 struct AVTreeNode *glyphs; ///< rendered glyphs, stored using the UTF-32 char code
166 char *x_expr; ///< expression for x position
167 char *y_expr; ///< expression for y position
168 AVExpr *x_pexpr, *y_pexpr; ///< parsed expressions for x and y
169 int64_t basetime; ///< base pts time in the real world for display
170 double var_values[VAR_VARS_NB];
171 #if FF_API_DRAWTEXT_OLD_TIMELINE
172 char *draw_expr; ///< expression for draw
173 AVExpr *draw_pexpr; ///< parsed expression for draw
174 int draw; ///< set to zero to prevent drawing
176 AVLFG prng; ///< random
177 char *tc_opt_string; ///< specified timecode option string
178 AVRational tc_rate; ///< frame rate for timecode
179 AVTimecode tc; ///< timecode context
180 int tc24hmax; ///< 1 if timecode is wrapped to 24 hours, 0 otherwise
181 int reload; ///< reload text file for each frame
182 int start_number; ///< starting frame number for n/frame_num var
183 AVDictionary *metadata;
186 #define OFFSET(x) offsetof(DrawTextContext, x)
187 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
189 static const AVOption drawtext_options[]= {
190 {"fontfile", "set font file", OFFSET(fontfile), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX, FLAGS},
191 {"text", "set text", OFFSET(text), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX, FLAGS},
192 {"textfile", "set text file", OFFSET(textfile), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX, FLAGS},
193 {"fontcolor", "set foreground color", OFFSET(fontcolor.rgba), AV_OPT_TYPE_COLOR, {.str="black"}, CHAR_MIN, CHAR_MAX, FLAGS},
194 {"boxcolor", "set box color", OFFSET(boxcolor.rgba), AV_OPT_TYPE_COLOR, {.str="white"}, CHAR_MIN, CHAR_MAX, FLAGS},
195 {"bordercolor", "set border color", OFFSET(bordercolor.rgba), AV_OPT_TYPE_COLOR, {.str="black"}, CHAR_MIN, CHAR_MAX, FLAGS},
196 {"shadowcolor", "set shadow color", OFFSET(shadowcolor.rgba), AV_OPT_TYPE_COLOR, {.str="black"}, CHAR_MIN, CHAR_MAX, FLAGS},
197 {"box", "set box", OFFSET(draw_box), AV_OPT_TYPE_INT, {.i64=0}, 0, 1 , FLAGS},
198 {"fontsize", "set font size", OFFSET(fontsize), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX , FLAGS},
199 {"x", "set x expression", OFFSET(x_expr), AV_OPT_TYPE_STRING, {.str="0"}, CHAR_MIN, CHAR_MAX, FLAGS},
200 {"y", "set y expression", OFFSET(y_expr), AV_OPT_TYPE_STRING, {.str="0"}, CHAR_MIN, CHAR_MAX, FLAGS},
201 {"shadowx", "set x", OFFSET(shadowx), AV_OPT_TYPE_INT, {.i64=0}, INT_MIN, INT_MAX , FLAGS},
202 {"shadowy", "set y", OFFSET(shadowy), AV_OPT_TYPE_INT, {.i64=0}, INT_MIN, INT_MAX , FLAGS},
203 {"borderw", "set border width", OFFSET(borderw), AV_OPT_TYPE_INT, {.i64=0}, INT_MIN, INT_MAX , FLAGS},
204 {"tabsize", "set tab size", OFFSET(tabsize), AV_OPT_TYPE_INT, {.i64=4}, 0, INT_MAX , FLAGS},
205 {"basetime", "set base time", OFFSET(basetime), AV_OPT_TYPE_INT64, {.i64=AV_NOPTS_VALUE}, INT64_MIN, INT64_MAX , FLAGS},
206 #if FF_API_DRAWTEXT_OLD_TIMELINE
207 {"draw", "if false do not draw (deprecated)", OFFSET(draw_expr), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX, FLAGS},
209 #if CONFIG_LIBFONTCONFIG
210 { "font", "Font name", OFFSET(font), AV_OPT_TYPE_STRING, { .str = "Sans" }, .flags = FLAGS },
213 {"expansion", "set the expansion mode", OFFSET(exp_mode), AV_OPT_TYPE_INT, {.i64=EXP_NORMAL}, 0, 2, FLAGS, "expansion"},
214 {"none", "set no expansion", OFFSET(exp_mode), AV_OPT_TYPE_CONST, {.i64=EXP_NONE}, 0, 0, FLAGS, "expansion"},
215 {"normal", "set normal expansion", OFFSET(exp_mode), AV_OPT_TYPE_CONST, {.i64=EXP_NORMAL}, 0, 0, FLAGS, "expansion"},
216 {"strftime", "set strftime expansion (deprecated)", OFFSET(exp_mode), AV_OPT_TYPE_CONST, {.i64=EXP_STRFTIME}, 0, 0, FLAGS, "expansion"},
218 {"timecode", "set initial timecode", OFFSET(tc_opt_string), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX, FLAGS},
219 {"tc24hmax", "set 24 hours max (timecode only)", OFFSET(tc24hmax), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS},
220 {"timecode_rate", "set rate (timecode only)", OFFSET(tc_rate), AV_OPT_TYPE_RATIONAL, {.dbl=0}, 0, INT_MAX, FLAGS},
221 {"r", "set rate (timecode only)", OFFSET(tc_rate), AV_OPT_TYPE_RATIONAL, {.dbl=0}, 0, INT_MAX, FLAGS},
222 {"rate", "set rate (timecode only)", OFFSET(tc_rate), AV_OPT_TYPE_RATIONAL, {.dbl=0}, 0, INT_MAX, FLAGS},
223 {"reload", "reload text file for each frame", OFFSET(reload), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS},
224 {"fix_bounds", "if true, check and fix text coords to avoid clipping", OFFSET(fix_bounds), AV_OPT_TYPE_INT, {.i64=1}, 0, 1, FLAGS},
225 {"start_number", "start frame number for n/frame_num variable", OFFSET(start_number), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, FLAGS},
227 /* FT_LOAD_* flags */
228 { "ft_load_flags", "set font loading flags for libfreetype", OFFSET(ft_load_flags), AV_OPT_TYPE_FLAGS, { .i64 = FT_LOAD_DEFAULT }, 0, INT_MAX, FLAGS, "ft_load_flags" },
229 { "default", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_DEFAULT }, .flags = FLAGS, .unit = "ft_load_flags" },
230 { "no_scale", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_SCALE }, .flags = FLAGS, .unit = "ft_load_flags" },
231 { "no_hinting", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_HINTING }, .flags = FLAGS, .unit = "ft_load_flags" },
232 { "render", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_RENDER }, .flags = FLAGS, .unit = "ft_load_flags" },
233 { "no_bitmap", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_BITMAP }, .flags = FLAGS, .unit = "ft_load_flags" },
234 { "vertical_layout", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_VERTICAL_LAYOUT }, .flags = FLAGS, .unit = "ft_load_flags" },
235 { "force_autohint", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_FORCE_AUTOHINT }, .flags = FLAGS, .unit = "ft_load_flags" },
236 { "crop_bitmap", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_CROP_BITMAP }, .flags = FLAGS, .unit = "ft_load_flags" },
237 { "pedantic", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_PEDANTIC }, .flags = FLAGS, .unit = "ft_load_flags" },
238 { "ignore_global_advance_width", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH }, .flags = FLAGS, .unit = "ft_load_flags" },
239 { "no_recurse", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_RECURSE }, .flags = FLAGS, .unit = "ft_load_flags" },
240 { "ignore_transform", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_IGNORE_TRANSFORM }, .flags = FLAGS, .unit = "ft_load_flags" },
241 { "monochrome", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_MONOCHROME }, .flags = FLAGS, .unit = "ft_load_flags" },
242 { "linear_design", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_LINEAR_DESIGN }, .flags = FLAGS, .unit = "ft_load_flags" },
243 { "no_autohint", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_AUTOHINT }, .flags = FLAGS, .unit = "ft_load_flags" },
247 AVFILTER_DEFINE_CLASS(drawtext);
249 #undef __FTERRORS_H__
250 #define FT_ERROR_START_LIST {
251 #define FT_ERRORDEF(e, v, s) { (e), (s) },
252 #define FT_ERROR_END_LIST { 0, NULL } };
258 } static ft_errors[] =
261 #define FT_ERRMSG(e) ft_errors[e].err_msg
263 typedef struct Glyph {
266 FT_Bitmap bitmap; ///< array holding bitmaps of font
267 FT_Bitmap border_bitmap; ///< array holding bitmaps of font border
274 static int glyph_cmp(void *key, const void *b)
276 const Glyph *a = key, *bb = b;
277 int64_t diff = (int64_t)a->code - (int64_t)bb->code;
278 return diff > 0 ? 1 : diff < 0 ? -1 : 0;
282 * Load glyphs corresponding to the UTF-32 codepoint code.
284 static int load_glyph(AVFilterContext *ctx, Glyph **glyph_ptr, uint32_t code)
286 DrawTextContext *s = ctx->priv;
287 FT_BitmapGlyph bitmapglyph;
289 struct AVTreeNode *node = NULL;
292 /* load glyph into s->face->glyph */
293 if (FT_Load_Char(s->face, code, s->ft_load_flags))
294 return AVERROR(EINVAL);
297 if (!(glyph = av_mallocz(sizeof(*glyph))) ||
298 !(glyph->glyph = av_mallocz(sizeof(*glyph->glyph)))) {
299 ret = AVERROR(ENOMEM);
304 if (FT_Get_Glyph(s->face->glyph, glyph->glyph)) {
305 ret = AVERROR(EINVAL);
309 FT_Glyph border_glyph = *glyph->glyph;
310 if (FT_Glyph_StrokeBorder(&border_glyph, s->stroker, 0, 0) ||
311 FT_Glyph_To_Bitmap(&border_glyph, FT_RENDER_MODE_NORMAL, 0, 1)) {
312 ret = AVERROR_EXTERNAL;
315 bitmapglyph = (FT_BitmapGlyph) border_glyph;
316 glyph->border_bitmap = bitmapglyph->bitmap;
318 if (FT_Glyph_To_Bitmap(glyph->glyph, FT_RENDER_MODE_NORMAL, 0, 1)) {
319 ret = AVERROR_EXTERNAL;
322 bitmapglyph = (FT_BitmapGlyph) *glyph->glyph;
324 glyph->bitmap = bitmapglyph->bitmap;
325 glyph->bitmap_left = bitmapglyph->left;
326 glyph->bitmap_top = bitmapglyph->top;
327 glyph->advance = s->face->glyph->advance.x >> 6;
329 /* measure text height to calculate text_height (or the maximum text height) */
330 FT_Glyph_Get_CBox(*glyph->glyph, ft_glyph_bbox_pixels, &glyph->bbox);
332 /* cache the newly created glyph */
333 if (!(node = av_tree_node_alloc())) {
334 ret = AVERROR(ENOMEM);
337 av_tree_insert(&s->glyphs, glyph, glyph_cmp, &node);
345 av_freep(&glyph->glyph);
351 static int load_font_file(AVFilterContext *ctx, const char *path, int index)
353 DrawTextContext *s = ctx->priv;
356 err = FT_New_Face(s->library, path, index, &s->face);
358 av_log(ctx, AV_LOG_ERROR, "Could not load font \"%s\": %s\n",
359 s->fontfile, FT_ERRMSG(err));
360 return AVERROR(EINVAL);
365 #if CONFIG_LIBFONTCONFIG
366 static int load_font_fontconfig(AVFilterContext *ctx)
368 DrawTextContext *s = ctx->priv;
369 FcConfig *fontconfig;
370 FcPattern *pat, *best;
371 FcResult result = FcResultMatch;
375 int err = AVERROR(ENOENT);
377 fontconfig = FcInitLoadConfigAndFonts();
379 av_log(ctx, AV_LOG_ERROR, "impossible to init fontconfig\n");
380 return AVERROR_UNKNOWN;
382 pat = FcNameParse(s->fontfile ? s->fontfile :
383 (uint8_t *)(intptr_t)"default");
385 av_log(ctx, AV_LOG_ERROR, "could not parse fontconfig pat");
386 return AVERROR(EINVAL);
389 FcPatternAddString(pat, FC_FAMILY, s->font);
391 FcPatternAddDouble(pat, FC_SIZE, (double)s->fontsize);
393 FcDefaultSubstitute(pat);
395 if (!FcConfigSubstitute(fontconfig, pat, FcMatchPattern)) {
396 av_log(ctx, AV_LOG_ERROR, "could not substitue fontconfig options"); /* very unlikely */
397 FcPatternDestroy(pat);
398 return AVERROR(ENOMEM);
401 best = FcFontMatch(fontconfig, pat, &result);
402 FcPatternDestroy(pat);
404 if (!best || result != FcResultMatch) {
405 av_log(ctx, AV_LOG_ERROR,
406 "Cannot find a valid font for the family %s\n",
412 FcPatternGetInteger(best, FC_INDEX, 0, &index ) != FcResultMatch ||
413 FcPatternGetDouble (best, FC_SIZE, 0, &size ) != FcResultMatch) {
414 av_log(ctx, AV_LOG_ERROR, "impossible to find font information");
415 return AVERROR(EINVAL);
418 if (FcPatternGetString(best, FC_FILE, 0, &filename) != FcResultMatch) {
419 av_log(ctx, AV_LOG_ERROR, "No file path for %s\n",
424 av_log(ctx, AV_LOG_INFO, "Using \"%s\"\n", filename);
426 s->fontsize = size + 0.5;
428 err = load_font_file(ctx, filename, index);
431 FcConfigDestroy(fontconfig);
433 FcPatternDestroy(best);
438 static int load_font(AVFilterContext *ctx)
440 DrawTextContext *s = ctx->priv;
443 /* load the face, and set up the encoding, which is by default UTF-8 */
444 err = load_font_file(ctx, s->fontfile, 0);
447 #if CONFIG_LIBFONTCONFIG
448 err = load_font_fontconfig(ctx);
455 static int load_textfile(AVFilterContext *ctx)
457 DrawTextContext *s = ctx->priv;
462 if ((err = av_file_map(s->textfile, &textbuf, &textbuf_size, 0, ctx)) < 0) {
463 av_log(ctx, AV_LOG_ERROR,
464 "The text file '%s' could not be read or is empty\n",
469 if (!(s->text = av_realloc(s->text, textbuf_size + 1)))
470 return AVERROR(ENOMEM);
471 memcpy(s->text, textbuf, textbuf_size);
472 s->text[textbuf_size] = 0;
473 av_file_unmap(textbuf, textbuf_size);
478 static av_cold int init(AVFilterContext *ctx)
481 DrawTextContext *s = ctx->priv;
484 #if FF_API_DRAWTEXT_OLD_TIMELINE
486 av_log(ctx, AV_LOG_WARNING, "'draw' option is deprecated and will be removed soon, "
487 "you are encouraged to use the generic timeline support through the 'enable' option\n");
490 if (!s->fontfile && !CONFIG_LIBFONTCONFIG) {
491 av_log(ctx, AV_LOG_ERROR, "No font filename provided\n");
492 return AVERROR(EINVAL);
497 av_log(ctx, AV_LOG_ERROR,
498 "Both text and text file provided. Please provide only one\n");
499 return AVERROR(EINVAL);
501 if ((err = load_textfile(ctx)) < 0)
505 if (s->reload && !s->textfile)
506 av_log(ctx, AV_LOG_WARNING, "No file to reload\n");
508 if (s->tc_opt_string) {
509 int ret = av_timecode_init_from_string(&s->tc, s->tc_rate,
510 s->tc_opt_string, ctx);
514 s->tc.flags |= AV_TIMECODE_FLAG_24HOURSMAX;
516 s->text = av_strdup("");
520 av_log(ctx, AV_LOG_ERROR,
521 "Either text, a valid file or a timecode must be provided\n");
522 return AVERROR(EINVAL);
525 if ((err = FT_Init_FreeType(&(s->library)))) {
526 av_log(ctx, AV_LOG_ERROR,
527 "Could not load FreeType: %s\n", FT_ERRMSG(err));
528 return AVERROR(EINVAL);
531 err = load_font(ctx);
536 if ((err = FT_Set_Pixel_Sizes(s->face, 0, s->fontsize))) {
537 av_log(ctx, AV_LOG_ERROR, "Could not set font size to %d pixels: %s\n",
538 s->fontsize, FT_ERRMSG(err));
539 return AVERROR(EINVAL);
543 if (FT_Stroker_New(s->library, &s->stroker)) {
544 av_log(ctx, AV_LOG_ERROR, "Coult not init FT stroker\n");
545 return AVERROR_EXTERNAL;
547 FT_Stroker_Set(s->stroker, s->borderw << 6, FT_STROKER_LINECAP_ROUND,
548 FT_STROKER_LINEJOIN_ROUND, 0);
551 s->use_kerning = FT_HAS_KERNING(s->face);
553 /* load the fallback glyph with code 0 */
554 load_glyph(ctx, NULL, 0);
556 /* set the tabsize in pixels */
557 if ((err = load_glyph(ctx, &glyph, ' ')) < 0) {
558 av_log(ctx, AV_LOG_ERROR, "Could not set tabsize.\n");
561 s->tabsize *= glyph->advance;
563 if (s->exp_mode == EXP_STRFTIME &&
564 (strchr(s->text, '%') || strchr(s->text, '\\')))
565 av_log(ctx, AV_LOG_WARNING, "expansion=strftime is deprecated.\n");
567 av_bprint_init(&s->expanded_text, 0, AV_BPRINT_SIZE_UNLIMITED);
572 static int query_formats(AVFilterContext *ctx)
574 ff_set_common_formats(ctx, ff_draw_supported_pixel_formats(0));
578 static int glyph_enu_free(void *opaque, void *elem)
582 FT_Done_Glyph(*glyph->glyph);
583 av_freep(&glyph->glyph);
588 static av_cold void uninit(AVFilterContext *ctx)
590 DrawTextContext *s = ctx->priv;
592 av_expr_free(s->x_pexpr);
593 av_expr_free(s->y_pexpr);
594 #if FF_API_DRAWTEXT_OLD_TIMELINE
595 av_expr_free(s->draw_pexpr);
596 s->x_pexpr = s->y_pexpr = s->draw_pexpr = NULL;
598 av_freep(&s->positions);
602 av_tree_enumerate(s->glyphs, NULL, NULL, glyph_enu_free);
603 av_tree_destroy(s->glyphs);
606 FT_Done_Face(s->face);
607 FT_Stroker_Done(s->stroker);
608 FT_Done_FreeType(s->library);
610 av_bprint_finalize(&s->expanded_text, NULL);
613 static inline int is_newline(uint32_t c)
615 return c == '\n' || c == '\r' || c == '\f' || c == '\v';
618 static int config_input(AVFilterLink *inlink)
620 AVFilterContext *ctx = inlink->dst;
621 DrawTextContext *s = ctx->priv;
624 ff_draw_init(&s->dc, inlink->format, 0);
625 ff_draw_color(&s->dc, &s->fontcolor, s->fontcolor.rgba);
626 ff_draw_color(&s->dc, &s->shadowcolor, s->shadowcolor.rgba);
627 ff_draw_color(&s->dc, &s->bordercolor, s->bordercolor.rgba);
628 ff_draw_color(&s->dc, &s->boxcolor, s->boxcolor.rgba);
630 s->var_values[VAR_w] = s->var_values[VAR_W] = s->var_values[VAR_MAIN_W] = inlink->w;
631 s->var_values[VAR_h] = s->var_values[VAR_H] = s->var_values[VAR_MAIN_H] = inlink->h;
632 s->var_values[VAR_SAR] = inlink->sample_aspect_ratio.num ? av_q2d(inlink->sample_aspect_ratio) : 1;
633 s->var_values[VAR_DAR] = (double)inlink->w / inlink->h * s->var_values[VAR_SAR];
634 s->var_values[VAR_HSUB] = 1 << s->dc.hsub_max;
635 s->var_values[VAR_VSUB] = 1 << s->dc.vsub_max;
636 s->var_values[VAR_X] = NAN;
637 s->var_values[VAR_Y] = NAN;
638 s->var_values[VAR_T] = NAN;
640 av_lfg_init(&s->prng, av_get_random_seed());
642 av_expr_free(s->x_pexpr);
643 av_expr_free(s->y_pexpr);
644 #if FF_API_DRAWTEXT_OLD_TIMELINE
645 av_expr_free(s->draw_pexpr);
646 s->x_pexpr = s->y_pexpr = s->draw_pexpr = NULL;
648 s->x_pexpr = s->y_pexpr = NULL;
651 if ((ret = av_expr_parse(&s->x_pexpr, s->x_expr, var_names,
652 NULL, NULL, fun2_names, fun2, 0, ctx)) < 0 ||
653 (ret = av_expr_parse(&s->y_pexpr, s->y_expr, var_names,
654 NULL, NULL, fun2_names, fun2, 0, ctx)) < 0)
656 return AVERROR(EINVAL);
657 #if FF_API_DRAWTEXT_OLD_TIMELINE
659 (ret = av_expr_parse(&s->draw_pexpr, s->draw_expr, var_names,
660 NULL, NULL, fun2_names, fun2, 0, ctx)) < 0)
667 static int command(AVFilterContext *ctx, const char *cmd, const char *arg, char *res, int res_len, int flags)
669 DrawTextContext *s = ctx->priv;
671 if (!strcmp(cmd, "reinit")) {
675 if ((ret = av_set_options_string(ctx, arg, "=", ":")) < 0)
677 if ((ret = init(ctx)) < 0)
679 return config_input(ctx->inputs[0]);
682 return AVERROR(ENOSYS);
685 static int func_pict_type(AVFilterContext *ctx, AVBPrint *bp,
686 char *fct, unsigned argc, char **argv, int tag)
688 DrawTextContext *s = ctx->priv;
690 av_bprintf(bp, "%c", av_get_picture_type_char(s->var_values[VAR_PICT_TYPE]));
694 static int func_pts(AVFilterContext *ctx, AVBPrint *bp,
695 char *fct, unsigned argc, char **argv, int tag)
697 DrawTextContext *s = ctx->priv;
699 av_bprintf(bp, "%.6f", s->var_values[VAR_T]);
703 static int func_frame_num(AVFilterContext *ctx, AVBPrint *bp,
704 char *fct, unsigned argc, char **argv, int tag)
706 DrawTextContext *s = ctx->priv;
708 av_bprintf(bp, "%d", (int)s->var_values[VAR_N]);
712 static int func_metadata(AVFilterContext *ctx, AVBPrint *bp,
713 char *fct, unsigned argc, char **argv, int tag)
715 DrawTextContext *s = ctx->priv;
716 AVDictionaryEntry *e = av_dict_get(s->metadata, argv[0], NULL, 0);
719 av_bprintf(bp, "%s", e->value);
723 #if !HAVE_LOCALTIME_R
724 static void localtime_r(const time_t *t, struct tm *tm)
730 static int func_strftime(AVFilterContext *ctx, AVBPrint *bp,
731 char *fct, unsigned argc, char **argv, int tag)
733 const char *fmt = argc ? argv[0] : "%Y-%m-%d %H:%M:%S";
739 localtime_r(&now, &tm);
742 av_bprint_strftime(bp, fmt, &tm);
746 static int func_eval_expr(AVFilterContext *ctx, AVBPrint *bp,
747 char *fct, unsigned argc, char **argv, int tag)
749 DrawTextContext *s = ctx->priv;
753 ret = av_expr_parse_and_eval(&res, argv[0], var_names, s->var_values,
754 NULL, NULL, fun2_names, fun2,
757 av_log(ctx, AV_LOG_ERROR,
758 "Expression '%s' for the expr text expansion function is not valid\n",
761 av_bprintf(bp, "%f", res);
766 static const struct drawtext_function {
768 unsigned argc_min, argc_max;
769 int tag; /**< opaque argument to func */
770 int (*func)(AVFilterContext *, AVBPrint *, char *, unsigned, char **, int);
772 { "expr", 1, 1, 0, func_eval_expr },
773 { "e", 1, 1, 0, func_eval_expr },
774 { "pict_type", 0, 0, 0, func_pict_type },
775 { "pts", 0, 0, 0, func_pts },
776 { "gmtime", 0, 1, 'G', func_strftime },
777 { "localtime", 0, 1, 'L', func_strftime },
778 { "frame_num", 0, 0, 0, func_frame_num },
779 { "n", 0, 0, 0, func_frame_num },
780 { "metadata", 1, 1, 0, func_metadata },
783 static int eval_function(AVFilterContext *ctx, AVBPrint *bp, char *fct,
784 unsigned argc, char **argv)
788 for (i = 0; i < FF_ARRAY_ELEMS(functions); i++) {
789 if (strcmp(fct, functions[i].name))
791 if (argc < functions[i].argc_min) {
792 av_log(ctx, AV_LOG_ERROR, "%%{%s} requires at least %d arguments\n",
793 fct, functions[i].argc_min);
794 return AVERROR(EINVAL);
796 if (argc > functions[i].argc_max) {
797 av_log(ctx, AV_LOG_ERROR, "%%{%s} requires at most %d arguments\n",
798 fct, functions[i].argc_max);
799 return AVERROR(EINVAL);
803 if (i >= FF_ARRAY_ELEMS(functions)) {
804 av_log(ctx, AV_LOG_ERROR, "%%{%s} is not known\n", fct);
805 return AVERROR(EINVAL);
807 return functions[i].func(ctx, bp, fct, argc, argv, functions[i].tag);
810 static int expand_function(AVFilterContext *ctx, AVBPrint *bp, char **rtext)
812 const char *text = *rtext;
813 char *argv[16] = { NULL };
814 unsigned argc = 0, i;
818 av_log(ctx, AV_LOG_ERROR, "Stray %% near '%s'\n", text);
819 return AVERROR(EINVAL);
823 if (!(argv[argc++] = av_get_token(&text, ":}"))) {
824 ret = AVERROR(ENOMEM);
828 av_log(ctx, AV_LOG_ERROR, "Unterminated %%{} near '%s'\n", *rtext);
829 ret = AVERROR(EINVAL);
832 if (argc == FF_ARRAY_ELEMS(argv))
833 av_freep(&argv[--argc]); /* error will be caught later */
839 if ((ret = eval_function(ctx, bp, argv[0], argc - 1, argv + 1)) < 0)
842 *rtext = (char *)text + 1;
845 for (i = 0; i < argc; i++)
850 static int expand_text(AVFilterContext *ctx)
852 DrawTextContext *s = ctx->priv;
853 char *text = s->text;
854 AVBPrint *bp = &s->expanded_text;
859 if (*text == '\\' && text[1]) {
860 av_bprint_chars(bp, text[1], 1);
862 } else if (*text == '%') {
864 if ((ret = expand_function(ctx, bp, &text)) < 0)
867 av_bprint_chars(bp, *text, 1);
871 if (!av_bprint_is_complete(bp))
872 return AVERROR(ENOMEM);
876 static int draw_glyphs(DrawTextContext *s, AVFrame *frame,
877 int width, int height, const uint8_t rgbcolor[4],
878 FFDrawColor *color, int x, int y, int borderw)
880 char *text = s->expanded_text.str;
886 for (i = 0, p = text; *p; i++) {
889 GET_UTF8(code, *p++, continue;);
891 /* skip new line chars, just go to new line */
892 if (code == '\n' || code == '\r' || code == '\t')
896 glyph = av_tree_find(s->glyphs, &dummy, (void *)glyph_cmp, NULL);
898 bitmap = borderw ? glyph->border_bitmap : glyph->bitmap;
900 if (glyph->bitmap.pixel_mode != FT_PIXEL_MODE_MONO &&
901 glyph->bitmap.pixel_mode != FT_PIXEL_MODE_GRAY)
902 return AVERROR(EINVAL);
904 x1 = s->positions[i].x+s->x+x - borderw;
905 y1 = s->positions[i].y+s->y+y - borderw;
907 ff_blend_mask(&s->dc, color,
908 frame->data, frame->linesize, width, height,
909 bitmap.buffer, bitmap.pitch,
910 bitmap.width, bitmap.rows,
911 bitmap.pixel_mode == FT_PIXEL_MODE_MONO ? 0 : 3,
918 static int draw_text(AVFilterContext *ctx, AVFrame *frame,
919 int width, int height)
921 DrawTextContext *s = ctx->priv;
922 AVFilterLink *inlink = ctx->inputs[0];
924 uint32_t code = 0, prev_code = 0;
925 int x = 0, y = 0, i = 0, ret;
926 int max_text_line_w = 0, len;
930 int y_min = 32000, y_max = -32000;
931 int x_min = 32000, x_max = -32000;
933 Glyph *glyph = NULL, *prev_glyph = NULL;
936 time_t now = time(0);
938 AVBPrint *bp = &s->expanded_text;
942 if(s->basetime != AV_NOPTS_VALUE)
943 now= frame->pts*av_q2d(ctx->inputs[0]->time_base) + s->basetime/1000000;
945 switch (s->exp_mode) {
947 av_bprintf(bp, "%s", s->text);
950 if ((ret = expand_text(ctx)) < 0)
954 localtime_r(&now, <ime);
955 av_bprint_strftime(bp, s->text, <ime);
959 if (s->tc_opt_string) {
960 char tcbuf[AV_TIMECODE_STR_SIZE];
961 av_timecode_make_string(&s->tc, tcbuf, inlink->frame_count);
963 av_bprintf(bp, "%s%s", s->text, tcbuf);
966 if (!av_bprint_is_complete(bp))
967 return AVERROR(ENOMEM);
968 text = s->expanded_text.str;
969 if ((len = s->expanded_text.len) > s->nb_positions) {
971 av_realloc(s->positions, len*sizeof(*s->positions))))
972 return AVERROR(ENOMEM);
973 s->nb_positions = len;
979 /* load and cache glyphs */
980 for (i = 0, p = text; *p; i++) {
981 GET_UTF8(code, *p++, continue;);
985 glyph = av_tree_find(s->glyphs, &dummy, glyph_cmp, NULL);
987 load_glyph(ctx, &glyph, code);
990 y_min = FFMIN(glyph->bbox.yMin, y_min);
991 y_max = FFMAX(glyph->bbox.yMax, y_max);
992 x_min = FFMIN(glyph->bbox.xMin, x_min);
993 x_max = FFMAX(glyph->bbox.xMax, x_max);
995 s->max_glyph_h = y_max - y_min;
996 s->max_glyph_w = x_max - x_min;
998 /* compute and save position for each glyph */
1000 for (i = 0, p = text; *p; i++) {
1001 GET_UTF8(code, *p++, continue;);
1003 /* skip the \n in the sequence \r\n */
1004 if (prev_code == '\r' && code == '\n')
1008 if (is_newline(code)) {
1010 max_text_line_w = FFMAX(max_text_line_w, x);
1011 y += s->max_glyph_h;
1019 glyph = av_tree_find(s->glyphs, &dummy, glyph_cmp, NULL);
1022 if (s->use_kerning && prev_glyph && glyph->code) {
1023 FT_Get_Kerning(s->face, prev_glyph->code, glyph->code,
1024 ft_kerning_default, &delta);
1029 s->positions[i].x = x + glyph->bitmap_left;
1030 s->positions[i].y = y - glyph->bitmap_top + y_max;
1031 if (code == '\t') x = (x / s->tabsize + 1)*s->tabsize;
1032 else x += glyph->advance;
1035 max_text_line_w = FFMAX(x, max_text_line_w);
1037 s->var_values[VAR_TW] = s->var_values[VAR_TEXT_W] = max_text_line_w;
1038 s->var_values[VAR_TH] = s->var_values[VAR_TEXT_H] = y + s->max_glyph_h;
1040 s->var_values[VAR_MAX_GLYPH_W] = s->max_glyph_w;
1041 s->var_values[VAR_MAX_GLYPH_H] = s->max_glyph_h;
1042 s->var_values[VAR_MAX_GLYPH_A] = s->var_values[VAR_ASCENT ] = y_max;
1043 s->var_values[VAR_MAX_GLYPH_D] = s->var_values[VAR_DESCENT] = y_min;
1045 s->var_values[VAR_LINE_H] = s->var_values[VAR_LH] = s->max_glyph_h;
1047 s->x = s->var_values[VAR_X] = av_expr_eval(s->x_pexpr, s->var_values, &s->prng);
1048 s->y = s->var_values[VAR_Y] = av_expr_eval(s->y_pexpr, s->var_values, &s->prng);
1049 s->x = s->var_values[VAR_X] = av_expr_eval(s->x_pexpr, s->var_values, &s->prng);
1050 #if FF_API_DRAWTEXT_OLD_TIMELINE
1052 s->draw = av_expr_eval(s->draw_pexpr, s->var_values, &s->prng);
1057 if (ctx->is_disabled)
1061 box_w = FFMIN(width - 1 , max_text_line_w);
1062 box_h = FFMIN(height - 1, y + s->max_glyph_h);
1066 ff_blend_rectangle(&s->dc, &s->boxcolor,
1067 frame->data, frame->linesize, width, height,
1068 s->x, s->y, box_w, box_h);
1070 if (s->shadowx || s->shadowy) {
1071 if ((ret = draw_glyphs(s, frame, width, height, s->shadowcolor.rgba,
1072 &s->shadowcolor, s->shadowx, s->shadowy, 0)) < 0)
1077 if ((ret = draw_glyphs(s, frame, width, height, s->bordercolor.rgba,
1078 &s->bordercolor, 0, 0, s->borderw)) < 0)
1081 if ((ret = draw_glyphs(s, frame, width, height, s->fontcolor.rgba,
1082 &s->fontcolor, 0, 0, 0)) < 0)
1088 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
1090 AVFilterContext *ctx = inlink->dst;
1091 AVFilterLink *outlink = ctx->outputs[0];
1092 DrawTextContext *s = ctx->priv;
1096 if ((ret = load_textfile(ctx)) < 0)
1099 s->var_values[VAR_N] = inlink->frame_count+s->start_number;
1100 s->var_values[VAR_T] = frame->pts == AV_NOPTS_VALUE ?
1101 NAN : frame->pts * av_q2d(inlink->time_base);
1103 s->var_values[VAR_PICT_TYPE] = frame->pict_type;
1104 s->metadata = av_frame_get_metadata(frame);
1106 draw_text(ctx, frame, frame->width, frame->height);
1108 av_log(ctx, AV_LOG_DEBUG, "n:%d t:%f text_w:%d text_h:%d x:%d y:%d\n",
1109 (int)s->var_values[VAR_N], s->var_values[VAR_T],
1110 (int)s->var_values[VAR_TEXT_W], (int)s->var_values[VAR_TEXT_H],
1113 return ff_filter_frame(outlink, frame);
1116 static const AVFilterPad avfilter_vf_drawtext_inputs[] = {
1119 .type = AVMEDIA_TYPE_VIDEO,
1120 .filter_frame = filter_frame,
1121 .config_props = config_input,
1122 .needs_writable = 1,
1127 static const AVFilterPad avfilter_vf_drawtext_outputs[] = {
1130 .type = AVMEDIA_TYPE_VIDEO,
1135 AVFilter ff_vf_drawtext = {
1137 .description = NULL_IF_CONFIG_SMALL("Draw text on top of video frames using libfreetype library."),
1138 .priv_size = sizeof(DrawTextContext),
1139 .priv_class = &drawtext_class,
1142 .query_formats = query_formats,
1143 .inputs = avfilter_vf_drawtext_inputs,
1144 .outputs = avfilter_vf_drawtext_outputs,
1145 .process_command = command,
1146 #if FF_API_DRAWTEXT_OLD_TIMELINE
1147 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL,
1149 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,