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