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     {
 319         msg_Err( p_vout, "out of memory" );
 320         return VLC_ENOMEM;
 321     }
 322     p_logo_list = p_sys->p_logo_list = malloc( sizeof( logo_list_t ) );
 323     if( p_logo_list == NULL )
 324     {
 325         msg_Err( p_vout, "out of memory" );
 326         free( p_sys );
 327         return VLC_ENOMEM;
 328     }
 329
 330     config_ChainParse( p_vout, CFG_PREFIX, ppsz_filter_options,
 331                        p_vout->p_cfg );
 332
 333     p_logo_list->psz_filename = var_CreateGetStringCommand( p_vout,
 334                                                             "logo-file" );
 335     if( !p_logo_list->psz_filename || !*p_logo_list->psz_filename )
 336     {
 337         msg_Err( p_vout, "logo file not specified" );
 338         return VLC_EGENERIC;
 339     }
 340
 341     p_vout->pf_init = Init;
 342     p_vout->pf_end = End;
 343     p_vout->pf_manage = NULL;
 344     p_vout->pf_render = Render;
 345     p_vout->pf_display = NULL;
 346     p_vout->pf_control = Control;
 347
 348     p_sys->pos = var_CreateGetIntegerCommand( p_vout, "logo-position" );
 349     p_sys->posx = var_CreateGetIntegerCommand( p_vout, "logo-x" );
 350     p_sys->posy = var_CreateGetIntegerCommand( p_vout, "logo-y" );
 351     p_logo_list->i_delay = __MAX( __MIN(
 352         var_CreateGetIntegerCommand( p_vout, "logo-delay" ) , 60000 ), 0 );
 353     p_logo_list->i_repeat = var_CreateGetIntegerCommand( p_vout, "logo-repeat");
 354     p_logo_list->i_alpha = __MAX( __MIN(
 355         var_CreateGetIntegerCommand( p_vout, "logo-transparency" ), 255 ), 0 );
 356
 357     LoadLogoList( p_vout, p_logo_list );
 358
 359     return VLC_SUCCESS;
 360 }
 361
 362 /*****************************************************************************
 363  * Init: initialize logo video thread output method
 364  *****************************************************************************/
 365 static int Init( vout_thread_t *p_vout )
 366 {
 367     vout_sys_t *p_sys = p_vout->p_sys;
 368     picture_t *p_pic;
 369     int i_index;
 370     video_format_t fmt;
 371     logo_list_t *p_logo_list = p_sys->p_logo_list;
 372
 373     I_OUTPUTPICTURES = 0;
 374     memset( &fmt, 0, sizeof(video_format_t) );
 375
 376     /* adjust index to the next logo */
 377     p_logo_list->i_counter =
 378                         ( p_logo_list->i_counter + 1 )%p_logo_list->i_count;
 379
 380     p_pic = p_logo_list->p_logo[p_logo_list->i_counter].p_pic;
 381     /* Initialize the output structure */
 382     p_vout->output.i_chroma = p_vout->render.i_chroma;
 383     p_vout->output.i_width  = p_vout->render.i_width;
 384     p_vout->output.i_height = p_vout->render.i_height;
 385     p_vout->output.i_aspect = p_vout->render.i_aspect;
 386     p_vout->fmt_out = p_vout->fmt_in;
 387     fmt = p_vout->fmt_out;
 388
 389     /* Load the video blending filter */
 390     p_sys->p_blend = vlc_object_create( p_vout, sizeof(filter_t) );
 391     vlc_object_attach( p_sys->p_blend, p_vout );
 392     p_sys->p_blend->fmt_out.video.i_x_offset =
 393         p_sys->p_blend->fmt_out.video.i_y_offset = 0;
 394     p_sys->p_blend->fmt_in.video.i_x_offset =
 395         p_sys->p_blend->fmt_in.video.i_y_offset = 0;
 396     p_sys->p_blend->fmt_out.video.i_aspect = p_vout->render.i_aspect;
 397     p_sys->p_blend->fmt_out.video.i_chroma = p_vout->output.i_chroma;
 398     p_sys->p_blend->fmt_in.video.i_chroma = VLC_FOURCC('Y','U','V','A');
 399     p_sys->p_blend->fmt_in.video.i_aspect = VOUT_ASPECT_FACTOR;
 400     p_sys->i_width =
 401         p_sys->p_blend->fmt_in.video.i_width =
 402             p_sys->p_blend->fmt_in.video.i_visible_width =
 403                 p_pic ? p_pic->p[Y_PLANE].i_visible_pitch : 0;
 404     p_sys->i_height =
 405         p_sys->p_blend->fmt_in.video.i_height =
 406             p_sys->p_blend->fmt_in.video.i_visible_height =
 407                 p_pic ? p_pic->p[Y_PLANE].i_visible_lines : 0;
 408     p_sys->p_blend->fmt_out.video.i_width =
 409         p_sys->p_blend->fmt_out.video.i_visible_width =
 410            p_vout->output.i_width;
 411     p_sys->p_blend->fmt_out.video.i_height =
 412         p_sys->p_blend->fmt_out.video.i_visible_height =
 413             p_vout->output.i_height;
 414
 415     p_sys->p_blend->p_module =
 416         module_Need( p_sys->p_blend, "video blending", 0, 0 );
 417     if( !p_sys->p_blend->p_module )
 418     {
 419         msg_Err( p_vout, "can't open blending filter, aborting" );
 420         vlc_object_detach( p_sys->p_blend );
 421         vlc_object_release( p_sys->p_blend );
 422         return VLC_EGENERIC;
 423     }
 424
 425     if( p_sys->posx < 0 || p_sys->posy < 0 )
 426     {
 427         p_sys->posx = 0; p_sys->posy = 0;
 428
 429         if( p_sys->pos & SUBPICTURE_ALIGN_BOTTOM )
 430         {
 431             p_sys->posy = p_vout->render.i_height - p_sys->i_height;
 432         }
 433         else if ( !(p_sys->pos & SUBPICTURE_ALIGN_TOP) )
 434         {
 435             p_sys->posy = p_vout->render.i_height / 2 - p_sys->i_height / 2;
 436         }
 437
 438         if( p_sys->pos & SUBPICTURE_ALIGN_RIGHT )
 439         {
 440             p_sys->posx = p_vout->render.i_width - p_sys->i_width;
 441         }
 442         else if ( !(p_sys->pos & SUBPICTURE_ALIGN_LEFT) )
 443         {
 444             p_sys->posx = p_vout->render.i_width / 2 - p_sys->i_width / 2;
 445         }
 446     }
 447     else
 448     {
 449         p_sys->pos = 0;
 450     }
 451
 452     /* Try to open the real video output */
 453     msg_Dbg( p_vout, "spawning the real video output" );
 454
 455     p_sys->p_vout = vout_Create( p_vout, &fmt );
 456
 457     /* Everything failed */
 458     if( p_sys->p_vout == NULL )
 459     {
 460         msg_Err( p_vout, "can't open vout, aborting" );
 461         return VLC_EGENERIC;
 462     }
 463
 464     var_AddCallback( p_sys->p_vout, "mouse-x", MouseEvent, p_vout);
 465     var_AddCallback( p_sys->p_vout, "mouse-y", MouseEvent, p_vout);
 466
 467     ALLOCATE_DIRECTBUFFERS( VOUT_MAX_PICTURES );
 468     ADD_CALLBACKS( p_sys->p_vout, SendEvents );
 469     ADD_PARENT_CALLBACKS( SendEventsToChild );
 470
 471     return VLC_SUCCESS;
 472 }
 473
 474 /*****************************************************************************
 475  * End: terminate logo video thread output method
 476  *****************************************************************************/
 477 static void End( vout_thread_t *p_vout )
 478 {
 479     vout_sys_t *p_sys = p_vout->p_sys;
 480     int i_index;
 481
 482     /* Free the fake output buffers we allocated */
 483     for( i_index = I_OUTPUTPICTURES ; i_index ; )
 484     {
 485         i_index--;
 486         free( PP_OUTPUTPICTURE[ i_index ]->p_data_orig );
 487     }
 488
 489     var_DelCallback( p_sys->p_vout, "mouse-x", MouseEvent, p_vout);
 490     var_DelCallback( p_sys->p_vout, "mouse-y", MouseEvent, p_vout);
 491
 492     DEL_CALLBACKS( p_sys->p_vout, SendEvents );
 493     vlc_object_detach( p_sys->p_vout );
 494     vlc_object_release( p_sys->p_vout );
 495
 496     if( p_sys->p_blend->p_module )
 497         module_Unneed( p_sys->p_blend, p_sys->p_blend->p_module );
 498     vlc_object_detach( p_sys->p_blend );
 499     vlc_object_release( p_sys->p_blend );
 500 }
 501
 502 /*****************************************************************************
 503  * Destroy: destroy logo video thread output method
 504  *****************************************************************************/
 505 static void Destroy( vlc_object_t *p_this )
 506 {
 507     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 508     vout_sys_t *p_sys = p_vout->p_sys;
 509
 510     DEL_PARENT_CALLBACKS( SendEventsToChild );
 511
 512     FreeLogoList( p_sys->p_logo_list );
 513     free( p_sys->p_logo_list );
 514
 515     free( p_sys );
 516 }
 517
 518 /*****************************************************************************
 519  * Render: render the logo onto the video
 520  *****************************************************************************/
 521 static void Render( vout_thread_t *p_vout, picture_t *p_inpic )
 522 {
 523     vout_sys_t *p_sys = p_vout->p_sys;
 524     picture_t *p_outpic;
 525     picture_t *p_pic;
 526     logo_list_t *p_logo_list;
 527     logo_t * p_logo;
 528
 529     p_logo_list = p_sys->p_logo_list;
 530
 531     if( p_logo_list->i_next_pic < p_inpic->date )
 532     {
 533         /* It's time to use a new logo */
 534         p_logo_list->i_counter =
 535                         ( p_logo_list->i_counter + 1 )%p_logo_list->i_count;
 536         p_logo = &p_logo_list->p_logo[p_sys->p_logo_list->i_counter];
 537         p_pic = p_logo->p_pic;
 538         p_logo_list->i_next_pic = p_inpic->date + ( p_logo->i_delay != -1 ?
 539                               p_logo->i_delay : p_logo_list->i_delay ) * 1000;
 540         if( p_pic )
 541         {
 542
 543             p_sys->i_width =
 544                 p_sys->p_blend->fmt_in.video.i_width =
 545                     p_sys->p_blend->fmt_in.video.i_visible_width =
 546                         p_pic->p[Y_PLANE].i_visible_pitch;
 547             p_sys->i_height =
 548                 p_sys->p_blend->fmt_in.video.i_height =
 549                     p_sys->p_blend->fmt_in.video.i_visible_height =
 550                         p_pic->p[Y_PLANE].i_visible_lines;
 551
 552             if( p_sys->pos )
 553             {
 554                 if( p_sys->pos & SUBPICTURE_ALIGN_BOTTOM )
 555                 {
 556                     p_sys->posy = p_vout->render.i_height - p_sys->i_height;
 557                 }
 558                 else if ( !(p_sys->pos & SUBPICTURE_ALIGN_TOP) )
 559                 {
 560                     p_sys->posy = p_vout->render.i_height/2 - p_sys->i_height/2;
 561                 }
 562                 if( p_sys->pos & SUBPICTURE_ALIGN_RIGHT )
 563                 {
 564                     p_sys->posx = p_vout->render.i_width - p_sys->i_width;
 565                 }
 566                 else if ( !(p_sys->pos & SUBPICTURE_ALIGN_LEFT) )
 567                 {
 568                     p_sys->posx = p_vout->render.i_width/2 - p_sys->i_width/2;
 569                 }
 570             }
 571         }
 572
 573     }
 574     else
 575     {
 576         p_logo = &p_logo_list->p_logo[p_sys->p_logo_list->i_counter];
 577         p_pic = p_logo->p_pic;
 578     }
 579
 580     /* This is a new frame. Get a structure from the video_output. */
 581     while( !(p_outpic = vout_CreatePicture( p_sys->p_vout, 0, 0, 0 )) )
 582     {
 583         if( p_vout->b_die || p_vout->b_error ) return;
 584         msleep( VOUT_OUTMEM_SLEEP );
 585     }
 586
 587     vout_CopyPicture( p_vout, p_outpic, p_inpic );
 588     vout_DatePicture( p_sys->p_vout, p_outpic, p_inpic->date );
 589
 590     if( p_pic )
 591     p_sys->p_blend->pf_video_blend( p_sys->p_blend, p_outpic, p_outpic,
 592                                     p_pic, p_sys->posx, p_sys->posy,
 593                                     p_logo->i_alpha != -1 ? p_logo->i_alpha
 594                                     : p_logo_list->i_alpha );
 595
 596     vout_DisplayPicture( p_sys->p_vout, p_outpic );
 597 }
 598
 599 /*****************************************************************************
 600  * SendEvents: forward mouse and keyboard events to the parent p_vout
 601  *****************************************************************************/
 602 static int SendEvents( vlc_object_t *p_this, char const *psz_var,
 603                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
 604 {
 605     VLC_UNUSED(p_this); VLC_UNUSED(oldval);
 606     var_Set( (vlc_object_t *)p_data, psz_var, newval );
 607     return VLC_SUCCESS;
 608 }
 609
 610 /*****************************************************************************
 611  * MouseEvent: callback for mouse events
 612  *****************************************************************************/
 613 static int MouseEvent( vlc_object_t *p_this, char const *psz_var,
 614                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
 615 {
 616     VLC_UNUSED(p_this); VLC_UNUSED(oldval);
 617     vout_thread_t *p_vout = (vout_thread_t*)p_data;
 618     vout_sys_t *p_sys = p_vout->p_sys;
 619     vlc_value_t valb;
 620     int i_delta;
 621
 622     var_Get( p_vout->p_sys->p_vout, "mouse-button-down", &valb );
 623
 624     i_delta = newval.i_int - oldval.i_int;
 625
 626     if( (valb.i_int & 0x1) == 0 )
 627     {
 628         return VLC_SUCCESS;
 629     }
 630
 631     if( psz_var[6] == 'x' )
 632     {
 633         vlc_value_t valy;
 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) )
 639         {
 640             p_sys->posx = __MIN( __MAX( p_sys->posx + i_delta, 0 ),
 641                           p_vout->output.i_width - p_sys->i_width );
 642         }
 643     }
 644     else if( psz_var[6] == 'y' )
 645     {
 646         vlc_value_t valx;
 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) )
 652         {
 653             p_sys->posy = __MIN( __MAX( p_sys->posy + i_delta, 0 ),
 654                           p_vout->output.i_height - p_sys->i_height );
 655         }
 656     }
 657
 658     return VLC_SUCCESS;
 659 }
 660
 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 )
 665 {
 666     return vout_vaControl( p_vout->p_sys->p_vout, i_query, args );
 667 }
 668
 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 )
 674 {
 675     VLC_UNUSED(p_data); VLC_UNUSED(oldval);
 676     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 677     var_Set( p_vout->p_sys->p_vout, psz_var, newval );
 678     return VLC_SUCCESS;
 679 }
 680
 681 /*****************************************************************************
 682  * filter_sys_t: logo filter descriptor
 683  *****************************************************************************/
 684 struct filter_sys_t
 685 {
 686     logo_list_t *p_logo_list;
 687
 688     int pos, posx, posy;
 689
 690     bool b_absolute;
 691     mtime_t i_last_date;
 692
 693     /* On the fly control variable */
 694     bool b_need_update;
 695 };
 696
 697 static subpicture_t *Filter( filter_t *, mtime_t );
 698
 699 /*****************************************************************************
 700  * CreateFilter: allocates logo video filter
 701  *****************************************************************************/
 702 static int CreateFilter( vlc_object_t *p_this )
 703 {
 704     filter_t *p_filter = (filter_t *)p_this;
 705     filter_sys_t *p_sys;
 706     logo_list_t *p_logo_list;
 707
 708     /* Allocate structure */
 709     p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
 710     if( p_sys == NULL )
 711     {
 712         msg_Err( p_filter, "out of memory" );
 713         return VLC_ENOMEM;
 714     }
 715     p_logo_list = p_sys->p_logo_list = malloc( sizeof( logo_list_t ) );
 716     if( p_logo_list == NULL )
 717     {
 718         msg_Err( p_filter, "out of memory" );
 719         free( p_sys );
 720         return VLC_ENOMEM;
 721     }
 722
 723     config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
 724                        p_filter->p_cfg );
 725
 726     /* Hook used for callback variables */
 727     p_logo_list->psz_filename =
 728         var_CreateGetStringCommand( p_filter, "logo-file" );
 729     if( !p_logo_list->psz_filename || !*p_logo_list->psz_filename )
 730     {
 731         msg_Err( p_this, "logo file not specified" );
 732         free( p_sys );
 733         free( p_logo_list );
 734         return VLC_EGENERIC;
 735     }
 736
 737     p_sys->posx = var_CreateGetIntegerCommand( p_filter, "logo-x" );
 738     p_sys->posy = var_CreateGetIntegerCommand( p_filter, "logo-y" );
 739     p_sys->pos = var_CreateGetIntegerCommand( p_filter, "logo-position" );
 740     p_logo_list->i_alpha = __MAX( __MIN( var_CreateGetIntegerCommand(
 741                            p_filter, "logo-transparency"), 255 ), 0 );
 742     p_logo_list->i_delay =
 743         var_CreateGetIntegerCommand( p_filter, "logo-delay" );
 744     p_logo_list->i_repeat =
 745         var_CreateGetIntegerCommand( p_filter, "logo-repeat" );
 746
 747     var_AddCallback( p_filter, "logo-file", LogoCallback, p_sys );
 748     var_AddCallback( p_filter, "logo-x", LogoCallback, p_sys );
 749     var_AddCallback( p_filter, "logo-y", LogoCallback, p_sys );
 750     var_AddCallback( p_filter, "logo-position", LogoCallback, p_sys );
 751     var_AddCallback( p_filter, "logo-transparency", LogoCallback, p_sys );
 752     var_AddCallback( p_filter, "logo-repeat", LogoCallback, p_sys );
 753
 754     vlc_mutex_init( &p_logo_list->lock );
 755     vlc_mutex_lock( &p_logo_list->lock );
 756
 757     LoadLogoList( p_this, p_logo_list );
 758
 759     vlc_mutex_unlock( &p_logo_list->lock );
 760
 761     /* Misc init */
 762     p_filter->pf_sub_filter = Filter;
 763     p_sys->b_need_update = true;
 764
 765     p_sys->i_last_date = 0;
 766
 767     return VLC_SUCCESS;
 768 }
 769
 770 /*****************************************************************************
 771  * DestroyFilter: destroy logo video filter
 772  *****************************************************************************/
 773 static void DestroyFilter( vlc_object_t *p_this )
 774 {
 775     filter_t *p_filter = (filter_t *)p_this;
 776     filter_sys_t *p_sys = p_filter->p_sys;
 777
 778     vlc_mutex_destroy( &p_sys->p_logo_list->lock );
 779     FreeLogoList( p_sys->p_logo_list );
 780     free( p_sys->p_logo_list );
 781     free( p_sys );
 782
 783     /* Delete the logo variables from INPUT */
 784     var_Destroy( p_filter->p_libvlc, "logo-file" );
 785     var_Destroy( p_filter->p_libvlc, "logo-x" );
 786     var_Destroy( p_filter->p_libvlc, "logo-y" );
 787     var_Destroy( p_filter->p_libvlc, "logo-delay" );
 788     var_Destroy( p_filter->p_libvlc, "logo-repeat" );
 789     var_Destroy( p_filter->p_libvlc, "logo-position" );
 790     var_Destroy( p_filter->p_libvlc, "logo-transparency" );
 791 }
 792
 793 /*****************************************************************************
 794  * Filter: the whole thing
 795  *****************************************************************************
 796  * This function outputs subpictures at regular time intervals.
 797  *****************************************************************************/
 798 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
 799 {
 800     filter_sys_t *p_sys = p_filter->p_sys;
 801     logo_list_t *p_logo_list = p_sys->p_logo_list;
 802     subpicture_t *p_spu;
 803     subpicture_region_t *p_region;
 804     video_format_t fmt;
 805     picture_t *p_pic;
 806     logo_t *p_logo;
 807
 808     vlc_mutex_lock( &p_logo_list->lock );
 809     /* Basic test:  b_need_update occurs on a dynamic change,
 810                     & i_next_pic is the general timer, when to
 811                     look at updating the logo image */
 812
 813     if( ( ( !p_sys->b_need_update ) && ( p_logo_list->i_next_pic > date ) )
 814         || !p_logo_list->i_repeat )
 815     {
 816         vlc_mutex_unlock( &p_logo_list->lock );
 817         return 0;
 818     }
 819     /* prior code tested on && p_sys->i_last_date +5000000 > date ) return 0; */
 820
 821     /* adjust index to the next logo */
 822     p_logo_list->i_counter =
 823                         ( p_logo_list->i_counter + 1 )%p_logo_list->i_count;
 824
 825     p_logo = &p_logo_list->p_logo[p_logo_list->i_counter];
 826     p_pic = p_logo->p_pic;
 827
 828     /* Allocate the subpicture internal data. */
 829     p_spu = p_filter->pf_sub_buffer_new( p_filter );
 830     if( !p_spu )
 831     {
 832         vlc_mutex_unlock( &p_logo_list->lock );
 833         return NULL;
 834     }
 835
 836     p_spu->b_absolute = p_sys->b_absolute;
 837     p_spu->i_start = p_sys->i_last_date = date;
 838     p_spu->i_stop = 0;
 839     p_spu->b_ephemer = true;
 840
 841     p_sys->b_need_update = false;
 842     p_logo_list->i_next_pic = date +
 843     ( p_logo->i_delay != -1 ? p_logo->i_delay : p_logo_list->i_delay ) * 1000;
 844
 845     if( p_logo_list->i_repeat != -1
 846         && p_logo_list->i_counter == 0 )
 847     {
 848         p_logo_list->i_repeat--;
 849         if( p_logo_list->i_repeat == 0 )
 850         {
 851             vlc_mutex_unlock( &p_logo_list->lock );
 852             return p_spu;
 853         }
 854     }
 855
 856     if( !p_pic || !p_logo->i_alpha
 857         || ( p_logo->i_alpha == -1 && !p_logo_list->i_alpha ) )
 858     {
 859         /* Send an empty subpicture to clear the display */
 860         vlc_mutex_unlock( &p_logo_list->lock );
 861         return p_spu;
 862     }
 863
 864     /* Create new SPU region */
 865     memset( &fmt, 0, sizeof(video_format_t) );
 866     fmt.i_chroma = VLC_FOURCC('Y','U','V','A');
 867     fmt.i_aspect = VOUT_ASPECT_FACTOR;
 868     fmt.i_sar_num = fmt.i_sar_den = 1;
 869     fmt.i_width = fmt.i_visible_width = p_pic->p[Y_PLANE].i_visible_pitch;
 870     fmt.i_height = fmt.i_visible_height = p_pic->p[Y_PLANE].i_visible_lines;
 871     fmt.i_x_offset = fmt.i_y_offset = 0;
 872     p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
 873     if( !p_region )
 874     {
 875         msg_Err( p_filter, "cannot allocate SPU region" );
 876         p_filter->pf_sub_buffer_del( p_filter, p_spu );
 877         vlc_mutex_unlock( &p_logo_list->lock );
 878         return NULL;
 879     }
 880
 881     vout_CopyPicture( p_filter, &p_region->picture, p_pic );
 882     vlc_mutex_unlock( &p_logo_list->lock );
 883
 884     /*  where to locate the logo: */
 885     if( p_sys->pos < 0 )
 886     {   /*  set to an absolute xy */
 887         p_region->i_align = OSD_ALIGN_RIGHT | OSD_ALIGN_TOP;
 888         p_spu->b_absolute = true;
 889     }
 890     else
 891     {   /* set to one of the 9 relative locations */
 892         p_region->i_align = p_sys->pos;
 893         p_spu->b_absolute = false;
 894     }
 895
 896     p_spu->i_x = p_sys->posx;
 897     p_spu->i_y = p_sys->posy;
 898
 899     p_spu->p_region = p_region;
 900
 901     p_spu->i_alpha = ( p_logo->i_alpha != -1 ?
 902                        p_logo->i_alpha : p_logo_list->i_alpha );
 903
 904     return p_spu;
 905 }
 906
 907 /*****************************************************************************
 908  * Callback to update params on the fly
 909  *****************************************************************************/
 910 static int LogoCallback( vlc_object_t *p_this, char const *psz_var,
 911                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 912 {
 913     VLC_UNUSED(oldval);
 914     filter_sys_t *p_sys = (filter_sys_t *)p_data;
 915     logo_list_t *p_logo_list = p_sys->p_logo_list;
 916
 917     if( !strncmp( psz_var, "logo-file", 6 ) )
 918     {
 919         vlc_mutex_lock( &p_logo_list->lock );
 920         FreeLogoList( p_logo_list );
 921         p_logo_list->psz_filename = strdup( newval.psz_string );
 922         LoadLogoList( p_this, p_logo_list );
 923         vlc_mutex_unlock( &p_logo_list->lock );
 924         p_sys->b_need_update = true;
 925     }
 926     else if ( !strncmp( psz_var, "logo-x", 6 ) )
 927     {
 928         p_sys->posx = newval.i_int;
 929     }
 930     else if ( !strncmp( psz_var, "logo-y", 6 ) )
 931     {
 932         p_sys->posy = newval.i_int;
 933     }
 934     else if ( !strncmp( psz_var, "logo-position", 12 ) )
 935     {
 936         p_sys->pos = newval.i_int;
 937     }
 938     else if ( !strncmp( psz_var, "logo-transparency", 9 ) )
 939     {
 940         vlc_mutex_lock( &p_logo_list->lock );
 941         p_logo_list->i_alpha = __MAX( __MIN( newval.i_int, 255 ), 0 );
 942         vlc_mutex_unlock( &p_logo_list->lock );
 943     }
 944     else if ( !strncmp( psz_var, "logo-repeat", 11 ) )
 945     {
 946         vlc_mutex_lock( &p_logo_list->lock );
 947         p_logo_list->i_repeat = newval.i_int;
 948         vlc_mutex_unlock( &p_logo_list->lock );
 949     }
 950     p_sys->b_need_update = true;
 951     return VLC_SUCCESS;
 952 }