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