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 *****************************************************************************/
34 #include <vlc_common.h>
35 #include <vlc_plugin.h>
36 #include "vlc_filter.h"
38 #include <vlc_image.h>
45 /*****************************************************************************
47 *****************************************************************************/
48 #define FILE_TEXT N_("Logo filenames")
49 #define FILE_LONGTEXT N_("Full path of the image files to use. Format is " \
50 "<image>[,<delay in ms>[,<alpha>]][;<image>[,<delay>[,<alpha>]]][;...]. " \
51 "If you only have one file, simply enter its filename.")
52 #define REPEAT_TEXT N_("Logo animation # of loops")
53 #define REPEAT_LONGTEXT N_("Number of loops for the logo animation." \
54 "-1 = continuous, 0 = disabled")
55 #define DELAY_TEXT N_("Logo individual image time in ms")
56 #define DELAY_LONGTEXT N_("Individual image display time of 0 - 60000 ms.")
58 #define POSX_TEXT N_("X coordinate")
59 #define POSX_LONGTEXT N_("X coordinate of the logo. You can move the logo " \
60 "by left-clicking it." )
61 #define POSY_TEXT N_("Y coordinate")
62 #define POSY_LONGTEXT N_("Y coordinate of the logo. You can move the logo " \
63 "by left-clicking it." )
64 #define TRANS_TEXT N_("Transparency of the logo")
65 #define TRANS_LONGTEXT N_("Logo transparency value " \
66 "(from 0 for full transparency to 255 for full opacity)." )
67 #define POS_TEXT N_("Logo position")
68 #define POS_LONGTEXT N_( \
69 "Enforce the logo position on the video " \
70 "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
71 "also use combinations of these values, eg 6 = top-right).")
73 #define CFG_PREFIX "logo-"
75 static const int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
76 static const char *const ppsz_pos_descriptions[] =
77 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
78 N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
80 static int OpenSub ( vlc_object_t * );
81 static int OpenVideo( vlc_object_t * );
82 static void Close ( vlc_object_t * );
85 set_category( CAT_VIDEO )
86 set_subcategory( SUBCAT_VIDEO_SUBPIC )
88 set_capability( "sub filter", 0 )
89 set_callbacks( OpenSub, Close )
90 set_description( N_("Logo sub filter") )
91 set_shortname( N_("Logo overlay") )
92 add_shortcut( "logo" )
94 add_file( CFG_PREFIX "file", NULL, NULL, FILE_TEXT, FILE_LONGTEXT, false )
95 add_integer( CFG_PREFIX "x", 0, NULL, POSX_TEXT, POSX_LONGTEXT, true )
96 add_integer( CFG_PREFIX "y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, true )
97 /* default to 1000 ms per image, continuously cycle through them */
98 add_integer( CFG_PREFIX "delay", 1000, NULL, DELAY_TEXT, DELAY_LONGTEXT, true )
99 add_integer( CFG_PREFIX "repeat", -1, NULL, REPEAT_TEXT, REPEAT_LONGTEXT, true )
100 add_integer_with_range( CFG_PREFIX "transparency", 255, 0, 255, NULL,
101 TRANS_TEXT, TRANS_LONGTEXT, false )
102 add_integer( CFG_PREFIX "position", -1, NULL, POS_TEXT, POS_LONGTEXT, false )
103 change_integer_list( pi_pos_values, ppsz_pos_descriptions, NULL )
105 /* video output filter submodule */
107 set_capability( "video filter2", 0 )
108 set_callbacks( OpenVideo, Close )
109 set_description( N_("Logo video filter") )
110 add_shortcut( "logo" )
114 /*****************************************************************************
116 *****************************************************************************/
119 * Structure to hold the set of individual logo image names, times,
124 char *psz_file; /* candidate for deletion -- not needed */
125 int i_delay; /* -1 means use default delay */
126 int i_alpha; /* -1 means use default alpha */
132 * Logo list structure.
136 logo_t *p_logo; /* the parsing's result */
137 unsigned int i_count; /* the number of logo images to be displayed */
139 int i_repeat; /* how often to repeat the images, image time in ms */
140 mtime_t i_next_pic; /* when to bring up a new logo image */
142 unsigned int i_counter; /* index into the list of logo images */
144 int i_delay; /* default delay (0 - 60000 ms) */
145 int i_alpha; /* default alpha */
147 char *psz_filename; /* --logo-file string ( is it really useful
152 * Private logo data holder
167 /* On the fly control variable */
174 static const char *const ppsz_filter_options[] = {
175 "file", "x", "y", "delay", "repeat", "transparency", "position", NULL
178 static const char *const ppsz_filter_callbacks[] = {
188 static int OpenCommon( vlc_object_t *, bool b_sub );
190 static subpicture_t *FilterSub( filter_t *, mtime_t );
191 static picture_t *FilterVideo( filter_t *, picture_t * );
193 static int Mouse( filter_t *, vlc_mouse_t *, const vlc_mouse_t *, const vlc_mouse_t * );
195 static int LogoCallback( vlc_object_t *, char const *,
196 vlc_value_t, vlc_value_t, void * );
198 static void LogoListLoad( vlc_object_t *, logo_list_t * );
199 static void LogoListUnload( logo_list_t * );
200 static logo_t *LogoListNext( logo_list_t *p_list, mtime_t i_date );
201 static logo_t *LogoListCurrent( logo_list_t *p_list );
204 * Open the sub filter
206 static int OpenSub( vlc_object_t *p_this )
208 return OpenCommon( p_this, true );
212 * Open the video filter
214 static int OpenVideo( vlc_object_t *p_this )
216 return OpenCommon( p_this, false );
220 * Common open function
222 static int OpenCommon( vlc_object_t *p_this, bool b_sub )
224 filter_t *p_filter = (filter_t *)p_this;
228 if( !b_sub && !es_format_IsSimilar( &p_filter->fmt_in, &p_filter->fmt_out ) )
230 msg_Err( p_filter, "Input and output format does not match" );
236 p_filter->p_sys = p_sys = malloc( sizeof( *p_sys ) );
241 p_sys->p_blend = NULL;
245 p_sys->p_blend = filter_NewBlend( VLC_OBJECT(p_filter),
246 p_filter->fmt_in.i_codec );
247 if( !p_sys->p_blend )
255 config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
259 logo_list_t *p_list = &p_sys->list;
261 p_list->psz_filename =
262 var_CreateGetStringCommand( p_filter, "logo-file" );
263 if( !p_list->psz_filename || *p_list->psz_filename == '\0' )
265 msg_Err( p_this, "logo file not specified" );
268 filter_DeleteBlend( p_sys->p_blend );
269 free( p_list->psz_filename );
273 p_list->i_alpha = var_CreateGetIntegerCommand( p_filter,
274 "logo-transparency");
275 p_list->i_alpha = __MAX( __MIN( p_list->i_alpha, 255 ), 0 );
277 var_CreateGetIntegerCommand( p_filter, "logo-delay" );
279 var_CreateGetIntegerCommand( p_filter, "logo-repeat" );
281 p_sys->i_pos = var_CreateGetIntegerCommand( p_filter, "logo-position" );
282 p_sys->i_pos_x = var_CreateGetIntegerCommand( p_filter, "logo-x" );
283 p_sys->i_pos_y = var_CreateGetIntegerCommand( p_filter, "logo-y" );
285 /* Ignore aligment if a position is given for video filter */
286 if( !b_sub && p_sys->i_pos_x >= 0 && p_sys->i_pos_y >= 0 )
289 vlc_mutex_init( &p_sys->lock );
290 LogoListLoad( p_this, p_list );
291 p_sys->b_spu_update = true;
292 p_sys->b_mouse_grab = false;
294 for( int i = 0; ppsz_filter_callbacks[i]; i++ )
295 var_AddCallback( p_filter, ppsz_filter_callbacks[i],
296 LogoCallback, p_sys );
301 p_filter->pf_sub_filter = FilterSub;
305 p_filter->pf_video_filter = FilterVideo;
306 p_filter->pf_mouse = Mouse;
313 * Common close function
315 static void Close( vlc_object_t *p_this )
317 filter_t *p_filter = (filter_t *)p_this;
318 filter_sys_t *p_sys = p_filter->p_sys;
320 for( int i = 0; ppsz_filter_callbacks[i]; i++ )
321 var_DelCallback( p_filter, ppsz_filter_callbacks[i],
322 LogoCallback, p_sys );
325 filter_DeleteBlend( p_sys->p_blend );
327 vlc_mutex_destroy( &p_sys->lock );
328 LogoListUnload( &p_sys->list );
335 static subpicture_t *FilterSub( filter_t *p_filter, mtime_t date )
337 filter_sys_t *p_sys = p_filter->p_sys;
338 logo_list_t *p_list = &p_sys->list;
341 subpicture_region_t *p_region;
346 vlc_mutex_lock( &p_sys->lock );
347 /* Basic test: b_spu_update occurs on a dynamic change,
348 & i_next_pic is the general timer, when to
349 look at updating the logo image */
351 if( ( !p_sys->b_spu_update && p_list->i_next_pic > date ) ||
354 vlc_mutex_unlock( &p_sys->lock );
358 /* adjust index to the next logo */
359 p_logo = LogoListNext( p_list, date );
360 p_sys->b_spu_update = false;
362 p_pic = p_logo->p_pic;
364 /* Allocate the subpicture internal data. */
365 p_spu = filter_NewSubpicture( p_filter );
369 p_spu->b_absolute = p_sys->b_absolute;
370 p_spu->i_start = date;
372 p_spu->b_ephemer = true;
374 /* Send an empty subpicture to clear the display when needed */
375 if( p_list->i_repeat != -1 && p_list->i_counter == 0 )
378 if( p_list->i_repeat == 0 )
381 if( !p_pic || !p_logo->i_alpha ||
382 ( p_logo->i_alpha == -1 && !p_list->i_alpha ) )
385 /* Create new SPU region */
386 memset( &fmt, 0, sizeof(video_format_t) );
387 fmt.i_chroma = VLC_CODEC_YUVA;
388 fmt.i_aspect = VOUT_ASPECT_FACTOR;
389 fmt.i_sar_num = fmt.i_sar_den = 1;
390 fmt.i_width = fmt.i_visible_width = p_pic->p[Y_PLANE].i_visible_pitch;
391 fmt.i_height = fmt.i_visible_height = p_pic->p[Y_PLANE].i_visible_lines;
392 fmt.i_x_offset = fmt.i_y_offset = 0;
393 p_region = subpicture_region_New( &fmt );
396 msg_Err( p_filter, "cannot allocate SPU region" );
397 p_filter->pf_sub_buffer_del( p_filter, p_spu );
403 picture_Copy( p_region->p_picture, p_pic );
405 /* where to locate the logo: */
406 if( p_sys->i_pos < 0 )
407 { /* set to an absolute xy */
408 p_region->i_align = OSD_ALIGN_RIGHT | OSD_ALIGN_TOP;
409 p_spu->b_absolute = true;
412 { /* set to one of the 9 relative locations */
413 p_region->i_align = p_sys->i_pos;
414 p_spu->b_absolute = false;
417 p_region->i_x = p_sys->i_pos_x;
418 p_region->i_y = p_sys->i_pos_y;
420 p_spu->p_region = p_region;
422 p_spu->i_alpha = ( p_logo->i_alpha != -1 ?
423 p_logo->i_alpha : p_list->i_alpha );
426 vlc_mutex_unlock( &p_sys->lock );
434 static picture_t *FilterVideo( filter_t *p_filter, picture_t *p_src )
436 filter_sys_t *p_sys = p_filter->p_sys;
437 logo_list_t *p_list = &p_sys->list;
439 picture_t *p_dst = filter_NewPicture( p_filter );
443 picture_Copy( p_dst, p_src );
446 vlc_mutex_lock( &p_sys->lock );
449 if( p_list->i_next_pic < p_src->date )
450 p_logo = LogoListNext( p_list, p_src->date );
452 p_logo = LogoListCurrent( p_list );
455 const picture_t *p_pic = p_logo->p_pic;
458 const video_format_t *p_fmt = &p_pic->format;
459 const int i_dst_w = p_filter->fmt_out.video.i_visible_width;
460 const int i_dst_h = p_filter->fmt_out.video.i_visible_height;
464 if( p_sys->i_pos & SUBPICTURE_ALIGN_BOTTOM )
466 p_sys->i_pos_y = i_dst_h - p_fmt->i_visible_height;
468 else if ( !(p_sys->i_pos & SUBPICTURE_ALIGN_TOP) )
470 p_sys->i_pos_y = ( i_dst_h - p_fmt->i_visible_height ) / 2;
477 if( p_sys->i_pos & SUBPICTURE_ALIGN_RIGHT )
479 p_sys->i_pos_x = i_dst_w - p_fmt->i_visible_width;
481 else if ( !(p_sys->i_pos & SUBPICTURE_ALIGN_LEFT) )
483 p_sys->i_pos_x = ( i_dst_w - p_fmt->i_visible_width ) / 2;
492 const int i_alpha = p_logo->i_alpha != -1 ? p_logo->i_alpha : p_list->i_alpha;
493 if( filter_ConfigureBlend( p_sys->p_blend, i_dst_w, i_dst_h, p_fmt ) ||
494 filter_Blend( p_sys->p_blend, p_dst, p_sys->i_pos_x, p_sys->i_pos_y,
497 msg_Err( p_filter, "failed to blend a picture" );
500 vlc_mutex_unlock( &p_sys->lock );
503 picture_Release( p_src );
507 static int Mouse( filter_t *p_filter, vlc_mouse_t *p_mouse,
508 const vlc_mouse_t *p_old, const vlc_mouse_t *p_new )
510 filter_sys_t *p_sys = p_filter->p_sys;
512 vlc_mutex_lock( &p_sys->lock );
513 logo_t *p_logo = LogoListCurrent( &p_sys->list );
514 const picture_t *p_pic = p_logo->p_pic;
518 const video_format_t *p_fmt = &p_pic->format;
519 const int i_logo_w = p_fmt->i_visible_width;
520 const int i_logo_h = p_fmt->i_visible_height;
522 /* Check if we are over the logo */
523 const bool b_over = p_new->i_x >= p_sys->i_pos_x &&
524 p_new->i_x < p_sys->i_pos_x + i_logo_w &&
525 p_new->i_y >= p_sys->i_pos_y &&
526 p_new->i_y < p_sys->i_pos_y + i_logo_h;
528 if( b_over && vlc_mouse_HasPressed( p_old, p_new, MOUSE_BUTTON_LEFT ) )
529 p_sys->b_mouse_grab = true;
530 else if( vlc_mouse_HasReleased( p_old, p_new, MOUSE_BUTTON_LEFT ) )
531 p_sys->b_mouse_grab = false;
533 msg_Err( p_filter, "Mouse: %d G: %d", b_over, p_sys->b_mouse_grab );
535 if( p_sys->b_mouse_grab )
538 vlc_mouse_GetMotion( &i_dx, &i_dy, p_old, p_new );
539 msg_Err( p_filter, "Mouse: d=%d:%d", i_dx, i_dy );
540 p_sys->i_pos_x = __MIN( __MAX( p_sys->i_pos_x + i_dx, 0 ),
541 p_filter->fmt_in.video.i_width - i_logo_w );
542 p_sys->i_pos_y = __MIN( __MAX( p_sys->i_pos_y + i_dy, 0 ),
543 p_filter->fmt_in.video.i_height - i_logo_h );
546 if( p_sys->b_mouse_grab || b_over )
548 vlc_mutex_unlock( &p_sys->lock );
552 vlc_mutex_unlock( &p_sys->lock );
560 /*****************************************************************************
561 * MouseEvent: callback for mouse events
562 *****************************************************************************/
563 static int MouseEvent( vlc_object_t *p_this, char const *psz_var,
564 vlc_value_t oldval, vlc_value_t newval, void *p_data )
566 vout_thread_t *p_vout = p_data;
567 assert( p_this == VLC_OBJECT(p_vout->p_sys->p_vout) );
570 vout_sys_t *p_sys = p_vout->p_sys;
571 const int i_delta = newval.i_int - oldval.i_int;
572 const int i_bdown = var_GetInteger( p_sys->p_vout, "mouse-button-down" );
574 if( (i_bdown & 0x1) == 0 )
580 if( psz_var[6] == 'x' )
582 i_y = var_GetInteger( p_sys->p_vout, "mouse-y" );
586 else if( psz_var[6] == 'y' )
589 i_x = var_GetInteger( p_sys->p_vout, "mouse-x" );
597 /* FIXME missing lock */
598 if( i_x < (int)p_sys->i_pos_x ||
599 i_y < (int)p_sys->i_pos_y ||
600 i_x > (int)(p_sys->i_pos_x + p_sys->i_width) ||
601 i_y > (int)(p_sys->i_pos_y + p_sys->i_height) )
604 p_sys->i_pos_x = __MIN( __MAX( p_sys->i_pos_x + i_dx, 0 ),
605 p_vout->output.i_width - p_sys->i_width );
606 p_sys->i_pos_y = __MIN( __MAX( p_sys->i_pos_y + i_dy, 0 ),
607 p_vout->output.i_height - p_sys->i_height );
611 return var_Set( p_vout, psz_var, newval );
615 /*****************************************************************************
616 * Callback to update params on the fly
617 *****************************************************************************/
618 static int LogoCallback( vlc_object_t *p_this, char const *psz_var,
619 vlc_value_t oldval, vlc_value_t newval, void *p_data )
622 filter_sys_t *p_sys = (filter_sys_t *)p_data;
623 logo_list_t *p_list = &p_sys->list;
625 vlc_mutex_lock( &p_sys->lock );
626 if( !strcmp( psz_var, "logo-file" ) )
628 LogoListUnload( p_list );
629 p_list->psz_filename = strdup( newval.psz_string );
630 LogoListLoad( p_this, p_list );
632 else if ( !strcmp( psz_var, "logo-x" ) )
634 p_sys->i_pos_x = newval.i_int;
636 else if ( !strcmp( psz_var, "logo-y" ) )
638 p_sys->i_pos_y = newval.i_int;
640 else if ( !strcmp( psz_var, "logo-position" ) )
642 p_sys->i_pos = newval.i_int;
644 else if ( !strcmp( psz_var, "logo-transparency" ) )
646 p_list->i_alpha = __MAX( __MIN( newval.i_int, 255 ), 0 );
648 else if ( !strcmp( psz_var, "logo-repeat" ) )
650 p_list->i_repeat = newval.i_int;
652 p_sys->b_spu_update = true;
653 vlc_mutex_unlock( &p_sys->lock );
659 * It loads the logo image into memory.
661 static picture_t *LoadImage( vlc_object_t *p_this, char *psz_filename )
663 video_format_t fmt_in;
664 video_format_Init( &fmt_in, 0 );
666 video_format_t fmt_out;
667 video_format_Init( &fmt_out, VLC_CODEC_YUVA );
669 image_handler_t *p_image = image_HandlerCreate( p_this );
673 picture_t *p_pic = image_ReadUrl( p_image, psz_filename, &fmt_in, &fmt_out );
674 image_HandlerDelete( p_image );
680 * It loads the logo images into memory.
682 * Read the logo-file input switch, obtaining a list of images and associated
683 * durations and transparencies. Store the image(s), and times. An image
684 * without a stated time or transparency will use the logo-delay and
685 * logo-transparency values.
687 static void LogoListLoad( vlc_object_t *p_this, logo_list_t *p_logo_list )
689 char *psz_list; /* the list: <logo>[,[<delay>[,[<alpha>]]]][;...] */
691 logo_t *p_logo; /* the parsing's result */
693 p_logo_list->i_counter = 0;
694 p_logo_list->i_next_pic = 0;
696 psz_list = strdup( p_logo_list->psz_filename );
698 /* Count the number logos == number of ';' + 1 */
699 p_logo_list->i_count = 1;
700 for( i = 0; i < strlen( psz_list ); i++ )
702 if( psz_list[i] == ';' )
703 p_logo_list->i_count++;
706 p_logo_list->p_logo =
707 p_logo = calloc( p_logo_list->i_count, sizeof(*p_logo) );
710 for( i = 0; i < p_logo_list->i_count; i++ )
712 char *p_c = strchr( psz_list, ';' );
713 char *p_c2 = strchr( psz_list, ',' );
715 p_logo[i].i_alpha = -1; /* use default settings */
716 p_logo[i].i_delay = -1; /* use default settings */
718 if( p_c2 && ( p_c2 < p_c || !p_c ) )
720 /* <logo>,<delay>[,<alpha>] type */
721 if( p_c2[1] != ',' && p_c2[1] != ';' && p_c2[1] != '\0' )
722 p_logo[i].i_delay = atoi( p_c2+1 );
724 if( ( p_c2 = strchr( p_c2+1, ',' ) )
725 && ( p_c2 < p_c || !p_c ) && p_c2[1] != ';' && p_c2[1] != '\0' )
726 p_logo[i].i_alpha = atoi( p_c2 + 1 );
735 p_logo[i].psz_file = strdup( psz_list );
736 p_logo[i].p_pic = LoadImage( p_this, p_logo[i].psz_file );
738 if( !p_logo[i].p_pic )
740 msg_Warn( p_this, "error while loading logo %s, will be skipped",
741 p_logo[i].psz_file );
748 for( i = 0; i < p_logo_list->i_count; i++ )
750 msg_Dbg( p_this, "logo file name %s, delay %d, alpha %d",
751 p_logo[i].psz_file, p_logo[i].i_delay, p_logo[i].i_alpha );
754 /* initialize so that on the first update it will wrap back to 0 */
755 p_logo_list->i_counter = p_logo_list->i_count - 1;
759 * Unload a list of logo and release associated ressources.
761 static void LogoListUnload( logo_list_t *p_list )
763 free( p_list->psz_filename );
765 for( unsigned i = 0; i < p_list->i_count; i++ )
767 logo_t *p_logo = &p_list->p_logo[i];
769 free( p_logo->psz_file );
772 picture_Release( p_logo->p_pic );
773 p_logo->p_pic = NULL;
779 * Go to the next logo and return its pointer.
781 static logo_t *LogoListNext( logo_list_t *p_list, mtime_t i_date )
783 p_list->i_counter = ( p_list->i_counter + 1 ) % p_list->i_count;
785 logo_t *p_logo = LogoListCurrent( p_list );
787 p_list->i_next_pic = i_date + ( p_logo->i_delay != -1 ?
788 p_logo->i_delay : p_list->i_delay ) * 1000;
792 * Return the current logo pointer
794 static logo_t *LogoListCurrent( logo_list_t *p_list )
796 return &p_list->p_logo[p_list->i_counter];