Use proper linespacing
[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.2 2003/07/19 14:41:30 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 #define FT_RENDER_MODE_NORMAL 0 /* Why do we have to do that ? */
40
41 /*****************************************************************************
42  * Local prototypes
43  *****************************************************************************/
44 static int  Create    ( vlc_object_t * );
45 static void Destroy   ( vlc_object_t * );
46
47 static void Render    ( vout_thread_t *, picture_t *, 
48                         const subpicture_t * );
49 static int  AddText   ( vout_thread_t *, byte_t *, text_style_t *, int, 
50                         int, int, mtime_t, mtime_t );
51 static int GetUnicodeCharFromUTF8( byte_t ** );
52
53 /*****************************************************************************
54  * Module descriptor
55  *****************************************************************************/
56 #define FONT_TEXT N_("Font")
57 #define FONT_LONGTEXT N_("Filename of Font")
58 #define FONTSIZE_TEXT N_("Font size")
59 #define FONTSIZE_LONGTEXT N_("The size of the fonts used by the osd module" )
60
61 vlc_module_begin();
62     add_category_hint( N_("Fonts"), NULL, VLC_FALSE );
63     add_file( "freetype-font", "", NULL, FONT_TEXT, FONT_LONGTEXT, VLC_FALSE );
64     add_integer( "freetype-fontsize", 16, NULL, FONTSIZE_TEXT, FONTSIZE_LONGTEXT, VLC_FALSE );
65     set_description( _("freetype2 font renderer") );
66     set_capability( "text renderer", 100 );
67     add_shortcut( "text" );
68     set_callbacks( Create, Destroy );
69 vlc_module_end();
70
71 /**
72  Describes a string to be displayed on the video, or a linked list of
73  such
74 */
75 struct subpicture_sys_t
76 {
77     int            i_x_margin;
78     int            i_y_margin;
79     int            i_width;
80     int            i_height;
81     int            i_flags;
82     /** The string associated with this subpicture */
83     byte_t        *psz_text;
84     /** NULL-terminated list of glyphs making the string */
85     FT_Glyph      *pp_glyphs;
86     /** list of relative positions for the glyphs */
87     FT_Vector     *p_glyph_pos;
88 };
89
90 /*****************************************************************************
91  * vout_sys_t: osd_text local data
92  *****************************************************************************
93  * This structure is part of the video output thread descriptor.
94  * It describes the osd-text specific properties of an output thread.
95  *****************************************************************************/
96 struct text_renderer_sys_t
97 {
98     FT_Library     p_library;   /* handle to library     */
99     FT_Face        p_face;      /* handle to face object */
100     vlc_mutex_t   *lock;
101     vlc_bool_t     i_use_kerning;
102     uint8_t        pi_gamma[256];
103 };
104 /* more prototypes */
105 //static void ComputeBoundingBox( subpicture_sys_t * );
106 static void FreeString( subpicture_t * );
107
108 /*****************************************************************************
109  * Create: allocates osd-text video thread output method
110  *****************************************************************************
111  * This function allocates and initializes a Clone vout method.
112  *****************************************************************************/
113 #define gamma_value 2.0
114 static int Create( vlc_object_t *p_this )
115 {
116     vout_thread_t *p_vout = (vout_thread_t *)p_this;
117     char *psz_fontfile;
118     int i, i_error;
119     double gamma_inv = 1.0f / gamma_value;
120     
121     /* Allocate structure */
122     p_vout->p_text_renderer_data = malloc( sizeof( text_renderer_sys_t ) );
123     if( p_vout->p_text_renderer_data == NULL )
124     {
125         msg_Err( p_vout, "out of memory" );
126         return VLC_ENOMEM;
127     }
128
129     for (i = 0; i < 256; i++) {
130         p_vout->p_text_renderer_data->pi_gamma[i] =
131             (uint8_t)( pow( (double)i / 255.0f, gamma_inv) * 255.0f );
132         //msg_Dbg( p_vout, "%d", p_vout->p_text_renderer_data->pi_gamma[i]);
133     }
134
135     /* Look what method was requested */
136     psz_fontfile = config_GetPsz( p_vout, "freetype-font" );
137     i_error = FT_Init_FreeType( &p_vout->p_text_renderer_data->p_library );
138     if( i_error )
139     {
140         msg_Err( p_vout, "couldn't initialize freetype" );
141         free( p_vout->p_text_renderer_data );
142         return VLC_EGENERIC;
143     }
144     i_error = FT_New_Face( p_vout->p_text_renderer_data->p_library,
145                            psz_fontfile, 0,
146                            &p_vout->p_text_renderer_data->p_face );
147     if( i_error == FT_Err_Unknown_File_Format )
148     {
149         msg_Err( p_vout, "file %s have unknown format", psz_fontfile );
150         FT_Done_FreeType( p_vout->p_text_renderer_data->p_library );
151         free( p_vout->p_text_renderer_data );
152         return VLC_EGENERIC;
153     }
154     else if( i_error )
155     {
156         msg_Err( p_vout, "failed to load font file" );
157         FT_Done_FreeType( p_vout->p_text_renderer_data->p_library );
158         free( p_vout->p_text_renderer_data );
159         return VLC_EGENERIC;
160     }
161     i_error = FT_Select_Charmap( p_vout->p_text_renderer_data->p_face,
162                                  FT_ENCODING_UNICODE );
163     if ( i_error )
164     {
165         msg_Err( p_vout, "Font has no unicode translation table" );
166         FT_Done_Face( p_vout->p_text_renderer_data->p_face );
167         FT_Done_FreeType( p_vout->p_text_renderer_data->p_library );
168         free( p_vout->p_text_renderer_data );
169         return VLC_EGENERIC;
170     }
171     
172     p_vout->p_text_renderer_data->i_use_kerning = FT_HAS_KERNING(p_vout->p_text_renderer_data->p_face);
173     
174     i_error = FT_Set_Pixel_Sizes( p_vout->p_text_renderer_data->p_face, 0, 
175                                   config_GetInt( p_vout, "freetype-fontsize" ) );
176     if( i_error )
177     {
178         msg_Err( p_vout, "couldn't set font size to %d",
179                  config_GetInt( p_vout, "osd-fontsize" ) );
180         free( p_vout->p_text_renderer_data );
181         return VLC_EGENERIC;
182     }
183     p_vout->pf_add_string = AddText;
184     return VLC_SUCCESS;
185 }
186
187 /*****************************************************************************
188  * Destroy: destroy Clone video thread output method
189  *****************************************************************************
190  * Clean up all data and library connections
191  *****************************************************************************/
192 static void Destroy( vlc_object_t *p_this )
193
194     vout_thread_t *p_vout = (vout_thread_t *)p_this;
195     FT_Done_Face( p_vout->p_text_renderer_data->p_face );
196     FT_Done_FreeType( p_vout->p_text_renderer_data->p_library );
197     free( p_vout->p_text_renderer_data );
198 }
199
200 /*****************************************************************************
201  * Render: place string in picture
202  *****************************************************************************
203  * This function merges the previously rendered freetype glyphs into a picture
204  *****************************************************************************/
205 static void Render( vout_thread_t *p_vout, picture_t *p_pic, 
206                     const subpicture_t *p_subpic )
207 {
208     subpicture_sys_t *p_string = p_subpic->p_sys;
209     int i_plane, i_error,x,y,pen_x, pen_y;
210     unsigned int i;
211     
212     for( i_plane = 0 ; i_plane < p_pic->i_planes ; i_plane++ )
213     {
214         uint8_t *p_in;
215         int i_pitch = p_pic->p[i_plane].i_pitch;
216
217         p_in = p_pic->p[i_plane].p_pixels;
218
219         if ( i_plane == 0 )
220         {
221             if ( p_string->i_flags & OSD_ALIGN_BOTTOM )
222             {
223                 pen_y = p_pic->p[i_plane].i_lines - p_string->i_height -
224                     p_string->i_y_margin;
225             }
226             else
227             {
228                 pen_y = p_string->i_y_margin;
229             }
230             if ( p_string->i_flags & OSD_ALIGN_RIGHT )
231             {
232                 pen_x = i_pitch - p_string->i_width
233                     - p_string->i_x_margin;
234             }
235             else
236             {
237                 pen_x = p_string->i_x_margin;
238             }
239
240             for( i = 0; p_string->pp_glyphs[i] != NULL; i++ )
241             {
242                 if( p_string->pp_glyphs[i] )
243                 {
244                     FT_Glyph p_glyph = p_string->pp_glyphs[i];
245                     FT_BitmapGlyph p_image;
246                     i_error = FT_Glyph_To_Bitmap( &p_glyph,
247                                                   FT_RENDER_MODE_NORMAL,
248                                                   &p_string->p_glyph_pos[i],
249                                                   0 );
250                     if ( i_error ) continue;
251                     p_image = (FT_BitmapGlyph)p_glyph;
252 #define alpha p_vout->p_text_renderer_data->pi_gamma[p_image->bitmap.buffer[x+ y*p_image->bitmap.width]]
253 #define pixel p_in[(p_string->p_glyph_pos[i].y + pen_y + y - p_image->top)*i_pitch+x+pen_x+p_string->p_glyph_pos[i].x+p_image->left]
254                     for(y = 0; y < p_image->bitmap.rows; y++ )
255                     {
256                         for( x = 0; x < p_image->bitmap.width; x++ )
257                         {
258                             //                                pixel = alpha;
259                             //                                pixel = (pixel^alpha)^pixel;
260                             pixel = ( ( pixel * ( 255 - alpha ) ) >> 8 ) +
261                                 ( 255 * alpha >> 8 );
262                         }
263                     }
264                     FT_Done_Glyph( p_glyph );
265                 }
266             }
267         }
268     }
269 }
270
271 /**
272  * This function receives a string and creates a subpicture for it. It
273  * also calculates the size needed for this string, and renders the
274  * needed glyphs into memory. It is used as pf_add_string callback in
275  * the vout method by this module
276  */
277 static int AddText ( vout_thread_t *p_vout, byte_t *psz_string,
278                      text_style_t *p_style, int i_flags, int i_hmargin, 
279                      int i_vmargin, mtime_t i_start, mtime_t i_stop )
280 {
281     subpicture_sys_t *p_string;
282     int i, i_pen_y, i_pen_x, i_error, i_glyph_index, i_previous, i_char;
283     subpicture_t *p_subpic;
284     FT_BBox line;
285     FT_BBox glyph_size;
286     FT_Vector result;
287
288     result.x = 0;
289     result.y = 0;
290     line.xMin = 0;
291     line.xMax = 0;
292     line.yMin = 0;
293     line.yMax = 0;
294
295     /* Create and initialize a subpicture */
296     p_subpic = vout_CreateSubPicture( p_vout, MEMORY_SUBPICTURE );
297     if ( p_subpic == NULL )
298     {
299         return VLC_EGENERIC;
300     }
301     p_subpic->pf_render = Render;
302     p_subpic->pf_destroy = FreeString;
303     p_subpic->i_start = i_start;
304     p_subpic->i_stop = i_stop;
305     if( i_stop == 0 )
306     {
307         p_subpic->b_ephemer = VLC_TRUE;
308     }
309     else
310     {
311         p_subpic->b_ephemer = VLC_FALSE;
312     }
313
314     /* Create and initialize private data for the subpicture */
315     p_string = malloc( sizeof(subpicture_sys_t) );
316     if ( p_string == NULL )
317     {
318         vout_DestroySubPicture( p_vout, p_subpic );
319         return VLC_ENOMEM;
320     }
321     p_subpic->p_sys = p_string;
322     p_string->i_flags = i_flags;
323     p_string->i_x_margin = i_hmargin;
324     p_string->i_y_margin = i_vmargin;
325
326     p_string->psz_text = strdup( psz_string );
327     p_string->pp_glyphs = malloc( sizeof(FT_GlyphSlot)
328                                   * ( strlen( p_string->psz_text ) + 1 ) );
329     if( p_string->pp_glyphs == NULL )
330     {
331         msg_Err( p_vout, "Out of memory" );
332         return VLC_ENOMEM;
333     }
334     p_string->p_glyph_pos = malloc( sizeof( FT_Vector )
335                                   * strlen( p_string->psz_text ) );
336     if( p_string->p_glyph_pos == NULL )
337     {
338         msg_Err( p_vout, "Out of memory" );
339         return VLC_ENOMEM;
340     }
341
342     /* Calculate relative glyph positions and a bounding box for the
343      * entire string */
344     i_pen_x = 0;
345     i_pen_y = 0;
346     i_previous = 0;
347     i = 0;
348     while( *psz_string )
349     {
350         i_char = GetUnicodeCharFromUTF8( &psz_string );
351 #define face p_vout->p_text_renderer_data->p_face
352 #define glyph face->glyph
353         if ( i_char == '\n' )
354         {
355             i_pen_x = 0;
356             result.x = __MAX( result.x, line.xMax );
357             result.y += face->height >> 6;
358             line.xMin = 0;
359             line.xMax = 0;
360             line.yMin = 0;
361             line.yMax = 0;
362             i_pen_y += face->height >> 6;
363             continue;
364         }
365         i_glyph_index = FT_Get_Char_Index( face, i_char );
366         if ( p_vout->p_text_renderer_data->i_use_kerning && i_glyph_index
367             && i_previous )
368         {
369             FT_Vector delta;
370             FT_Get_Kerning( face, i_previous, i_glyph_index,
371                             ft_kerning_default, &delta );
372             i_pen_x += delta.x >> 6;
373             
374         }
375         p_string->p_glyph_pos[ i ].x = i_pen_x;
376         p_string->p_glyph_pos[ i ].y = i_pen_y;
377         i_error = FT_Load_Glyph( face, i_glyph_index, FT_LOAD_DEFAULT );
378         if ( i_error )
379         {
380             msg_Err( p_vout, "FT_Load_Glyph returned %d", i_error );
381             return VLC_EGENERIC;
382         }
383         i_error = FT_Get_Glyph( glyph, &p_string->pp_glyphs[ i ] );
384         if ( i_error )
385         {
386             msg_Err( p_vout, "FT_Get_Glyph returned %d", i_error );
387             return VLC_EGENERIC;
388         }
389         FT_Glyph_Get_CBox( p_string->pp_glyphs[i],
390                            ft_glyph_bbox_pixels, &glyph_size );
391         /* Do rest */
392         line.xMax = p_string->p_glyph_pos[i].x + glyph_size.xMax - glyph_size.xMin;
393         line.yMax = __MAX( line.yMax, glyph_size.yMax );
394         line.yMin = __MIN( line.yMin, glyph_size.yMin );
395         
396         i_previous = i_glyph_index;
397         i_pen_x += glyph->advance.x >> 6;
398         i++;
399     }
400     p_string->pp_glyphs[i] = NULL;
401     result.x = __MAX( result.x, line.xMax );
402     result.y += line.yMax - line.yMin;
403     p_string->i_height = result.y;
404     p_string->i_width = result.x;
405     msg_Dbg( p_vout, "string height is %d, width is %d", p_string->i_height, p_string->i_width );
406     msg_Dbg( p_vout, "adding string \"%s\" at (%d,%d) start_date "I64Fd
407              " end_date" I64Fd, p_string->psz_text, p_string->i_x_margin,
408              p_string->i_y_margin, i_start, i_stop );
409     vout_DisplaySubPicture( p_vout, p_subpic );
410     return VLC_SUCCESS;
411 }
412
413 static void FreeString( subpicture_t *p_subpic )
414 {
415     unsigned int i;
416     subpicture_sys_t *p_string = p_subpic->p_sys;
417     for ( i = 0; p_string->pp_glyphs[ i ] != NULL; i++ )
418     {
419         FT_Done_Glyph( p_string->pp_glyphs[ i ] );
420     }
421     free( p_string->psz_text );
422     free( p_string->p_glyph_pos );
423     free( p_string->pp_glyphs );
424     free( p_string );
425 }
426
427 /* convert one or more utf8 bytes into a unicode character */
428 static int GetUnicodeCharFromUTF8( byte_t **ppsz_utf8_string )
429 {
430     int i_remaining_bytes, i_char = 0;
431     if( ( **ppsz_utf8_string & 0xFC ) == 0xFC )
432     {
433         i_char = **ppsz_utf8_string & 1;
434         i_remaining_bytes = 5;
435     }
436     else if( ( **ppsz_utf8_string & 0xF8 ) == 0xF8 )
437     {
438         i_char = **ppsz_utf8_string & 3;
439         i_remaining_bytes = 4;
440     }
441     else if( ( **ppsz_utf8_string & 0xF0 ) == 0xF0 )
442     {
443         i_char = **ppsz_utf8_string & 7;
444         i_remaining_bytes = 3;
445     }
446     else if( ( **ppsz_utf8_string & 0xE0 ) == 0xE0 )
447     {
448         i_char = **ppsz_utf8_string & 15;
449         i_remaining_bytes = 2;
450     }
451     else if( ( **ppsz_utf8_string & 0xC0 ) == 0xC0 )
452     {
453         i_char = **ppsz_utf8_string & 31;
454         i_remaining_bytes = 1;
455     }
456     else
457     {
458         i_char = **ppsz_utf8_string;
459         i_remaining_bytes = 0;
460     }
461     while( i_remaining_bytes )
462     {
463         (*ppsz_utf8_string)++;
464         i_remaining_bytes--;
465         i_char = ( i_char << 6 ) + ( **ppsz_utf8_string & 0x3F );
466     }
467     (*ppsz_utf8_string)++;
468     return i_char;
469 }