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