freetype.c 19 KB
Newer Older
1 2 3 4
/*****************************************************************************
 * freetype.c : Put text on the video, using freetype2
 *****************************************************************************
 * Copyright (C) 2002, 2003 VideoLAN
5
 * $Id: freetype.c,v 1.7 2003/07/20 23:05:24 sigmunau Exp $
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
 *
 * Authors: Sigmund Augdal <sigmunau@idi.ntnu.no>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
#include <stdlib.h>                                      /* malloc(), free() */
#include <string.h>

#include <vlc/vlc.h>
#include <vlc/vout.h>
#include <osd.h>
#include <math.h>

#include <ft2build.h>
#include FT_FREETYPE_H
#include FT_GLYPH_H

39 40 41 42 43 44
#ifdef SYS_DARWIN
#define DEFAULT_FONT "/System/Library/Fonts/LucidaGrande.dfont"
#else
#define DEFAULT_FONT ""
#endif

45 46 47 48 49 50
/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
static int  Create    ( vlc_object_t * );
static void Destroy   ( vlc_object_t * );

51 52 53 54 55 56
static void Render    ( vout_thread_t *, picture_t *,
                        const subpicture_t * );
static void RenderI420( vout_thread_t *, picture_t *,
                        const subpicture_t * );
static int  AddText   ( vout_thread_t *, byte_t *, text_style_t *, int,
                        int, int, mtime_t, mtime_t );
57 58
static int  GetUnicodeCharFromUTF8( byte_t ** );
static void FreeString( subpicture_t * );
59 60 61 62 63 64 65 66 67 68 69

/*****************************************************************************
 * Module descriptor
 *****************************************************************************/
#define FONT_TEXT N_("Font")
#define FONT_LONGTEXT N_("Filename of Font")
#define FONTSIZE_TEXT N_("Font size")
#define FONTSIZE_LONGTEXT N_("The size of the fonts used by the osd module" )

vlc_module_begin();
    add_category_hint( N_("Fonts"), NULL, VLC_FALSE );
70
    add_file( "freetype-font", DEFAULT_FONT, NULL, FONT_TEXT, FONT_LONGTEXT, VLC_FALSE );
71 72 73 74 75 76 77 78
    add_integer( "freetype-fontsize", 16, NULL, FONTSIZE_TEXT, FONTSIZE_LONGTEXT, VLC_FALSE );
    set_description( _("freetype2 font renderer") );
    set_capability( "text renderer", 100 );
    add_shortcut( "text" );
    set_callbacks( Create, Destroy );
vlc_module_end();

/**
79 80
 * Private data in a aubpicture. Describes a string.
 */
81 82 83 84 85 86 87 88 89 90
struct subpicture_sys_t
{
    int            i_x_margin;
    int            i_y_margin;
    int            i_width;
    int            i_height;
    int            i_flags;
    /** The string associated with this subpicture */
    byte_t        *psz_text;
    /** NULL-terminated list of glyphs making the string */
91
    FT_BitmapGlyph      *pp_glyphs;
92 93 94 95 96
    /** list of relative positions for the glyphs */
    FT_Vector     *p_glyph_pos;
};

/*****************************************************************************
97
 * text_remderer_sys_t: freetype local data
98 99
 *****************************************************************************
 * This structure is part of the video output thread descriptor.
100
 * It describes the freetype specific properties of an output thread.
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
 *****************************************************************************/
struct text_renderer_sys_t
{
    FT_Library     p_library;   /* handle to library     */
    FT_Face        p_face;      /* handle to face object */
    vlc_mutex_t   *lock;
    vlc_bool_t     i_use_kerning;
    uint8_t        pi_gamma[256];
};

/*****************************************************************************
 * Create: allocates osd-text video thread output method
 *****************************************************************************
 * This function allocates and initializes a Clone vout method.
 *****************************************************************************/
