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

   1 /*****************************************************************************
   2  * svg.c : Put SVG on the video
   3  *****************************************************************************
   4  * Copyright (C) 2002, 2003 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Olivier Aubert <oaubert@lisi.univ-lyon1.fr>
   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 #include <stdlib.h>                                      /* malloc( ), free( ) */
  28 #include <string.h>
  29
  30 #ifdef HAVE_SYS_TYPES_H
  31 #   include <sys/types.h>
  32 #endif
  33 #include <sys/stat.h>
  34
  35 #ifdef HAVE_UNISTD_H
  36 #    include <unistd.h>
  37 #elif defined( WIN32 ) && !defined( UNDER_CE )
  38 #   include <io.h>
  39 #endif
  40
  41 #include <vlc/vlc.h>
  42 #include <vlc/vout.h>
  43 #include "vlc_osd.h"
  44 #include "vlc_block.h"
  45 #include "vlc_filter.h"
  46
  47 #include <librsvg-2/librsvg/rsvg.h>
  48
  49 typedef struct svg_rendition_t svg_rendition_t;
  50
  51 /*****************************************************************************
  52  * Local prototypes
  53  *****************************************************************************/
  54 static int  Create    ( vlc_object_t * );
  55 static void Destroy   ( vlc_object_t * );
  56 static int RenderText( filter_t *p_filter, subpicture_region_t *p_region_out,
  57                        subpicture_region_t *p_region_in );
  58
  59
  60 /*****************************************************************************
  61  * Module descriptor
  62  *****************************************************************************/
  63
  64 #define TEMPLATE_TEXT N_( "SVG template file" )
  65 #define TEMPLATE_LONGTEXT N_( "Location of a file holding a SVG template "\
  66         "for automatic string conversion" )
  67
  68 vlc_module_begin();
  69  set_category( CAT_INPUT);
  70  set_category( SUBCAT_INPUT_SCODEC );
  71  set_capability( "text renderer", 101 );
  72  add_shortcut( "svg" );
  73  add_string( "svg-template-file", "", NULL, TEMPLATE_TEXT, TEMPLATE_LONGTEXT, VLC_TRUE );
  74  set_callbacks( Create, Destroy );
  75 vlc_module_end();
  76
  77 /**
  78    Describes a SVG string to be displayed on the video
  79 */
  80 struct svg_rendition_t
  81 {
  82     int            i_width;
  83     int            i_height;
  84     int            i_chroma;
  85     /** The SVG source associated with this subpicture */
  86     char           *psz_text;
  87     /* The rendered SVG, as a GdkPixbuf */
  88     GdkPixbuf      *p_rendition;
  89 };
  90
  91 static int Render( filter_t *, subpicture_region_t *, svg_rendition_t *, int, int);
  92 static char *svg_GetTemplate ();
  93 static void svg_set_size( filter_t *p_filter, int width, int height );
  94 static void svg_SizeCallback  ( int *width, int *height, gpointer data );
  95 static void svg_RenderPicture ( filter_t *p_filter,
  96                                 svg_rendition_t *p_svg );
  97 static void FreeString( svg_rendition_t * );
  98
  99 /*****************************************************************************
 100  * filter_sys_t: svg local data
 101  *****************************************************************************
 102  * This structure is part of the filter thread descriptor.
 103  * It describes the svg specific properties of an output thread.
 104  *****************************************************************************/
 105 struct filter_sys_t
 106 {
 107     /* The SVG template used to convert strings */
 108     char          *psz_template;
 109     /* Default size for rendering. Initialized to the output size. */
 110     int            i_width;
 111     int            i_height;
 112     vlc_mutex_t   *lock;
 113 };
 114
 115 /*****************************************************************************
 116  * Create: allocates svg video thread output method
 117  *****************************************************************************
 118  * This function allocates and initializes a  vout method.
 119  *****************************************************************************/
 120 static int Create( vlc_object_t *p_this )
 121 {
 122     filter_t *p_filter = ( filter_t * )p_this;
 123     filter_sys_t *p_sys;
 124
 125     /* Allocate structure */
 126     p_sys = malloc( sizeof( filter_sys_t ) );
 127     if( !p_sys )
 128     {
 129         msg_Err( p_filter, "out of memory" );
 130         return VLC_ENOMEM;
 131     }
 132
 133     /* Initialize psz_template */
 134     p_sys->psz_template = svg_GetTemplate( p_this );
 135     if( !p_sys->psz_template )
 136     {
 137         msg_Err( p_filter, "out of memory" );
 138         return VLC_ENOMEM;
 139     }
 140
 141     p_sys->i_width = p_filter->fmt_out.video.i_width;
 142     p_sys->i_height = p_filter->fmt_out.video.i_height;
 143
 144     p_filter->pf_render_text = RenderText;
 145     p_filter->p_sys = p_sys;
 146
 147     /* MUST call this before any RSVG funcs */
 148     g_type_init ();
 149
 150     return VLC_SUCCESS;
 151 }
 152
 153 static char *svg_GetTemplate( vlc_object_t *p_this )
 154 {
 155     filter_t *p_filter = ( filter_t * )p_this;
 156     char *psz_filename;
 157     char *psz_template;
 158     FILE *file;
 159
 160     psz_filename = config_GetPsz( p_filter, "svg-template-file" );
 161     if( !psz_filename || psz_filename[0] == 0 )
 162     {
 163         /* No filename. Use a default value. */
 164         psz_template = NULL;
 165     }
 166     else
 167     {
 168         /* Read the template */
 169         file = utf8_fopen( psz_filename, "rt" );
 170         if( !file )
 171         {
 172             msg_Warn( p_this, "SVG template file %s does not exist.",
 173                                          psz_filename );
 174             psz_template = NULL;
 175         }
 176         else
 177         {
 178             struct stat s;
 179             int i_ret;
 180
 181             i_ret = utf8_stat( psz_filename, &s );
 182             if( i_ret )
 183             {
 184                 /* Problem accessing file information. Should not
 185                    happen as we could open it. */
 186                 psz_template = NULL;
 187             }
 188             else
 189             if( ((signed)s.st_size) < 0 )
 190             {
 191                 msg_Err( p_this, "SVG template too big" );
 192                 psz_template = NULL;
 193             }
 194             else
 195             {
 196                 msg_Dbg( p_this, "reading %ld bytes from template %s",
 197                          (unsigned long)s.st_size, psz_filename );
 198
 199                 psz_template = malloc( s.st_size + 42 );
 200                 if( !psz_template )
 201                 {
 202                     msg_Err( p_filter, "out of memory" );
 203                     return NULL;
 204                 }
 205                 memset( psz_template, 0, s.st_size + 1 );
 206                 fread( psz_template, s.st_size, 1, file );
 207                 fclose( file );
 208             }
 209         }
 210     }
 211     if( !psz_template )
 212     {
 213         /* Either there was no file, or there was an error.
 214            Use the default value */
 215         psz_template = strdup( "<?xml version='1.0' encoding='UTF-8' standalone='no'?> \
 216 <svg version='1' preserveAspectRatio='xMinYMin meet' viewBox='0 0 800 600'> \
 217   <text x='10' y='560' fill='white' font-size='32'  \
 218         font-family='sans-serif'>%s</text></svg>" );
 219     }
 220
 221     return psz_template;
 222 }
 223
 224 /*****************************************************************************
 225  * Destroy: destroy Clone video thread output method
 226  *****************************************************************************
 227  * Clean up all data and library connections
 228  *****************************************************************************/
 229 static void Destroy( vlc_object_t *p_this )
 230 {
 231     filter_t *p_filter = ( filter_t * )p_this;
 232     filter_sys_t *p_sys = p_filter->p_sys;
 233
 234     free( p_sys->psz_template );
 235     free( p_sys );
 236 }
 237
 238 /*****************************************************************************
 239  * Render: render SVG in picture
 240  *****************************************************************************/
 241 static int Render( filter_t *p_filter, subpicture_region_t *p_region,
 242                    svg_rendition_t *p_svg, int i_width, int i_height )
 243 {
 244     video_format_t fmt;
 245     uint8_t *p_y, *p_u, *p_v, *p_a;
 246     int x, y, i_pitch, i_u_pitch;
 247     guchar *pixels_in = NULL;
 248     int rowstride_in;
 249     int channels_in;
 250     int alpha;
 251     picture_t *p_pic;
 252     subpicture_region_t *p_region_tmp;
 253
 254     if ( p_filter->p_sys->i_width != i_width ||
 255          p_filter->p_sys->i_height != i_height )
 256     {
 257         svg_set_size( p_filter, i_width, i_height );
 258         p_svg->p_rendition = NULL;
 259     }
 260
 261     if( p_svg->p_rendition == NULL ) {
 262         svg_RenderPicture( p_filter, p_svg );
 263         /* FIXME: should do a check here to ensure that
 264            the rendition went OK */
 265     }
 266     i_width = gdk_pixbuf_get_width( p_svg->p_rendition );
 267     i_height = gdk_pixbuf_get_height( p_svg->p_rendition );
 268
 269     /* Create a new subpicture region */
 270     memset( &fmt, 0, sizeof( video_format_t ) );
 271     fmt.i_chroma = VLC_FOURCC( 'Y','U','V','A' );
 272     fmt.i_aspect = VOUT_ASPECT_FACTOR;
 273     fmt.i_width = fmt.i_visible_width = i_width;
 274     fmt.i_height = fmt.i_visible_height = i_height;
 275     fmt.i_x_offset = fmt.i_y_offset = 0;
 276     p_region_tmp = spu_CreateRegion( p_filter, &fmt );
 277     if( !p_region_tmp )
 278     {
 279         msg_Err( p_filter, "cannot allocate SPU region" );
 280         return VLC_EGENERIC;
 281     }
 282     p_region->fmt = p_region_tmp->fmt;
 283     p_region->picture = p_region_tmp->picture;
 284     free( p_region_tmp );
 285
 286     p_region->i_x = p_region->i_y = 0;
 287     p_y = p_region->picture.Y_PIXELS;
 288     p_u = p_region->picture.U_PIXELS;
 289     p_v = p_region->picture.V_PIXELS;
 290     p_a = p_region->picture.A_PIXELS;
 291
 292     i_pitch = p_region->picture.Y_PITCH;
 293     i_u_pitch = p_region->picture.U_PITCH;
 294
 295     /* Initialize the region pixels (only the alpha will be changed later) */
 296     memset( p_y, 0x00, i_pitch * p_region->fmt.i_height );
 297     memset( p_u, 0x80, i_u_pitch * p_region->fmt.i_height );
 298     memset( p_v, 0x80, i_u_pitch * p_region->fmt.i_height );
 299
 300     p_pic = &p_region->picture;
 301
 302     /* Copy the data */
 303
 304     /* This rendering code is in no way optimized. If someone has some time to
 305        make it work faster or better, please do.
 306     */
 307
 308     /*
 309       p_pixbuf->get_rowstride() is the number of bytes in a line.
 310       p_pixbuf->get_height() is the number of lines.
 311
 312       The number of bytes of p_pixbuf->p_pixels is get_rowstride * get_height
 313
 314       if( has_alpha() ) {
 315       alpha = pixels [ n_channels * ( y*rowstride + x ) + 3 ];
 316       }
 317       red   = pixels [ n_channels * ( y*rowstride ) + x ) ];
 318       green = pixels [ n_channels * ( y*rowstride ) + x ) + 1 ];
 319       blue  = pixels [ n_channels * ( y*rowstride ) + x ) + 2 ];
 320     */
 321
 322     pixels_in = gdk_pixbuf_get_pixels( p_svg->p_rendition );
 323     rowstride_in = gdk_pixbuf_get_rowstride( p_svg->p_rendition );
 324     channels_in = gdk_pixbuf_get_n_channels( p_svg->p_rendition );
 325     alpha = gdk_pixbuf_get_has_alpha( p_svg->p_rendition );
 326
 327     /*
 328       This crashes the plugin (if !alpha). As there is always an alpha value,
 329       it does not matter for the moment :
 330
 331     if( !alpha )
 332       memset( p_a, 0xFF, i_pitch * p_region->fmt.i_height );
 333     */
 334
 335 #define INDEX_IN( x, y ) ( y * rowstride_in + x * channels_in )
 336 #define INDEX_OUT( x, y ) ( y * i_pitch + x * p_pic->p[Y_PLANE].i_pixel_pitch )
 337
 338     for( y = 0; y < i_height; y++ )
 339     {
 340         for( x = 0; x < i_width; x++ )
 341         {
 342             guchar *p_in;
 343             int i_out;
 344
 345             p_in = &pixels_in[INDEX_IN( x, y )];
 346
 347 #define R( pixel ) *pixel
 348 #define G( pixel ) *( pixel+1 )
 349 #define B( pixel ) *( pixel+2 )
 350 #define ALPHA( pixel ) *( pixel+3 )
 351
 352             /* From http://www.geocrawler.com/archives/3/8263/2001/6/0/6020594/ :
 353                Y = 0.29900 * R + 0.58700 * G + 0.11400 * B
 354                U = -0.1687 * r  - 0.3313 * g + 0.5 * b + 128
 355                V = 0.5   * r - 0.4187 * g - 0.0813 * b + 128
 356             */
 357             if ( alpha ) {
 358                 i_out = INDEX_OUT( x, y );
 359
 360                 p_pic->Y_PIXELS[i_out] = .299 * R( p_in ) + .587 * G( p_in ) + .114 * B( p_in );
 361
 362                 p_pic->U_PIXELS[i_out] = -.1687 * R( p_in ) - .3313 * G( p_in ) + .5 * B( p_in ) + 128;
 363                 p_pic->V_PIXELS[i_out] = .5 * R( p_in ) - .4187 * G( p_in ) - .0813 * B( p_in ) + 128;
 364
 365                 p_pic->A_PIXELS[i_out] = ALPHA( p_in );
 366             }
 367         }
 368     }
 369
 370     return VLC_SUCCESS;
 371 }
 372
 373 static void svg_set_size( filter_t *p_filter, int width, int height )
 374 {
 375   p_filter->p_sys->i_width = width;
 376   p_filter->p_sys->i_height = height;
 377 }
 378
 379 static void svg_SizeCallback( int *width, int *height, gpointer data )
 380 {
 381     filter_t *p_filter = data;
 382
 383     *width = p_filter->p_sys->i_width;
 384     *height = p_filter->p_sys->i_height;
 385     return;
 386 }
 387
 388 static void svg_RenderPicture( filter_t *p_filter,
 389                                svg_rendition_t *p_svg )
 390 {
 391     /* Render the SVG string p_string->psz_text into a new picture_t
 392        p_string->p_rendition with dimensions ( ->i_width, ->i_height ) */
 393     RsvgHandle *p_handle;
 394     GError *error = NULL;
 395
 396     p_handle = rsvg_handle_new();
 397
 398     rsvg_handle_set_size_callback( p_handle, svg_SizeCallback, p_filter, NULL );
 399
 400     rsvg_handle_write( p_handle,
 401                        ( guchar* )p_svg->psz_text, strlen( p_svg->psz_text ) + 1,
 402                        &error );
 403     if( error != NULL )
 404     {
 405         msg_Err( p_filter, "error while rendering SVG: %s\n", error->message );
 406         return;
 407     }
 408     rsvg_handle_close( p_handle, &error );
 409
 410     p_svg->p_rendition = rsvg_handle_get_pixbuf( p_handle );
 411     rsvg_handle_free( p_handle );
 412 }
 413
 414
 415 static int RenderText( filter_t *p_filter, subpicture_region_t *p_region_out,
 416                        subpicture_region_t *p_region_in )
 417 {
 418     filter_sys_t *p_sys = p_filter->p_sys;
 419     svg_rendition_t *p_svg = NULL;
 420     char *psz_string;
 421
 422     /* Sanity check */
 423     if( !p_region_in || !p_region_out ) return VLC_EGENERIC;
 424     psz_string = p_region_in->psz_text;
 425     if( !psz_string || !*psz_string ) return VLC_EGENERIC;
 426
 427     p_svg = ( svg_rendition_t * )malloc( sizeof( svg_rendition_t ) );
 428     if( !p_svg )
 429     {
 430         msg_Err( p_filter, "out of memory" );
 431         return VLC_ENOMEM;
 432     }
 433
 434     p_region_out->i_x = p_region_in->i_x;
 435     p_region_out->i_y = p_region_in->i_y;
 436
 437     /* Check if the data is SVG or pure text. In the latter case,
 438        convert the text to SVG. FIXME: find a better test */
 439     if( strstr( psz_string, "<svg" ))
 440     {
 441         /* Data is SVG: duplicate */
 442         p_svg->psz_text = strdup( psz_string );
 443         if( !p_svg->psz_text )
 444         {
 445             msg_Err( p_filter, "out of memory" );
 446             free( p_svg );
 447             return VLC_ENOMEM;
 448         }
 449     }
 450     else
 451     {
 452         /* Data is text. Convert to SVG */
 453         int length;
 454         char* psz_template = p_sys->psz_template;
 455         length = strlen( psz_string ) + strlen( psz_template ) + 42;
 456         p_svg->psz_text = malloc( length + 1 );
 457         if( !p_svg->psz_text )
 458         {
 459             msg_Err( p_filter, "out of memory" );
 460             free( p_svg );
 461             return VLC_ENOMEM;
 462         }
 463         memset( p_svg->psz_text, 0, length + 1 );
 464         snprintf( p_svg->psz_text, length, psz_template, psz_string );
 465     }
 466     p_svg->i_width = p_sys->i_width;
 467     p_svg->i_height = p_sys->i_height;
 468     p_svg->i_chroma = VLC_FOURCC( 'Y','U','V','A' );
 469
 470     /* Render the SVG.
 471        The input data is stored in the p_string structure,
 472        and the function updates the p_rendition attribute. */
 473     svg_RenderPicture( p_filter, p_svg );
 474
 475     Render( p_filter, p_region_out, p_svg, p_svg->i_width, p_svg->i_height );
 476     FreeString( p_svg );
 477
 478     return VLC_SUCCESS;
 479 }
 480
 481 static void FreeString( svg_rendition_t *p_svg )
 482 {
 483     free( p_svg->psz_text );
 484     free( p_svg->p_rendition );
 485     free( p_svg );
 486 }