modules/misc/freetype.c:
[vlc.git] / modules / misc / freetype.c
1 /*****************************************************************************
2  * freetype.c : Put text on the video, using freetype2
3  *****************************************************************************
4  * Copyright (C) 2002, 2003 VideoLAN
5  * $Id: freetype.c,v 1.19 2003/08/17 23:11:55 sigmunau Exp $
6  *
7  * Authors: Sigmund Augdal <sigmunau@idi.ntnu.no>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #include <stdlib.h>                                      /* malloc(), free() */
28 #include <string.h>
29
30 #include <vlc/vlc.h>
31 #include <vlc/vout.h>
32 #include <osd.h>
33 #include <math.h>
34
35 #include <ft2build.h>
36 #include FT_FREETYPE_H
37 #include FT_GLYPH_H
38
39 #ifdef SYS_DARWIN
40 #define DEFAULT_FONT "/System/Library/Fonts/LucidaGrande.dfont"
41 #elif defined( SYS_BEOS )
42 #define DEFAULT_FONT "/boot/beos/etc/fonts/ttfonts/Swiss721.ttf"
43 #else
44 #define DEFAULT_FONT ""
45 #endif
46
47 typedef struct line_desc_t line_desc_t;
48
49 /*****************************************************************************
50  * Local prototypes
51  *****************************************************************************/
52 static int  Create    ( vlc_object_t * );
53 static void Destroy   ( vlc_object_t * );
54
55 static void Render    ( vout_thread_t *, picture_t *,
56                         const subpicture_t * );
57 static void RenderI420( vout_thread_t *, picture_t *,
58                         const subpicture_t * );
59 static void RenderYUY2( vout_thread_t *, picture_t *,
60                         const subpicture_t * );
61 static void RenderRV32( vout_thread_t *, picture_t *,
62                         const subpicture_t * );
63 static int  AddText   ( vout_thread_t *, byte_t *, text_style_t *, int,
64                         int, int, mtime_t, mtime_t );
65 static void FreeString( subpicture_t * );
66
67 static int  GetUnicodeCharFromUTF8( byte_t ** );
68
69 static line_desc_t *NewLine( byte_t * );
70
71 /*****************************************************************************
72  * Module descriptor
73  *****************************************************************************/
74 #define FONT_TEXT N_("Font")
75 #define FONT_LONGTEXT N_("Filename of Font")
76 #define FONTSIZE_TEXT N_("Font size")
77 #define FONTSIZE_LONGTEXT N_("The size of the fonts used by the osd module" )
78
79 vlc_module_begin();
80     add_category_hint( N_("Fonts"), NULL, VLC_FALSE );
81     add_file( "freetype-font", DEFAULT_FONT, NULL, FONT_TEXT, FONT_LONGTEXT, VLC_FALSE );
82     add_integer( "freetype-fontsize", 16, NULL, FONTSIZE_TEXT, FONTSIZE_LONGTEXT, VLC_FALSE );
83     set_description( _("freetype2 font renderer") );
84     set_capability( "text renderer", 100 );
85     add_shortcut( "text" );
86     set_callbacks( Create, Destroy );
87 vlc_module_end();
88
89 /**
90  * Private data in a aubpicture. Describes a string.
91  */
92 struct subpicture_sys_t
93 {
94     int            i_x_margin;
95     int            i_y_margin;
96     int            i_width;
97     int            i_height;
98     int            i_flags;
99     /** The string associated with this subpicture */
100     byte_t        *psz_text;
101     line_desc_t   *p_lines;
102 };
103
104 struct line_desc_t
105 {
106     /** NULL-terminated list of glyphs making the string */
107     FT_BitmapGlyph *pp_glyphs;
108     /** list of relative positions for the glyphs */
109     FT_Vector      *p_glyph_pos;
110     int             i_height;
111     int             i_width;
112     line_desc_t    *p_next;
113 };
114
115 /*****************************************************************************
116  * text_remderer_sys_t: freetype local data
117  *****************************************************************************
118  * This structure is part of the video output thread descriptor.
119  * It describes the freetype specific properties of an output thread.
120  *****************************************************************************/
121 struct text_renderer_sys_t
122 {
123     FT_Library     p_library;   /* handle to library     */
124     FT_Face        p_face;      /* handle to face object */
125     vlc_mutex_t   *lock;
126     vlc_bool_t     i_use_kerning;
127     uint8_t        pi_gamma[256];
128 };
129
130 /*****************************************************************************
131  * Create: allocates osd-text video thread output method
132  *****************************************************************************
133  * This function allocates and initializes a Clone vout method.
134  *****************************************************************************/
135 #define gamma_value 2.0
136 static int Create( vlc_object_t *p_this )
137 {
138     vout_thread_t *p_vout = (vout_thread_t *)p_this;
139     char *psz_fontfile;
140     int i, i_error;
141     double gamma_inv = 1.0f / gamma_value;
142     vlc_value_t val;
143
144     /* Allocate structure */
145     p_vout->p_text_renderer_data = malloc( sizeof( text_renderer_sys_t ) );
146     if( p_vout->p_text_renderer_data == NULL )
147     {
148         msg_Err( p_vout, "out of memory" );
149         return VLC_ENOMEM;
150     }
151
152     for (i = 0; i < 256; i++) {
153         p_vout->p_text_renderer_data->pi_gamma[i] =
154             (uint8_t)( pow( (double)i / 255.0f, gamma_inv) * 255.0f );
155     }
156
157     var_Create( p_vout, "freetype-font", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
158     var_Create( p_vout, "freetype-fontsize",
159                 VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
160
161     /* Look what method was requested */
162     var_Get( p_vout, "freetype-font", &val );
163     psz_fontfile = val.psz_string;
164
165     if( !psz_fontfile || !*psz_fontfile )
166     {
167         if( psz_fontfile ) free( psz_fontfile );
168         psz_fontfile = (char *)malloc( PATH_MAX + 1 );
169 #ifdef WIN32
170         GetWindowsDirectory( psz_fontfile, PATH_MAX + 1 );
171         strcat( psz_fontfile, "\\fonts\\arial.ttf" );
172 #elif SYS_DARWIN
173         strcpy( psz_fontfile, DEFAULT_FONT );
174 #else
175         msg_Err( p_vout, "user didn't specify a font" );
176         free( p_vout->p_text_renderer_data );
177         return VLC_EGENERIC;
178 #endif
179     }
180
181     i_error = FT_Init_FreeType( &p_vout->p_text_renderer_data->p_library );
182     if( i_error )
183     {
184         msg_Err( p_vout, "couldn't initialize freetype" );
185         free( p_vout->p_text_renderer_data );
186         return VLC_EGENERIC;
187     }
188
189     i_error = FT_New_Face( p_vout->p_text_renderer_data->p_library,
190                            psz_fontfile ? psz_fontfile : "", 0,
191                            &p_vout->p_text_renderer_data->p_face );
192     if( i_error == FT_Err_Unknown_File_Format )
193     {
194         msg_Err( p_vout, "file %s have unknown format", psz_fontfile );
195         FT_Done_FreeType( p_vout->p_text_renderer_data->p_library );
196         free( p_vout->p_text_renderer_data );
197         if( psz_fontfile ) free( psz_fontfile );
198         return VLC_EGENERIC;
199     }
200     else if( i_error )
201     {
202         msg_Err( p_vout, "failed to load font file %s", psz_fontfile );
203         FT_Done_FreeType( p_vout->p_text_renderer_data->p_library );
204         free( p_vout->p_text_renderer_data );
205         if( psz_fontfile ) free( psz_fontfile );
206         return VLC_EGENERIC;
207     }
208     if( psz_fontfile ) free( psz_fontfile );
209
210     i_error = FT_Select_Charmap( p_vout->p_text_renderer_data->p_face,
211                                  ft_encoding_unicode );
212     if ( i_error )
213     {
214         msg_Err( p_vout, "Font has no unicode translation table" );
215         FT_Done_Face( p_vout->p_text_renderer_data->p_face );
216         FT_Done_FreeType( p_vout->p_text_renderer_data->p_library );
217         free( p_vout->p_text_renderer_data );
218         return VLC_EGENERIC;
219     }
220
221     p_vout->p_text_renderer_data->i_use_kerning =
222         FT_HAS_KERNING(p_vout->p_text_renderer_data->p_face);
223     var_Get( p_vout, "freetype-fontsize", &val );
224
225     i_error = FT_Set_Pixel_Sizes( p_vout->p_text_renderer_data->p_face, 0,
226                                   val.i_int );
227     if( i_error )
228     {
229         msg_Err( p_vout, "couldn't set font size to %d", val.i_int );
230         free( p_vout->p_text_renderer_data );
231         return VLC_EGENERIC;
232     }
233     p_vout->pf_add_string = AddText;
234     return VLC_SUCCESS;
235 }
236
237 /*****************************************************************************
238  * Destroy: destroy Clone video thread output method
239  *****************************************************************************
240  * Clean up all data and library connections
241  *****************************************************************************/
242 static void Destroy( vlc_object_t *p_this )
243 {
244     vout_thread_t *p_vout = (vout_thread_t *)p_this;
245     FT_Done_Face( p_vout->p_text_renderer_data->p_face );
246     FT_Done_FreeType( p_vout->p_text_renderer_data->p_library );
247     free( p_vout->p_text_renderer_data );
248 }
249
250 /*****************************************************************************
251  * Render: place string in picture
252  *****************************************************************************
253  * This function merges the previously rendered freetype glyphs into a picture
254  *****************************************************************************/
255 static void Render( vout_thread_t *p_vout, picture_t *p_pic,
256                     const subpicture_t *p_subpic )
257 {
258     switch( p_vout->output.i_chroma )
259     {
260         /* I420 target, no scaling */
261         case VLC_FOURCC('I','4','2','0'):
262         case VLC_FOURCC('I','Y','U','V'):
263         case VLC_FOURCC('Y','V','1','2'):
264             RenderI420( p_vout, p_pic, p_subpic );
265             break;
266 #if 0
267         /* RV16 target, scaling */
268         case VLC_FOURCC('R','V','1','6'):
269             RenderRV16( p_vout, p_pic, p_subpic );
270             break;
271 #endif
272         /* RV32 target, scaling */
273         case VLC_FOURCC('R','V','2','4'):
274         case VLC_FOURCC('R','V','3','2'):
275             RenderRV32( p_vout, p_pic, p_subpic );
276             break;
277         /* NVidia or BeOS overlay, no scaling */
278         case VLC_FOURCC('Y','U','Y','2'):
279             RenderYUY2( p_vout, p_pic, p_subpic );
280             break;
281
282         default:
283             msg_Err( p_vout, "unknown chroma, can't render SPU" );
284             break;
285     }
286 }
287
288 /**
289  * Draw a string on a i420 (or similar) picture
290  */
291 static void RenderI420( vout_thread_t *p_vout, picture_t *p_pic,
292                     const subpicture_t *p_subpic )
293 {
294     subpicture_sys_t *p_string = p_subpic->p_sys;
295     int i_plane, x, y, pen_x, pen_y;
296     unsigned int i;
297     line_desc_t *p_line;
298
299     for( p_line = p_subpic->p_sys->p_lines; p_line != NULL; p_line = p_line->p_next )
300     {
301         for( i_plane = 0 ; i_plane < p_pic->i_planes ; i_plane++ )
302         {
303             uint8_t *p_in;
304             int i_pitch = p_pic->p[ i_plane ].i_pitch;
305
306             p_in = p_pic->p[ i_plane ].p_pixels;
307
308             if ( i_plane == 0 )
309             {
310                 if ( p_string->i_flags & OSD_ALIGN_BOTTOM )
311                 {
312                     pen_y = p_pic->p[ i_plane ].i_lines - p_string->i_height -
313                         p_string->i_y_margin;
314                 }
315                 else
316                 {
317                     pen_y = p_string->i_y_margin;
318                 }
319                 pen_y += p_vout->p_text_renderer_data->p_face->size->metrics.ascender >> 6;
320                 if ( p_string->i_flags & OSD_ALIGN_RIGHT )
321                 {
322                     pen_x = i_pitch - p_line->i_width
323                         - p_string->i_x_margin;
324                 }
325                 else if ( p_string->i_flags & OSD_ALIGN_LEFT )
326                 {
327                     pen_x = p_string->i_x_margin;
328                 }
329                 else
330                 {
331                     pen_x = i_pitch / 2 - p_line->i_width / 2
332                         + p_string->i_x_margin;
333                 }
334
335                 for( i = 0; p_line->pp_glyphs[i] != NULL; i++ )
336                 {
337                     FT_BitmapGlyph p_glyph = p_line->pp_glyphs[ i ];
338 #define alpha p_vout->p_text_renderer_data->pi_gamma[ p_glyph->bitmap.buffer[ x + y * p_glyph->bitmap.width ] ]
339 #define pixel p_in[ ( p_line->p_glyph_pos[ i ].y + pen_y + y - p_glyph->top ) * i_pitch + x + pen_x + p_line->p_glyph_pos[ i ].x + p_glyph->left ]
340                     pen_y--;
341                     for(y = 0; y < p_glyph->bitmap.rows; y++ )
342                     {
343                         for( x = 0; x < p_glyph->bitmap.width; x++ )
344                         {
345                             pixel = ( ( pixel * ( 255 - alpha ) ) >> 8 );
346                         }
347                     }
348                     pen_y++; pen_x--;
349                     for(y = 0; y < p_glyph->bitmap.rows; y++ )
350                     {
351                         for( x = 0; x < p_glyph->bitmap.width; x++ )
352                         {
353                             pixel = ( ( pixel * ( 255 - alpha ) ) >> 8 );
354                         }
355                     }
356                     pen_x += 2;
357                     for(y = 0; y < p_glyph->bitmap.rows; y++ )
358                     {
359                         for( x = 0; x < p_glyph->bitmap.width; x++ )
360                         {
361                             pixel = ( ( pixel * ( 255 - alpha ) ) >> 8 );
362                         }
363                     }
364                     pen_y++; pen_x--;
365                     for(y = 0; y < p_glyph->bitmap.rows; y++ )
366                     {
367                         for( x = 0; x < p_glyph->bitmap.width; x++ )
368                         {
369                             pixel = ( ( pixel * ( 255 - alpha ) ) >> 8 );
370                         }
371                     }
372                     pen_y--;
373                     for(y = 0; y < p_glyph->bitmap.rows; y++ )
374                     {
375                         for( x = 0; x < p_glyph->bitmap.width; x++ )
376                         {
377                             pixel = ( ( pixel * ( 255 - alpha ) ) >> 8 ) +
378                                 ( 255 * alpha >> 8 );
379                         }
380                     }
381 #undef alpha
382 #undef pixel
383                 }
384             }
385             else
386             {
387                 if ( p_string->i_flags & OSD_ALIGN_BOTTOM )
388                 {
389                     pen_y = p_pic->p[i_plane].i_lines - ( p_string->i_height>>1) -
390                         (p_string->i_y_margin>>1);
391                 }
392                 else
393                 {
394                     pen_y = p_string->i_y_margin >> 1;
395                 }
396                 pen_y += p_vout->p_text_renderer_data->p_face->size->metrics.ascender >> 7;
397                 if ( p_string->i_flags & OSD_ALIGN_RIGHT )
398                 {
399                     pen_x = i_pitch - ( p_line->i_width >> 1 )
400                         - ( p_string->i_x_margin >> 1 );
401                 }
402                 else if ( p_string->i_flags & OSD_ALIGN_LEFT )
403                 {
404                     pen_x = p_string->i_x_margin >> 1;
405                 }
406                 else
407                 {
408                     pen_x = i_pitch / 2 - p_line->i_width / 4
409                         + p_string->i_x_margin / 2;
410                 }
411
412                 for( i = 0; p_line->pp_glyphs[i] != NULL; i++ )
413                 {
414                     FT_BitmapGlyph p_glyph = p_line->pp_glyphs[ i ];
415 #define alpha p_vout->p_text_renderer_data->pi_gamma[ p_glyph->bitmap.buffer[ ( x + y * p_glyph->bitmap.width ) ] ]
416 #define pixel p_in[ ( ( p_line->p_glyph_pos[ i ].y >> 1 ) + pen_y + ( y >> 1 ) -  ( p_glyph->top >> 1 ) ) * i_pitch + ( x >> 1 ) + pen_x + ( p_line->p_glyph_pos[ i ].x >> 1 ) + ( p_glyph->left >>1) ]
417                     for( y = 0; y < p_glyph->bitmap.rows; y+=2 )
418                     {
419                         for( x = 0; x < p_glyph->bitmap.width; x+=2 )
420                         {
421                             pixel = ( ( pixel * ( 0xFF - alpha ) ) >> 8 ) +
422                                 ( 0x80 * alpha >> 8 );
423 #undef alpha
424 #undef pixel
425                         }
426                     }
427                 }
428             }
429         }
430     }
431 }
432
433 /**
434  * Draw a string on a YUY2 picture
435  */
436 static void RenderYUY2( vout_thread_t *p_vout, picture_t *p_pic,
437                         const subpicture_t *p_subpic )
438 {
439     subpicture_sys_t *p_string = p_subpic->p_sys;
440     int x, y, pen_x, pen_y;
441     unsigned int i;
442     line_desc_t *p_line;
443
444     for( p_line = p_subpic->p_sys->p_lines; p_line != NULL;
445          p_line = p_line->p_next )
446     {
447         uint8_t *p_in;
448         int i_pitch = p_pic->p[0].i_pitch;
449         
450         p_in = p_pic->p[0].p_pixels;
451         
452         if ( p_string->i_flags & OSD_ALIGN_BOTTOM )
453         {
454             pen_y = p_pic->p[0].i_lines - p_string->i_height -
455                 p_string->i_y_margin;
456         }
457         else
458         {
459             pen_y = p_string->i_y_margin;
460         }
461         pen_y += p_vout->p_text_renderer_data->p_face->size->metrics.ascender >> 6;
462         if ( p_string->i_flags & OSD_ALIGN_RIGHT )
463         {
464             pen_x = i_pitch - p_line->i_width
465                 - p_string->i_x_margin;
466         }
467         else if ( p_string->i_flags & OSD_ALIGN_LEFT )
468         {
469             pen_x = p_string->i_x_margin;
470         }
471         else
472         {
473             pen_x = i_pitch / 2 /2 - p_line->i_width / 2 + p_string->i_x_margin;
474         }
475         
476         for( i = 0; p_line->pp_glyphs[i] != NULL; i++ )
477         {
478             FT_BitmapGlyph p_glyph = p_line->pp_glyphs[ i ];
479 #define alpha p_vout->p_text_renderer_data->pi_gamma[ p_glyph->bitmap.buffer[ x + y * p_glyph->bitmap.width ] ]
480 #define pixel p_in[ ( p_line->p_glyph_pos[ i ].y + pen_y + y - p_glyph->top ) * i_pitch + 2 * ( x + pen_x + p_line->p_glyph_pos[ i ].x + p_glyph->left ) ]
481             pen_y--;
482             for(y = 0; y < p_glyph->bitmap.rows; y++ )
483             {
484                 for( x = 0; x < p_glyph->bitmap.width; x++ )
485                 {
486                     pixel = ( ( pixel * ( 255 - alpha ) ) >> 8 );
487                 }
488             }
489             pen_y++; pen_x--;
490             for(y = 0; y < p_glyph->bitmap.rows; y++ )
491             {
492                 for( x = 0; x < p_glyph->bitmap.width; x++ )
493                 {
494                     pixel = ( ( pixel * ( 255 - alpha ) ) >> 8 );
495                 }
496             }
497             pen_x += 2;
498             for(y = 0; y < p_glyph->bitmap.rows; y++ )
499             {
500                 for( x = 0; x < p_glyph->bitmap.width; x++ )
501                 {
502                     pixel = ( ( pixel * ( 255 - alpha ) ) >> 8 );
503                 }
504             }
505             pen_y++; pen_x--;
506             for(y = 0; y < p_glyph->bitmap.rows; y++ )
507             {
508                 for( x = 0; x < p_glyph->bitmap.width; x++ )
509                 {
510                     pixel = ( ( pixel * ( 255 - alpha ) ) >> 8 );
511                 }
512             }
513             pen_y--;
514             for(y = 0; y < p_glyph->bitmap.rows; y++ )
515             {
516                 for( x = 0; x < p_glyph->bitmap.width; x++ )
517                 {
518                     pixel = ( ( pixel * ( 255 - alpha ) ) >> 8 ) +
519                         ( 255 * alpha >> 8 );
520                 }
521             }
522 #undef alpha
523 #undef pixel
524         }
525     }
526 }
527
528 /**
529  * Draw a string on a RV32 picture
530  */
531 static void RenderRV32( vout_thread_t *p_vout, picture_t *p_pic,
532                     const subpicture_t *p_subpic )
533 {
534     subpicture_sys_t *p_string = p_subpic->p_sys;
535     int i_plane, x, y, pen_x, pen_y;
536     unsigned int i;
537     line_desc_t *p_line;
538
539     i_plane = 0;
540     
541     for( p_line = p_subpic->p_sys->p_lines; p_line != NULL; p_line = p_line->p_next )
542     {
543         uint8_t *p_in;
544         int i_pitch = p_pic->p[ i_plane ].i_pitch;
545         
546         p_in = p_pic->p[ i_plane ].p_pixels;
547         
548         if ( p_string->i_flags & OSD_ALIGN_BOTTOM )
549         {
550             pen_y = p_pic->p[ i_plane ].i_lines - p_string->i_height -
551                 p_string->i_y_margin;
552         }
553         else
554         {
555             pen_y = p_string->i_y_margin;
556         }
557         pen_y += p_vout->p_text_renderer_data->p_face->size->metrics.ascender >> 6;
558         if ( p_string->i_flags & OSD_ALIGN_RIGHT )
559         {
560             pen_x = i_pitch - p_line->i_width
561                 - p_string->i_x_margin;
562         }
563         else if ( p_string->i_flags & OSD_ALIGN_LEFT )
564         {
565             pen_x = p_string->i_x_margin;
566         }
567         else
568         {
569             pen_x = i_pitch / 2 / 4 - p_line->i_width / 2
570                 + p_string->i_x_margin;
571         }
572         
573         for( i = 0; p_line->pp_glyphs[i] != NULL; i++ )
574         {
575             FT_BitmapGlyph p_glyph = p_line->pp_glyphs[ i ];
576 #define alpha p_vout->p_text_renderer_data->pi_gamma[ p_glyph->bitmap.buffer[ x + y * p_glyph->bitmap.width ] ]
577 #define pixel( c ) p_in[ ( p_line->p_glyph_pos[ i ].y + pen_y + y - p_glyph->top ) * i_pitch + ( x + pen_x + p_line->p_glyph_pos[ i ].x + p_glyph->left ) * 4 + c ]
578             pen_y--;
579             for(y = 0; y < p_glyph->bitmap.rows; y++ )
580             {
581                 for( x = 0; x < p_glyph->bitmap.width; x++ )
582                 {
583                     pixel( 0 ) = ( ( pixel( 0 ) * ( 255 - alpha ) ) >> 8 );
584                     pixel( 1 ) = ( ( pixel( 1 ) * ( 255 - alpha ) ) >> 8 );
585                     pixel( 2 ) = ( ( pixel( 2 ) * ( 255 - alpha ) ) >> 8 );
586                 }
587             }
588             pen_y++; pen_x--;
589             for(y = 0; y < p_glyph->bitmap.rows; y++ )
590             {
591                 for( x = 0; x < p_glyph->bitmap.width; x++ )
592                 {
593                     pixel( 0 ) = ( ( pixel( 0 ) * ( 255 - alpha ) ) >> 8 );
594                     pixel( 1 ) = ( ( pixel( 1 ) * ( 255 - alpha ) ) >> 8 );
595                     pixel( 2 ) = ( ( pixel( 2 ) * ( 255 - alpha ) ) >> 8 );
596                 }
597             }
598             pen_x += 2;
599             for(y = 0; y < p_glyph->bitmap.rows; y++ )
600             {
601                 for( x = 0; x < p_glyph->bitmap.width; x++ )
602                 {
603                     pixel( 0 ) = ( ( pixel( 0 ) * ( 255 - alpha ) ) >> 8 );
604                     pixel( 1 ) = ( ( pixel( 1 ) * ( 255 - alpha ) ) >> 8 );
605                     pixel( 2 ) = ( ( pixel( 2 ) * ( 255 - alpha ) ) >> 8 );
606                 }
607             }
608             pen_y++; pen_x--;
609             for(y = 0; y < p_glyph->bitmap.rows; y++ )
610             {
611                 for( x = 0; x < p_glyph->bitmap.width; x++ )
612                 {
613                     pixel( 0 ) = ( ( pixel( 0 ) * ( 255 - alpha ) ) >> 8 );
614                     pixel( 1 ) = ( ( pixel( 1 ) * ( 255 - alpha ) ) >> 8 );
615                     pixel( 2 ) = ( ( pixel( 2 ) * ( 255 - alpha ) ) >> 8 );
616                 }
617             }
618             pen_y--;
619             for(y = 0; y < p_glyph->bitmap.rows; y++ )
620             {
621                 for( x = 0; x < p_glyph->bitmap.width; x++ )
622                 {
623                     pixel( 0 ) = ( ( pixel( 0 ) * ( 255 - alpha ) ) >> 8 ) +
624                         ( 255 * alpha >> 8 );
625                     pixel( 1 ) = ( ( pixel( 1 ) * ( 255 - alpha ) ) >> 8 ) +
626                         ( 255 * alpha >> 8 );
627                     pixel( 2 ) = ( ( pixel( 2 ) * ( 255 - alpha ) ) >> 8 ) +
628                         ( 255 * alpha >> 8 );
629                 }
630             }
631 #undef alpha
632 #undef pixel
633         }
634     }
635 }
636
637 /**
638  * This function receives a string and creates a subpicture for it. It
639  * also calculates the size needed for this string, and renders the
640  * needed glyphs into memory. It is used as pf_add_string callback in
641  * the vout method by this module
642  */
643 static int AddText ( vout_thread_t *p_vout, byte_t *psz_string,
644                      text_style_t *p_style, int i_flags, int i_hmargin,
645                      int i_vmargin, mtime_t i_start, mtime_t i_stop )
646 {
647     subpicture_sys_t *p_string;
648     int i, i_pen_y, i_pen_x, i_error, i_glyph_index, i_previous, i_char;
649     subpicture_t *p_subpic;
650     line_desc_t  *p_line,  *p_next;
651
652     FT_BBox line;
653     FT_BBox glyph_size;
654     FT_Vector result;
655     FT_Glyph tmp_glyph;
656
657     /* Sanity check */
658     if ( !psz_string || !*psz_string )
659     {
660         return VLC_EGENERIC;
661     }
662
663     result.x = 0;
664     result.y = 0;
665     line.xMin = 0;
666     line.xMax = 0;
667     line.yMin = 0;
668     line.yMax = 0;
669
670     p_line = 0;
671     p_string = 0;
672     p_subpic = 0;
673
674     /* Create and initialize a subpicture */
675     p_subpic = vout_CreateSubPicture( p_vout, MEMORY_SUBPICTURE );
676     if ( p_subpic == NULL )
677     {
678         return VLC_EGENERIC;
679     }
680     p_subpic->p_sys = 0;
681     p_subpic->pf_render = Render;
682     p_subpic->pf_destroy = FreeString;
683     p_subpic->i_start = i_start;
684     p_subpic->i_stop = i_stop;
685     if( i_stop == 0 )
686     {
687         p_subpic->b_ephemer = VLC_TRUE;
688     }
689     else
690     {
691         p_subpic->b_ephemer = VLC_FALSE;
692     }
693
694     /* Create and initialize private data for the subpicture */
695     p_string = malloc( sizeof(subpicture_sys_t) );
696     if ( p_string == NULL )
697     {
698         msg_Err( p_vout, "Out of memory" );
699         goto error;
700     }
701     p_subpic->p_sys = p_string;
702     p_string->i_flags = i_flags;
703     p_string->i_x_margin = i_hmargin;
704     p_string->i_y_margin = i_vmargin;
705     p_string->p_lines = 0;
706     p_string->psz_text = strdup( psz_string );
707
708     /* Calculate relative glyph positions and a bounding box for the
709      * entire string */
710     p_line = NewLine( psz_string );
711     if( p_line == NULL )
712     {
713         msg_Err( p_vout, "Out of memory" );
714         goto error;
715     }
716     p_string->p_lines = p_line;
717     i_pen_x = 0;
718     i_pen_y = 0;
719     i_previous = 0;
720     i = 0;
721
722 #define face p_vout->p_text_renderer_data->p_face
723 #define glyph face->glyph
724
725     while( *psz_string )
726     {
727         i_char = GetUnicodeCharFromUTF8( &psz_string );
728
729         if ( i_char == '\r' ) /* ignore CR chars wherever they may be */
730         {
731             continue;
732         }
733
734         if ( i_char == '\n' )
735         {
736             p_next = NewLine( psz_string );
737             if( p_next == NULL )
738             {
739                 msg_Err( p_vout, "Out of memory" );
740                 goto error;
741             }
742             p_line->p_next = p_next;
743             p_line->i_width = line.xMax;
744             p_line->i_height = face->size->metrics.height >> 6;
745             p_line->pp_glyphs[ i ] = NULL;
746             p_line = p_next;
747             result.x = __MAX( result.x, line.xMax );
748             result.y += face->size->metrics.height >> 6;
749             i_pen_x = 0;
750             line.xMin = 0;
751             line.xMax = 0;
752             line.yMin = 0;
753             line.yMax = 0;
754             i_pen_y += face->size->metrics.height >> 6;
755             msg_Dbg( p_vout, "Creating new line, i is %d", i );
756             i = 0;
757             continue;
758         }
759
760         i_glyph_index = FT_Get_Char_Index( face, i_char );
761         if ( p_vout->p_text_renderer_data->i_use_kerning && i_glyph_index
762             && i_previous )
763         {
764             FT_Vector delta;
765             FT_Get_Kerning( face, i_previous, i_glyph_index,
766                             ft_kerning_default, &delta );
767             i_pen_x += delta.x >> 6;
768
769         }
770         p_line->p_glyph_pos[ i ].x = i_pen_x;
771         p_line->p_glyph_pos[ i ].y = i_pen_y;
772         i_error = FT_Load_Glyph( face, i_glyph_index, FT_LOAD_DEFAULT );
773         if ( i_error )
774         {
775             msg_Err( p_vout, "FT_Load_Glyph returned %d", i_error );
776             goto error;
777         }
778         i_error = FT_Get_Glyph( glyph, &tmp_glyph );
779         if ( i_error )
780         {
781             msg_Err( p_vout, "FT_Get_Glyph returned %d", i_error );
782             goto error;
783         }
784         FT_Glyph_Get_CBox( tmp_glyph, ft_glyph_bbox_pixels, &glyph_size );
785         i_error = FT_Glyph_To_Bitmap( &tmp_glyph, ft_render_mode_normal,
786                                       NULL, 1 );
787         if ( i_error ) continue;
788         p_line->pp_glyphs[ i ] = (FT_BitmapGlyph)tmp_glyph;
789
790         /* Do rest */
791         line.xMax = p_line->p_glyph_pos[i].x + glyph_size.xMax - glyph_size.xMin;
792         line.yMax = __MAX( line.yMax, glyph_size.yMax );
793         line.yMin = __MIN( line.yMin, glyph_size.yMin );
794
795         i_previous = i_glyph_index;
796         i_pen_x += glyph->advance.x >> 6;
797         i++;
798     }
799     p_line->i_width = line.xMax;
800     p_line->i_height = face->size->metrics.height >> 6;
801     p_line->pp_glyphs[ i ] = NULL;
802     result.x = __MAX( result.x, line.xMax );
803     result.y += line.yMax - line.yMin;
804     p_string->i_height = result.y;
805     p_string->i_width = result.x;
806     msg_Dbg( p_vout, "string height is %d, width is %d",
807              p_string->i_height, p_string->i_width );
808     msg_Dbg( p_vout, "adding string \"%s\" at (%d,%d) start_date "I64Fd
809              " end_date" I64Fd, p_string->psz_text, p_string->i_x_margin,
810              p_string->i_y_margin, i_start, i_stop );
811     vout_DisplaySubPicture( p_vout, p_subpic );
812     return VLC_SUCCESS;
813
814 #undef face
815 #undef glyph
816
817  error:
818     FreeString( p_subpic );
819     vout_DestroySubPicture( p_vout, p_subpic );
820     return VLC_EGENERIC;
821 }
822
823 static void FreeString( subpicture_t *p_subpic )
824 {
825     unsigned int i;
826     subpicture_sys_t *p_string = p_subpic->p_sys;
827     line_desc_t *p_line, *p_next;
828
829     if( p_subpic->p_sys == NULL ) return;
830
831     for( p_line = p_string->p_lines; p_line != NULL; p_line = p_next )
832     {
833         p_next = p_line->p_next;
834         for( i = 0; p_line->pp_glyphs[ i ] != NULL; i++ )
835         {
836             FT_Done_Glyph( (FT_Glyph)p_line->pp_glyphs[ i ] );
837         }
838         free( p_line->pp_glyphs );
839         free( p_line->p_glyph_pos );
840         free( p_line );
841     }
842             
843     free( p_string->psz_text );
844     free( p_string );
845 }
846
847 /* convert one or more utf8 bytes into a unicode character */
848 static int GetUnicodeCharFromUTF8( byte_t **ppsz_utf8_string )
849 {
850     int i_remaining_bytes, i_char = 0;
851     if( ( **ppsz_utf8_string & 0xFC ) == 0xFC )
852     {
853         i_char = **ppsz_utf8_string & 1;
854         i_remaining_bytes = 5;
855     }
856     else if( ( **ppsz_utf8_string & 0xF8 ) == 0xF8 )
857     {
858         i_char = **ppsz_utf8_string & 3;
859         i_remaining_bytes = 4;
860     }
861     else if( ( **ppsz_utf8_string & 0xF0 ) == 0xF0 )
862     {
863         i_char = **ppsz_utf8_string & 7;
864         i_remaining_bytes = 3;
865     }
866     else if( ( **ppsz_utf8_string & 0xE0 ) == 0xE0 )
867     {
868         i_char = **ppsz_utf8_string & 15;
869         i_remaining_bytes = 2;
870     }
871     else if( ( **ppsz_utf8_string & 0xC0 ) == 0xC0 )
872     {
873         i_char = **ppsz_utf8_string & 31;
874         i_remaining_bytes = 1;
875     }
876     else
877     {
878         i_char = **ppsz_utf8_string;
879         i_remaining_bytes = 0;
880     }
881     while( i_remaining_bytes )
882     {
883         (*ppsz_utf8_string)++;
884         i_remaining_bytes--;
885         i_char = ( i_char << 6 ) + ( **ppsz_utf8_string & 0x3F );
886     }
887     (*ppsz_utf8_string)++;
888     return i_char;
889 }
890
891 static line_desc_t *NewLine( byte_t *psz_string )
892 {
893     int i_count;
894     line_desc_t *p_line = malloc( sizeof(line_desc_t) );
895     if( !p_line )
896     {
897         return NULL;
898     }
899     p_line->i_height = 0;
900     p_line->i_width = 0;
901     p_line->p_next = NULL;
902
903     /* We don't use CountUtf8Characters() here because we are not acutally
904      * sure the string is utf8. Better be safe than sorry. */
905     i_count = strlen( psz_string );
906
907     p_line->pp_glyphs = malloc( sizeof(FT_BitmapGlyph)
908                                 * ( i_count + 1 ) );
909     if( p_line->pp_glyphs == NULL )
910     {
911         free( p_line );
912         return NULL;
913     }
914     p_line->p_glyph_pos = malloc( sizeof( FT_Vector )
915                                   * i_count + 1 );
916     if( p_line->p_glyph_pos == NULL )
917     {
918         free( p_line->pp_glyphs );
919         free( p_line );
920         return NULL;
921     }
922
923     return p_line;
924 }