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