#define gamma_value 2.0
static int Create( vlc_object_t *p_this )
{
    vout_thread_t *p_vout = (vout_thread_t *)p_this;
    char *psz_fontfile;
    int i, i_error;
    double gamma_inv = 1.0f / gamma_value;
123

124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
    /* Allocate structure */
    p_vout->p_text_renderer_data = malloc( sizeof( text_renderer_sys_t ) );
    if( p_vout->p_text_renderer_data == NULL )
    {
        msg_Err( p_vout, "out of memory" );
        return VLC_ENOMEM;
    }

    for (i = 0; i < 256; i++) {
        p_vout->p_text_renderer_data->pi_gamma[i] =
            (uint8_t)( pow( (double)i / 255.0f, gamma_inv) * 255.0f );
    }

    /* Look what method was requested */
    psz_fontfile = config_GetPsz( p_vout, "freetype-font" );
    i_error = FT_Init_FreeType( &p_vout->p_text_renderer_data->p_library );
    if( i_error )
    {
        msg_Err( p_vout, "couldn't initialize freetype" );
        free( p_vout->p_text_renderer_data );
        return VLC_EGENERIC;
    }
    i_error = FT_New_Face( p_vout->p_text_renderer_data->p_library,
147
                           psz_fontfile, 0,
148 149 150 151
                           &p_vout->p_text_renderer_data->p_face );
    if( i_error == FT_Err_Unknown_File_Format )
    {
        msg_Err( p_vout, "file %s have unknown format", psz_fontfile );
152
        FT_Done_FreeType( p_vout->p_text_renderer_data->p_library );
153 154 155 156 157 158
        free( p_vout->p_text_renderer_data );
        return VLC_EGENERIC;
    }
    else if( i_error )
    {
        msg_Err( p_vout, "failed to load font file" );
159
        FT_Done_FreeType( p_vout->p_text_renderer_data->p_library );
160 161 162 163
        free( p_vout->p_text_renderer_data );
        return VLC_EGENERIC;
    }
    i_error = FT_Select_Charmap( p_vout->p_text_renderer_data->p_face,
164
                                 ft_encoding_unicode );
165 166
    if ( i_error )
    {
167 168 169 170 171
        msg_Err( p_vout, "Font has no unicode translation table" );
        FT_Done_Face( p_vout->p_text_renderer_data->p_face );
        FT_Done_FreeType( p_vout->p_text_renderer_data->p_library );
        free( p_vout->p_text_renderer_data );
        return VLC_EGENERIC;
172
    }
173 174 175 176 177 178

    p_vout->p_text_renderer_data->i_use_kerning =
        FT_HAS_KERNING(p_vout->p_text_renderer_data->p_face);

    i_error = FT_Set_Pixel_Sizes( p_vout->p_text_renderer_data->p_face, 0,
                                  config_GetInt( p_vout, "freetype-fontsize" ) );
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
    if( i_error )
    {
        msg_Err( p_vout, "couldn't set font size to %d",
                 config_GetInt( p_vout, "osd-fontsize" ) );
        free( p_vout->p_text_renderer_data );
        return VLC_EGENERIC;
    }
    p_vout->pf_add_string = AddText;
    return VLC_SUCCESS;
}

/*****************************************************************************
 * Destroy: destroy Clone video thread output method
 *****************************************************************************
 * Clean up all data and library connections
 *****************************************************************************/
static void Destroy( vlc_object_t *p_this )
196
{
197 198 199 200 201 202 203 204 205 206 207
    vout_thread_t *p_vout = (vout_thread_t *)p_this;
    FT_Done_Face( p_vout->p_text_renderer_data->p_face );
    FT_Done_FreeType( p_vout->p_text_renderer_data->p_library );
    free( p_vout->p_text_renderer_data );
}

/*****************************************************************************
 * Render: place string in picture
 *****************************************************************************
 * This function merges the previously rendered freetype glyphs into a picture
 *****************************************************************************/
208 209
static void Render( vout_thread_t *p_vout, picture_t *p_pic,
                    const subpicture_t *p_subpic )
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
{
    switch( p_vout->output.i_chroma )
    {
        /* I420 target, no scaling */
        case VLC_FOURCC('I','4','2','0'):
        case VLC_FOURCC('I','Y','U','V'):
        case VLC_FOURCC('Y','V','1','2'):
            RenderI420( p_vout, p_pic, p_subpic );
            break;
#if 0
        /* RV16 target, scaling */
        case VLC_FOURCC('R','V','1','6'):
            RenderRV16( p_vout, p_pic, p_spu, p_spu->p_sys->b_crop );
            break;

        /* RV32 target, scaling */
        case VLC_FOURCC('R','V','2','4'):
        case VLC_FOURCC('R','V','3','2'):
            RenderRV32( p_vout, p_pic, p_spu, p_spu->p_sys->b_crop );
            break;

        /* NVidia overlay, no scaling */
        case VLC_FOURCC('Y','U','Y','2'):
            RenderYUY2( p_vout, p_pic, p_spu, p_spu->p_sys->b_crop );
            break;
#endif
        default:
            msg_Err( p_vout, "unknown chroma, can't render SPU" );
            break;
    }
}

