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 #include <assert.h>
  37
  38 #include "vlc_filter.h"
  39 #include "filter_common.h"
  40 #include "vlc_image.h"
  41 #include "vlc_osd.h"
  42
  43 #ifdef LoadImage
  44 #   undef LoadImage
  45 #endif
  46
  47 /*****************************************************************************
  48  * Local prototypes
  49  *****************************************************************************/
  50 static int  Create    ( vlc_object_t * );
  51 static void Destroy   ( vlc_object_t * );
  52
  53 static int  Init      ( vout_thread_t * );
  54 static void End       ( vout_thread_t * );
  55 static void Render    ( vout_thread_t *, picture_t * );
  56
  57 static int  MouseEvent( vlc_object_t *, char const *,
  58                         vlc_value_t , vlc_value_t , void * );
  59 static int  Control   ( vout_thread_t *, int, va_list );
  60
  61 static int  CreateFilter ( vlc_object_t * );
  62 static void DestroyFilter( vlc_object_t * );
  63
  64 static int LogoCallback( vlc_object_t *, char const *,
  65                          vlc_value_t, vlc_value_t, void * );
  66
  67 /*****************************************************************************
  68  * Module descriptor
  69  *****************************************************************************/
  70 #define FILE_TEXT N_("Logo filenames")
  71 #define FILE_LONGTEXT N_("Full path of the image files to use. Format is " \
  72 "<image>[,<delay in ms>[,<alpha>]][;<image>[,<delay>[,<alpha>]]][;...]. " \
  73 "If you only have one file, simply enter its filename.")
  74 #define REPEAT_TEXT N_("Logo animation # of loops")
  75 #define REPEAT_LONGTEXT N_("Number of loops for the logo animation." \
  76         "-1 = continuous, 0 = disabled")
  77 #define DELAY_TEXT N_("Logo individual image time in ms")
  78 #define DELAY_LONGTEXT N_("Individual image display time of 0 - 60000 ms.")
  79
  80 #define POSX_TEXT N_("X coordinate")
  81 #define POSX_LONGTEXT N_("X coordinate of the logo. You can move the logo " \
  82                 "by left-clicking it." )
  83 #define POSY_TEXT N_("Y coordinate")
  84 #define POSY_LONGTEXT N_("Y coordinate of the logo. You can move the logo " \
  85                 "by left-clicking it." )
  86 #define TRANS_TEXT N_("Transparency of the logo")
  87 #define TRANS_LONGTEXT N_("Logo transparency value " \
  88   "(from 0 for full transparency to 255 for full opacity)." )
  89 #define POS_TEXT N_("Logo position")
  90 #define POS_LONGTEXT N_( \
  91   "Enforce the logo position on the video " \
  92   "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
  93   "also use combinations of these values, eg 6 = top-right).")
  94
  95 #define CFG_PREFIX "logo-"
  96
  97 static const int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
  98 static const char *const ppsz_pos_descriptions[] =
  99 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
 100   N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
 101
 102 vlc_module_begin ()
 103     set_capability( "sub filter", 0 )
 104     set_callbacks( CreateFilter, DestroyFilter )
 105     set_description( N_("Logo sub filter") )
 106     set_shortname( N_("Logo overlay") )
 107     set_category( CAT_VIDEO )
 108     set_subcategory( SUBCAT_VIDEO_SUBPIC )
 109     add_shortcut( "logo" )
 110
 111     add_file( CFG_PREFIX "file", NULL, NULL, FILE_TEXT, FILE_LONGTEXT, false )
 112     add_integer( CFG_PREFIX "x", 0, NULL, POSX_TEXT, POSX_LONGTEXT, true )
 113     add_integer( CFG_PREFIX "y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, true )
 114     /* default to 1000 ms per image, continuously cycle through them */
 115     add_integer( CFG_PREFIX "delay", 1000, NULL, DELAY_TEXT, DELAY_LONGTEXT, true )
 116     add_integer( CFG_PREFIX "repeat", -1, NULL, REPEAT_TEXT, REPEAT_LONGTEXT, true )
 117     add_integer_with_range( CFG_PREFIX "transparency", 255, 0, 255, NULL,
 118         TRANS_TEXT, TRANS_LONGTEXT, false )
 119     add_integer( CFG_PREFIX "position", -1, NULL, POS_TEXT, POS_LONGTEXT, false )
 120         change_integer_list( pi_pos_values, ppsz_pos_descriptions, NULL )
 121
 122     /* video output filter submodule */
 123     add_submodule ()
 124     set_capability( "video filter", 0 )
 125     set_callbacks( Create, Destroy )
 126     set_description( N_("Logo video filter") )
 127     add_shortcut( "logo" )
 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             picture_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         free( p_logo_list->psz_filename );
 335         free( p_sys );
 336         return VLC_EGENERIC;
 337     }
 338
 339     p_vout->pf_init = Init;
 340     p_vout->pf_end = End;
 341     p_vout->pf_manage = NULL;
 342     p_vout->pf_render = Render;
 343     p_vout->pf_display = NULL;
 344     p_vout->pf_control = Control;
 345
 346     p_sys->pos = var_CreateGetIntegerCommand( p_vout, "logo-position" );
 347     p_sys->posx = var_CreateGetIntegerCommand( p_vout, "logo-x" );
 348     p_sys->posy = var_CreateGetIntegerCommand( p_vout, "logo-y" );
 349     p_logo_list->i_delay = __MAX( __MIN(
 350         var_CreateGetIntegerCommand( p_vout, "logo-delay" ) , 60000 ), 0 );
 351     p_logo_list->i_repeat = var_CreateGetIntegerCommand( p_vout, "logo-repeat");
 352     p_logo_list->i_alpha = __MAX( __MIN(
 353         var_CreateGetIntegerCommand( p_vout, "logo-transparency" ), 255 ), 0 );
 354
 355     LoadLogoList( p_vout, p_logo_list );
 356
 357     return VLC_SUCCESS;
 358 }
 359
 360 /*****************************************************************************
 361  * Init: initialize logo video thread output method
 362  *****************************************************************************/
 363 static int Init( vout_thread_t *p_vout )
 364 {
 365     vout_sys_t *p_sys = p_vout->p_sys;
 366     picture_t *p_pic;
 367     video_format_t fmt;
 368     logo_list_t *p_logo_list = p_sys->p_logo_list;
 369
 370     I_OUTPUTPICTURES = 0;
 371     memset( &fmt, 0, sizeof(video_format_t) );
 372
 373     /* adjust index to the next logo */
 374     p_logo_list->i_counter =
 375                         ( p_logo_list->i_counter + 1 )%p_logo_list->i_count;
 376
 377     p_pic = p_logo_list->p_logo[p_logo_list->i_counter].p_pic;
 378     /* Initialize the output structure */
 379     p_vout->output.i_chroma = p_vout->render.i_chroma;
 380     p_vout->output.i_width  = p_vout->render.i_width;
 381     p_vout->output.i_height = p_vout->render.i_height;
 382     p_vout->output.i_aspect = p_vout->render.i_aspect;
 383     p_vout->fmt_out = p_vout->fmt_in;
 384     fmt = p_vout->fmt_out;
 385
 386     /* Load the video blending filter */
 387     p_sys->p_blend = vlc_object_create( p_vout, sizeof(filter_t) );
 388     vlc_object_attach( p_sys->p_blend, p_vout );
 389     p_sys->p_blend->fmt_out.video.i_x_offset =
 390         p_sys->p_blend->fmt_out.video.i_y_offset = 0;
 391     p_sys->p_blend->fmt_in.video.i_x_offset =
 392         p_sys->p_blend->fmt_in.video.i_y_offset = 0;
 393     p_sys->p_blend->fmt_out.video.i_aspect = p_vout->render.i_aspect;
 394     p_sys->p_blend->fmt_out.video.i_chroma = p_vout->output.i_chroma;
 395     p_sys->p_blend->fmt_in.video.i_chroma = VLC_FOURCC('Y','U','V','A');
 396     p_sys->p_blend->fmt_in.video.i_aspect = VOUT_ASPECT_FACTOR;
 397     p_sys->i_width =
 398         p_sys->p_blend->fmt_in.video.i_width =
 399             p_sys->p_blend->fmt_in.video.i_visible_width =
 400                 p_pic ? p_pic->p[Y_PLANE].i_visible_pitch : 0;
 401     p_sys->i_height =
 402         p_sys->p_blend->fmt_in.video.i_height =
 403             p_sys->p_blend->fmt_in.video.i_visible_height =
 404                 p_pic ? p_pic->p[Y_PLANE].i_visible_lines : 0;
 405     p_sys->p_blend->fmt_out.video.i_width =
 406         p_sys->p_blend->fmt_out.video.i_visible_width =
 407            p_vout->output.i_width;
 408     p_sys->p_blend->fmt_out.video.i_height =
 409         p_sys->p_blend->fmt_out.video.i_visible_height =
 410             p_vout->output.i_height;
 411
 412     p_sys->p_blend->p_module =
 413         module_need( p_sys->p_blend, "video blending", NULL, false );
 414     if( !p_sys->p_blend->p_module )
 415     {
 416         msg_Err( p_vout, "can't open blending filter, aborting" );
 417         vlc_object_detach( p_sys->p_blend );
 418         vlc_object_release( p_sys->p_blend );
 419         return VLC_EGENERIC;
 420     }
 421
 422     if( p_sys->posx < 0 || p_sys->posy < 0 )
 423     {
 424         p_sys->posx = 0; p_sys->posy = 0;
 425
 426         if( p_sys->pos & SUBPICTURE_ALIGN_BOTTOM )
 427         {
 428             p_sys->posy = p_vout->render.i_height - p_sys->i_height;
 429         }
 430         else if ( !(p_sys->pos & SUBPICTURE_ALIGN_TOP) )
 431         {
 432             p_sys->posy = p_vout->render.i_height / 2 - p_sys->i_height / 2;
 433         }
 434
 435         if( p_sys->pos & SUBPICTURE_ALIGN_RIGHT )
 436         {
 437             p_sys->posx = p_vout->render.i_width - p_sys->i_width;
 438         }
 439         else if ( !(p_sys->pos & SUBPICTURE_ALIGN_LEFT) )
 440         {
 441             p_sys->posx = p_vout->render.i_width / 2 - p_sys->i_width / 2;
 442         }
 443     }
 444     else
 445     {
 446         p_sys->pos = 0;
 447     }
 448
 449     /* Try to open the real video output */
 450     msg_Dbg( p_vout, "spawning the real video output" );
 451
 452     p_sys->p_vout = vout_Create( p_vout, &fmt );
 453
 454     /* Everything failed */
 455     if( p_sys->p_vout == NULL )
 456     {
 457         msg_Err( p_vout, "can't open vout, aborting" );
 458         return VLC_EGENERIC;
 459     }
 460
 461     vout_filter_AllocateDirectBuffers( p_vout, VOUT_MAX_PICTURES );
 462
 463     vout_filter_AddChild( p_vout, p_sys->p_vout, MouseEvent );
 464
 465     return VLC_SUCCESS;
 466 }
 467
 468 /*****************************************************************************
 469  * End: terminate logo video thread output method
 470  *****************************************************************************/
 471 static void End( vout_thread_t *p_vout )
 472 {
 473     vout_sys_t *p_sys = p_vout->p_sys;
 474
 475     vout_filter_DelChild( p_vout, p_sys->p_vout, MouseEvent );
 476     vout_CloseAndRelease( p_sys->p_vout );
 477
 478     vout_filter_ReleaseDirectBuffers( p_vout );
 479
 480     if( p_sys->p_blend->p_module )
 481         module_unneed( p_sys->p_blend, p_sys->p_blend->p_module );
 482     vlc_object_detach( p_sys->p_blend );
 483     vlc_object_release( p_sys->p_blend );
 484 }
 485
 486 /*****************************************************************************
 487  * Destroy: destroy logo video thread output method
 488  *****************************************************************************/
 489 static void Destroy( vlc_object_t *p_this )
 490 {
 491     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 492     vout_sys_t *p_sys = p_vout->p_sys;
 493
 494
 495     FreeLogoList( p_sys->p_logo_list );
 496     free( p_sys->p_logo_list );
 497
 498     free( p_sys );
 499 }
 500
 501 /*****************************************************************************
 502  * Render: render the logo onto the video
 503  *****************************************************************************/
 504 static void Render( vout_thread_t *p_vout, picture_t *p_inpic )
 505 {
 506     vout_sys_t *p_sys = p_vout->p_sys;
 507     picture_t *p_outpic;
 508     picture_t *p_pic;
 509     logo_list_t *p_logo_list;
 510     logo_t * p_logo;
 511
 512     p_logo_list = p_sys->p_logo_list;
 513
 514     if( p_logo_list->i_next_pic < p_inpic->date )
 515     {
 516         /* It's time to use a new logo */
 517         p_logo_list->i_counter =
 518                         ( p_logo_list->i_counter + 1 )%p_logo_list->i_count;
 519         p_logo = &p_logo_list->p_logo[p_sys->p_logo_list->i_counter];
 520         p_pic = p_logo->p_pic;
 521         p_logo_list->i_next_pic = p_inpic->date + ( p_logo->i_delay != -1 ?
 522                               p_logo->i_delay : p_logo_list->i_delay ) * 1000;
 523         if( p_pic )
 524         {
 525
 526             p_sys->i_width =
 527                 p_sys->p_blend->fmt_in.video.i_width =
 528                     p_sys->p_blend->fmt_in.video.i_visible_width =
 529                         p_pic->p[Y_PLANE].i_visible_pitch;
 530             p_sys->i_height =
 531                 p_sys->p_blend->fmt_in.video.i_height =
 532                     p_sys->p_blend->fmt_in.video.i_visible_height =
 533                         p_pic->p[Y_PLANE].i_visible_lines;
 534
 535             if( p_sys->pos )
 536             {
 537                 if( p_sys->pos & SUBPICTURE_ALIGN_BOTTOM )
 538                 {
 539                     p_sys->posy = p_vout->render.i_height - p_sys->i_height;
 540                 }
 541                 else if ( !(p_sys->pos & SUBPICTURE_ALIGN_TOP) )
 542                 {
 543                     p_sys->posy = p_vout->render.i_height/2 - p_sys->i_height/2;
 544                 }
 545                 if( p_sys->pos & SUBPICTURE_ALIGN_RIGHT )
 546                 {
 547                     p_sys->posx = p_vout->render.i_width - p_sys->i_width;
 548                 }
 549                 else if ( !(p_sys->pos & SUBPICTURE_ALIGN_LEFT) )
 550                 {
 551                     p_sys->posx = p_vout->render.i_width/2 - p_sys->i_width/2;
 552                 }
 553             }
 554         }
 555
 556     }
 557     else
 558     {
 559         p_logo = &p_logo_list->p_logo[p_sys->p_logo_list->i_counter];
 560         p_pic = p_logo->p_pic;
 561     }
 562
 563     /* This is a new frame. Get a structure from the video_output. */
 564     while( !(p_outpic = vout_CreatePicture( p_sys->p_vout, 0, 0, 0 )) )
 565     {
 566         if( !vlc_object_alive (p_vout) || p_vout->b_error ) return;
 567         msleep( VOUT_OUTMEM_SLEEP );
 568     }
 569
 570     picture_Copy( p_outpic, p_inpic );
 571
 572     if( p_pic )
 573         p_sys->p_blend->pf_video_blend( p_sys->p_blend, p_outpic,
 574                                         p_pic, p_sys->posx, p_sys->posy,
 575                                         p_logo->i_alpha != -1 ? p_logo->i_alpha
 576                                         : p_logo_list->i_alpha );
 577
 578     vout_DisplayPicture( p_sys->p_vout, p_outpic );
 579 }
 580
 581 /*****************************************************************************
 582  * MouseEvent: callback for mouse events
 583  *****************************************************************************/
 584 static int MouseEvent( vlc_object_t *p_this, char const *psz_var,
 585                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
 586 {
 587     vout_thread_t *p_vout = p_data;
 588     assert( p_this == VLC_OBJECT(p_vout->p_sys->p_vout) );
 589     VLC_UNUSED(oldval);
 590
 591     vout_sys_t *p_sys = p_vout->p_sys;
 592     const int i_delta = newval.i_int - oldval.i_int;
 593     const int i_bdown = var_GetInteger( p_sys->p_vout, "mouse-button-down" );
 594
 595     if( (i_bdown & 0x1) == 0 )
 596         goto forward;
 597
 598     int i_x, i_y;
 599     int i_dx = 0;
 600     int i_dy = 0;
 601     if( psz_var[6] == 'x' )
 602     {
 603         i_y = var_GetInteger( p_sys->p_vout, "mouse-y" );
 604         i_x = newval.i_int;
 605         i_dx = i_delta;
 606     }
 607     else if( psz_var[6] == 'y' )
 608     {
 609         i_y = newval.i_int;
 610         i_x = var_GetInteger( p_sys->p_vout, "mouse-x" );
 611         i_dy = i_delta;
 612     }
 613     else
 614     {
 615         goto forward;
 616     }
 617
 618     /* FIXME missing lock */
 619     if( i_x < (int)p_sys->posx ||
 620         i_y < (int)p_sys->posy ||
 621         i_x > (int)(p_sys->posx + p_sys->i_width) ||
 622         i_y > (int)(p_sys->posy + p_sys->i_height) )
 623         goto forward;
 624
 625     p_sys->posx = __MIN( __MAX( p_sys->posx + i_dx, 0 ),
 626                          p_vout->output.i_width - p_sys->i_width );
 627     p_sys->posy = __MIN( __MAX( p_sys->posy + i_dy, 0 ),
 628                          p_vout->output.i_height - p_sys->i_height );
 629     return VLC_SUCCESS;
 630
 631 forward:
 632     return var_Set( p_vout, psz_var, newval );
 633 }
 634
 635 /*****************************************************************************
 636  * Control: control facility for the vout (forwards to child vout)
 637  *****************************************************************************/
 638 static int Control( vout_thread_t *p_vout, int i_query, va_list args )
 639 {
 640     return vout_vaControl( p_vout->p_sys->p_vout, i_query, args );
 641 }
 642
 643 /*****************************************************************************
 644  * filter_sys_t: logo filter descriptor
 645  *****************************************************************************/
 646 struct filter_sys_t
 647 {
 648     logo_list_t *p_logo_list;
 649
 650     int pos, posx, posy;
 651
 652     bool b_absolute;
 653     mtime_t i_last_date;
 654
 655     /* On the fly control variable */
 656     bool b_need_update;
 657 };
 658
 659 static subpicture_t *Filter( filter_t *, mtime_t );
 660
 661 /*****************************************************************************
 662  * CreateFilter: allocates logo video filter
 663  *****************************************************************************/
 664 static int CreateFilter( vlc_object_t *p_this )
 665 {
 666     filter_t *p_filter = (filter_t *)p_this;
 667     filter_sys_t *p_sys;
 668     logo_list_t *p_logo_list;
 669
 670     /* Allocate structure */
 671     p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
 672     if( p_sys == NULL )
 673         return VLC_ENOMEM;
 674     p_logo_list = p_sys->p_logo_list = malloc( sizeof( logo_list_t ) );
 675     if( p_logo_list == NULL )
 676     {
 677         free( p_sys );
 678         return VLC_ENOMEM;
 679     }
 680
 681     config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
 682                        p_filter->p_cfg );
 683
 684     /* Hook used for callback variables */
 685     p_logo_list->psz_filename =
 686         var_CreateGetStringCommand( p_filter, "logo-file" );
 687     if( !p_logo_list->psz_filename || !*p_logo_list->psz_filename )
 688     {
 689         msg_Err( p_this, "logo file not specified" );
 690         free( p_sys );
 691         free( p_logo_list );
 692         return VLC_EGENERIC;
 693     }
 694
 695     p_sys->posx = var_CreateGetIntegerCommand( p_filter, "logo-x" );
 696     p_sys->posy = var_CreateGetIntegerCommand( p_filter, "logo-y" );
 697     p_sys->pos = var_CreateGetIntegerCommand( p_filter, "logo-position" );
 698     p_logo_list->i_alpha = __MAX( __MIN( var_CreateGetIntegerCommand(
 699                            p_filter, "logo-transparency"), 255 ), 0 );
 700     p_logo_list->i_delay =
 701         var_CreateGetIntegerCommand( p_filter, "logo-delay" );
 702     p_logo_list->i_repeat =
 703         var_CreateGetIntegerCommand( p_filter, "logo-repeat" );
 704
 705     var_AddCallback( p_filter, "logo-file", LogoCallback, p_sys );
 706     var_AddCallback( p_filter, "logo-x", LogoCallback, p_sys );
 707     var_AddCallback( p_filter, "logo-y", LogoCallback, p_sys );
 708     var_AddCallback( p_filter, "logo-position", LogoCallback, p_sys );
 709     var_AddCallback( p_filter, "logo-transparency", LogoCallback, p_sys );
 710     var_AddCallback( p_filter, "logo-repeat", LogoCallback, p_sys );
 711
 712     vlc_mutex_init( &p_logo_list->lock );
 713     vlc_mutex_lock( &p_logo_list->lock );
 714
 715     LoadLogoList( p_this, p_logo_list );
 716
 717     vlc_mutex_unlock( &p_logo_list->lock );
 718
 719     /* Misc init */
 720     p_filter->pf_sub_filter = Filter;
 721     p_sys->b_need_update = true;
 722
 723     p_sys->i_last_date = 0;
 724
 725     return VLC_SUCCESS;
 726 }
 727
 728 /*****************************************************************************
 729  * DestroyFilter: destroy logo video filter
 730  *****************************************************************************/
 731 static void DestroyFilter( vlc_object_t *p_this )
 732 {
 733     filter_t *p_filter = (filter_t *)p_this;
 734     filter_sys_t *p_sys = p_filter->p_sys;
 735
 736     /* Delete the logo variables from INPUT */
 737     var_Destroy( p_filter->p_libvlc, "logo-file" );
 738     var_Destroy( p_filter->p_libvlc, "logo-x" );
 739     var_Destroy( p_filter->p_libvlc, "logo-y" );
 740     var_Destroy( p_filter->p_libvlc, "logo-delay" );
 741     var_Destroy( p_filter->p_libvlc, "logo-repeat" );
 742     var_Destroy( p_filter->p_libvlc, "logo-position" );
 743     var_Destroy( p_filter->p_libvlc, "logo-transparency" );
 744
 745     vlc_mutex_destroy( &p_sys->p_logo_list->lock );
 746     FreeLogoList( p_sys->p_logo_list );
 747     free( p_sys->p_logo_list );
 748     free( p_sys );
 749 }
 750
 751 /*****************************************************************************
 752  * Filter: the whole thing
 753  *****************************************************************************
 754  * This function outputs subpictures at regular time intervals.
 755  *****************************************************************************/
 756 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
 757 {
 758     filter_sys_t *p_sys = p_filter->p_sys;
 759     logo_list_t *p_logo_list = p_sys->p_logo_list;
 760     subpicture_t *p_spu;
 761     subpicture_region_t *p_region;
 762     video_format_t fmt;
 763     picture_t *p_pic;
 764     logo_t *p_logo;
 765
 766     vlc_mutex_lock( &p_logo_list->lock );
 767     /* Basic test:  b_need_update occurs on a dynamic change,
 768                     & i_next_pic is the general timer, when to
 769                     look at updating the logo image */
 770
 771     if( ( ( !p_sys->b_need_update ) && ( p_logo_list->i_next_pic > date ) )
 772         || !p_logo_list->i_repeat )
 773     {
 774         vlc_mutex_unlock( &p_logo_list->lock );
 775         return 0;
 776     }
 777     /* prior code tested on && p_sys->i_last_date +5000000 > date ) return 0; */
 778
 779     /* adjust index to the next logo */
 780     p_logo_list->i_counter =
 781                         ( p_logo_list->i_counter + 1 )%p_logo_list->i_count;
 782
 783     p_logo = &p_logo_list->p_logo[p_logo_list->i_counter];
 784     p_pic = p_logo->p_pic;
 785
 786     /* Allocate the subpicture internal data. */
 787     p_spu = filter_NewSubpicture( p_filter );
 788     if( !p_spu )
 789     {
 790         vlc_mutex_unlock( &p_logo_list->lock );
 791         return NULL;
 792     }
 793
 794     p_spu->b_absolute = p_sys->b_absolute;
 795     p_spu->i_start = p_sys->i_last_date = date;
 796     p_spu->i_stop = 0;
 797     p_spu->b_ephemer = true;
 798
 799     p_sys->b_need_update = false;
 800     p_logo_list->i_next_pic = date +
 801     ( p_logo->i_delay != -1 ? p_logo->i_delay : p_logo_list->i_delay ) * 1000;
 802
 803     if( p_logo_list->i_repeat != -1
 804         && p_logo_list->i_counter == 0 )
 805     {
 806         p_logo_list->i_repeat--;
 807         if( p_logo_list->i_repeat == 0 )
 808         {
 809             vlc_mutex_unlock( &p_logo_list->lock );
 810             return p_spu;
 811         }
 812     }
 813
 814     if( !p_pic || !p_logo->i_alpha
 815         || ( p_logo->i_alpha == -1 && !p_logo_list->i_alpha ) )
 816     {
 817         /* Send an empty subpicture to clear the display */
 818         vlc_mutex_unlock( &p_logo_list->lock );
 819         return p_spu;
 820     }
 821
 822     /* Create new SPU region */
 823     memset( &fmt, 0, sizeof(video_format_t) );
 824     fmt.i_chroma = VLC_FOURCC('Y','U','V','A');
 825     fmt.i_aspect = VOUT_ASPECT_FACTOR;
 826     fmt.i_sar_num = fmt.i_sar_den = 1;
 827     fmt.i_width = fmt.i_visible_width = p_pic->p[Y_PLANE].i_visible_pitch;
 828     fmt.i_height = fmt.i_visible_height = p_pic->p[Y_PLANE].i_visible_lines;
 829     fmt.i_x_offset = fmt.i_y_offset = 0;
 830     p_region = subpicture_region_New( &fmt );
 831     if( !p_region )
 832     {
 833         msg_Err( p_filter, "cannot allocate SPU region" );
 834         p_filter->pf_sub_buffer_del( p_filter, p_spu );
 835         vlc_mutex_unlock( &p_logo_list->lock );
 836         return NULL;
 837     }
 838
 839     /* FIXME the copy is probably not needed anymore */
 840     picture_Copy( p_region->p_picture, p_pic );
 841     vlc_mutex_unlock( &p_logo_list->lock );
 842
 843     /*  where to locate the logo: */
 844     if( p_sys->pos < 0 )
 845     {   /*  set to an absolute xy */
 846         p_region->i_align = OSD_ALIGN_RIGHT | OSD_ALIGN_TOP;
 847         p_spu->b_absolute = true;
 848     }
 849     else
 850     {   /* set to one of the 9 relative locations */
 851         p_region->i_align = p_sys->pos;
 852         p_spu->b_absolute = false;
 853     }
 854
 855     p_region->i_x = p_sys->posx;
 856     p_region->i_y = p_sys->posy;
 857
 858     p_spu->p_region = p_region;
 859
 860     p_spu->i_alpha = ( p_logo->i_alpha != -1 ?
 861                        p_logo->i_alpha : p_logo_list->i_alpha );
 862
 863     return p_spu;
 864 }
 865
 866 /*****************************************************************************
 867  * Callback to update params on the fly
 868  *****************************************************************************/
 869 static int LogoCallback( vlc_object_t *p_this, char const *psz_var,
 870                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 871 {
 872     VLC_UNUSED(oldval);
 873     filter_sys_t *p_sys = (filter_sys_t *)p_data;
 874     logo_list_t *p_logo_list = p_sys->p_logo_list;
 875
 876     if( !strcmp( psz_var, "logo-file" ) )
 877     {
 878         vlc_mutex_lock( &p_logo_list->lock );
 879         FreeLogoList( p_logo_list );
 880         p_logo_list->psz_filename = strdup( newval.psz_string );
 881         LoadLogoList( p_this, p_logo_list );
 882         vlc_mutex_unlock( &p_logo_list->lock );
 883     }
 884     else if ( !strcmp( psz_var, "logo-x" ) )
 885     {
 886         p_sys->posx = newval.i_int;
 887     }
 888     else if ( !strcmp( psz_var, "logo-y" ) )
 889     {
 890         p_sys->posy = newval.i_int;
 891     }
 892     else if ( !strcmp( psz_var, "logo-position" ) )
 893     {
 894         p_sys->pos = newval.i_int;
 895     }
 896     else if ( !strcmp( psz_var, "logo-transparency" ) )
 897     {
 898         vlc_mutex_lock( &p_logo_list->lock );
 899         p_logo_list->i_alpha = __MAX( __MIN( newval.i_int, 255 ), 0 );
 900         vlc_mutex_unlock( &p_logo_list->lock );
 901     }
 902     else if ( !strcmp( psz_var, "logo-repeat" ) )
 903     {
 904         vlc_mutex_lock( &p_logo_list->lock );
 905         p_logo_list->i_repeat = newval.i_int;
 906         vlc_mutex_unlock( &p_logo_list->lock );
 907     }
 908     p_sys->b_need_update = true;
 909     return VLC_SUCCESS;
 910 }