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