242 243 244
/**
 * Draw a string on a i420 (or similar) picture
 */
245 246
static void RenderI420( vout_thread_t *p_vout, picture_t *p_pic,
                    const subpicture_t *p_subpic )
247 248
{
    subpicture_sys_t *p_string = p_subpic->p_sys;
249
    int i_plane, x, y, pen_x, pen_y;
250
    unsigned int i;
251

252 253 254 255 256 257 258 259
    for( i_plane = 0 ; i_plane < p_pic->i_planes ; i_plane++ )
    {
        uint8_t *p_in;
        int i_pitch = p_pic->p[i_plane].i_pitch;

        p_in = p_pic->p[i_plane].p_pixels;

        if ( i_plane == 0 )
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
        {
            if ( p_string->i_flags & OSD_ALIGN_BOTTOM )
            {
                pen_y = p_pic->p[i_plane].i_lines - p_string->i_height -
                    p_string->i_y_margin;
            }
            else
            {
                pen_y = p_string->i_y_margin;
            }
            if ( p_string->i_flags & OSD_ALIGN_RIGHT )
            {
                pen_x = i_pitch - p_string->i_width
                    - p_string->i_x_margin;
            }
            else
            {
                pen_x = p_string->i_x_margin;
            }

            for( i = 0; p_string->pp_glyphs[i] != NULL; i++ )
            {
                if( p_string->pp_glyphs[i] )
                {
                    FT_BitmapGlyph p_glyph = p_string->pp_glyphs[ i ];
285 286
#define alpha p_vout->p_text_renderer_data->pi_gamma[ p_glyph->bitmap.buffer[ x + y * p_glyph->bitmap.width ] ]
#define pixel p_in[ ( p_string->p_glyph_pos[ i ].y + pen_y + y - p_glyph->top ) * i_pitch+x + pen_x + p_string->p_glyph_pos[ i ].x + p_glyph->left ]
287 288 289 290 291
                    for(y = 0; y < p_glyph->bitmap.rows; y++ )
                    {
                        for( x = 0; x < p_glyph->bitmap.width; x++ )
                        {
                            pixel = ( ( pixel * ( 255 - alpha ) ) >> 8 ) +
292
                                ( 255 * alpha >> 8 );
293 294
#undef alpha
#undef pixel
295 296 297 298 299
                        }
                    }
                }
            }
        }
300 301
        else
        {
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
            if ( p_string->i_flags & OSD_ALIGN_BOTTOM )
            {
                pen_y = p_pic->p[i_plane].i_lines - ( p_string->i_height>>1) -
                    (p_string->i_y_margin>>1);
            }
            else
            {
                pen_y = p_string->i_y_margin >> 1;
            }
            if ( p_string->i_flags & OSD_ALIGN_RIGHT )
            {
                pen_x = i_pitch - ( p_string->i_width >> 1 )
                    - ( p_string->i_x_margin >> 1 );
            }
            else
            {
                pen_x = p_string->i_x_margin >> 1;
            }

            for( i = 0; p_string->pp_glyphs[i] != NULL; i++ )
            {
                if( p_string->pp_glyphs[i] )
                {
                    FT_BitmapGlyph p_glyph = p_string->pp_glyphs[ i ];
326 327
#define alpha p_vout->p_text_renderer_data->pi_gamma[ p_glyph->bitmap.buffer[ ( x + y * p_glyph->bitmap.width ) ] ]
#define pixel p_in[ ( (p_string->p_glyph_pos[ i ].y>>1) + pen_y + (y>>1) -  ( p_glyph->top >> 1 ) ) * i_pitch + ( x >> 1 ) + pen_x + ( p_string->p_glyph_pos[ i ].x >> 1 ) + ( p_glyph->left >>1) ]
328 329 330 331 332
                    for( y = 0; y < p_glyph->bitmap.rows; y+=2 )
                    {
                        for( x = 0; x < p_glyph->bitmap.width; x+=2 )
                        {
                            pixel = ( ( pixel * ( 0xFF - alpha ) ) >> 8 ) +
333 334 335
                                ( 0x80 * alpha >> 8 );
#undef alpha
#undef pixel
336 337 338 339
                        }
                    }
                }
            }
340
        }
341 342 343 344 345 346 347 348 349 350
    }
}

