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 LOGO_HELP N_("Use a local picture as logo on the video")
75 #define CFG_PREFIX "logo-"
77 static const int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
78 static const char *const ppsz_pos_descriptions[] =
79 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
80 N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
82 static int OpenSub ( vlc_object_t * );
83 static int OpenVideo( vlc_object_t * );
84 static void Close ( vlc_object_t * );
87 set_category( CAT_VIDEO )
88 set_subcategory( SUBCAT_VIDEO_SUBPIC )
90 set_capability( "sub filter", 0 )
91 set_callbacks( OpenSub, Close )
92 set_description( N_("Logo sub filter") )
93 set_shortname( N_("Logo overlay") )
94 add_shortcut( "logo" )
96 add_file( CFG_PREFIX "file", NULL, NULL, FILE_TEXT, FILE_LONGTEXT, false )
97 add_integer( CFG_PREFIX "x", 0, NULL, POSX_TEXT, POSX_LONGTEXT, true )
98 add_integer( CFG_PREFIX "y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, true )
99 /* default to 1000 ms per image, continuously cycle through them */
100 add_integer( CFG_PREFIX "delay", 1000, NULL, DELAY_TEXT, DELAY_LONGTEXT, true )
101 add_integer( CFG_PREFIX "repeat", -1, NULL, REPEAT_TEXT, REPEAT_LONGTEXT, true )
102 add_integer_with_range( CFG_PREFIX "transparency", 255, 0, 255, NULL,
103 TRANS_TEXT, TRANS_LONGTEXT, false )
104 add_integer( CFG_PREFIX "position", -1, NULL, POS_TEXT, POS_LONGTEXT, false )
105 change_integer_list( pi_pos_values, ppsz_pos_descriptions, NULL )
107 /* video output filter submodule */
109 set_capability( "video filter2", 0 )
110 set_callbacks( OpenVideo, Close )
111 set_description( N_("Logo video filter") )
112 add_shortcut( "logo" )
116 /*****************************************************************************
118 *****************************************************************************/
121 * Structure to hold the set of individual logo image names, times,
126 int i_delay; /* -1 means use default delay */
127 int i_alpha; /* -1 means use default alpha */
133 * Logo list structure.
137 logo_t *p_logo; /* the parsing's result */
138 unsigned int i_count; /* the number of logo images to be displayed */
140 int i_repeat; /* how often to repeat the images, image time in ms */
141 mtime_t i_next_pic; /* when to bring up a new logo image */
143 unsigned int i_counter; /* index into the list of logo images */
145 int i_delay; /* default delay (0 - 60000 ms) */
146 int i_alpha; /* default alpha */
151 * Private logo data holder
166 /* On the fly control variable */
173 static const char *const ppsz_filter_options[] = {
174 "file", "x", "y", "delay", "repeat", "transparency", "position", NULL
177 static const char *const ppsz_filter_callbacks[] = {
187 static int OpenCommon( vlc_object_t *, bool b_sub );
189 static subpicture_t *FilterSub( filter_t *, mtime_t );
190 static picture_t *FilterVideo( filter_t *, picture_t * );
192 static int Mouse( filter_t *, vlc_mouse_t *, const vlc_mouse_t *, const vlc_mouse_t * );
194 static int LogoCallback( vlc_object_t *, char const *,
195 vlc_value_t, vlc_value_t, void * );
197 static void LogoListLoad( vlc_object_t *, logo_list_t *, const char * );
198 static void LogoListUnload( logo_list_t * );
199 static logo_t *LogoListNext( logo_list_t *p_list, mtime_t i_date );
200 static logo_t *LogoListCurrent( logo_list_t *p_list );
203 * Open the sub filter
205 static int OpenSub( vlc_object_t *p_this )
207 return OpenCommon( p_this, true );
211 * Open the video filter
213 static int OpenVideo( vlc_object_t *p_this )
215 return OpenCommon( p_this, false );
219 * Common open function
221 static int OpenCommon( vlc_object_t *p_this, bool b_sub )
223 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.video );
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 psz_filename = var_CreateGetStringCommand( p_filter, "logo-file" );
265 filter_DeleteBlend( p_sys->p_blend );
269 if( *psz_filename == '\0' )
270 msg_Warn( p_this, "no logo file specified" );
272 p_list->i_alpha = var_CreateGetIntegerCommand( p_filter,
273 "logo-transparency");
274 p_list->i_alpha = __MAX( __MIN( p_list->i_alpha, 255 ), 0 );
276 var_CreateGetIntegerCommand( p_filter, "logo-delay" );
278 var_CreateGetIntegerCommand( p_filter, "logo-repeat" );
280 p_sys->i_pos = var_CreateGetIntegerCommand( p_filter, "logo-position" );
281 p_sys->i_pos_x = var_CreateGetIntegerCommand( p_filter, "logo-x" );
282 p_sys->i_pos_y = var_CreateGetIntegerCommand( p_filter, "logo-y" );
284 /* Ignore aligment if a position is given for video filter */
285 if( !b_sub && p_sys->i_pos_x >= 0 && p_sys->i_pos_y >= 0 )
288 vlc_mutex_init( &p_sys->lock );
289 LogoListLoad( p_this, p_list, psz_filename );
290 p_sys->b_spu_update = true;
291 p_sys->b_mouse_grab = false;
293 for( int i = 0; ppsz_filter_callbacks[i]; i++ )
294 var_AddCallback( p_filter, ppsz_filter_callbacks[i],
295 LogoCallback, p_sys );
300 p_filter->pf_sub_filter = FilterSub;
304 p_filter->pf_video_filter = FilterVideo;
305 p_filter->pf_mouse = Mouse;
308 free( psz_filename );
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_sar_num = fmt.i_sar_den = 1;
389 fmt.i_width = fmt.i_visible_width = p_pic->p[Y_PLANE].i_visible_pitch;
390 fmt.i_height = fmt.i_visible_height = p_pic->p[Y_PLANE].i_visible_lines;
391 fmt.i_x_offset = fmt.i_y_offset = 0;
392 p_region = subpicture_region_New( &fmt );
395 msg_Err( p_filter, "cannot allocate SPU region" );
396 p_filter->pf_sub_buffer_del( p_filter, p_spu );
402 picture_Copy( p_region->p_picture, p_pic );
404 /* where to locate the logo: */
405 if( p_sys->i_pos < 0 )
406 { /* set to an absolute xy */
407 p_region->i_align = OSD_ALIGN_RIGHT | OSD_ALIGN_TOP;
408 p_spu->b_absolute = true;
411 { /* set to one of the 9 relative locations */
412 p_region->i_align = p_sys->i_pos;
413 p_spu->b_absolute = false;
416 p_region->i_x = p_sys->i_pos_x;
417 p_region->i_y = p_sys->i_pos_y;
419 p_spu->p_region = p_region;
421 p_spu->i_alpha = ( p_logo->i_alpha != -1 ?
422 p_logo->i_alpha : p_list->i_alpha );
425 vlc_mutex_unlock( &p_sys->lock );
433 static picture_t *FilterVideo( filter_t *p_filter, picture_t *p_src )
435 filter_sys_t *p_sys = p_filter->p_sys;
436 logo_list_t *p_list = &p_sys->list;
438 picture_t *p_dst = filter_NewPicture( p_filter );
442 picture_Copy( p_dst, p_src );
445 vlc_mutex_lock( &p_sys->lock );
448 if( p_list->i_next_pic < p_src->date )
449 p_logo = LogoListNext( p_list, p_src->date );
451 p_logo = LogoListCurrent( p_list );
454 const picture_t *p_pic = p_logo->p_pic;
457 const video_format_t *p_fmt = &p_pic->format;
458 const int i_dst_w = p_filter->fmt_out.video.i_visible_width;
459 const int i_dst_h = p_filter->fmt_out.video.i_visible_height;
463 if( p_sys->i_pos & SUBPICTURE_ALIGN_BOTTOM )
465 p_sys->i_pos_y = i_dst_h - p_fmt->i_visible_height;
467 else if ( !(p_sys->i_pos & SUBPICTURE_ALIGN_TOP) )
469 p_sys->i_pos_y = ( i_dst_h - p_fmt->i_visible_height ) / 2;
476 if( p_sys->i_pos & SUBPICTURE_ALIGN_RIGHT )
478 p_sys->i_pos_x = i_dst_w - p_fmt->i_visible_width;
480 else if ( !(p_sys->i_pos & SUBPICTURE_ALIGN_LEFT) )
482 p_sys->i_pos_x = ( i_dst_w - p_fmt->i_visible_width ) / 2;
491 const int i_alpha = p_logo->i_alpha != -1 ? p_logo->i_alpha : p_list->i_alpha;
492 if( filter_ConfigureBlend( p_sys->p_blend, i_dst_w, i_dst_h, p_fmt ) ||
493 filter_Blend( p_sys->p_blend, p_dst, p_sys->i_pos_x, p_sys->i_pos_y,
496 msg_Err( p_filter, "failed to blend a picture" );
499 vlc_mutex_unlock( &p_sys->lock );
502 picture_Release( p_src );
506 static int Mouse( filter_t *p_filter, vlc_mouse_t *p_mouse,
507 const vlc_mouse_t *p_old, const vlc_mouse_t *p_new )
509 filter_sys_t *p_sys = p_filter->p_sys;
511 vlc_mutex_lock( &p_sys->lock );
512 logo_t *p_logo = LogoListCurrent( &p_sys->list );
513 const picture_t *p_pic = p_logo->p_pic;
517 const video_format_t *p_fmt = &p_pic->format;
518 const int i_logo_w = p_fmt->i_visible_width;
519 const int i_logo_h = p_fmt->i_visible_height;
521 /* Check if we are over the logo */
522 const bool b_over = p_new->i_x >= p_sys->i_pos_x &&
523 p_new->i_x < p_sys->i_pos_x + i_logo_w &&
524 p_new->i_y >= p_sys->i_pos_y &&
525 p_new->i_y < p_sys->i_pos_y + i_logo_h;
527 if( b_over && vlc_mouse_HasPressed( p_old, p_new, MOUSE_BUTTON_LEFT ) )
528 p_sys->b_mouse_grab = true;
529 else if( vlc_mouse_HasReleased( p_old, p_new, MOUSE_BUTTON_LEFT ) )
530 p_sys->b_mouse_grab = false;
532 if( p_sys->b_mouse_grab )
535 vlc_mouse_GetMotion( &i_dx, &i_dy, p_old, p_new );
536 p_sys->i_pos_x = __MIN( __MAX( p_sys->i_pos_x + i_dx, 0 ),
537 p_filter->fmt_in.video.i_width - i_logo_w );
538 p_sys->i_pos_y = __MIN( __MAX( p_sys->i_pos_y + i_dy, 0 ),
539 p_filter->fmt_in.video.i_height - i_logo_h );
542 if( p_sys->b_mouse_grab || b_over )
544 vlc_mutex_unlock( &p_sys->lock );
548 vlc_mutex_unlock( &p_sys->lock );
554 /*****************************************************************************
555 * Callback to update params on the fly
556 *****************************************************************************/
557 static int LogoCallback( vlc_object_t *p_this, char const *psz_var,
558 vlc_value_t oldval, vlc_value_t newval, void *p_data )
561 filter_sys_t *p_sys = (filter_sys_t *)p_data;
562 logo_list_t *p_list = &p_sys->list;
564 vlc_mutex_lock( &p_sys->lock );
565 if( !strcmp( psz_var, "logo-file" ) )
567 LogoListUnload( p_list );
568 LogoListLoad( p_this, p_list, newval.psz_string );
570 else if ( !strcmp( psz_var, "logo-x" ) )
572 p_sys->i_pos_x = newval.i_int;
574 else if ( !strcmp( psz_var, "logo-y" ) )
576 p_sys->i_pos_y = newval.i_int;
578 else if ( !strcmp( psz_var, "logo-position" ) )
580 p_sys->i_pos = newval.i_int;
582 else if ( !strcmp( psz_var, "logo-transparency" ) )
584 p_list->i_alpha = __MAX( __MIN( newval.i_int, 255 ), 0 );
586 else if ( !strcmp( psz_var, "logo-repeat" ) )
588 p_list->i_repeat = newval.i_int;
590 p_sys->b_spu_update = true;
591 vlc_mutex_unlock( &p_sys->lock );
597 * It loads the logo image into memory.
599 static picture_t *LoadImage( vlc_object_t *p_this, const char *psz_filename )
604 video_format_t fmt_in;
605 video_format_Init( &fmt_in, 0 );
607 video_format_t fmt_out;
608 video_format_Init( &fmt_out, VLC_CODEC_YUVA );
610 image_handler_t *p_image = image_HandlerCreate( p_this );
614 picture_t *p_pic = image_ReadUrl( p_image, psz_filename, &fmt_in, &fmt_out );
615 image_HandlerDelete( p_image );
621 * It loads the logo images into memory.
623 * Read the logo-file input switch, obtaining a list of images and associated
624 * durations and transparencies. Store the image(s), and times. An image
625 * without a stated time or transparency will use the logo-delay and
626 * logo-transparency values.
628 static void LogoListLoad( vlc_object_t *p_this, logo_list_t *p_logo_list,
629 const char *psz_filename )
631 char *psz_list; /* the list: <logo>[,[<delay>[,[<alpha>]]]][;...] */
634 logo_t *p_logo; /* the parsing's result */
636 p_logo_list->i_counter = 0;
637 p_logo_list->i_next_pic = 0;
639 psz_original = psz_list = strdup( psz_filename );
643 /* Count the number logos == number of ';' + 1 */
644 p_logo_list->i_count = 1;
645 for( i = 0; i < strlen( psz_list ); i++ )
647 if( psz_list[i] == ';' )
648 p_logo_list->i_count++;
651 p_logo_list->p_logo =
652 p_logo = calloc( p_logo_list->i_count, sizeof(*p_logo) );
657 for( i = 0; i < p_logo_list->i_count; i++ )
659 char *p_c = strchr( psz_list, ';' );
660 char *p_c2 = strchr( psz_list, ',' );
662 p_logo[i].i_alpha = -1; /* use default settings */
663 p_logo[i].i_delay = -1; /* use default settings */
665 if( p_c2 && ( p_c2 < p_c || !p_c ) )
667 /* <logo>,<delay>[,<alpha>] type */
668 if( p_c2[1] != ',' && p_c2[1] != ';' && p_c2[1] != '\0' )
669 p_logo[i].i_delay = atoi( p_c2+1 );
671 if( ( p_c2 = strchr( p_c2+1, ',' ) )
672 && ( p_c2 < p_c || !p_c ) && p_c2[1] != ';' && p_c2[1] != '\0' )
673 p_logo[i].i_alpha = atoi( p_c2 + 1 );
682 msg_Dbg( p_this, "logo file name %s, delay %d, alpha %d",
683 psz_list, p_logo[i].i_delay, p_logo[i].i_alpha );
684 p_logo[i].p_pic = LoadImage( p_this, psz_list );
685 if( !p_logo[i].p_pic )
687 msg_Warn( p_this, "error while loading logo %s, will be skipped",
695 /* initialize so that on the first update it will wrap back to 0 */
696 p_logo_list->i_counter = p_logo_list->i_count - 1;
698 free( psz_original );
702 * Unload a list of logo and release associated ressources.
704 static void LogoListUnload( logo_list_t *p_list )
706 for( unsigned i = 0; i < p_list->i_count; i++ )
708 logo_t *p_logo = &p_list->p_logo[i];
711 picture_Release( p_logo->p_pic );
713 free( p_list->p_logo );
717 * Go to the next logo and return its pointer.
719 static logo_t *LogoListNext( logo_list_t *p_list, mtime_t i_date )
721 p_list->i_counter = ( p_list->i_counter + 1 ) % p_list->i_count;
723 logo_t *p_logo = LogoListCurrent( p_list );
725 p_list->i_next_pic = i_date + ( p_logo->i_delay != -1 ?
726 p_logo->i_delay : p_list->i_delay ) * 1000;
730 * Return the current logo pointer
732 static logo_t *LogoListCurrent( logo_list_t *p_list )
734 return &p_list->p_logo[p_list->i_counter];