git.sesse.net Git - vlc/blob - modules/video_filter/logo.c

   1 /*****************************************************************************
   2  * logo.c : logo video plugin for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2003-2006 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Gildas Bazin <gbazin@videolan.org>
   8  *          Simon Latapie <garf@videolan.org>
   9  *
  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.
  14  *
  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.
  19  *
  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  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28
  29 #ifdef HAVE_CONFIG_H
  30 # include "config.h"
  31 #endif
  32
  33 #include <vlc_common.h>
  34 #include <vlc_plugin.h>
  35 #include <vlc_vout.h>
  36
  37 #include "vlc_filter.h"
  38 #include "filter_common.h"
  39 #include "vlc_image.h"
  40 #include "vlc_osd.h"
  41
  42 #ifdef LoadImage
  43 #   undef LoadImage
  44 #endif
  45
  46 /*****************************************************************************
  47  * Local prototypes
  48  *****************************************************************************/
  49 static int  Create    ( vlc_object_t * );
  50 static void Destroy   ( vlc_object_t * );
  51
  52 static int  Init      ( vout_thread_t * );
  53 static void End       ( vout_thread_t * );
  54 static void Render    ( vout_thread_t *, picture_t * );
  55
  56 static int  SendEvents( vlc_object_t *, char const *,
  57                         vlc_value_t, vlc_value_t, void * );
  58 static int  MouseEvent( vlc_object_t *, char const *,
  59                         vlc_value_t , vlc_value_t , void * );
  60 static int  Control   ( vout_thread_t *, int, va_list );
  61
  62 static int  CreateFilter ( vlc_object_t * );
  63 static void DestroyFilter( vlc_object_t * );
  64
  65 static int LogoCallback( vlc_object_t *, char const *,
  66                          vlc_value_t, vlc_value_t, void * );
  67
  68 /*****************************************************************************
  69  * Module descriptor
  70  *****************************************************************************/
  71 #define FILE_TEXT N_("Logo filenames")
  72 #define FILE_LONGTEXT N_("Full path of the image files to use. Format is " \
  73 "<image>[,<delay in ms>[,<alpha>]][;<image>[,<delay>[,<alpha>]]][;...]. " \
  74 "If you only have one file, simply enter its filename.")
  75 #define REPEAT_TEXT N_("Logo animation # of loops")
  76 #define REPEAT_LONGTEXT N_("Number of loops for the logo animation." \
  77         "-1 = continuous, 0 = disabled")
  78 #define DELAY_TEXT N_("Logo individual image time in ms")
  79 #define DELAY_LONGTEXT N_("Individual image display time of 0 - 60000 ms.")
  80
  81 #define POSX_TEXT N_("X coordinate")
  82 #define POSX_LONGTEXT N_("X coordinate of the logo. You can move the logo " \
  83                 "by left-clicking it." )
  84 #define POSY_TEXT N_("Y coordinate")
  85 #define POSY_LONGTEXT N_("Y coordinate of the logo. You can move the logo " \
  86                 "by left-clicking it." )
  87 #define TRANS_TEXT N_("Transparency of the logo")
  88 #define TRANS_LONGTEXT N_("Logo transparency value " \
  89   "(from 0 for full transparency to 255 for full opacity)." )
  90 #define POS_TEXT N_("Logo position")
  91 #define POS_LONGTEXT N_( \
  92   "Enforce the logo position on the video " \
  93   "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
  94   "also use combinations of these values, eg 6 = top-right).")
  95
  96 #define CFG_PREFIX "logo-"
  97
  98 static const int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
  99 static const char *const ppsz_pos_descriptions[] =
 100 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
 101   N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
 102
 103 vlc_module_begin();
 104     set_description( N_("Logo video filter") );
 105     set_capability( "video filter", 0 );
 106     set_shortname( N_("Logo overlay") );
 107     set_category( CAT_VIDEO );
 108     set_subcategory( SUBCAT_VIDEO_SUBPIC );
 109     add_shortcut( "logo" );
 110     set_callbacks( Create, Destroy );
 111
 112     add_file( CFG_PREFIX "file", NULL, NULL, FILE_TEXT, FILE_LONGTEXT, false );
 113     add_integer( CFG_PREFIX "x", 0, NULL, POSX_TEXT, POSX_LONGTEXT, true );
 114     add_integer( CFG_PREFIX "y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, true );
 115     /* default to 1000 ms per image, continuously cycle through them */
 116     add_integer( CFG_PREFIX "delay", 1000, NULL, DELAY_TEXT, DELAY_LONGTEXT, true );
 117     add_integer( CFG_PREFIX "repeat", -1, NULL, REPEAT_TEXT, REPEAT_LONGTEXT, true );
 118     add_integer_with_range( CFG_PREFIX "transparency", 255, 0, 255, NULL,
 119         TRANS_TEXT, TRANS_LONGTEXT, false );
 120     add_integer( CFG_PREFIX "position", -1, NULL, POS_TEXT, POS_LONGTEXT, false );
 121         change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
 122
 123     /* subpicture filter submodule */
 124     add_submodule();
 125     set_capability( "sub filter", 0 );
 126     set_callbacks( CreateFilter, DestroyFilter );
 127     set_description( N_("Logo sub filter") );
 128 vlc_module_end();
 129
 130 static const char *const ppsz_filter_options[] = {
 131     "file", "x", "y", "delay", "repeat", "transparency", "position", NULL
 132 };
 133
 134 /*****************************************************************************
 135  * Structure to hold the set of individual logo image names, times,
 136  * transparencies
 137  ****************************************************************************/
 138 typedef struct
 139 {
 140     char *psz_file;    /* candidate for deletion -- not needed */
 141     int i_delay;       /* -1 means use default delay */
 142     int i_alpha;       /* -1 means use default alpha */
 143     picture_t *p_pic;
 144
 145 } logo_t;
 146
 147 /*****************************************************************************
 148  * Logo list structure. Common to both the vout and sub picture filter
 149  ****************************************************************************/
 150 typedef struct
 151 {
 152     logo_t *p_logo;         /* the parsing's result */
 153     unsigned int i_count;   /* the number of logo images to be displayed */
 154
 155     int i_repeat;         /* how often to repeat the images, image time in ms */
 156     mtime_t i_next_pic;     /* when to bring up a new logo image */
 157
 158     unsigned int i_counter; /* index into the list of logo images */
 159
 160     int i_delay;            /* default delay (0 - 60000 ms) */
 161     int i_alpha;            /* default alpha */
 162
 163     char *psz_filename;     /* --logo-file string ( is it really useful
 164                              * to store it ? ) */
 165
 166     vlc_mutex_t lock;
 167 } logo_list_t;
 168
 169 /*****************************************************************************
 170  * LoadImage: loads the logo image into memory
 171  *****************************************************************************/
 172 static picture_t *LoadImage( vlc_object_t *p_this, char *psz_filename )
 173 {
 174     picture_t *p_pic;
 175     image_handler_t *p_image;
 176     video_format_t fmt_in;
 177     video_format_t fmt_out;
 178
 179     memset( &fmt_in, 0, sizeof(video_format_t) );
 180     memset( &fmt_out, 0, sizeof(video_format_t) );
 181
 182     fmt_out.i_chroma = VLC_FOURCC('Y','U','V','A');
 183     p_image = image_HandlerCreate( p_this );
 184     p_pic = image_ReadUrl( p_image, psz_filename, &fmt_in, &fmt_out );
 185     image_HandlerDelete( p_image );
 186
 187     return p_pic;
 188 }
 189
 190 /*****************************************************************************
 191  * LoadLogoList: loads the logo images into memory
 192  *****************************************************************************
 193  * Read the logo-file input switch, obtaining a list of images and associated
 194  * durations and transparencies.  Store the image(s), and times.  An image
 195  * without a stated time or transparency will use the logo-delay and
 196  * logo-transparency values.
 197  *****************************************************************************/
 198 #define LoadLogoList( a, b ) __LoadLogoList( VLC_OBJECT( a ), b )
 199 static void __LoadLogoList( vlc_object_t *p_this, logo_list_t *p_logo_list )
 200 {
 201     char *psz_list; /* the list: <logo>[,[<delay>[,[<alpha>]]]][;...] */
 202     unsigned int i;
 203     logo_t *p_logo;         /* the parsing's result */
 204
 205     p_logo_list->i_counter = 0;
 206     p_logo_list->i_next_pic = 0;
 207
 208     psz_list = strdup( p_logo_list->psz_filename );
 209
 210     /* Count the number logos == number of ';' + 1 */
 211     p_logo_list->i_count = 1;
 212     for( i = 0; i < strlen( psz_list ); i++ )
 213     {
 214         if( psz_list[i] == ';' ) p_logo_list->i_count++;
 215     }
 216
 217     p_logo_list->p_logo = p_logo =
 218         (logo_t *)malloc( p_logo_list->i_count * sizeof(logo_t) );
 219
 220     /* Fill the data */
 221     for( i = 0; i < p_logo_list->i_count; i++ )
 222     {
 223         char *p_c;
 224         char *p_c2;
 225         p_c = strchr( psz_list, ';' );
 226         p_c2 = strchr( psz_list, ',' );
 227
 228         p_logo[i].i_alpha = -1; /* use default settings */
 229         p_logo[i].i_delay = -1; /* use default settings */
 230
 231         if( p_c2 && ( p_c2 < p_c || !p_c ) )
 232         {
 233             /* <logo>,<delay>[,<alpha>] type */
 234             if( p_c2[1] != ',' && p_c2[1] != ';' && p_c2[1] != '\0' )
 235                 p_logo[i].i_delay = atoi( p_c2+1 );
 236             *p_c2 = '\0';
 237             if( ( p_c2 = strchr( p_c2+1, ',' ) )
 238                 && ( p_c2 < p_c || !p_c ) && p_c2[1] != ';' && p_c2[1] != '\0' )
 239                 p_logo[i].i_alpha = atoi( p_c2 + 1 );
 240         }
 241         else
 242         {
 243             /* <logo> type */
 244             if( p_c ) *p_c = '\0';
 245         }
 246
 247         p_logo[i].psz_file = strdup( psz_list );
 248         p_logo[i].p_pic = LoadImage( p_this, p_logo[i].psz_file );
 249
 250         if( !p_logo[i].p_pic )
 251         {
 252             msg_Warn( p_this, "error while loading logo %s, will be skipped",
 253                       p_logo[i].psz_file );
 254         }
 255
 256         if( p_c ) psz_list = p_c + 1;
 257     }
 258
 259     for( i = 0; i < p_logo_list->i_count; i++ )
 260     {
 261        msg_Dbg( p_this, "logo file name %s, delay %d, alpha %d",
 262                 p_logo[i].psz_file, p_logo[i].i_delay, p_logo[i].i_alpha );
 263     }
 264
 265     /* initialize so that on the first update it will wrap back to 0 */
 266     p_logo_list->i_counter = p_logo_list->i_count;
 267 }
 268
 269 /*****************************************************************************
 270  * FreeLogoList
 271  *****************************************************************************/
 272 static void FreeLogoList( logo_list_t *p_logo_list )
 273 {
 274     unsigned int i;
 275     FREENULL( p_logo_list->psz_filename );
 276     for( i = 0; i < p_logo_list->i_count; i++ )
 277     {
 278         logo_t *p_logo = &p_logo_list->p_logo[i];
 279         FREENULL( p_logo->psz_file );
 280         if( p_logo->p_pic )
 281         {
 282             p_logo->p_pic->pf_release( p_logo->p_pic );
 283             p_logo->p_pic = NULL;
 284         }
 285     }
 286 }
 287
 288 /*****************************************************************************
 289  * vout_sys_t: logo video output method descriptor
 290  *****************************************************************************
 291  * This structure is part of the video output thread descriptor.
 292  * It describes the Invert specific properties of an output thread.
 293  *****************************************************************************/
 294 struct vout_sys_t
 295 {
 296     logo_list_t *p_logo_list;
 297
 298     vout_thread_t *p_vout;
 299
 300     filter_t *p_blend;
 301
 302     int i_width, i_height;
 303     int pos, posx, posy;
 304 };
 305
 306 /*****************************************************************************
 307  * Create: allocates logo video thread output method
 308  *****************************************************************************/
 309 static int Create( vlc_object_t *p_this )
 310 {
 311     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 312     vout_sys_t *p_sys;
 313     logo_list_t *p_logo_list;
 314
 315     /* Allocate structure */
 316     p_sys = p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
 317     if( p_sys == NULL )
 318         return VLC_ENOMEM;
 319     p_logo_list = p_sys->p_logo_list = malloc( sizeof( logo_list_t ) );
 320     if( p_logo_list == NULL )
 321     {
 322         free( p_sys );
 323         return VLC_ENOMEM;
 324     }
 325
 326     config_ChainParse( p_vout, CFG_PREFIX, ppsz_filter_options,
 327                        p_vout->p_cfg );
 328
 329     p_logo_list->psz_filename = var_CreateGetStringCommand( p_vout,
 330                                                             "logo-file" );
 331     if( !p_logo_list->psz_filename || !*p_logo_list->psz_filename )
 332     {
 333         msg_Err( p_vout, "logo file not specified" );
 334         return VLC_EGENERIC;
 335     }
 336
 337     p_vout->pf_init = Init;
 338     p_vout->pf_end = End;
 339     p_vout->pf_manage = NULL;
 340     p_vout->pf_render = Render;
 341     p_vout->pf_display = NULL;
 342     p_vout->pf_control = Control;
 343
 344     p_sys->pos = var_CreateGetIntegerCommand( p_vout, "logo-position" );
 345     p_sys->posx = var_CreateGetIntegerCommand( p_vout, "logo-x" );
 346     p_sys->posy = var_CreateGetIntegerCommand( p_vout, "logo-y" );
 347     p_logo_list->i_delay = __MAX( __MIN(
 348         var_CreateGetIntegerCommand( p_vout, "logo-delay" ) , 60000 ), 0 );
 349     p_logo_list->i_repeat = var_CreateGetIntegerCommand( p_vout, "logo-repeat");
 350     p_logo_list->i_alpha = __MAX( __MIN(
 351         var_CreateGetIntegerCommand( p_vout, "logo-transparency" ), 255 ), 0 );
 352
 353     LoadLogoList( p_vout, p_logo_list );
 354
 355     return VLC_SUCCESS;
 356 }
 357
 358 /*****************************************************************************
 359  * Init: initialize logo video thread output method
 360  *****************************************************************************/
 361 static int Init( vout_thread_t *p_vout )
 362 {
 363     vout_sys_t *p_sys = p_vout->p_sys;
 364     picture_t *p_pic;
 365     int i_index;
 366     video_format_t fmt;
 367     logo_list_t *p_logo_list = p_sys->p_logo_list;
 368
 369     I_OUTPUTPICTURES = 0;
 370     memset( &fmt, 0, sizeof(video_format_t) );
 371
 372     /* adjust index to the next logo */
 373     p_logo_list->i_counter =
 374                         ( p_logo_list->i_counter + 1 )%p_logo_list->i_count;
 375
 376     p_pic = p_logo_list->p_logo[p_logo_list->i_counter].p_pic;
 377     /* Initialize the output structure */
 378     p_vout->output.i_chroma = p_vout->render.i_chroma;
 379     p_vout->output.i_width  = p_vout->render.i_width;
 380     p_vout->output.i_height = p_vout->render.i_height;
 381     p_vout->output.i_aspect = p_vout->render.i_aspect;
 382     p_vout->fmt_out = p_vout->fmt_in;
 383     fmt = p_vout->fmt_out;
 384
 385     /* Load the video blending filter */
 386     p_sys->p_blend = vlc_object_create( p_vout, sizeof(filter_t) );
 387     vlc_object_attach( p_sys->p_blend, p_vout );
 388     p_sys->p_blend->fmt_out.video.i_x_offset =
 389         p_sys->p_blend->fmt_out.video.i_y_offset = 0;
 390     p_sys->p_blend->fmt_in.video.i_x_offset =
 391         p_sys->p_blend->fmt_in.video.i_y_offset = 0;
 392     p_sys->p_blend->fmt_out.video.i_aspect = p_vout->render.i_aspect;
 393     p_sys->p_blend->fmt_out.video.i_chroma = p_vout->output.i_chroma;
 394     p_sys->p_blend->fmt_in.video.i_chroma = VLC_FOURCC('Y','U','V','A');
 395     p_sys->p_blend->fmt_in.video.i_aspect = VOUT_ASPECT_FACTOR;
 396     p_sys->i_width =
 397         p_sys->p_blend->fmt_in.video.i_width =
 398             p_sys->p_blend->fmt_in.video.i_visible_width =
 399                 p_pic ? p_pic->p[Y_PLANE].i_visible_pitch : 0;
 400     p_sys->i_height =
 401         p_sys->p_blend->fmt_in.video.i_height =
 402             p_sys->p_blend->fmt_in.video.i_visible_height =
 403                 p_pic ? p_pic->p[Y_PLANE].i_visible_lines : 0;
 404     p_sys->p_blend->fmt_out.video.i_width =
 405         p_sys->p_blend->fmt_out.video.i_visible_width =
 406            p_vout->output.i_width;
 407     p_sys->p_blend->fmt_out.video.i_height =
 408         p_sys->p_blend->fmt_out.video.i_visible_height =
 409             p_vout->output.i_height;
 410
 411     p_sys->p_blend->p_module =
 412         module_Need( p_sys->p_blend, "video blending", 0, 0 );
 413     if( !p_sys->p_blend->p_module )
 414     {
 415         msg_Err( p_vout, "can't open blending filter, aborting" );
 416         vlc_object_detach( p_sys->p_blend );
 417         vlc_object_release( p_sys->p_blend );
 418         return VLC_EGENERIC;
 419     }
 420
 421     if( p_sys->posx < 0 || p_sys->posy < 0 )
 422     {
 423         p_sys->posx = 0; p_sys->posy = 0;
 424
 425         if( p_sys->pos & SUBPICTURE_ALIGN_BOTTOM )
 426         {
 427             p_sys->posy = p_vout->render.i_height - p_sys->i_height;
 428         }
 429         else if ( !(p_sys->pos & SUBPICTURE_ALIGN_TOP) )
 430         {
 431             p_sys->posy = p_vout->render.i_height / 2 - p_sys->i_height / 2;
 432         }
 433
 434         if( p_sys->pos & SUBPICTURE_ALIGN_RIGHT )
 435         {
 436             p_sys->posx = p_vout->render.i_width - p_sys->i_width;
 437         }
 438         else if ( !(p_sys->pos & SUBPICTURE_ALIGN_LEFT) )
 439         {
 440             p_sys->posx = p_vout->render.i_width / 2 - p_sys->i_width / 2;
 441         }
 442     }
 443     else
 444     {
 445         p_sys->pos = 0;
 446     }
 447
 448     /* Try to open the real video output */
 449     msg_Dbg( p_vout, "spawning the real video output" );
 450
 451     p_sys->p_vout = vout_Create( p_vout, &fmt );
 452
 453     /* Everything failed */
 454     if( p_sys->p_vout == NULL )
 455     {
 456         msg_Err( p_vout, "can't open vout, aborting" );
 457         return VLC_EGENERIC;
 458     }
 459
 460     var_AddCallback( p_sys->p_vout, "mouse-x", MouseEvent, p_vout);
 461     var_AddCallback( p_sys->p_vout, "mouse-y", MouseEvent, p_vout);
 462
 463     ALLOCATE_DIRECTBUFFERS( VOUT_MAX_PICTURES );
 464     ADD_CALLBACKS( p_sys->p_vout, SendEvents );
 465     ADD_PARENT_CALLBACKS( SendEventsToChild );
 466
 467     return VLC_SUCCESS;
 468 }
 469
 470 /*****************************************************************************
 471  * End: terminate logo video thread output method
 472  *****************************************************************************/
 473 static void End( vout_thread_t *p_vout )
 474 {
 475     vout_sys_t *p_sys = p_vout->p_sys;
 476     int i_index;
 477
 478     /* Free the fake output buffers we allocated */
 479     for( i_index = I_OUTPUTPICTURES ; i_index ; )
 480     {
 481         i_index--;
 482         free( PP_OUTPUTPICTURE[ i_index ]->p_data_orig );
 483     }
 484
 485     var_DelCallback( p_sys->p_vout, "mouse-x", MouseEvent, p_vout);
 486     var_DelCallback( p_sys->p_vout, "mouse-y", MouseEvent, p_vout);
 487
 488     DEL_CALLBACKS( p_sys->p_vout, SendEvents );
 489     vlc_object_detach( p_sys->p_vout );
 490     vlc_object_release( p_sys->p_vout );
 491
 492     if( p_sys->p_blend->p_module )
 493         module_Unneed( p_sys->p_blend, p_sys->p_blend->p_module );
 494     vlc_object_detach( p_sys->p_blend );
 495     vlc_object_release( p_sys->p_blend );
 496 }
 497
 498 /*****************************************************************************
 499  * Destroy: destroy logo video thread output method
 500  *****************************************************************************/
 501 static void Destroy( vlc_object_t *p_this )
 502 {
 503     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 504     vout_sys_t *p_sys = p_vout->p_sys;
 505
 506     DEL_PARENT_CALLBACKS( SendEventsToChild );
 507
 508     FreeLogoList( p_sys->p_logo_list );
 509     free( p_sys->p_logo_list );
 510
 511     free( p_sys );
 512 }
 513
 514 /*****************************************************************************
 515  * Render: render the logo onto the video
 516  *****************************************************************************/
 517 static void Render( vout_thread_t *p_vout, picture_t *p_inpic )
 518 {
 519     vout_sys_t *p_sys = p_vout->p_sys;
 520     picture_t *p_outpic;
 521     picture_t *p_pic;
 522     logo_list_t *p_logo_list;
 523     logo_t * p_logo;
 524
 525     p_logo_list = p_sys->p_logo_list;
 526
 527     if( p_logo_list->i_next_pic < p_inpic->date )
 528     {
 529         /* It's time to use a new logo */
 530         p_logo_list->i_counter =
 531                         ( p_logo_list->i_counter + 1 )%p_logo_list->i_count;
 532         p_logo = &p_logo_list->p_logo[p_sys->p_logo_list->i_counter];
 533         p_pic = p_logo->p_pic;
 534         p_logo_list->i_next_pic = p_inpic->date + ( p_logo->i_delay != -1 ?
 535                               p_logo->i_delay : p_logo_list->i_delay ) * 1000;
 536         if( p_pic )
 537         {
 538
 539             p_sys->i_width =
 540                 p_sys->p_blend->fmt_in.video.i_width =
 541                     p_sys->p_blend->fmt_in.video.i_visible_width =
 542                         p_pic->p[Y_PLANE].i_visible_pitch;
 543             p_sys->i_height =
 544                 p_sys->p_blend->fmt_in.video.i_height =
 545                     p_sys->p_blend->fmt_in.video.i_visible_height =
 546                         p_pic->p[Y_PLANE].i_visible_lines;
 547
 548             if( p_sys->pos )
 549             {
 550                 if( p_sys->pos & SUBPICTURE_ALIGN_BOTTOM )
 551                 {
 552                     p_sys->posy = p_vout->render.i_height - p_sys->i_height;
 553                 }
 554                 else if ( !(p_sys->pos & SUBPICTURE_ALIGN_TOP) )
 555                 {
 556                     p_sys->posy = p_vout->render.i_height/2 - p_sys->i_height/2;
 557                 }
 558                 if( p_sys->pos & SUBPICTURE_ALIGN_RIGHT )
 559                 {
 560                     p_sys->posx = p_vout->render.i_width - p_sys->i_width;
 561                 }
 562                 else if ( !(p_sys->pos & SUBPICTURE_ALIGN_LEFT) )
 563                 {
 564                     p_sys->posx = p_vout->render.i_width/2 - p_sys->i_width/2;
 565                 }
 566             }
 567         }
 568
 569     }
 570     else
 571     {
 572         p_logo = &p_logo_list->p_logo[p_sys->p_logo_list->i_counter];
 573         p_pic = p_logo->p_pic;
 574     }
 575
 576     /* This is a new frame. Get a structure from the video_output. */
 577     while( !(p_outpic = vout_CreatePicture( p_sys->p_vout, 0, 0, 0 )) )
 578     {
 579         if( p_vout->b_die || p_vout->b_error ) return;
 580         msleep( VOUT_OUTMEM_SLEEP );
 581     }
 582
 583     vout_CopyPicture( p_vout, p_outpic, p_inpic );
 584     vout_DatePicture( p_sys->p_vout, p_outpic, p_inpic->date );
 585
 586     if( p_pic )
 587     p_sys->p_blend->pf_video_blend( p_sys->p_blend, p_outpic, p_outpic,
 588                                     p_pic, p_sys->posx, p_sys->posy,
 589                                     p_logo->i_alpha != -1 ? p_logo->i_alpha
 590                                     : p_logo_list->i_alpha );
 591
 592     vout_DisplayPicture( p_sys->p_vout, p_outpic );
 593 }
 594
 595 /*****************************************************************************
 596  * SendEvents: forward mouse and keyboard events to the parent p_vout
 597  *****************************************************************************/
 598 static int SendEvents( vlc_object_t *p_this, char const *psz_var,
 599                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
 600 {
 601     VLC_UNUSED(p_this); VLC_UNUSED(oldval);
 602     var_Set( (vlc_object_t *)p_data, psz_var, newval );
 603     return VLC_SUCCESS;
 604 }
 605
 606 /*****************************************************************************
 607  * MouseEvent: callback for mouse events
 608  *****************************************************************************/
 609 static int MouseEvent( vlc_object_t *p_this, char const *psz_var,
 610                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
 611 {
 612     VLC_UNUSED(p_this); VLC_UNUSED(oldval);
 613     vout_thread_t *p_vout = (vout_thread_t*)p_data;
 614     vout_sys_t *p_sys = p_vout->p_sys;
 615     vlc_value_t valb;
 616     int i_delta;
 617
 618     var_Get( p_vout->p_sys->p_vout, "mouse-button-down", &valb );
 619
 620     i_delta = newval.i_int - oldval.i_int;
 621
 622     if( (valb.i_int & 0x1) == 0 )
 623     {
 624         return VLC_SUCCESS;
 625     }
 626
 627     if( psz_var[6] == 'x' )
 628     {
 629         vlc_value_t valy;
 630         var_Get( p_vout->p_sys->p_vout, "mouse-y", &valy );
 631         if( newval.i_int >= (int)p_sys->posx &&
 632             valy.i_int >= (int)p_sys->posy &&
 633             newval.i_int <= (int)(p_sys->posx + p_sys->i_width) &&
 634             valy.i_int <= (int)(p_sys->posy + p_sys->i_height) )
 635         {
 636             p_sys->posx = __MIN( __MAX( p_sys->posx + i_delta, 0 ),
 637                           p_vout->output.i_width - p_sys->i_width );
 638         }
 639     }
 640     else if( psz_var[6] == 'y' )
 641     {
 642         vlc_value_t valx;
 643         var_Get( p_vout->p_sys->p_vout, "mouse-x", &valx );
 644         if( valx.i_int >= (int)p_sys->posx &&
 645             newval.i_int >= (int)p_sys->posy &&
 646             valx.i_int <= (int)(p_sys->posx + p_sys->i_width) &&
 647             newval.i_int <= (int)(p_sys->posy + p_sys->i_height) )
 648         {
 649             p_sys->posy = __MIN( __MAX( p_sys->posy + i_delta, 0 ),
 650                           p_vout->output.i_height - p_sys->i_height );
 651         }
 652     }
 653
 654     return VLC_SUCCESS;
 655 }
 656
 657 /*****************************************************************************
 658  * Control: control facility for the vout (forwards to child vout)
 659  *****************************************************************************/
 660 static int Control( vout_thread_t *p_vout, int i_query, va_list args )
 661 {
 662     return vout_vaControl( p_vout->p_sys->p_vout, i_query, args );
 663 }
 664
 665 /*****************************************************************************
 666  * SendEventsToChild: forward events to the child/children vout
 667  *****************************************************************************/
 668 static int SendEventsToChild( vlc_object_t *p_this, char const *psz_var,
 669                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
 670 {
 671     VLC_UNUSED(p_data); VLC_UNUSED(oldval);
 672     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 673     var_Set( p_vout->p_sys->p_vout, psz_var, newval );
 674     return VLC_SUCCESS;
 675 }
 676
 677 /*****************************************************************************
 678  * filter_sys_t: logo filter descriptor
 679  *****************************************************************************/
 680 struct filter_sys_t
 681 {
 682     logo_list_t *p_logo_list;
 683
 684     int pos, posx, posy;
 685
 686     bool b_absolute;
 687     mtime_t i_last_date;
 688
 689     /* On the fly control variable */
 690     bool b_need_update;
 691 };
 692
 693 static subpicture_t *Filter( filter_t *, mtime_t );
 694
 695 /*****************************************************************************
 696  * CreateFilter: allocates logo video filter
 697  *****************************************************************************/
 698 static int CreateFilter( vlc_object_t *p_this )
 699 {
 700     filter_t *p_filter = (filter_t *)p_this;
 701     filter_sys_t *p_sys;
 702     logo_list_t *p_logo_list;
 703
 704     /* Allocate structure */
 705     p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
 706     if( p_sys == NULL )
 707         return VLC_ENOMEM;
 708     p_logo_list = p_sys->p_logo_list = malloc( sizeof( logo_list_t ) );
 709     if( p_logo_list == NULL )
 710     {
 711         free( p_sys );
 712         return VLC_ENOMEM;
 713     }
 714
 715     config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
 716                        p_filter->p_cfg );
 717
 718     /* Hook used for callback variables */
 719     p_logo_list->psz_filename =
 720         var_CreateGetStringCommand( p_filter, "logo-file" );
 721     if( !p_logo_list->psz_filename || !*p_logo_list->psz_filename )
 722     {
 723         msg_Err( p_this, "logo file not specified" );
 724         free( p_sys );
 725         free( p_logo_list );
 726         return VLC_EGENERIC;
 727     }
 728
 729     p_sys->posx = var_CreateGetIntegerCommand( p_filter, "logo-x" );
 730     p_sys->posy = var_CreateGetIntegerCommand( p_filter, "logo-y" );
 731     p_sys->pos = var_CreateGetIntegerCommand( p_filter, "logo-position" );
 732     p_logo_list->i_alpha = __MAX( __MIN( var_CreateGetIntegerCommand(
 733                            p_filter, "logo-transparency"), 255 ), 0 );
 734     p_logo_list->i_delay =
 735         var_CreateGetIntegerCommand( p_filter, "logo-delay" );
 736     p_logo_list->i_repeat =
 737         var_CreateGetIntegerCommand( p_filter, "logo-repeat" );
 738
 739     var_AddCallback( p_filter, "logo-file", LogoCallback, p_sys );
 740     var_AddCallback( p_filter, "logo-x", LogoCallback, p_sys );
 741     var_AddCallback( p_filter, "logo-y", LogoCallback, p_sys );
 742     var_AddCallback( p_filter, "logo-position", LogoCallback, p_sys );
 743     var_AddCallback( p_filter, "logo-transparency", LogoCallback, p_sys );
 744     var_AddCallback( p_filter, "logo-repeat", LogoCallback, p_sys );
 745
 746     vlc_mutex_init( &p_logo_list->lock );
 747     vlc_mutex_lock( &p_logo_list->lock );
 748
 749     LoadLogoList( p_this, p_logo_list );
 750
 751     vlc_mutex_unlock( &p_logo_list->lock );
 752
 753     /* Misc init */
 754     p_filter->pf_sub_filter = Filter;
 755     p_sys->b_need_update = true;
 756
 757     p_sys->i_last_date = 0;
 758
 759     return VLC_SUCCESS;
 760 }
 761
 762 /*****************************************************************************
 763  * DestroyFilter: destroy logo video filter
 764  *****************************************************************************/
 765 static void DestroyFilter( vlc_object_t *p_this )
 766 {
 767     filter_t *p_filter = (filter_t *)p_this;
 768     filter_sys_t *p_sys = p_filter->p_sys;
 769
 770     vlc_mutex_destroy( &p_sys->p_logo_list->lock );
 771     FreeLogoList( p_sys->p_logo_list );
 772     free( p_sys->p_logo_list );
 773     free( p_sys );
 774
 775     /* Delete the logo variables from INPUT */
 776     var_Destroy( p_filter->p_libvlc, "logo-file" );
 777     var_Destroy( p_filter->p_libvlc, "logo-x" );
 778     var_Destroy( p_filter->p_libvlc, "logo-y" );
 779     var_Destroy( p_filter->p_libvlc, "logo-delay" );
 780     var_Destroy( p_filter->p_libvlc, "logo-repeat" );
 781     var_Destroy( p_filter->p_libvlc, "logo-position" );
 782     var_Destroy( p_filter->p_libvlc, "logo-transparency" );
 783 }
 784
 785 /*****************************************************************************
 786  * Filter: the whole thing
 787  *****************************************************************************
 788  * This function outputs subpictures at regular time intervals.
 789  *****************************************************************************/
 790 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
 791 {
 792     filter_sys_t *p_sys = p_filter->p_sys;
 793     logo_list_t *p_logo_list = p_sys->p_logo_list;
 794     subpicture_t *p_spu;
 795     subpicture_region_t *p_region;
 796     video_format_t fmt;
 797     picture_t *p_pic;
 798     logo_t *p_logo;
 799
 800     vlc_mutex_lock( &p_logo_list->lock );
 801     /* Basic test:  b_need_update occurs on a dynamic change,
 802                     & i_next_pic is the general timer, when to
 803                     look at updating the logo image */
 804
 805     if( ( ( !p_sys->b_need_update ) && ( p_logo_list->i_next_pic > date ) )
 806         || !p_logo_list->i_repeat )
 807     {
 808         vlc_mutex_unlock( &p_logo_list->lock );
 809         return 0;
 810     }
 811     /* prior code tested on && p_sys->i_last_date +5000000 > date ) return 0; */
 812
 813     /* adjust index to the next logo */
 814     p_logo_list->i_counter =
 815                         ( p_logo_list->i_counter + 1 )%p_logo_list->i_count;
 816
 817     p_logo = &p_logo_list->p_logo[p_logo_list->i_counter];
 818     p_pic = p_logo->p_pic;
 819
 820     /* Allocate the subpicture internal data. */
 821     p_spu = p_filter->pf_sub_buffer_new( p_filter );
 822     if( !p_spu )
 823     {
 824         vlc_mutex_unlock( &p_logo_list->lock );
 825         return NULL;
 826     }
 827
 828     p_spu->b_absolute = p_sys->b_absolute;
 829     p_spu->i_start = p_sys->i_last_date = date;
 830     p_spu->i_stop = 0;
 831     p_spu->b_ephemer = true;
 832
 833     p_sys->b_need_update = false;
 834     p_logo_list->i_next_pic = date +
 835     ( p_logo->i_delay != -1 ? p_logo->i_delay : p_logo_list->i_delay ) * 1000;
 836
 837     if( p_logo_list->i_repeat != -1
 838         && p_logo_list->i_counter == 0 )
 839     {
 840         p_logo_list->i_repeat--;
 841         if( p_logo_list->i_repeat == 0 )
 842         {
 843             vlc_mutex_unlock( &p_logo_list->lock );
 844             return p_spu;
 845         }
 846     }
 847
 848     if( !p_pic || !p_logo->i_alpha
 849         || ( p_logo->i_alpha == -1 && !p_logo_list->i_alpha ) )
 850     {
 851         /* Send an empty subpicture to clear the display */
 852         vlc_mutex_unlock( &p_logo_list->lock );
 853         return p_spu;
 854     }
 855
 856     /* Create new SPU region */
 857     memset( &fmt, 0, sizeof(video_format_t) );
 858     fmt.i_chroma = VLC_FOURCC('Y','U','V','A');
 859     fmt.i_aspect = VOUT_ASPECT_FACTOR;
 860     fmt.i_sar_num = fmt.i_sar_den = 1;
 861     fmt.i_width = fmt.i_visible_width = p_pic->p[Y_PLANE].i_visible_pitch;
 862     fmt.i_height = fmt.i_visible_height = p_pic->p[Y_PLANE].i_visible_lines;
 863     fmt.i_x_offset = fmt.i_y_offset = 0;
 864     p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
 865     if( !p_region )
 866     {
 867         msg_Err( p_filter, "cannot allocate SPU region" );
 868         p_filter->pf_sub_buffer_del( p_filter, p_spu );
 869         vlc_mutex_unlock( &p_logo_list->lock );
 870         return NULL;
 871     }
 872
 873     vout_CopyPicture( p_filter, &p_region->picture, p_pic );
 874     vlc_mutex_unlock( &p_logo_list->lock );
 875
 876     /*  where to locate the logo: */
 877     if( p_sys->pos < 0 )
 878     {   /*  set to an absolute xy */
 879         p_region->i_align = OSD_ALIGN_RIGHT | OSD_ALIGN_TOP;
 880         p_spu->b_absolute = true;
 881     }
 882     else
 883     {   /* set to one of the 9 relative locations */
 884         p_region->i_align = p_sys->pos;
 885         p_spu->b_absolute = false;
 886     }
 887
 888     p_spu->i_x = p_sys->posx;
 889     p_spu->i_y = p_sys->posy;
 890
 891     p_spu->p_region = p_region;
 892
 893     p_spu->i_alpha = ( p_logo->i_alpha != -1 ?
 894                        p_logo->i_alpha : p_logo_list->i_alpha );
 895
 896     return p_spu;
 897 }
 898
 899 /*****************************************************************************
 900  * Callback to update params on the fly
 901  *****************************************************************************/
 902 static int LogoCallback( vlc_object_t *p_this, char const *psz_var,
 903                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 904 {
 905     VLC_UNUSED(oldval);
 906     filter_sys_t *p_sys = (filter_sys_t *)p_data;
 907     logo_list_t *p_logo_list = p_sys->p_logo_list;
 908
 909     if( !strncmp( psz_var, "logo-file", 6 ) )
 910     {
 911         vlc_mutex_lock( &p_logo_list->lock );
 912         FreeLogoList( p_logo_list );
 913         p_logo_list->psz_filename = strdup( newval.psz_string );
 914         LoadLogoList( p_this, p_logo_list );
 915         vlc_mutex_unlock( &p_logo_list->lock );
 916         p_sys->b_need_update = true;
 917     }
 918     else if ( !strncmp( psz_var, "logo-x", 6 ) )
 919     {
 920         p_sys->posx = newval.i_int;
 921     }
 922     else if ( !strncmp( psz_var, "logo-y", 6 ) )
 923     {
 924         p_sys->posy = newval.i_int;
 925     }
 926     else if ( !strncmp( psz_var, "logo-position", 12 ) )
 927     {
 928         p_sys->pos = newval.i_int;
 929     }
 930     else if ( !strncmp( psz_var, "logo-transparency", 9 ) )
 931     {
 932         vlc_mutex_lock( &p_logo_list->lock );
 933         p_logo_list->i_alpha = __MAX( __MIN( newval.i_int, 255 ), 0 );
 934         vlc_mutex_unlock( &p_logo_list->lock );
 935     }
 936     else if ( !strncmp( psz_var, "logo-repeat", 11 ) )
 937     {
 938         vlc_mutex_lock( &p_logo_list->lock );
 939         p_logo_list->i_repeat = newval.i_int;
 940         vlc_mutex_unlock( &p_logo_list->lock );
 941     }
 942     p_sys->b_need_update = true;
 943     return VLC_SUCCESS;
 944 }