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 #ifdef HAVE_SYS_STAT_H
  34 #   include <sys/stat.h>
  35 #endif
  36 #ifdef HAVE_UNISTD_H
  37 #    include <unistd.h>
  38 #elif defined( WIN32 ) && !defined( UNDER_CE )
  39 #   include <io.h>
  40 #endif
  41
  42 #include <vlc/vlc.h>
  43 #include <vlc/vout.h>
  44 #include "vlc_osd.h"
  45 #include "vlc_block.h"
  46 #include "vlc_filter.h"
  47
  48 #include <librsvg-2/librsvg/rsvg.h>
  49
  50 typedef struct svg_rendition_t svg_rendition_t;
  51
  52 /*****************************************************************************
  53  * Local prototypes
  54  *****************************************************************************/
  55 static int  Create    ( vlc_object_t * );
  56 static void Destroy   ( vlc_object_t * );
  57 static int RenderText( filter_t *p_filter, subpicture_region_t *p_region_out,
  58                        subpicture_region_t *p_region_in );
  59
  60
  61 /*****************************************************************************
  62  * Module descriptor
  63  *****************************************************************************/
  64
  65 #define TEMPLATE_TEXT N_( "SVG template file" )
  66 #define TEMPLATE_LONGTEXT N_( "Location of a file holding a SVG template 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     byte_t        *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 byte_t *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     byte_t        *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 byte_t *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 = fopen( psz_filename, "rt" );
 170         if( !file )
 171         {
 172             msg_Warn( p_this, "SVG template file %s does not exist.", psz_filename );
 173             psz_template = NULL;
 174         }
 175         else
 176         {
 177             struct stat s;
 178             int i_ret;
 179
 180             i_ret = lstat( psz_filename, &s );
 181             if( i_ret )
 182             {
 183                 /* Problem accessing file information. Should not
 184                    happen as we could open it. */
 185                 psz_template = NULL;
 186             }
 187             else
 188             {
 189                 msg_Dbg( p_this, "Reading %ld bytes from template %s\n", ( long )s.st_size, psz_filename );
 190
 191                 psz_template = malloc( s.st_size + 42 );
 192                 if( !psz_template )
 193                 {
 194                     msg_Err( p_filter, "Out of memory" );
 195                     return NULL;
 196                 }
 197                 memset( psz_template, 0, s.st_size + 1 );
 198                 fread( psz_template, s.st_size, 1, file );
 199                 fclose( file );
 200             }
 201         }
 202     }
 203     if( !psz_template )
 204     {
 205         /* Either there was no file, or there was an error.
 206            Use the default value */
 207         psz_template = strdup( "<?xml version='1.0' encoding='UTF-8' standalone='no'?> \
 208 <svg version='1' preserveAspectRatio='xMinYMin meet' viewBox='0 0 800 600'> \
 209   <text x='10' y='560' fill='white' font-size='32'  \
 210         font-family='sans-serif'>%s</text></svg>" );
 211     }
 212
 213     return psz_template;
 214 }
 215
 216 /*****************************************************************************
 217  * Destroy: destroy Clone video thread output method
 218  *****************************************************************************
 219  * Clean up all data and library connections
 220  *****************************************************************************/
 221 static void Destroy( vlc_object_t *p_this )
 222 {
 223     filter_t *p_filter = ( filter_t * )p_this;
 224     filter_sys_t *p_sys = p_filter->p_sys;
 225
 226     free( p_sys->psz_template );
 227     free( p_sys );
 228 }
 229
 230 /*****************************************************************************
 231  * Render: render SVG in picture
 232  *****************************************************************************/
 233 static int Render( filter_t *p_filter, subpicture_region_t *p_region,
 234                    svg_rendition_t *p_svg, int i_width, int i_height )
 235 {
 236     video_format_t fmt;
 237     uint8_t *p_y, *p_u, *p_v, *p_a;
 238     int x, y, i_pitch, i_u_pitch;
 239     guchar *pixels_in = NULL;
 240     int rowstride_in;
 241     int channels_in;
 242     int alpha;
 243     picture_t *p_pic;
 244     subpicture_region_t *p_region_tmp;
 245
 246     if ( p_filter->p_sys->i_width != i_width ||
 247          p_filter->p_sys->i_height != i_height )
 248     {
 249         svg_set_size( p_filter, i_width, i_height );
 250         p_svg->p_rendition = NULL;
 251     }
 252
 253     if( p_svg->p_rendition == NULL ) {
 254         svg_RenderPicture( p_filter, p_svg );
 255         /* FIXME: should do a check here to ensure that
 256            the rendition went OK */
 257     }
 258     i_width = gdk_pixbuf_get_width( p_svg->p_rendition );
 259     i_height = gdk_pixbuf_get_height( p_svg->p_rendition );
 260
 261     /* Create a new subpicture region */
 262     memset( &fmt, 0, sizeof( video_format_t ) );
 263     fmt.i_chroma = VLC_FOURCC( 'Y','U','V','A' );
 264     fmt.i_aspect = VOUT_ASPECT_FACTOR;
 265     fmt.i_width = fmt.i_visible_width = i_width;
 266     fmt.i_height = fmt.i_visible_height = i_height;
 267     fmt.i_x_offset = fmt.i_y_offset = 0;
 268     p_region_tmp = spu_CreateRegion( p_filter, &fmt );
 269     if( !p_region_tmp )
 270     {
 271         msg_Err( p_filter, "cannot allocate SPU region" );
 272         return VLC_EGENERIC;
 273     }
 274     p_region->fmt = p_region_tmp->fmt;
 275     p_region->picture = p_region_tmp->picture;
 276     free( p_region_tmp );
 277
 278     p_region->i_x = p_region->i_y = 0;
 279     p_y = p_region->picture.Y_PIXELS;
 280     p_u = p_region->picture.U_PIXELS;
 281     p_v = p_region->picture.V_PIXELS;
 282     p_a = p_region->picture.A_PIXELS;
 283
 284     i_pitch = p_region->picture.Y_PITCH;
 285     i_u_pitch = p_region->picture.U_PITCH;
 286
 287     /* Initialize the region pixels (only the alpha will be changed later) */
 288     memset( p_y, 0x00, i_pitch * p_region->fmt.i_height );
 289     memset( p_u, 0x80, i_u_pitch * p_region->fmt.i_height );
 290     memset( p_v, 0x80, i_u_pitch * p_region->fmt.i_height );
 291
 292     p_pic = &p_region->picture;
 293
 294     /* Copy the data */
 295
 296     /* This rendering code is in no way optimized. If someone has some time to
 297        make it work faster or better, please do.
 298     */
 299
 300     /*
 301       p_pixbuf->get_rowstride() is the number of bytes in a line.
 302       p_pixbuf->get_height() is the number of lines.
 303
 304       The number of bytes of p_pixbuf->p_pixels is get_rowstride * get_height
 305
 306       if( has_alpha() ) {
 307       alpha = pixels [ n_channels * ( y*rowstride + x ) + 3 ];
 308       }
 309       red   = pixels [ n_channels * ( y*rowstride ) + x ) ];
 310       green = pixels [ n_channels * ( y*rowstride ) + x ) + 1 ];
 311       blue  = pixels [ n_channels * ( y*rowstride ) + x ) + 2 ];
 312     */
 313
 314     pixels_in = gdk_pixbuf_get_pixels( p_svg->p_rendition );
 315     rowstride_in = gdk_pixbuf_get_rowstride( p_svg->p_rendition );
 316     channels_in = gdk_pixbuf_get_n_channels( p_svg->p_rendition );
 317     alpha = gdk_pixbuf_get_has_alpha( p_svg->p_rendition );
 318
 319     /*
 320       This crashes the plugin (if !alpha). As there is always an alpha value,
 321       it does not matter for the moment :
 322
 323     if( !alpha )
 324       memset( p_a, 0xFF, i_pitch * p_region->fmt.i_height );
 325     */
 326
 327 #define INDEX_IN( x, y ) ( y * rowstride_in + x * channels_in )
 328 #define INDEX_OUT( x, y ) ( y * i_pitch + x * p_pic->p[Y_PLANE].i_pixel_pitch )
 329
 330     for( y = 0; y < i_height; y++ )
 331     {
 332         for( x = 0; x < i_width; x++ )
 333         {
 334             guchar *p_in;
 335             int i_out;
 336
 337             p_in = &pixels_in[INDEX_IN( x, y )];
 338
 339 #define R( pixel ) *pixel
 340 #define G( pixel ) *( pixel+1 )
 341 #define B( pixel ) *( pixel+2 )
 342 #define ALPHA( pixel ) *( pixel+3 )
 343
 344             /* From http://www.geocrawler.com/archives/3/8263/2001/6/0/6020594/ :
 345                Y = 0.29900 * R + 0.58700 * G + 0.11400 * B
 346                U = -0.1687 * r  - 0.3313 * g + 0.5 * b + 128
 347                V = 0.5   * r - 0.4187 * g - 0.0813 * b + 128
 348             */
 349             if ( alpha ) {
 350                 i_out = INDEX_OUT( x, y );
 351
 352                 p_pic->Y_PIXELS[i_out] = .299 * R( p_in ) + .587 * G( p_in ) + .114 * B( p_in );
 353
 354                 p_pic->U_PIXELS[i_out] = -.1687 * R( p_in ) - .3313 * G( p_in ) + .5 * B( p_in ) + 128;
 355                 p_pic->V_PIXELS[i_out] = .5 * R( p_in ) - .4187 * G( p_in ) - .0813 * B( p_in ) + 128;
 356
 357                 p_pic->A_PIXELS[i_out] = ALPHA( p_in );
 358             }
 359         }
 360     }
 361
 362     return VLC_SUCCESS;
 363 }
 364
 365 static void svg_set_size( filter_t *p_filter, int width, int height )
 366 {
 367   p_filter->p_sys->i_width = width;
 368   p_filter->p_sys->i_height = height;
 369 }
 370
 371 static void svg_SizeCallback( int *width, int *height, gpointer data )
 372 {
 373     filter_t *p_filter = data;
 374
 375     *width = p_filter->p_sys->i_width;
 376     *height = p_filter->p_sys->i_height;
 377     return;
 378 }
 379
 380 static void svg_RenderPicture( filter_t *p_filter,
 381                                svg_rendition_t *p_svg )
 382 {
 383     /* Render the SVG string p_string->psz_text into a new picture_t
 384        p_string->p_rendition with dimensions ( ->i_width, ->i_height ) */
 385     RsvgHandle *p_handle;
 386     GError *error = NULL;
 387
 388     p_handle = rsvg_handle_new();
 389
 390     rsvg_handle_set_size_callback( p_handle, svg_SizeCallback, p_filter, NULL );
 391
 392     rsvg_handle_write( p_handle,
 393                        p_svg->psz_text, strlen( p_svg->psz_text ) + 1,
 394                        &error );
 395     if( error != NULL )
 396     {
 397         msg_Err( p_filter, "Error in handle_write: %s\n", error->message );
 398         return;
 399     }
 400     rsvg_handle_close( p_handle, &error );
 401
 402     p_svg->p_rendition = rsvg_handle_get_pixbuf( p_handle );
 403     rsvg_handle_free( p_handle );
 404 }
 405
 406
 407 static int RenderText( filter_t *p_filter, subpicture_region_t *p_region_out,
 408                        subpicture_region_t *p_region_in )
 409 {
 410     filter_sys_t *p_sys = p_filter->p_sys;
 411     svg_rendition_t *p_svg = NULL;
 412     char *psz_string;
 413
 414     /* Sanity check */
 415     if( !p_region_in || !p_region_out ) return VLC_EGENERIC;
 416     psz_string = p_region_in->psz_text;
 417     if( !psz_string || !*psz_string ) return VLC_EGENERIC;
 418
 419     p_svg = ( svg_rendition_t * )malloc( sizeof( svg_rendition_t ) );
 420     if( !p_svg )
 421     {
 422         msg_Err( p_filter, "Out of memory" );
 423         return VLC_ENOMEM;
 424     }
 425
 426     p_region_out->i_x = p_region_in->i_x;
 427     p_region_out->i_y = p_region_in->i_y;
 428
 429     /* Check if the data is SVG or pure text. In the latter case,
 430        convert the text to SVG. FIXME: find a better test */
 431     if( strstr( psz_string, "<svg" ))
 432     {
 433         /* Data is SVG: duplicate */
 434         p_svg->psz_text = strdup( psz_string );
 435         if( !p_svg->psz_text )
 436         {
 437             msg_Err( p_filter, "Out of memory" );
 438             free( p_svg );
 439             return VLC_ENOMEM;
 440         }
 441     }
 442     else
 443     {
 444         /* Data is text. Convert to SVG */
 445         int length;
 446         byte_t* psz_template = p_sys->psz_template;
 447         length = strlen( psz_string ) + strlen( psz_template ) + 42;
 448         p_svg->psz_text = malloc( length + 1 );
 449         if( !p_svg->psz_text )
 450         {
 451             msg_Err( p_filter, "Out of memory" );
 452             free( p_svg );
 453             return VLC_ENOMEM;
 454         }
 455         memset( p_svg->psz_text, 0, length + 1 );
 456         snprintf( p_svg->psz_text, length, psz_template, psz_string );
 457     }
 458     p_svg->i_width = p_sys->i_width;
 459     p_svg->i_height = p_sys->i_height;
 460     p_svg->i_chroma = VLC_FOURCC( 'Y','U','V','A' );
 461
 462     /* Render the SVG.
 463        The input data is stored in the p_string structure,
 464        and the function updates the p_rendition attribute. */
 465     svg_RenderPicture( p_filter, p_svg );
 466
 467     Render( p_filter, p_region_out, p_svg, p_svg->i_width, p_svg->i_height );
 468     FreeString( p_svg );
 469
 470     return VLC_SUCCESS;
 471 }
 472
 473 static void FreeString( svg_rendition_t *p_svg )
 474 {
 475     free( p_svg->psz_text );
 476     free( p_svg->p_rendition );
 477     free( p_svg );
 478 }