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>
37 #include <vlc_block.h>
38 #include <vlc_filter.h>
40 #include <sys/types.h>
44 #elif defined( WIN32 ) && !defined( UNDER_CE )
49 #include <glib/gstdio.h>
50 #include <glib-object.h> /* g_object_unref( ) */
51 #include <librsvg/rsvg.h>
53 typedef struct svg_rendition_t svg_rendition_t
;
55 /*****************************************************************************
57 *****************************************************************************/
58 static int Create ( vlc_object_t
* );
59 static void Destroy ( vlc_object_t
* );
60 static int RenderText( filter_t
*p_filter
, subpicture_region_t
*p_region_out
,
61 subpicture_region_t
*p_region_in
);
62 static char *svg_GetTemplate( vlc_object_t
*p_this
);
64 /*****************************************************************************
66 *****************************************************************************/
68 #define TEMPLATE_TEXT N_( "SVG template file" )
69 #define TEMPLATE_LONGTEXT N_( "Location of a file holding a SVG template "\
70 "for automatic string conversion" )
73 set_category( CAT_INPUT
)
74 set_category( SUBCAT_INPUT_SCODEC
)
75 set_capability( "text renderer", 99 )
77 add_string( "svg-template-file", "", NULL
, TEMPLATE_TEXT
, TEMPLATE_LONGTEXT
, true )
78 set_callbacks( Create
, Destroy
)
82 Describes a SVG string to be displayed on the video
84 struct svg_rendition_t
89 /** The SVG source associated with this subpicture */
91 /* The rendered SVG, as a GdkPixbuf */
92 GdkPixbuf
*p_rendition
;
95 static int Render( filter_t
*, subpicture_region_t
*, svg_rendition_t
*, int, int);
96 static char *svg_GetTemplate ();
97 static void svg_set_size( filter_t
*p_filter
, int width
, int height
);
98 static void svg_SizeCallback ( int *width
, int *height
, gpointer data
);
99 static void svg_RenderPicture ( filter_t
*p_filter
,
100 svg_rendition_t
*p_svg
);
101 static void FreeString( svg_rendition_t
* );
103 /*****************************************************************************
104 * filter_sys_t: svg local data
105 *****************************************************************************
106 * This structure is part of the filter thread descriptor.
107 * It describes the svg specific properties of an output thread.
108 *****************************************************************************/
111 /* The SVG template used to convert strings */
113 /* Default size for rendering. Initialized to the output size. */
118 /*****************************************************************************
119 * Create: allocates svg video thread output method
120 *****************************************************************************
121 * This function allocates and initializes a vout method.
122 *****************************************************************************/
123 static int Create( vlc_object_t
*p_this
)
125 filter_t
*p_filter
= ( filter_t
* )p_this
;
128 /* Allocate structure */
129 p_sys
= malloc( sizeof( filter_sys_t
) );
133 /* Initialize psz_template */
134 p_sys
->psz_template
= svg_GetTemplate( p_this
);
135 if( !p_sys
->psz_template
)
141 p_sys
->i_width
= p_filter
->fmt_out
.video
.i_width
;
142 p_sys
->i_height
= p_filter
->fmt_out
.video
.i_height
;
144 p_filter
->pf_render_text
= RenderText
;
145 p_filter
->pf_render_html
= NULL
;
146 p_filter
->p_sys
= p_sys
;
148 /* MUST call this before any RSVG funcs */
154 static char *svg_GetTemplate( vlc_object_t
*p_this
)
156 filter_t
*p_filter
= ( filter_t
* )p_this
;
161 psz_filename
= var_InheritString( p_filter
, "svg-template-file" );
162 if( !psz_filename
|| (psz_filename
[0] == 0) )
164 /* No filename. Use a default value. */
169 /* Read the template */
170 file
= vlc_fopen( psz_filename
, "rt" );
173 msg_Warn( p_this
, "SVG template file %s does not exist.",
181 if( fstat( fileno( file
), &s
) )
183 /* Problem accessing file information. Should not
184 happen as we could open it. */
188 if( ((signed)s
.st_size
) < 0 )
190 msg_Err( p_this
, "SVG template too big" );
195 msg_Dbg( p_this
, "reading %ld bytes from template %s",
196 (unsigned long)s
.st_size
, psz_filename
);
198 psz_template
= calloc( 1, s
.st_size
+ 42 );
202 free( psz_filename
);
205 if(! fread( psz_template
, s
.st_size
, 1, file
) )
207 msg_Dbg( p_this
, "No data read from template." );
213 free( psz_filename
);
216 /* Either there was no file, or there was an error.
217 Use the default value */
218 psz_template
= strdup( "<?xml version='1.0' encoding='UTF-8' standalone='no'?> \
219 <svg version='1' preserveAspectRatio='xMinYMin meet' viewBox='0 0 800 600'> \
220 <text x='10' y='560' fill='white' font-size='32' \
221 font-family='sans-serif'>%s</text></svg>" );
227 /*****************************************************************************
228 * Destroy: destroy Clone video thread output method
229 *****************************************************************************
230 * Clean up all data and library connections
231 *****************************************************************************/
232 static void Destroy( vlc_object_t
*p_this
)
234 filter_t
*p_filter
= ( filter_t
* )p_this
;
235 filter_sys_t
*p_sys
= p_filter
->p_sys
;
237 free( p_sys
->psz_template
);
242 /*****************************************************************************
243 * Render: render SVG in picture
244 *****************************************************************************/
245 static int Render( filter_t
*p_filter
, subpicture_region_t
*p_region
,
246 svg_rendition_t
*p_svg
, int i_width
, int i_height
)
249 uint8_t *p_y
, *p_u
, *p_v
, *p_a
;
250 int x
, y
, i_pitch
, i_u_pitch
;
251 guchar
*pixels_in
= NULL
;
257 if ( p_filter
->p_sys
->i_width
!= i_width
||
258 p_filter
->p_sys
->i_height
!= i_height
)
260 svg_set_size( p_filter
, i_width
, i_height
);
261 p_svg
->p_rendition
= NULL
;
264 if( p_svg
->p_rendition
== NULL
) {
265 svg_RenderPicture( p_filter
, p_svg
);
266 if( ! p_svg
->p_rendition
)
268 msg_Err( p_filter
, "Cannot render SVG" );
272 i_width
= gdk_pixbuf_get_width( p_svg
->p_rendition
);
273 i_height
= gdk_pixbuf_get_height( p_svg
->p_rendition
);
275 /* Create a new subpicture region */
276 memset( &fmt
, 0, sizeof( video_format_t
) );
277 fmt
.i_chroma
= VLC_CODEC_YUVA
;
278 fmt
.i_width
= fmt
.i_visible_width
= i_width
;
279 fmt
.i_height
= fmt
.i_visible_height
= i_height
;
280 fmt
.i_x_offset
= fmt
.i_y_offset
= 0;
284 p_region
->p_picture
= picture_NewFromFormat( &fmt
);
285 if( !p_region
->p_picture
)
289 p_region
->i_x
= p_region
->i_y
= 0;
290 p_y
= p_region
->p_picture
->Y_PIXELS
;
291 p_u
= p_region
->p_picture
->U_PIXELS
;
292 p_v
= p_region
->p_picture
->V_PIXELS
;
293 p_a
= p_region
->p_picture
->A_PIXELS
;
295 i_pitch
= p_region
->p_picture
->Y_PITCH
;
296 i_u_pitch
= p_region
->p_picture
->U_PITCH
;
298 /* Initialize the region pixels (only the alpha will be changed later) */
299 memset( p_y
, 0x00, i_pitch
* p_region
->fmt
.i_height
);
300 memset( p_u
, 0x80, i_u_pitch
* p_region
->fmt
.i_height
);
301 memset( p_v
, 0x80, i_u_pitch
* p_region
->fmt
.i_height
);
303 p_pic
= p_region
->p_picture
;
307 /* This rendering code is in no way optimized. If someone has some time to
308 make it work faster or better, please do.
312 p_pixbuf->get_rowstride() is the number of bytes in a line.
313 p_pixbuf->get_height() is the number of lines.
315 The number of bytes of p_pixbuf->p_pixels is get_rowstride * get_height
318 alpha = pixels [ n_channels * ( y*rowstride + x ) + 3 ];
320 red = pixels [ n_channels * ( y*rowstride ) + x ) ];
321 green = pixels [ n_channels * ( y*rowstride ) + x ) + 1 ];
322 blue = pixels [ n_channels * ( y*rowstride ) + x ) + 2 ];
325 pixels_in
= gdk_pixbuf_get_pixels( p_svg
->p_rendition
);
326 rowstride_in
= gdk_pixbuf_get_rowstride( p_svg
->p_rendition
);
327 channels_in
= gdk_pixbuf_get_n_channels( p_svg
->p_rendition
);
328 alpha
= gdk_pixbuf_get_has_alpha( p_svg
->p_rendition
);
331 This crashes the plugin (if !alpha). As there is always an alpha value,
332 it does not matter for the moment :
335 memset( p_a, 0xFF, i_pitch * p_region->fmt.i_height );
338 #define INDEX_IN( x, y ) ( y * rowstride_in + x * channels_in )
339 #define INDEX_OUT( x, y ) ( y * i_pitch + x * p_pic->p[Y_PLANE].i_pixel_pitch )
341 for( y
= 0; y
< i_height
; y
++ )
343 for( x
= 0; x
< i_width
; x
++ )
348 p_in
= &pixels_in
[INDEX_IN( x
, y
)];
350 #define R( pixel ) *pixel
351 #define G( pixel ) *( pixel+1 )
352 #define B( pixel ) *( pixel+2 )
353 #define ALPHA( pixel ) *( pixel+3 )
355 /* From http://www.geocrawler.com/archives/3/8263/2001/6/0/6020594/ :
356 Y = 0.29900 * R + 0.58700 * G + 0.11400 * B
357 U = -0.1687 * r - 0.3313 * g + 0.5 * b + 128
358 V = 0.5 * r - 0.4187 * g - 0.0813 * b + 128
361 i_out
= INDEX_OUT( x
, y
);
363 p_pic
->Y_PIXELS
[i_out
] = .299 * R( p_in
) + .587 * G( p_in
) + .114 * B( p_in
);
365 p_pic
->U_PIXELS
[i_out
] = -.1687 * R( p_in
) - .3313 * G( p_in
) + .5 * B( p_in
) + 128;
366 p_pic
->V_PIXELS
[i_out
] = .5 * R( p_in
) - .4187 * G( p_in
) - .0813 * B( p_in
) + 128;
368 p_pic
->A_PIXELS
[i_out
] = ALPHA( p_in
);
376 static void svg_set_size( filter_t
*p_filter
, int width
, int height
)
378 p_filter
->p_sys
->i_width
= width
;
379 p_filter
->p_sys
->i_height
= height
;
382 static void svg_SizeCallback( int *width
, int *height
, gpointer data
)
384 filter_t
*p_filter
= data
;
386 *width
= p_filter
->p_sys
->i_width
;
387 *height
= p_filter
->p_sys
->i_height
;
391 static void svg_RenderPicture( filter_t
*p_filter
,
392 svg_rendition_t
*p_svg
)
394 /* Render the SVG string p_string->psz_text into a new picture_t
395 p_string->p_rendition with dimensions ( ->i_width, ->i_height ) */
396 RsvgHandle
*p_handle
;
397 GError
*error
= NULL
;
399 p_svg
->p_rendition
= NULL
;
401 p_handle
= rsvg_handle_new();
405 msg_Err( p_filter
, "Error creating SVG reader" );
409 rsvg_handle_set_size_callback( p_handle
, svg_SizeCallback
, p_filter
, NULL
);
411 if( ! rsvg_handle_write( p_handle
,
412 ( guchar
* )p_svg
->psz_text
, strlen( p_svg
->psz_text
),
415 msg_Err( p_filter
, "error while rendering SVG: %s", error
->message
);
416 g_object_unref( G_OBJECT( p_handle
) );
420 if( ! rsvg_handle_close( p_handle
, &error
) )
422 msg_Err( p_filter
, "error while rendering SVG (close): %s", error
->message
);
423 g_object_unref( G_OBJECT( p_handle
) );
427 p_svg
->p_rendition
= rsvg_handle_get_pixbuf( p_handle
);
429 g_object_unref( G_OBJECT( p_handle
) );
433 static int RenderText( filter_t
*p_filter
, subpicture_region_t
*p_region_out
,
434 subpicture_region_t
*p_region_in
)
436 filter_sys_t
*p_sys
= p_filter
->p_sys
;
437 svg_rendition_t
*p_svg
= NULL
;
441 if( !p_region_in
|| !p_region_out
) return VLC_EGENERIC
;
442 psz_string
= p_region_in
->psz_text
;
443 if( !psz_string
|| !*psz_string
) return VLC_EGENERIC
;
445 p_svg
= malloc( sizeof( svg_rendition_t
) );
449 p_region_out
->i_x
= p_region_in
->i_x
;
450 p_region_out
->i_y
= p_region_in
->i_y
;
452 /* Check if the data is SVG or pure text. In the latter case,
453 convert the text to SVG. FIXME: find a better test */
454 if( strstr( psz_string
, "<svg" ))
456 /* Data is SVG: duplicate */
457 p_svg
->psz_text
= strdup( psz_string
);
458 if( !p_svg
->psz_text
)
466 /* Data is text. Convert to SVG */
467 /* FIXME: handle p_style attributes */
469 char* psz_template
= p_sys
->psz_template
;
470 length
= strlen( psz_string
) + strlen( psz_template
) + 42;
471 p_svg
->psz_text
= calloc( 1, length
+ 1 );
472 if( !p_svg
->psz_text
)
477 snprintf( p_svg
->psz_text
, length
, psz_template
, psz_string
);
479 p_svg
->i_width
= p_sys
->i_width
;
480 p_svg
->i_height
= p_sys
->i_height
;
481 p_svg
->i_chroma
= VLC_CODEC_YUVA
;
484 The input data is stored in the p_string structure,
485 and the function updates the p_rendition attribute. */
486 svg_RenderPicture( p_filter
, p_svg
);
488 Render( p_filter
, p_region_out
, p_svg
, p_svg
->i_width
, p_svg
->i_height
);
494 static void FreeString( svg_rendition_t
*p_svg
)
496 free( p_svg
->psz_text
);
497 /* p_svg->p_rendition is a GdkPixbuf, and its allocation is
498 managed through ref. counting */
499 if( p_svg
->p_rendition
)
500 g_object_unref( p_svg
->p_rendition
);