1 /*****************************************************************************
2 * svg.c : Put SVG on the video
3 *****************************************************************************
4 * Copyright (C) 2002, 2003 the VideoLAN team
7 * Authors: Olivier Aubert <oaubert@lisi.univ-lyon1.fr>
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.
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.
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 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
34 #include <vlc_charset.h>
37 #include <vlc_block.h>
38 #include <vlc_filter.h>
40 #ifdef HAVE_SYS_TYPES_H
41 # include <sys/types.h>
46 #elif defined( WIN32 ) && !defined( UNDER_CE )
51 #include <glib/gstdio.h>
52 #include <glib-object.h> /* g_object_unref( ) */
53 #include <librsvg-2/librsvg/rsvg.h>
55 typedef struct svg_rendition_t svg_rendition_t;
57 /*****************************************************************************
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 );
66 /*****************************************************************************
68 *****************************************************************************/
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" )
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 );
84 Describes a SVG string to be displayed on the video
86 struct svg_rendition_t
91 /** The SVG source associated with this subpicture */
93 /* The rendered SVG, as a GdkPixbuf */
94 GdkPixbuf *p_rendition;
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 * );
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 *****************************************************************************/
113 /* The SVG template used to convert strings */
115 /* Default size for rendering. Initialized to the output size. */
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 )
128 filter_t *p_filter = ( filter_t * )p_this;
131 /* Allocate structure */
132 p_sys = malloc( sizeof( filter_sys_t ) );
135 msg_Err( p_filter, "out of memory" );
139 /* Initialize psz_template */
140 p_sys->psz_template = svg_GetTemplate( p_this );
141 if( !p_sys->psz_template )
143 msg_Err( p_filter, "out of memory" );
148 p_sys->i_width = p_filter->fmt_out.video.i_width;
149 p_sys->i_height = p_filter->fmt_out.video.i_height;
151 p_filter->pf_render_text = RenderText;
152 p_filter->pf_render_html = NULL;
153 p_filter->p_sys = p_sys;
155 /* MUST call this before any RSVG funcs */
161 static char *svg_GetTemplate( vlc_object_t *p_this )
163 filter_t *p_filter = ( filter_t * )p_this;
168 psz_filename = config_GetPsz( p_filter, "svg-template-file" );
169 if( !psz_filename || (psz_filename[0] == 0) )
171 /* No filename. Use a default value. */
176 /* Read the template */
177 file = utf8_fopen( psz_filename, "rt" );
180 msg_Warn( p_this, "SVG template file %s does not exist.",
188 if( fstat( fileno( file ), &s ) )
190 /* Problem accessing file information. Should not
191 happen as we could open it. */
195 if( ((signed)s.st_size) < 0 )
197 msg_Err( p_this, "SVG template too big" );
202 msg_Dbg( p_this, "reading %ld bytes from template %s",
203 (unsigned long)s.st_size, psz_filename );
205 psz_template = malloc( ( s.st_size + 42 ) * sizeof( char ) );
208 msg_Err( p_filter, "out of memory" );
211 memset( psz_template, 0, s.st_size + 1 );
212 fread( psz_template, s.st_size, 1, file );
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>" );
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 )
237 filter_t *p_filter = ( filter_t * )p_this;
238 filter_sys_t *p_sys = p_filter->p_sys;
240 free( p_sys->psz_template );
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 )
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;
259 subpicture_region_t *p_region_tmp;
261 if ( p_filter->p_sys->i_width != i_width ||
262 p_filter->p_sys->i_height != i_height )
264 svg_set_size( p_filter, i_width, i_height );
265 p_svg->p_rendition = NULL;
268 if( p_svg->p_rendition == NULL ) {
269 svg_RenderPicture( p_filter, p_svg );
270 if( ! p_svg->p_rendition )
272 msg_Err( p_filter, "Cannot render SVG" );
276 i_width = gdk_pixbuf_get_width( p_svg->p_rendition );
277 i_height = gdk_pixbuf_get_height( p_svg->p_rendition );
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 );
289 msg_Err( p_filter, "cannot allocate SPU region" );
292 p_region->fmt = p_region_tmp->fmt;
293 p_region->picture = p_region_tmp->picture;
294 free( p_region_tmp );
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;
302 i_pitch = p_region->picture.Y_PITCH;
303 i_u_pitch = p_region->picture.U_PITCH;
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 );
310 p_pic = &p_region->picture;
314 /* This rendering code is in no way optimized. If someone has some time to
315 make it work faster or better, please do.
319 p_pixbuf->get_rowstride() is the number of bytes in a line.
320 p_pixbuf->get_height() is the number of lines.
322 The number of bytes of p_pixbuf->p_pixels is get_rowstride * get_height
325 alpha = pixels [ n_channels * ( y*rowstride + x ) + 3 ];
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 ];
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 );
338 This crashes the plugin (if !alpha). As there is always an alpha value,
339 it does not matter for the moment :
342 memset( p_a, 0xFF, i_pitch * p_region->fmt.i_height );
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 )
348 for( y = 0; y < i_height; y++ )
350 for( x = 0; x < i_width; x++ )
355 p_in = &pixels_in[INDEX_IN( x, y )];
357 #define R( pixel ) *pixel
358 #define G( pixel ) *( pixel+1 )
359 #define B( pixel ) *( pixel+2 )
360 #define ALPHA( pixel ) *( pixel+3 )
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
368 i_out = INDEX_OUT( x, y );
370 p_pic->Y_PIXELS[i_out] = .299 * R( p_in ) + .587 * G( p_in ) + .114 * B( p_in );
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;
375 p_pic->A_PIXELS[i_out] = ALPHA( p_in );
383 static void svg_set_size( filter_t *p_filter, int width, int height )
385 p_filter->p_sys->i_width = width;
386 p_filter->p_sys->i_height = height;
389 static void svg_SizeCallback( int *width, int *height, gpointer data )
391 filter_t *p_filter = data;
393 *width = p_filter->p_sys->i_width;
394 *height = p_filter->p_sys->i_height;
398 static void svg_RenderPicture( filter_t *p_filter,
399 svg_rendition_t *p_svg )
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;
406 p_svg->p_rendition = NULL;
408 p_handle = rsvg_handle_new();
412 msg_Err( p_filter, "Error creating SVG reader: %s", error->message );
416 rsvg_handle_set_size_callback( p_handle, svg_SizeCallback, p_filter, NULL );
418 if( ! rsvg_handle_write( p_handle,
419 ( guchar* )p_svg->psz_text, strlen( p_svg->psz_text ),
422 msg_Err( p_filter, "error while rendering SVG: %s\n", error->message );
423 g_object_unref( G_OBJECT( p_handle ) );
427 if( ! rsvg_handle_close( p_handle, &error ) )
429 msg_Err( p_filter, "error while rendering SVG (close): %s\n", error->message );
430 g_object_unref( G_OBJECT( p_handle ) );
434 p_svg->p_rendition = rsvg_handle_get_pixbuf( p_handle );
436 g_object_unref( G_OBJECT( p_handle ) );
440 static int RenderText( filter_t *p_filter, subpicture_region_t *p_region_out,
441 subpicture_region_t *p_region_in )
443 filter_sys_t *p_sys = p_filter->p_sys;
444 svg_rendition_t *p_svg = NULL;
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;
452 p_svg = ( svg_rendition_t * )malloc( sizeof( svg_rendition_t ) );
455 msg_Err( p_filter, "out of memory" );
459 p_region_out->i_x = p_region_in->i_x;
460 p_region_out->i_y = p_region_in->i_y;
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" ))
466 /* Data is SVG: duplicate */
467 p_svg->psz_text = strdup( psz_string );
468 if( !p_svg->psz_text )
470 msg_Err( p_filter, "out of memory" );
477 /* Data is text. Convert to SVG */
478 /* FIXME: handle p_style attributes */
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 )
485 msg_Err( p_filter, "out of memory" );
489 memset( p_svg->psz_text, 0, length + 1 );
490 snprintf( p_svg->psz_text, length, psz_template, psz_string );
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' );
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 );
501 Render( p_filter, p_region_out, p_svg, p_svg->i_width, p_svg->i_height );
507 static void FreeString( svg_rendition_t *p_svg )
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 );