Change license headers to say 'FFmpeg' instead of 'this program/this library'
[ffmpeg.git] / vhook / drawtext.c
1 /*
2  * drawtext.c: print text over the screen
3  ******************************************************************************
4  * Options:
5  * -f <filename>    font filename (MANDATORY!!!)
6  * -s <pixel_size>  font size in pixels [default 16]
7  * -b               print background
8  * -o               outline glyphs (use the bg color)
9  * -x <pos>         x position ( >= 0) [default 0]
10  * -y <pos>         y position ( >= 0) [default 0]
11  * -t <text>        text to print (will be passed to strftime())
12  *                  MANDATORY: will be used even when -T is used.
13  *                  in this case, -t will be used if some error
14  *                  occurs
15  * -T <filename>    file with the text (re-read every frame)
16  * -c <#RRGGBB>     foreground color ('internet' way) [default #ffffff]
17  * -C <#RRGGBB>     background color ('internet' way) [default #000000]
18  *
19  ******************************************************************************
20  * Features:
21  * - True Type, Type1 and others via FreeType2 library
22  * - Font kerning (better output)
23  * - Line Wrap (if the text doesn't fit, the next char go to the next line)
24  * - Background box
25  * - Outline
26  ******************************************************************************
27  * Author: Gustavo Sverzut Barbieri <gsbarbieri@yahoo.com.br>
28  *
29  * This file is part of FFmpeg.
30  *
31  * FFmpeg is free software; you can redistribute it and/or
32  * modify it under the terms of the GNU Lesser General Public
33  * License as published by the Free Software Foundation; either
34  * version 2.1 of the License, or (at your option) any later version.
35  *
36  * FFmpeg is distributed in the hope that it will be useful,
37  * but WITHOUT ANY WARRANTY; without even the implied warranty of
38  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
39  * Lesser General Public License for more details.
40  *
41  * You should have received a copy of the GNU Lesser General Public
42  * License along with FFmpeg; if not, write to the Free Software
43  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
44  */
45
46 #define MAXSIZE_TEXT 1024
47
48 #include "framehook.h"
49
50 #include <stdio.h>
51 #include <stdlib.h>
52 #include <fcntl.h>
53 #include <stdarg.h>
54 #include <string.h>
55 #include <unistd.h>
56 #undef time
57 #include <sys/time.h>
58 #include <time.h>
59
60 #include <ft2build.h>
61 #include FT_FREETYPE_H
62 #include FT_GLYPH_H
63
64 #define RGB_TO_YUV(rgb_color, yuv_color) { \
65     yuv_color[0] = ( 0.257 * rgb_color[0]) + (0.504 * rgb_color[1]) + (0.098 * rgb_color[2]) +  16; \
66     yuv_color[2] = ( 0.439 * rgb_color[0]) - (0.368 * rgb_color[1]) - (0.071 * rgb_color[2]) + 128; \
67     yuv_color[1] = (-0.148 * rgb_color[0]) - (0.291 * rgb_color[1]) + (0.439 * rgb_color[2]) + 128; \
68 }
69
70 #define COPY_3(dst,src) { \
71     dst[0]=src[0]; \
72     dst[1]=src[1]; \
73     dst[2]=src[2]; \
74 }
75
76
77
78 #define SET_PIXEL(picture, yuv_color, x, y) { \
79     picture->data[0][ (x) + (y)*picture->linesize[0] ] = yuv_color[0]; \
80     picture->data[1][ ((x/2) + (y/2)*picture->linesize[1]) ] = yuv_color[1]; \
81     picture->data[2][ ((x/2) + (y/2)*picture->linesize[2]) ] = yuv_color[2]; \
82 }
83
84 #define GET_PIXEL(picture, yuv_color, x, y) { \
85     yuv_color[0] = picture->data[0][ (x) + (y)*picture->linesize[0] ]; \
86     yuv_color[1] = picture->data[1][ (x/2) + (y/2)*picture->linesize[1] ]; \
87     yuv_color[2] = picture->data[2][ (x/2) + (y/2)*picture->linesize[2] ]; \
88 }
89
90
91 typedef struct {
92   unsigned char *text;
93   unsigned char *file;
94   unsigned int x;
95   unsigned int y;
96   int bg;
97   int outline;
98   unsigned char bgcolor[3]; /* YUV */
99   unsigned char fgcolor[3]; /* YUV */
100   FT_Library library;
101   FT_Face    face;
102   FT_Glyph   glyphs[ 255 ];
103   FT_Bitmap  bitmaps[ 255 ];
104   int        advance[ 255 ];
105   int        bitmap_left[ 255 ];
106   int        bitmap_top[ 255 ];
107   unsigned int glyphs_index[ 255 ];
108   int        text_height;
109   int        baseline;
110   int use_kerning;
111 } ContextInfo;
112
113
114 void Release(void *ctx)
115 {
116     if (ctx)
117         av_free(ctx);
118 }
119
120
121 static int ParseColor(char *text, unsigned char yuv_color[3])
122 {
123   char tmp[3];
124   unsigned char rgb_color[3];
125   int i;
126
127   tmp[2] = '\0';
128
129   if ((!text) || (strlen(text) != 7) || (text[0] != '#') )
130     return -1;
131
132   for (i=0; i < 3; i++)
133     {
134       tmp[0] = text[i*2+1];
135       tmp[1] = text[i*2+2];
136
137       rgb_color[i] = strtol(tmp, NULL, 16);
138     }
139
140   RGB_TO_YUV(rgb_color, yuv_color);
141
142   return 0;
143 }
144
145 int Configure(void **ctxp, int argc, char *argv[])
146 {
147     int c;
148     int error;
149     ContextInfo *ci=NULL;
150     char *font=NULL;
151     unsigned int size=16;
152     FT_BBox bbox;
153     int yMax, yMin;
154     *ctxp = av_mallocz(sizeof(ContextInfo));
155     ci = (ContextInfo *) *ctxp;
156
157     /* configure Context Info */
158     ci->text = NULL;
159     ci->file = NULL;
160     ci->x = ci->y = 0;
161     ci->fgcolor[0]=255;
162     ci->fgcolor[1]=128;
163     ci->fgcolor[2]=128;
164     ci->bgcolor[0]=0;
165     ci->fgcolor[1]=128;
166     ci->fgcolor[2]=128;
167     ci->bg = 0;
168     ci->outline = 0;
169     ci->text_height = 0;
170
171     optind = 0;
172     while ((c = getopt(argc, argv, "f:t:T:x:y:s:c:C:bo")) > 0) {
173       switch (c) {
174       case 'f':
175         font = optarg;
176         break;
177       case 't':
178         ci->text = av_strdup(optarg);
179         break;
180       case 'T':
181         ci->file = av_strdup(optarg);
182         break;
183       case 'x':
184         ci->x = (unsigned int) atoi(optarg);
185         break;
186       case 'y':
187         ci->y = (unsigned int) atoi(optarg);
188         break;
189       case 's':
190         size = (unsigned int) atoi(optarg);
191         break;
192       case 'c':
193         if (ParseColor(optarg, ci->fgcolor) == -1)
194           {
195             av_log(NULL, AV_LOG_ERROR, "Invalid foreground color: '%s'. You must specify the color in the internet way(packaged hex): #RRGGBB, ie: -c #ffffff (for white foreground)\n", optarg);
196             return -1;
197           }
198         break;
199       case 'C':
200         if (ParseColor(optarg, ci->bgcolor) == -1)
201           {
202             av_log(NULL, AV_LOG_ERROR, "Invalid foreground color: '%s'. You must specify the color in the internet way(packaged hex): #RRGGBB, ie: -c #ffffff (for white foreground)\n", optarg);
203             return -1;
204           }
205         break;
206       case 'b':
207         ci->bg=1;
208         break;
209       case 'o':
210         ci->outline=1;
211         break;
212       case '?':
213         av_log(NULL, AV_LOG_ERROR, "Unrecognized argument '%s'\n", argv[optind]);
214         return -1;
215       }
216     }
217
218     if (!ci->text)
219       {
220         av_log(NULL, AV_LOG_ERROR, "No text provided (-t text)\n");
221         return -1;
222       }
223
224     if (ci->file)
225       {
226         FILE *fp;
227         if ((fp=fopen(ci->file, "r")) == NULL)
228           {
229             av_log(NULL, AV_LOG_INFO, "WARNING: The file could not be opened. Using text provided with -t switch: %s", strerror(errno));
230           }
231         else
232           {
233             fclose(fp);
234           }
235       }
236
237     if (!font)
238       {
239         av_log(NULL, AV_LOG_ERROR, "No font file provided! (-f filename)\n");
240         return -1;
241       }
242
243     if ((error = FT_Init_FreeType(&(ci->library))) != 0)
244       {
245         av_log(NULL, AV_LOG_ERROR, "Could not load FreeType (error# %d).\n", error);
246         return -1;
247       }
248
249     if ((error = FT_New_Face( ci->library, font, 0, &(ci->face) )) != 0)
250       {
251         av_log(NULL, AV_LOG_ERROR, "Could not load face: %s  (error# %d).\n", font, error);
252         return -1;
253       }
254
255     if ((error = FT_Set_Pixel_Sizes( ci->face, 0, size)) != 0)
256       {
257         av_log(NULL, AV_LOG_ERROR, "Could not set font size to %d pixels (error# %d).\n", size, error);
258         return -1;
259       }
260
261     ci->use_kerning = FT_HAS_KERNING(ci->face);
262
263     /* load and cache glyphs */
264     yMax = -32000;
265     yMin =  32000;
266     for (c=0; c < 256; c++)
267       {
268         /* Load char */
269         error = FT_Load_Char( ci->face, (unsigned char) c, FT_LOAD_RENDER | FT_LOAD_MONOCHROME );
270         if (error) continue;  /* ignore errors */
271
272         /* Save bitmap */
273         ci->bitmaps[c] = ci->face->glyph->bitmap;
274         /* Save bitmap left */
275         ci->bitmap_left[c] = ci->face->glyph->bitmap_left;
276         /* Save bitmap top */
277         ci->bitmap_top[c] = ci->face->glyph->bitmap_top;
278
279         /* Save advance */
280         ci->advance[c] = ci->face->glyph->advance.x >> 6;
281
282         /* Save glyph */
283         error = FT_Get_Glyph( ci->face->glyph, &(ci->glyphs[c]) );
284         /* Save glyph index */
285         ci->glyphs_index[c] = FT_Get_Char_Index( ci->face, (unsigned char) c );
286
287         /* Measure text height to calculate text_height (or the maximum text height) */
288         FT_Glyph_Get_CBox( ci->glyphs[ c ], ft_glyph_bbox_pixels, &bbox );
289         if (bbox.yMax > yMax)
290           yMax = bbox.yMax;
291         if (bbox.yMin < yMin)
292           yMin = bbox.yMin;
293
294       }
295
296     ci->text_height = yMax - yMin;
297     ci->baseline = yMax;
298
299     return 0;
300 }
301
302
303
304
305 static inline void draw_glyph(AVPicture *picture, FT_Bitmap *bitmap, unsigned int x, unsigned int y, unsigned int width, unsigned int height, unsigned char yuv_fgcolor[3], unsigned char yuv_bgcolor[3], int outline)
306 {
307   int r, c;
308   int spixel, dpixel[3], in_glyph=0;
309
310   if (bitmap->pixel_mode == ft_pixel_mode_mono)
311     {
312       in_glyph = 0;
313       for (r=0; (r < bitmap->rows) && (r+y < height); r++)
314         {
315           for (c=0; (c < bitmap->width) && (c+x < width); c++)
316             {
317               /* pixel in the picture (destination) */
318               GET_PIXEL(picture, dpixel, (c+x), (y+r));
319
320               /* pixel in the glyph bitmap (source) */
321               spixel = bitmap->buffer[r*bitmap->pitch +c/8] & (0x80>>(c%8));
322
323               if (spixel)
324                 COPY_3(dpixel, yuv_fgcolor);
325
326               if (outline)
327                 {
328                   /* border detection: */
329                   if ( (!in_glyph) && (spixel) )
330                     /* left border detected */
331                     {
332                       in_glyph = 1;
333                       /* draw left pixel border */
334                       if (c-1 >= 0)
335                         SET_PIXEL(picture, yuv_bgcolor, (c+x-1), (y+r));
336                     }
337                   else if ( (in_glyph) && (!spixel) )
338                     /* right border detected */
339                     {
340                       in_glyph = 0;
341                       /* 'draw' right pixel border */
342                       COPY_3(dpixel, yuv_bgcolor);
343                     }
344
345                   if (in_glyph)
346                     /* see if we have a top/bottom border */
347                     {
348                       /* top */
349                       if ( (r-1 >= 0) && (! bitmap->buffer[(r-1)*bitmap->pitch +c/8] & (0x80>>(c%8))) )
350                         /* we have a top border */
351                         SET_PIXEL(picture, yuv_bgcolor, (c+x), (y+r-1));
352
353                       /* bottom */
354                       if ( (r+1 < height) && (! bitmap->buffer[(r+1)*bitmap->pitch +c/8] & (0x80>>(c%8))) )
355                         /* we have a bottom border */
356                         SET_PIXEL(picture, yuv_bgcolor, (c+x), (y+r+1));
357
358                     }
359                 }
360
361               SET_PIXEL(picture, dpixel, (c+x), (y+r));
362             }
363         }
364     }
365 }
366
367
368 static inline void draw_box(AVPicture *picture, unsigned int x, unsigned int y, unsigned int width, unsigned int height, unsigned char yuv_color[3])
369 {
370   int i, j;
371
372   for (j = 0; (j < height); j++)
373     for (i = 0; (i < width); i++)
374       {
375         SET_PIXEL(picture, yuv_color, (i+x), (y+j));
376       }
377
378 }
379
380
381
382
383 void Process(void *ctx, AVPicture *picture, enum PixelFormat pix_fmt, int width, int height, int64_t pts)
384 {
385   ContextInfo *ci = (ContextInfo *) ctx;
386   FT_Face face = ci->face;
387   FT_GlyphSlot  slot = face->glyph;
388   unsigned char *text = ci->text;
389   unsigned char c;
390   int x = 0, y = 0, i=0, size=0;
391   unsigned char buff[MAXSIZE_TEXT];
392   unsigned char tbuff[MAXSIZE_TEXT];
393   time_t now = time(0);
394   int str_w, str_w_max;
395   FT_Vector pos[MAXSIZE_TEXT];
396   FT_Vector delta;
397
398   if (ci->file)
399     {
400       int fd = open(ci->file, O_RDONLY);
401
402       if (fd < 0)
403         {
404           text = ci->text;
405           av_log(NULL, AV_LOG_INFO, "WARNING: The file could not be opened. Using text provided with -t switch: %s", strerror(errno));
406         }
407       else
408         {
409           int l = read(fd, tbuff, sizeof(tbuff) - 1);
410
411           if (l >= 0)
412             {
413               tbuff[l] = 0;
414               text = tbuff;
415             }
416           else
417             {
418               text = ci->text;
419               av_log(NULL, AV_LOG_INFO, "WARNING: The file could not be read. Using text provided with -t switch: %s", strerror(errno));
420             }
421           close(fd);
422         }
423     }
424   else
425     {
426       text = ci->text;
427     }
428
429   strftime(buff, sizeof(buff), text, localtime(&now));
430
431   text = buff;
432
433   size = strlen(text);
434
435
436
437
438   /* measure string size and save glyphs position*/
439   str_w = str_w_max = 0;
440   x = ci->x;
441   y = ci->y;
442   for (i=0; i < size; i++)
443     {
444       c = text[i];
445
446       /* kerning */
447       if ( (ci->use_kerning) && (i > 0) && (ci->glyphs_index[c]) )
448         {
449           FT_Get_Kerning( ci->face,
450                           ci->glyphs_index[ text[i-1] ],
451                           ci->glyphs_index[c],
452                           ft_kerning_default,
453                           &delta );
454
455           x += delta.x >> 6;
456         }
457
458       if (( (x + ci->advance[ c ]) >= width ) || ( c == '\n' ))
459         {
460           str_w = width - ci->x - 1;
461
462           y += ci->text_height;
463           x = ci->x;
464         }
465
466
467       /* save position */
468       pos[i].x = x + ci->bitmap_left[c];
469       pos[i].y = y - ci->bitmap_top[c] + ci->baseline;
470
471
472       x += ci->advance[c];
473
474
475       if (str_w > str_w_max)
476         str_w_max = str_w;
477
478     }
479
480
481
482
483   if (ci->bg)
484     {
485       /* Check if it doesn't pass the limits */
486       if ( str_w_max + ci->x >= width )
487         str_w_max = width - ci->x - 1;
488       if ( y >= height )
489         y = height - 1 - 2*ci->y;
490
491       /* Draw Background */
492       draw_box( picture, ci->x, ci->y, str_w_max, y - ci->y, ci->bgcolor );
493     }
494
495
496
497   /* Draw Glyphs */
498   for (i=0; i < size; i++)
499     {
500       c = text[i];
501
502       if (
503           ( (c == '_') && (text == ci->text) ) || /* skip '_' (consider as space)
504                                                      IF text was specified in cmd line
505                                                      (which doesn't like neasted quotes)  */
506           ( c == '\n' ) /* Skip new line char, just go to new line */
507           )
508         continue;
509
510         /* now, draw to our target surface */
511         draw_glyph( picture,
512                     &(ci->bitmaps[ c ]),
513                     pos[i].x,
514                     pos[i].y,
515                     width,
516                     height,
517                     ci->fgcolor,
518                     ci->bgcolor,
519                     ci->outline );
520
521       /* increment pen position */
522       x += slot->advance.x >> 6;
523     }
524
525
526 }
527