git.sesse.net Git - vlc/blob - modules/misc/freetype.c

   1 /*****************************************************************************
   2  * freetype.c : Put text on the video, using freetype2
   3  *****************************************************************************
   4  * Copyright (C) 2002 - 2005 VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Sigmund Augdal <sigmunau@idi.ntnu.no>
   8  *          Gildas Bazin <gbazin@videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28 #include <stdlib.h>                                      /* malloc(), free() */
  29 #include <string.h>
  30
  31 #ifdef HAVE_LINUX_LIMITS_H
  32 #   include <linux/limits.h>
  33 #endif
  34
  35 #include <vlc/vlc.h>
  36 #include <vlc/vout.h>
  37 #include "osd.h"
  38 #include "vlc_block.h"
  39 #include "vlc_filter.h"
  40
  41 #include <math.h>
  42
  43 #ifdef HAVE_ERRNO_H
  44 #   include <errno.h>
  45 #endif
  46
  47 #include <ft2build.h>
  48 #include FT_FREETYPE_H
  49 #include FT_GLYPH_H
  50
  51 #ifdef SYS_DARWIN
  52 #define DEFAULT_FONT "/System/Library/Fonts/LucidaGrande.dfont"
  53 #elif defined( SYS_BEOS )
  54 #define DEFAULT_FONT "/boot/beos/etc/fonts/ttfonts/Swiss721.ttf"
  55 #elif defined( WIN32 )
  56 #define DEFAULT_FONT "" /* Default font found at run-time */
  57 #else
  58 #define DEFAULT_FONT "/usr/share/fonts/truetype/freefont/FreeSerifBold.ttf"
  59 #endif
  60
  61 #if defined(HAVE_FRIBIDI)
  62 #include <fribidi/fribidi.h>
  63 #endif
  64
  65 typedef struct line_desc_t line_desc_t;
  66
  67 /*****************************************************************************
  68  * Local prototypes
  69  *****************************************************************************/
  70 static int  Create ( vlc_object_t * );
  71 static void Destroy( vlc_object_t * );
  72
  73 /* The RenderText call maps to pf_render_string, defined in vlc_filter.h */
  74 static subpicture_region_t *RenderText( filter_t *, subpicture_t *, subpicture_region_t* );//block_t *, int, int, int );
  75 static line_desc_t *NewLine( byte_t * );
  76
  77 /*****************************************************************************
  78  * Module descriptor
  79  *****************************************************************************/
  80 #define FONT_TEXT N_("Font")
  81 #define FONT_LONGTEXT N_("Font filename")
  82 #define FONTSIZE_TEXT N_("Font size in pixels")
  83 #define FONTSIZE_LONGTEXT N_("The size of the fonts used by the osd module. " \
  84     "If set to something different than 0 this option will override the " \
  85     "relative font size " )
  86 #define OPACITY_TEXT N_("Opacity, 0..255")
  87 #define OPACITY_LONGTEXT N_("The opacity (inverse of transparency) of overlay text. " \
  88     "1 = transparent, 255 = totally opaque. " )
  89 #define COLOR_TEXT N_("Text Default Color")
  90 #define COLOR_LONGTEXT N_("The color of overlay text. 1 byte for each color, hexadecimal." \
  91     "#000000 = all colors off, 0xFF0000 = just Red, 0xFFFFFF = all color on [White]" )
  92 #define FONTSIZER_TEXT N_("Font size")
  93 #define FONTSIZER_LONGTEXT N_("The size of the fonts used by the osd module" )
  94
  95 static int   pi_sizes[] = { 20, 18, 16, 12, 6 };
  96 static char *ppsz_sizes_text[] = { N_("Smaller"), N_("Small"), N_("Normal"),
  97                                    N_("Large"), N_("Larger") };
  98 static int pi_color_values[] = { 0x00000000, 0x00808080, 0x00C0C0C0, 0x00FFFFFF, 0x00800000,
  99                                0x00FF0000, 0x00FF00FF, 0x00FFFF00, 0x00808000, 0x00008000, 0x00008080,
 100                                0x0000FF00, 0x00800080, 0x00000080, 0x000000FF, 0x0000FFFF};
 101 static char *ppsz_color_descriptions[] = { N_("Black"), N_("Gray"), N_("Silver"), N_("White"),
 102                                  N_("Maroon"), N_("Red"), N_("Fuchsia"), N_("Yellow"),
 103                                  N_("Olive"), N_("Green"), N_("Teal"), N_("Lime"), N_("Purple"),
 104                                  N_("Navy"), N_("Blue"), N_("Aqua") };
 105
 106 vlc_module_begin();
 107     set_shortname( _("Freetype"));
 108     set_description( _("Freetype2 font renderer") );
 109     set_category( CAT_VIDEO );
 110     set_subcategory( SUBCAT_VIDEO_TEXT );
 111
 112     add_file( "freetype-font", DEFAULT_FONT, NULL, FONT_TEXT, FONT_LONGTEXT,
 113               VLC_FALSE );
 114     add_integer( "freetype-fontsize", 0, NULL, FONTSIZE_TEXT,
 115                  FONTSIZE_LONGTEXT, VLC_TRUE );
 116     /* opacity valid on 0..255, with default 255 = fully opaque */
 117     add_integer_with_range( "freetype-opacity", 255, 0, 255, NULL,
 118         OPACITY_TEXT, OPACITY_LONGTEXT, VLC_FALSE );
 119     /* hook to the color values list, with default 0x00ffffff = white */
 120     add_integer( "freetype-color", 0x00FFFFFF, NULL, COLOR_TEXT, COLOR_LONGTEXT, VLC_TRUE );
 121         change_integer_list( pi_color_values, ppsz_color_descriptions, 0 );
 122
 123     add_integer( "freetype-rel-fontsize", 16, NULL, FONTSIZER_TEXT,
 124                  FONTSIZER_LONGTEXT, VLC_FALSE );
 125         change_integer_list( pi_sizes, ppsz_sizes_text, 0 );
 126
 127     set_capability( "text renderer", 100 );
 128     add_shortcut( "text" );
 129     set_callbacks( Create, Destroy );
 130 vlc_module_end();
 131
 132 /**
 133  * Private data in a subpicture. Describes a string.
 134  */
 135 typedef struct subpicture_data_t
 136 {
 137     int            i_width;
 138     int            i_height;
 139     /** The string associated with this subpicture */
 140     byte_t        *psz_text;
 141     line_desc_t   *p_lines;
 142
 143 } subpicture_data_t;
 144
 145 struct line_desc_t
 146 {
 147     /** NULL-terminated list of glyphs making the string */
 148     FT_BitmapGlyph *pp_glyphs;
 149     /** list of relative positions for the glyphs */
 150     FT_Vector      *p_glyph_pos;
 151     int             i_height;
 152     int             i_width;
 153     line_desc_t    *p_next;
 154 };
 155
 156 static subpicture_region_t *Render    ( filter_t *, subpicture_t *, subpicture_data_t *, uint8_t,
 157                         int, int, int );
 158 static void FreeString( subpicture_data_t * );
 159 static void FreeLine( line_desc_t * );
 160
 161 /*****************************************************************************
 162  * filter_sys_t: freetype local data
 163  *****************************************************************************
 164  * This structure is part of the video output thread descriptor.
 165  * It describes the freetype specific properties of an output thread.
 166  *****************************************************************************/
 167 struct filter_sys_t
 168 {
 169     FT_Library     p_library;   /* handle to library     */
 170     FT_Face        p_face;      /* handle to face object */
 171     vlc_bool_t     i_use_kerning;
 172     uint8_t        i_font_opacity; /* freetype-opacity */
 173     int            i_font_color;  /* freetype-color */
 174     int            i_red, i_blue, i_green; /* function vars to render */
 175     int            i_font_size;
 176     uint8_t        i_opacity; /*  function var to render */
 177     uint8_t        pi_gamma[256];
 178 };
 179
 180 /*****************************************************************************
 181  * Create: allocates osd-text video thread output method
 182  *****************************************************************************
 183  * This function allocates and initializes a Clone vout method.
 184  *****************************************************************************/
 185 static int Create( vlc_object_t *p_this )
 186 {
 187     filter_t *p_filter = (filter_t *)p_this;
 188     filter_sys_t *p_sys;
 189     char *psz_fontfile = NULL;
 190     int i, i_error;
 191     vlc_value_t val;
 192
 193     /* Allocate structure */
 194     p_sys = malloc( sizeof( filter_sys_t ) );
 195     if( !p_sys )
 196     {
 197         msg_Err( p_filter, "out of memory" );
 198         return VLC_ENOMEM;
 199     }
 200     p_sys->p_face = 0;
 201     p_sys->p_library = 0;
 202     p_sys->i_font_size = 0;
 203
 204     for( i = 0; i < 256; i++ )
 205     {
 206         p_sys->pi_gamma[i] = (uint8_t)( pow( (double)i * 255.0f, 0.5f ) );
 207     }
 208
 209     var_Create( p_filter, "freetype-font",
 210                 VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 211     var_Create( p_filter, "freetype-fontsize",
 212                 VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 213     var_Create( p_filter, "freetype-rel-fontsize",
 214                 VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 215     var_Create( p_filter, "freetype-opacity", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
 216     var_Get( p_filter, "freetype-opacity", &val );
 217     p_sys->i_font_opacity = __MAX( __MIN( val.i_int, 255 ), 0 );
 218     var_Create( p_filter, "freetype-color", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 219     var_Get( p_filter, "freetype-color", &val );
 220     if ( ( val.i_int > -1 ) && ( val.i_int < 0x01000000 ) )  /* valid range */
 221     {
 222             p_sys->i_font_color = val.i_int;
 223     }
 224     else msg_Warn(p_filter, "Invalid freetype color specified, using white [0xFFFFFF]");
 225
 226     /* Look what method was requested */
 227     var_Get( p_filter, "freetype-font", &val );
 228     psz_fontfile = val.psz_string;
 229     if( !psz_fontfile || !*psz_fontfile )
 230     {
 231         if( psz_fontfile ) free( psz_fontfile );
 232         psz_fontfile = (char *)malloc( PATH_MAX + 1 );
 233 #ifdef WIN32
 234         GetWindowsDirectory( psz_fontfile, PATH_MAX + 1 );
 235         strcat( psz_fontfile, "\\fonts\\arial.ttf" );
 236 #elif SYS_DARWIN
 237         strcpy( psz_fontfile, DEFAULT_FONT );
 238 #else
 239         msg_Err( p_filter, "user didn't specify a font" );
 240         goto error;
 241 #endif
 242     }
 243
 244     i_error = FT_Init_FreeType( &p_sys->p_library );
 245     if( i_error )
 246     {
 247         msg_Err( p_filter, "couldn't initialize freetype" );
 248         goto error;
 249     }
 250
 251     i_error = FT_New_Face( p_sys->p_library, psz_fontfile ? psz_fontfile : "",
 252                            0, &p_sys->p_face );
 253     if( i_error == FT_Err_Unknown_File_Format )
 254     {
 255         msg_Err( p_filter, "file %s have unknown format", psz_fontfile );
 256         goto error;
 257     }
 258     else if( i_error )
 259     {
 260         msg_Err( p_filter, "failed to load font file %s", psz_fontfile );
 261         goto error;
 262     }
 263
 264     i_error = FT_Select_Charmap( p_sys->p_face, ft_encoding_unicode );
 265     if( i_error )
 266     {
 267         msg_Err( p_filter, "Font has no unicode translation table" );
 268         goto error;
 269     }
 270
 271     p_sys->i_use_kerning = FT_HAS_KERNING( p_sys->p_face );
 272
 273
 274     var_Get( p_filter, "freetype-fontsize", &val );
 275     if( val.i_int )
 276     {
 277         p_sys->i_font_size = val.i_int;
 278     }
 279     else
 280     {
 281         var_Get( p_filter, "freetype-rel-fontsize", &val );
 282         p_sys->i_font_size = (int)p_filter->fmt_out.video.i_height / val.i_int;
 283     }
 284     if( p_sys->i_font_size <= 0 )
 285     {
 286         msg_Warn( p_filter, "Invalid fontsize, using 12" );
 287         p_sys->i_font_size = 12;
 288     }
 289     msg_Dbg( p_filter, "Using fontsize: %i", p_sys->i_font_size);
 290
 291     i_error = FT_Set_Pixel_Sizes( p_sys->p_face, 0, p_sys->i_font_size );
 292     if( i_error )
 293     {
 294         msg_Err( p_filter, "couldn't set font size to %d", p_sys->i_font_size );
 295         goto error;
 296     }
 297
 298     if( psz_fontfile ) free( psz_fontfile );
 299     p_filter->pf_render_string = RenderText;
 300     p_filter->p_sys = p_sys;
 301     return VLC_SUCCESS;
 302
 303  error:
 304     if( p_sys->p_face ) FT_Done_Face( p_sys->p_face );
 305     if( p_sys->p_library ) FT_Done_FreeType( p_sys->p_library );
 306     if( psz_fontfile ) free( psz_fontfile );
 307     free( p_sys );
 308     return VLC_EGENERIC;
 309 }
 310
 311 /*****************************************************************************
 312  * Destroy: destroy Clone video thread output method
 313  *****************************************************************************
 314  * Clean up all data and library connections
 315  *****************************************************************************/
 316 static void Destroy( vlc_object_t *p_this )
 317 {
 318     filter_t *p_filter = (filter_t *)p_this;
 319     filter_sys_t *p_sys = p_filter->p_sys;
 320
 321     FT_Done_Face( p_sys->p_face );
 322     FT_Done_FreeType( p_sys->p_library );
 323     free( p_sys );
 324 }
 325
 326 /*****************************************************************************
 327  * Render: place string in picture
 328  *****************************************************************************
 329  * This function merges the previously rendered freetype glyphs into a picture
 330  *****************************************************************************/
 331 static subpicture_region_t *Render( filter_t *p_filter, subpicture_t *p_spu,
 332                                     subpicture_data_t *p_string,
 333                                     uint8_t opacity,
 334                                     int red, int green, int blue)
 335 {
 336     filter_sys_t *p_sys = p_filter->p_sys;
 337     line_desc_t *p_line;
 338     uint8_t *p_y, *p_u, *p_v, *p_a;
 339     video_format_t fmt;
 340     int i, x, y, i_pitch;
 341     uint8_t i_y, i_u, i_v;  /* YUV values, derived from incoming RGB */
 342     subpicture_region_t *p_region;
 343
 344     /* calculate text color components: */
 345     i_y = (uint8_t) ( (  66 * red + 129 * green +  25 * blue + 128) >> 8) +  16;
 346     i_u = (uint8_t) ( ( -38 * red -  74 * green + 112 * blue + 128) >> 8) + 128;
 347     i_v = (uint8_t) ( ( 112 * red -  94 * green -  18 * blue + 128) >> 8) + 128;
 348
 349     /* Create a new subpicture region */
 350     memset( &fmt, 0, sizeof(video_format_t) );
 351     fmt.i_chroma = VLC_FOURCC('Y','U','V','A');
 352     fmt.i_aspect = VOUT_ASPECT_FACTOR;
 353     fmt.i_width = fmt.i_visible_width = p_string->i_width + 2;
 354     fmt.i_height = fmt.i_visible_height = p_string->i_height + 2;
 355     fmt.i_x_offset = fmt.i_y_offset = 0;
 356     p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
 357     if( !p_region )
 358     {
 359         msg_Err( p_filter, "cannot allocate SPU region" );
 360         return NULL;
 361     }
 362
 363     p_region->i_x = p_region->i_y = 0;
 364     p_y = p_region->picture.Y_PIXELS;
 365     p_u = p_region->picture.U_PIXELS;
 366     p_v = p_region->picture.V_PIXELS;
 367     p_a = p_region->picture.A_PIXELS;
 368     i_pitch = p_region->picture.Y_PITCH;
 369
 370     /* Initialize the region pixels */
 371     memset( p_y, 0x00, i_pitch * p_region->fmt.i_height );
 372     memset( p_u, 0x80, i_pitch * p_region->fmt.i_height );
 373     memset( p_v, 0x80, i_pitch * p_region->fmt.i_height );
 374     memset( p_a, 0x00, i_pitch * p_region->fmt.i_height );
 375
 376 #define pi_gamma p_sys->pi_gamma
 377
 378     for( p_line = p_string->p_lines; p_line != NULL; p_line = p_line->p_next )
 379     {
 380         int i_glyph_tmax = 0;
 381         int i_bitmap_offset, i_offset;
 382         for( i = 0; p_line->pp_glyphs[i] != NULL; i++ )
 383         {
 384             FT_BitmapGlyph p_glyph = p_line->pp_glyphs[ i ];
 385             i_glyph_tmax = __MAX( i_glyph_tmax, p_glyph->top );
 386         }
 387
 388         for( i = 0; p_line->pp_glyphs[i] != NULL; i++ )
 389         {
 390             FT_BitmapGlyph p_glyph = p_line->pp_glyphs[ i ];
 391
 392             i_offset = ( p_line->p_glyph_pos[ i ].y +
 393                 i_glyph_tmax - p_glyph->top + 1 ) *
 394                 i_pitch + p_line->p_glyph_pos[ i ].x + p_glyph->left + 1;
 395
 396             for( y = 0, i_bitmap_offset = 0; y < p_glyph->bitmap.rows; y++ )
 397             {
 398                 for( x = 0; x < p_glyph->bitmap.width; x++, i_bitmap_offset++ )
 399                 {
 400                     if( !pi_gamma[p_glyph->bitmap.buffer[i_bitmap_offset]] )
 401                         continue;
 402
 403                     i_offset -= i_pitch;
 404                     p_a[i_offset + x] = ((uint16_t)p_a[i_offset + x] +
 405                       pi_gamma[p_glyph->bitmap.buffer[i_bitmap_offset]])*opacity/512;
 406                     i_offset += i_pitch; x--;
 407                     p_a[i_offset + x] = ((uint16_t)p_a[i_offset + x] +
 408                       pi_gamma[p_glyph->bitmap.buffer[i_bitmap_offset]])*opacity/512;
 409                     x += 2;
 410                     p_a[i_offset + x] = ((uint16_t)p_a[i_offset + x] +
 411                       pi_gamma[p_glyph->bitmap.buffer[i_bitmap_offset]])*opacity/512;
 412                     i_offset += i_pitch; x--;
 413                     p_a[i_offset + x] = ((uint16_t)p_a[i_offset + x] +
 414                       pi_gamma[p_glyph->bitmap.buffer[i_bitmap_offset]])*opacity/512;
 415                     i_offset -= i_pitch;
 416                 }
 417                 i_offset += i_pitch;
 418             }
 419
 420             i_offset = ( p_line->p_glyph_pos[ i ].y +
 421                 i_glyph_tmax - p_glyph->top + 1 ) *
 422                 i_pitch + p_line->p_glyph_pos[ i ].x + p_glyph->left + 1;
 423
 424             for( y = 0, i_bitmap_offset = 0; y < p_glyph->bitmap.rows; y++ )
 425             {
 426                for( x = 0; x < p_glyph->bitmap.width; x++, i_bitmap_offset++ )
 427                {
 428                    p_y[i_offset + x] = i_y*opacity*pi_gamma[p_glyph->bitmap.buffer[i_bitmap_offset]]/(256*256);
 429                    p_u[i_offset + x] = i_u;
 430                    p_v[i_offset + x] = i_v;
 431                }
 432                i_offset += i_pitch;
 433             }
 434
 435 #undef pi_gamma
 436         }
 437     }
 438     return p_region;
 439 }
 440
 441 /**
 442  * This function receives a string and creates a subpicture for it. It
 443  * also calculates the size needed for this string, and renders the
 444  * needed glyphs into memory. It is used as pf_add_string callback in
 445  * the vout method by this module
 446  */
 447 static subpicture_region_t *RenderText( filter_t *p_filter,
 448                                         subpicture_t *p_subpic,
 449                                         subpicture_region_t *p_region )
 450 {
 451     filter_sys_t *p_sys = p_filter->p_sys;
 452     subpicture_data_t *p_string = 0;
 453     line_desc_t  *p_line = 0, *p_next = 0, *p_prev = 0;
 454     int i, i_pen_y, i_pen_x, i_error, i_glyph_index, i_previous;
 455     uint32_t *psz_unicode, *psz_unicode_orig = 0, i_char, *psz_line_start;
 456     int i_string_length;
 457     char *psz_string;
 458     vlc_iconv_t iconv_handle = (vlc_iconv_t)(-1);
 459     int i_font_color, i_font_opacity, i_font_size;
 460     subpicture_region_t *p_res;
 461
 462     FT_BBox line;
 463     FT_BBox glyph_size;
 464     FT_Vector result;
 465     FT_Glyph tmp_glyph;
 466
 467     /* Sanity check */
 468     if( !p_region ) return NULL;
 469     psz_string = p_region->psz_text;
 470     if( !psz_string || !*psz_string ) goto error;
 471     i_font_color   = p_region->i_font_color;
 472     i_font_opacity = p_region->i_font_opacity;
 473     i_font_size    = p_region->i_font_size;
 474
 475     result.x = 0;
 476     result.y = 0;
 477     line.xMin = 0;
 478     line.xMax = 0;
 479     line.yMin = 0;
 480     line.yMax = 0;
 481
 482     /* Create and initialize private data for the subpicture */
 483     p_string = malloc( sizeof(subpicture_data_t) );
 484     if( !p_string )
 485     {
 486         msg_Err( p_filter, "out of memory" );
 487         goto error;
 488     }
 489     p_string->p_lines = 0;
 490     p_string->psz_text = strdup( psz_string );
 491
 492     psz_unicode = psz_unicode_orig =
 493         malloc( ( strlen(psz_string) + 1 ) * sizeof(uint32_t) );
 494     if( psz_unicode == NULL )
 495     {
 496         msg_Err( p_filter, "out of memory" );
 497         goto error;
 498     }
 499 #if defined(WORDS_BIGENDIAN)
 500     iconv_handle = vlc_iconv_open( "UCS-4BE", "UTF-8" );
 501 #else
 502     iconv_handle = vlc_iconv_open( "UCS-4LE", "UTF-8" );
 503 #endif
 504     if( iconv_handle == (vlc_iconv_t)-1 )
 505     {
 506         msg_Warn( p_filter, "unable to do conversion" );
 507         goto error;
 508     }
 509
 510     /* Set up the glyphs for the desired font size.  By definition,
 511        p_sys->i_font_size is a valid value, else the initial Create would
 512        have failed. Using -1 as a flag to use the freetype-fontsize */
 513     if ( i_font_size < 0 )
 514     {
 515             FT_Set_Pixel_Sizes( p_sys->p_face, 0, p_sys->i_font_size );
 516     }
 517     else
 518     {
 519         i_error = FT_Set_Pixel_Sizes( p_sys->p_face, 0, i_font_size );
 520         if( i_error )
 521         {
 522             msg_Warn( p_filter, "Invalid font size to RenderText, using %d",
 523                       p_sys->i_font_size );
 524             FT_Set_Pixel_Sizes( p_sys->p_face, 0, p_sys->i_font_size );
 525         }
 526     }
 527
 528     {
 529         char *p_in_buffer, *p_out_buffer;
 530         size_t i_in_bytes, i_out_bytes, i_out_bytes_left, i_ret;
 531         i_in_bytes = strlen( psz_string );
 532         i_out_bytes = i_in_bytes * sizeof( uint32_t );
 533         i_out_bytes_left = i_out_bytes;
 534         p_in_buffer = psz_string;
 535         p_out_buffer = (char *)psz_unicode;
 536         i_ret = vlc_iconv( iconv_handle, &p_in_buffer, &i_in_bytes,
 537                            &p_out_buffer, &i_out_bytes_left );
 538
 539         vlc_iconv_close( iconv_handle );
 540
 541         if( i_in_bytes )
 542         {
 543             msg_Warn( p_filter, "failed to convert string to unicode (%s), "
 544                       "bytes left %d", strerror(errno), i_in_bytes );
 545             goto error;
 546         }
 547         *(uint32_t*)p_out_buffer = 0;
 548         i_string_length = (i_out_bytes - i_out_bytes_left) / sizeof(uint32_t);
 549     }
 550
 551 #if defined(HAVE_FRIBIDI)
 552     {
 553         uint32_t *p_fribidi_string;
 554         FriBidiCharType base_dir = FRIBIDI_TYPE_ON;
 555         p_fribidi_string = malloc( (i_string_length + 1) * sizeof(uint32_t) );
 556         fribidi_log2vis( (FriBidiChar*)psz_unicode, i_string_length,
 557                          &base_dir, (FriBidiChar*)p_fribidi_string, 0, 0, 0 );
 558         free( psz_unicode_orig );
 559         psz_unicode = psz_unicode_orig = p_fribidi_string;
 560         p_fribidi_string[ i_string_length ] = 0;
 561     }
 562 #endif
 563
 564     /* Calculate relative glyph positions and a bounding box for the
 565      * entire string */
 566     p_line = NewLine( psz_string );
 567     if( p_line == NULL )
 568     {
 569         msg_Err( p_filter, "out of memory" );
 570         goto error;
 571     }
 572     p_string->p_lines = p_line;
 573     i_pen_x = 0;
 574     i_pen_y = 0;
 575     i_previous = 0;
 576     i = 0;
 577     psz_line_start = psz_unicode;
 578
 579 #define face p_sys->p_face
 580 #define glyph face->glyph
 581
 582     while( *psz_unicode )
 583     {
 584         i_char = *psz_unicode++;
 585         if( i_char == '\r' ) /* ignore CR chars wherever they may be */
 586         {
 587             continue;
 588         }
 589
 590         if( i_char == '\n' )
 591         {
 592             psz_line_start = psz_unicode;
 593             p_next = NewLine( psz_string );
 594             if( p_next == NULL )
 595             {
 596                 msg_Err( p_filter, "out of memory" );
 597                 goto error;
 598             }
 599             p_line->p_next = p_next;
 600             p_line->i_width = line.xMax;
 601             p_line->i_height = face->size->metrics.height >> 6;
 602             p_line->pp_glyphs[ i ] = NULL;
 603             p_prev = p_line;
 604             p_line = p_next;
 605             result.x = __MAX( result.x, line.xMax );
 606             result.y += face->size->metrics.height >> 6;
 607             i_pen_x = 0;
 608             i_previous = 0;
 609             line.xMin = 0;
 610             line.xMax = 0;
 611             line.yMin = 0;
 612             line.yMax = 0;
 613             i_pen_y += face->size->metrics.height >> 6;
 614 #if 0
 615             msg_Dbg( p_filter, "Creating new line, i is %d", i );
 616 #endif
 617             i = 0;
 618             continue;
 619         }
 620
 621         i_glyph_index = FT_Get_Char_Index( face, i_char );
 622         if( p_sys->i_use_kerning && i_glyph_index
 623             && i_previous )
 624         {
 625             FT_Vector delta;
 626             FT_Get_Kerning( face, i_previous, i_glyph_index,
 627                             ft_kerning_default, &delta );
 628             i_pen_x += delta.x >> 6;
 629
 630         }
 631         p_line->p_glyph_pos[ i ].x = i_pen_x;
 632         p_line->p_glyph_pos[ i ].y = i_pen_y;
 633         i_error = FT_Load_Glyph( face, i_glyph_index, FT_LOAD_DEFAULT );
 634         if( i_error )
 635         {
 636             msg_Err( p_filter, "FT_Load_Glyph returned %d", i_error );
 637             goto error;
 638         }
 639         i_error = FT_Get_Glyph( glyph, &tmp_glyph );
 640         if( i_error )
 641         {
 642             msg_Err( p_filter, "FT_Get_Glyph returned %d", i_error );
 643             goto error;
 644         }
 645         FT_Glyph_Get_CBox( tmp_glyph, ft_glyph_bbox_pixels, &glyph_size );
 646         i_error = FT_Glyph_To_Bitmap( &tmp_glyph, ft_render_mode_normal,
 647                                       NULL, 1 );
 648         if( i_error ) continue;
 649         p_line->pp_glyphs[ i ] = (FT_BitmapGlyph)tmp_glyph;
 650
 651         /* Do rest */
 652         line.xMax = p_line->p_glyph_pos[i].x + glyph_size.xMax - glyph_size.xMin + ((FT_BitmapGlyph)tmp_glyph)->left;
 653         if( line.xMax > p_filter->fmt_out.video.i_visible_width - 20 )
 654         {
 655             p_line->pp_glyphs[ i ] = NULL;
 656             FreeLine( p_line );
 657             p_line = NewLine( psz_string );
 658             if( p_prev )
 659             {
 660                 p_prev->p_next = p_line;
 661             }
 662             else
 663             {
 664                 p_string->p_lines = p_line;
 665             }
 666             while( psz_unicode > psz_line_start && *psz_unicode != ' ' )
 667             {
 668                 psz_unicode--;
 669             }
 670             if( psz_unicode == psz_line_start )
 671             {
 672                 msg_Warn( p_filter, "unbreakable string" );
 673                 goto error;
 674             }
 675             else
 676             {
 677
 678                 *psz_unicode = '\n';
 679             }
 680             psz_unicode = psz_line_start;
 681             i_pen_x = 0;
 682             i_previous = 0;
 683             line.xMin = 0;
 684             line.xMax = 0;
 685             line.yMin = 0;
 686             line.yMax = 0;
 687             i = 0;
 688             continue;
 689         }
 690         line.yMax = __MAX( line.yMax, glyph_size.yMax );
 691         line.yMin = __MIN( line.yMin, glyph_size.yMin );
 692
 693         i_previous = i_glyph_index;
 694         i_pen_x += glyph->advance.x >> 6;
 695         i++;
 696     }
 697
 698     p_line->i_width = line.xMax;
 699     p_line->i_height = face->size->metrics.height >> 6;
 700     p_line->pp_glyphs[ i ] = NULL;
 701     result.x = __MAX( result.x, line.xMax );
 702     result.y += line.yMax - line.yMin;
 703     p_string->i_height = result.y;
 704     p_string->i_width = result.x;
 705
 706 #undef face
 707 #undef glyph
 708 /* check to see whether to use the default color/opacity, or another one: */
 709     if( i_font_color < 0 )
 710     {
 711         p_sys->i_blue  =   p_sys->i_font_color & 0x000000FF;
 712         p_sys->i_green = ( p_sys->i_font_color & 0x0000FF00 ) >>  8;
 713         p_sys->i_red   = ( p_sys->i_font_color & 0x00FF0000 ) >> 16;
 714     }
 715     else
 716     {
 717         p_sys->i_blue  =   i_font_color & 0x000000FF;
 718         p_sys->i_green = ( i_font_color & 0x0000FF00 ) >>  8;
 719         p_sys->i_red   = ( i_font_color & 0x00FF0000 ) >> 16;
 720     }
 721     if( i_font_opacity < 0 )
 722     {
 723         p_sys->i_opacity = p_sys->i_font_opacity;
 724     }
 725     else
 726     {
 727         p_sys->i_opacity = (uint8_t)( i_font_opacity & 0x000000FF );
 728     }
 729
 730     p_res = Render( p_filter, p_subpic, p_string, p_sys->i_opacity,
 731                     p_sys->i_red, p_sys->i_green, p_sys->i_blue );
 732     FreeString( p_string );
 733     if( psz_unicode_orig ) free( psz_unicode_orig );
 734     return p_res;
 735
 736  error:
 737     FreeString( p_string );
 738     if( p_subpic ) p_filter->pf_sub_buffer_del( p_filter, p_subpic );
 739     if( psz_unicode_orig ) free( psz_unicode_orig );
 740     return NULL;
 741 }
 742
 743 static void FreeLine( line_desc_t *p_line )
 744 {
 745     unsigned int i;
 746     for( i = 0; p_line->pp_glyphs[ i ] != NULL; i++ )
 747     {
 748         FT_Done_Glyph( (FT_Glyph)p_line->pp_glyphs[ i ] );
 749     }
 750     free( p_line->pp_glyphs );
 751     free( p_line->p_glyph_pos );
 752     free( p_line );
 753 }
 754
 755 static void FreeString( subpicture_data_t *p_string )
 756 {
 757     line_desc_t *p_line, *p_next;
 758
 759     if( !p_string ) return;
 760
 761     for( p_line = p_string->p_lines; p_line != NULL; p_line = p_next )
 762     {
 763         p_next = p_line->p_next;
 764         FreeLine( p_line );
 765     }
 766
 767     free( p_string->psz_text );
 768     free( p_string );
 769 }
 770
 771 static line_desc_t *NewLine( byte_t *psz_string )
 772 {
 773     int i_count;
 774     line_desc_t *p_line = malloc( sizeof(line_desc_t) );
 775     if( !p_line )
 776     {
 777         return NULL;
 778     }
 779     p_line->i_height = 0;
 780     p_line->i_width = 0;
 781     p_line->p_next = NULL;
 782
 783     /* We don't use CountUtf8Characters() here because we are not acutally
 784      * sure the string is utf8. Better be safe than sorry. */
 785     i_count = strlen( psz_string );
 786
 787     p_line->pp_glyphs = malloc( sizeof(FT_BitmapGlyph)
 788                                 * ( i_count + 1 ) );
 789     if( p_line->pp_glyphs == NULL )
 790     {
 791         free( p_line );
 792         return NULL;
 793     }
 794     p_line->pp_glyphs[0] = NULL;
 795
 796     p_line->p_glyph_pos = malloc( sizeof( FT_Vector )
 797                                   * i_count + 1 );
 798     if( p_line->p_glyph_pos == NULL )
 799     {
 800         free( p_line->pp_glyphs );
 801         free( p_line );
 802         return NULL;
 803     }
 804
 805     return p_line;
 806 }