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 Libav.
   7  *
   8  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  21  */
  22
  23 /**
  24  * @file
  25  * drawtext filter, based on the original vhook/drawtext.c
  26  * filter by Gustavo Sverzut Barbieri
  27  */
  28
  29 #include "config.h"
  30
  31 #include <sys/types.h>
  32 #include <sys/time.h>
  33 #include <sys/stat.h>
  34 #include <time.h>
  35 #include <unistd.h>
  36
  37 #if CONFIG_LIBFONTCONFIG
  38 #include <fontconfig/fontconfig.h>
  39 #endif
  40
  41 #include "libavutil/colorspace.h"
  42 #include "libavutil/common.h"
  43 #include "libavutil/file.h"
  44 #include "libavutil/eval.h"
  45 #include "libavutil/opt.h"
  46 #include "libavutil/mathematics.h"
  47 #include "libavutil/random_seed.h"
  48 #include "libavutil/parseutils.h"
  49 #include "libavutil/pixdesc.h"
  50 #include "libavutil/tree.h"
  51 #include "libavutil/lfg.h"
  52 #include "avfilter.h"
  53 #include "drawutils.h"
  54 #include "formats.h"
  55 #include "internal.h"
  56 #include "video.h"
  57
  58 #include <ft2build.h>
  59 #include FT_FREETYPE_H
  60 #include FT_GLYPH_H
  61
  62 static const char *const var_names[] = {
  63     "E",
  64     "PHI",
  65     "PI",
  66     "main_w",    "W", ///< width  of the main    video
  67     "main_h",    "H", ///< height of the main    video
  68     "text_w",    "w", ///< width  of the overlay text
  69     "text_h",    "h", ///< height of the overlay text
  70     "x",
  71     "y",
  72     "n",              ///< number of processed frames
  73     "t",              ///< timestamp expressed in seconds
  74     NULL
  75 };
  76
  77 static const char *const fun2_names[] = {
  78     "rand"
  79 };
  80
  81 static double drand(void *opaque, double min, double max)
  82 {
  83     return min + (max-min) / UINT_MAX * av_lfg_get(opaque);
  84 }
  85
  86 typedef double (*eval_func2)(void *, double a, double b);
  87
  88 static const eval_func2 fun2[] = {
  89     drand,
  90     NULL
  91 };
  92
  93 enum var_name {
  94     VAR_E,
  95     VAR_PHI,
  96     VAR_PI,
  97     VAR_MAIN_W, VAR_MW,
  98     VAR_MAIN_H, VAR_MH,
  99     VAR_TEXT_W, VAR_TW,
 100     VAR_TEXT_H, VAR_TH,
 101     VAR_X,
 102     VAR_Y,
 103     VAR_N,
 104     VAR_T,
 105     VAR_VARS_NB
 106 };
 107
 108 typedef struct DrawTextContext {
 109     const AVClass *class;
 110 #if CONFIG_LIBFONTCONFIG
 111     uint8_t *font;              ///< font to be used
 112 #endif
 113     uint8_t *fontfile;              ///< font to be used
 114     uint8_t *text;                  ///< text to be drawn
 115     uint8_t *expanded_text;         ///< used to contain the strftime()-expanded text
 116     size_t   expanded_text_size;    ///< size in bytes of the expanded_text buffer
 117     int ft_load_flags;              ///< flags used for loading fonts, see FT_LOAD_*
 118     FT_Vector *positions;           ///< positions for each element in the text
 119     size_t nb_positions;            ///< number of elements of positions array
 120     char *textfile;                 ///< file with text to be drawn
 121     int x, y;                       ///< position to start drawing text
 122     int w, h;                       ///< dimension of the text block
 123     int shadowx, shadowy;
 124     unsigned int fontsize;          ///< font size to use
 125     char *fontcolor_string;         ///< font color as string
 126     char *boxcolor_string;          ///< box color as string
 127     char *shadowcolor_string;       ///< shadow color as string
 128     uint8_t fontcolor[4];           ///< foreground color
 129     uint8_t boxcolor[4];            ///< background color
 130     uint8_t shadowcolor[4];         ///< shadow color
 131     uint8_t fontcolor_rgba[4];      ///< foreground color in RGBA
 132     uint8_t boxcolor_rgba[4];       ///< background color in RGBA
 133     uint8_t shadowcolor_rgba[4];    ///< shadow color in RGBA
 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     FT_Library library;             ///< freetype font library handle
 141     FT_Face face;                   ///< freetype font face handle
 142     struct AVTreeNode *glyphs;      ///< rendered glyphs, stored using the UTF-32 char code
 143     int hsub, vsub;                 ///< chroma subsampling values
 144     int is_packed_rgb;
 145     int pixel_step[4];              ///< distance in bytes between the component of each pixel
 146     uint8_t rgba_map[4];            ///< map RGBA offsets to the positions in the packed RGBA format
 147     uint8_t *box_line[4];           ///< line used for filling the box background
 148     char   *x_expr, *y_expr;
 149     AVExpr *x_pexpr, *y_pexpr;      ///< parsed expressions for x and y
 150     double var_values[VAR_VARS_NB];
 151     char   *d_expr;
 152     AVExpr *d_pexpr;
 153     int draw;                       ///< set to zero to prevent drawing
 154     AVLFG  prng;                    ///< random
 155 } DrawTextContext;
 156
 157 #define OFFSET(x) offsetof(DrawTextContext, x)
 158 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM
 159
 160 static const AVOption drawtext_options[]= {
 161 #if CONFIG_LIBFONTCONFIG
 162     { "font",        "Font name",            OFFSET(font),               AV_OPT_TYPE_STRING, { .str = "Sans" },           .flags = FLAGS },
 163 #endif
 164     { "fontfile",    NULL,                   OFFSET(fontfile),           AV_OPT_TYPE_STRING,                              .flags = FLAGS },
 165     { "text",        NULL,                   OFFSET(text),               AV_OPT_TYPE_STRING,                              .flags = FLAGS },
 166     { "textfile",    NULL,                   OFFSET(textfile),           AV_OPT_TYPE_STRING,                              .flags = FLAGS },
 167     { "fontcolor",   NULL,                   OFFSET(fontcolor_string),   AV_OPT_TYPE_STRING, { .str = "black" },          .flags = FLAGS },
 168     { "boxcolor",    NULL,                   OFFSET(boxcolor_string),    AV_OPT_TYPE_STRING, { .str = "white" },          .flags = FLAGS },
 169     { "shadowcolor", NULL,                   OFFSET(shadowcolor_string), AV_OPT_TYPE_STRING, { .str = "black" },          .flags = FLAGS },
 170     { "box",         NULL,                   OFFSET(draw_box),           AV_OPT_TYPE_INT,    { .i64 = 0       }, 0,       1,       FLAGS },
 171     { "fontsize",    NULL,                   OFFSET(fontsize),           AV_OPT_TYPE_INT,    { .i64 = 16      }, 1,       72,      FLAGS },
 172     { "x",           NULL,                   OFFSET(x_expr),             AV_OPT_TYPE_STRING, { .str = "0"     },          .flags = FLAGS },
 173     { "y",           NULL,                   OFFSET(y_expr),             AV_OPT_TYPE_STRING, { .str = "0"     },          .flags = FLAGS },
 174     { "shadowx",     NULL,                   OFFSET(shadowx),            AV_OPT_TYPE_INT,    { .i64 = 0       }, INT_MIN, INT_MAX, FLAGS },
 175     { "shadowy",     NULL,                   OFFSET(shadowy),            AV_OPT_TYPE_INT,    { .i64 = 0       }, INT_MIN, INT_MAX, FLAGS },
 176     { "tabsize",     NULL,                   OFFSET(tabsize),            AV_OPT_TYPE_INT,    { .i64 = 4       }, 0,       INT_MAX, FLAGS },
 177     { "draw",        "if false do not draw", OFFSET(d_expr),             AV_OPT_TYPE_STRING, { .str = "1"     },          .flags = FLAGS },
 178     { "fix_bounds",  "if true, check and fix text coords to avoid clipping",
 179                                             OFFSET(fix_bounds),          AV_OPT_TYPE_INT,    { .i64 = 1       }, 0,       1,       FLAGS },
 180
 181     /* FT_LOAD_* flags */
 182     { "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" },
 183         { "default",                     NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_DEFAULT },                     .flags = FLAGS, .unit = "ft_load_flags" },
 184         { "no_scale",                    NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_SCALE },                    .flags = FLAGS, .unit = "ft_load_flags" },
 185         { "no_hinting",                  NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_HINTING },                  .flags = FLAGS, .unit = "ft_load_flags" },
 186         { "render",                      NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_RENDER },                      .flags = FLAGS, .unit = "ft_load_flags" },
 187         { "no_bitmap",                   NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_BITMAP },                   .flags = FLAGS, .unit = "ft_load_flags" },
 188         { "vertical_layout",             NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_VERTICAL_LAYOUT },             .flags = FLAGS, .unit = "ft_load_flags" },
 189         { "force_autohint",              NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_FORCE_AUTOHINT },              .flags = FLAGS, .unit = "ft_load_flags" },
 190         { "crop_bitmap",                 NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_CROP_BITMAP },                 .flags = FLAGS, .unit = "ft_load_flags" },
 191         { "pedantic",                    NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_PEDANTIC },                    .flags = FLAGS, .unit = "ft_load_flags" },
 192         { "ignore_global_advance_width", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH }, .flags = FLAGS, .unit = "ft_load_flags" },
 193         { "no_recurse",                  NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_RECURSE },                  .flags = FLAGS, .unit = "ft_load_flags" },
 194         { "ignore_transform",            NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_IGNORE_TRANSFORM },            .flags = FLAGS, .unit = "ft_load_flags" },
 195         { "monochrome",                  NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_MONOCHROME },                  .flags = FLAGS, .unit = "ft_load_flags" },
 196         { "linear_design",               NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_LINEAR_DESIGN },               .flags = FLAGS, .unit = "ft_load_flags" },
 197         { "no_autohint",                 NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FT_LOAD_NO_AUTOHINT },                 .flags = FLAGS, .unit = "ft_load_flags" },
 198     { NULL},
 199 };
 200
 201 static const char *drawtext_get_name(void *ctx)
 202 {
 203     return "drawtext";
 204 }
 205
 206 static const AVClass drawtext_class = {
 207     "DrawTextContext",
 208     drawtext_get_name,
 209     drawtext_options
 210 };
 211
 212 #undef __FTERRORS_H__
 213 #define FT_ERROR_START_LIST {
 214 #define FT_ERRORDEF(e, v, s) { (e), (s) },
 215 #define FT_ERROR_END_LIST { 0, NULL } };
 216
 217 struct ft_error
 218 {
 219     int err;
 220     const char *err_msg;
 221 } static ft_errors[] =
 222 #include FT_ERRORS_H
 223
 224 #define FT_ERRMSG(e) ft_errors[e].err_msg
 225
 226 typedef struct Glyph {
 227     FT_Glyph *glyph;
 228     uint32_t code;
 229     FT_Bitmap bitmap; ///< array holding bitmaps of font
 230     FT_BBox bbox;
 231     int advance;
 232     int bitmap_left;
 233     int bitmap_top;
 234 } Glyph;
 235
 236 static int glyph_cmp(void *key, const void *b)
 237 {
 238     const Glyph *a = key, *bb = b;
 239     int64_t diff = (int64_t)a->code - (int64_t)bb->code;
 240     return diff > 0 ? 1 : diff < 0 ? -1 : 0;
 241 }
 242
 243 /**
 244  * Load glyphs corresponding to the UTF-32 codepoint code.
 245  */
 246 static int load_glyph(AVFilterContext *ctx, Glyph **glyph_ptr, uint32_t code)
 247 {
 248     DrawTextContext *s = ctx->priv;
 249     Glyph *glyph;
 250     struct AVTreeNode *node = NULL;
 251     int ret;
 252
 253     /* load glyph into s->face->glyph */
 254     if (FT_Load_Char(s->face, code, s->ft_load_flags))
 255         return AVERROR(EINVAL);
 256
 257     /* save glyph */
 258     if (!(glyph = av_mallocz(sizeof(*glyph))) ||
 259         !(glyph->glyph = av_mallocz(sizeof(*glyph->glyph)))) {
 260         ret = AVERROR(ENOMEM);
 261         goto error;
 262     }
 263     glyph->code  = code;
 264
 265     if (FT_Get_Glyph(s->face->glyph, glyph->glyph)) {
 266         ret = AVERROR(EINVAL);
 267         goto error;
 268     }
 269
 270     glyph->bitmap      = s->face->glyph->bitmap;
 271     glyph->bitmap_left = s->face->glyph->bitmap_left;
 272     glyph->bitmap_top  = s->face->glyph->bitmap_top;
 273     glyph->advance     = s->face->glyph->advance.x >> 6;
 274
 275     /* measure text height to calculate text_height (or the maximum text height) */
 276     FT_Glyph_Get_CBox(*glyph->glyph, ft_glyph_bbox_pixels, &glyph->bbox);
 277
 278     /* cache the newly created glyph */
 279     if (!(node = av_tree_node_alloc())) {
 280         ret = AVERROR(ENOMEM);
 281         goto error;
 282     }
 283     av_tree_insert(&s->glyphs, glyph, glyph_cmp, &node);
 284
 285     if (glyph_ptr)
 286         *glyph_ptr = glyph;
 287     return 0;
 288
 289 error:
 290     if (glyph)
 291         av_freep(&glyph->glyph);
 292     av_freep(&glyph);
 293     av_freep(&node);
 294     return ret;
 295 }
 296
 297 static int parse_font(AVFilterContext *ctx)
 298 {
 299     DrawTextContext *s = ctx->priv;
 300 #if !CONFIG_LIBFONTCONFIG
 301     if (!s->fontfile) {
 302         av_log(ctx, AV_LOG_ERROR, "No font filename provided\n");
 303         return AVERROR(EINVAL);
 304     }
 305
 306     return 0;
 307 #else
 308     FcPattern *pat, *best;
 309     FcResult result = FcResultMatch;
 310
 311     FcBool fc_bool;
 312     FcChar8* fc_string;
 313     int err = AVERROR(ENOENT);
 314
 315     if (s->fontfile)
 316         return 0;
 317
 318     if (!FcInit())
 319         return AVERROR_UNKNOWN;
 320
 321     if (!(pat = FcPatternCreate()))
 322         return AVERROR(ENOMEM);
 323
 324     FcPatternAddString(pat, FC_FAMILY, s->font);
 325     FcPatternAddBool(pat, FC_OUTLINE, FcTrue);
 326     FcPatternAddDouble(pat, FC_SIZE, (double)s->fontsize);
 327
 328     FcDefaultSubstitute(pat);
 329
 330     if (!FcConfigSubstitute(NULL, pat, FcMatchPattern)) {
 331         FcPatternDestroy(pat);
 332         return AVERROR(ENOMEM);
 333     }
 334
 335     best = FcFontMatch(NULL, pat, &result);
 336     FcPatternDestroy(pat);
 337
 338     if (!best || result == FcResultNoMatch) {
 339          av_log(ctx, AV_LOG_ERROR,
 340                 "Cannot find a valid font for the family %s\n",
 341                 s->font);
 342         goto fail;
 343     }
 344
 345     if (FcPatternGetBool(best, FC_OUTLINE, 0, &fc_bool) != FcResultMatch ||
 346         !fc_bool) {
 347         av_log(ctx, AV_LOG_ERROR, "Outline not available for %s\n",
 348                s->font);
 349         goto fail;
 350     }
 351
 352     if (FcPatternGetString(best, FC_FAMILY, 0, &fc_string) != FcResultMatch) {
 353         av_log(ctx, AV_LOG_ERROR, "No matches for %s\n",
 354                s->font);
 355         goto fail;
 356     }
 357
 358     if (FcPatternGetString(best, FC_FILE, 0, &fc_string) != FcResultMatch) {
 359         av_log(ctx, AV_LOG_ERROR, "No file path for %s\n",
 360                s->font);
 361         goto fail;
 362     }
 363
 364     s->fontfile = av_strdup(fc_string);
 365     if (!s->fontfile)
 366         err = AVERROR(ENOMEM);
 367     else
 368         err = 0;
 369
 370 fail:
 371     FcPatternDestroy(best);
 372     return err;
 373 #endif
 374 }
 375
 376 static av_cold int init(AVFilterContext *ctx)
 377 {
 378     int err;
 379     DrawTextContext *s = ctx->priv;
 380     Glyph *glyph;
 381
 382     if ((err = parse_font(ctx)) < 0)
 383         return err;
 384
 385     if (s->textfile) {
 386         uint8_t *textbuf;
 387         size_t textbuf_size;
 388
 389         if (s->text) {
 390             av_log(ctx, AV_LOG_ERROR,
 391                    "Both text and text file provided. Please provide only one\n");
 392             return AVERROR(EINVAL);
 393         }
 394         if ((err = av_file_map(s->textfile, &textbuf, &textbuf_size, 0, ctx)) < 0) {
 395             av_log(ctx, AV_LOG_ERROR,
 396                    "The text file '%s' could not be read or is empty\n",
 397                    s->textfile);
 398             return err;
 399         }
 400
 401         if (textbuf_size > SIZE_MAX - 1 ||
 402             !(s->text = av_malloc(textbuf_size + 1))) {
 403             av_file_unmap(textbuf, textbuf_size);
 404             return AVERROR(ENOMEM);
 405         }
 406         memcpy(s->text, textbuf, textbuf_size);
 407         s->text[textbuf_size] = 0;
 408         av_file_unmap(textbuf, textbuf_size);
 409     }
 410
 411     if (!s->text) {
 412         av_log(ctx, AV_LOG_ERROR,
 413                "Either text or a valid file must be provided\n");
 414         return AVERROR(EINVAL);
 415     }
 416
 417     if ((err = av_parse_color(s->fontcolor_rgba, s->fontcolor_string, -1, ctx))) {
 418         av_log(ctx, AV_LOG_ERROR,
 419                "Invalid font color '%s'\n", s->fontcolor_string);
 420         return err;
 421     }
 422
 423     if ((err = av_parse_color(s->boxcolor_rgba, s->boxcolor_string, -1, ctx))) {
 424         av_log(ctx, AV_LOG_ERROR,
 425                "Invalid box color '%s'\n", s->boxcolor_string);
 426         return err;
 427     }
 428
 429     if ((err = av_parse_color(s->shadowcolor_rgba, s->shadowcolor_string, -1, ctx))) {
 430         av_log(ctx, AV_LOG_ERROR,
 431                "Invalid shadow color '%s'\n", s->shadowcolor_string);
 432         return err;
 433     }
 434
 435     if ((err = FT_Init_FreeType(&(s->library)))) {
 436         av_log(ctx, AV_LOG_ERROR,
 437                "Could not load FreeType: %s\n", FT_ERRMSG(err));
 438         return AVERROR(EINVAL);
 439     }
 440
 441     /* load the face, and set up the encoding, which is by default UTF-8 */
 442     if ((err = FT_New_Face(s->library, s->fontfile, 0, &s->face))) {
 443         av_log(ctx, AV_LOG_ERROR, "Could not load fontface from file '%s': %s\n",
 444                s->fontfile, FT_ERRMSG(err));
 445         return AVERROR(EINVAL);
 446     }
 447     if ((err = FT_Set_Pixel_Sizes(s->face, 0, s->fontsize))) {
 448         av_log(ctx, AV_LOG_ERROR, "Could not set font size to %d pixels: %s\n",
 449                s->fontsize, FT_ERRMSG(err));
 450         return AVERROR(EINVAL);
 451     }
 452
 453     s->use_kerning = FT_HAS_KERNING(s->face);
 454
 455     /* load the fallback glyph with code 0 */
 456     load_glyph(ctx, NULL, 0);
 457
 458     /* set the tabsize in pixels */
 459     if ((err = load_glyph(ctx, &glyph, ' ') < 0)) {
 460         av_log(ctx, AV_LOG_ERROR, "Could not set tabsize.\n");
 461         return err;
 462     }
 463     s->tabsize *= glyph->advance;
 464
 465 #if !HAVE_LOCALTIME_R
 466     av_log(ctx, AV_LOG_WARNING, "strftime() expansion unavailable!\n");
 467 #endif
 468
 469     return 0;
 470 }
 471
 472 static int query_formats(AVFilterContext *ctx)
 473 {
 474     static const enum AVPixelFormat pix_fmts[] = {
 475         AV_PIX_FMT_ARGB,    AV_PIX_FMT_RGBA,
 476         AV_PIX_FMT_ABGR,    AV_PIX_FMT_BGRA,
 477         AV_PIX_FMT_RGB24,   AV_PIX_FMT_BGR24,
 478         AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV444P,
 479         AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV411P,
 480         AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV440P,
 481         AV_PIX_FMT_NONE
 482     };
 483
 484     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
 485     return 0;
 486 }
 487
 488 static int glyph_enu_free(void *opaque, void *elem)
 489 {
 490     av_free(elem);
 491     return 0;
 492 }
 493
 494 static av_cold void uninit(AVFilterContext *ctx)
 495 {
 496     DrawTextContext *s = ctx->priv;
 497     int i;
 498
 499     av_expr_free(s->x_pexpr);
 500     av_expr_free(s->y_pexpr);
 501     av_expr_free(s->d_pexpr);
 502     s->x_pexpr = s->y_pexpr = s->d_pexpr = NULL;
 503     av_freep(&s->expanded_text);
 504     av_freep(&s->positions);
 505     av_tree_enumerate(s->glyphs, NULL, NULL, glyph_enu_free);
 506     av_tree_destroy(s->glyphs);
 507     s->glyphs = 0;
 508     FT_Done_Face(s->face);
 509     FT_Done_FreeType(s->library);
 510
 511     for (i = 0; i < 4; i++) {
 512         av_freep(&s->box_line[i]);
 513         s->pixel_step[i] = 0;
 514     }
 515
 516 }
 517
 518 static inline int is_newline(uint32_t c)
 519 {
 520     return c == '\n' || c == '\r' || c == '\f' || c == '\v';
 521 }
 522
 523 static int dtext_prepare_text(AVFilterContext *ctx)
 524 {
 525     DrawTextContext *s = ctx->priv;
 526     uint32_t code = 0, prev_code = 0;
 527     int x = 0, y = 0, i = 0, ret;
 528     int text_height, baseline;
 529     char *text = s->text;
 530     uint8_t *p;
 531     int str_w = 0, len;
 532     int y_min = 32000, y_max = -32000;
 533     FT_Vector delta;
 534     Glyph *glyph = NULL, *prev_glyph = NULL;
 535     Glyph dummy = { 0 };
 536     int width  = ctx->inputs[0]->w;
 537     int height = ctx->inputs[0]->h;
 538
 539 #if HAVE_LOCALTIME_R
 540     time_t now = time(0);
 541     struct tm ltime;
 542     uint8_t *buf = s->expanded_text;
 543     int buf_size = s->expanded_text_size;
 544
 545     if (!buf)
 546         buf_size = 2*strlen(s->text)+1;
 547
 548     localtime_r(&now, &ltime);
 549
 550     while ((buf = av_realloc(buf, buf_size))) {
 551         *buf = 1;
 552         if (strftime(buf, buf_size, s->text, &ltime) != 0 || *buf == 0)
 553             break;
 554         buf_size *= 2;
 555     }
 556
 557     if (!buf)
 558         return AVERROR(ENOMEM);
 559     text = s->expanded_text = buf;
 560     s->expanded_text_size = buf_size;
 561 #endif
 562
 563     if ((len = strlen(text)) > s->nb_positions) {
 564         FT_Vector *p = av_realloc(s->positions,
 565                                   len * sizeof(*s->positions));
 566         if (!p) {
 567             av_freep(s->positions);
 568             s->nb_positions = 0;
 569             return AVERROR(ENOMEM);
 570         } else {
 571             s->positions = p;
 572             s->nb_positions = len;
 573         }
 574     }
 575
 576     /* load and cache glyphs */
 577     for (i = 0, p = text; *p; i++) {
 578         GET_UTF8(code, *p++, continue;);
 579
 580         /* get glyph */
 581         dummy.code = code;
 582         glyph = av_tree_find(s->glyphs, &dummy, glyph_cmp, NULL);
 583         if (!glyph) {
 584             ret = load_glyph(ctx, &glyph, code);
 585             if (ret)
 586                 return ret;
 587         }
 588
 589         y_min = FFMIN(glyph->bbox.yMin, y_min);
 590         y_max = FFMAX(glyph->bbox.yMax, y_max);
 591     }
 592     text_height = y_max - y_min;
 593     baseline    = y_max;
 594
 595     /* compute and save position for each glyph */
 596     glyph = NULL;
 597     for (i = 0, p = text; *p; i++) {
 598         GET_UTF8(code, *p++, continue;);
 599
 600         /* skip the \n in the sequence \r\n */
 601         if (prev_code == '\r' && code == '\n')
 602             continue;
 603
 604         prev_code = code;
 605         if (is_newline(code)) {
 606             str_w = FFMAX(str_w, x - s->x);
 607             y += text_height;
 608             x = 0;
 609             continue;
 610         }
 611
 612         /* get glyph */
 613         prev_glyph = glyph;
 614         dummy.code = code;
 615         glyph = av_tree_find(s->glyphs, &dummy, glyph_cmp, NULL);
 616
 617         /* kerning */
 618         if (s->use_kerning && prev_glyph && glyph->code) {
 619             FT_Get_Kerning(s->face, prev_glyph->code, glyph->code,
 620                            ft_kerning_default, &delta);
 621             x += delta.x >> 6;
 622         }
 623
 624         if (x + glyph->bbox.xMax >= width) {
 625             str_w = FFMAX(str_w, x);
 626             y += text_height;
 627             x = 0;
 628         }
 629
 630         /* save position */
 631         s->positions[i].x = x + glyph->bitmap_left;
 632         s->positions[i].y = y - glyph->bitmap_top + baseline;
 633         if (code == '\t') x  = (x / s->tabsize + 1)*s->tabsize;
 634         else              x += glyph->advance;
 635     }
 636
 637     str_w = FFMIN(width - 1, FFMAX(str_w, x));
 638     y     = FFMIN(y + text_height, height - 1);
 639
 640     s->w = str_w;
 641     s->var_values[VAR_TEXT_W] = s->var_values[VAR_TW] = s->w;
 642     s->h = y;
 643     s->var_values[VAR_TEXT_H] = s->var_values[VAR_TH] = s->h;
 644
 645     return 0;
 646 }
 647
 648
 649 static int config_input(AVFilterLink *inlink)
 650 {
 651     AVFilterContext *ctx  = inlink->dst;
 652     DrawTextContext *s = ctx->priv;
 653     const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(inlink->format);
 654     int ret;
 655
 656     s->hsub = pix_desc->log2_chroma_w;
 657     s->vsub = pix_desc->log2_chroma_h;
 658
 659     s->var_values[VAR_E  ] = M_E;
 660     s->var_values[VAR_PHI] = M_PHI;
 661     s->var_values[VAR_PI ] = M_PI;
 662
 663     s->var_values[VAR_MAIN_W] =
 664         s->var_values[VAR_MW] = ctx->inputs[0]->w;
 665     s->var_values[VAR_MAIN_H] =
 666         s->var_values[VAR_MH] = ctx->inputs[0]->h;
 667
 668     s->var_values[VAR_X] = 0;
 669     s->var_values[VAR_Y] = 0;
 670     s->var_values[VAR_T] = NAN;
 671
 672     av_lfg_init(&s->prng, av_get_random_seed());
 673
 674     av_expr_free(s->x_pexpr);
 675     av_expr_free(s->y_pexpr);
 676     av_expr_free(s->d_pexpr);
 677     s->x_pexpr = s->y_pexpr = s->d_pexpr = NULL;
 678     if ((ret = av_expr_parse(&s->x_pexpr, s->x_expr, var_names,
 679                              NULL, NULL, fun2_names, fun2, 0, ctx)) < 0 ||
 680         (ret = av_expr_parse(&s->y_pexpr, s->y_expr, var_names,
 681                              NULL, NULL, fun2_names, fun2, 0, ctx)) < 0 ||
 682         (ret = av_expr_parse(&s->d_pexpr, s->d_expr, var_names,
 683                              NULL, NULL, fun2_names, fun2, 0, ctx)) < 0)
 684         return AVERROR(EINVAL);
 685
 686     if ((ret =
 687          ff_fill_line_with_color(s->box_line, s->pixel_step,
 688                                  inlink->w, s->boxcolor,
 689                                  inlink->format, s->boxcolor_rgba,
 690                                  &s->is_packed_rgb, s->rgba_map)) < 0)
 691         return ret;
 692
 693     if (!s->is_packed_rgb) {
 694         uint8_t *rgba = s->fontcolor_rgba;
 695         s->fontcolor[0] = RGB_TO_Y_CCIR(rgba[0], rgba[1], rgba[2]);
 696         s->fontcolor[1] = RGB_TO_U_CCIR(rgba[0], rgba[1], rgba[2], 0);
 697         s->fontcolor[2] = RGB_TO_V_CCIR(rgba[0], rgba[1], rgba[2], 0);
 698         s->fontcolor[3] = rgba[3];
 699         rgba = s->shadowcolor_rgba;
 700         s->shadowcolor[0] = RGB_TO_Y_CCIR(rgba[0], rgba[1], rgba[2]);
 701         s->shadowcolor[1] = RGB_TO_U_CCIR(rgba[0], rgba[1], rgba[2], 0);
 702         s->shadowcolor[2] = RGB_TO_V_CCIR(rgba[0], rgba[1], rgba[2], 0);
 703         s->shadowcolor[3] = rgba[3];
 704     }
 705
 706     s->draw = 1;
 707
 708     return dtext_prepare_text(ctx);
 709 }
 710
 711 #define GET_BITMAP_VAL(r, c)                                            \
 712     bitmap->pixel_mode == FT_PIXEL_MODE_MONO ?                          \
 713         (bitmap->buffer[(r) * bitmap->pitch + ((c)>>3)] & (0x80 >> ((c)&7))) * 255 : \
 714          bitmap->buffer[(r) * bitmap->pitch +  (c)]
 715
 716 #define SET_PIXEL_YUV(frame, yuva_color, val, x, y, hsub, vsub) {           \
 717     luma_pos    = ((x)          ) + ((y)          ) * frame->linesize[0]; \
 718     alpha = yuva_color[3] * (val) * 129;                               \
 719     frame->data[0][luma_pos]    = (alpha * yuva_color[0] + (255*255*129 - alpha) * frame->data[0][luma_pos]   ) >> 23; \
 720     if (((x) & ((1<<(hsub)) - 1)) == 0 && ((y) & ((1<<(vsub)) - 1)) == 0) {\
 721         chroma_pos1 = ((x) >> (hsub)) + ((y) >> (vsub)) * frame->linesize[1]; \
 722         chroma_pos2 = ((x) >> (hsub)) + ((y) >> (vsub)) * frame->linesize[2]; \
 723         frame->data[1][chroma_pos1] = (alpha * yuva_color[1] + (255*255*129 - alpha) * frame->data[1][chroma_pos1]) >> 23; \
 724         frame->data[2][chroma_pos2] = (alpha * yuva_color[2] + (255*255*129 - alpha) * frame->data[2][chroma_pos2]) >> 23; \
 725     }\
 726 }
 727
 728 static inline int draw_glyph_yuv(AVFrame *frame, FT_Bitmap *bitmap, unsigned int x,
 729                                  unsigned int y, unsigned int width, unsigned int height,
 730                                  const uint8_t yuva_color[4], int hsub, int vsub)
 731 {
 732     int r, c, alpha;
 733     unsigned int luma_pos, chroma_pos1, chroma_pos2;
 734     uint8_t src_val;
 735
 736     for (r = 0; r < bitmap->rows && r+y < height; r++) {
 737         for (c = 0; c < bitmap->width && c+x < width; c++) {
 738             /* get intensity value in the glyph bitmap (source) */
 739             src_val = GET_BITMAP_VAL(r, c);
 740             if (!src_val)
 741                 continue;
 742
 743             SET_PIXEL_YUV(frame, yuva_color, src_val, c+x, y+r, hsub, vsub);
 744         }
 745     }
 746
 747     return 0;
 748 }
 749
 750 #define SET_PIXEL_RGB(frame, rgba_color, val, x, y, pixel_step, r_off, g_off, b_off, a_off) { \
 751     p   = frame->data[0] + (x) * pixel_step + ((y) * frame->linesize[0]); \
 752     alpha = rgba_color[3] * (val) * 129;                              \
 753     *(p+r_off) = (alpha * rgba_color[0] + (255*255*129 - alpha) * *(p+r_off)) >> 23; \
 754     *(p+g_off) = (alpha * rgba_color[1] + (255*255*129 - alpha) * *(p+g_off)) >> 23; \
 755     *(p+b_off) = (alpha * rgba_color[2] + (255*255*129 - alpha) * *(p+b_off)) >> 23; \
 756 }
 757
 758 static inline int draw_glyph_rgb(AVFrame *frame, FT_Bitmap *bitmap,
 759                                  unsigned int x, unsigned int y,
 760                                  unsigned int width, unsigned int height, int pixel_step,
 761                                  const uint8_t rgba_color[4], const uint8_t rgba_map[4])
 762 {
 763     int r, c, alpha;
 764     uint8_t *p;
 765     uint8_t src_val;
 766
 767     for (r = 0; r < bitmap->rows && r+y < height; r++) {
 768         for (c = 0; c < bitmap->width && c+x < width; c++) {
 769             /* get intensity value in the glyph bitmap (source) */
 770             src_val = GET_BITMAP_VAL(r, c);
 771             if (!src_val)
 772                 continue;
 773
 774             SET_PIXEL_RGB(frame, rgba_color, src_val, c+x, y+r, pixel_step,
 775                           rgba_map[0], rgba_map[1], rgba_map[2], rgba_map[3]);
 776         }
 777     }
 778
 779     return 0;
 780 }
 781
 782 static inline void drawbox(AVFrame *frame, unsigned int x, unsigned int y,
 783                            unsigned int width, unsigned int height,
 784                            uint8_t *line[4], int pixel_step[4], uint8_t color[4],
 785                            int hsub, int vsub, int is_rgba_packed, uint8_t rgba_map[4])
 786 {
 787     int i, j, alpha;
 788
 789     if (color[3] != 0xFF) {
 790         if (is_rgba_packed) {
 791             uint8_t *p;
 792             for (j = 0; j < height; j++)
 793                 for (i = 0; i < width; i++)
 794                     SET_PIXEL_RGB(frame, color, 255, i+x, y+j, pixel_step[0],
 795                                   rgba_map[0], rgba_map[1], rgba_map[2], rgba_map[3]);
 796         } else {
 797             unsigned int luma_pos, chroma_pos1, chroma_pos2;
 798             for (j = 0; j < height; j++)
 799                 for (i = 0; i < width; i++)
 800                     SET_PIXEL_YUV(frame, color, 255, i+x, y+j, hsub, vsub);
 801         }
 802     } else {
 803         ff_draw_rectangle(frame->data, frame->linesize,
 804                           line, pixel_step, hsub, vsub,
 805                           x, y, width, height);
 806     }
 807 }
 808
 809 static int draw_glyphs(DrawTextContext *s, AVFrame *frame,
 810                        int width, int height, const uint8_t rgbcolor[4], const uint8_t yuvcolor[4], int x, int y)
 811 {
 812     char *text = HAVE_LOCALTIME_R ? s->expanded_text : s->text;
 813     uint32_t code = 0;
 814     int i;
 815     uint8_t *p;
 816     Glyph *glyph = NULL;
 817
 818     for (i = 0, p = text; *p; i++) {
 819         Glyph dummy = { 0 };
 820         GET_UTF8(code, *p++, continue;);
 821
 822         /* skip new line chars, just go to new line */
 823         if (code == '\n' || code == '\r' || code == '\t')
 824             continue;
 825
 826         dummy.code = code;
 827         glyph = av_tree_find(s->glyphs, &dummy, (void *)glyph_cmp, NULL);
 828
 829         if (glyph->bitmap.pixel_mode != FT_PIXEL_MODE_MONO &&
 830             glyph->bitmap.pixel_mode != FT_PIXEL_MODE_GRAY)
 831             return AVERROR(EINVAL);
 832
 833         if (s->is_packed_rgb) {
 834             draw_glyph_rgb(frame, &glyph->bitmap,
 835                            s->positions[i].x+x, s->positions[i].y+y, width, height,
 836                            s->pixel_step[0], rgbcolor, s->rgba_map);
 837         } else {
 838             draw_glyph_yuv(frame, &glyph->bitmap,
 839                            s->positions[i].x+x, s->positions[i].y+y, width, height,
 840                            yuvcolor, s->hsub, s->vsub);
 841         }
 842     }
 843
 844     return 0;
 845 }
 846
 847 static int draw_text(AVFilterContext *ctx, AVFrame *frame,
 848                      int width, int height)
 849 {
 850     DrawTextContext *s = ctx->priv;
 851     int ret;
 852
 853     /* draw box */
 854     if (s->draw_box)
 855         drawbox(frame, s->x, s->y, s->w, s->h,
 856                 s->box_line, s->pixel_step, s->boxcolor,
 857                 s->hsub, s->vsub, s->is_packed_rgb,
 858                 s->rgba_map);
 859
 860     if (s->shadowx || s->shadowy) {
 861         if ((ret = draw_glyphs(s, frame, width, height,
 862                                s->shadowcolor_rgba,
 863                                s->shadowcolor,
 864                                s->x + s->shadowx,
 865                                s->y + s->shadowy)) < 0)
 866             return ret;
 867     }
 868
 869     if ((ret = draw_glyphs(s, frame, width, height,
 870                            s->fontcolor_rgba,
 871                            s->fontcolor,
 872                            s->x,
 873                            s->y)) < 0)
 874         return ret;
 875
 876     return 0;
 877 }
 878
 879 static inline int normalize_double(int *n, double d)
 880 {
 881     int ret = 0;
 882
 883     if (isnan(d)) {
 884         ret = AVERROR(EINVAL);
 885     } else if (d > INT_MAX || d < INT_MIN) {
 886         *n = d > INT_MAX ? INT_MAX : INT_MIN;
 887         ret = AVERROR(EINVAL);
 888     } else
 889         *n = round(d);
 890
 891     return ret;
 892 }
 893
 894 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
 895 {
 896     AVFilterContext *ctx = inlink->dst;
 897     DrawTextContext *s = ctx->priv;
 898     int ret = 0;
 899
 900     if ((ret = dtext_prepare_text(ctx)) < 0) {
 901         av_log(ctx, AV_LOG_ERROR, "Can't draw text\n");
 902         av_frame_free(&frame);
 903         return ret;
 904     }
 905
 906     s->var_values[VAR_T] = frame->pts == AV_NOPTS_VALUE ?
 907         NAN : frame->pts * av_q2d(inlink->time_base);
 908     s->var_values[VAR_X] =
 909         av_expr_eval(s->x_pexpr, s->var_values, &s->prng);
 910     s->var_values[VAR_Y] =
 911         av_expr_eval(s->y_pexpr, s->var_values, &s->prng);
 912     s->var_values[VAR_X] =
 913         av_expr_eval(s->x_pexpr, s->var_values, &s->prng);
 914
 915     s->draw = av_expr_eval(s->d_pexpr, s->var_values, &s->prng);
 916
 917     normalize_double(&s->x, s->var_values[VAR_X]);
 918     normalize_double(&s->y, s->var_values[VAR_Y]);
 919
 920     if (s->fix_bounds) {
 921         if (s->x < 0) s->x = 0;
 922         if (s->y < 0) s->y = 0;
 923         if ((unsigned)s->x + (unsigned)s->w > inlink->w)
 924             s->x = inlink->w - s->w;
 925         if ((unsigned)s->y + (unsigned)s->h > inlink->h)
 926             s->y = inlink->h - s->h;
 927     }
 928
 929     s->x &= ~((1 << s->hsub) - 1);
 930     s->y &= ~((1 << s->vsub) - 1);
 931
 932     av_dlog(ctx, "n:%d t:%f x:%d y:%d x+w:%d y+h:%d\n",
 933             (int)s->var_values[VAR_N], s->var_values[VAR_T],
 934             s->x, s->y, s->x+s->w, s->y+s->h);
 935
 936     if (s->draw)
 937         draw_text(inlink->dst, frame, frame->width, frame->height);
 938
 939     s->var_values[VAR_N] += 1.0;
 940
 941     return ff_filter_frame(inlink->dst->outputs[0], frame);
 942 }
 943
 944 static const AVFilterPad avfilter_vf_drawtext_inputs[] = {
 945     {
 946         .name             = "default",
 947         .type             = AVMEDIA_TYPE_VIDEO,
 948         .get_video_buffer = ff_null_get_video_buffer,
 949         .filter_frame     = filter_frame,
 950         .config_props     = config_input,
 951         .needs_writable   = 1,
 952     },
 953     { NULL }
 954 };
 955
 956 static const AVFilterPad avfilter_vf_drawtext_outputs[] = {
 957     {
 958         .name = "default",
 959         .type = AVMEDIA_TYPE_VIDEO,
 960     },
 961     { NULL }
 962 };
 963
 964 AVFilter ff_vf_drawtext = {
 965     .name          = "drawtext",
 966     .description   = NULL_IF_CONFIG_SMALL("Draw text on top of video frames using libfreetype library."),
 967     .priv_size     = sizeof(DrawTextContext),
 968     .priv_class    = &drawtext_class,
 969     .init          = init,
 970     .uninit        = uninit,
 971     .query_formats = query_formats,
 972
 973     .inputs    = avfilter_vf_drawtext_inputs,
 974     .outputs   = avfilter_vf_drawtext_outputs,
 975 };