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