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>
6 * This file is part of FFmpeg.
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.
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.
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
25 * drawtext filter, based on the original vhook/drawtext.c
26 * filter by Gustavo Sverzut Barbieri
33 #include "libavutil/avstring.h"
34 #include "libavutil/colorspace.h"
35 #include "libavutil/file.h"
36 #include "libavutil/eval.h"
37 #include "libavutil/opt.h"
38 #include "libavutil/random_seed.h"
39 #include "libavutil/parseutils.h"
40 #include "libavutil/pixdesc.h"
41 #include "libavutil/timecode.h"
42 #include "libavutil/tree.h"
43 #include "libavutil/lfg.h"
45 #include "drawutils.h"
50 #include <freetype/config/ftheader.h>
51 #include FT_FREETYPE_H
54 static const char * const var_names[] = {
55 "main_w", "w", "W", ///< width of the input video
56 "main_h", "h", "H", ///< height of the input video
57 "tw", "text_w", ///< width of the rendered text
58 "th", "text_h", ///< height of the rendered text
59 "max_glyph_w", ///< max glyph width
60 "max_glyph_h", ///< max glyph height
61 "max_glyph_a", "ascent", ///< max glyph ascent
62 "max_glyph_d", "descent", ///< min glyph descent
63 "line_h", "lh", ///< line height, same as max_glyph_h
70 "n", ///< number of frame
71 "t", ///< timestamp expressed in seconds
75 static const char *fun2_names[] = {
79 static double drand(void *opaque, double min, double max)
81 return min + (max-min) / UINT_MAX * av_lfg_get(opaque);
84 typedef double (*eval_func2)(void *, double a, double b);
86 static const eval_func2 fun2[] = {
92 VAR_MAIN_W, VAR_w, VAR_W,
93 VAR_MAIN_H, VAR_h, VAR_H,
98 VAR_MAX_GLYPH_A, VAR_ASCENT,
99 VAR_MAX_GLYPH_D, VAR_DESCENT,
113 const AVClass *class;
114 int reinit; ///< tells if the filter is being reinited
115 uint8_t *fontfile; ///< font to be used
116 uint8_t *text; ///< text to be drawn
117 uint8_t *expanded_text; ///< used to contain the strftime()-expanded text
118 size_t expanded_text_size; ///< size in bytes of the expanded_text buffer
119 int ft_load_flags; ///< flags used for loading fonts, see FT_LOAD_*
120 FT_Vector *positions; ///< positions for each element in the text
121 size_t nb_positions; ///< number of elements of positions array
122 char *textfile; ///< file with text to be drawn
123 int x; ///< x position to start drawing text
124 int y; ///< y position to start drawing text
125 int max_glyph_w; ///< max glyph width
126 int max_glyph_h; ///< max glyph heigth
127 int shadowx, shadowy;
128 unsigned int fontsize; ///< font size to use
129 char *fontcolor_string; ///< font color as string
130 char *boxcolor_string; ///< box color as string
131 char *shadowcolor_string; ///< shadow color as string
132 uint8_t fontcolor[4]; ///< foreground color
133 uint8_t boxcolor[4]; ///< background color
134 uint8_t shadowcolor[4]; ///< shadow color
135 uint8_t fontcolor_rgba[4]; ///< foreground color in RGBA
136 uint8_t boxcolor_rgba[4]; ///< background color in RGBA
137 uint8_t shadowcolor_rgba[4]; ///< shadow color in RGBA
139 short int draw_box; ///< draw box around text - true or false
140 int use_kerning; ///< font kerning is used - true/false
141 int tabsize; ///< tab size
142 int fix_bounds; ///< do we let it go out of frame bounds - t/f
144 FT_Library library; ///< freetype font library handle
145 FT_Face face; ///< freetype font face handle
146 struct AVTreeNode *glyphs; ///< rendered glyphs, stored using the UTF-32 char code
147 int hsub, vsub; ///< chroma subsampling values
149 int pixel_step[4]; ///< distance in bytes between the component of each pixel
150 uint8_t rgba_map[4]; ///< map RGBA offsets to the positions in the packed RGBA format
151 uint8_t *box_line[4]; ///< line used for filling the box background
152 char *x_expr; ///< expression for x position
153 char *y_expr; ///< expression for y position
154 AVExpr *x_pexpr, *y_pexpr; ///< parsed expressions for x and y
155 int64_t basetime; ///< base pts time in the real world for display
156 double var_values[VAR_VARS_NB];
159 int draw; ///< set to zero to prevent drawing
160 AVLFG prng; ///< random
161 char *tc_opt_string; ///< specified timecode option string
162 AVRational tc_rate; ///< frame rate for timecode
163 AVTimecode tc; ///< timecode context
167 #define OFFSET(x) offsetof(DrawTextContext, x)
169 static const AVOption drawtext_options[]= {
170 {"fontfile", "set font file", OFFSET(fontfile), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX },
171 {"text", "set text", OFFSET(text), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX },
172 {"textfile", "set text file", OFFSET(textfile), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX },
173 {"fontcolor", "set foreground color", OFFSET(fontcolor_string), AV_OPT_TYPE_STRING, {.str="black"}, CHAR_MIN, CHAR_MAX },
174 {"boxcolor", "set box color", OFFSET(boxcolor_string), AV_OPT_TYPE_STRING, {.str="white"}, CHAR_MIN, CHAR_MAX },
175 {"shadowcolor", "set shadow color", OFFSET(shadowcolor_string), AV_OPT_TYPE_STRING, {.str="black"}, CHAR_MIN, CHAR_MAX },
176 {"box", "set box", OFFSET(draw_box), AV_OPT_TYPE_INT, {.dbl=0}, 0, 1 },
177 {"fontsize", "set font size", OFFSET(fontsize), AV_OPT_TYPE_INT, {.dbl=16}, 1, INT_MAX },
178 {"x", "set x expression", OFFSET(x_expr), AV_OPT_TYPE_STRING, {.str="0"}, CHAR_MIN, CHAR_MAX },
179 {"y", "set y expression", OFFSET(y_expr), AV_OPT_TYPE_STRING, {.str="0"}, CHAR_MIN, CHAR_MAX },
180 {"shadowx", "set x", OFFSET(shadowx), AV_OPT_TYPE_INT, {.dbl=0}, INT_MIN, INT_MAX },
181 {"shadowy", "set y", OFFSET(shadowy), AV_OPT_TYPE_INT, {.dbl=0}, INT_MIN, INT_MAX },
182 {"tabsize", "set tab size", OFFSET(tabsize), AV_OPT_TYPE_INT, {.dbl=4}, 0, INT_MAX },
183 {"basetime", "set base time", OFFSET(basetime), AV_OPT_TYPE_INT64, {.dbl=AV_NOPTS_VALUE}, INT64_MIN, INT64_MAX },
184 {"draw", "if false do not draw", OFFSET(d_expr), AV_OPT_TYPE_STRING, {.str="1"}, CHAR_MIN, CHAR_MAX },
185 {"timecode", "set initial timecode", OFFSET(tc_opt_string), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX },
186 {"r", "set rate (timecode only)", OFFSET(tc_rate), AV_OPT_TYPE_RATIONAL, {.dbl=0}, 0, INT_MAX },
187 {"rate", "set rate (timecode only)", OFFSET(tc_rate), AV_OPT_TYPE_RATIONAL, {.dbl=0}, 0, INT_MAX },
188 {"fix_bounds", "if true, check and fix text coords to avoid clipping",
189 OFFSET(fix_bounds), AV_OPT_TYPE_INT, {.dbl=1}, 0, 1 },
191 /* FT_LOAD_* flags */
192 {"ft_load_flags", "set font loading flags for libfreetype", OFFSET(ft_load_flags), AV_OPT_TYPE_FLAGS, {.dbl=FT_LOAD_DEFAULT|FT_LOAD_RENDER}, 0, INT_MAX, 0, "ft_load_flags" },
193 {"default", "set default", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_DEFAULT}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
194 {"no_scale", "set no_scale", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_NO_SCALE}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
195 {"no_hinting", "set no_hinting", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_NO_HINTING}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
196 {"render", "set render", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_RENDER}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
197 {"no_bitmap", "set no_bitmap", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_NO_BITMAP}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
198 {"vertical_layout", "set vertical_layout", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_VERTICAL_LAYOUT}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
199 {"force_autohint", "set force_autohint", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_FORCE_AUTOHINT}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
200 {"crop_bitmap", "set crop_bitmap", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_CROP_BITMAP}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
201 {"pedantic", "set pedantic", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_PEDANTIC}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
202 {"ignore_global_advance_width", "set ignore_global_advance_width", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
203 {"no_recurse", "set no_recurse", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_NO_RECURSE}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
204 {"ignore_transform", "set ignore_transform", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_IGNORE_TRANSFORM}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
205 {"monochrome", "set monochrome", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_MONOCHROME}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
206 {"linear_design", "set linear_design", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_LINEAR_DESIGN}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
207 {"no_autohint", "set no_autohint", 0, AV_OPT_TYPE_CONST, {.dbl=FT_LOAD_NO_AUTOHINT}, INT_MIN, INT_MAX, 0, "ft_load_flags" },
211 static const char *drawtext_get_name(void *ctx)
216 static const AVClass drawtext_class = {
222 #undef __FTERRORS_H__
223 #define FT_ERROR_START_LIST {
224 #define FT_ERRORDEF(e, v, s) { (e), (s) },
225 #define FT_ERROR_END_LIST { 0, NULL } };
231 } static ft_errors[] =
234 #define FT_ERRMSG(e) ft_errors[e].err_msg
239 FT_Bitmap bitmap; ///< array holding bitmaps of font
246 static int glyph_cmp(void *key, const void *b)
248 const Glyph *a = key, *bb = b;
249 int64_t diff = (int64_t)a->code - (int64_t)bb->code;
250 return diff > 0 ? 1 : diff < 0 ? -1 : 0;
254 * Load glyphs corresponding to the UTF-32 codepoint code.
256 static int load_glyph(AVFilterContext *ctx, Glyph **glyph_ptr, uint32_t code)
258 DrawTextContext *dtext = ctx->priv;
260 struct AVTreeNode *node = NULL;
263 /* load glyph into dtext->face->glyph */
264 if (FT_Load_Char(dtext->face, code, dtext->ft_load_flags))
265 return AVERROR(EINVAL);
268 if (!(glyph = av_mallocz(sizeof(*glyph))) ||
269 !(glyph->glyph = av_mallocz(sizeof(*glyph->glyph)))) {
270 ret = AVERROR(ENOMEM);
275 if (FT_Get_Glyph(dtext->face->glyph, glyph->glyph)) {
276 ret = AVERROR(EINVAL);
280 glyph->bitmap = dtext->face->glyph->bitmap;
281 glyph->bitmap_left = dtext->face->glyph->bitmap_left;
282 glyph->bitmap_top = dtext->face->glyph->bitmap_top;
283 glyph->advance = dtext->face->glyph->advance.x >> 6;
285 /* measure text height to calculate text_height (or the maximum text height) */
286 FT_Glyph_Get_CBox(*glyph->glyph, ft_glyph_bbox_pixels, &glyph->bbox);
288 /* cache the newly created glyph */
289 if (!(node = av_mallocz(av_tree_node_size))) {
290 ret = AVERROR(ENOMEM);
293 av_tree_insert(&dtext->glyphs, glyph, glyph_cmp, &node);
301 av_freep(&glyph->glyph);
307 static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)
310 DrawTextContext *dtext = ctx->priv;
313 dtext->class = &drawtext_class;
314 av_opt_set_defaults(dtext);
316 if ((err = (av_set_options_string(dtext, args, "=", ":"))) < 0) {
317 av_log(ctx, AV_LOG_ERROR, "Error parsing options string: '%s'\n", args);
321 if (!dtext->fontfile) {
322 av_log(ctx, AV_LOG_ERROR, "No font filename provided\n");
323 return AVERROR(EINVAL);
326 if (dtext->textfile) {
331 av_log(ctx, AV_LOG_ERROR,
332 "Both text and text file provided. Please provide only one\n");
333 return AVERROR(EINVAL);
335 if ((err = av_file_map(dtext->textfile, &textbuf, &textbuf_size, 0, ctx)) < 0) {
336 av_log(ctx, AV_LOG_ERROR,
337 "The text file '%s' could not be read or is empty\n",
342 if (!(dtext->text = av_malloc(textbuf_size+1)))
343 return AVERROR(ENOMEM);
344 memcpy(dtext->text, textbuf, textbuf_size);
345 dtext->text[textbuf_size] = 0;
346 av_file_unmap(textbuf, textbuf_size);
349 if (dtext->tc_opt_string) {
350 int ret = av_timecode_init_from_string(&dtext->tc, dtext->tc_rate,
351 dtext->tc_opt_string, ctx);
355 dtext->text = av_strdup("");
359 av_log(ctx, AV_LOG_ERROR,
360 "Either text, a valid file or a timecode must be provided\n");
361 return AVERROR(EINVAL);
364 if ((err = av_parse_color(dtext->fontcolor_rgba, dtext->fontcolor_string, -1, ctx))) {
365 av_log(ctx, AV_LOG_ERROR,
366 "Invalid font color '%s'\n", dtext->fontcolor_string);
370 if ((err = av_parse_color(dtext->boxcolor_rgba, dtext->boxcolor_string, -1, ctx))) {
371 av_log(ctx, AV_LOG_ERROR,
372 "Invalid box color '%s'\n", dtext->boxcolor_string);
376 if ((err = av_parse_color(dtext->shadowcolor_rgba, dtext->shadowcolor_string, -1, ctx))) {
377 av_log(ctx, AV_LOG_ERROR,
378 "Invalid shadow color '%s'\n", dtext->shadowcolor_string);
382 if ((err = FT_Init_FreeType(&(dtext->library)))) {
383 av_log(ctx, AV_LOG_ERROR,
384 "Could not load FreeType: %s\n", FT_ERRMSG(err));
385 return AVERROR(EINVAL);
388 /* load the face, and set up the encoding, which is by default UTF-8 */
389 if ((err = FT_New_Face(dtext->library, dtext->fontfile, 0, &dtext->face))) {
390 av_log(ctx, AV_LOG_ERROR, "Could not load fontface from file '%s': %s\n",
391 dtext->fontfile, FT_ERRMSG(err));
392 return AVERROR(EINVAL);
394 if ((err = FT_Set_Pixel_Sizes(dtext->face, 0, dtext->fontsize))) {
395 av_log(ctx, AV_LOG_ERROR, "Could not set font size to %d pixels: %s\n",
396 dtext->fontsize, FT_ERRMSG(err));
397 return AVERROR(EINVAL);
400 dtext->use_kerning = FT_HAS_KERNING(dtext->face);
402 /* load the fallback glyph with code 0 */
403 load_glyph(ctx, NULL, 0);
405 /* set the tabsize in pixels */
406 if ((err = load_glyph(ctx, &glyph, ' ')) < 0) {
407 av_log(ctx, AV_LOG_ERROR, "Could not set tabsize.\n");
410 dtext->tabsize *= glyph->advance;
415 static int query_formats(AVFilterContext *ctx)
417 static const enum PixelFormat pix_fmts[] = {
418 PIX_FMT_ARGB, PIX_FMT_RGBA,
419 PIX_FMT_ABGR, PIX_FMT_BGRA,
420 PIX_FMT_RGB24, PIX_FMT_BGR24,
421 PIX_FMT_YUV420P, PIX_FMT_YUV444P,
422 PIX_FMT_YUV422P, PIX_FMT_YUV411P,
423 PIX_FMT_YUV410P, PIX_FMT_YUV440P,
427 avfilter_set_common_pixel_formats(ctx, avfilter_make_format_list(pix_fmts));
431 static int glyph_enu_free(void *opaque, void *elem)
437 static av_cold void uninit(AVFilterContext *ctx)
439 DrawTextContext *dtext = ctx->priv;
442 av_expr_free(dtext->x_pexpr); dtext->x_pexpr = NULL;
443 av_expr_free(dtext->y_pexpr); dtext->y_pexpr = NULL;
445 av_freep(&dtext->boxcolor_string);
446 av_freep(&dtext->expanded_text);
447 av_freep(&dtext->fontcolor_string);
448 av_freep(&dtext->fontfile);
449 av_freep(&dtext->shadowcolor_string);
450 av_freep(&dtext->text);
451 av_freep(&dtext->x_expr);
452 av_freep(&dtext->y_expr);
454 av_freep(&dtext->positions);
455 dtext->nb_positions = 0;
457 av_tree_enumerate(dtext->glyphs, NULL, NULL, glyph_enu_free);
458 av_tree_destroy(dtext->glyphs);
459 dtext->glyphs = NULL;
461 FT_Done_Face(dtext->face);
462 FT_Done_FreeType(dtext->library);
464 for (i = 0; i < 4; i++) {
465 av_freep(&dtext->box_line[i]);
466 dtext->pixel_step[i] = 0;
470 static inline int is_newline(uint32_t c)
472 return c == '\n' || c == '\r' || c == '\f' || c == '\v';
475 static int config_input(AVFilterLink *inlink)
477 AVFilterContext *ctx = inlink->dst;
478 DrawTextContext *dtext = ctx->priv;
479 const AVPixFmtDescriptor *pix_desc = &av_pix_fmt_descriptors[inlink->format];
482 dtext->hsub = pix_desc->log2_chroma_w;
483 dtext->vsub = pix_desc->log2_chroma_h;
486 ff_fill_line_with_color(dtext->box_line, dtext->pixel_step,
487 inlink->w, dtext->boxcolor,
488 inlink->format, dtext->boxcolor_rgba,
489 &dtext->is_packed_rgb, dtext->rgba_map)) < 0)
492 if (!dtext->is_packed_rgb) {
493 uint8_t *rgba = dtext->fontcolor_rgba;
494 dtext->fontcolor[0] = RGB_TO_Y_CCIR(rgba[0], rgba[1], rgba[2]);
495 dtext->fontcolor[1] = RGB_TO_U_CCIR(rgba[0], rgba[1], rgba[2], 0);
496 dtext->fontcolor[2] = RGB_TO_V_CCIR(rgba[0], rgba[1], rgba[2], 0);
497 dtext->fontcolor[3] = rgba[3];
498 rgba = dtext->shadowcolor_rgba;
499 dtext->shadowcolor[0] = RGB_TO_Y_CCIR(rgba[0], rgba[1], rgba[2]);
500 dtext->shadowcolor[1] = RGB_TO_U_CCIR(rgba[0], rgba[1], rgba[2], 0);
501 dtext->shadowcolor[2] = RGB_TO_V_CCIR(rgba[0], rgba[1], rgba[2], 0);
502 dtext->shadowcolor[3] = rgba[3];
505 dtext->var_values[VAR_w] = dtext->var_values[VAR_W] = dtext->var_values[VAR_MAIN_W] = inlink->w;
506 dtext->var_values[VAR_h] = dtext->var_values[VAR_H] = dtext->var_values[VAR_MAIN_H] = inlink->h;
507 dtext->var_values[VAR_SAR] = inlink->sample_aspect_ratio.num ? av_q2d(inlink->sample_aspect_ratio) : 1;
508 dtext->var_values[VAR_DAR] = (double)inlink->w / inlink->h * dtext->var_values[VAR_SAR];
509 dtext->var_values[VAR_HSUB] = 1<<pix_desc->log2_chroma_w;
510 dtext->var_values[VAR_VSUB] = 1<<pix_desc->log2_chroma_h;
511 dtext->var_values[VAR_X] = NAN;
512 dtext->var_values[VAR_Y] = NAN;
514 dtext->var_values[VAR_N] = 0;
515 dtext->var_values[VAR_T] = NAN;
517 av_lfg_init(&dtext->prng, av_get_random_seed());
519 if ((ret = av_expr_parse(&dtext->x_pexpr, dtext->x_expr, var_names,
520 NULL, NULL, fun2_names, fun2, 0, ctx)) < 0 ||
521 (ret = av_expr_parse(&dtext->y_pexpr, dtext->y_expr, var_names,
522 NULL, NULL, fun2_names, fun2, 0, ctx)) < 0 ||
523 (ret = av_expr_parse(&dtext->d_pexpr, dtext->d_expr, var_names,
524 NULL, NULL, fun2_names, fun2, 0, ctx)) < 0)
526 return AVERROR(EINVAL);
531 static int command(AVFilterContext *ctx, const char *cmd, const char *arg, char *res, int res_len, int flags)
533 DrawTextContext *dtext = ctx->priv;
535 if (!strcmp(cmd, "reinit")) {
539 if ((ret = init(ctx, arg, NULL)) < 0)
541 return config_input(ctx->inputs[0]);
544 return AVERROR(ENOSYS);
547 #define GET_BITMAP_VAL(r, c) \
548 bitmap->pixel_mode == FT_PIXEL_MODE_MONO ? \
549 (bitmap->buffer[(r) * bitmap->pitch + ((c)>>3)] & (0x80 >> ((c)&7))) * 255 : \
550 bitmap->buffer[(r) * bitmap->pitch + (c)]
552 #define SET_PIXEL_YUV(picref, yuva_color, val, x, y, hsub, vsub) { \
553 luma_pos = ((x) ) + ((y) ) * picref->linesize[0]; \
554 alpha = yuva_color[3] * (val) * 129; \
555 picref->data[0][luma_pos] = (alpha * yuva_color[0] + (255*255*129 - alpha) * picref->data[0][luma_pos] ) >> 23; \
556 if (((x) & ((1<<(hsub)) - 1)) == 0 && ((y) & ((1<<(vsub)) - 1)) == 0) {\
557 chroma_pos1 = ((x) >> (hsub)) + ((y) >> (vsub)) * picref->linesize[1]; \
558 chroma_pos2 = ((x) >> (hsub)) + ((y) >> (vsub)) * picref->linesize[2]; \
559 picref->data[1][chroma_pos1] = (alpha * yuva_color[1] + (255*255*129 - alpha) * picref->data[1][chroma_pos1]) >> 23; \
560 picref->data[2][chroma_pos2] = (alpha * yuva_color[2] + (255*255*129 - alpha) * picref->data[2][chroma_pos2]) >> 23; \
564 static inline int draw_glyph_yuv(AVFilterBufferRef *picref, FT_Bitmap *bitmap,
565 int x, int y, int width, int height,
566 const uint8_t yuva_color[4], int hsub, int vsub)
569 unsigned int luma_pos, chroma_pos1, chroma_pos2;
572 for (r = 0; r < bitmap->rows && r+y < height; r++) {
573 for (c = 0; c < bitmap->width && c+x < width; c++) {
574 if (c+x < 0 || r+y < 0)
577 /* get intensity value in the glyph bitmap (source) */
578 src_val = GET_BITMAP_VAL(r, c);
582 SET_PIXEL_YUV(picref, yuva_color, src_val, c+x, y+r, hsub, vsub);
589 #define SET_PIXEL_RGB(picref, rgba_color, val, x, y, pixel_step, r_off, g_off, b_off, a_off) { \
590 p = picref->data[0] + (x) * pixel_step + ((y) * picref->linesize[0]); \
591 alpha = rgba_color[3] * (val) * 129; \
592 *(p+r_off) = (alpha * rgba_color[0] + (255*255*129 - alpha) * *(p+r_off)) >> 23; \
593 *(p+g_off) = (alpha * rgba_color[1] + (255*255*129 - alpha) * *(p+g_off)) >> 23; \
594 *(p+b_off) = (alpha * rgba_color[2] + (255*255*129 - alpha) * *(p+b_off)) >> 23; \
597 static inline int draw_glyph_rgb(AVFilterBufferRef *picref, FT_Bitmap *bitmap,
598 int x, int y, int width, int height, int pixel_step,
599 const uint8_t rgba_color[4], const uint8_t rgba_map[4])
605 for (r = 0; r < bitmap->rows && r+y < height; r++) {
606 for (c = 0; c < bitmap->width && c+x < width; c++) {
607 if (c+x < 0 || r+y < 0)
609 /* get intensity value in the glyph bitmap (source) */
610 src_val = GET_BITMAP_VAL(r, c);
614 SET_PIXEL_RGB(picref, rgba_color, src_val, c+x, y+r, pixel_step,
615 rgba_map[0], rgba_map[1], rgba_map[2], rgba_map[3]);
622 static inline void drawbox(AVFilterBufferRef *picref, int x, int y,
623 int width, int height,
624 uint8_t *line[4], int pixel_step[4], uint8_t color[4],
625 int hsub, int vsub, int is_rgba_packed, uint8_t rgba_map[4])
629 if (color[3] != 0xFF) {
630 if (is_rgba_packed) {
632 for (j = 0; j < height; j++)
633 for (i = 0; i < width; i++)
634 SET_PIXEL_RGB(picref, color, 255, i+x, y+j, pixel_step[0],
635 rgba_map[0], rgba_map[1], rgba_map[2], rgba_map[3]);
637 unsigned int luma_pos, chroma_pos1, chroma_pos2;
638 for (j = 0; j < height; j++)
639 for (i = 0; i < width; i++)
640 SET_PIXEL_YUV(picref, color, 255, i+x, y+j, hsub, vsub);
643 ff_draw_rectangle(picref->data, picref->linesize,
644 line, pixel_step, hsub, vsub,
645 x, y, width, height);
649 static int draw_glyphs(DrawTextContext *dtext, AVFilterBufferRef *picref,
650 int width, int height, const uint8_t rgbcolor[4], const uint8_t yuvcolor[4], int x, int y)
652 char *text = dtext->expanded_text;
658 for (i = 0, p = text; *p; i++) {
660 GET_UTF8(code, *p++, continue;);
662 /* skip new line chars, just go to new line */
663 if (code == '\n' || code == '\r' || code == '\t')
667 glyph = av_tree_find(dtext->glyphs, &dummy, (void *)glyph_cmp, NULL);
669 if (glyph->bitmap.pixel_mode != FT_PIXEL_MODE_MONO &&
670 glyph->bitmap.pixel_mode != FT_PIXEL_MODE_GRAY)
671 return AVERROR(EINVAL);
673 x1 = dtext->positions[i].x+dtext->x+x;
674 y1 = dtext->positions[i].y+dtext->y+y;
676 if (dtext->is_packed_rgb) {
677 draw_glyph_rgb(picref, &glyph->bitmap,
678 x1, y1, width, height,
679 dtext->pixel_step[0], rgbcolor, dtext->rgba_map);
681 draw_glyph_yuv(picref, &glyph->bitmap,
682 x1, y1, width, height,
683 yuvcolor, dtext->hsub, dtext->vsub);
690 static int draw_text(AVFilterContext *ctx, AVFilterBufferRef *picref,
691 int width, int height)
693 DrawTextContext *dtext = ctx->priv;
694 uint32_t code = 0, prev_code = 0;
695 int x = 0, y = 0, i = 0, ret;
696 int max_text_line_w = 0, len;
698 char *text = dtext->text;
700 int y_min = 32000, y_max = -32000;
701 int x_min = 32000, x_max = -32000;
703 Glyph *glyph = NULL, *prev_glyph = NULL;
706 time_t now = time(0);
708 uint8_t *buf = dtext->expanded_text;
709 int buf_size = dtext->expanded_text_size;
711 if(dtext->basetime != AV_NOPTS_VALUE)
712 now= picref->pts*av_q2d(ctx->inputs[0]->time_base) + dtext->basetime/1000000;
715 buf_size = 2*strlen(dtext->text)+1;
716 buf = av_malloc(buf_size);
720 localtime_r(&now, <ime);
722 if(strchr(dtext->text, '%'))
723 ltime= *localtime(&now);
728 if (strftime(buf, buf_size, dtext->text, <ime) != 0 || *buf == 0)
731 } while ((buf = av_realloc(buf, buf_size)));
733 if (dtext->tc_opt_string) {
734 char tcbuf[AV_TIMECODE_STR_SIZE];
735 av_timecode_make_string(&dtext->tc, tcbuf, dtext->frame_id++);
736 buf = av_asprintf("%s%s", dtext->text, tcbuf);
740 return AVERROR(ENOMEM);
741 text = dtext->expanded_text = buf;
742 dtext->expanded_text_size = buf_size;
743 if ((len = strlen(text)) > dtext->nb_positions) {
744 if (!(dtext->positions =
745 av_realloc(dtext->positions, len*sizeof(*dtext->positions))))
746 return AVERROR(ENOMEM);
747 dtext->nb_positions = len;
753 /* load and cache glyphs */
754 for (i = 0, p = text; *p; i++) {
755 GET_UTF8(code, *p++, continue;);
759 glyph = av_tree_find(dtext->glyphs, &dummy, glyph_cmp, NULL);
761 load_glyph(ctx, &glyph, code);
764 y_min = FFMIN(glyph->bbox.yMin, y_min);
765 y_max = FFMAX(glyph->bbox.yMax, y_max);
766 x_min = FFMIN(glyph->bbox.xMin, x_min);
767 x_max = FFMAX(glyph->bbox.xMax, x_max);
769 dtext->max_glyph_h = y_max - y_min;
770 dtext->max_glyph_w = x_max - x_min;
772 /* compute and save position for each glyph */
774 for (i = 0, p = text; *p; i++) {
775 GET_UTF8(code, *p++, continue;);
777 /* skip the \n in the sequence \r\n */
778 if (prev_code == '\r' && code == '\n')
782 if (is_newline(code)) {
783 max_text_line_w = FFMAX(max_text_line_w, x);
784 y += dtext->max_glyph_h;
792 glyph = av_tree_find(dtext->glyphs, &dummy, glyph_cmp, NULL);
795 if (dtext->use_kerning && prev_glyph && glyph->code) {
796 FT_Get_Kerning(dtext->face, prev_glyph->code, glyph->code,
797 ft_kerning_default, &delta);
802 dtext->positions[i].x = x + glyph->bitmap_left;
803 dtext->positions[i].y = y - glyph->bitmap_top + y_max;
804 if (code == '\t') x = (x / dtext->tabsize + 1)*dtext->tabsize;
805 else x += glyph->advance;
808 max_text_line_w = FFMAX(x, max_text_line_w);
810 dtext->var_values[VAR_TW] = dtext->var_values[VAR_TEXT_W] = max_text_line_w;
811 dtext->var_values[VAR_TH] = dtext->var_values[VAR_TEXT_H] = y + dtext->max_glyph_h;
813 dtext->var_values[VAR_MAX_GLYPH_W] = dtext->max_glyph_w;
814 dtext->var_values[VAR_MAX_GLYPH_H] = dtext->max_glyph_h;
815 dtext->var_values[VAR_MAX_GLYPH_A] = dtext->var_values[VAR_ASCENT ] = y_max;
816 dtext->var_values[VAR_MAX_GLYPH_D] = dtext->var_values[VAR_DESCENT] = y_min;
818 dtext->var_values[VAR_LINE_H] = dtext->var_values[VAR_LH] = dtext->max_glyph_h;
820 dtext->x = dtext->var_values[VAR_X] = av_expr_eval(dtext->x_pexpr, dtext->var_values, &dtext->prng);
821 dtext->y = dtext->var_values[VAR_Y] = av_expr_eval(dtext->y_pexpr, dtext->var_values, &dtext->prng);
822 dtext->x = dtext->var_values[VAR_X] = av_expr_eval(dtext->x_pexpr, dtext->var_values, &dtext->prng);
823 dtext->draw = av_expr_eval(dtext->d_pexpr, dtext->var_values, &dtext->prng);
828 dtext->x &= ~((1 << dtext->hsub) - 1);
829 dtext->y &= ~((1 << dtext->vsub) - 1);
831 box_w = FFMIN(width - 1 , max_text_line_w);
832 box_h = FFMIN(height - 1, y + dtext->max_glyph_h);
836 drawbox(picref, dtext->x, dtext->y, box_w, box_h,
837 dtext->box_line, dtext->pixel_step, dtext->is_packed_rgb ? dtext->boxcolor_rgba : dtext->boxcolor,
838 dtext->hsub, dtext->vsub, dtext->is_packed_rgb, dtext->rgba_map);
840 if (dtext->shadowx || dtext->shadowy) {
841 if ((ret = draw_glyphs(dtext, picref, width, height, dtext->shadowcolor_rgba,
842 dtext->shadowcolor, dtext->shadowx, dtext->shadowy)) < 0)
846 if ((ret = draw_glyphs(dtext, picref, width, height, dtext->fontcolor_rgba,
847 dtext->fontcolor, 0, 0)) < 0)
853 static void null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir) { }
855 static void end_frame(AVFilterLink *inlink)
857 AVFilterContext *ctx = inlink->dst;
858 AVFilterLink *outlink = ctx->outputs[0];
859 DrawTextContext *dtext = ctx->priv;
860 AVFilterBufferRef *picref = inlink->cur_buf;
862 dtext->var_values[VAR_T] = picref->pts == AV_NOPTS_VALUE ?
863 NAN : picref->pts * av_q2d(inlink->time_base);
865 draw_text(ctx, picref, picref->video->w, picref->video->h);
867 av_log(ctx, AV_LOG_DEBUG, "n:%d t:%f text_w:%d text_h:%d x:%d y:%d\n",
868 (int)dtext->var_values[VAR_N], dtext->var_values[VAR_T],
869 (int)dtext->var_values[VAR_TEXT_W], (int)dtext->var_values[VAR_TEXT_H],
872 dtext->var_values[VAR_N] += 1.0;
874 avfilter_draw_slice(outlink, 0, picref->video->h, 1);
875 avfilter_end_frame(outlink);
878 AVFilter avfilter_vf_drawtext = {
880 .description = NULL_IF_CONFIG_SMALL("Draw text on top of video frames using libfreetype library."),
881 .priv_size = sizeof(DrawTextContext),
884 .query_formats = query_formats,
886 .inputs = (const AVFilterPad[]) {{ .name = "default",
887 .type = AVMEDIA_TYPE_VIDEO,
888 .get_video_buffer = avfilter_null_get_video_buffer,
889 .start_frame = avfilter_null_start_frame,
890 .draw_slice = null_draw_slice,
891 .end_frame = end_frame,
892 .config_props = config_input,
893 .min_perms = AV_PERM_WRITE |
895 .rej_perms = AV_PERM_PRESERVE },
897 .outputs = (const AVFilterPad[]) {{ .name = "default",
898 .type = AVMEDIA_TYPE_VIDEO, },
900 .process_command = command,