1 /*****************************************************************************
2 * logo.c : logo video plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2003-2004 VideoLAN
7 * Authors: Gildas Bazin <gbazin@videolan.org>
8 * Simon Latapie <garf@videolan.org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
23 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
28 #include <stdlib.h> /* malloc(), free() */
36 #include "vlc_filter.h"
37 #include "filter_common.h"
39 /*****************************************************************************
41 *****************************************************************************/
42 static int Create ( vlc_object_t * );
43 static void Destroy ( vlc_object_t * );
45 static int Init ( vout_thread_t * );
46 static void End ( vout_thread_t * );
47 static void Render ( vout_thread_t *, picture_t * );
49 static int SendEvents( vlc_object_t *, char const *,
50 vlc_value_t, vlc_value_t, void * );
51 static int MouseEvent ( vlc_object_t *, char const *,
52 vlc_value_t , vlc_value_t , void * );
53 static int Control ( vout_thread_t *, int, va_list );
55 static int CreateFilter ( vlc_object_t * );
56 static void DestroyFilter( vlc_object_t * );
58 /*****************************************************************************
60 *****************************************************************************/
61 #define FILE_TEXT N_("Logo filename")
62 #define FILE_LONGTEXT N_("Full path of the PNG file to use.")
63 #define POSX_TEXT N_("X coordinate of the logo")
64 #define POSX_LONGTEXT N_("You can move the logo by left-clicking on it." )
65 #define POSY_TEXT N_("Y coordinate of the logo")
66 #define POSY_LONGTEXT N_("You can move the logo by left-clicking on it." )
67 #define TRANS_TEXT N_("Transparency of the logo")
68 #define TRANS_LONGTEXT N_("You can set the logo transparency value here " \
69 "(from 0 for full transparency to 255 for full opacity)." )
72 set_description( _("Logo video filter") );
73 set_capability( "video filter", 0 );
74 add_shortcut( "logo" );
75 set_callbacks( Create, Destroy );
77 add_file( "logo-file", NULL, NULL, FILE_TEXT, FILE_LONGTEXT, VLC_FALSE );
78 add_integer( "logo-x", 0, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_FALSE );
79 add_integer( "logo-y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_FALSE );
80 add_integer_with_range( "logo-transparency", 255, 0, 255, NULL,
81 TRANS_TEXT, TRANS_LONGTEXT, VLC_FALSE );
83 /* subpicture filter submodule */
85 set_capability( "sub filter", 0 );
86 set_callbacks( CreateFilter, DestroyFilter );
87 set_description( _("Logo sub filter") );
88 add_shortcut( "logo" );
91 /*****************************************************************************
92 * LoadPNG: loads the PNG logo into memory
93 *****************************************************************************/
94 static picture_t *LoadPNG( vlc_object_t *p_this )
101 vlc_bool_t b_alpha = VLC_TRUE;
103 png_uint_32 i_width, i_height;
104 int i_color_type, i_interlace_type, i_compression_type, i_filter_type;
106 png_bytep *p_row_pointers;
108 png_infop p_info, p_end_info;
110 var_Create( p_this, "logo-file", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
111 var_Get( p_this, "logo-file", &val );
112 psz_filename = val.psz_string;
113 if( !psz_filename || !*psz_filename )
115 msg_Err( p_this, "logo file not specified" );
119 if( !(file = fopen( psz_filename , "rb" )) )
121 msg_Err( p_this, "logo file (%s) not found", psz_filename );
122 free( psz_filename );
125 free( psz_filename );
127 p_png = png_create_read_struct( PNG_LIBPNG_VER_STRING, 0, 0, 0 );
128 p_info = png_create_info_struct( p_png );
129 p_end_info = png_create_info_struct( p_png );
130 png_init_io( p_png, file );
131 png_read_info( p_png, p_info );
132 png_get_IHDR( p_png, p_info, &i_width, &i_height,
133 &i_bit_depth, &i_color_type, &i_interlace_type,
134 &i_compression_type, &i_filter_type);
136 if( i_color_type == PNG_COLOR_TYPE_PALETTE )
137 png_set_palette_to_rgb( p_png );
139 if( i_color_type == PNG_COLOR_TYPE_GRAY ||
140 i_color_type == PNG_COLOR_TYPE_GRAY_ALPHA )
141 png_set_gray_to_rgb( p_png );
143 if( png_get_valid( p_png, p_info, PNG_INFO_tRNS ) )
145 png_set_tRNS_to_alpha( p_png );
147 else if( !(i_color_type & PNG_COLOR_MASK_ALPHA) )
152 p_row_pointers = malloc( sizeof(png_bytep) * i_height );
153 for( i = 0; i < (int)i_height; i++ )
154 p_row_pointers[i] = malloc( 4 * ( i_bit_depth + 7 ) / 8 * i_width );
156 png_read_image( p_png, p_row_pointers );
157 png_read_end( p_png, p_end_info );
160 png_destroy_read_struct( &p_png, &p_info, &p_end_info );
162 /* Convert to YUVA */
163 p_pic = malloc( sizeof(picture_t) );
164 if( vout_AllocatePicture( p_this, p_pic, VLC_FOURCC('Y','U','V','A'),
165 i_width, i_height, VOUT_ASPECT_FACTOR ) !=
168 for( i = 0; i < (int)i_height; i++ ) free( p_row_pointers[i] );
169 free( p_row_pointers );
173 var_Create(p_this, "logo-transparency", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT);
174 var_Get( p_this, "logo-transparency", &val );
175 i_trans = __MAX( __MIN( val.i_int, 255 ), 0 );
177 for( j = 0; j < (int)i_height ; j++ )
179 uint8_t *p = (uint8_t *)p_row_pointers[j];
181 for( i = 0; i < (int)i_width ; i++ )
183 int i_offset = i + j * p_pic->p[Y_PLANE].i_pitch;
185 p_pic->p[Y_PLANE].p_pixels[i_offset] =
186 (p[0] * 257L + p[1] * 504 + p[2] * 98)/1000 + 16;
187 p_pic->p[U_PLANE].p_pixels[i_offset] =
188 (p[2] * 439L - p[0] * 148 - p[1] * 291)/1000 + 128;
189 p_pic->p[V_PLANE].p_pixels[i_offset] =
190 (p[0] * 439L - p[1] * 368 - p[2] * 71)/1000 + 128;
191 p_pic->p[A_PLANE].p_pixels[i_offset] =
192 b_alpha ? (p[3] * i_trans) / 255 : i_trans;
194 p += (b_alpha ? 4 : 3);
198 for( i = 0; i < (int)i_height; i++ ) free( p_row_pointers[i] );
199 free( p_row_pointers );
203 /*****************************************************************************
204 * vout_sys_t: logo video output method descriptor
205 *****************************************************************************
206 * This structure is part of the video output thread descriptor.
207 * It describes the Invert specific properties of an output thread.
208 *****************************************************************************/
211 vout_thread_t *p_vout;
216 int i_width, i_height;
220 /*****************************************************************************
221 * Create: allocates logo video thread output method
222 *****************************************************************************/
223 static int Create( vlc_object_t *p_this )
225 vout_thread_t *p_vout = (vout_thread_t *)p_this;
229 /* Allocate structure */
230 p_sys = p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
233 msg_Err( p_vout, "out of memory" );
237 p_vout->pf_init = Init;
238 p_vout->pf_end = End;
239 p_vout->pf_manage = NULL;
240 p_vout->pf_render = Render;
241 p_vout->pf_display = NULL;
242 p_vout->pf_control = Control;
244 var_Create( p_this, "logo-x", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
245 var_Get( p_this, "logo-x", &val );
246 p_sys->posx = val.i_int;
247 var_Create( p_this, "logo-y", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
248 var_Get( p_this, "logo-y", &val );
249 p_sys->posy = val.i_int;
251 p_sys->p_pic = LoadPNG( p_this );
258 p_sys->i_width = p_sys->p_pic->p[Y_PLANE].i_visible_pitch;
259 p_sys->i_height = p_sys->p_pic->p[Y_PLANE].i_visible_lines;
264 /*****************************************************************************
265 * Init: initialize logo video thread output method
266 *****************************************************************************/
267 static int Init( vout_thread_t *p_vout )
269 vout_sys_t *p_sys = p_vout->p_sys;
273 I_OUTPUTPICTURES = 0;
275 /* Initialize the output structure */
276 p_vout->output.i_chroma = p_vout->render.i_chroma;
277 p_vout->output.i_width = p_vout->render.i_width;
278 p_vout->output.i_height = p_vout->render.i_height;
279 p_vout->output.i_aspect = p_vout->render.i_aspect;
281 /* Load the video blending filter */
282 p_sys->p_blend = vlc_object_create( p_vout, sizeof(filter_t) );
283 vlc_object_attach( p_sys->p_blend, p_vout );
284 p_sys->p_blend->fmt_out.video.i_x_offset =
285 p_sys->p_blend->fmt_out.video.i_y_offset = 0;
286 p_sys->p_blend->fmt_in.video.i_x_offset =
287 p_sys->p_blend->fmt_in.video.i_y_offset = 0;
288 p_sys->p_blend->fmt_out.video.i_aspect = p_vout->render.i_aspect;
289 p_sys->p_blend->fmt_out.video.i_chroma = p_vout->output.i_chroma;
290 p_sys->p_blend->fmt_in.video.i_chroma = VLC_FOURCC('Y','U','V','A');
291 p_sys->p_blend->fmt_in.video.i_aspect = VOUT_ASPECT_FACTOR;
292 p_sys->p_blend->fmt_in.video.i_width =
293 p_sys->p_blend->fmt_in.video.i_visible_width =
294 p_sys->p_pic->p[Y_PLANE].i_visible_pitch;
295 p_sys->p_blend->fmt_in.video.i_height =
296 p_sys->p_blend->fmt_in.video.i_visible_height =
297 p_sys->p_pic->p[Y_PLANE].i_visible_lines;
298 p_sys->p_blend->fmt_out.video.i_width =
299 p_sys->p_blend->fmt_out.video.i_visible_width =
300 p_vout->output.i_width;
301 p_sys->p_blend->fmt_out.video.i_height =
302 p_sys->p_blend->fmt_out.video.i_visible_height =
303 p_vout->output.i_height;
305 p_sys->p_blend->p_module =
306 module_Need( p_sys->p_blend, "video blending", 0, 0 );
307 if( !p_sys->p_blend->p_module )
309 msg_Err( p_vout, "can't open blending filter, aborting" );
310 vlc_object_detach( p_sys->p_blend );
311 vlc_object_destroy( p_sys->p_blend );
315 /* Try to open the real video output */
316 msg_Dbg( p_vout, "spawning the real video output" );
319 vout_Create( p_vout, p_vout->render.i_width, p_vout->render.i_height,
320 p_vout->render.i_chroma, p_vout->render.i_aspect );
322 /* Everything failed */
323 if( p_sys->p_vout == NULL )
325 msg_Err( p_vout, "can't open vout, aborting" );
329 var_AddCallback( p_sys->p_vout, "mouse-x", MouseEvent, p_vout);
330 var_AddCallback( p_sys->p_vout, "mouse-y", MouseEvent, p_vout);
332 ALLOCATE_DIRECTBUFFERS( VOUT_MAX_PICTURES );
333 ADD_CALLBACKS( p_sys->p_vout, SendEvents );
334 ADD_PARENT_CALLBACKS( SendEventsToChild );
339 /*****************************************************************************
340 * End: terminate logo video thread output method
341 *****************************************************************************/
342 static void End( vout_thread_t *p_vout )
344 vout_sys_t *p_sys = p_vout->p_sys;
347 /* Free the fake output buffers we allocated */
348 for( i_index = I_OUTPUTPICTURES ; i_index ; )
351 free( PP_OUTPUTPICTURE[ i_index ]->p_data_orig );
354 var_DelCallback( p_sys->p_vout, "mouse-x", MouseEvent, p_vout);
355 var_DelCallback( p_sys->p_vout, "mouse-y", MouseEvent, p_vout);
359 DEL_CALLBACKS( p_sys->p_vout, SendEvents );
360 vlc_object_detach( p_sys->p_vout );
361 vout_Destroy( p_sys->p_vout );
364 if( p_sys->p_blend->p_module )
365 module_Unneed( p_sys->p_blend, p_sys->p_blend->p_module );
366 vlc_object_detach( p_sys->p_blend );
367 vlc_object_destroy( p_sys->p_blend );
370 /*****************************************************************************
371 * Destroy: destroy logo video thread output method
372 *****************************************************************************/
373 static void Destroy( vlc_object_t *p_this )
375 vout_thread_t *p_vout = (vout_thread_t *)p_this;
376 vout_sys_t *p_sys = p_vout->p_sys;
378 DEL_PARENT_CALLBACKS( SendEventsToChild );
380 if( p_sys->p_pic && p_sys->p_pic->p_data_orig )
381 free( p_sys->p_pic->p_data_orig );
382 if( p_sys->p_pic ) free( p_sys->p_pic );
387 /*****************************************************************************
388 * Render: render the logo onto the video
389 *****************************************************************************/
390 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
392 vout_sys_t *p_sys = p_vout->p_sys;
395 /* This is a new frame. Get a structure from the video_output. */
396 while( !(p_outpic = vout_CreatePicture( p_sys->p_vout, 0, 0, 0 )) )
398 if( p_vout->b_die || p_vout->b_error ) return;
399 msleep( VOUT_OUTMEM_SLEEP );
402 vout_CopyPicture( p_vout, p_outpic, p_pic );
403 vout_DatePicture( p_sys->p_vout, p_outpic, p_pic->date );
405 p_sys->p_blend->pf_video_blend( p_sys->p_blend, p_outpic, p_outpic,
406 p_sys->p_pic, p_sys->posx, p_sys->posy );
408 vout_DisplayPicture( p_sys->p_vout, p_outpic );
411 /*****************************************************************************
412 * SendEvents: forward mouse and keyboard events to the parent p_vout
413 *****************************************************************************/
414 static int SendEvents( vlc_object_t *p_this, char const *psz_var,
415 vlc_value_t oldval, vlc_value_t newval, void *p_data )
417 var_Set( (vlc_object_t *)p_data, psz_var, newval );
421 /*****************************************************************************
422 * MouseEvent: callback for mouse events
423 *****************************************************************************/
424 static int MouseEvent( vlc_object_t *p_this, char const *psz_var,
425 vlc_value_t oldval, vlc_value_t newval, void *p_data )
427 vout_thread_t *p_vout = (vout_thread_t*)p_data;
428 vout_sys_t *p_sys = p_vout->p_sys;
432 var_Get( p_vout->p_sys->p_vout, "mouse-button-down", &valb );
434 i_delta = newval.i_int - oldval.i_int;
436 if( (valb.i_int & 0x1) == 0 )
441 if( psz_var[6] == 'x' )
444 var_Get( p_vout->p_sys->p_vout, "mouse-y", &valy );
445 if( newval.i_int >= (int)p_sys->posx &&
446 valy.i_int >= (int)p_sys->posy &&
447 newval.i_int <= (int)(p_sys->posx + p_sys->i_width) &&
448 valy.i_int <= (int)(p_sys->posy + p_sys->i_height) )
450 p_sys->posx = __MIN( __MAX( p_sys->posx + i_delta, 0 ),
451 p_vout->output.i_width - p_sys->i_width );
454 else if( psz_var[6] == 'y' )
457 var_Get( p_vout->p_sys->p_vout, "mouse-x", &valx );
458 if( valx.i_int >= (int)p_sys->posx &&
459 newval.i_int >= (int)p_sys->posy &&
460 valx.i_int <= (int)(p_sys->posx + p_sys->i_width) &&
461 newval.i_int <= (int)(p_sys->posy + p_sys->i_height) )
463 p_sys->posy = __MIN( __MAX( p_sys->posy + i_delta, 0 ),
464 p_vout->output.i_height - p_sys->i_height );
471 /*****************************************************************************
472 * Control: control facility for the vout (forwards to child vout)
473 *****************************************************************************/
474 static int Control( vout_thread_t *p_vout, int i_query, va_list args )
476 return vout_vaControl( p_vout->p_sys->p_vout, i_query, args );
479 /*****************************************************************************
480 * SendEventsToChild: forward events to the child/children vout
481 *****************************************************************************/
482 static int SendEventsToChild( vlc_object_t *p_this, char const *psz_var,
483 vlc_value_t oldval, vlc_value_t newval, void *p_data )
485 vout_thread_t *p_vout = (vout_thread_t *)p_this;
486 var_Set( p_vout->p_sys->p_vout, psz_var, newval );
490 /*****************************************************************************
491 * filter_sys_t: logo filter descriptor
492 *****************************************************************************/
497 int i_width, i_height;
503 static subpicture_t *Filter( filter_t *, mtime_t );
505 /*****************************************************************************
506 * CreateFilter: allocates logo video filter
507 *****************************************************************************/
508 static int CreateFilter( vlc_object_t *p_this )
510 filter_t *p_filter = (filter_t *)p_this;
514 /* Allocate structure */
515 p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
518 msg_Err( p_filter, "out of memory" );
522 var_Create( p_this, "logo-x", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
523 var_Get( p_this, "logo-x", &val );
524 p_sys->posx = val.i_int;
525 var_Create( p_this, "logo-y", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
526 var_Get( p_this, "logo-y", &val );
527 p_sys->posy = val.i_int;
529 p_sys->p_pic = LoadPNG( p_this );
536 p_sys->i_width = p_sys->p_pic->p[Y_PLANE].i_visible_pitch;
537 p_sys->i_height = p_sys->p_pic->p[Y_PLANE].i_visible_lines;
538 p_sys->i_last_date = 0;
541 p_filter->pf_sub_filter = Filter;
546 /*****************************************************************************
547 * DestroyFilter: destroy logo video filter
548 *****************************************************************************/
549 static void DestroyFilter( vlc_object_t *p_this )
551 filter_t *p_filter = (filter_t *)p_this;
552 filter_sys_t *p_sys = p_filter->p_sys;
554 if( p_sys->p_pic && p_sys->p_pic->p_data_orig )
555 free( p_sys->p_pic->p_data_orig );
556 if( p_sys->p_pic ) free( p_sys->p_pic );
561 /****************************************************************************
562 * Filter: the whole thing
563 ****************************************************************************
564 * This function outputs subpictures at regular time intervals.
565 ****************************************************************************/
566 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
568 filter_sys_t *p_sys = p_filter->p_sys;
570 subpicture_region_t *p_region;
573 if( p_sys->i_last_date && p_sys->i_last_date + 5000000 > date ) return 0;
575 /* Allocate the subpicture internal data. */
576 p_spu = p_filter->pf_sub_buffer_new( p_filter );
577 if( !p_spu ) return NULL;
579 /* Create new SPU region */
580 memset( &fmt, 0, sizeof(video_format_t) );
581 fmt.i_chroma = VLC_FOURCC('Y','U','V','A');
582 fmt.i_aspect = VOUT_ASPECT_FACTOR;
583 fmt.i_width = fmt.i_visible_width = p_sys->i_width;
584 fmt.i_height = fmt.i_visible_height = p_sys->i_height;
585 fmt.i_x_offset = fmt.i_y_offset = 0;
586 p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
589 msg_Err( p_filter, "cannot allocate SPU region" );
590 p_filter->pf_sub_buffer_del( p_filter, p_spu );
594 vout_CopyPicture( p_filter, &p_region->picture, p_sys->p_pic );
597 p_spu->i_x = p_sys->posx;
598 p_spu->i_y = p_sys->posy;
599 p_spu->p_region = p_region;
601 p_spu->i_start = p_sys->i_last_date = date;
603 p_spu->b_ephemer = VLC_TRUE;