1 /*****************************************************************************
2 * logo.c : logo video plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2003-2006 the VideoLAN team
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
36 #include "vlc_filter.h"
37 #include "filter_common.h"
38 #include "vlc_image.h"
45 /*****************************************************************************
47 *****************************************************************************/
48 static int Create ( vlc_object_t * );
49 static void Destroy ( vlc_object_t * );
51 static int Init ( vout_thread_t * );
52 static void End ( vout_thread_t * );
53 static void Render ( vout_thread_t *, picture_t * );
55 static int SendEvents( vlc_object_t *, char const *,
56 vlc_value_t, vlc_value_t, void * );
57 static int MouseEvent( vlc_object_t *, char const *,
58 vlc_value_t , vlc_value_t , void * );
59 static int Control ( vout_thread_t *, int, va_list );
61 static int CreateFilter ( vlc_object_t * );
62 static void DestroyFilter( vlc_object_t * );
64 static int LogoCallback( vlc_object_t *, char const *,
65 vlc_value_t, vlc_value_t, void * );
67 /*****************************************************************************
69 *****************************************************************************/
70 #define FILE_TEXT N_("Logo filenames")
71 #define FILE_LONGTEXT N_("Full path of the image files to use. Format is " \
72 "<image>[,<delay in ms>[,<alpha>]][;<image>[,<delay>[,<alpha>]]][;...]. " \
73 "If you only have one file, simply enter its filename.")
74 #define REPEAT_TEXT N_("Logo animation # of loops")
75 #define REPEAT_LONGTEXT N_("Number of loops for the logo animation." \
76 "-1 = continuous, 0 = disabled")
77 #define DELAY_TEXT N_("Logo individual image time in ms")
78 #define DELAY_LONGTEXT N_("Individual image display time of 0 - 60000 ms.")
80 #define POSX_TEXT N_("X coordinate")
81 #define POSX_LONGTEXT N_("X coordinate of the logo. You can move the logo " \
82 "by left-clicking it." )
83 #define POSY_TEXT N_("Y coordinate")
84 #define POSY_LONGTEXT N_("Y coordinate of the logo. You can move the logo " \
85 "by left-clicking it." )
86 #define TRANS_TEXT N_("Transparency of the logo")
87 #define TRANS_LONGTEXT N_("Logo transparency value " \
88 "(from 0 for full transparency to 255 for full opacity)." )
89 #define POS_TEXT N_("Logo position")
90 #define POS_LONGTEXT N_( \
91 "Enforce the logo position on the video " \
92 "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
93 "also use combinations of these values, eg 6 = top-right).")
95 #define CFG_PREFIX "logo-"
97 static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
98 static const char *ppsz_pos_descriptions[] =
99 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
100 N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
103 set_description( _("Logo video filter") );
104 set_capability( "video filter", 0 );
105 set_shortname( _("Logo overlay") );
106 set_category( CAT_VIDEO );
107 set_subcategory( SUBCAT_VIDEO_SUBPIC );
108 add_shortcut( "logo" );
109 set_callbacks( Create, Destroy );
111 add_file( CFG_PREFIX "file", NULL, NULL, FILE_TEXT, FILE_LONGTEXT, VLC_FALSE );
112 add_integer( CFG_PREFIX "x", 0, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_TRUE );
113 add_integer( CFG_PREFIX "y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_TRUE );
114 /* default to 1000 ms per image, continuously cycle through them */
115 add_integer( CFG_PREFIX "delay", 1000, NULL, DELAY_TEXT, DELAY_LONGTEXT, VLC_TRUE );
116 add_integer( CFG_PREFIX "repeat", -1, NULL, REPEAT_TEXT, REPEAT_LONGTEXT, VLC_TRUE );
117 add_integer_with_range( CFG_PREFIX "transparency", 255, 0, 255, NULL,
118 TRANS_TEXT, TRANS_LONGTEXT, VLC_FALSE );
119 add_integer( CFG_PREFIX "position", -1, NULL, POS_TEXT, POS_LONGTEXT, VLC_FALSE );
120 change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
122 /* subpicture filter submodule */
124 set_capability( "sub filter", 0 );
125 set_callbacks( CreateFilter, DestroyFilter );
126 set_description( _("Logo sub filter") );
129 static const char *ppsz_filter_options[] = {
130 "file", "x", "y", "delay", "repeat", "transparency", "position", NULL
133 /*****************************************************************************
134 * Structure to hold the set of individual logo image names, times,
136 ****************************************************************************/
139 char *psz_file; /* candidate for deletion -- not needed */
140 int i_delay; /* -1 means use default delay */
141 int i_alpha; /* -1 means use default alpha */
146 /*****************************************************************************
147 * Logo list structure. Common to both the vout and sub picture filter
148 ****************************************************************************/
151 logo_t *p_logo; /* the parsing's result */
152 unsigned int i_count; /* the number of logo images to be displayed */
154 int i_repeat; /* how often to repeat the images, image time in ms */
155 mtime_t i_next_pic; /* when to bring up a new logo image */
157 unsigned int i_counter; /* index into the list of logo images */
159 int i_delay; /* default delay (0 - 60000 ms) */
160 int i_alpha; /* default alpha */
162 char *psz_filename; /* --logo-file string ( is it really useful
168 /*****************************************************************************
169 * LoadImage: loads the logo image into memory
170 *****************************************************************************/
171 static picture_t *LoadImage( vlc_object_t *p_this, char *psz_filename )
174 image_handler_t *p_image;
175 video_format_t fmt_in;
176 video_format_t fmt_out;
178 memset( &fmt_in, 0, sizeof(video_format_t) );
179 memset( &fmt_out, 0, sizeof(video_format_t) );
181 fmt_out.i_chroma = VLC_FOURCC('Y','U','V','A');
182 p_image = image_HandlerCreate( p_this );
183 p_pic = image_ReadUrl( p_image, psz_filename, &fmt_in, &fmt_out );
184 image_HandlerDelete( p_image );
189 /*****************************************************************************
190 * LoadLogoList: loads the logo images into memory
191 *****************************************************************************
192 * Read the logo-file input switch, obtaining a list of images and associated
193 * durations and transparencies. Store the image(s), and times. An image
194 * without a stated time or transparency will use the logo-delay and
195 * logo-transparency values.
196 *****************************************************************************/
197 #define LoadLogoList( a, b ) __LoadLogoList( VLC_OBJECT( a ), b )
198 static void __LoadLogoList( vlc_object_t *p_this, logo_list_t *p_logo_list )
200 char *psz_list; /* the list: <logo>[,[<delay>[,[<alpha>]]]][;...] */
202 logo_t *p_logo; /* the parsing's result */
204 p_logo_list->i_counter = 0;
205 p_logo_list->i_next_pic = 0;
207 psz_list = strdup( p_logo_list->psz_filename );
209 /* Count the number logos == number of ';' + 1 */
210 p_logo_list->i_count = 1;
211 for( i = 0; i < strlen( psz_list ); i++ )
213 if( psz_list[i] == ';' ) p_logo_list->i_count++;
216 p_logo_list->p_logo = p_logo =
217 (logo_t *)malloc( p_logo_list->i_count * sizeof(logo_t) );
220 for( i = 0; i < p_logo_list->i_count; i++ )
224 p_c = strchr( psz_list, ';' );
225 p_c2 = strchr( psz_list, ',' );
227 p_logo[i].i_alpha = -1; /* use default settings */
228 p_logo[i].i_delay = -1; /* use default settings */
230 if( p_c2 && ( p_c2 < p_c || !p_c ) )
232 /* <logo>,<delay>[,<alpha>] type */
233 if( p_c2[1] != ',' && p_c2[1] != ';' && p_c2[1] != '\0' )
234 p_logo[i].i_delay = atoi( p_c2+1 );
236 if( ( p_c2 = strchr( p_c2+1, ',' ) )
237 && ( p_c2 < p_c || !p_c ) && p_c2[1] != ';' && p_c2[1] != '\0' )
238 p_logo[i].i_alpha = atoi( p_c2 + 1 );
243 if( p_c ) *p_c = '\0';
246 p_logo[i].psz_file = strdup( psz_list );
247 p_logo[i].p_pic = LoadImage( p_this, p_logo[i].psz_file );
249 if( !p_logo[i].p_pic )
251 msg_Warn( p_this, "error while loading logo %s, will be skipped",
252 p_logo[i].psz_file );
255 if( p_c ) psz_list = p_c + 1;
258 for( i = 0; i < p_logo_list->i_count; i++ )
260 msg_Dbg( p_this, "logo file name %s, delay %d, alpha %d",
261 p_logo[i].psz_file, p_logo[i].i_delay, p_logo[i].i_alpha );
264 /* initialize so that on the first update it will wrap back to 0 */
265 p_logo_list->i_counter = p_logo_list->i_count;
268 /*****************************************************************************
270 *****************************************************************************/
271 static void FreeLogoList( logo_list_t *p_logo_list )
274 FREENULL( p_logo_list->psz_filename );
275 for( i = 0; i < p_logo_list->i_count; i++ )
277 logo_t *p_logo = &p_logo_list->p_logo[i];
278 FREENULL( p_logo->psz_file );
281 p_logo->p_pic->pf_release( p_logo->p_pic );
282 p_logo->p_pic = NULL;
287 /*****************************************************************************
288 * vout_sys_t: logo video output method descriptor
289 *****************************************************************************
290 * This structure is part of the video output thread descriptor.
291 * It describes the Invert specific properties of an output thread.
292 *****************************************************************************/
295 logo_list_t *p_logo_list;
297 vout_thread_t *p_vout;
301 int i_width, i_height;
305 /*****************************************************************************
306 * Create: allocates logo video thread output method
307 *****************************************************************************/
308 static int Create( vlc_object_t *p_this )
310 vout_thread_t *p_vout = (vout_thread_t *)p_this;
312 logo_list_t *p_logo_list;
314 /* Allocate structure */
315 p_sys = p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
318 msg_Err( p_vout, "out of memory" );
321 p_logo_list = p_sys->p_logo_list = malloc( sizeof( logo_list_t ) );
322 if( p_logo_list == NULL )
324 msg_Err( p_vout, "out of memory" );
329 config_ChainParse( p_vout, CFG_PREFIX, ppsz_filter_options,
332 p_logo_list->psz_filename = var_CreateGetStringCommand( p_vout,
334 if( !p_logo_list->psz_filename || !*p_logo_list->psz_filename )
336 msg_Err( p_vout, "logo file not specified" );
340 p_vout->pf_init = Init;
341 p_vout->pf_end = End;
342 p_vout->pf_manage = NULL;
343 p_vout->pf_render = Render;
344 p_vout->pf_display = NULL;
345 p_vout->pf_control = Control;
347 p_sys->pos = var_CreateGetIntegerCommand( p_vout, "logo-position" );
348 p_sys->posx = var_CreateGetIntegerCommand( p_vout, "logo-x" );
349 p_sys->posy = var_CreateGetIntegerCommand( p_vout, "logo-y" );
350 p_logo_list->i_delay = __MAX( __MIN(
351 var_CreateGetIntegerCommand( p_vout, "logo-delay" ) , 60000 ), 0 );
352 p_logo_list->i_repeat = var_CreateGetIntegerCommand( p_vout, "logo-repeat");
353 p_logo_list->i_alpha = __MAX( __MIN(
354 var_CreateGetIntegerCommand( p_vout, "logo-transparency" ), 255 ), 0 );
356 LoadLogoList( p_vout, p_logo_list );
361 /*****************************************************************************
362 * Init: initialize logo video thread output method
363 *****************************************************************************/
364 static int Init( vout_thread_t *p_vout )
366 vout_sys_t *p_sys = p_vout->p_sys;
370 logo_list_t *p_logo_list = p_sys->p_logo_list;
372 I_OUTPUTPICTURES = 0;
373 memset( &fmt, 0, sizeof(video_format_t) );
375 /* adjust index to the next logo */
376 p_logo_list->i_counter =
377 ( p_logo_list->i_counter + 1 )%p_logo_list->i_count;
379 p_pic = p_logo_list->p_logo[p_logo_list->i_counter].p_pic;
380 /* Initialize the output structure */
381 p_vout->output.i_chroma = p_vout->render.i_chroma;
382 p_vout->output.i_width = p_vout->render.i_width;
383 p_vout->output.i_height = p_vout->render.i_height;
384 p_vout->output.i_aspect = p_vout->render.i_aspect;
385 p_vout->fmt_out = p_vout->fmt_in;
386 fmt = p_vout->fmt_out;
388 /* Load the video blending filter */
389 p_sys->p_blend = vlc_object_create( p_vout, sizeof(filter_t) );
390 vlc_object_attach( p_sys->p_blend, p_vout );
391 p_sys->p_blend->fmt_out.video.i_x_offset =
392 p_sys->p_blend->fmt_out.video.i_y_offset = 0;
393 p_sys->p_blend->fmt_in.video.i_x_offset =
394 p_sys->p_blend->fmt_in.video.i_y_offset = 0;
395 p_sys->p_blend->fmt_out.video.i_aspect = p_vout->render.i_aspect;
396 p_sys->p_blend->fmt_out.video.i_chroma = p_vout->output.i_chroma;
397 p_sys->p_blend->fmt_in.video.i_chroma = VLC_FOURCC('Y','U','V','A');
398 p_sys->p_blend->fmt_in.video.i_aspect = VOUT_ASPECT_FACTOR;
400 p_sys->p_blend->fmt_in.video.i_width =
401 p_sys->p_blend->fmt_in.video.i_visible_width =
402 p_pic ? p_pic->p[Y_PLANE].i_visible_pitch : 0;
404 p_sys->p_blend->fmt_in.video.i_height =
405 p_sys->p_blend->fmt_in.video.i_visible_height =
406 p_pic ? p_pic->p[Y_PLANE].i_visible_lines : 0;
407 p_sys->p_blend->fmt_out.video.i_width =
408 p_sys->p_blend->fmt_out.video.i_visible_width =
409 p_vout->output.i_width;
410 p_sys->p_blend->fmt_out.video.i_height =
411 p_sys->p_blend->fmt_out.video.i_visible_height =
412 p_vout->output.i_height;
414 p_sys->p_blend->p_module =
415 module_Need( p_sys->p_blend, "video blending", 0, 0 );
416 if( !p_sys->p_blend->p_module )
418 msg_Err( p_vout, "can't open blending filter, aborting" );
419 vlc_object_detach( p_sys->p_blend );
420 vlc_object_destroy( p_sys->p_blend );
424 if( p_sys->posx < 0 || p_sys->posy < 0 )
426 p_sys->posx = 0; p_sys->posy = 0;
428 if( p_sys->pos & SUBPICTURE_ALIGN_BOTTOM )
430 p_sys->posy = p_vout->render.i_height - p_sys->i_height;
432 else if ( !(p_sys->pos & SUBPICTURE_ALIGN_TOP) )
434 p_sys->posy = p_vout->render.i_height / 2 - p_sys->i_height / 2;
437 if( p_sys->pos & SUBPICTURE_ALIGN_RIGHT )
439 p_sys->posx = p_vout->render.i_width - p_sys->i_width;
441 else if ( !(p_sys->pos & SUBPICTURE_ALIGN_LEFT) )
443 p_sys->posx = p_vout->render.i_width / 2 - p_sys->i_width / 2;
451 /* Try to open the real video output */
452 msg_Dbg( p_vout, "spawning the real video output" );
454 p_sys->p_vout = vout_Create( p_vout, &fmt );
456 /* Everything failed */
457 if( p_sys->p_vout == NULL )
459 msg_Err( p_vout, "can't open vout, aborting" );
463 var_AddCallback( p_sys->p_vout, "mouse-x", MouseEvent, p_vout);
464 var_AddCallback( p_sys->p_vout, "mouse-y", MouseEvent, p_vout);
466 ALLOCATE_DIRECTBUFFERS( VOUT_MAX_PICTURES );
467 ADD_CALLBACKS( p_sys->p_vout, SendEvents );
468 ADD_PARENT_CALLBACKS( SendEventsToChild );
473 /*****************************************************************************
474 * End: terminate logo video thread output method
475 *****************************************************************************/
476 static void End( vout_thread_t *p_vout )
478 vout_sys_t *p_sys = p_vout->p_sys;
481 /* Free the fake output buffers we allocated */
482 for( i_index = I_OUTPUTPICTURES ; i_index ; )
485 free( PP_OUTPUTPICTURE[ i_index ]->p_data_orig );
488 var_DelCallback( p_sys->p_vout, "mouse-x", MouseEvent, p_vout);
489 var_DelCallback( p_sys->p_vout, "mouse-y", MouseEvent, p_vout);
493 DEL_CALLBACKS( p_sys->p_vout, SendEvents );
494 vlc_object_detach( p_sys->p_vout );
495 vout_Destroy( p_sys->p_vout );
498 if( p_sys->p_blend->p_module )
499 module_Unneed( p_sys->p_blend, p_sys->p_blend->p_module );
500 vlc_object_detach( p_sys->p_blend );
501 vlc_object_destroy( p_sys->p_blend );
504 /*****************************************************************************
505 * Destroy: destroy logo video thread output method
506 *****************************************************************************/
507 static void Destroy( vlc_object_t *p_this )
509 vout_thread_t *p_vout = (vout_thread_t *)p_this;
510 vout_sys_t *p_sys = p_vout->p_sys;
512 DEL_PARENT_CALLBACKS( SendEventsToChild );
514 FreeLogoList( p_sys->p_logo_list );
515 free( p_sys->p_logo_list );
520 /*****************************************************************************
521 * Render: render the logo onto the video
522 *****************************************************************************/
523 static void Render( vout_thread_t *p_vout, picture_t *p_inpic )
525 vout_sys_t *p_sys = p_vout->p_sys;
528 logo_list_t *p_logo_list;
531 p_logo_list = p_sys->p_logo_list;
533 if( p_logo_list->i_next_pic < p_inpic->date )
535 /* It's time to use a new logo */
536 p_logo_list->i_counter =
537 ( p_logo_list->i_counter + 1 )%p_logo_list->i_count;
538 p_logo = &p_logo_list->p_logo[p_sys->p_logo_list->i_counter];
539 p_pic = p_logo->p_pic;
540 p_logo_list->i_next_pic = p_inpic->date + ( p_logo->i_delay != -1 ?
541 p_logo->i_delay : p_logo_list->i_delay ) * 1000;
546 p_sys->p_blend->fmt_in.video.i_width =
547 p_sys->p_blend->fmt_in.video.i_visible_width =
548 p_pic->p[Y_PLANE].i_visible_pitch;
550 p_sys->p_blend->fmt_in.video.i_height =
551 p_sys->p_blend->fmt_in.video.i_visible_height =
552 p_pic->p[Y_PLANE].i_visible_lines;
556 if( p_sys->pos & SUBPICTURE_ALIGN_BOTTOM )
558 p_sys->posy = p_vout->render.i_height - p_sys->i_height;
560 else if ( !(p_sys->pos & SUBPICTURE_ALIGN_TOP) )
562 p_sys->posy = p_vout->render.i_height/2 - p_sys->i_height/2;
564 if( p_sys->pos & SUBPICTURE_ALIGN_RIGHT )
566 p_sys->posx = p_vout->render.i_width - p_sys->i_width;
568 else if ( !(p_sys->pos & SUBPICTURE_ALIGN_LEFT) )
570 p_sys->posx = p_vout->render.i_width/2 - p_sys->i_width/2;
578 p_logo = &p_logo_list->p_logo[p_sys->p_logo_list->i_counter];
579 p_pic = p_logo->p_pic;
582 /* This is a new frame. Get a structure from the video_output. */
583 while( !(p_outpic = vout_CreatePicture( p_sys->p_vout, 0, 0, 0 )) )
585 if( p_vout->b_die || p_vout->b_error ) return;
586 msleep( VOUT_OUTMEM_SLEEP );
589 vout_CopyPicture( p_vout, p_outpic, p_inpic );
590 vout_DatePicture( p_sys->p_vout, p_outpic, p_inpic->date );
593 p_sys->p_blend->pf_video_blend( p_sys->p_blend, p_outpic, p_outpic,
594 p_pic, p_sys->posx, p_sys->posy,
595 p_logo->i_alpha != -1 ? p_logo->i_alpha
596 : p_logo_list->i_alpha );
598 vout_DisplayPicture( p_sys->p_vout, p_outpic );
601 /*****************************************************************************
602 * SendEvents: forward mouse and keyboard events to the parent p_vout
603 *****************************************************************************/
604 static int SendEvents( vlc_object_t *p_this, char const *psz_var,
605 vlc_value_t oldval, vlc_value_t newval, void *p_data )
607 var_Set( (vlc_object_t *)p_data, psz_var, newval );
611 /*****************************************************************************
612 * MouseEvent: callback for mouse events
613 *****************************************************************************/
614 static int MouseEvent( vlc_object_t *p_this, char const *psz_var,
615 vlc_value_t oldval, vlc_value_t newval, void *p_data )
617 vout_thread_t *p_vout = (vout_thread_t*)p_data;
618 vout_sys_t *p_sys = p_vout->p_sys;
622 var_Get( p_vout->p_sys->p_vout, "mouse-button-down", &valb );
624 i_delta = newval.i_int - oldval.i_int;
626 if( (valb.i_int & 0x1) == 0 )
631 if( psz_var[6] == 'x' )
634 var_Get( p_vout->p_sys->p_vout, "mouse-y", &valy );
635 if( newval.i_int >= (int)p_sys->posx &&
636 valy.i_int >= (int)p_sys->posy &&
637 newval.i_int <= (int)(p_sys->posx + p_sys->i_width) &&
638 valy.i_int <= (int)(p_sys->posy + p_sys->i_height) )
640 p_sys->posx = __MIN( __MAX( p_sys->posx + i_delta, 0 ),
641 p_vout->output.i_width - p_sys->i_width );
644 else if( psz_var[6] == 'y' )
647 var_Get( p_vout->p_sys->p_vout, "mouse-x", &valx );
648 if( valx.i_int >= (int)p_sys->posx &&
649 newval.i_int >= (int)p_sys->posy &&
650 valx.i_int <= (int)(p_sys->posx + p_sys->i_width) &&
651 newval.i_int <= (int)(p_sys->posy + p_sys->i_height) )
653 p_sys->posy = __MIN( __MAX( p_sys->posy + i_delta, 0 ),
654 p_vout->output.i_height - p_sys->i_height );
661 /*****************************************************************************
662 * Control: control facility for the vout (forwards to child vout)
663 *****************************************************************************/
664 static int Control( vout_thread_t *p_vout, int i_query, va_list args )
666 return vout_vaControl( p_vout->p_sys->p_vout, i_query, args );
669 /*****************************************************************************
670 * SendEventsToChild: forward events to the child/children vout
671 *****************************************************************************/
672 static int SendEventsToChild( vlc_object_t *p_this, char const *psz_var,
673 vlc_value_t oldval, vlc_value_t newval, void *p_data )
675 vout_thread_t *p_vout = (vout_thread_t *)p_this;
676 var_Set( p_vout->p_sys->p_vout, psz_var, newval );
680 /*****************************************************************************
681 * filter_sys_t: logo filter descriptor
682 *****************************************************************************/
685 logo_list_t *p_logo_list;
689 vlc_bool_t b_absolute;
692 /* On the fly control variable */
693 vlc_bool_t b_need_update;
696 static subpicture_t *Filter( filter_t *, mtime_t );
698 /*****************************************************************************
699 * CreateFilter: allocates logo video filter
700 *****************************************************************************/
701 static int CreateFilter( vlc_object_t *p_this )
703 filter_t *p_filter = (filter_t *)p_this;
705 logo_list_t *p_logo_list;
707 /* Allocate structure */
708 p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
711 msg_Err( p_filter, "out of memory" );
714 p_logo_list = p_sys->p_logo_list = malloc( sizeof( logo_list_t ) );
715 if( p_logo_list == NULL )
717 msg_Err( p_filter, "out of memory" );
722 config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
725 /* Hook used for callback variables */
726 p_logo_list->psz_filename =
727 var_CreateGetStringCommand( p_filter, "logo-file" );
728 if( !p_logo_list->psz_filename || !*p_logo_list->psz_filename )
730 msg_Err( p_this, "logo file not specified" );
736 p_sys->posx = var_CreateGetIntegerCommand( p_filter, "logo-x" );
737 p_sys->posy = var_CreateGetIntegerCommand( p_filter, "logo-y" );
738 p_sys->pos = var_CreateGetIntegerCommand( p_filter, "logo-position" );
739 p_logo_list->i_alpha = __MAX( __MIN( var_CreateGetIntegerCommand(
740 p_filter, "logo-transparency"), 255 ), 0 );
741 p_logo_list->i_delay =
742 var_CreateGetIntegerCommand( p_filter, "logo-delay" );
743 p_logo_list->i_repeat =
744 var_CreateGetIntegerCommand( p_filter, "logo-repeat" );
746 var_AddCallback( p_filter, "logo-file", LogoCallback, p_sys );
747 var_AddCallback( p_filter, "logo-x", LogoCallback, p_sys );
748 var_AddCallback( p_filter, "logo-y", LogoCallback, p_sys );
749 var_AddCallback( p_filter, "logo-position", LogoCallback, p_sys );
750 var_AddCallback( p_filter, "logo-transparency", LogoCallback, p_sys );
751 var_AddCallback( p_filter, "logo-repeat", LogoCallback, p_sys );
753 vlc_mutex_init( p_filter, &p_logo_list->lock );
754 vlc_mutex_lock( &p_logo_list->lock );
756 LoadLogoList( p_this, p_logo_list );
758 vlc_mutex_unlock( &p_logo_list->lock );
761 p_filter->pf_sub_filter = Filter;
762 p_sys->b_need_update = VLC_TRUE;
764 p_sys->i_last_date = 0;
769 /*****************************************************************************
770 * DestroyFilter: destroy logo video filter
771 *****************************************************************************/
772 static void DestroyFilter( vlc_object_t *p_this )
774 filter_t *p_filter = (filter_t *)p_this;
775 filter_sys_t *p_sys = p_filter->p_sys;
777 vlc_mutex_destroy( &p_sys->p_logo_list->lock );
778 FreeLogoList( p_sys->p_logo_list );
779 free( p_sys->p_logo_list );
782 /* Delete the logo variables from INPUT */
783 var_Destroy( p_filter->p_libvlc, "logo-file" );
784 var_Destroy( p_filter->p_libvlc, "logo-x" );
785 var_Destroy( p_filter->p_libvlc, "logo-y" );
786 var_Destroy( p_filter->p_libvlc, "logo-delay" );
787 var_Destroy( p_filter->p_libvlc, "logo-repeat" );
788 var_Destroy( p_filter->p_libvlc, "logo-position" );
789 var_Destroy( p_filter->p_libvlc, "logo-transparency" );
792 /*****************************************************************************
793 * Filter: the whole thing
794 *****************************************************************************
795 * This function outputs subpictures at regular time intervals.
796 *****************************************************************************/
797 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
799 filter_sys_t *p_sys = p_filter->p_sys;
800 logo_list_t *p_logo_list = p_sys->p_logo_list;
802 subpicture_region_t *p_region;
807 vlc_mutex_lock( &p_logo_list->lock );
808 /* Basic test: b_need_update occurs on a dynamic change,
809 & i_next_pic is the general timer, when to
810 look at updating the logo image */
812 if( ( ( !p_sys->b_need_update ) && ( p_logo_list->i_next_pic > date ) )
813 || !p_logo_list->i_repeat )
815 vlc_mutex_unlock( &p_logo_list->lock );
818 /* prior code tested on && p_sys->i_last_date +5000000 > date ) return 0; */
820 /* adjust index to the next logo */
821 p_logo_list->i_counter =
822 ( p_logo_list->i_counter + 1 )%p_logo_list->i_count;
824 p_logo = &p_logo_list->p_logo[p_logo_list->i_counter];
825 p_pic = p_logo->p_pic;
827 /* Allocate the subpicture internal data. */
828 p_spu = p_filter->pf_sub_buffer_new( p_filter );
831 vlc_mutex_unlock( &p_logo_list->lock );
835 p_spu->b_absolute = p_sys->b_absolute;
836 p_spu->i_start = p_sys->i_last_date = date;
838 p_spu->b_ephemer = VLC_TRUE;
840 p_sys->b_need_update = VLC_FALSE;
841 p_logo_list->i_next_pic = date +
842 ( p_logo->i_delay != -1 ? p_logo->i_delay : p_logo_list->i_delay ) * 1000;
844 if( p_logo_list->i_repeat != -1
845 && p_logo_list->i_counter == 0 )
847 p_logo_list->i_repeat--;
848 if( p_logo_list->i_repeat == 0 )
850 vlc_mutex_unlock( &p_logo_list->lock );
855 if( !p_pic || !p_logo->i_alpha
856 || ( p_logo->i_alpha == -1 && !p_logo_list->i_alpha ) )
858 /* Send an empty subpicture to clear the display */
859 vlc_mutex_unlock( &p_logo_list->lock );
863 /* Create new SPU region */
864 memset( &fmt, 0, sizeof(video_format_t) );
865 fmt.i_chroma = VLC_FOURCC('Y','U','V','A');
866 fmt.i_aspect = VOUT_ASPECT_FACTOR;
867 fmt.i_sar_num = fmt.i_sar_den = 1;
868 fmt.i_width = fmt.i_visible_width = p_pic->p[Y_PLANE].i_visible_pitch;
869 fmt.i_height = fmt.i_visible_height = p_pic->p[Y_PLANE].i_visible_lines;
870 fmt.i_x_offset = fmt.i_y_offset = 0;
871 p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
874 msg_Err( p_filter, "cannot allocate SPU region" );
875 p_filter->pf_sub_buffer_del( p_filter, p_spu );
876 vlc_mutex_unlock( &p_logo_list->lock );
880 vout_CopyPicture( p_filter, &p_region->picture, p_pic );
881 vlc_mutex_unlock( &p_logo_list->lock );
883 /* where to locate the logo: */
885 { /* set to an absolute xy */
886 p_spu->p_region->i_align = OSD_ALIGN_RIGHT | OSD_ALIGN_TOP;
887 p_spu->b_absolute = VLC_TRUE;
890 { /* set to one of the 9 relative locations */
891 p_spu->p_region->i_align = p_sys->pos;
892 p_spu->b_absolute = VLC_FALSE;
895 p_spu->i_x = p_sys->posx;
896 p_spu->i_y = p_sys->posy;
898 p_spu->p_region = p_region;
900 p_spu->i_alpha = ( p_logo->i_alpha != -1 ?
901 p_logo->i_alpha : p_logo_list->i_alpha );
906 /*****************************************************************************
907 * Callback to update params on the fly
908 *****************************************************************************/
909 static int LogoCallback( vlc_object_t *p_this, char const *psz_var,
910 vlc_value_t oldval, vlc_value_t newval, void *p_data )
912 filter_sys_t *p_sys = (filter_sys_t *)p_data;
913 logo_list_t *p_logo_list = p_sys->p_logo_list;
915 if( !strncmp( psz_var, "logo-file", 6 ) )
917 vlc_mutex_lock( &p_logo_list->lock );
918 FreeLogoList( p_logo_list );
919 p_logo_list->psz_filename = strdup( newval.psz_string );
920 LoadLogoList( p_this, p_logo_list );
921 vlc_mutex_unlock( &p_logo_list->lock );
922 p_sys->b_need_update = VLC_TRUE;
924 else if ( !strncmp( psz_var, "logo-x", 6 ) )
926 p_sys->posx = newval.i_int;
928 else if ( !strncmp( psz_var, "logo-y", 6 ) )
930 p_sys->posy = newval.i_int;
932 else if ( !strncmp( psz_var, "logo-position", 12 ) )
934 p_sys->pos = newval.i_int;
936 else if ( !strncmp( psz_var, "logo-transparency", 9 ) )
938 vlc_mutex_lock( &p_logo_list->lock );
939 p_logo_list->i_alpha = __MAX( __MIN( newval.i_int, 255 ), 0 );
940 vlc_mutex_unlock( &p_logo_list->lock );
942 else if ( !strncmp( psz_var, "logo-repeat", 11 ) )
944 vlc_mutex_lock( &p_logo_list->lock );
945 p_logo_list->i_repeat = newval.i_int;
946 vlc_mutex_unlock( &p_logo_list->lock );
948 p_sys->b_need_update = VLC_TRUE;