1 /*****************************************************************************
2 * freetype.c : Put text on the video, using freetype2
3 *****************************************************************************
4 * Copyright (C) 2002, 2003 VideoLAN
7 * Authors: Sigmund Augdal <sigmunau@idi.ntnu.no>
8 * Gildas Bazin <gbazin@videolan.org>
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.
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.
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 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
28 #include <stdlib.h> /* malloc(), free() */
31 #ifdef HAVE_LINUX_LIMITS_H
32 # include <linux/limits.h>
38 #include "vlc_block.h"
39 #include "vlc_filter.h"
48 #include FT_FREETYPE_H
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 */
58 #define DEFAULT_FONT "/usr/share/fonts/truetype/freefont/FreeSerifBold.ttf"
61 #if defined(HAVE_FRIBIDI)
62 #include <fribidi/fribidi.h>
65 typedef struct line_desc_t line_desc_t;
67 /*****************************************************************************
69 *****************************************************************************/
70 static int Create ( vlc_object_t * );
71 static void Destroy( vlc_object_t * );
73 static subpicture_t *RenderText( filter_t *, block_t * );
74 static line_desc_t *NewLine( byte_t * );
76 /*****************************************************************************
78 *****************************************************************************/
79 #define FONT_TEXT N_("Font")
80 #define FONT_LONGTEXT N_("Font filename")
81 #define FONTSIZE_TEXT N_("Font size in pixels")
82 #define FONTSIZE_LONGTEXT N_("The size of the fonts used by the osd module. " \
83 "If set to something different than 0 this option will override the " \
84 "relative font size " )
85 #define FONTSIZER_TEXT N_("Font size")
86 #define FONTSIZER_LONGTEXT N_("The size of the fonts used by the osd module" )
88 static int pi_sizes[] = { 20, 18, 16, 12, 6 };
89 static char *ppsz_sizes_text[] = { N_("Smaller"), N_("Small"), N_("Normal"),
90 N_("Large"), N_("Larger") };
93 set_description( _("freetype2 font renderer") );
94 set_category( CAT_VIDEO );
95 set_subcategory( SUBCAT_VIDEO_TEXT );
97 add_file( "freetype-font", DEFAULT_FONT, NULL, FONT_TEXT, FONT_LONGTEXT,
99 add_integer( "freetype-fontsize", 0, NULL, FONTSIZE_TEXT,
100 FONTSIZE_LONGTEXT, VLC_TRUE );
101 add_integer( "freetype-rel-fontsize", 16, NULL, FONTSIZER_TEXT,
102 FONTSIZER_LONGTEXT, VLC_FALSE );
103 change_integer_list( pi_sizes, ppsz_sizes_text, 0 );
105 set_capability( "text renderer", 100 );
106 add_shortcut( "text" );
107 set_callbacks( Create, Destroy );
111 * Private data in a subpicture. Describes a string.
113 typedef struct subpicture_data_t
117 /** The string associated with this subpicture */
119 line_desc_t *p_lines;
125 /** NULL-terminated list of glyphs making the string */
126 FT_BitmapGlyph *pp_glyphs;
127 /** list of relative positions for the glyphs */
128 FT_Vector *p_glyph_pos;
134 static void Render ( filter_t *, subpicture_t *, subpicture_data_t * );
135 static void FreeString( subpicture_data_t * );
136 static void FreeLine( line_desc_t * );
138 /*****************************************************************************
139 * filter_sys_t: freetype local data
140 *****************************************************************************
141 * This structure is part of the video output thread descriptor.
142 * It describes the freetype specific properties of an output thread.
143 *****************************************************************************/
146 FT_Library p_library; /* handle to library */
147 FT_Face p_face; /* handle to face object */
148 vlc_bool_t i_use_kerning;
149 uint8_t pi_gamma[256];
152 /*****************************************************************************
153 * Create: allocates osd-text video thread output method
154 *****************************************************************************
155 * This function allocates and initializes a Clone vout method.
156 *****************************************************************************/
157 static int Create( vlc_object_t *p_this )
159 filter_t *p_filter = (filter_t *)p_this;
161 char *psz_fontfile = NULL;
166 /* Allocate structure */
167 p_sys = malloc( sizeof( filter_sys_t ) );
170 msg_Err( p_filter, "out of memory" );
174 p_sys->p_library = 0;
176 for( i = 0; i < 256; i++ )
178 p_sys->pi_gamma[i] = (uint8_t)( pow( (double)i * 255.0f, 0.5f ) );
181 var_Create( p_filter, "freetype-font",
182 VLC_VAR_STRING | VLC_VAR_DOINHERIT );
183 var_Create( p_filter, "freetype-fontsize",
184 VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
185 var_Create( p_filter, "freetype-rel-fontsize",
186 VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
188 /* Look what method was requested */
189 var_Get( p_filter, "freetype-font", &val );
190 psz_fontfile = val.psz_string;
191 if( !psz_fontfile || !*psz_fontfile )
193 if( psz_fontfile ) free( psz_fontfile );
194 psz_fontfile = (char *)malloc( PATH_MAX + 1 );
196 GetWindowsDirectory( psz_fontfile, PATH_MAX + 1 );
197 strcat( psz_fontfile, "\\fonts\\arial.ttf" );
199 strcpy( psz_fontfile, DEFAULT_FONT );
201 msg_Err( p_filter, "user didn't specify a font" );
206 i_error = FT_Init_FreeType( &p_sys->p_library );
209 msg_Err( p_filter, "couldn't initialize freetype" );
213 i_error = FT_New_Face( p_sys->p_library, psz_fontfile ? psz_fontfile : "",
215 if( i_error == FT_Err_Unknown_File_Format )
217 msg_Err( p_filter, "file %s have unknown format", psz_fontfile );
222 msg_Err( p_filter, "failed to load font file %s", psz_fontfile );
226 i_error = FT_Select_Charmap( p_sys->p_face, ft_encoding_unicode );
229 msg_Err( p_filter, "Font has no unicode translation table" );
233 p_sys->i_use_kerning = FT_HAS_KERNING( p_sys->p_face );
235 var_Get( p_filter, "freetype-fontsize", &val );
238 i_fontsize = val.i_int;
242 var_Get( p_filter, "freetype-rel-fontsize", &val );
243 i_fontsize = (int)p_filter->fmt_out.video.i_height / val.i_int;
245 if( i_fontsize <= 0 )
247 msg_Warn( p_filter, "Invalid fontsize, using 12" );
250 msg_Dbg( p_filter, "Using fontsize: %i", i_fontsize);
252 i_error = FT_Set_Pixel_Sizes( p_sys->p_face, 0, i_fontsize );
255 msg_Err( p_filter, "couldn't set font size to %d", i_fontsize );
259 if( psz_fontfile ) free( psz_fontfile );
260 p_filter->pf_render_string = RenderText;
261 p_filter->p_sys = p_sys;
265 if( p_sys->p_face ) FT_Done_Face( p_sys->p_face );
266 if( p_sys->p_library ) FT_Done_FreeType( p_sys->p_library );
267 if( psz_fontfile ) free( psz_fontfile );
272 /*****************************************************************************
273 * Destroy: destroy Clone video thread output method
274 *****************************************************************************
275 * Clean up all data and library connections
276 *****************************************************************************/
277 static void Destroy( vlc_object_t *p_this )
279 filter_t *p_filter = (filter_t *)p_this;
280 filter_sys_t *p_sys = p_filter->p_sys;
281 FT_Done_Face( p_sys->p_face );
282 FT_Done_FreeType( p_sys->p_library );
286 /*****************************************************************************
287 * Render: place string in picture
288 *****************************************************************************
289 * This function merges the previously rendered freetype glyphs into a picture
290 *****************************************************************************/
291 static void Render( filter_t *p_filter, subpicture_t *p_spu,
292 subpicture_data_t *p_string )
294 filter_sys_t *p_sys = p_filter->p_sys;
296 uint8_t *p_y, *p_u, *p_v, *p_a;
298 int i, x, y, i_pitch;
300 /* Create a new subpicture region */
301 memset( &fmt, 0, sizeof(video_format_t) );
302 fmt.i_chroma = VLC_FOURCC('Y','U','V','A');
303 fmt.i_aspect = VOUT_ASPECT_FACTOR;
304 fmt.i_width = fmt.i_visible_width = p_string->i_width + 2;
305 fmt.i_height = fmt.i_visible_height = p_string->i_height + 2;
306 fmt.i_x_offset = fmt.i_y_offset = 0;
307 p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
308 if( !p_spu->p_region )
310 msg_Err( p_filter, "cannot allocate SPU region" );
314 p_spu->p_region->i_x = p_spu->p_region->i_y = 0;
315 p_y = p_spu->p_region->picture.Y_PIXELS;
316 p_u = p_spu->p_region->picture.U_PIXELS;
317 p_v = p_spu->p_region->picture.V_PIXELS;
318 p_a = p_spu->p_region->picture.A_PIXELS;
319 i_pitch = p_spu->p_region->picture.Y_PITCH;
321 /* Initialize the region pixels (only the alpha will be changed later) */
322 memset( p_y, 0x00, i_pitch * p_spu->p_region->fmt.i_height );
323 memset( p_u, 0x80, i_pitch * p_spu->p_region->fmt.i_height );
324 memset( p_v, 0x80, i_pitch * p_spu->p_region->fmt.i_height );
325 memset( p_a, 0x00, i_pitch * p_spu->p_region->fmt.i_height );
327 #define pi_gamma p_sys->pi_gamma
329 for( p_line = p_string->p_lines; p_line != NULL; p_line = p_line->p_next )
331 int i_glyph_tmax = 0;
332 int i_bitmap_offset, i_offset;
333 for( i = 0; p_line->pp_glyphs[i] != NULL; i++ )
335 FT_BitmapGlyph p_glyph = p_line->pp_glyphs[ i ];
336 i_glyph_tmax = __MAX( i_glyph_tmax, p_glyph->top );
339 for( i = 0; p_line->pp_glyphs[i] != NULL; i++ )
341 FT_BitmapGlyph p_glyph = p_line->pp_glyphs[ i ];
343 i_offset = ( p_line->p_glyph_pos[ i ].y +
344 i_glyph_tmax - p_glyph->top + 1 ) *
345 i_pitch + p_line->p_glyph_pos[ i ].x + p_glyph->left + 1;
347 for( y = 0, i_bitmap_offset = 0; y < p_glyph->bitmap.rows; y++ )
349 for( x = 0; x < p_glyph->bitmap.width; x++, i_bitmap_offset++ )
351 if( !pi_gamma[p_glyph->bitmap.buffer[i_bitmap_offset]] )
355 p_a[i_offset + x] = ((uint16_t)p_a[i_offset + x] +
356 pi_gamma[p_glyph->bitmap.buffer[i_bitmap_offset]])/2;
357 i_offset += i_pitch; x--;
358 p_a[i_offset + x] = ((uint16_t)p_a[i_offset + x] +
359 pi_gamma[p_glyph->bitmap.buffer[i_bitmap_offset]])/2;
361 p_a[i_offset + x] = ((uint16_t)p_a[i_offset + x] +
362 pi_gamma[p_glyph->bitmap.buffer[i_bitmap_offset]])/2;
363 i_offset += i_pitch; x--;
364 p_a[i_offset + x] = ((uint16_t)p_a[i_offset + x] +
365 pi_gamma[p_glyph->bitmap.buffer[i_bitmap_offset]])/2;
371 i_offset = ( p_line->p_glyph_pos[ i ].y +
372 i_glyph_tmax - p_glyph->top + 1 ) *
373 i_pitch + p_line->p_glyph_pos[ i ].x + p_glyph->left + 1;
375 for( y = 0, i_bitmap_offset = 0; y < p_glyph->bitmap.rows; y++ )
377 for( x = 0; x < p_glyph->bitmap.width; x++, i_bitmap_offset++ )
380 pi_gamma[p_glyph->bitmap.buffer[i_bitmap_offset]];
391 * This function receives a string and creates a subpicture for it. It
392 * also calculates the size needed for this string, and renders the
393 * needed glyphs into memory. It is used as pf_add_string callback in
394 * the vout method by this module
396 static subpicture_t *RenderText( filter_t *p_filter, block_t *p_block )
398 filter_sys_t *p_sys = p_filter->p_sys;
399 subpicture_t *p_subpic = 0;
400 subpicture_data_t *p_string = 0;
401 line_desc_t *p_line = 0, *p_next = 0, *p_prev = 0;
402 int i, i_pen_y, i_pen_x, i_error, i_glyph_index, i_previous;
403 uint32_t *psz_unicode, *psz_unicode_orig = 0, i_char, *psz_line_start;
406 vlc_iconv_t iconv_handle = (vlc_iconv_t)(-1);
414 if( !p_block ) return NULL;
415 psz_string = p_block->p_buffer;
416 if( !psz_string || !*psz_string ) goto error;
425 /* Create and initialize a subpicture */
426 p_subpic = p_filter->pf_sub_buffer_new( p_filter );
427 if( !p_subpic ) goto error;
429 p_subpic->i_start = p_block->i_pts;
430 p_subpic->i_stop = p_block->i_pts + p_block->i_length;
431 p_subpic->b_ephemer = (p_block->i_length == 0);
432 p_subpic->b_absolute = VLC_FALSE;
434 /* Create and initialize private data for the subpicture */
435 p_string = malloc( sizeof(subpicture_data_t) );
438 msg_Err( p_filter, "out of memory" );
441 p_string->p_lines = 0;
442 p_string->psz_text = strdup( psz_string );
444 psz_unicode = psz_unicode_orig =
445 malloc( ( strlen(psz_string) + 1 ) * sizeof(uint32_t) );
446 if( psz_unicode == NULL )
448 msg_Err( p_filter, "out of memory" );
451 #if defined(WORDS_BIGENDIAN)
452 iconv_handle = vlc_iconv_open( "UCS-4BE", "UTF-8" );
454 iconv_handle = vlc_iconv_open( "UCS-4LE", "UTF-8" );
456 if( iconv_handle == (vlc_iconv_t)-1 )
458 msg_Warn( p_filter, "unable to do convertion" );
463 char *p_in_buffer, *p_out_buffer;
464 size_t i_in_bytes, i_out_bytes, i_out_bytes_left, i_ret;
465 i_in_bytes = strlen( psz_string );
466 i_out_bytes = i_in_bytes * sizeof( uint32_t );
467 i_out_bytes_left = i_out_bytes;
468 p_in_buffer = psz_string;
469 p_out_buffer = (char *)psz_unicode;
470 i_ret = vlc_iconv( iconv_handle, &p_in_buffer, &i_in_bytes,
471 &p_out_buffer, &i_out_bytes_left );
473 vlc_iconv_close( iconv_handle );
477 msg_Warn( p_filter, "failed to convert string to unicode (%s), "
478 "bytes left %d", strerror(errno), i_in_bytes );
481 *(uint32_t*)p_out_buffer = 0;
482 i_string_length = (i_out_bytes - i_out_bytes_left) / sizeof(uint32_t);
485 #if defined(HAVE_FRIBIDI)
487 uint32_t *p_fribidi_string;
488 FriBidiCharType base_dir = FRIBIDI_TYPE_ON;
489 p_fribidi_string = malloc( (i_string_length + 1) * sizeof(uint32_t) );
490 fribidi_log2vis( (FriBidiChar*)psz_unicode, i_string_length,
491 &base_dir, (FriBidiChar*)p_fribidi_string, 0, 0, 0 );
492 free( psz_unicode_orig );
493 psz_unicode = psz_unicode_orig = p_fribidi_string;
494 p_fribidi_string[ i_string_length ] = 0;
498 /* Calculate relative glyph positions and a bounding box for the
500 p_line = NewLine( psz_string );
503 msg_Err( p_filter, "out of memory" );
506 p_string->p_lines = p_line;
511 psz_line_start = psz_unicode;
513 #define face p_sys->p_face
514 #define glyph face->glyph
516 while( *psz_unicode )
518 i_char = *psz_unicode++;
519 if( i_char == '\r' ) /* ignore CR chars wherever they may be */
526 psz_line_start = psz_unicode;
527 p_next = NewLine( psz_string );
530 msg_Err( p_filter, "out of memory" );
533 p_line->p_next = p_next;
534 p_line->i_width = line.xMax;
535 p_line->i_height = face->size->metrics.height >> 6;
536 p_line->pp_glyphs[ i ] = NULL;
539 result.x = __MAX( result.x, line.xMax );
540 result.y += face->size->metrics.height >> 6;
547 i_pen_y += face->size->metrics.height >> 6;
549 msg_Dbg( p_filter, "Creating new line, i is %d", i );
555 i_glyph_index = FT_Get_Char_Index( face, i_char );
556 if( p_sys->i_use_kerning && i_glyph_index
560 FT_Get_Kerning( face, i_previous, i_glyph_index,
561 ft_kerning_default, &delta );
562 i_pen_x += delta.x >> 6;
565 p_line->p_glyph_pos[ i ].x = i_pen_x;
566 p_line->p_glyph_pos[ i ].y = i_pen_y;
567 i_error = FT_Load_Glyph( face, i_glyph_index, FT_LOAD_DEFAULT );
570 msg_Err( p_filter, "FT_Load_Glyph returned %d", i_error );
573 i_error = FT_Get_Glyph( glyph, &tmp_glyph );
576 msg_Err( p_filter, "FT_Get_Glyph returned %d", i_error );
579 FT_Glyph_Get_CBox( tmp_glyph, ft_glyph_bbox_pixels, &glyph_size );
580 i_error = FT_Glyph_To_Bitmap( &tmp_glyph, ft_render_mode_normal,
582 if( i_error ) continue;
583 p_line->pp_glyphs[ i ] = (FT_BitmapGlyph)tmp_glyph;
586 line.xMax = p_line->p_glyph_pos[i].x + glyph_size.xMax - glyph_size.xMin + ((FT_BitmapGlyph)tmp_glyph)->left;
587 if( line.xMax > p_filter->fmt_out.video.i_visible_width - 20 )
589 p_line->pp_glyphs[ i ] = NULL;
591 p_line = NewLine( psz_string );
594 p_prev->p_next = p_line;
598 p_string->p_lines = p_line;
600 while( psz_unicode > psz_line_start && *psz_unicode != ' ' )
604 if( psz_unicode == psz_line_start )
606 msg_Warn( p_filter, "unbreakable string" );
614 psz_unicode = psz_line_start;
624 line.yMax = __MAX( line.yMax, glyph_size.yMax );
625 line.yMin = __MIN( line.yMin, glyph_size.yMin );
627 i_previous = i_glyph_index;
628 i_pen_x += glyph->advance.x >> 6;
632 p_line->i_width = line.xMax;
633 p_line->i_height = face->size->metrics.height >> 6;
634 p_line->pp_glyphs[ i ] = NULL;
635 result.x = __MAX( result.x, line.xMax );
636 result.y += line.yMax - line.yMin;
637 p_string->i_height = result.y;
638 p_string->i_width = result.x;
643 Render( p_filter, p_subpic, p_string );
644 FreeString( p_string );
645 block_Release( p_block );
646 if( psz_unicode_orig ) free( psz_unicode_orig );
650 FreeString( p_string );
651 if( p_subpic ) p_filter->pf_sub_buffer_del( p_filter, p_subpic );
652 block_Release( p_block );
653 if( psz_unicode_orig ) free( psz_unicode_orig );
657 static void FreeLine( line_desc_t *p_line )
660 for( i = 0; p_line->pp_glyphs[ i ] != NULL; i++ )
662 FT_Done_Glyph( (FT_Glyph)p_line->pp_glyphs[ i ] );
664 free( p_line->pp_glyphs );
665 free( p_line->p_glyph_pos );
669 static void FreeString( subpicture_data_t *p_string )
671 line_desc_t *p_line, *p_next;
673 if( !p_string ) return;
675 for( p_line = p_string->p_lines; p_line != NULL; p_line = p_next )
677 p_next = p_line->p_next;
681 free( p_string->psz_text );
685 static line_desc_t *NewLine( byte_t *psz_string )
688 line_desc_t *p_line = malloc( sizeof(line_desc_t) );
693 p_line->i_height = 0;
695 p_line->p_next = NULL;
697 /* We don't use CountUtf8Characters() here because we are not acutally
698 * sure the string is utf8. Better be safe than sorry. */
699 i_count = strlen( psz_string );
701 p_line->pp_glyphs = malloc( sizeof(FT_BitmapGlyph)
703 if( p_line->pp_glyphs == NULL )
708 p_line->pp_glyphs[0] = NULL;
710 p_line->p_glyph_pos = malloc( sizeof( FT_Vector )
712 if( p_line->p_glyph_pos == NULL )
714 free( p_line->pp_glyphs );