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 };
 119
 120 /*****************************************************************************
 121  * Create: allocates svg video thread output method
 122  *****************************************************************************
 123  * This function allocates and initializes a  vout method.
 124  *****************************************************************************/
 125 static int Create( vlc_object_t *p_this )
 126 {
 127     filter_t *p_filter = ( filter_t * )p_this;
 128     filter_sys_t *p_sys;
 129
 130     /* Allocate structure */
 131     p_sys = malloc( sizeof( filter_sys_t ) );
 132     if( !p_sys )
 133         return VLC_ENOMEM;
 134
 135     /* Initialize psz_template */
 136     p_sys->psz_template = svg_GetTemplate( p_this );
 137     if( !p_sys->psz_template )
 138     {
 139         free( p_sys );
 140         return VLC_ENOMEM;
 141     }
 142
 143     p_sys->i_width = p_filter->fmt_out.video.i_width;
 144     p_sys->i_height = p_filter->fmt_out.video.i_height;
 145
 146     p_filter->pf_render_text = RenderText;
 147     p_filter->pf_render_html = NULL;
 148     p_filter->p_sys = p_sys;
 149
 150     /* MUST call this before any RSVG funcs */
 151     rsvg_init( );
 152
 153     return VLC_SUCCESS;
 154 }
 155
 156 static char *svg_GetTemplate( vlc_object_t *p_this )
 157 {
 158     filter_t *p_filter = ( filter_t * )p_this;
 159     char *psz_filename;
 160     char *psz_template;
 161     FILE *file;
 162
 163     psz_filename = config_GetPsz( p_filter, "svg-template-file" );
 164     if( !psz_filename || (psz_filename[0] == 0) )
 165     {
 166         /* No filename. Use a default value. */
 167         psz_template = NULL;
 168     }
 169     else
 170     {
 171         /* Read the template */
 172         file = utf8_fopen( psz_filename, "rt" );
 173         if( !file )
 174         {
 175             msg_Warn( p_this, "SVG template file %s does not exist.",
 176                                          psz_filename );
 177             psz_template = NULL;
 178         }
 179         else
 180         {
 181             struct stat s;
 182
 183             if( fstat( fileno( file ), &s ) )
 184             {
 185                 /* Problem accessing file information. Should not
 186                    happen as we could open it. */
 187                 psz_template = NULL;
 188             }
 189             else
 190             if( ((signed)s.st_size) < 0 )
 191             {
 192                 msg_Err( p_this, "SVG template too big" );
 193                 psz_template = NULL;
 194             }
 195             else
 196             {
 197                 msg_Dbg( p_this, "reading %ld bytes from template %s",
 198                          (unsigned long)s.st_size, psz_filename );
 199
 200                 psz_template = malloc( s.st_size + 42 );
 201                 if( !psz_template )
 202                 {
 203                     fclose( file );
 204                     free( psz_filename );
 205                     return NULL;
 206                 }
 207                 memset( psz_template, 0, s.st_size + 1 );
 208                 if(! fread( psz_template, s.st_size, 1, file ) )
 209                 {
 210                     msg_Dbg( p_this, "No data read from template." );
 211                 }
 212             }
 213             fclose( file );
 214         }
 215     }
 216     free( psz_filename );
 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
 260     if ( p_filter->p_sys->i_width != i_width ||
 261          p_filter->p_sys->i_height != i_height )
 262     {
 263         svg_set_size( p_filter, i_width, i_height );
 264         p_svg->p_rendition = NULL;
 265     }
 266
 267     if( p_svg->p_rendition == NULL ) {
 268         svg_RenderPicture( p_filter, p_svg );
 269         if( ! p_svg->p_rendition )
 270         {
 271             msg_Err( p_filter, "Cannot render SVG" );
 272             return VLC_EGENERIC;
 273         }
 274     }
 275     i_width = gdk_pixbuf_get_width( p_svg->p_rendition );
 276     i_height = gdk_pixbuf_get_height( p_svg->p_rendition );
 277
 278     /* Create a new subpicture region */
 279     memset( &fmt, 0, sizeof( video_format_t ) );
 280     fmt.i_chroma = VLC_CODEC_YUVA;
 281     fmt.i_aspect = VOUT_ASPECT_FACTOR;
 282     fmt.i_width = fmt.i_visible_width = i_width;
 283     fmt.i_height = fmt.i_visible_height = i_height;
 284     fmt.i_x_offset = fmt.i_y_offset = 0;
 285
 286     p_region->p_picture = picture_New( fmt.i_chroma, fmt.i_width, fmt.i_height, fmt.i_aspect );
 287     if( !p_region->p_picture )
 288         return VLC_EGENERIC;
 289     p_region->fmt = fmt;
 290
 291     p_region->i_x = p_region->i_y = 0;
 292     p_y = p_region->p_picture->Y_PIXELS;
 293     p_u = p_region->p_picture->U_PIXELS;
 294     p_v = p_region->p_picture->V_PIXELS;
 295     p_a = p_region->p_picture->A_PIXELS;
 296
 297     i_pitch = p_region->p_picture->Y_PITCH;
 298     i_u_pitch = p_region->p_picture->U_PITCH;
 299
 300     /* Initialize the region pixels (only the alpha will be changed later) */
 301     memset( p_y, 0x00, i_pitch * p_region->fmt.i_height );
 302     memset( p_u, 0x80, i_u_pitch * p_region->fmt.i_height );
 303     memset( p_v, 0x80, i_u_pitch * p_region->fmt.i_height );
 304
 305     p_pic = p_region->p_picture;
 306
 307     /* Copy the data */
 308
 309     /* This rendering code is in no way optimized. If someone has some time to
 310        make it work faster or better, please do.
 311     */
 312
 313     /*
 314       p_pixbuf->get_rowstride() is the number of bytes in a line.
 315       p_pixbuf->get_height() is the number of lines.
 316
 317       The number of bytes of p_pixbuf->p_pixels is get_rowstride * get_height
 318
 319       if( has_alpha() ) {
 320       alpha = pixels [ n_channels * ( y*rowstride + x ) + 3 ];
 321       }
 322       red   = pixels [ n_channels * ( y*rowstride ) + x ) ];
 323       green = pixels [ n_channels * ( y*rowstride ) + x ) + 1 ];
 324       blue  = pixels [ n_channels * ( y*rowstride ) + x ) + 2 ];
 325     */
 326
 327     pixels_in = gdk_pixbuf_get_pixels( p_svg->p_rendition );
 328     rowstride_in = gdk_pixbuf_get_rowstride( p_svg->p_rendition );
 329     channels_in = gdk_pixbuf_get_n_channels( p_svg->p_rendition );
 330     alpha = gdk_pixbuf_get_has_alpha( p_svg->p_rendition );
 331
 332     /*
 333       This crashes the plugin (if !alpha). As there is always an alpha value,
 334       it does not matter for the moment :
 335
 336     if( !alpha )
 337       memset( p_a, 0xFF, i_pitch * p_region->fmt.i_height );
 338     */
 339
 340 #define INDEX_IN( x, y ) ( y * rowstride_in + x * channels_in )
 341 #define INDEX_OUT( x, y ) ( y * i_pitch + x * p_pic->p[Y_PLANE].i_pixel_pitch )
 342
 343     for( y = 0; y < i_height; y++ )
 344     {
 345         for( x = 0; x < i_width; x++ )
 346         {
 347             guchar *p_in;
 348             int i_out;
 349
 350             p_in = &pixels_in[INDEX_IN( x, y )];
 351
 352 #define R( pixel ) *pixel
 353 #define G( pixel ) *( pixel+1 )
 354 #define B( pixel ) *( pixel+2 )
 355 #define ALPHA( pixel ) *( pixel+3 )
 356
 357             /* From http://www.geocrawler.com/archives/3/8263/2001/6/0/6020594/ :
 358                Y = 0.29900 * R + 0.58700 * G + 0.11400 * B
 359                U = -0.1687 * r  - 0.3313 * g + 0.5 * b + 128
 360                V = 0.5   * r - 0.4187 * g - 0.0813 * b + 128
 361             */
 362             if ( alpha ) {
 363                 i_out = INDEX_OUT( x, y );
 364
 365                 p_pic->Y_PIXELS[i_out] = .299 * R( p_in ) + .587 * G( p_in ) + .114 * B( p_in );
 366
 367                 p_pic->U_PIXELS[i_out] = -.1687 * R( p_in ) - .3313 * G( p_in ) + .5 * B( p_in ) + 128;
 368                 p_pic->V_PIXELS[i_out] = .5 * R( p_in ) - .4187 * G( p_in ) - .0813 * B( p_in ) + 128;
 369
 370                 p_pic->A_PIXELS[i_out] = ALPHA( p_in );
 371             }
 372         }
 373     }
 374
 375     return VLC_SUCCESS;
 376 }
 377
 378 static void svg_set_size( filter_t *p_filter, int width, int height )
 379 {
 380   p_filter->p_sys->i_width = width;
 381   p_filter->p_sys->i_height = height;
 382 }
 383
 384 static void svg_SizeCallback( int *width, int *height, gpointer data )
 385 {
 386     filter_t *p_filter = data;
 387
 388     *width = p_filter->p_sys->i_width;
 389     *height = p_filter->p_sys->i_height;
 390     return;
 391 }
 392
 393 static void svg_RenderPicture( filter_t *p_filter,
 394                                svg_rendition_t *p_svg )
 395 {
 396     /* Render the SVG string p_string->psz_text into a new picture_t
 397        p_string->p_rendition with dimensions ( ->i_width, ->i_height ) */
 398     RsvgHandle *p_handle;
 399     GError *error = NULL;
 400
 401     p_svg->p_rendition = NULL;
 402
 403     p_handle = rsvg_handle_new();
 404
 405     if( !p_handle )
 406     {
 407         msg_Err( p_filter, "Error creating SVG reader: %s", error->message );
 408         return;
 409     }
 410
 411     rsvg_handle_set_size_callback( p_handle, svg_SizeCallback, p_filter, NULL );
 412
 413     if( ! rsvg_handle_write( p_handle,
 414                  ( guchar* )p_svg->psz_text, strlen( p_svg->psz_text ),
 415                  &error ) )
 416     {
 417         msg_Err( p_filter, "error while rendering SVG: %s", error->message );
 418         g_object_unref( G_OBJECT( p_handle ) );
 419         return;
 420     }
 421
 422     if( ! rsvg_handle_close( p_handle, &error ) )
 423     {
 424         msg_Err( p_filter, "error while rendering SVG (close): %s", error->message );
 425         g_object_unref( G_OBJECT( p_handle ) );
 426         return;
 427     }
 428
 429     p_svg->p_rendition = rsvg_handle_get_pixbuf( p_handle );
 430
 431     g_object_unref( G_OBJECT( p_handle ) );
 432 }
 433
 434
 435 static int RenderText( filter_t *p_filter, subpicture_region_t *p_region_out,
 436                        subpicture_region_t *p_region_in )
 437 {
 438     filter_sys_t *p_sys = p_filter->p_sys;
 439     svg_rendition_t *p_svg = NULL;
 440     char *psz_string;
 441
 442     /* Sanity check */
 443     if( !p_region_in || !p_region_out ) return VLC_EGENERIC;
 444     psz_string = p_region_in->psz_text;
 445     if( !psz_string || !*psz_string ) return VLC_EGENERIC;
 446
 447     p_svg = malloc( sizeof( svg_rendition_t ) );
 448     if( !p_svg )
 449         return VLC_ENOMEM;
 450
 451     p_region_out->i_x = p_region_in->i_x;
 452     p_region_out->i_y = p_region_in->i_y;
 453
 454     /* Check if the data is SVG or pure text. In the latter case,
 455        convert the text to SVG. FIXME: find a better test */
 456     if( strstr( psz_string, "<svg" ))
 457     {
 458         /* Data is SVG: duplicate */
 459         p_svg->psz_text = strdup( psz_string );
 460         if( !p_svg->psz_text )
 461         {
 462             free( p_svg );
 463             return VLC_ENOMEM;
 464         }
 465     }
 466     else
 467     {
 468         /* Data is text. Convert to SVG */
 469         /* FIXME: handle p_style attributes */
 470         int length;
 471         char* psz_template = p_sys->psz_template;
 472         length = strlen( psz_string ) + strlen( psz_template ) + 42;
 473         p_svg->psz_text = malloc( length + 1 );
 474         if( !p_svg->psz_text )
 475         {
 476             free( p_svg );
 477             return VLC_ENOMEM;
 478         }
 479         memset( p_svg->psz_text, 0, length + 1 );
 480         snprintf( p_svg->psz_text, length, psz_template, psz_string );
 481     }
 482     p_svg->i_width = p_sys->i_width;
 483     p_svg->i_height = p_sys->i_height;
 484     p_svg->i_chroma = VLC_CODEC_YUVA;
 485
 486     /* Render the SVG.
 487        The input data is stored in the p_string structure,
 488        and the function updates the p_rendition attribute. */
 489     svg_RenderPicture( p_filter, p_svg );
 490
 491     Render( p_filter, p_region_out, p_svg, p_svg->i_width, p_svg->i_height );
 492     FreeString( p_svg );
 493
 494     return VLC_SUCCESS;
 495 }
 496
 497 static void FreeString( svg_rendition_t *p_svg )
 498 {
 499     free( p_svg->psz_text );
 500     /* p_svg->p_rendition is a GdkPixbuf, and its allocation is
 501        managed through ref. counting */
 502     if( p_svg->p_rendition )
 503         g_object_unref( p_svg->p_rendition );
 504     free( p_svg );
 505 }