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

   1 /*****************************************************************************
   2  * quartztext.c : Put text on the video, using Mac OS X Quartz Engine
   3  *****************************************************************************
   4  * Copyright (C) 2007 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Bernie Purcell <bitmap@videolan.org>
   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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 //////////////////////////////////////////////////////////////////////////////
  25 // Preamble
  26 //////////////////////////////////////////////////////////////////////////////
  27
  28 #include <vlc/vlc.h>
  29 #include <vlc_vout.h>
  30 #include <vlc_osd.h>
  31 #include <vlc_block.h>
  32 #include <vlc_filter.h>
  33 #include <vlc_stream.h>
  34 #include <vlc_xml.h>
  35 #include <vlc_input.h>
  36
  37 #include <math.h>
  38
  39 #include <Carbon/Carbon.h>
  40
  41 #define DEFAULT_FONT           "Verdana"
  42 #define DEFAULT_FONT_COLOR     0xffffff
  43 #define DEFAULT_REL_FONT_SIZE  16
  44
  45 #define VERTICAL_MARGIN 3
  46 #define HORIZONTAL_MARGIN 10
  47
  48 //////////////////////////////////////////////////////////////////////////////
  49 // Local prototypes
  50 //////////////////////////////////////////////////////////////////////////////
  51 static int  Create ( vlc_object_t * );
  52 static void Destroy( vlc_object_t * );
  53
  54 static int LoadFontsFromAttachments( filter_t *p_filter );
  55
  56 static int RenderText( filter_t *, subpicture_region_t *,
  57                        subpicture_region_t * );
  58 static int RenderHtml( filter_t *, subpicture_region_t *,
  59                        subpicture_region_t * );
  60
  61 static int RenderYUVA( filter_t *p_filter, subpicture_region_t *p_region,
  62                        UniChar *psz_utfString, uint32_t i_text_len,
  63                        uint32_t i_runs, uint32_t *pi_run_lengths,
  64                        ATSUStyle *pp_styles );
  65 static ATSUStyle CreateStyle( char *psz_fontname, int i_font_size,
  66                               int i_font_color, int i_font_alpha,
  67                               vlc_bool_t b_bold, vlc_bool_t b_italic,
  68                               vlc_bool_t b_uline );
  69 //////////////////////////////////////////////////////////////////////////////
  70 // Module descriptor
  71 //////////////////////////////////////////////////////////////////////////////
  72
  73 // The preferred way to set font style information is for it to come from the
  74 // subtitle file, and for it to be rendered with RenderHtml instead of
  75 // RenderText. This module, unlike Freetype, doesn't provide any options to
  76 // override the fallback font selection used when this style information is
  77 // absent.
  78 vlc_module_begin();
  79     set_shortname( _("Mac Text renderer"));
  80     set_description( _("Quartz font renderer") );
  81     set_category( CAT_VIDEO );
  82     set_subcategory( SUBCAT_VIDEO_SUBPIC );
  83
  84     set_capability( "text renderer", 120 );
  85     add_shortcut( "text" );
  86     set_callbacks( Create, Destroy );
  87 vlc_module_end();
  88
  89 typedef struct font_stack_t font_stack_t;
  90 struct font_stack_t
  91 {
  92     char          *psz_name;
  93     int            i_size;
  94     int            i_color;
  95     int            i_alpha;
  96
  97     font_stack_t  *p_next;
  98 };
  99
 100 typedef struct offscreen_bitmap_t offscreen_bitmap_t;
 101 struct offscreen_bitmap_t
 102 {
 103     uint8_t       *p_data;
 104     int            i_bitsPerChannel;
 105     int            i_bitsPerPixel;
 106     int            i_bytesPerPixel;
 107     int            i_bytesPerRow;
 108 };
 109
 110 //////////////////////////////////////////////////////////////////////////////
 111 // filter_sys_t: quartztext local data
 112 //////////////////////////////////////////////////////////////////////////////
 113 // This structure is part of the video output thread descriptor.
 114 // It describes the freetype specific properties of an output thread.
 115 //////////////////////////////////////////////////////////////////////////////
 116 struct filter_sys_t
 117 {
 118     char          *psz_font_name;
 119     uint8_t        i_font_opacity;
 120     int            i_font_color;
 121     int            i_font_size;
 122
 123     ATSFontContainerRef    *p_fonts;
 124     int                     i_fonts;
 125 };
 126
 127 //////////////////////////////////////////////////////////////////////////////
 128 // Create: allocates osd-text video thread output method
 129 //////////////////////////////////////////////////////////////////////////////
 130 // This function allocates and initializes a Clone vout method.
 131 //////////////////////////////////////////////////////////////////////////////
 132 static int Create( vlc_object_t *p_this )
 133 {
 134     filter_t *p_filter = (filter_t *)p_this;
 135     filter_sys_t *p_sys;
 136
 137     // Allocate structure
 138     p_filter->p_sys = p_sys = malloc( sizeof( filter_sys_t ) );
 139     if( !p_sys )
 140     {
 141         msg_Err( p_filter, "out of memory" );
 142         return VLC_ENOMEM;
 143     }
 144     p_sys->psz_font_name  = strdup( DEFAULT_FONT );
 145     p_sys->i_font_opacity = 255;
 146     p_sys->i_font_color   = DEFAULT_FONT_COLOR;
 147     p_sys->i_font_size    = p_filter->fmt_out.video.i_height / DEFAULT_REL_FONT_SIZE;
 148
 149     p_filter->pf_render_text = RenderText;
 150     p_filter->pf_render_html = RenderHtml;
 151
 152     p_sys->p_fonts = NULL;
 153     p_sys->i_fonts = 0;
 154
 155     LoadFontsFromAttachments( p_filter );
 156
 157     return VLC_SUCCESS;
 158 }
 159
 160 //////////////////////////////////////////////////////////////////////////////
 161 // Destroy: destroy Clone video thread output method
 162 //////////////////////////////////////////////////////////////////////////////
 163 // Clean up all data and library connections
 164 //////////////////////////////////////////////////////////////////////////////
 165 static void Destroy( vlc_object_t *p_this )
 166 {
 167     filter_t *p_filter = (filter_t *)p_this;
 168     filter_sys_t *p_sys = p_filter->p_sys;
 169
 170     if( p_sys->p_fonts )
 171     {
 172         int   k;
 173
 174         for( k = 0; k < p_sys->i_fonts; k++ )
 175         {
 176             ATSFontDeactivate( p_sys->p_fonts[k], NULL, kATSOptionFlagsDefault );
 177         }
 178
 179         free( p_sys->p_fonts );
 180     }
 181
 182     if( p_sys->psz_font_name ) free( p_sys->psz_font_name );
 183
 184     free( p_sys );
 185 }
 186
 187 //////////////////////////////////////////////////////////////////////////////
 188 // Make any TTF/OTF fonts present in the attachments of the media file
 189 // available to the Quartz engine for text rendering
 190 //////////////////////////////////////////////////////////////////////////////
 191 static int LoadFontsFromAttachments( filter_t *p_filter )
 192 {
 193     filter_sys_t         *p_sys = p_filter->p_sys;
 194     input_thread_t       *p_input;
 195     input_attachment_t  **pp_attachments;
 196     int                   i_attachments_cnt;
 197     int                   k;
 198     int                   rv = VLC_SUCCESS;
 199
 200     p_input = (input_thread_t *)vlc_object_find( p_filter, VLC_OBJECT_INPUT, FIND_PARENT );
 201     if( ! p_input )
 202         return VLC_EGENERIC;
 203
 204     if( VLC_SUCCESS != input_Control( p_input, INPUT_GET_ATTACHMENTS, &pp_attachments, &i_attachments_cnt ))
 205     {
 206         vlc_object_release(p_input);
 207         return VLC_EGENERIC;
 208     }
 209
 210     p_sys->i_fonts = 0;
 211     p_sys->p_fonts = malloc( i_attachments_cnt * sizeof( ATSFontContainerRef ) );
 212     if(! p_sys->p_fonts )
 213         rv = VLC_ENOMEM;
 214
 215     for( k = 0; k < i_attachments_cnt; k++ )
 216     {
 217         input_attachment_t *p_attach = pp_attachments[k];
 218
 219         if( p_sys->p_fonts )
 220         {
 221             if(( !strcmp( p_attach->psz_mime, "application/x-truetype-font" ) || // TTF
 222                  !strcmp( p_attach->psz_mime, "application/x-font-otf" ) ) &&    // OTF
 223                ( p_attach->i_data > 0 ) &&
 224                ( p_attach->p_data != NULL ) )
 225             {
 226                 ATSFontContainerRef  container;
 227
 228                 if( noErr == ATSFontActivateFromMemory( p_attach->p_data,
 229                                                         p_attach->i_data,
 230                                                         kATSFontContextLocal,
 231                                                         kATSFontFormatUnspecified,
 232                                                         NULL,
 233                                                         kATSOptionFlagsDefault,
 234                                                         &container ))
 235                 {
 236                     p_sys->p_fonts[ p_sys->i_fonts++ ] = container;
 237                 }
 238             }
 239         }
 240         vlc_input_attachment_Delete( p_attach );
 241     }
 242     free( pp_attachments );
 243
 244     vlc_object_release(p_input);
 245
 246     return rv;
 247 }
 248
 249 #if MAC_OS_X_VERSION_MIN_REQUIRED < MAC_OS_X_VERSION_10_4
 250 // Original version of these functions available on:
 251 // http://developer.apple.com/documentation/Carbon/Conceptual/QuickDrawToQuartz2D/tq_color/chapter_4_section_3.html
 252
 253 #define kGenericRGBProfilePathStr "/System/Library/ColorSync/Profiles/Generic RGB Profile.icc"
 254
 255 static CMProfileRef OpenGenericProfile( void )
 256 {
 257     static CMProfileRef cached_rgb_prof = NULL;
 258
 259     // Create the profile reference only once
 260     if( cached_rgb_prof == NULL )
 261     {
 262         OSStatus            err;
 263         CMProfileLocation   loc;
 264
 265         loc.locType = cmPathBasedProfile;
 266         strcpy( loc.u.pathLoc.path, kGenericRGBProfilePathStr );
 267
 268         err = CMOpenProfile( &cached_rgb_prof, &loc );
 269
 270         if( err != noErr )
 271         {
 272             cached_rgb_prof = NULL;
 273         }
 274     }
 275
 276     if( cached_rgb_prof )
 277     {
 278         // Clone the profile reference so that the caller has
 279         // their own reference, not our cached one.
 280         CMCloneProfileRef( cached_rgb_prof );
 281     }
 282
 283     return cached_rgb_prof;
 284 }
 285
 286 static CGColorSpaceRef CreateGenericRGBColorSpace( void )
 287 {
 288     static CGColorSpaceRef p_generic_rgb_cs = NULL;
 289
 290     if( p_generic_rgb_cs == NULL )
 291     {
 292         CMProfileRef generic_rgb_prof = OpenGenericProfile();
 293
 294         if( generic_rgb_prof )
 295         {
 296             p_generic_rgb_cs = CGColorSpaceCreateWithPlatformColorSpace( generic_rgb_prof );
 297
 298             CMCloseProfile( generic_rgb_prof );
 299         }
 300     }
 301
 302     return p_generic_rgb_cs;
 303 }
 304 #endif
 305
 306 static char *EliminateCRLF( char *psz_string )
 307 {
 308     char *p;
 309     char *q;
 310
 311     for( p = psz_string; p && *p; p++ )
 312     {
 313         if( ( *p == '\r' ) && ( *(p+1) == '\n' ) )
 314         {
 315             for( q = p + 1; *q; q++ )
 316                 *( q - 1 ) = *q;
 317
 318             *( q - 1 ) = '\0';
 319         }
 320     }
 321     return psz_string;
 322 }
 323
 324 // Convert UTF-8 string to UTF-16 character array -- internal Mac Endian-ness ;
 325 // we don't need to worry about bidirectional text conversion as ATSUI should
 326 // handle that for us automatically
 327 static void ConvertToUTF16( const char *psz_utf8_str, uint32_t *pi_strlen, UniChar **ppsz_utf16_str )
 328 {
 329     CFStringRef   p_cfString;
 330     int           i_string_length;
 331
 332     p_cfString = CFStringCreateWithCString( NULL, psz_utf8_str, kCFStringEncodingUTF8 );
 333     i_string_length = CFStringGetLength( p_cfString );
 334
 335     if( pi_strlen )
 336         *pi_strlen = i_string_length;
 337
 338     if( !*ppsz_utf16_str )
 339         *ppsz_utf16_str = (UniChar *) calloc( i_string_length, sizeof( UniChar ) );
 340
 341     CFStringGetCharacters( p_cfString, CFRangeMake( 0, i_string_length ), *ppsz_utf16_str );
 342
 343     CFRelease( p_cfString );
 344 }
 345
 346 // Renders a text subpicture region into another one.
 347 // It is used as pf_add_string callback in the vout method by this module
 348 static int RenderText( filter_t *p_filter, subpicture_region_t *p_region_out,
 349                        subpicture_region_t *p_region_in )
 350 {
 351     filter_sys_t *p_sys = p_filter->p_sys;
 352     UniChar      *psz_utf16_str = NULL;
 353     uint32_t      i_string_length;
 354     char         *psz_string;
 355     int           i_font_color, i_font_alpha, i_font_size;
 356
 357     // Sanity check
 358     if( !p_region_in || !p_region_out ) return VLC_EGENERIC;
 359     psz_string = p_region_in->psz_text;
 360     if( !psz_string || !*psz_string ) return VLC_EGENERIC;
 361
 362     if( p_region_in->p_style )
 363     {
 364         i_font_color = __MAX( __MIN( p_region_in->p_style->i_font_color, 0xFFFFFF ), 0 );
 365         i_font_alpha = __MAX( __MIN( p_region_in->p_style->i_font_alpha, 255 ), 0 );
 366         i_font_size  = __MAX( __MIN( p_region_in->p_style->i_font_size, 255 ), 0 );
 367     }
 368     else
 369     {
 370         i_font_color = p_sys->i_font_color;
 371         i_font_alpha = 255 - p_sys->i_font_opacity;
 372         i_font_size  = p_sys->i_font_size;
 373     }
 374
 375     if( !i_font_alpha ) i_font_alpha = 255 - p_sys->i_font_opacity;
 376
 377     ConvertToUTF16( EliminateCRLF( psz_string ), &i_string_length, &psz_utf16_str );
 378
 379     p_region_out->i_x = p_region_in->i_x;
 380     p_region_out->i_y = p_region_in->i_y;
 381
 382     if( psz_utf16_str != NULL )
 383     {
 384         ATSUStyle p_style = CreateStyle( p_sys->psz_font_name, i_font_size,
 385                                          i_font_color, i_font_alpha,
 386                                          VLC_FALSE, VLC_FALSE, VLC_FALSE );
 387         if( p_style )
 388         {
 389             RenderYUVA( p_filter, p_region_out, psz_utf16_str, i_string_length,
 390                         1, &i_string_length, &p_style );
 391         }
 392
 393         ATSUDisposeStyle( p_style );
 394         free( psz_utf16_str );
 395     }
 396
 397     return VLC_SUCCESS;
 398 }
 399
 400
 401 static ATSUStyle CreateStyle( char *psz_fontname, int i_font_size, int i_font_color, int i_font_alpha,
 402                               vlc_bool_t b_bold, vlc_bool_t b_italic, vlc_bool_t b_uline )
 403 {
 404     ATSUStyle   p_style;
 405     OSStatus    status;
 406     uint32_t    i_tag_cnt;
 407
 408     float f_red   = (float)(( i_font_color & 0x00FF0000 ) >> 16) / 255.0;
 409     float f_green = (float)(( i_font_color & 0x0000FF00 ) >>  8) / 255.0;
 410     float f_blue  = (float)(  i_font_color & 0x000000FF        ) / 255.0;
 411     float f_alpha = ( 255.0 - (float)i_font_alpha) / 255.0;
 412
 413     ATSUFontID           font;
 414     Fixed                font_size  = IntToFixed( i_font_size );
 415     ATSURGBAlphaColor    font_color = { f_red, f_green, f_blue, f_alpha };
 416     Boolean              bold       = b_bold;
 417     Boolean              italic     = b_italic;
 418     Boolean              uline      = b_uline;
 419
 420     ATSUAttributeTag tags[]        = { kATSUSizeTag, kATSURGBAlphaColorTag, kATSUQDItalicTag,
 421                                        kATSUQDBoldfaceTag, kATSUQDUnderlineTag, kATSUFontTag };
 422     ByteCount sizes[]              = { sizeof( Fixed ), sizeof( ATSURGBAlphaColor ), sizeof( Boolean ),
 423                                        sizeof( Boolean ), sizeof( Boolean ), sizeof( ATSUFontID )};
 424     ATSUAttributeValuePtr values[] = { &font_size, &font_color, &italic, &bold, &uline, &font };
 425
 426     i_tag_cnt = sizeof( tags ) / sizeof( ATSUAttributeTag );
 427
 428     status = ATSUFindFontFromName( psz_fontname,
 429                                    strlen( psz_fontname ),
 430                                    kFontFullName,
 431                                    kFontNoPlatform,
 432                                    kFontNoScript,
 433                                    kFontNoLanguageCode,
 434                                    &font );
 435
 436     if( status != noErr )
 437     {
 438         // If we can't find a suitable font, just do everything else
 439         i_tag_cnt--;
 440     }
 441
 442     if( noErr == ATSUCreateStyle( &p_style ) )
 443     {
 444         if( noErr == ATSUSetAttributes( p_style, i_tag_cnt, tags, sizes, values ) )
 445         {
 446             return p_style;
 447         }
 448         ATSUDisposeStyle( p_style );
 449     }
 450     return NULL;
 451 }
 452
 453 static int PushFont( font_stack_t **p_font, const char *psz_name, int i_size,
 454                      int i_color, int i_alpha )
 455 {
 456     font_stack_t *p_new;
 457
 458     if( !p_font )
 459         return VLC_EGENERIC;
 460
 461     p_new = malloc( sizeof( font_stack_t ) );
 462     if( ! p_new )
 463         return VLC_ENOMEM;
 464
 465     p_new->p_next = NULL;
 466
 467     if( psz_name )
 468         p_new->psz_name = strdup( psz_name );
 469     else
 470         p_new->psz_name = NULL;
 471
 472     p_new->i_size   = i_size;
 473     p_new->i_color  = i_color;
 474     p_new->i_alpha  = i_alpha;
 475
 476     if( !*p_font )
 477     {
 478         *p_font = p_new;
 479     }
 480     else
 481     {
 482         font_stack_t *p_last;
 483
 484         for( p_last = *p_font;
 485              p_last->p_next;
 486              p_last = p_last->p_next )
 487         ;
 488
 489         p_last->p_next = p_new;
 490     }
 491     return VLC_SUCCESS;
 492 }
 493
 494 static int PopFont( font_stack_t **p_font )
 495 {
 496     font_stack_t *p_last, *p_next_to_last;
 497
 498     if( !p_font || !*p_font )
 499         return VLC_EGENERIC;
 500
 501     p_next_to_last = NULL;
 502     for( p_last = *p_font;
 503          p_last->p_next;
 504          p_last = p_last->p_next )
 505     {
 506         p_next_to_last = p_last;
 507     }
 508
 509     if( p_next_to_last )
 510         p_next_to_last->p_next = NULL;
 511     else
 512         *p_font = NULL;
 513
 514     free( p_last->psz_name );
 515     free( p_last );
 516
 517     return VLC_SUCCESS;
 518 }
 519
 520 static int PeekFont( font_stack_t **p_font, char **psz_name, int *i_size,
 521                      int *i_color, int *i_alpha )
 522 {
 523     font_stack_t *p_last;
 524
 525     if( !p_font || !*p_font )
 526         return VLC_EGENERIC;
 527
 528     for( p_last=*p_font;
 529          p_last->p_next;
 530          p_last=p_last->p_next )
 531     ;
 532
 533     *psz_name = p_last->psz_name;
 534     *i_size   = p_last->i_size;
 535     *i_color  = p_last->i_color;
 536     *i_alpha  = p_last->i_alpha;
 537
 538     return VLC_SUCCESS;
 539 }
 540
 541 static ATSUStyle GetStyleFromFontStack( filter_sys_t *p_sys, font_stack_t **p_fonts,
 542                               vlc_bool_t b_bold, vlc_bool_t b_italic, vlc_bool_t b_uline )
 543 {
 544     ATSUStyle   p_style = NULL;
 545
 546     char  *psz_fontname = NULL;
 547     int    i_font_color = p_sys->i_font_color;
 548     int    i_font_alpha = 0;
 549     int    i_font_size  = p_sys->i_font_size;
 550
 551     if( VLC_SUCCESS == PeekFont( p_fonts, &psz_fontname, &i_font_size, &i_font_color, &i_font_alpha ) )
 552     {
 553         p_style = CreateStyle( psz_fontname, i_font_size, i_font_color, i_font_alpha,
 554                                b_bold, b_italic, b_uline );
 555     }
 556     return p_style;
 557 }
 558
 559 static void ProcessNodes( filter_t *p_filter, xml_reader_t *p_xml_reader,
 560                           text_style_t *p_font_style, UniChar *psz_text, int *pi_len,
 561                           uint32_t *pi_runs, uint32_t **ppi_run_lengths,
 562                           ATSUStyle **ppp_styles)
 563 {
 564     filter_sys_t *p_sys          = p_filter->p_sys;
 565     UniChar      *psz_text_orig  = psz_text;
 566     font_stack_t *p_fonts        = NULL;
 567
 568     char *psz_node  = NULL;
 569
 570     vlc_bool_t b_italic = VLC_FALSE;
 571     vlc_bool_t b_bold   = VLC_FALSE;
 572     vlc_bool_t b_uline  = VLC_FALSE;
 573
 574     if( p_font_style )
 575     {
 576         rv = PushFont( &p_fonts,
 577                p_font_style->psz_fontname,
 578                p_font_style->i_font_size,
 579                p_font_style->i_font_color,
 580                   p_font_style->i_font_alpha );
 581
 582         if( p_font_style->i_style_flags & STYLE_BOLD )
 583             b_bold = VLC_TRUE;
 584         if( p_font_style->i_style_flags & STYLE_ITALIC )
 585             b_italic = VLC_TRUE;
 586         if( p_font_style->i_style_flags & STYLE_UNDERLINE )
 587             b_uline = VLC_TRUE;
 588     }
 589     else
 590     {
 591         rv = PushFont( &p_fonts,
 592                        p_sys->psz_font_name,
 593                        p_sys->i_font_size,
 594                        p_sys->i_font_color, 0 );
 595     }
 596     if( rv != VLC_SUCCESS )
 597         return rv;
 598
 599     while ( ( xml_ReaderRead( p_xml_reader ) == 1 ) )
 600     {
 601         switch ( xml_ReaderNodeType( p_xml_reader ) )
 602         {
 603             case XML_READER_NONE:
 604                 break;
 605             case XML_READER_ENDELEM:
 606                 psz_node = xml_ReaderName( p_xml_reader );
 607
 608                 if( psz_node )
 609                 {
 610                     if( !strcasecmp( "font", psz_node ) )
 611                         PopFont( &p_fonts );
 612                     else if( !strcasecmp( "b", psz_node ) )
 613                         b_bold   = VLC_FALSE;
 614                     else if( !strcasecmp( "i", psz_node ) )
 615                         b_italic = VLC_FALSE;
 616                     else if( !strcasecmp( "u", psz_node ) )
 617                         b_uline  = VLC_FALSE;
 618
 619                     free( psz_node );
 620                 }
 621                 break;
 622             case XML_READER_STARTELEM:
 623                 psz_node = xml_ReaderName( p_xml_reader );
 624                 if( psz_node )
 625                 {
 626                     if( !strcasecmp( "font", psz_node ) )
 627                     {
 628                         char *psz_fontname = NULL;
 629                         int   i_font_color = 0xffffff;
 630                         int   i_font_alpha = 0;
 631                         int   i_font_size  = 24;
 632
 633                         // Default all attributes to the top font in the stack -- in case not
 634                         // all attributes are specified in the sub-font
 635                         if( VLC_SUCCESS == PeekFont( &p_fonts, &psz_fontname, &i_font_size, &i_font_color, &i_font_alpha ))
 636                         {
 637                             psz_fontname = strdup( psz_fontname );
 638                         }
 639
 640                         while ( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
 641                         {
 642                             char *psz_name = xml_ReaderName ( p_xml_reader );
 643                             char *psz_value = xml_ReaderValue ( p_xml_reader );
 644
 645                             if( psz_name && psz_value )
 646                             {
 647                                 if( !strcasecmp( "face", psz_name ) )
 648                                 {
 649                                     if( psz_fontname ) free( psz_fontname );
 650                                     psz_fontname = strdup( psz_value );
 651                                 }
 652                                 else if( !strcasecmp( "size", psz_name ) )
 653                                 {
 654                                     if( ( *psz_value == '+' ) || ( *psz_value == '-' ) )
 655                                     {
 656                                         int i_value = atoi( psz_value );
 657
 658                                         if( ( i_value >= -5 ) && ( i_value <= 5 ) )
 659                                             i_font_size += ( i_value * i_font_size ) / 10;
 660                                         else if( i_value < -5 )
 661                                             i_font_size = - i_value;
 662                                         else if( i_value > 5 )
 663                                             i_font_size = i_value;
 664                                     }
 665                                     else
 666                                         i_font_size = atoi( psz_value );
 667                                 }
 668                                 else if( !strcasecmp( "color", psz_name )  &&
 669                                          ( psz_value[0] == '#' ) )
 670                                 {
 671                                     i_font_color = strtol( psz_value+1, NULL, 16 );
 672                                     i_font_color &= 0x00ffffff;
 673                                 }
 674                                 else if( !strcasecmp( "alpha", psz_name ) &&
 675                                          ( psz_value[0] == '#' ) )
 676                                 {
 677                                     i_font_alpha = strtol( psz_value+1, NULL, 16 );
 678                                     i_font_alpha &= 0xff;
 679                                 }
 680                                 free( psz_name );
 681                                 free( psz_value );
 682                             }
 683                         }
 684                         PushFont( &p_fonts, psz_fontname, i_font_size, i_font_color, i_font_alpha );
 685                         free( psz_fontname );
 686                     }
 687                     else if( !strcasecmp( "b", psz_node ) )
 688                     {
 689                         b_bold = VLC_TRUE;
 690                     }
 691                     else if( !strcasecmp( "i", psz_node ) )
 692                     {
 693                         b_italic = VLC_TRUE;
 694                     }
 695                     else if( !strcasecmp( "u", psz_node ) )
 696                     {
 697                         b_uline = VLC_TRUE;
 698                     }
 699                     else if( !strcasecmp( "br", psz_node ) )
 700                     {
 701                         uint32_t i_string_length;
 702
 703                         ConvertToUTF16( "\n", &i_string_length, &psz_text );
 704                         psz_text += i_string_length;
 705
 706                         (*pi_runs)++;
 707
 708                         if( *ppp_styles )
 709                             *ppp_styles = (ATSUStyle *) realloc( *ppp_styles, *pi_runs * sizeof( ATSUStyle ) );
 710                         else
 711                             *ppp_styles = (ATSUStyle *) malloc( *pi_runs * sizeof( ATSUStyle ) );
 712
 713                         (*ppp_styles)[ *pi_runs - 1 ] = GetStyleFromFontStack( p_sys, &p_fonts, b_bold, b_italic, b_uline );
 714
 715                         if( *ppi_run_lengths )
 716                             *ppi_run_lengths = (uint32_t *) realloc( *ppi_run_lengths, *pi_runs * sizeof( uint32_t ) );
 717                         else
 718                             *ppi_run_lengths = (uint32_t *) malloc( *pi_runs * sizeof( uint32_t ) );
 719
 720                         (*ppi_run_lengths)[ *pi_runs - 1 ] = i_string_length;
 721                     }
 722                     free( psz_node );
 723                 }
 724                 break;
 725             case XML_READER_TEXT:
 726                 psz_node = xml_ReaderValue( p_xml_reader );
 727                 if( psz_node )
 728                 {
 729                     uint32_t i_string_length;
 730
 731                     // Turn any multiple-whitespaces into single spaces
 732                     char *s = strpbrk( psz_node, "\t\r\n " );
 733                     while( s )
 734                     {
 735                         int i_whitespace = strspn( s, "\t\r\n " );
 736
 737                         if( i_whitespace > 1 )
 738                             memmove( &s[1],
 739                                      &s[i_whitespace],
 740                                      strlen( s ) - i_whitespace + 1 );
 741                         *s++ = ' ';
 742
 743                         s = strpbrk( s, "\t\r\n " );
 744                     }
 745
 746                     ConvertToUTF16( psz_node, &i_string_length, &psz_text );
 747                     psz_text += i_string_length;
 748
 749                     (*pi_runs)++;
 750
 751                     if( *ppp_styles )
 752                         *ppp_styles = (ATSUStyle *) realloc( *ppp_styles, *pi_runs * sizeof( ATSUStyle ) );
 753                     else
 754                         *ppp_styles = (ATSUStyle *) malloc( *pi_runs * sizeof( ATSUStyle ) );
 755
 756                     (*ppp_styles)[ *pi_runs - 1 ] = GetStyleFromFontStack( p_sys, &p_fonts, b_bold, b_italic, b_uline );
 757
 758                     if( *ppi_run_lengths )
 759                         *ppi_run_lengths = (uint32_t *) realloc( *ppi_run_lengths, *pi_runs * sizeof( uint32_t ) );
 760                     else
 761                         *ppi_run_lengths = (uint32_t *) malloc( *pi_runs * sizeof( uint32_t ) );
 762
 763                     (*ppi_run_lengths)[ *pi_runs - 1 ] = i_string_length;
 764
 765                     free( psz_node );
 766                 }
 767                 break;
 768         }
 769     }
 770
 771     *pi_len = psz_text - psz_text_orig;
 772
 773     while( VLC_SUCCESS == PopFont( &p_fonts ) );
 774 }
 775
 776 static int RenderHtml( filter_t *p_filter, subpicture_region_t *p_region_out,
 777                        subpicture_region_t *p_region_in )
 778 {
 779     int          rv = VLC_SUCCESS;
 780     stream_t     *p_sub = NULL;
 781     xml_t        *p_xml = NULL;
 782     xml_reader_t *p_xml_reader = NULL;
 783
 784     if( !p_region_in || !p_region_in->psz_html )
 785         return VLC_EGENERIC;
 786
 787     p_sub = stream_MemoryNew( VLC_OBJECT(p_filter),
 788                               (uint8_t *) p_region_in->psz_html,
 789                               strlen( p_region_in->psz_html ),
 790                               VLC_TRUE );
 791     if( p_sub )
 792     {
 793         p_xml = xml_Create( p_filter );
 794         if( p_xml )
 795         {
 796             p_xml_reader = xml_ReaderCreate( p_xml, p_sub );
 797             if( p_xml_reader )
 798             {
 799                 UniChar    *psz_text;
 800                 int         i_len;
 801                 uint32_t    i_runs = 0;
 802                 uint32_t   *pi_run_lengths = NULL;
 803                 ATSUStyle  *pp_styles = NULL;
 804
 805                 psz_text = (UniChar *) calloc( strlen( p_region_in->psz_html ), sizeof( UniChar ) );
 806                 if( psz_text )
 807                 {
 808                     uint32_t k;
 809
 810                     ProcessNodes( p_filter, p_xml_reader, p_region_in->p_style, psz_text,
 811                                   &i_len, &i_runs, &pi_run_lengths, &pp_styles );
 812
 813                     p_region_out->i_x = p_region_in->i_x;
 814                     p_region_out->i_y = p_region_in->i_y;
 815
 816                     RenderYUVA( p_filter, p_region_out, psz_text, i_len, i_runs, pi_run_lengths, pp_styles);
 817
 818                     for( k=0; k<i_runs; k++)
 819                         ATSUDisposeStyle( pp_styles[k] );
 820                     free( pp_styles );
 821                     free( pi_run_lengths );
 822
 823                     free( psz_text );
 824                 }
 825
 826                 xml_ReaderDelete( p_xml, p_xml_reader );
 827             }
 828             xml_Delete( p_xml );
 829         }
 830         stream_Delete( p_sub );
 831     }
 832
 833     return rv;
 834 }
 835
 836 static CGContextRef CreateOffScreenContext( int i_width, int i_height,
 837                          offscreen_bitmap_t **pp_memory, CGColorSpaceRef *pp_colorSpace )
 838 {
 839     offscreen_bitmap_t *p_bitmap;
 840     CGContextRef        p_context = NULL;
 841
 842     p_bitmap = (offscreen_bitmap_t *) malloc( sizeof( offscreen_bitmap_t ));
 843     if( p_bitmap )
 844     {
 845         p_bitmap->i_bitsPerChannel = 8;
 846         p_bitmap->i_bitsPerPixel   = 4 * p_bitmap->i_bitsPerChannel; // A,R,G,B
 847         p_bitmap->i_bytesPerPixel  = p_bitmap->i_bitsPerPixel / 8;
 848         p_bitmap->i_bytesPerRow    = i_width * p_bitmap->i_bytesPerPixel;
 849
 850         p_bitmap->p_data = calloc( i_height, p_bitmap->i_bytesPerRow );
 851
 852 #if MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_X_VERSION_10_4
 853         *pp_colorSpace = CGColorSpaceCreateWithName( kCGColorSpaceGenericRGB );
 854 #else
 855         *pp_colorSpace = CreateGenericRGBColorSpace();
 856 #endif
 857
 858         if( p_bitmap->p_data && *pp_colorSpace )
 859         {
 860             p_context = CGBitmapContextCreate( p_bitmap->p_data, i_width, i_height,
 861                                 p_bitmap->i_bitsPerChannel, p_bitmap->i_bytesPerRow,
 862                                 *pp_colorSpace, kCGImageAlphaPremultipliedFirst);
 863         }
 864         if( p_context )
 865         {
 866 #if MAC_OS_X_VERSION_MIN_REQUIRED > MAC_OS_X_VERSION_10_1
 867             // OS X 10.1 doesn't support weak linking of this call which is only available
 868             // int 10.4 and later
 869             if( CGContextSetAllowsAntialiasing != NULL )
 870             {
 871                 CGContextSetAllowsAntialiasing( p_context, true );
 872             }
 873 #endif
 874         }
 875         *pp_memory = p_bitmap;
 876     }
 877
 878     return p_context;
 879 }
 880
 881 static offscreen_bitmap_t *Compose( int i_text_align, UniChar *psz_utf16_str, uint32_t i_text_len,
 882                                     uint32_t i_runs, uint32_t *pi_run_lengths, ATSUStyle *pp_styles,
 883                                     int i_width, int i_height, int *pi_textblock_height )
 884 {
 885     offscreen_bitmap_t  *p_offScreen  = NULL;
 886     CGColorSpaceRef      p_colorSpace = NULL;
 887     CGContextRef         p_context = NULL;
 888
 889     p_context = CreateOffScreenContext( i_width, i_height, &p_offScreen, &p_colorSpace );
 890
 891     if( p_context )
 892     {
 893         ATSUTextLayout p_textLayout;
 894         OSStatus status = noErr;
 895
 896         status = ATSUCreateTextLayoutWithTextPtr( psz_utf16_str, 0, i_text_len, i_text_len,
 897                                                   i_runs,
 898                                                   (const UniCharCount *) pi_run_lengths,
 899                                                   pp_styles,
 900                                                   &p_textLayout );
 901         if( status == noErr )
 902         {
 903             // Attach our offscreen Image Graphics Context to the text style
 904             // and setup the line alignment (have to specify the line width
 905             // also in order for our chosen alignment to work)
 906
 907             Fract   alignment  = kATSUStartAlignment;
 908             Fixed   line_width = Long2Fix( i_width - HORIZONTAL_MARGIN * 2 );
 909
 910             ATSUAttributeTag tags[]        = { kATSUCGContextTag, kATSULineFlushFactorTag, kATSULineWidthTag };
 911             ByteCount sizes[]              = { sizeof( CGContextRef ), sizeof( Fract ), sizeof( Fixed ) };
 912             ATSUAttributeValuePtr values[] = { &p_context, &alignment, &line_width };
 913
 914             int i_tag_cnt = sizeof( tags ) / sizeof( ATSUAttributeTag );
 915
 916             if( i_text_align == SUBPICTURE_ALIGN_RIGHT )
 917             {
 918                 alignment = kATSUEndAlignment;
 919             }
 920             else if( i_text_align != SUBPICTURE_ALIGN_LEFT )
 921             {
 922                 alignment = kATSUCenterAlignment;
 923             }
 924
 925             ATSUSetLayoutControls( p_textLayout, i_tag_cnt, tags, sizes, values );
 926
 927             // let ATSUI deal with characters not-in-our-specified-font
 928             ATSUSetTransientFontMatching( p_textLayout, true );
 929
 930             Fixed x = Long2Fix( HORIZONTAL_MARGIN );
 931             Fixed y = Long2Fix( i_height );
 932
 933             // Set the line-breaks and draw individual lines
 934             uint32_t i_start = 0;
 935             uint32_t i_end = i_text_len;
 936
 937             // Set up black outlining of the text --
 938             CGContextSetRGBStrokeColor( p_context, 0, 0, 0, 0.5 );
 939             CGContextSetTextDrawingMode( p_context, kCGTextFillStroke );
 940
 941             do
 942             {
 943                 // ATSUBreakLine will automatically pick up any manual '\n's also
 944                 status = ATSUBreakLine( p_textLayout, i_start, line_width, true, (UniCharArrayOffset *) &i_end );
 945                 if( ( status == noErr ) || ( status == kATSULineBreakInWord ) )
 946                 {
 947                     Fixed     ascent;
 948                     Fixed     descent;
 949                     uint32_t  i_actualSize;
 950
 951                     // Come down far enough to fit the height of this line --
 952                     ATSUGetLineControl( p_textLayout, i_start, kATSULineAscentTag,
 953                                     sizeof( Fixed ), &ascent, (ByteCount *) &i_actualSize );
 954
 955                     // Quartz uses an upside-down co-ordinate space -> y values decrease as
 956                     // you move down the page
 957                     y -= ascent;
 958
 959                     // Set the outlining for this line to be dependant on the size of the line -
 960                     // make it about 5% of the ascent, with a minimum at 1.0
 961                     float f_thickness = FixedToFloat( ascent ) * 0.05;
 962                     CGContextSetLineWidth( p_context, (( f_thickness > 1.0 ) ? 1.0 : f_thickness ));
 963
 964                     ATSUDrawText( p_textLayout, i_start, i_end - i_start, x, y );
 965
 966                     // and now prepare for the next line by coming down far enough for our
 967                     // descent
 968                     ATSUGetLineControl( p_textLayout, i_start, kATSULineDescentTag,
 969                                     sizeof( Fixed ), &descent, (ByteCount *) &i_actualSize );
 970                     y -= descent;
 971
 972                     i_start = i_end;
 973                 }
 974                 else
 975                     break;
 976             }
 977             while( i_end < i_text_len );
 978
 979             *pi_textblock_height = i_height - Fix2Long( y );
 980             CGContextFlush( p_context );
 981
 982             ATSUDisposeTextLayout( p_textLayout );
 983         }
 984
 985         CGContextRelease( p_context );
 986     }
 987     if( p_colorSpace ) CGColorSpaceRelease( p_colorSpace );
 988
 989     return p_offScreen;
 990 }
 991
 992 static int RenderYUVA( filter_t *p_filter, subpicture_region_t *p_region, UniChar *psz_utf16_str,
 993                        uint32_t i_text_len, uint32_t i_runs, uint32_t *pi_run_lengths, ATSUStyle *pp_styles )
 994 {
 995     offscreen_bitmap_t *p_offScreen = NULL;
 996     int      i_textblock_height = 0;
 997
 998     int i_width = p_filter->fmt_out.video.i_visible_width;
 999     int i_height = p_filter->fmt_out.video.i_visible_height;
1000     int i_text_align = p_region->i_align & 0x3;
1001
1002     if( !psz_utf16_str )
1003     {
1004         msg_Err( p_filter, "Invalid argument to RenderYUVA" );
1005         return VLC_EGENERIC;
1006     }
1007
1008     p_offScreen = Compose( i_text_align, psz_utf16_str, i_text_len,
1009                            i_runs, pi_run_lengths, pp_styles,
1010                            i_width, i_height, &i_textblock_height );
1011
1012     if( !p_offScreen )
1013     {
1014         msg_Err( p_filter, "No offscreen buffer" );
1015         return VLC_EGENERIC;
1016     }
1017
1018     uint8_t *p_dst_y,*p_dst_u,*p_dst_v,*p_dst_a;
1019     video_format_t fmt;
1020     int x, y, i_offset, i_pitch;
1021     uint8_t i_y, i_u, i_v; // YUV values, derived from incoming RGB
1022     subpicture_region_t *p_region_tmp;
1023
1024     // Create a new subpicture region
1025     memset( &fmt, 0, sizeof(video_format_t) );
1026     fmt.i_chroma = VLC_FOURCC('Y','U','V','A');
1027     fmt.i_aspect = 0;
1028     fmt.i_width = fmt.i_visible_width = i_width;
1029     fmt.i_height = fmt.i_visible_height = i_textblock_height + VERTICAL_MARGIN * 2;
1030     fmt.i_x_offset = fmt.i_y_offset = 0;
1031     p_region_tmp = spu_CreateRegion( p_filter, &fmt );
1032     if( !p_region_tmp )
1033     {
1034         msg_Err( p_filter, "cannot allocate SPU region" );
1035         return VLC_EGENERIC;
1036     }
1037     p_region->fmt = p_region_tmp->fmt;
1038     p_region->picture = p_region_tmp->picture;
1039     free( p_region_tmp );
1040
1041     p_dst_y = p_region->picture.Y_PIXELS;
1042     p_dst_u = p_region->picture.U_PIXELS;
1043     p_dst_v = p_region->picture.V_PIXELS;
1044     p_dst_a = p_region->picture.A_PIXELS;
1045     i_pitch = p_region->picture.A_PITCH;
1046
1047     i_offset = VERTICAL_MARGIN *i_pitch;
1048     for( y=0; y<i_textblock_height; y++)
1049     {
1050         for( x=0; x<i_width; x++)
1051         {
1052             int i_alpha = p_offScreen->p_data[ y * p_offScreen->i_bytesPerRow + x * p_offScreen->i_bytesPerPixel     ];
1053             int i_red   = p_offScreen->p_data[ y * p_offScreen->i_bytesPerRow + x * p_offScreen->i_bytesPerPixel + 1 ];
1054             int i_green = p_offScreen->p_data[ y * p_offScreen->i_bytesPerRow + x * p_offScreen->i_bytesPerPixel + 2 ];
1055             int i_blue  = p_offScreen->p_data[ y * p_offScreen->i_bytesPerRow + x * p_offScreen->i_bytesPerPixel + 3 ];
1056
1057             i_y = (uint8_t)__MIN(abs( 2104 * i_red  + 4130 * i_green +
1058                               802 * i_blue + 4096 + 131072 ) >> 13, 235);
1059             i_u = (uint8_t)__MIN(abs( -1214 * i_red  + -2384 * i_green +
1060                              3598 * i_blue + 4096 + 1048576) >> 13, 240);
1061             i_v = (uint8_t)__MIN(abs( 3598 * i_red + -3013 * i_green +
1062                               -585 * i_blue + 4096 + 1048576) >> 13, 240);
1063
1064             p_dst_y[ i_offset + x ] = i_y;
1065             p_dst_u[ i_offset + x ] = i_u;
1066             p_dst_v[ i_offset + x ] = i_v;
1067             p_dst_a[ i_offset + x ] = i_alpha;
1068         }
1069         i_offset += i_pitch;
1070     }
1071
1072     free( p_offScreen->p_data );
1073     free( p_offScreen );
1074
1075     return VLC_SUCCESS;
1076 }