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