/**
 * This function receives a string and creates a subpicture for it. It
 * also calculates the size needed for this string, and renders the
 * needed glyphs into memory. It is used as pf_add_string callback in
 * the vout method by this module
 */
static int AddText ( vout_thread_t *p_vout, byte_t *psz_string,
351 352
                     text_style_t *p_style, int i_flags, int i_hmargin,
                     int i_vmargin, mtime_t i_start, mtime_t i_stop )
353 354 355 356 357 358 359
{
    subpicture_sys_t *p_string;
    int i, i_pen_y, i_pen_x, i_error, i_glyph_index, i_previous, i_char;
    subpicture_t *p_subpic;
    FT_BBox line;
    FT_BBox glyph_size;
    FT_Vector result;
360
    FT_Glyph tmp_glyph;
361 362 363 364 365 366 367 368 369 370 371 372

    result.x = 0;
    result.y = 0;
    line.xMin = 0;
    line.xMax = 0;
    line.yMin = 0;
    line.yMax = 0;

    /* Create and initialize a subpicture */
    p_subpic = vout_CreateSubPicture( p_vout, MEMORY_SUBPICTURE );
    if ( p_subpic == NULL )
    {
373
        return VLC_EGENERIC;
374 375 376 377 378 379 380
    }
    p_subpic->pf_render = Render;
    p_subpic->pf_destroy = FreeString;
    p_subpic->i_start = i_start;
    p_subpic->i_stop = i_stop;
    if( i_stop == 0 )
    {
381
        p_subpic->b_ephemer = VLC_TRUE;
382 383 384
    }
    else
    {
385
        p_subpic->b_ephemer = VLC_FALSE;
386 387 388 389 390 391
    }

    /* Create and initialize private data for the subpicture */
    p_string = malloc( sizeof(subpicture_sys_t) );
    if ( p_string == NULL )
    {
392 393
        vout_DestroySubPicture( p_vout, p_subpic );
        return VLC_ENOMEM;
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
    }
    p_subpic->p_sys = p_string;
    p_string->i_flags = i_flags;
    p_string->i_x_margin = i_hmargin;
    p_string->i_y_margin = i_vmargin;

    p_string->psz_text = strdup( psz_string );
    p_string->pp_glyphs = malloc( sizeof(FT_GlyphSlot)
                                  * ( strlen( p_string->psz_text ) + 1 ) );
    if( p_string->pp_glyphs == NULL )
    {
        msg_Err( p_vout, "Out of memory" );
        return VLC_ENOMEM;
    }
    p_string->p_glyph_pos = malloc( sizeof( FT_Vector )
                                  * strlen( p_string->psz_text ) );
    if( p_string->p_glyph_pos == NULL )
    {
        msg_Err( p_vout, "Out of memory" );
        return VLC_ENOMEM;
    }

    /* Calculate relative glyph positions and a bounding box for the
     * entire string */
    i_pen_x = 0;
    i_pen_y = 0;
    i_previous = 0;
    i = 0;
    while( *psz_string )
    {
        i_char = GetUnicodeCharFromUTF8( &psz_string );
#define face p_vout->p_text_renderer_data->p_face
#define glyph face->glyph
        if ( i_char == '\n' )
        {
            i_pen_x = 0;
            result.x = __MAX( result.x, line.xMax );
431
            result.y += face->height >> 6;
432 433 434 435
            line.xMin = 0;
            line.xMax = 0;
            line.yMin = 0;
            line.yMax = 0;
436
            i_pen_y += face->height >> 6;
437 438 439 440 441 442 443 444 445 446
            continue;
        }
        i_glyph_index = FT_Get_Char_Index( face, i_char );
        if ( p_vout->p_text_renderer_data->i_use_kerning && i_glyph_index
            && i_previous )
        {
            FT_Vector delta;
            FT_Get_Kerning( face, i_previous, i_glyph_index,
                            ft_kerning_default, &delta );
            i_pen_x += delta.x >> 6;
447

448 449 450 451 452 453 454 455 456
        }
        p_string->p_glyph_pos[ i ].x = i_pen_x;
        p_string->p_glyph_pos[ i ].y = i_pen_y;
        i_error = FT_Load_Glyph( face, i_glyph_index, FT_LOAD_DEFAULT );
        if ( i_error )
        {
            msg_Err( p_vout, "FT_Load_Glyph returned %d", i_error );
            return VLC_EGENERIC;
        }
457
        i_error = FT_Get_Glyph( glyph, &tmp_glyph );
458 459 460 461 462
        if ( i_error )
        {
            msg_Err( p_vout, "FT_Get_Glyph returned %d", i_error );
            return VLC_EGENERIC;
        }
463 464
        FT_Glyph_Get_CBox( tmp_glyph, ft_glyph_bbox_pixels, &glyph_size );
        i_error = FT_Glyph_To_Bitmap( &tmp_glyph,
465
                                      ft_render_mode_normal,
466 467 468 469
                                      &p_string->p_glyph_pos[i],
                                      1 );
        if ( i_error ) continue;
        p_string->pp_glyphs[ i ] = (FT_BitmapGlyph)tmp_glyph;
470

471 472 473 474
        /* Do rest */
        line.xMax = p_string->p_glyph_pos[i].x + glyph_size.xMax - glyph_size.xMin;
        line.yMax = __MAX( line.yMax, glyph_size.yMax );
        line.yMin = __MIN( line.yMin, glyph_size.yMin );
475

476 477
        i_previous = i_glyph_index;
        i_pen_x += glyph->advance.x >> 6;
478
        i++;
479 480 481 482 483 484
    }
    p_string->pp_glyphs[i] = NULL;
    result.x = __MAX( result.x, line.xMax );
    result.y += line.yMax - line.yMin;
    p_string->i_height = result.y;
    p_string->i_width = result.x;
485 486
    msg_Dbg( p_vout, "string height is %d, width is %d",
             p_string->i_height, p_string->i_width );
487 488 489 490 491 492 493 494 495 496 497 498 499
    msg_Dbg( p_vout, "adding string \"%s\" at (%d,%d) start_date "I64Fd
             " end_date" I64Fd, p_string->psz_text, p_string->i_x_margin,
             p_string->i_y_margin, i_start, i_stop );
    vout_DisplaySubPicture( p_vout, p_subpic );
    return VLC_SUCCESS;
}

