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