52d4e96ee05d1e203f83c33ff044c5419bae3cc9
[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.17 2003/08/10 10:22:52 gbazin 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 int  AddText   ( vout_thread_t *, byte_t *, text_style_t *, int,
62                         int, int, mtime_t, mtime_t );
63 static void FreeString( subpicture_t * );
64
65 static int  GetUnicodeCharFromUTF8( byte_t ** );
66
67 static line_desc_t *NewLine( byte_t * );
68
69 /*****************************************************************************
70  * Module descriptor
71  *****************************************************************************/
72 #define FONT_TEXT N_("Font")
73 #define FONT_LONGTEXT N_("Filename of Font")
74 #define FONTSIZE_TEXT N_("Font size")
75 #define FONTSIZE_LONGTEXT N_("The size of the fonts used by the osd module" )
76
77 vlc_module_begin();
78     add_category_hint( N_("Fonts"), NULL, VLC_FALSE );
79     add_file( "freetype-font", DEFAULT_FONT, NULL, FONT_TEXT, FONT_LONGTEXT, VLC_FALSE );
80     add_integer( "freetype-fontsize", 16, NULL, FONTSIZE_TEXT, FONTSIZE_LONGTEXT, VLC_FALSE );
81     set_description( _("freetype2 font renderer") );
82     set_capability( "text renderer", 100 );
83     add_shortcut( "text" );
84     set_callbacks( Create, Destroy );
85 vlc_module_end();
86
87 /**
88  * Private data in a aubpicture. Describes a string.
89  */
90 struct subpicture_sys_t
91 {
92     int            i_x_margin;
93     int            i_y_margin;
94     int            i_width;
95     int            i_height;
96     int            i_flags;
97     /** The string associated with this subpicture */
98     byte_t        *psz_text;
99     line_desc_t   *p_lines;
100 };
101
102 struct line_desc_t
103 {
104     /** NULL-terminated list of glyphs making the string */
105     FT_BitmapGlyph *pp_glyphs;
106     /** list of relative positions for the glyphs */
107     FT_Vector      *p_glyph_pos;
108     int             i_height;
109     int             i_width;
110     line_desc_t    *p_next;
111 };
112
113 /*****************************************************************************
114  * text_remderer_sys_t: freetype local data
115  *****************************************************************************
116  * This structure is part of the video output thread descriptor.
117  * It describes the freetype specific properties of an output thread.
118  *****************************************************************************/
119 struct text_renderer_sys_t
120 {
121     FT_Library     p_library;   /* handle to library     */
122     FT_Face        p_face;      /* handle to face object */
123     vlc_mutex_t   *lock;
124     vlc_bool_t     i_use_kerning;
125     uint8_t        pi_gamma[256];
126 };
127
128 /*****************************************************************************
129  * Create: allocates osd-text video thread output method
130  *****************************************************************************
131  * This function allocates and initializes a Clone vout method.
132  *****************************************************************************/
133 #define gamma_value 2.0
134 static int Create( vlc_object_t *p_this )
135 {
136     vout_thread_t *p_vout = (vout_thread_t *)p_this;
137     char *psz_fontfile;
138     int i, i_error;
139     double gamma_inv = 1.0f / gamma_value;
140     vlc_value_t val;
141
142     /* Allocate structure */
143     p_vout->p_text_renderer_data = malloc( sizeof( text_renderer_sys_t ) );
144     if( p_vout->p_text_renderer_data == NULL )
145     {
146         msg_Err( p_vout, "out of memory" );
147         return VLC_ENOMEM;
148     }
149
150     for (i = 0; i < 256; i++) {
151         p_vout->p_text_renderer_data->pi_gamma[i] =
152             (uint8_t)( pow( (double)i / 255.0f, gamma_inv) * 255.0f );
153     }
154
155     var_Create( p_vout, "freetype-font", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
156     var_Create( p_vout, "freetype-fontsize",
157                 VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
158
159     /* Look what method was requested */
160     var_Get( p_vout, "freetype-font", &val );
161     psz_fontfile = val.psz_string;
162
163     if( !psz_fontfile || !*psz_fontfile )
164     {
165         if( psz_fontfile ) free( psz_fontfile );
166         psz_fontfile = (char *)malloc( PATH_MAX + 1 );
167 #ifdef WIN32
168         GetWindowsDirectory( psz_fontfile, PATH_MAX + 1 );
169         strcat( psz_fontfile, "\\fonts\\arial.ttf" );
170 #elif SYS_DARWIN
171         strcpy( psz_fontfile, DEFAULT_FONT );
172 #else
173         msg_Err( p_vout, "user didn't specify a font" );
174         free( p_vout->p_text_renderer_data );
175         return VLC_EGENERIC;
176 #endif
177     }
178
179     i_error = FT_Init_FreeType( &p_vout->p_text_renderer_data->p_library );
180     if( i_error )
181     {
182         msg_Err( p_vout, "couldn't initialize freetype" );
183         free( p_vout->p_text_renderer_data );
184         return VLC_EGENERIC;
185     }
186
187     i_error = FT_New_Face( p_vout->p_text_renderer_data->p_library,
188                            psz_fontfile ? psz_fontfile : "", 0,
189                            &p_vout->p_text_renderer_data->p_face );
190     if( i_error == FT_Err_Unknown_File_Format )
191     {
192         msg_Err( p_vout, "file %s have unknown format", psz_fontfile );
193         FT_Done_FreeType( p_vout->p_text_renderer_data->p_library );
194         free( p_vout->p_text_renderer_data );
195         if( psz_fontfile ) free( psz_fontfile );
196         return VLC_EGENERIC;
197     }
198     else if( i_error )
199     {
200         msg_Err( p_vout, "failed to load font file %s", psz_fontfile );
201         FT_Done_FreeType( p_vout->p_text_renderer_data->p_library );
202         free( p_vout->p_text_renderer_data );
203         if( psz_fontfile ) free( psz_fontfile );
204         return VLC_EGENERIC;
205     }
206     if( psz_fontfile ) free( psz_fontfile );
207
208     i_error = FT_Select_Charmap( p_vout->p_text_renderer_data->p_face,
209                                  ft_encoding_unicode );
210     if ( i_error )
211     {
212         msg_Err( p_vout, "Font has no unicode translation table" );
213         FT_Done_Face( p_vout->p_text_renderer_data->p_face );
214         FT_Done_FreeType( p_vout->p_text_renderer_data->p_library );
215         free( p_vout->p_text_renderer_data );
216         return VLC_EGENERIC;
217     }
218
219     p_vout->p_text_renderer_data->i_use_kerning =
220         FT_HAS_KERNING(p_vout->p_text_renderer_data->p_face);
221     var_Get( p_vout, "freetype-fontsize", &val );
222
223     i_error = FT_Set_Pixel_Sizes( p_vout->p_text_renderer_data->p_face, 0,
224                                   val.i_int );
225     if( i_error )
226     {
227         msg_Err( p_vout, "couldn't set font size to %d", val.i_int );
228         free( p_vout->p_text_renderer_data );
229         return VLC_EGENERIC;
230     }
231     p_vout->pf_add_string = AddText;
232     return VLC_SUCCESS;
233 }
234
235 /*****************************************************************************
236  * Destroy: destroy Clone video thread output method
237  *****************************************************************************
238  * Clean up all data and library connections
239  *****************************************************************************/
240 static void Destroy( vlc_object_t *p_this )
241 {
242     vout_thread_t *p_vout = (vout_thread_t *)p_this;
243     FT_Done_Face( p_vout->p_text_renderer_data->p_face );
244     FT_Done_FreeType( p_vout->p_text_renderer_data->p_library );
245     free( p_vout->p_text_renderer_data );
246 }
247
248 /*****************************************************************************
249  * Render: place string in picture
250  *****************************************************************************
251  * This function merges the previously rendered freetype glyphs into a picture
252  *****************************************************************************/
253 static void Render( vout_thread_t *p_vout, picture_t *p_pic,
254                     const subpicture_t *p_subpic )
255 {
256     switch( p_vout->output.i_chroma )
257     {
258         /* I420 target, no scaling */
259         case VLC_FOURCC('I','4','2','0'):
260         case VLC_FOURCC('I','Y','U','V'):
261         case VLC_FOURCC('Y','V','1','2'):
262             RenderI420( p_vout, p_pic, p_subpic );
263             break;
264 #if 0
265         /* RV16 target, scaling */
266         case VLC_FOURCC('R','V','1','6'):
267             RenderRV16( p_vout, p_pic, p_subpic );
268             break;
269
270         /* RV32 target, scaling */
271         case VLC_FOURCC('R','V','2','4'):
272         case VLC_FOURCC('R','V','3','2'):
273             RenderRV32( p_vout, p_pic, p_subpic );
274             break;
275 #endif
276         /* NVidia or BeOS overlay, no scaling */
277         case VLC_FOURCC('Y','U','Y','2'):
278             RenderYUY2( p_vout, p_pic, p_subpic );
279             break;
280
281         default:
282             msg_Err( p_vout, "unknown chroma, can't render SPU" );
283             break;
284     }
285 }
286
287 /**
288  * Draw a string on a i420 (or similar) picture
289  */
290 static void RenderI420( vout_thread_t *p_vout, picture_t *p_pic,
291                     const subpicture_t *p_subpic )
292 {
293     subpicture_sys_t *p_string = p_subpic->p_sys;
294     int i_plane, x, y, pen_x, pen_y;
295     unsigned int i;
296     line_desc_t *p_line;
297
298     for( p_line = p_subpic->p_sys->p_lines; p_line != NULL; p_line = p_line->p_next )
299     {
300         for( i_plane = 0 ; i_plane < p_pic->i_planes ; i_plane++ )
301         {
302             uint8_t *p_in;
303             int i_pitch = p_pic->p[ i_plane ].i_pitch;
304
305             p_in = p_pic->p[ i_plane ].p_pixels;
306
307             if ( i_plane == 0 )
308             {
309                 if ( p_string->i_flags & OSD_ALIGN_BOTTOM )
310                 {
311                     pen_y = p_pic->p[ i_plane ].i_lines - p_string->i_height -
312                         p_string->i_y_margin;
313                 }
314                 else
315                 {
316                     pen_y = p_string->i_y_margin;
317                 }
318                 pen_y += p_vout->p_text_renderer_data->p_face->size->metrics.ascender >> 6;
319                 if ( p_string->i_flags & OSD_ALIGN_RIGHT )
320                 {
321                     pen_x = i_pitch - p_line->i_width
322                         - p_string->i_x_margin;
323                 }
324                 else if ( p_string->i_flags & OSD_ALIGN_LEFT )
325                 {
326                     pen_x = p_string->i_x_margin;
327                 }
328                 else
329                 {
330                     pen_x = i_pitch / 2 - p_line->i_width / 2
331                         + p_string->i_x_margin;
332                 }
333
334                 for( i = 0; p_line->pp_glyphs[i] != NULL; i++ )
335                 {
336                     FT_BitmapGlyph p_glyph = p_line->pp_glyphs[ i ];
337 #define alpha p_vout->p_text_renderer_data->pi_gamma[ p_glyph->bitmap.buffer[ x + y * p_glyph->bitmap.width ] ]
338 #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 ]
339                     for(y = 0; y < p_glyph->bitmap.rows; y++ )
340                     {
341                         for( x = 0; x < p_glyph->bitmap.width; x++ )
342                         {
343                             pixel = ( ( pixel * ( 255 - alpha ) ) >> 8 ) +
344                                 ( 255 * alpha >> 8 );
345 #undef alpha
346 #undef pixel
347                         }
348                     }
349                 }
350             }
351             else
352             {
353                 if ( p_string->i_flags & OSD_ALIGN_BOTTOM )
354                 {
355                     pen_y = p_pic->p[i_plane].i_lines - ( p_string->i_height>>1) -
356                         (p_string->i_y_margin>>1);
357                 }
358                 else
359                 {
360                     pen_y = p_string->i_y_margin >> 1;
361                 }
362                 pen_y += p_vout->p_text_renderer_data->p_face->size->metrics.ascender >> 7;
363                 if ( p_string->i_flags & OSD_ALIGN_RIGHT )
364                 {
365                     pen_x = i_pitch - ( p_line->i_width >> 1 )
366                         - ( p_string->i_x_margin >> 1 );
367                 }
368                 else if ( p_string->i_flags & OSD_ALIGN_LEFT )
369                 {
370                     pen_x = p_string->i_x_margin >> 1;
371                 }
372                 else
373                 {
374                     pen_x = i_pitch / 2 - p_line->i_width / 4
375                         + p_string->i_x_margin / 2;
376                 }
377
378                 for( i = 0; p_line->pp_glyphs[i] != NULL; i++ )
379                 {
380                     FT_BitmapGlyph p_glyph = p_line->pp_glyphs[ i ];
381 #define alpha p_vout->p_text_renderer_data->pi_gamma[ p_glyph->bitmap.buffer[ ( x + y * p_glyph->bitmap.width ) ] ]
382 #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) ]
383                     for( y = 0; y < p_glyph->bitmap.rows; y+=2 )
384                     {
385                         for( x = 0; x < p_glyph->bitmap.width; x+=2 )
386                         {
387                             pixel = ( ( pixel * ( 0xFF - alpha ) ) >> 8 ) +
388                                 ( 0x80 * alpha >> 8 );
389 #undef alpha
390 #undef pixel
391                         }
392                     }
393                 }
394             }
395         }
396     }
397 }
398
399 /**
400  * Draw a string on a YUY2 picture
401  */
402 static void RenderYUY2( vout_thread_t *p_vout, picture_t *p_pic,
403                         const subpicture_t *p_subpic )
404 {
405     subpicture_sys_t *p_string = p_subpic->p_sys;
406     int x, y, pen_x, pen_y;
407     unsigned int i;
408     line_desc_t *p_line;
409
410     for( p_line = p_subpic->p_sys->p_lines; p_line != NULL;
411          p_line = p_line->p_next )
412     {
413         uint8_t *p_in;
414         int i_pitch = p_pic->p[0].i_pitch;
415         
416         p_in = p_pic->p[0].p_pixels;
417         
418         if ( p_string->i_flags & OSD_ALIGN_BOTTOM )
419         {
420             pen_y = p_pic->p[0].i_lines - p_string->i_height -
421                 p_string->i_y_margin;
422         }
423         else
424         {
425             pen_y = p_string->i_y_margin;
426         }
427         pen_y += p_vout->p_text_renderer_data->p_face->size->metrics.ascender >> 6;
428         if ( p_string->i_flags & OSD_ALIGN_RIGHT )
429         {
430             pen_x = i_pitch - p_line->i_width
431                 - p_string->i_x_margin;
432         }
433         else if ( p_string->i_flags & OSD_ALIGN_LEFT )
434         {
435             pen_x = p_string->i_x_margin;
436         }
437         else
438         {
439             pen_x = i_pitch / 2 - p_line->i_width / 2 + p_string->i_x_margin;
440         }
441         
442         for( i = 0; p_line->pp_glyphs[i] != NULL; i++ )
443         {
444             FT_BitmapGlyph p_glyph = p_line->pp_glyphs[ i ];
445 #define alpha p_vout->p_text_renderer_data->pi_gamma[ p_glyph->bitmap.buffer[ x + y * p_glyph->bitmap.width ] ]
446 #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 ) ]
447             for(y = 0; y < p_glyph->bitmap.rows; y++ )
448             {
449                 for( x = 0; x < p_glyph->bitmap.width; x++ )
450                 {
451                     pixel = ( ( pixel * ( 255 - alpha ) ) >> 8 ) +
452                         ( 255 * alpha >> 8 );
453 #undef alpha
454 #undef pixel
455                 }
456             }
457         }
458     }
459 }
460
461
462 /**
463  * This function receives a string and creates a subpicture for it. It
464  * also calculates the size needed for this string, and renders the
465  * needed glyphs into memory. It is used as pf_add_string callback in
466  * the vout method by this module
467  */
468 static int AddText ( vout_thread_t *p_vout, byte_t *psz_string,
469                      text_style_t *p_style, int i_flags, int i_hmargin,
470                      int i_vmargin, mtime_t i_start, mtime_t i_stop )
471 {
472     subpicture_sys_t *p_string;
473     int i, i_pen_y, i_pen_x, i_error, i_glyph_index, i_previous, i_char;
474     subpicture_t *p_subpic;
475     line_desc_t  *p_line,  *p_next;
476
477     FT_BBox line;
478     FT_BBox glyph_size;
479     FT_Vector result;
480     FT_Glyph tmp_glyph;
481
482     /* Sanity check */
483     if ( !psz_string || !*psz_string )
484     {
485         return VLC_EGENERIC;
486     }
487
488     result.x = 0;
489     result.y = 0;
490     line.xMin = 0;
491     line.xMax = 0;
492     line.yMin = 0;
493     line.yMax = 0;
494
495     p_line = 0;
496     p_string = 0;
497     p_subpic = 0;
498
499     /* Create and initialize a subpicture */
500     p_subpic = vout_CreateSubPicture( p_vout, MEMORY_SUBPICTURE );
501     if ( p_subpic == NULL )
502     {
503         return VLC_EGENERIC;
504     }
505     p_subpic->p_sys = 0;
506     p_subpic->pf_render = Render;
507     p_subpic->pf_destroy = FreeString;
508     p_subpic->i_start = i_start;
509     p_subpic->i_stop = i_stop;
510     if( i_stop == 0 )
511     {
512         p_subpic->b_ephemer = VLC_TRUE;
513     }
514     else
515     {
516         p_subpic->b_ephemer = VLC_FALSE;
517     }
518
519     /* Create and initialize private data for the subpicture */
520     p_string = malloc( sizeof(subpicture_sys_t) );
521     if ( p_string == NULL )
522     {
523         msg_Err( p_vout, "Out of memory" );
524         goto error;
525     }
526     p_subpic->p_sys = p_string;
527     p_string->i_flags = i_flags;
528     p_string->i_x_margin = i_hmargin;
529     p_string->i_y_margin = i_vmargin;
530     p_string->p_lines = 0;
531     p_string->psz_text = strdup( psz_string );
532
533     /* Calculate relative glyph positions and a bounding box for the
534      * entire string */
535     p_line = NewLine( psz_string );
536     if( p_line == NULL )
537     {
538         msg_Err( p_vout, "Out of memory" );
539         goto error;
540     }
541     p_string->p_lines = p_line;
542     i_pen_x = 0;
543     i_pen_y = 0;
544     i_previous = 0;
545     i = 0;
546
547 #define face p_vout->p_text_renderer_data->p_face
548 #define glyph face->glyph
549
550     while( *psz_string )
551     {
552         i_char = GetUnicodeCharFromUTF8( &psz_string );
553
554         if ( i_char == '\r' ) /* ignore CR chars wherever they may be */
555         {
556             continue;
557         }
558
559         if ( i_char == '\n' )
560         {
561             p_next = NewLine( psz_string );
562             if( p_next == NULL )
563             {
564                 msg_Err( p_vout, "Out of memory" );
565                 goto error;
566             }
567             p_line->p_next = p_next;
568             p_line->i_width = line.xMax;
569             p_line->i_height = face->size->metrics.height >> 6;
570             p_line->pp_glyphs[ i ] = NULL;
571             p_line = p_next;
572             result.x = __MAX( result.x, line.xMax );
573             result.y += face->size->metrics.height >> 6;
574             i_pen_x = 0;
575             line.xMin = 0;
576             line.xMax = 0;
577             line.yMin = 0;
578             line.yMax = 0;
579             i_pen_y += face->size->metrics.height >> 6;
580             msg_Dbg( p_vout, "Creating new line, i is %d", i );
581             i = 0;
582             continue;
583         }
584
585         i_glyph_index = FT_Get_Char_Index( face, i_char );
586         if ( p_vout->p_text_renderer_data->i_use_kerning && i_glyph_index
587             && i_previous )
588         {
589             FT_Vector delta;
590             FT_Get_Kerning( face, i_previous, i_glyph_index,
591                             ft_kerning_default, &delta );
592             i_pen_x += delta.x >> 6;
593
594         }
595         p_line->p_glyph_pos[ i ].x = i_pen_x;
596         p_line->p_glyph_pos[ i ].y = i_pen_y;
597         i_error = FT_Load_Glyph( face, i_glyph_index, FT_LOAD_DEFAULT );
598         if ( i_error )
599         {
600             msg_Err( p_vout, "FT_Load_Glyph returned %d", i_error );
601             goto error;
602         }
603         i_error = FT_Get_Glyph( glyph, &tmp_glyph );
604         if ( i_error )
605         {
606             msg_Err( p_vout, "FT_Get_Glyph returned %d", i_error );
607             goto error;
608         }
609         FT_Glyph_Get_CBox( tmp_glyph, ft_glyph_bbox_pixels, &glyph_size );
610         i_error = FT_Glyph_To_Bitmap( &tmp_glyph, ft_render_mode_normal,
611                                       NULL, 1 );
612         if ( i_error ) continue;
613         p_line->pp_glyphs[ i ] = (FT_BitmapGlyph)tmp_glyph;
614
615         /* Do rest */
616         line.xMax = p_line->p_glyph_pos[i].x + glyph_size.xMax - glyph_size.xMin;
617         line.yMax = __MAX( line.yMax, glyph_size.yMax );
618         line.yMin = __MIN( line.yMin, glyph_size.yMin );
619
620         i_previous = i_glyph_index;
621         i_pen_x += glyph->advance.x >> 6;
622         i++;
623     }
624     p_line->i_width = line.xMax;
625     p_line->i_height = face->size->metrics.height >> 6;
626     p_line->pp_glyphs[ i ] = NULL;
627     result.x = __MAX( result.x, line.xMax );
628     result.y += line.yMax - line.yMin;
629     p_string->i_height = result.y;
630     p_string->i_width = result.x;
631     msg_Dbg( p_vout, "string height is %d, width is %d",
632              p_string->i_height, p_string->i_width );
633     msg_Dbg( p_vout, "adding string \"%s\" at (%d,%d) start_date "I64Fd
634              " end_date" I64Fd, p_string->psz_text, p_string->i_x_margin,
635              p_string->i_y_margin, i_start, i_stop );
636     vout_DisplaySubPicture( p_vout, p_subpic );
637     return VLC_SUCCESS;
638
639 #undef face
640 #undef glyph
641
642  error:
643     FreeString( p_subpic );
644     vout_DestroySubPicture( p_vout, p_subpic );
645     return VLC_EGENERIC;
646 }
647
648 static void FreeString( subpicture_t *p_subpic )
649 {
650     unsigned int i;
651     subpicture_sys_t *p_string = p_subpic->p_sys;
652     line_desc_t *p_line, *p_next;
653
654     if( p_subpic->p_sys == NULL ) return;
655
656     for( p_line = p_string->p_lines; p_line != NULL; p_line = p_next )
657     {
658         p_next = p_line->p_next;
659         for( i = 0; p_line->pp_glyphs[ i ] != NULL; i++ )
660         {
661             FT_Done_Glyph( (FT_Glyph)p_line->pp_glyphs[ i ] );
662         }
663         free( p_line->pp_glyphs );
664         free( p_line->p_glyph_pos );
665         free( p_line );
666     }
667             
668     free( p_string->psz_text );
669     free( p_string );
670 }
671
672 /* convert one or more utf8 bytes into a unicode character */
673 static int GetUnicodeCharFromUTF8( byte_t **ppsz_utf8_string )
674 {
675     int i_remaining_bytes, i_char = 0;
676     if( ( **ppsz_utf8_string & 0xFC ) == 0xFC )
677     {
678         i_char = **ppsz_utf8_string & 1;
679         i_remaining_bytes = 5;
680     }
681     else if( ( **ppsz_utf8_string & 0xF8 ) == 0xF8 )
682     {
683         i_char = **ppsz_utf8_string & 3;
684         i_remaining_bytes = 4;
685     }
686     else if( ( **ppsz_utf8_string & 0xF0 ) == 0xF0 )
687     {
688         i_char = **ppsz_utf8_string & 7;
689         i_remaining_bytes = 3;
690     }
691     else if( ( **ppsz_utf8_string & 0xE0 ) == 0xE0 )
692     {
693         i_char = **ppsz_utf8_string & 15;
694         i_remaining_bytes = 2;
695     }
696     else if( ( **ppsz_utf8_string & 0xC0 ) == 0xC0 )
697     {
698         i_char = **ppsz_utf8_string & 31;
699         i_remaining_bytes = 1;
700     }
701     else
702     {
703         i_char = **ppsz_utf8_string;
704         i_remaining_bytes = 0;
705     }
706     while( i_remaining_bytes )
707     {
708         (*ppsz_utf8_string)++;
709         i_remaining_bytes--;
710         i_char = ( i_char << 6 ) + ( **ppsz_utf8_string & 0x3F );
711     }
712     (*ppsz_utf8_string)++;
713     return i_char;
714 }
715
716 static line_desc_t *NewLine( byte_t *psz_string )
717 {
718     int i_count;
719     line_desc_t *p_line = malloc( sizeof(line_desc_t) );
720     if( !p_line )
721     {
722         return NULL;
723     }
724     p_line->i_height = 0;
725     p_line->i_width = 0;
726     p_line->p_next = NULL;
727
728     /* We don't use CountUtf8Characters() here because we are not acutally
729      * sure the string is utf8. Better be safe than sorry. */
730     i_count = strlen( psz_string );
731
732     p_line->pp_glyphs = malloc( sizeof(FT_BitmapGlyph)
733                                 * ( i_count + 1 ) );
734     if( p_line->pp_glyphs == NULL )
735     {
736         free( p_line );
737         return NULL;
738     }
739     p_line->p_glyph_pos = malloc( sizeof( FT_Vector )
740                                   * i_count + 1 );
741     if( p_line->p_glyph_pos == NULL )
742     {
743         free( p_line->pp_glyphs );
744         free( p_line );
745         return NULL;
746     }
747
748     return p_line;
749 }