Merge remote-tracking branch 'qatar/master'
[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/file.h"
35 #include "libavutil/eval.h"
36 #include "libavutil/opt.h"
37 #include "libavutil/random_seed.h"
38 #include "libavutil/parseutils.h"
39 #include "libavutil/timecode.h"
40 #include "libavutil/tree.h"
41 #include "libavutil/lfg.h"
42 #include "avfilter.h"
43 #include "drawutils.h"
44 #include "formats.h"
45 #include "internal.h"
46 #include "video.h"
47
48 #undef time
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     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_VARS_NB
112 };
113
114 typedef struct {
115     const AVClass *class;
116     int reinit;                     ///< tells if the filter is being reinited
117     uint8_t *fontfile;              ///< font to be used
118     uint8_t *text;                  ///< text to be drawn
119     uint8_t *expanded_text;         ///< used to contain the strftime()-expanded text
120     size_t   expanded_text_size;    ///< size in bytes of the expanded_text buffer
121     int ft_load_flags;              ///< flags used for loading fonts, see FT_LOAD_*
122     FT_Vector *positions;           ///< positions for each element in the text
123     size_t nb_positions;            ///< number of elements of positions array
124     char *textfile;                 ///< file with text to be drawn
125     int x;                          ///< x position to start drawing text
126     int y;                          ///< y position to start drawing text
127     int max_glyph_w;                ///< max glyph width
128     int max_glyph_h;                ///< max glyph height
129     int shadowx, shadowy;
130     unsigned int fontsize;          ///< font size to use
131     char *fontcolor_string;         ///< font color as string
132     char *boxcolor_string;          ///< box color as string
133     char *shadowcolor_string;       ///< shadow color as string
134
135     short int draw_box;             ///< draw box around text - true or false
136     int use_kerning;                ///< font kerning is used - true/false
137     int tabsize;                    ///< tab size
138     int fix_bounds;                 ///< do we let it go out of frame bounds - t/f
139
140     FFDrawContext dc;
141     FFDrawColor fontcolor;          ///< foreground color
142     FFDrawColor shadowcolor;        ///< shadow color
143     FFDrawColor boxcolor;           ///< background color
144
145     FT_Library library;             ///< freetype font library handle
146     FT_Face face;                   ///< freetype font face handle
147     struct AVTreeNode *glyphs;      ///< rendered glyphs, stored using the UTF-32 char code
148     char *x_expr;                   ///< expression for x position
149     char *y_expr;                   ///< expression for y position
150     AVExpr *x_pexpr, *y_pexpr;      ///< parsed expressions for x and y
151     int64_t basetime;               ///< base pts time in the real world for display
152     double var_values[VAR_VARS_NB];
153     char   *draw_expr;              ///< expression for draw
154     AVExpr *draw_pexpr;             ///< parsed expression for draw
155     int draw;                       ///< set to zero to prevent drawing
156     AVLFG  prng;                    ///< random
157     char       *tc_opt_string;      ///< specified timecode option string
158     AVRational  tc_rate;            ///< frame rate for timecode
159     AVTimecode  tc;                 ///< timecode context
160     int tc24hmax;                   ///< 1 if timecode is wrapped to 24 hours, 0 otherwise
161     int frame_id;
162 } DrawTextContext;
163
164 #define OFFSET(x) offsetof(DrawTextContext, x)
165
166 static const AVOption drawtext_options[]= {
167 {"fontfile", "set font file",        OFFSET(fontfile),           AV_OPT_TYPE_STRING, {.str=NULL},  CHAR_MIN, CHAR_MAX },
168 {"text",     "set text",             OFFSET(text),               AV_OPT_TYPE_STRING, {.str=NULL},  CHAR_MIN, CHAR_MAX },
169 {"textfile", "set text file",        OFFSET(textfile),           AV_OPT_TYPE_STRING, {.str=NULL},  CHAR_MIN, CHAR_MAX },
170 {"fontcolor",   "set foreground color", OFFSET(fontcolor_string),   AV_OPT_TYPE_STRING, {.str="black"}, CHAR_MIN, CHAR_MAX },
171 {"boxcolor",    "set box color",        OFFSET(boxcolor_string),    AV_OPT_TYPE_STRING, {.str="white"}, CHAR_MIN, CHAR_MAX },
172 {"shadowcolor", "set shadow color",     OFFSET(shadowcolor_string), AV_OPT_TYPE_STRING, {.str="black"}, CHAR_MIN, CHAR_MAX },
173 {"box",      "set box",              OFFSET(draw_box),           AV_OPT_TYPE_INT,    {.dbl=0},     0,        1        },
174 {"fontsize", "set font size",        OFFSET(fontsize),           AV_OPT_TYPE_INT,    {.dbl=0},     0,        INT_MAX  },
175 {"x",        "set x expression",     OFFSET(x_expr),             AV_OPT_TYPE_STRING, {.str="0"},   CHAR_MIN, CHAR_MAX },
176 {"y",        "set y expression",     OFFSET(y_expr),             AV_OPT_TYPE_STRING, {.str="0"},   CHAR_MIN, CHAR_MAX },
177 {"shadowx",  "set x",                OFFSET(shadowx),            AV_OPT_TYPE_INT,    {.dbl=0},     INT_MIN,  INT_MAX  },
178 {"shadowy",  "set y",                OFFSET(shadowy),            AV_OPT_TYPE_INT,    {.dbl=0},     INT_MIN,  INT_MAX  },
179 {"tabsize",  "set tab size",         OFFSET(tabsize),            AV_OPT_TYPE_INT,    {.dbl=4},     0,        INT_MAX  },
180 {"basetime", "set base time",        OFFSET(basetime),           AV_OPT_TYPE_INT64,  {.dbl=AV_NOPTS_VALUE},     INT64_MIN,        INT64_MAX  },
181 {"draw",     "if false do not draw", OFFSET(draw_expr),          AV_OPT_TYPE_STRING, {.str="1"},   CHAR_MIN, CHAR_MAX },
182 {"timecode", "set initial timecode", OFFSET(tc_opt_string),      AV_OPT_TYPE_STRING, {.str=NULL},  CHAR_MIN, CHAR_MAX },
183 {"tc24hmax", "set 24 hours max (timecode only)", OFFSET(tc24hmax), AV_OPT_TYPE_INT,  {.dbl=0},            0,        1 },
184 {"timecode_rate", "set rate (timecode only)", OFFSET(tc_rate),   AV_OPT_TYPE_RATIONAL, {.dbl=0},          0,  INT_MAX },
185 {"r",        "set rate (timecode only)", OFFSET(tc_rate),        AV_OPT_TYPE_RATIONAL, {.dbl=0},          0,  INT_MAX },
186 {"rate",     "set rate (timecode only)", OFFSET(tc_rate),        AV_OPT_TYPE_RATIONAL, {.dbl=0},          0,  INT_MAX },
187 {"fix_bounds", "if true, check and fix text coords to avoid clipping",
188                                      OFFSET(fix_bounds),         AV_OPT_TYPE_INT,    {.dbl=1},     0,        1        },
189
190 /* FT_LOAD_* flags */
191 {"ft_load_flags", "set font loading flags for libfreetype",   OFFSET(ft_load_flags),  AV_OPT_TYPE_FLAGS,  {.dbl=FT_LOAD_DEFAULT|FT_LOAD_RENDER}, 0, INT_MAX, 0, "ft_load_flags" },
192 {"default",                     "set default",                     0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_DEFAULT},                     INT_MIN, INT_MAX, 0, "ft_load_flags" },
193 {"no_scale",                    "set no_scale",                    0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_NO_SCALE},                    INT_MIN, INT_MAX, 0, "ft_load_flags" },
194 {"no_hinting",                  "set no_hinting",                  0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_NO_HINTING},                  INT_MIN, INT_MAX, 0, "ft_load_flags" },
195 {"render",                      "set render",                      0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_RENDER},                      INT_MIN, INT_MAX, 0, "ft_load_flags" },
196 {"no_bitmap",                   "set no_bitmap",                   0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_NO_BITMAP},                   INT_MIN, INT_MAX, 0, "ft_load_flags" },
197 {"vertical_layout",             "set vertical_layout",             0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_VERTICAL_LAYOUT},             INT_MIN, INT_MAX, 0, "ft_load_flags" },
198 {"force_autohint",              "set force_autohint",              0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_FORCE_AUTOHINT},              INT_MIN, INT_MAX, 0, "ft_load_flags" },
199 {"crop_bitmap",                 "set crop_bitmap",                 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_CROP_BITMAP},                 INT_MIN, INT_MAX, 0, "ft_load_flags" },
200 {"pedantic",                    "set pedantic",                    0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_PEDANTIC},                    INT_MIN, INT_MAX, 0, "ft_load_flags" },
201 {"ignore_global_advance_width", "set ignore_global_advance_width", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
202 {"no_recurse",                  "set no_recurse",                  0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_NO_RECURSE},                  INT_MIN, INT_MAX, 0, "ft_load_flags" },
203 {"ignore_transform",            "set ignore_transform",            0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_IGNORE_TRANSFORM},            INT_MIN, INT_MAX, 0, "ft_load_flags" },
204 {"monochrome",                  "set monochrome",                  0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_MONOCHROME},                  INT_MIN, INT_MAX, 0, "ft_load_flags" },
205 {"linear_design",               "set linear_design",               0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_LINEAR_DESIGN},               INT_MIN, INT_MAX, 0, "ft_load_flags" },
206 {"no_autohint",                 "set no_autohint",                 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_NO_AUTOHINT},                 INT_MIN, INT_MAX, 0, "ft_load_flags" },
207 {NULL},
208 };
209
210 static const AVClass drawtext_class = {
211     "DrawTextContext",
212     av_default_item_name,
213     drawtext_options
214 };
215
216 #undef __FTERRORS_H__
217 #define FT_ERROR_START_LIST {
218 #define FT_ERRORDEF(e, v, s) { (e), (s) },
219 #define FT_ERROR_END_LIST { 0, NULL } };
220
221 struct ft_error
222 {
223     int err;
224     const char *err_msg;
225 } static ft_errors[] =
226 #include FT_ERRORS_H
227
228 #define FT_ERRMSG(e) ft_errors[e].err_msg
229
230 typedef struct {
231     FT_Glyph *glyph;
232     uint32_t code;
233     FT_Bitmap bitmap; ///< array holding bitmaps of font
234     FT_BBox bbox;
235     int advance;
236     int bitmap_left;
237     int bitmap_top;
238 } Glyph;
239
240 static int glyph_cmp(void *key, const void *b)
241 {
242     const Glyph *a = key, *bb = b;
243     int64_t diff = (int64_t)a->code - (int64_t)bb->code;
244     return diff > 0 ? 1 : diff < 0 ? -1 : 0;
245 }
246
247 /**
248  * Load glyphs corresponding to the UTF-32 codepoint code.
249  */
250 static int load_glyph(AVFilterContext *ctx, Glyph **glyph_ptr, uint32_t code)
251 {
252     DrawTextContext *dtext = ctx->priv;
253     Glyph *glyph;
254     struct AVTreeNode *node = NULL;
255     int ret;
256
257     /* load glyph into dtext->face->glyph */
258     if (FT_Load_Char(dtext->face, code, dtext->ft_load_flags))
259         return AVERROR(EINVAL);
260
261     /* save glyph */
262     if (!(glyph = av_mallocz(sizeof(*glyph))) ||
263         !(glyph->glyph = av_mallocz(sizeof(*glyph->glyph)))) {
264         ret = AVERROR(ENOMEM);
265         goto error;
266     }
267     glyph->code  = code;
268
269     if (FT_Get_Glyph(dtext->face->glyph, glyph->glyph)) {
270         ret = AVERROR(EINVAL);
271         goto error;
272     }
273
274     glyph->bitmap      = dtext->face->glyph->bitmap;
275     glyph->bitmap_left = dtext->face->glyph->bitmap_left;
276     glyph->bitmap_top  = dtext->face->glyph->bitmap_top;
277     glyph->advance     = dtext->face->glyph->advance.x >> 6;
278
279     /* measure text height to calculate text_height (or the maximum text height) */
280     FT_Glyph_Get_CBox(*glyph->glyph, ft_glyph_bbox_pixels, &glyph->bbox);
281
282     /* cache the newly created glyph */
283     if (!(node = av_mallocz(av_tree_node_size))) {
284         ret = AVERROR(ENOMEM);
285         goto error;
286     }
287     av_tree_insert(&dtext->glyphs, glyph, glyph_cmp, &node);
288
289     if (glyph_ptr)
290         *glyph_ptr = glyph;
291     return 0;
292
293 error:
294     if (glyph)
295         av_freep(&glyph->glyph);
296     av_freep(&glyph);
297     av_freep(&node);
298     return ret;
299 }
300
301 static int load_font_file(AVFilterContext *ctx, const char *path, int index,
302                           const char **error)
303 {
304     DrawTextContext *dtext = ctx->priv;
305     int err;
306
307     err = FT_New_Face(dtext->library, path, index, &dtext->face);
308     if (err) {
309         *error = FT_ERRMSG(err);
310         return AVERROR(EINVAL);
311     }
312     return 0;
313 }
314
315 #if CONFIG_FONTCONFIG
316 static int load_font_fontconfig(AVFilterContext *ctx, const char **error)
317 {
318     DrawTextContext *dtext = ctx->priv;
319     FcConfig *fontconfig;
320     FcPattern *pattern, *fpat;
321     FcResult result = FcResultMatch;
322     FcChar8 *filename;
323     int err, index;
324     double size;
325
326     fontconfig = FcInitLoadConfigAndFonts();
327     if (!fontconfig) {
328         *error = "impossible to init fontconfig\n";
329         return AVERROR(EINVAL);
330     }
331     pattern = FcNameParse(dtext->fontfile ? dtext->fontfile :
332                           (uint8_t *)(intptr_t)"default");
333     if (!pattern) {
334         *error = "could not parse fontconfig pattern";
335         return AVERROR(EINVAL);
336     }
337     if (!FcConfigSubstitute(fontconfig, pattern, FcMatchPattern)) {
338         *error = "could not substitue fontconfig options"; /* very unlikely */
339         return AVERROR(EINVAL);
340     }
341     FcDefaultSubstitute(pattern);
342     fpat = FcFontMatch(fontconfig, pattern, &result);
343     if (!fpat || result != FcResultMatch) {
344         *error = "impossible to find a matching font";
345         return AVERROR(EINVAL);
346     }
347     if (FcPatternGetString (fpat, FC_FILE,  0, &filename) != FcResultMatch ||
348         FcPatternGetInteger(fpat, FC_INDEX, 0, &index   ) != FcResultMatch ||
349         FcPatternGetDouble (fpat, FC_SIZE,  0, &size    ) != FcResultMatch) {
350         *error = "impossible to find font information";
351         return AVERROR(EINVAL);
352     }
353     av_log(ctx, AV_LOG_INFO, "Using \"%s\"\n", filename);
354     if (!dtext->fontsize)
355         dtext->fontsize = size + 0.5;
356     err = load_font_file(ctx, filename, index, error);
357     if (err)
358         return err;
359     FcPatternDestroy(fpat);
360     FcPatternDestroy(pattern);
361     FcConfigDestroy(fontconfig);
362     return 0;
363 }
364 #endif
365
366 static int load_font(AVFilterContext *ctx)
367 {
368     DrawTextContext *dtext = ctx->priv;
369     int err;
370     const char *error = "unknown error\n";
371
372     /* load the face, and set up the encoding, which is by default UTF-8 */
373     err = load_font_file(ctx, dtext->fontfile, 0, &error);
374     if (!err)
375         return 0;
376 #if CONFIG_FONTCONFIG
377     err = load_font_fontconfig(ctx, &error);
378     if (!err)
379         return 0;
380 #endif
381     av_log(ctx, AV_LOG_ERROR, "Could not load font \"%s\": %s\n",
382            dtext->fontfile, error);
383     return err;
384 }
385
386 static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)
387 {
388     int err;
389     DrawTextContext *dtext = ctx->priv;
390     Glyph *glyph;
391
392     dtext->class = &drawtext_class;
393     av_opt_set_defaults(dtext);
394
395     if ((err = (av_set_options_string(dtext, args, "=", ":"))) < 0) {
396         av_log(ctx, AV_LOG_ERROR, "Error parsing options string: '%s'\n", args);
397         return err;
398     }
399
400     if (!dtext->fontfile && !CONFIG_FONTCONFIG) {
401         av_log(ctx, AV_LOG_ERROR, "No font filename provided\n");
402         return AVERROR(EINVAL);
403     }
404
405     if (dtext->textfile) {
406         uint8_t *textbuf;
407         size_t textbuf_size;
408
409         if (dtext->text) {
410             av_log(ctx, AV_LOG_ERROR,
411                    "Both text and text file provided. Please provide only one\n");
412             return AVERROR(EINVAL);
413         }
414         if ((err = av_file_map(dtext->textfile, &textbuf, &textbuf_size, 0, ctx)) < 0) {
415             av_log(ctx, AV_LOG_ERROR,
416                    "The text file '%s' could not be read or is empty\n",
417                    dtext->textfile);
418             return err;
419         }
420
421         if (!(dtext->text = av_malloc(textbuf_size+1)))
422             return AVERROR(ENOMEM);
423         memcpy(dtext->text, textbuf, textbuf_size);
424         dtext->text[textbuf_size] = 0;
425         av_file_unmap(textbuf, textbuf_size);
426     }
427
428     if (dtext->tc_opt_string) {
429         int ret = av_timecode_init_from_string(&dtext->tc, dtext->tc_rate,
430                                                dtext->tc_opt_string, ctx);
431         if (ret < 0)
432             return ret;
433         if (dtext->tc24hmax)
434             dtext->tc.flags |= AV_TIMECODE_FLAG_24HOURSMAX;
435         if (!dtext->text)
436             dtext->text = av_strdup("");
437     }
438
439     if (!dtext->text) {
440         av_log(ctx, AV_LOG_ERROR,
441                "Either text, a valid file or a timecode must be provided\n");
442         return AVERROR(EINVAL);
443     }
444
445     if ((err = av_parse_color(dtext->fontcolor.rgba, dtext->fontcolor_string, -1, ctx))) {
446         av_log(ctx, AV_LOG_ERROR,
447                "Invalid font color '%s'\n", dtext->fontcolor_string);
448         return err;
449     }
450
451     if ((err = av_parse_color(dtext->boxcolor.rgba, dtext->boxcolor_string, -1, ctx))) {
452         av_log(ctx, AV_LOG_ERROR,
453                "Invalid box color '%s'\n", dtext->boxcolor_string);
454         return err;
455     }
456
457     if ((err = av_parse_color(dtext->shadowcolor.rgba, dtext->shadowcolor_string, -1, ctx))) {
458         av_log(ctx, AV_LOG_ERROR,
459                "Invalid shadow color '%s'\n", dtext->shadowcolor_string);
460         return err;
461     }
462
463     if ((err = FT_Init_FreeType(&(dtext->library)))) {
464         av_log(ctx, AV_LOG_ERROR,
465                "Could not load FreeType: %s\n", FT_ERRMSG(err));
466         return AVERROR(EINVAL);
467     }
468
469     err = load_font(ctx);
470     if (err)
471         return err;
472     if (!dtext->fontsize)
473         dtext->fontsize = 16;
474     if ((err = FT_Set_Pixel_Sizes(dtext->face, 0, dtext->fontsize))) {
475         av_log(ctx, AV_LOG_ERROR, "Could not set font size to %d pixels: %s\n",
476                dtext->fontsize, FT_ERRMSG(err));
477         return AVERROR(EINVAL);
478     }
479
480     dtext->use_kerning = FT_HAS_KERNING(dtext->face);
481
482     /* load the fallback glyph with code 0 */
483     load_glyph(ctx, NULL, 0);
484
485     /* set the tabsize in pixels */
486     if ((err = load_glyph(ctx, &glyph, ' ')) < 0) {
487         av_log(ctx, AV_LOG_ERROR, "Could not set tabsize.\n");
488         return err;
489     }
490     dtext->tabsize *= glyph->advance;
491
492     return 0;
493 }
494
495 static int query_formats(AVFilterContext *ctx)
496 {
497     ff_set_common_formats(ctx, ff_draw_supported_pixel_formats(0));
498     return 0;
499 }
500
501 static int glyph_enu_free(void *opaque, void *elem)
502 {
503     Glyph *glyph = elem;
504
505     FT_Done_Glyph(*glyph->glyph);
506     av_freep(&glyph->glyph);
507     av_free(elem);
508     return 0;
509 }
510
511 static av_cold void uninit(AVFilterContext *ctx)
512 {
513     DrawTextContext *dtext = ctx->priv;
514
515     av_expr_free(dtext->x_pexpr); dtext->x_pexpr = NULL;
516     av_expr_free(dtext->y_pexpr); dtext->y_pexpr = NULL;
517     av_expr_free(dtext->draw_pexpr); dtext->draw_pexpr = NULL;
518
519     av_freep(&dtext->boxcolor_string);
520     av_freep(&dtext->expanded_text);
521     av_freep(&dtext->fontcolor_string);
522     av_freep(&dtext->fontfile);
523     av_freep(&dtext->shadowcolor_string);
524     av_freep(&dtext->text);
525     av_freep(&dtext->x_expr);
526     av_freep(&dtext->y_expr);
527     av_freep(&dtext->draw_expr);
528
529     av_freep(&dtext->positions);
530     dtext->nb_positions = 0;
531
532     av_tree_enumerate(dtext->glyphs, NULL, NULL, glyph_enu_free);
533     av_tree_destroy(dtext->glyphs);
534     dtext->glyphs = NULL;
535
536     FT_Done_Face(dtext->face);
537     FT_Done_FreeType(dtext->library);
538 }
539
540 static inline int is_newline(uint32_t c)
541 {
542     return c == '\n' || c == '\r' || c == '\f' || c == '\v';
543 }
544
545 static int config_input(AVFilterLink *inlink)
546 {
547     AVFilterContext *ctx = inlink->dst;
548     DrawTextContext *dtext = ctx->priv;
549     int ret;
550
551     ff_draw_init(&dtext->dc, inlink->format, 0);
552     ff_draw_color(&dtext->dc, &dtext->fontcolor,   dtext->fontcolor.rgba);
553     ff_draw_color(&dtext->dc, &dtext->shadowcolor, dtext->shadowcolor.rgba);
554     ff_draw_color(&dtext->dc, &dtext->boxcolor,    dtext->boxcolor.rgba);
555
556     dtext->var_values[VAR_w]     = dtext->var_values[VAR_W]     = dtext->var_values[VAR_MAIN_W] = inlink->w;
557     dtext->var_values[VAR_h]     = dtext->var_values[VAR_H]     = dtext->var_values[VAR_MAIN_H] = inlink->h;
558     dtext->var_values[VAR_SAR]   = inlink->sample_aspect_ratio.num ? av_q2d(inlink->sample_aspect_ratio) : 1;
559     dtext->var_values[VAR_DAR]   = (double)inlink->w / inlink->h * dtext->var_values[VAR_SAR];
560     dtext->var_values[VAR_HSUB]  = 1 << dtext->dc.hsub_max;
561     dtext->var_values[VAR_VSUB]  = 1 << dtext->dc.vsub_max;
562     dtext->var_values[VAR_X]     = NAN;
563     dtext->var_values[VAR_Y]     = NAN;
564     if (!dtext->reinit)
565         dtext->var_values[VAR_N] = 0;
566     dtext->var_values[VAR_T]     = NAN;
567
568     av_lfg_init(&dtext->prng, av_get_random_seed());
569
570     if ((ret = av_expr_parse(&dtext->x_pexpr, dtext->x_expr, var_names,
571                              NULL, NULL, fun2_names, fun2, 0, ctx)) < 0 ||
572         (ret = av_expr_parse(&dtext->y_pexpr, dtext->y_expr, var_names,
573                              NULL, NULL, fun2_names, fun2, 0, ctx)) < 0 ||
574         (ret = av_expr_parse(&dtext->draw_pexpr, dtext->draw_expr, var_names,
575                              NULL, NULL, fun2_names, fun2, 0, ctx)) < 0)
576
577         return AVERROR(EINVAL);
578
579     return 0;
580 }
581
582 static int command(AVFilterContext *ctx, const char *cmd, const char *arg, char *res, int res_len, int flags)
583 {
584     DrawTextContext *dtext = ctx->priv;
585
586     if (!strcmp(cmd, "reinit")) {
587         int ret;
588         uninit(ctx);
589         dtext->reinit = 1;
590         if ((ret = init(ctx, arg, NULL)) < 0)
591             return ret;
592         return config_input(ctx->inputs[0]);
593     }
594
595     return AVERROR(ENOSYS);
596 }
597
598 static int draw_glyphs(DrawTextContext *dtext, AVFilterBufferRef *picref,
599                        int width, int height, const uint8_t rgbcolor[4], FFDrawColor *color, int x, int y)
600 {
601     char *text = dtext->expanded_text;
602     uint32_t code = 0;
603     int i, x1, y1;
604     uint8_t *p;
605     Glyph *glyph = NULL;
606
607     for (i = 0, p = text; *p; i++) {
608         Glyph dummy = { 0 };
609         GET_UTF8(code, *p++, continue;);
610
611         /* skip new line chars, just go to new line */
612         if (code == '\n' || code == '\r' || code == '\t')
613             continue;
614
615         dummy.code = code;
616         glyph = av_tree_find(dtext->glyphs, &dummy, (void *)glyph_cmp, NULL);
617
618         if (glyph->bitmap.pixel_mode != FT_PIXEL_MODE_MONO &&
619             glyph->bitmap.pixel_mode != FT_PIXEL_MODE_GRAY)
620             return AVERROR(EINVAL);
621
622         x1 = dtext->positions[i].x+dtext->x+x;
623         y1 = dtext->positions[i].y+dtext->y+y;
624
625         ff_blend_mask(&dtext->dc, color,
626                       picref->data, picref->linesize, width, height,
627                       glyph->bitmap.buffer, glyph->bitmap.pitch,
628                       glyph->bitmap.width, glyph->bitmap.rows,
629                       glyph->bitmap.pixel_mode == FT_PIXEL_MODE_MONO ? 0 : 3,
630                       0, x1, y1);
631     }
632
633     return 0;
634 }
635
636 static int draw_text(AVFilterContext *ctx, AVFilterBufferRef *picref,
637                      int width, int height)
638 {
639     DrawTextContext *dtext = ctx->priv;
640     uint32_t code = 0, prev_code = 0;
641     int x = 0, y = 0, i = 0, ret;
642     int max_text_line_w = 0, len;
643     int box_w, box_h;
644     char *text = dtext->text;
645     uint8_t *p;
646     int y_min = 32000, y_max = -32000;
647     int x_min = 32000, x_max = -32000;
648     FT_Vector delta;
649     Glyph *glyph = NULL, *prev_glyph = NULL;
650     Glyph dummy = { 0 };
651
652     time_t now = time(0);
653     struct tm ltime;
654     uint8_t *buf = dtext->expanded_text;
655     int buf_size = dtext->expanded_text_size;
656
657     if(dtext->basetime != AV_NOPTS_VALUE)
658         now= picref->pts*av_q2d(ctx->inputs[0]->time_base) + dtext->basetime/1000000;
659
660     if (!buf) {
661         buf_size = 2*strlen(dtext->text)+1;
662         buf = av_malloc(buf_size);
663     }
664
665 #if HAVE_LOCALTIME_R
666     localtime_r(&now, &ltime);
667 #else
668     if(strchr(dtext->text, '%'))
669         ltime= *localtime(&now);
670 #endif
671
672     do {
673         *buf = 1;
674         if (strftime(buf, buf_size, dtext->text, &ltime) != 0 || *buf == 0)
675             break;
676         buf_size *= 2;
677     } while ((buf = av_realloc(buf, buf_size)));
678
679     if (dtext->tc_opt_string) {
680         char tcbuf[AV_TIMECODE_STR_SIZE];
681         av_timecode_make_string(&dtext->tc, tcbuf, dtext->frame_id++);
682         buf = av_asprintf("%s%s", dtext->text, tcbuf);
683     }
684
685     if (!buf)
686         return AVERROR(ENOMEM);
687     text = dtext->expanded_text = buf;
688     dtext->expanded_text_size = buf_size;
689     if ((len = strlen(text)) > dtext->nb_positions) {
690         if (!(dtext->positions =
691               av_realloc(dtext->positions, len*sizeof(*dtext->positions))))
692             return AVERROR(ENOMEM);
693         dtext->nb_positions = len;
694     }
695
696     x = 0;
697     y = 0;
698
699     /* load and cache glyphs */
700     for (i = 0, p = text; *p; i++) {
701         GET_UTF8(code, *p++, continue;);
702
703         /* get glyph */
704         dummy.code = code;
705         glyph = av_tree_find(dtext->glyphs, &dummy, glyph_cmp, NULL);
706         if (!glyph) {
707             load_glyph(ctx, &glyph, code);
708         }
709
710         y_min = FFMIN(glyph->bbox.yMin, y_min);
711         y_max = FFMAX(glyph->bbox.yMax, y_max);
712         x_min = FFMIN(glyph->bbox.xMin, x_min);
713         x_max = FFMAX(glyph->bbox.xMax, x_max);
714     }
715     dtext->max_glyph_h = y_max - y_min;
716     dtext->max_glyph_w = x_max - x_min;
717
718     /* compute and save position for each glyph */
719     glyph = NULL;
720     for (i = 0, p = text; *p; i++) {
721         GET_UTF8(code, *p++, continue;);
722
723         /* skip the \n in the sequence \r\n */
724         if (prev_code == '\r' && code == '\n')
725             continue;
726
727         prev_code = code;
728         if (is_newline(code)) {
729             max_text_line_w = FFMAX(max_text_line_w, x);
730             y += dtext->max_glyph_h;
731             x = 0;
732             continue;
733         }
734
735         /* get glyph */
736         prev_glyph = glyph;
737         dummy.code = code;
738         glyph = av_tree_find(dtext->glyphs, &dummy, glyph_cmp, NULL);
739
740         /* kerning */
741         if (dtext->use_kerning && prev_glyph && glyph->code) {
742             FT_Get_Kerning(dtext->face, prev_glyph->code, glyph->code,
743                            ft_kerning_default, &delta);
744             x += delta.x >> 6;
745         }
746
747         /* save position */
748         dtext->positions[i].x = x + glyph->bitmap_left;
749         dtext->positions[i].y = y - glyph->bitmap_top + y_max;
750         if (code == '\t') x  = (x / dtext->tabsize + 1)*dtext->tabsize;
751         else              x += glyph->advance;
752     }
753
754     max_text_line_w = FFMAX(x, max_text_line_w);
755
756     dtext->var_values[VAR_TW] = dtext->var_values[VAR_TEXT_W] = max_text_line_w;
757     dtext->var_values[VAR_TH] = dtext->var_values[VAR_TEXT_H] = y + dtext->max_glyph_h;
758
759     dtext->var_values[VAR_MAX_GLYPH_W] = dtext->max_glyph_w;
760     dtext->var_values[VAR_MAX_GLYPH_H] = dtext->max_glyph_h;
761     dtext->var_values[VAR_MAX_GLYPH_A] = dtext->var_values[VAR_ASCENT ] = y_max;
762     dtext->var_values[VAR_MAX_GLYPH_D] = dtext->var_values[VAR_DESCENT] = y_min;
763
764     dtext->var_values[VAR_LINE_H] = dtext->var_values[VAR_LH] = dtext->max_glyph_h;
765
766     dtext->x = dtext->var_values[VAR_X] = av_expr_eval(dtext->x_pexpr, dtext->var_values, &dtext->prng);
767     dtext->y = dtext->var_values[VAR_Y] = av_expr_eval(dtext->y_pexpr, dtext->var_values, &dtext->prng);
768     dtext->x = dtext->var_values[VAR_X] = av_expr_eval(dtext->x_pexpr, dtext->var_values, &dtext->prng);
769     dtext->draw = av_expr_eval(dtext->draw_pexpr, dtext->var_values, &dtext->prng);
770
771     if(!dtext->draw)
772         return 0;
773
774     box_w = FFMIN(width - 1 , max_text_line_w);
775     box_h = FFMIN(height - 1, y + dtext->max_glyph_h);
776
777     /* draw box */
778     if (dtext->draw_box)
779         ff_blend_rectangle(&dtext->dc, &dtext->boxcolor,
780                            picref->data, picref->linesize, width, height,
781                            dtext->x, dtext->y, box_w, box_h);
782
783     if (dtext->shadowx || dtext->shadowy) {
784         if ((ret = draw_glyphs(dtext, picref, width, height, dtext->shadowcolor.rgba,
785                                &dtext->shadowcolor, dtext->shadowx, dtext->shadowy)) < 0)
786             return ret;
787     }
788
789     if ((ret = draw_glyphs(dtext, picref, width, height, dtext->fontcolor.rgba,
790                            &dtext->fontcolor, 0, 0)) < 0)
791         return ret;
792
793     return 0;
794 }
795
796 static void null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir) { }
797
798 static void end_frame(AVFilterLink *inlink)
799 {
800     AVFilterContext *ctx = inlink->dst;
801     AVFilterLink *outlink = ctx->outputs[0];
802     DrawTextContext *dtext = ctx->priv;
803     AVFilterBufferRef *picref = inlink->cur_buf;
804
805     dtext->var_values[VAR_T] = picref->pts == AV_NOPTS_VALUE ?
806         NAN : picref->pts * av_q2d(inlink->time_base);
807
808     draw_text(ctx, picref, picref->video->w, picref->video->h);
809
810     av_log(ctx, AV_LOG_DEBUG, "n:%d t:%f text_w:%d text_h:%d x:%d y:%d\n",
811            (int)dtext->var_values[VAR_N], dtext->var_values[VAR_T],
812            (int)dtext->var_values[VAR_TEXT_W], (int)dtext->var_values[VAR_TEXT_H],
813            dtext->x, dtext->y);
814
815     dtext->var_values[VAR_N] += 1.0;
816
817     ff_draw_slice(outlink, 0, picref->video->h, 1);
818     ff_end_frame(outlink);
819 }
820
821 AVFilter avfilter_vf_drawtext = {
822     .name          = "drawtext",
823     .description   = NULL_IF_CONFIG_SMALL("Draw text on top of video frames using libfreetype library."),
824     .priv_size     = sizeof(DrawTextContext),
825     .init          = init,
826     .uninit        = uninit,
827     .query_formats = query_formats,
828
829     .inputs    = (const AVFilterPad[]) {{ .name       = "default",
830                                     .type             = AVMEDIA_TYPE_VIDEO,
831                                     .get_video_buffer = ff_null_get_video_buffer,
832                                     .start_frame      = ff_null_start_frame,
833                                     .draw_slice       = null_draw_slice,
834                                     .end_frame        = end_frame,
835                                     .config_props     = config_input,
836                                     .min_perms        = AV_PERM_WRITE |
837                                                         AV_PERM_READ,
838                                     .rej_perms        = AV_PERM_PRESERVE },
839                                   { .name = NULL}},
840     .outputs   = (const AVFilterPad[]) {{ .name       = "default",
841                                     .type             = AVMEDIA_TYPE_VIDEO, },
842                                   { .name = NULL}},
843     .process_command = command,
844 };