FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
vf_drawtext.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011 Stefano Sabatini
3  * Copyright (c) 2010 S.N. Hemanth Meenakshisundaram
4  * Copyright (c) 2003 Gustavo Sverzut Barbieri <gsbarbieri@yahoo.com.br>
5  *
6  * This file is part of FFmpeg.
7  *
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.
12  *
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.
17  *
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
21  */
22 
23 /**
24  * @file
25  * drawtext filter, based on the original vhook/drawtext.c
26  * filter by Gustavo Sverzut Barbieri
27  */
28 
29 #include "config.h"
30 #if HAVE_SYS_TIME_H
31 #include <sys/time.h>
32 #endif
33 #include <time.h>
34 
35 #include "libavutil/avstring.h"
36 #include "libavutil/bprint.h"
37 #include "libavutil/common.h"
38 #include "libavutil/file.h"
39 #include "libavutil/eval.h"
40 #include "libavutil/opt.h"
41 #include "libavutil/random_seed.h"
42 #include "libavutil/parseutils.h"
43 #include "libavutil/timecode.h"
44 #include "libavutil/tree.h"
45 #include "libavutil/lfg.h"
46 #include "avfilter.h"
47 #include "drawutils.h"
48 #include "formats.h"
49 #include "internal.h"
50 #include "video.h"
51 
52 #include <ft2build.h>
53 #include FT_FREETYPE_H
54 #include FT_GLYPH_H
55 #include FT_STROKER_H
56 #if CONFIG_FONTCONFIG
57 #include <fontconfig/fontconfig.h>
58 #endif
59 
60 static const char *const var_names[] = {
61  "dar",
62  "hsub", "vsub",
63  "line_h", "lh", ///< line height, same as max_glyph_h
64  "main_h", "h", "H", ///< height of the input video
65  "main_w", "w", "W", ///< width of the input video
66  "max_glyph_a", "ascent", ///< max glyph ascent
67  "max_glyph_d", "descent", ///< min glyph descent
68  "max_glyph_h", ///< max glyph height
69  "max_glyph_w", ///< max glyph width
70  "n", ///< number of frame
71  "sar",
72  "t", ///< timestamp expressed in seconds
73  "text_h", "th", ///< height of the rendered text
74  "text_w", "tw", ///< width of the rendered text
75  "x",
76  "y",
77  "pict_type",
78  NULL
79 };
80 
81 static const char *const fun2_names[] = {
82  "rand"
83 };
84 
85 static double drand(void *opaque, double min, double max)
86 {
87  return min + (max-min) / UINT_MAX * av_lfg_get(opaque);
88 }
89 
90 typedef double (*eval_func2)(void *, double a, double b);
91 
92 static const eval_func2 fun2[] = {
93  drand,
94  NULL
95 };
96 
97 enum var_name {
116 };
117 
122 };
123 
124 typedef struct {
125  const AVClass *class;
126  enum expansion_mode exp_mode; ///< expansion mode to use for the text
127  int reinit; ///< tells if the filter is being reinited
128  uint8_t *fontfile; ///< font to be used
129  uint8_t *text; ///< text to be drawn
130  AVBPrint expanded_text; ///< used to contain the expanded text
131  int ft_load_flags; ///< flags used for loading fonts, see FT_LOAD_*
132  FT_Vector *positions; ///< positions for each element in the text
133  size_t nb_positions; ///< number of elements of positions array
134  char *textfile; ///< file with text to be drawn
135  int x; ///< x position to start drawing text
136  int y; ///< y position to start drawing text
137  int max_glyph_w; ///< max glyph width
138  int max_glyph_h; ///< max glyph height
139  int shadowx, shadowy;
140  int borderw; ///< border width
141  unsigned int fontsize; ///< font size to use
142 
143  short int draw_box; ///< draw box around text - true or false
144  int use_kerning; ///< font kerning is used - true/false
145  int tabsize; ///< tab size
146  int fix_bounds; ///< do we let it go out of frame bounds - t/f
147 
149  FFDrawColor fontcolor; ///< foreground color
150  FFDrawColor shadowcolor; ///< shadow color
151  FFDrawColor bordercolor; ///< border color
152  FFDrawColor boxcolor; ///< background color
153 
154  FT_Library library; ///< freetype font library handle
155  FT_Face face; ///< freetype font face handle
156  FT_Stroker stroker; ///< freetype stroker handle
157  struct AVTreeNode *glyphs; ///< rendered glyphs, stored using the UTF-32 char code
158  char *x_expr; ///< expression for x position
159  char *y_expr; ///< expression for y position
160  AVExpr *x_pexpr, *y_pexpr; ///< parsed expressions for x and y
161  int64_t basetime; ///< base pts time in the real world for display
162  double var_values[VAR_VARS_NB];
163 #if FF_API_DRAWTEXT_OLD_TIMELINE
164  char *draw_expr; ///< expression for draw
165  AVExpr *draw_pexpr; ///< parsed expression for draw
166  int draw; ///< set to zero to prevent drawing
167 #endif
168  AVLFG prng; ///< random
169  char *tc_opt_string; ///< specified timecode option string
170  AVRational tc_rate; ///< frame rate for timecode
171  AVTimecode tc; ///< timecode context
172  int tc24hmax; ///< 1 if timecode is wrapped to 24 hours, 0 otherwise
173  int reload; ///< reload text file for each frame
174  int start_number; ///< starting frame number for n/frame_num var
177 
178 #define OFFSET(x) offsetof(DrawTextContext, x)
179 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
180 
181 static const AVOption drawtext_options[]= {
182  {"fontfile", "set font file", OFFSET(fontfile), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX, FLAGS},
183  {"text", "set text", OFFSET(text), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX, FLAGS},
184  {"textfile", "set text file", OFFSET(textfile), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX, FLAGS},
185  {"fontcolor", "set foreground color", OFFSET(fontcolor.rgba), AV_OPT_TYPE_COLOR, {.str="black"}, CHAR_MIN, CHAR_MAX, FLAGS},
186  {"boxcolor", "set box color", OFFSET(boxcolor.rgba), AV_OPT_TYPE_COLOR, {.str="white"}, CHAR_MIN, CHAR_MAX, FLAGS},
187  {"bordercolor", "set border color", OFFSET(bordercolor.rgba), AV_OPT_TYPE_COLOR, {.str="black"}, CHAR_MIN, CHAR_MAX, FLAGS},
188  {"shadowcolor", "set shadow color", OFFSET(shadowcolor.rgba), AV_OPT_TYPE_COLOR, {.str="black"}, CHAR_MIN, CHAR_MAX, FLAGS},
189  {"box", "set box", OFFSET(draw_box), AV_OPT_TYPE_INT, {.i64=0}, 0, 1 , FLAGS},
190  {"fontsize", "set font size", OFFSET(fontsize), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX , FLAGS},
191  {"x", "set x expression", OFFSET(x_expr), AV_OPT_TYPE_STRING, {.str="0"}, CHAR_MIN, CHAR_MAX, FLAGS},
192  {"y", "set y expression", OFFSET(y_expr), AV_OPT_TYPE_STRING, {.str="0"}, CHAR_MIN, CHAR_MAX, FLAGS},
193  {"shadowx", "set x", OFFSET(shadowx), AV_OPT_TYPE_INT, {.i64=0}, INT_MIN, INT_MAX , FLAGS},
194  {"shadowy", "set y", OFFSET(shadowy), AV_OPT_TYPE_INT, {.i64=0}, INT_MIN, INT_MAX , FLAGS},
195  {"borderw", "set border width", OFFSET(borderw), AV_OPT_TYPE_INT, {.i64=0}, INT_MIN, INT_MAX , FLAGS},
196  {"tabsize", "set tab size", OFFSET(tabsize), AV_OPT_TYPE_INT, {.i64=4}, 0, INT_MAX , FLAGS},
197  {"basetime", "set base time", OFFSET(basetime), AV_OPT_TYPE_INT64, {.i64=AV_NOPTS_VALUE}, INT64_MIN, INT64_MAX , FLAGS},
198 #if FF_API_DRAWTEXT_OLD_TIMELINE
199  {"draw", "if false do not draw (deprecated)", OFFSET(draw_expr), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX, FLAGS},
200 #endif
201 
202  {"expansion", "set the expansion mode", OFFSET(exp_mode), AV_OPT_TYPE_INT, {.i64=EXP_NORMAL}, 0, 2, FLAGS, "expansion"},
203  {"none", "set no expansion", OFFSET(exp_mode), AV_OPT_TYPE_CONST, {.i64=EXP_NONE}, 0, 0, FLAGS, "expansion"},
204  {"normal", "set normal expansion", OFFSET(exp_mode), AV_OPT_TYPE_CONST, {.i64=EXP_NORMAL}, 0, 0, FLAGS, "expansion"},
205  {"strftime", "set strftime expansion (deprecated)", OFFSET(exp_mode), AV_OPT_TYPE_CONST, {.i64=EXP_STRFTIME}, 0, 0, FLAGS, "expansion"},
206 
207  {"timecode", "set initial timecode", OFFSET(tc_opt_string), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX, FLAGS},
208  {"tc24hmax", "set 24 hours max (timecode only)", OFFSET(tc24hmax), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS},
209  {"timecode_rate", "set rate (timecode only)", OFFSET(tc_rate), AV_OPT_TYPE_RATIONAL, {.dbl=0}, 0, INT_MAX, FLAGS},
210  {"r", "set rate (timecode only)", OFFSET(tc_rate), AV_OPT_TYPE_RATIONAL, {.dbl=0}, 0, INT_MAX, FLAGS},
211  {"rate", "set rate (timecode only)", OFFSET(tc_rate), AV_OPT_TYPE_RATIONAL, {.dbl=0}, 0, INT_MAX, FLAGS},
212  {"reload", "reload text file for each frame", OFFSET(reload), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS},
213  {"fix_bounds", "if true, check and fix text coords to avoid clipping", OFFSET(fix_bounds), AV_OPT_TYPE_INT, {.i64=1}, 0, 1, FLAGS},
214  {"start_number", "start frame number for n/frame_num variable", OFFSET(start_number), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, FLAGS},
215 
216  /* FT_LOAD_* flags */
217  { "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" },
218  { "default", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_DEFAULT }, .flags = FLAGS, .unit = "ft_load_flags" },
219  { "no_scale", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_SCALE }, .flags = FLAGS, .unit = "ft_load_flags" },
220  { "no_hinting", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_HINTING }, .flags = FLAGS, .unit = "ft_load_flags" },
221  { "render", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_RENDER }, .flags = FLAGS, .unit = "ft_load_flags" },
222  { "no_bitmap", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_BITMAP }, .flags = FLAGS, .unit = "ft_load_flags" },
223  { "vertical_layout", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_VERTICAL_LAYOUT }, .flags = FLAGS, .unit = "ft_load_flags" },
224  { "force_autohint", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_FORCE_AUTOHINT }, .flags = FLAGS, .unit = "ft_load_flags" },
225  { "crop_bitmap", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_CROP_BITMAP }, .flags = FLAGS, .unit = "ft_load_flags" },
226  { "pedantic", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_PEDANTIC }, .flags = FLAGS, .unit = "ft_load_flags" },
227  { "ignore_global_advance_width", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH }, .flags = FLAGS, .unit = "ft_load_flags" },
228  { "no_recurse", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_RECURSE }, .flags = FLAGS, .unit = "ft_load_flags" },
229  { "ignore_transform", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_IGNORE_TRANSFORM }, .flags = FLAGS, .unit = "ft_load_flags" },
230  { "monochrome", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_MONOCHROME }, .flags = FLAGS, .unit = "ft_load_flags" },
231  { "linear_design", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_LINEAR_DESIGN }, .flags = FLAGS, .unit = "ft_load_flags" },
232  { "no_autohint", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_AUTOHINT }, .flags = FLAGS, .unit = "ft_load_flags" },
233  { NULL }
234 };
235 
237 
238 #undef __FTERRORS_H__
239 #define FT_ERROR_START_LIST {
240 #define FT_ERRORDEF(e, v, s) { (e), (s) },
241 #define FT_ERROR_END_LIST { 0, NULL } };
242 
243 struct ft_error
244 {
245  int err;
246  const char *err_msg;
247 } static ft_errors[] =
248 #include FT_ERRORS_H
249 
250 #define FT_ERRMSG(e) ft_errors[e].err_msg
251 
252 typedef struct {
253  FT_Glyph *glyph;
254  uint32_t code;
255  FT_Bitmap bitmap; ///< array holding bitmaps of font
256  FT_Bitmap border_bitmap; ///< array holding bitmaps of font border
257  FT_BBox bbox;
258  int advance;
259  int bitmap_left;
260  int bitmap_top;
261 } Glyph;
262 
263 static int glyph_cmp(void *key, const void *b)
264 {
265  const Glyph *a = key, *bb = b;
266  int64_t diff = (int64_t)a->code - (int64_t)bb->code;
267  return diff > 0 ? 1 : diff < 0 ? -1 : 0;
268 }
269 
270 /**
271  * Load glyphs corresponding to the UTF-32 codepoint code.
272  */
273 static int load_glyph(AVFilterContext *ctx, Glyph **glyph_ptr, uint32_t code)
274 {
275  DrawTextContext *s = ctx->priv;
276  FT_BitmapGlyph bitmapglyph;
277  Glyph *glyph;
278  struct AVTreeNode *node = NULL;
279  int ret;
280 
281  /* load glyph into s->face->glyph */
282  if (FT_Load_Char(s->face, code, s->ft_load_flags))
283  return AVERROR(EINVAL);
284 
285  /* save glyph */
286  if (!(glyph = av_mallocz(sizeof(*glyph))) ||
287  !(glyph->glyph = av_mallocz(sizeof(*glyph->glyph)))) {
288  ret = AVERROR(ENOMEM);
289  goto error;
290  }
291  glyph->code = code;
292 
293  if (FT_Get_Glyph(s->face->glyph, glyph->glyph)) {
294  ret = AVERROR(EINVAL);
295  goto error;
296  }
297  if (s->borderw) {
298  FT_Glyph border_glyph = *glyph->glyph;
299  if (FT_Glyph_StrokeBorder(&border_glyph, s->stroker, 0, 0) ||
300  FT_Glyph_To_Bitmap(&border_glyph, FT_RENDER_MODE_NORMAL, 0, 1)) {
301  ret = AVERROR_EXTERNAL;
302  goto error;
303  }
304  bitmapglyph = (FT_BitmapGlyph) border_glyph;
305  glyph->border_bitmap = bitmapglyph->bitmap;
306  }
307  if (FT_Glyph_To_Bitmap(glyph->glyph, FT_RENDER_MODE_NORMAL, 0, 1)) {
308  ret = AVERROR_EXTERNAL;
309  goto error;
310  }
311  bitmapglyph = (FT_BitmapGlyph) *glyph->glyph;
312 
313  glyph->bitmap = bitmapglyph->bitmap;
314  glyph->bitmap_left = bitmapglyph->left;
315  glyph->bitmap_top = bitmapglyph->top;
316  glyph->advance = s->face->glyph->advance.x >> 6;
317 
318  /* measure text height to calculate text_height (or the maximum text height) */
319  FT_Glyph_Get_CBox(*glyph->glyph, ft_glyph_bbox_pixels, &glyph->bbox);
320 
321  /* cache the newly created glyph */
322  if (!(node = av_tree_node_alloc())) {
323  ret = AVERROR(ENOMEM);
324  goto error;
325  }
326  av_tree_insert(&s->glyphs, glyph, glyph_cmp, &node);
327 
328  if (glyph_ptr)
329  *glyph_ptr = glyph;
330  return 0;
331 
332 error:
333  if (glyph)
334  av_freep(&glyph->glyph);
335  av_freep(&glyph);
336  av_freep(&node);
337  return ret;
338 }
339 
340 static int load_font_file(AVFilterContext *ctx, const char *path, int index,
341  const char **error)
342 {
343  DrawTextContext *s = ctx->priv;
344  int err;
345 
346  err = FT_New_Face(s->library, path, index, &s->face);
347  if (err) {
348  *error = FT_ERRMSG(err);
349  return AVERROR(EINVAL);
350  }
351  return 0;
352 }
353 
354 #if CONFIG_FONTCONFIG
355 static int load_font_fontconfig(AVFilterContext *ctx, const char **error)
356 {
357  DrawTextContext *s = ctx->priv;
358  FcConfig *fontconfig;
359  FcPattern *pattern, *fpat;
360  FcResult result = FcResultMatch;
361  FcChar8 *filename;
362  int err, index;
363  double size;
364 
365  fontconfig = FcInitLoadConfigAndFonts();
366  if (!fontconfig) {
367  *error = "impossible to init fontconfig\n";
368  return AVERROR(EINVAL);
369  }
370  pattern = FcNameParse(s->fontfile ? s->fontfile :
371  (uint8_t *)(intptr_t)"default");
372  if (!pattern) {
373  *error = "could not parse fontconfig pattern";
374  return AVERROR(EINVAL);
375  }
376  if (!FcConfigSubstitute(fontconfig, pattern, FcMatchPattern)) {
377  *error = "could not substitue fontconfig options"; /* very unlikely */
378  return AVERROR(EINVAL);
379  }
380  FcDefaultSubstitute(pattern);
381  fpat = FcFontMatch(fontconfig, pattern, &result);
382  if (!fpat || result != FcResultMatch) {
383  *error = "impossible to find a matching font";
384  return AVERROR(EINVAL);
385  }
386  if (FcPatternGetString (fpat, FC_FILE, 0, &filename) != FcResultMatch ||
387  FcPatternGetInteger(fpat, FC_INDEX, 0, &index ) != FcResultMatch ||
388  FcPatternGetDouble (fpat, FC_SIZE, 0, &size ) != FcResultMatch) {
389  *error = "impossible to find font information";
390  return AVERROR(EINVAL);
391  }
392  av_log(ctx, AV_LOG_INFO, "Using \"%s\"\n", filename);
393  if (!s->fontsize)
394  s->fontsize = size + 0.5;
395  err = load_font_file(ctx, filename, index, error);
396  if (err)
397  return err;
398  FcPatternDestroy(fpat);
399  FcPatternDestroy(pattern);
400  FcConfigDestroy(fontconfig);
401  return 0;
402 }
403 #endif
404 
405 static int load_font(AVFilterContext *ctx)
406 {
407  DrawTextContext *s = ctx->priv;
408  int err;
409  const char *error = "unknown error\n";
410 
411  /* load the face, and set up the encoding, which is by default UTF-8 */
412  err = load_font_file(ctx, s->fontfile, 0, &error);
413  if (!err)
414  return 0;
415 #if CONFIG_FONTCONFIG
416  err = load_font_fontconfig(ctx, &error);
417  if (!err)
418  return 0;
419 #endif
420  av_log(ctx, AV_LOG_ERROR, "Could not load font \"%s\": %s\n",
421  s->fontfile, error);
422  return err;
423 }
424 
426 {
427  DrawTextContext *s = ctx->priv;
428  int err;
429  uint8_t *textbuf;
430  size_t textbuf_size;
431 
432  if ((err = av_file_map(s->textfile, &textbuf, &textbuf_size, 0, ctx)) < 0) {
433  av_log(ctx, AV_LOG_ERROR,
434  "The text file '%s' could not be read or is empty\n",
435  s->textfile);
436  return err;
437  }
438 
439  if (!(s->text = av_realloc(s->text, textbuf_size + 1)))
440  return AVERROR(ENOMEM);
441  memcpy(s->text, textbuf, textbuf_size);
442  s->text[textbuf_size] = 0;
443  av_file_unmap(textbuf, textbuf_size);
444 
445  return 0;
446 }
447 
448 static av_cold int init(AVFilterContext *ctx)
449 {
450  int err;
451  DrawTextContext *s = ctx->priv;
452  Glyph *glyph;
453 
454 #if FF_API_DRAWTEXT_OLD_TIMELINE
455  if (s->draw_expr)
456  av_log(ctx, AV_LOG_WARNING, "'draw' option is deprecated and will be removed soon, "
457  "you are encouraged to use the generic timeline support through the 'enable' option\n");
458 #endif
459 
460  if (!s->fontfile && !CONFIG_FONTCONFIG) {
461  av_log(ctx, AV_LOG_ERROR, "No font filename provided\n");
462  return AVERROR(EINVAL);
463  }
464 
465  if (s->textfile) {
466  if (s->text) {
467  av_log(ctx, AV_LOG_ERROR,
468  "Both text and text file provided. Please provide only one\n");
469  return AVERROR(EINVAL);
470  }
471  if ((err = load_textfile(ctx)) < 0)
472  return err;
473  }
474 
475  if (s->reload && !s->textfile)
476  av_log(ctx, AV_LOG_WARNING, "No file to reload\n");
477 
478  if (s->tc_opt_string) {
480  s->tc_opt_string, ctx);
481  if (ret < 0)
482  return ret;
483  if (s->tc24hmax)
485  if (!s->text)
486  s->text = av_strdup("");
487  }
488 
489  if (!s->text) {
490  av_log(ctx, AV_LOG_ERROR,
491  "Either text, a valid file or a timecode must be provided\n");
492  return AVERROR(EINVAL);
493  }
494 
495  if ((err = FT_Init_FreeType(&(s->library)))) {
496  av_log(ctx, AV_LOG_ERROR,
497  "Could not load FreeType: %s\n", FT_ERRMSG(err));
498  return AVERROR(EINVAL);
499  }
500 
501  err = load_font(ctx);
502  if (err)
503  return err;
504  if (!s->fontsize)
505  s->fontsize = 16;
506  if ((err = FT_Set_Pixel_Sizes(s->face, 0, s->fontsize))) {
507  av_log(ctx, AV_LOG_ERROR, "Could not set font size to %d pixels: %s\n",
508  s->fontsize, FT_ERRMSG(err));
509  return AVERROR(EINVAL);
510  }
511 
512  if (s->borderw) {
513  if (FT_Stroker_New(s->library, &s->stroker)) {
514  av_log(ctx, AV_LOG_ERROR, "Coult not init FT stroker\n");
515  return AVERROR_EXTERNAL;
516  }
517  FT_Stroker_Set(s->stroker, s->borderw << 6, FT_STROKER_LINECAP_ROUND,
518  FT_STROKER_LINEJOIN_ROUND, 0);
519  }
520 
521  s->use_kerning = FT_HAS_KERNING(s->face);
522 
523  /* load the fallback glyph with code 0 */
524  load_glyph(ctx, NULL, 0);
525 
526  /* set the tabsize in pixels */
527  if ((err = load_glyph(ctx, &glyph, ' ')) < 0) {
528  av_log(ctx, AV_LOG_ERROR, "Could not set tabsize.\n");
529  return err;
530  }
531  s->tabsize *= glyph->advance;
532 
533  if (s->exp_mode == EXP_STRFTIME &&
534  (strchr(s->text, '%') || strchr(s->text, '\\')))
535  av_log(ctx, AV_LOG_WARNING, "expansion=strftime is deprecated.\n");
536 
538 
539  return 0;
540 }
541 
543 {
545  return 0;
546 }
547 
548 static int glyph_enu_free(void *opaque, void *elem)
549 {
550  Glyph *glyph = elem;
551 
552  FT_Done_Glyph(*glyph->glyph);
553  av_freep(&glyph->glyph);
554  av_free(elem);
555  return 0;
556 }
557 
558 static av_cold void uninit(AVFilterContext *ctx)
559 {
560  DrawTextContext *s = ctx->priv;
561 
562  av_expr_free(s->x_pexpr);
563  av_expr_free(s->y_pexpr);
564 #if FF_API_DRAWTEXT_OLD_TIMELINE
566  s->x_pexpr = s->y_pexpr = s->draw_pexpr = NULL;
567 #endif
568  av_freep(&s->positions);
569  s->nb_positions = 0;
570 
571 
572  av_tree_enumerate(s->glyphs, NULL, NULL, glyph_enu_free);
574  s->glyphs = NULL;
575 
576  FT_Done_Face(s->face);
577  FT_Stroker_Done(s->stroker);
578  FT_Done_FreeType(s->library);
579 
581 }
582 
583 static inline int is_newline(uint32_t c)
584 {
585  return c == '\n' || c == '\r' || c == '\f' || c == '\v';
586 }
587 
588 static int config_input(AVFilterLink *inlink)
589 {
590  AVFilterContext *ctx = inlink->dst;
591  DrawTextContext *s = ctx->priv;
592  int ret;
593 
594  ff_draw_init(&s->dc, inlink->format, 0);
595  ff_draw_color(&s->dc, &s->fontcolor, s->fontcolor.rgba);
598  ff_draw_color(&s->dc, &s->boxcolor, s->boxcolor.rgba);
599 
600  s->var_values[VAR_w] = s->var_values[VAR_W] = s->var_values[VAR_MAIN_W] = inlink->w;
601  s->var_values[VAR_h] = s->var_values[VAR_H] = s->var_values[VAR_MAIN_H] = inlink->h;
603  s->var_values[VAR_DAR] = (double)inlink->w / inlink->h * s->var_values[VAR_SAR];
604  s->var_values[VAR_HSUB] = 1 << s->dc.hsub_max;
605  s->var_values[VAR_VSUB] = 1 << s->dc.vsub_max;
606  s->var_values[VAR_X] = NAN;
607  s->var_values[VAR_Y] = NAN;
608  s->var_values[VAR_T] = NAN;
609 
611 
612  av_expr_free(s->x_pexpr);
613  av_expr_free(s->y_pexpr);
614 #if FF_API_DRAWTEXT_OLD_TIMELINE
616  s->x_pexpr = s->y_pexpr = s->draw_pexpr = NULL;
617 #else
618  s->x_pexpr = s->y_pexpr = NULL;
619 #endif
620 
621  if ((ret = av_expr_parse(&s->x_pexpr, s->x_expr, var_names,
622  NULL, NULL, fun2_names, fun2, 0, ctx)) < 0 ||
623  (ret = av_expr_parse(&s->y_pexpr, s->y_expr, var_names,
624  NULL, NULL, fun2_names, fun2, 0, ctx)) < 0)
625 
626  return AVERROR(EINVAL);
627 #if FF_API_DRAWTEXT_OLD_TIMELINE
628  if (s->draw_expr &&
630  NULL, NULL, fun2_names, fun2, 0, ctx)) < 0)
631  return ret;
632 #endif
633 
634  return 0;
635 }
636 
637 static int command(AVFilterContext *ctx, const char *cmd, const char *arg, char *res, int res_len, int flags)
638 {
639  DrawTextContext *s = ctx->priv;
640 
641  if (!strcmp(cmd, "reinit")) {
642  int ret;
643  uninit(ctx);
644  s->reinit = 1;
645  if ((ret = av_set_options_string(ctx, arg, "=", ":")) < 0)
646  return ret;
647  if ((ret = init(ctx)) < 0)
648  return ret;
649  return config_input(ctx->inputs[0]);
650  }
651 
652  return AVERROR(ENOSYS);
653 }
654 
656  char *fct, unsigned argc, char **argv, int tag)
657 {
658  DrawTextContext *s = ctx->priv;
659 
661  return 0;
662 }
663 
664 static int func_pts(AVFilterContext *ctx, AVBPrint *bp,
665  char *fct, unsigned argc, char **argv, int tag)
666 {
667  DrawTextContext *s = ctx->priv;
668 
669  av_bprintf(bp, "%.6f", s->var_values[VAR_T]);
670  return 0;
671 }
672 
674  char *fct, unsigned argc, char **argv, int tag)
675 {
676  DrawTextContext *s = ctx->priv;
677 
678  av_bprintf(bp, "%d", (int)s->var_values[VAR_N]);
679  return 0;
680 }
681 
683  char *fct, unsigned argc, char **argv, int tag)
684 {
685  DrawTextContext *s = ctx->priv;
686  AVDictionaryEntry *e = av_dict_get(s->metadata, argv[0], NULL, 0);
687 
688  if (e && e->value)
689  av_bprintf(bp, "%s", e->value);
690  return 0;
691 }
692 
693 #if !HAVE_LOCALTIME_R
694 static void localtime_r(const time_t *t, struct tm *tm)
695 {
696  *tm = *localtime(t);
697 }
698 #endif
699 
701  char *fct, unsigned argc, char **argv, int tag)
702 {
703  const char *fmt = argc ? argv[0] : "%Y-%m-%d %H:%M:%S";
704  time_t now;
705  struct tm tm;
706 
707  time(&now);
708  if (tag == 'L')
709  localtime_r(&now, &tm);
710  else
711  tm = *gmtime(&now);
712  av_bprint_strftime(bp, fmt, &tm);
713  return 0;
714 }
715 
717  char *fct, unsigned argc, char **argv, int tag)
718 {
719  DrawTextContext *s = ctx->priv;
720  double res;
721  int ret;
722 
723  ret = av_expr_parse_and_eval(&res, argv[0], var_names, s->var_values,
724  NULL, NULL, fun2_names, fun2,
725  &s->prng, 0, ctx);
726  if (ret < 0)
727  av_log(ctx, AV_LOG_ERROR,
728  "Expression '%s' for the expr text expansion function is not valid\n",
729  argv[0]);
730  else
731  av_bprintf(bp, "%f", res);
732 
733  return ret;
734 }
735 
736 static const struct drawtext_function {
737  const char *name;
738  unsigned argc_min, argc_max;
739  int tag; /**< opaque argument to func */
740  int (*func)(AVFilterContext *, AVBPrint *, char *, unsigned, char **, int);
741 } functions[] = {
742  { "expr", 1, 1, 0, func_eval_expr },
743  { "e", 1, 1, 0, func_eval_expr },
744  { "pict_type", 0, 0, 0, func_pict_type },
745  { "pts", 0, 0, 0, func_pts },
746  { "gmtime", 0, 1, 'G', func_strftime },
747  { "localtime", 0, 1, 'L', func_strftime },
748  { "frame_num", 0, 0, 0, func_frame_num },
749  { "n", 0, 0, 0, func_frame_num },
750  { "metadata", 1, 1, 0, func_metadata },
751 };
752 
753 static int eval_function(AVFilterContext *ctx, AVBPrint *bp, char *fct,
754  unsigned argc, char **argv)
755 {
756  unsigned i;
757 
758  for (i = 0; i < FF_ARRAY_ELEMS(functions); i++) {
759  if (strcmp(fct, functions[i].name))
760  continue;
761  if (argc < functions[i].argc_min) {
762  av_log(ctx, AV_LOG_ERROR, "%%{%s} requires at least %d arguments\n",
763  fct, functions[i].argc_min);
764  return AVERROR(EINVAL);
765  }
766  if (argc > functions[i].argc_max) {
767  av_log(ctx, AV_LOG_ERROR, "%%{%s} requires at most %d arguments\n",
768  fct, functions[i].argc_max);
769  return AVERROR(EINVAL);
770  }
771  break;
772  }
773  if (i >= FF_ARRAY_ELEMS(functions)) {
774  av_log(ctx, AV_LOG_ERROR, "%%{%s} is not known\n", fct);
775  return AVERROR(EINVAL);
776  }
777  return functions[i].func(ctx, bp, fct, argc, argv, functions[i].tag);
778 }
779 
780 static int expand_function(AVFilterContext *ctx, AVBPrint *bp, char **rtext)
781 {
782  const char *text = *rtext;
783  char *argv[16] = { NULL };
784  unsigned argc = 0, i;
785  int ret;
786 
787  if (*text != '{') {
788  av_log(ctx, AV_LOG_ERROR, "Stray %% near '%s'\n", text);
789  return AVERROR(EINVAL);
790  }
791  text++;
792  while (1) {
793  if (!(argv[argc++] = av_get_token(&text, ":}"))) {
794  ret = AVERROR(ENOMEM);
795  goto end;
796  }
797  if (!*text) {
798  av_log(ctx, AV_LOG_ERROR, "Unterminated %%{} near '%s'\n", *rtext);
799  ret = AVERROR(EINVAL);
800  goto end;
801  }
802  if (argc == FF_ARRAY_ELEMS(argv))
803  av_freep(&argv[--argc]); /* error will be caught later */
804  if (*text == '}')
805  break;
806  text++;
807  }
808 
809  if ((ret = eval_function(ctx, bp, argv[0], argc - 1, argv + 1)) < 0)
810  goto end;
811  ret = 0;
812  *rtext = (char *)text + 1;
813 
814 end:
815  for (i = 0; i < argc; i++)
816  av_freep(&argv[i]);
817  return ret;
818 }
819 
820 static int expand_text(AVFilterContext *ctx)
821 {
822  DrawTextContext *s = ctx->priv;
823  char *text = s->text;
824  AVBPrint *bp = &s->expanded_text;
825  int ret;
826 
827  av_bprint_clear(bp);
828  while (*text) {
829  if (*text == '\\' && text[1]) {
830  av_bprint_chars(bp, text[1], 1);
831  text += 2;
832  } else if (*text == '%') {
833  text++;
834  if ((ret = expand_function(ctx, bp, &text)) < 0)
835  return ret;
836  } else {
837  av_bprint_chars(bp, *text, 1);
838  text++;
839  }
840  }
841  if (!av_bprint_is_complete(bp))
842  return AVERROR(ENOMEM);
843  return 0;
844 }
845 
847  int width, int height, const uint8_t rgbcolor[4],
848  FFDrawColor *color, int x, int y, int borderw)
849 {
850  char *text = s->expanded_text.str;
851  uint32_t code = 0;
852  int i, x1, y1;
853  uint8_t *p;
854  Glyph *glyph = NULL;
855 
856  for (i = 0, p = text; *p; i++) {
857  FT_Bitmap bitmap;
858  Glyph dummy = { 0 };
859  GET_UTF8(code, *p++, continue;);
860 
861  /* skip new line chars, just go to new line */
862  if (code == '\n' || code == '\r' || code == '\t')
863  continue;
864 
865  dummy.code = code;
866  glyph = av_tree_find(s->glyphs, &dummy, (void *)glyph_cmp, NULL);
867 
868  bitmap = borderw ? glyph->border_bitmap : glyph->bitmap;
869 
870  if (glyph->bitmap.pixel_mode != FT_PIXEL_MODE_MONO &&
871  glyph->bitmap.pixel_mode != FT_PIXEL_MODE_GRAY)
872  return AVERROR(EINVAL);
873 
874  x1 = s->positions[i].x+s->x+x - borderw;
875  y1 = s->positions[i].y+s->y+y - borderw;
876 
877  ff_blend_mask(&s->dc, color,
878  frame->data, frame->linesize, width, height,
879  bitmap.buffer, bitmap.pitch,
880  bitmap.width, bitmap.rows,
881  bitmap.pixel_mode == FT_PIXEL_MODE_MONO ? 0 : 3,
882  0, x1, y1);
883  }
884 
885  return 0;
886 }
887 
889  int width, int height)
890 {
891  DrawTextContext *s = ctx->priv;
892  AVFilterLink *inlink = ctx->inputs[0];
893 
894  uint32_t code = 0, prev_code = 0;
895  int x = 0, y = 0, i = 0, ret;
896  int max_text_line_w = 0, len;
897  int box_w, box_h;
898  char *text;
899  uint8_t *p;
900  int y_min = 32000, y_max = -32000;
901  int x_min = 32000, x_max = -32000;
902  FT_Vector delta;
903  Glyph *glyph = NULL, *prev_glyph = NULL;
904  Glyph dummy = { 0 };
905 
906  time_t now = time(0);
907  struct tm ltime;
908  AVBPrint *bp = &s->expanded_text;
909 
910  av_bprint_clear(bp);
911 
912  if(s->basetime != AV_NOPTS_VALUE)
913  now= frame->pts*av_q2d(ctx->inputs[0]->time_base) + s->basetime/1000000;
914 
915  switch (s->exp_mode) {
916  case EXP_NONE:
917  av_bprintf(bp, "%s", s->text);
918  break;
919  case EXP_NORMAL:
920  if ((ret = expand_text(ctx)) < 0)
921  return ret;
922  break;
923  case EXP_STRFTIME:
924  localtime_r(&now, &ltime);
925  av_bprint_strftime(bp, s->text, &ltime);
926  break;
927  }
928 
929  if (s->tc_opt_string) {
930  char tcbuf[AV_TIMECODE_STR_SIZE];
931  av_timecode_make_string(&s->tc, tcbuf, inlink->frame_count);
932  av_bprint_clear(bp);
933  av_bprintf(bp, "%s%s", s->text, tcbuf);
934  }
935 
936  if (!av_bprint_is_complete(bp))
937  return AVERROR(ENOMEM);
938  text = s->expanded_text.str;
939  if ((len = s->expanded_text.len) > s->nb_positions) {
940  if (!(s->positions =
941  av_realloc(s->positions, len*sizeof(*s->positions))))
942  return AVERROR(ENOMEM);
943  s->nb_positions = len;
944  }
945 
946  x = 0;
947  y = 0;
948 
949  /* load and cache glyphs */
950  for (i = 0, p = text; *p; i++) {
951  GET_UTF8(code, *p++, continue;);
952 
953  /* get glyph */
954  dummy.code = code;
955  glyph = av_tree_find(s->glyphs, &dummy, glyph_cmp, NULL);
956  if (!glyph) {
957  load_glyph(ctx, &glyph, code);
958  }
959 
960  y_min = FFMIN(glyph->bbox.yMin, y_min);
961  y_max = FFMAX(glyph->bbox.yMax, y_max);
962  x_min = FFMIN(glyph->bbox.xMin, x_min);
963  x_max = FFMAX(glyph->bbox.xMax, x_max);
964  }
965  s->max_glyph_h = y_max - y_min;
966  s->max_glyph_w = x_max - x_min;
967 
968  /* compute and save position for each glyph */
969  glyph = NULL;
970  for (i = 0, p = text; *p; i++) {
971  GET_UTF8(code, *p++, continue;);
972 
973  /* skip the \n in the sequence \r\n */
974  if (prev_code == '\r' && code == '\n')
975  continue;
976 
977  prev_code = code;
978  if (is_newline(code)) {
979 
980  max_text_line_w = FFMAX(max_text_line_w, x);
981  y += s->max_glyph_h;
982  x = 0;
983  continue;
984  }
985 
986  /* get glyph */
987  prev_glyph = glyph;
988  dummy.code = code;
989  glyph = av_tree_find(s->glyphs, &dummy, glyph_cmp, NULL);
990 
991  /* kerning */
992  if (s->use_kerning && prev_glyph && glyph->code) {
993  FT_Get_Kerning(s->face, prev_glyph->code, glyph->code,
994  ft_kerning_default, &delta);
995  x += delta.x >> 6;
996  }
997 
998  /* save position */
999  s->positions[i].x = x + glyph->bitmap_left;
1000  s->positions[i].y = y - glyph->bitmap_top + y_max;
1001  if (code == '\t') x = (x / s->tabsize + 1)*s->tabsize;
1002  else x += glyph->advance;
1003  }
1004 
1005  max_text_line_w = FFMAX(x, max_text_line_w);
1006 
1007  s->var_values[VAR_TW] = s->var_values[VAR_TEXT_W] = max_text_line_w;
1009 
1012  s->var_values[VAR_MAX_GLYPH_A] = s->var_values[VAR_ASCENT ] = y_max;
1014 
1016 
1017  s->x = s->var_values[VAR_X] = av_expr_eval(s->x_pexpr, s->var_values, &s->prng);
1018  s->y = s->var_values[VAR_Y] = av_expr_eval(s->y_pexpr, s->var_values, &s->prng);
1019  s->x = s->var_values[VAR_X] = av_expr_eval(s->x_pexpr, s->var_values, &s->prng);
1020 #if FF_API_DRAWTEXT_OLD_TIMELINE
1021  if (s->draw_pexpr){
1022  s->draw = av_expr_eval(s->draw_pexpr, s->var_values, &s->prng);
1023 
1024  if(!s->draw)
1025  return 0;
1026  }
1027  if (ctx->is_disabled)
1028  return 0;
1029 #endif
1030 
1031  box_w = FFMIN(width - 1 , max_text_line_w);
1032  box_h = FFMIN(height - 1, y + s->max_glyph_h);
1033 
1034  /* draw box */
1035  if (s->draw_box)
1036  ff_blend_rectangle(&s->dc, &s->boxcolor,
1037  frame->data, frame->linesize, width, height,
1038  s->x, s->y, box_w, box_h);
1039 
1040  if (s->shadowx || s->shadowy) {
1041  if ((ret = draw_glyphs(s, frame, width, height, s->shadowcolor.rgba,
1042  &s->shadowcolor, s->shadowx, s->shadowy, 0)) < 0)
1043  return ret;
1044  }
1045 
1046  if (s->borderw) {
1047  if ((ret = draw_glyphs(s, frame, width, height, s->bordercolor.rgba,
1048  &s->bordercolor, 0, 0, s->borderw)) < 0)
1049  return ret;
1050  }
1051  if ((ret = draw_glyphs(s, frame, width, height, s->fontcolor.rgba,
1052  &s->fontcolor, 0, 0, 0)) < 0)
1053  return ret;
1054 
1055  return 0;
1056 }
1057 
1059 {
1060  AVFilterContext *ctx = inlink->dst;
1061  AVFilterLink *outlink = ctx->outputs[0];
1062  DrawTextContext *s = ctx->priv;
1063  int ret;
1064 
1065  if (s->reload)
1066  if ((ret = load_textfile(ctx)) < 0)
1067  return ret;
1068 
1069  s->var_values[VAR_N] = inlink->frame_count+s->start_number;
1070  s->var_values[VAR_T] = frame->pts == AV_NOPTS_VALUE ?
1071  NAN : frame->pts * av_q2d(inlink->time_base);
1072 
1073  s->var_values[VAR_PICT_TYPE] = frame->pict_type;
1074  s->metadata = av_frame_get_metadata(frame);
1075 
1076  draw_text(ctx, frame, frame->width, frame->height);
1077 
1078  av_log(ctx, AV_LOG_DEBUG, "n:%d t:%f text_w:%d text_h:%d x:%d y:%d\n",
1079  (int)s->var_values[VAR_N], s->var_values[VAR_T],
1080  (int)s->var_values[VAR_TEXT_W], (int)s->var_values[VAR_TEXT_H],
1081  s->x, s->y);
1082 
1083  return ff_filter_frame(outlink, frame);
1084 }
1085 
1087  {
1088  .name = "default",
1089  .type = AVMEDIA_TYPE_VIDEO,
1090  .filter_frame = filter_frame,
1091  .config_props = config_input,
1092  .needs_writable = 1,
1093  },
1094  { NULL }
1095 };
1096 
1098  {
1099  .name = "default",
1100  .type = AVMEDIA_TYPE_VIDEO,
1101  },
1102  { NULL }
1103 };
1104 
1106  .name = "drawtext",
1107  .description = NULL_IF_CONFIG_SMALL("Draw text on top of video frames using libfreetype library."),
1108  .priv_size = sizeof(DrawTextContext),
1109  .priv_class = &drawtext_class,
1110  .init = init,
1111  .uninit = uninit,
1113  .inputs = avfilter_vf_drawtext_inputs,
1114  .outputs = avfilter_vf_drawtext_outputs,
1118 #else
1120 #endif
1121 };