static void FreeString( subpicture_t *p_subpic )
{
    unsigned int i;
    subpicture_sys_t *p_string = p_subpic->p_sys;
    for ( i = 0; p_string->pp_glyphs[ i ] != NULL; i++ )
    {
500
        FT_Done_Glyph( (FT_Glyph)p_string->pp_glyphs[ i ] );
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
    }
    free( p_string->psz_text );
    free( p_string->p_glyph_pos );
    free( p_string->pp_glyphs );
    free( p_string );
}

/* convert one or more utf8 bytes into a unicode character */
static int GetUnicodeCharFromUTF8( byte_t **ppsz_utf8_string )
{
    int i_remaining_bytes, i_char = 0;
    if( ( **ppsz_utf8_string & 0xFC ) == 0xFC )
    {
        i_char = **ppsz_utf8_string & 1;
        i_remaining_bytes = 5;
    }
    else if( ( **ppsz_utf8_string & 0xF8 ) == 0xF8 )
    {
        i_char = **ppsz_utf8_string & 3;
        i_remaining_bytes = 4;
    }
    else if( ( **ppsz_utf8_string & 0xF0 ) == 0xF0 )
    {
        i_char = **ppsz_utf8_string & 7;
        i_remaining_bytes = 3;
    }
    else if( ( **ppsz_utf8_string & 0xE0 ) == 0xE0 )
    {
        i_char = **ppsz_utf8_string & 15;
        i_remaining_bytes = 2;
    }
    else if( ( **ppsz_utf8_string & 0xC0 ) == 0xC0 )
    {
        i_char = **ppsz_utf8_string & 31;
        i_remaining_bytes = 1;
    }
    else
    {
        i_char = **ppsz_utf8_string;
        i_remaining_bytes = 0;
    }
    while( i_remaining_bytes )
    {
        (*ppsz_utf8_string)++;
        i_remaining_bytes--;
        i_char = ( i_char << 6 ) + ( **ppsz_utf8_string & 0x3F );
    }
    (*ppsz_utf8_string)++;
    return i_char;
}