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

   1 /*****************************************************************************
   2  * osdmenu.c: osd filter module
   3  *****************************************************************************
   4  * Copyright (C) 2004-2007 M2X
   5  * $Id$
   6  *
   7  * Authors: Jean-Paul Saman <jpsaman #_at_# m2x dot nl>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implid warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #ifdef HAVE_CONFIG_H
  28 # include "config.h"
  29 #endif
  30
  31 #include <vlc_common.h>
  32 #include <vlc_plugin.h>
  33 #include <vlc_vout.h>
  34 #include <vlc_filter.h>
  35
  36 #include <vlc_osd.h>
  37
  38 /*****************************************************************************
  39  * Module descriptor
  40  *****************************************************************************/
  41
  42 /* FIXME: Future extension make the definition file in XML format. */
  43 #define OSD_FILE_TEXT N_("Configuration file")
  44 #define OSD_FILE_LONGTEXT N_( \
  45     "Configuration file for the OSD Menu." )
  46 #define OSD_PATH_TEXT N_("Path to OSD menu images")
  47 #define OSD_PATH_LONGTEXT N_( \
  48     "Path to the OSD menu images. This will override the path defined in the " \
  49     "OSD configuration file." )
  50
  51 #define POSX_TEXT N_("X coordinate")
  52 #define POSX_LONGTEXT N_("You can move the OSD menu by left-clicking on it." )
  53
  54 #define POSY_TEXT N_("Y coordinate")
  55 #define POSY_LONGTEXT N_("You can move the OSD menu by left-clicking on it." )
  56
  57 #define POS_TEXT N_("Menu position")
  58 #define POS_LONGTEXT N_( \
  59   "You can enforce the OSD menu position on the video " \
  60   "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
  61   "also use combinations of these values, eg. 6 = top-right).")
  62
  63 #define TIMEOUT_TEXT N_("Menu timeout")
  64 #define TIMEOUT_LONGTEXT N_( \
  65     "OSD menu pictures get a default timeout of 15 seconds added to their " \
  66     "remaining time. This will ensure that they are at least the specified " \
  67     "time visible.")
  68
  69 #define OSD_UPDATE_TEXT N_("Menu update interval" )
  70 #define OSD_UPDATE_LONGTEXT N_( \
  71     "The default is to update the OSD menu picture every 200 ms. Shorten the" \
  72     " update time for environments that experience transmissions errors. " \
  73     "Be careful with this option as encoding OSD menu pictures is very " \
  74     "computing intensive. The range is 0 - 1000 ms." )
  75
  76 #define OSD_ALPHA_TEXT N_("Alpha transparency value (default 255)")
  77 #define OSD_ALPHA_LONGTEXT N_( \
  78     "The transparency of the OSD menu can be changed by giving a value " \
  79     "between 0 and 255. A lower value specifies more transparency a higher " \
  80     "means less transparency. The default is being not transparent " \
  81     "(value 255) the minimum is fully transparent (value 0)." )
  82
  83 static const int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
  84 static const char *const ppsz_pos_descriptions[] =
  85 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
  86   N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
  87
  88 /* subfilter functions */
  89 static int  CreateFilter ( vlc_object_t * );
  90 static void DestroyFilter( vlc_object_t * );
  91 static subpicture_t *Filter( filter_t *, mtime_t );
  92
  93 static int OSDMenuUpdateEvent( vlc_object_t *, char const *,
  94                     vlc_value_t, vlc_value_t, void * );
  95 static int OSDMenuVisibleEvent( vlc_object_t *, char const *,
  96                     vlc_value_t, vlc_value_t, void * );
  97 static int OSDMenuCallback( vlc_object_t *, char const *,
  98                             vlc_value_t, vlc_value_t, void * );
  99
 100 static int MouseEvent( vlc_object_t *, char const *,
 101                         vlc_value_t , vlc_value_t , void * );
 102
 103 #define OSD_CFG "osdmenu-"
 104
 105 #if defined( WIN32 ) || defined( UNDER_CE )
 106 #define OSD_DEFAULT_CFG "osdmenu/default.cfg"
 107 #else
 108 #define OSD_DEFAULT_CFG "share/osdmenu/default.cfg"
 109 #endif
 110
 111 #define OSD_UPDATE_MIN     0
 112 #define OSD_UPDATE_DEFAULT 300
 113 #define OSD_UPDATE_MAX     1000
 114
 115 vlc_module_begin();
 116     add_integer( OSD_CFG "x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, false );
 117     add_integer( OSD_CFG "y", -1, NULL, POSY_TEXT, POSY_LONGTEXT, false );
 118     add_integer( OSD_CFG "position", 8, NULL, POS_TEXT, POS_LONGTEXT,
 119                  false );
 120         change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
 121     add_string( OSD_CFG "file", OSD_DEFAULT_CFG, NULL, OSD_FILE_TEXT,
 122         OSD_FILE_LONGTEXT, false );
 123     add_string( OSD_CFG "file-path", NULL, NULL, OSD_PATH_TEXT,
 124         OSD_PATH_LONGTEXT, false );
 125     add_integer( OSD_CFG "timeout", 15, NULL, TIMEOUT_TEXT,
 126         TIMEOUT_LONGTEXT, false );
 127     add_integer_with_range( OSD_CFG "update", OSD_UPDATE_DEFAULT,
 128         OSD_UPDATE_MIN, OSD_UPDATE_MAX, NULL, OSD_UPDATE_TEXT,
 129         OSD_UPDATE_LONGTEXT, true );
 130     add_integer_with_range( OSD_CFG "alpha", 255, 0, 255, NULL,
 131         OSD_ALPHA_TEXT, OSD_ALPHA_LONGTEXT, true );
 132
 133     set_capability( "sub filter", 100 );
 134     set_description( N_("On Screen Display menu") );
 135     set_shortname( N_("OSD menu") );
 136     add_shortcut( "osdmenu" );
 137
 138     set_category( CAT_VIDEO );
 139     set_subcategory( SUBCAT_VIDEO_SUBPIC );
 140
 141     set_callbacks( CreateFilter, DestroyFilter );
 142 vlc_module_end();
 143
 144 /*****************************************************************************
 145  * Sub filter code
 146  *****************************************************************************/
 147
 148 /*****************************************************************************
 149  * Local prototypes
 150  *****************************************************************************/
 151 struct filter_sys_t
 152 {
 153     int          i_position;    /* relative positioning of SPU images */
 154     int          i_x;           /* absolute positioning of SPU images */
 155     int          i_y;           /* absolute positioning of SPU images */
 156     mtime_t      i_last_date;   /* last mdate SPU object has been sent to SPU subsytem */
 157     mtime_t      i_timeout;     /* duration SPU object is valid on the video output in seconds */
 158
 159     bool   b_absolute;    /* do we use absolute positioning or relative? */
 160     bool   b_update;      /* Update OSD Menu by sending SPU objects */
 161     bool   b_visible;     /* OSD Menu is visible */
 162     mtime_t      i_update;      /* Update the OSD menu every n ms */
 163     mtime_t      i_end_date;    /* End data of display OSD menu */
 164     int          i_alpha;       /* alpha transparency value */
 165
 166     char        *psz_file;      /* OSD Menu configuration file */
 167     char        *psz_path;      /* Path to OSD Menu pictures */
 168     osd_menu_t  *p_menu;        /* pointer to OSD Menu object */
 169
 170     /* menu interaction */
 171     vout_thread_t *p_vout;
 172     bool  b_clicked;
 173     uint32_t    i_mouse_x;
 174     uint32_t    i_mouse_y;
 175 };
 176
 177 /*****************************************************************************
 178  * CreateFilter: Create the filter and open the definition file
 179  *****************************************************************************/
 180 static int CreateFilter ( vlc_object_t *p_this )
 181 {
 182     filter_t *p_filter = (filter_t *)p_this;
 183     filter_sys_t *p_sys = NULL;
 184
 185     p_filter->p_sys = p_sys = (filter_sys_t *) malloc( sizeof(filter_sys_t) );
 186     if( !p_filter->p_sys )
 187     {
 188         msg_Err( p_filter, "out of memory" );
 189         return VLC_ENOMEM;
 190     }
 191     memset( p_sys, 0, sizeof(filter_sys_t) );
 192
 193     /* Populating struct */
 194     p_sys->psz_path = var_CreateGetString( p_this, OSD_CFG "file-path" );
 195     p_sys->psz_file = var_CreateGetString( p_this, OSD_CFG "file" );
 196     if( (p_sys->psz_file == NULL) ||
 197         (*p_sys->psz_file == '\0') )
 198     {
 199         msg_Err( p_filter, "unable to get filename" );
 200         goto error;
 201     }
 202
 203     p_sys->i_x = var_CreateGetIntegerCommand( p_this, OSD_CFG "x" );
 204     p_sys->i_y = var_CreateGetIntegerCommand( p_this, OSD_CFG "y" );
 205     p_sys->i_position = var_CreateGetIntegerCommand( p_this, OSD_CFG "position" );
 206     p_sys->i_alpha = var_CreateGetIntegerCommand( p_this, OSD_CFG "alpha" );
 207
 208     /* in micro seconds - divide by 2 to match user expectations */
 209     p_sys->i_timeout = var_CreateGetIntegerCommand( p_this, OSD_CFG "timeout" );
 210     p_sys->i_timeout = (mtime_t)(p_sys->i_timeout * 1000000) >> 2;
 211     p_sys->i_update  = var_CreateGetIntegerCommand( p_this, OSD_CFG "update" );
 212     p_sys->i_update = (mtime_t)(p_sys->i_update * 1000); /* in micro seconds */
 213
 214     var_AddCallback( p_filter, OSD_CFG "position", OSDMenuCallback, p_sys );
 215     var_AddCallback( p_filter, OSD_CFG "timeout", OSDMenuCallback, p_sys );
 216     var_AddCallback( p_filter, OSD_CFG "update", OSDMenuCallback, p_sys );
 217     var_AddCallback( p_filter, OSD_CFG "alpha", OSDMenuCallback, p_sys );
 218
 219     /* Load the osd menu subsystem */
 220     p_sys->p_menu = osd_MenuCreate( p_this, p_sys->psz_file );
 221     if( p_sys->p_menu == NULL )
 222         goto error;
 223
 224     p_sys->p_menu->i_position = p_sys->i_position;
 225
 226     /* Check if menu position was overridden */
 227     p_sys->b_absolute = true;
 228     if( (p_sys->i_x < 0) || (p_sys->i_y < 0) )
 229     {
 230         p_sys->b_absolute = false;
 231         p_sys->p_menu->i_x = 0;
 232         p_sys->p_menu->i_y = 0;
 233     }
 234     else if( (p_sys->i_x >= 0) || (p_sys->i_y >= 0) )
 235     {
 236         p_sys->p_menu->i_x = p_sys->i_x;
 237         p_sys->p_menu->i_y = p_sys->i_y;
 238     }
 239     else if( (p_sys->p_menu->i_x < 0) ||
 240              (p_sys->p_menu->i_y < 0) )
 241     {
 242         p_sys->b_absolute = false;
 243         p_sys->p_menu->i_x = 0;
 244         p_sys->p_menu->i_y = 0;
 245     }
 246
 247     /* Set up p_filter */
 248     p_sys->i_last_date = mdate();
 249
 250     /* Keep track of OSD Events */
 251     p_sys->b_update  = false;
 252     p_sys->b_visible = false;
 253     p_sys->b_clicked = false;
 254
 255     /* Listen to osd menu core updates/visible settings. */
 256     var_AddCallback( p_sys->p_menu, "osd-menu-update",
 257                      OSDMenuUpdateEvent, p_filter );
 258     var_AddCallback( p_sys->p_menu, "osd-menu-visible",
 259                      OSDMenuVisibleEvent, p_filter );
 260
 261     /* Attach subpicture filter callback */
 262     p_filter->pf_sub_filter = Filter;
 263
 264     p_sys->p_vout = vlc_object_find( p_this, VLC_OBJECT_VOUT, FIND_ANYWHERE );
 265     if( p_sys->p_vout )
 266     {
 267         var_AddCallback( p_sys->p_vout, "mouse-x",
 268                         MouseEvent, p_sys );
 269         var_AddCallback( p_sys->p_vout, "mouse-y",
 270                         MouseEvent, p_sys );
 271         var_AddCallback( p_sys->p_vout, "mouse-clicked",
 272                         MouseEvent, p_sys );
 273     }
 274
 275     es_format_Init( &p_filter->fmt_out, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
 276     p_filter->fmt_out.i_priority = 0;
 277
 278     return VLC_SUCCESS;
 279
 280 error:
 281     msg_Err( p_filter, "osdmenu filter discarded" );
 282
 283     osd_MenuDelete( p_this, p_sys->p_menu );
 284     p_sys->p_menu = NULL;
 285     free( p_sys->psz_file );
 286     free( p_sys );
 287     return VLC_EGENERIC;
 288 }
 289
 290 /*****************************************************************************
 291  * DestroyFilter: Make a clean exit of this plugin
 292  *****************************************************************************/
 293 static void DestroyFilter( vlc_object_t *p_this )
 294 {
 295     filter_t     *p_filter = (filter_t*)p_this;
 296     filter_sys_t *p_sys = p_filter->p_sys;
 297
 298     var_DelCallback( p_filter, OSD_CFG "position", OSDMenuCallback, p_sys );
 299     var_DelCallback( p_filter, OSD_CFG "timeout", OSDMenuCallback, p_sys );
 300     var_DelCallback( p_filter, OSD_CFG "update", OSDMenuCallback, p_sys );
 301     var_DelCallback( p_filter, OSD_CFG "alpha", OSDMenuCallback, p_sys );
 302
 303     if( p_sys )
 304     {
 305         var_DelCallback( p_sys->p_menu, "osd-menu-update",
 306                          OSDMenuUpdateEvent, p_filter );
 307         var_DelCallback( p_sys->p_menu, "osd-menu-visible",
 308                          OSDMenuVisibleEvent, p_filter );
 309     }
 310
 311     if( p_sys && p_sys->p_vout )
 312     {
 313         var_DelCallback( p_sys->p_vout, "mouse-x",
 314                         MouseEvent, p_sys );
 315         var_DelCallback( p_sys->p_vout, "mouse-y",
 316                         MouseEvent, p_sys );
 317         var_DelCallback( p_sys->p_vout, "mouse-clicked",
 318                         MouseEvent, p_sys );
 319
 320         vlc_object_release( p_sys->p_vout );
 321         p_sys->p_vout = NULL;
 322     }
 323
 324     var_Destroy( p_this, OSD_CFG "file-path" );
 325     var_Destroy( p_this, OSD_CFG "file" );
 326     var_Destroy( p_this, OSD_CFG "x" );
 327     var_Destroy( p_this, OSD_CFG "y" );
 328     var_Destroy( p_this, OSD_CFG "position" );
 329     var_Destroy( p_this, OSD_CFG "timeout" );
 330     var_Destroy( p_this, OSD_CFG "update" );
 331     var_Destroy( p_this, OSD_CFG "alpha" );
 332
 333     if( p_sys )
 334     {
 335         osd_MenuDelete( p_filter, p_sys->p_menu );
 336
 337         free( p_sys->psz_file );
 338         free( p_sys );
 339     }
 340 }
 341
 342 /*****************************************************************************
 343  * OSDMenuEvent: callback for OSD Menu events
 344  *****************************************************************************/
 345 static int OSDMenuVisibleEvent( vlc_object_t *p_this, char const *psz_var,
 346                     vlc_value_t oldval, vlc_value_t newval, void *p_data )
 347 {
 348     VLC_UNUSED(p_this); VLC_UNUSED(psz_var); VLC_UNUSED(oldval);
 349     VLC_UNUSED(newval);
 350     filter_t *p_filter = (filter_t *) p_data;
 351
 352     p_filter->p_sys->b_visible = true;
 353     p_filter->p_sys->b_update = true;
 354     return VLC_SUCCESS;
 355 }
 356
 357 static int OSDMenuUpdateEvent( vlc_object_t *p_this, char const *psz_var,
 358                     vlc_value_t oldval, vlc_value_t newval, void *p_data )
 359 {
 360     VLC_UNUSED(p_this); VLC_UNUSED(psz_var); VLC_UNUSED(oldval);
 361     VLC_UNUSED(newval);
 362     filter_t *p_filter = (filter_t *) p_data;
 363     filter_sys_t *p_sys = p_filter->p_sys;
 364
 365     p_sys->b_update = p_sys->b_visible ? true : false;
 366     p_sys->i_end_date = (mtime_t) 0;
 367     return VLC_SUCCESS;
 368 }
 369
 370 #if 0
 371 /*****************************************************************************
 372  * create_text_region : compose a text region SPU
 373  *****************************************************************************/
 374 static subpicture_region_t *create_text_region( filter_t *p_filter, subpicture_t *p_spu,
 375     int i_width, int i_height, const char *psz_text )
 376 {
 377     subpicture_region_t *p_region;
 378     video_format_t       fmt;
 379
 380     /* Create new SPU region */
 381     memset( &fmt, 0, sizeof(video_format_t) );
 382     fmt.i_chroma = VLC_FOURCC( 'T','E','X','T' );
 383     fmt.i_aspect = VOUT_ASPECT_FACTOR;
 384     fmt.i_sar_num = fmt.i_sar_den = 1;
 385     fmt.i_width = fmt.i_visible_width = i_width;
 386     fmt.i_height = fmt.i_visible_height = i_height;
 387     fmt.i_x_offset = fmt.i_y_offset = 0;
 388     p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
 389     if( !p_region )
 390     {
 391         msg_Err( p_filter, "cannot allocate another SPU region" );
 392         return NULL;
 393     }
 394     p_region->psz_text = strdup( psz_text );
 395     p_region->i_x = 0;
 396     p_region->i_y = 40;
 397 #if 0
 398     msg_Dbg( p_filter, "SPU text region position (%d,%d) (%d,%d) [%s]",
 399         p_region->i_x, p_region->i_y,
 400         p_region->fmt.i_width, p_region->fmt.i_height, p_region->psz_text );
 401 #endif
 402     return p_region;
 403 }
 404 #endif
 405
 406 /*****************************************************************************
 407  * create_picture_region : compose a picture region SPU
 408  *****************************************************************************/
 409 static subpicture_region_t *create_picture_region( filter_t *p_filter, subpicture_t *p_spu,
 410     int i_width, int i_height, picture_t *p_pic )
 411 {
 412     subpicture_region_t *p_region = NULL;
 413     video_format_t       fmt;
 414
 415     if( !p_spu ) return NULL;
 416
 417     /* Create new SPU region */
 418     memset( &fmt, 0, sizeof(video_format_t) );
 419     fmt.i_chroma = (p_pic == NULL) ? VLC_FOURCC('Y','U','V','P') : VLC_FOURCC('Y','U','V','A');
 420     fmt.i_aspect = VOUT_ASPECT_FACTOR;
 421     fmt.i_sar_num = fmt.i_sar_den = 1;
 422     fmt.i_width = fmt.i_visible_width = i_width;
 423     fmt.i_height = fmt.i_visible_height = i_height;
 424     fmt.i_x_offset = fmt.i_y_offset = 0;
 425
 426     p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
 427     if( !p_region )
 428     {
 429         msg_Err( p_filter, "cannot allocate SPU region" );
 430         p_filter->pf_sub_buffer_del( p_filter, p_spu );
 431         return NULL;
 432     }
 433     if( !p_pic && ( fmt.i_chroma == VLC_FOURCC('Y','U','V','P') ) )
 434     {
 435         p_region->fmt.p_palette->i_entries = 0;
 436         p_region->fmt.i_width = p_region->fmt.i_visible_width = 0;
 437         p_region->fmt.i_height = p_region->fmt.i_visible_height = 0;
 438     }
 439     if( p_pic )
 440         vout_CopyPicture( p_filter, &p_region->picture, p_pic );
 441
 442     p_region->i_x = 0;
 443     p_region->i_y = 0;
 444     p_region->i_align = p_filter->p_sys->i_position;
 445     p_region->i_alpha = p_filter->p_sys->i_alpha;
 446 #if 0
 447     msg_Dbg( p_filter, "SPU picture region position (%d,%d) (%d,%d) [%p]",
 448         p_region->i_x, p_region->i_y,
 449         p_region->fmt.i_width, p_region->fmt.i_height, p_pic );
 450 #endif
 451     return p_region;
 452 }
 453
 454 /****************************************************************************
 455  * Filter: the whole thing
 456  ****************************************************************************
 457  * This function outputs subpictures at regular time intervals.
 458  ****************************************************************************/
 459 static subpicture_t *Filter( filter_t *p_filter, mtime_t i_date )
 460 {
 461     filter_sys_t *p_sys = p_filter->p_sys;
 462     subpicture_t *p_spu = NULL;
 463     subpicture_region_t *p_region = NULL;
 464
 465     if( !p_sys->b_update || (p_sys->i_update <= 0) )
 466             return NULL;
 467
 468     /* Am I too early?
 469     */
 470     if( ( ( p_sys->i_last_date + p_sys->i_update ) > i_date ) &&
 471         ( p_sys->i_end_date > 0 ) )
 472         return NULL; /* we are too early, so wait */
 473
 474     /* Allocate the subpicture internal data. */
 475     p_spu = p_filter->pf_sub_buffer_new( p_filter );
 476     if( !p_spu ) return NULL;
 477
 478     p_spu->b_ephemer = true;
 479     p_spu->b_fade = true;
 480     if( p_filter->p_sys->p_menu->i_style == OSD_MENU_STYLE_CONCAT )
 481         p_spu->b_absolute = true;
 482     else
 483         p_spu->b_absolute = p_sys->b_absolute;
 484     p_spu->i_flags = p_sys->i_position;
 485
 486     /* Determine the duration of the subpicture */
 487     if( p_sys->i_end_date > 0 )
 488     {
 489         /* Display the subpicture again. */
 490         p_spu->i_stop = p_sys->i_end_date - i_date;
 491         if( ( i_date + p_sys->i_update ) >= p_sys->i_end_date )
 492             p_sys->b_update = false;
 493     }
 494     else
 495     {
 496         /* There is a new OSD picture to display */
 497         p_spu->i_stop = i_date + p_sys->i_timeout;
 498         p_sys->i_end_date = p_spu->i_stop;
 499     }
 500
 501     p_sys->i_last_date = i_date;
 502     p_spu->i_start = p_sys->i_last_date = i_date;
 503
 504     /* Send an empty subpicture to clear the display
 505      * when OSD menu should be hidden and menu picture is not allocated.
 506      */
 507     if( !p_filter->p_sys->p_menu->p_state->p_pic ||
 508         ( p_filter->p_sys->b_visible == false ) )
 509     {
 510         /* Create new spu regions and allocate an empty picture in it. */
 511         p_region = create_picture_region( p_filter, p_spu,
 512             p_filter->p_sys->p_menu->p_state->i_width,
 513             p_filter->p_sys->p_menu->p_state->i_height,
 514             NULL );
 515
 516         /* proper positioning of OSD menu image */
 517         p_spu->i_x = p_filter->p_sys->p_menu->p_state->i_x;
 518         p_spu->i_y = p_filter->p_sys->p_menu->p_state->i_y;
 519         p_spu->p_region = p_region;
 520         p_spu->i_alpha = 0xFF; /* Picture is completely non transparent. */
 521         return p_spu;
 522     }
 523
 524     if( p_sys->p_vout && p_sys->b_clicked )
 525     {
 526         p_sys->b_clicked = false;
 527         osd_MenuActivate( p_filter );
 528     }
 529     /* Create new spu regions
 530     */
 531     p_region = create_picture_region( p_filter, p_spu,
 532         p_filter->p_sys->p_menu->p_state->i_width,
 533         p_filter->p_sys->p_menu->p_state->i_height,
 534         p_filter->p_sys->p_menu->p_state->p_pic );
 535
 536     if( !p_region )
 537     {
 538         p_filter->pf_sub_buffer_del( p_filter, p_spu );
 539         return NULL;
 540     }
 541
 542     p_spu->i_width = p_region->fmt.i_visible_width;
 543     p_spu->i_height = p_region->fmt.i_visible_height;
 544     p_spu->i_alpha = p_filter->p_sys->i_alpha;
 545
 546     /* proper positioning of OSD menu image */
 547     if( p_filter->p_sys->p_menu->i_style == OSD_MENU_STYLE_CONCAT )
 548     {
 549         p_spu->i_x = p_filter->p_sys->p_menu->p_button->i_x;
 550         p_spu->i_y = p_filter->p_sys->p_menu->p_button->i_y;
 551     }
 552     else
 553     {
 554         p_spu->i_x = p_filter->p_sys->p_menu->p_state->i_x;
 555         p_spu->i_y = p_filter->p_sys->p_menu->p_state->i_y;
 556     }
 557
 558     if( p_filter->p_sys->p_menu->i_style == OSD_MENU_STYLE_CONCAT )
 559     {
 560         subpicture_region_t *p_region_list = NULL;
 561         subpicture_region_t *p_region_tail = NULL;
 562         osd_menu_t *p_osd = p_filter->p_sys->p_menu;
 563         osd_button_t *p_button = p_osd->p_button;
 564
 565         /* Construct the entire OSD from individual images */
 566         while( p_button != NULL )
 567         {
 568             osd_button_t *p_tmp = NULL;
 569             subpicture_region_t *p_new = NULL;
 570
 571             p_new = create_picture_region( p_filter, p_spu,
 572                     p_button->p_current_state->p_pic->p[Y_PLANE].i_visible_pitch,
 573                     p_button->p_current_state->p_pic->p[Y_PLANE].i_visible_lines,
 574                     p_button->p_current_state->p_pic );
 575             if( !p_new )
 576             {
 577                 /* Cleanup when bailing out */
 578                 subpicture_region_t *p_tmp = NULL;
 579                 while( p_region_list )
 580                 {
 581                     p_tmp = p_region_list->p_next;
 582                     p_spu->pf_destroy_region( VLC_OBJECT(p_filter), p_region_list );
 583                 };
 584                 p_spu->pf_destroy_region( VLC_OBJECT(p_filter), p_region );
 585                 p_filter->pf_sub_buffer_del( p_filter, p_spu );
 586                 return NULL;
 587             }
 588
 589             p_spu->i_width += p_new->fmt.i_visible_width;
 590             p_spu->i_height += p_new->fmt.i_visible_height;
 591
 592             if( !p_region_list )
 593             {
 594                 p_region_list = p_new;
 595                 p_region_tail = p_new;
 596             }
 597             else
 598             {
 599                 p_new->i_x = p_region_tail->fmt.i_visible_width;
 600                 p_new->i_y = p_button->i_y;
 601                 p_region_tail->p_next = p_new;
 602                 p_region_tail = p_new;
 603             }
 604             p_tmp = p_button->p_next;
 605             p_button = p_tmp;
 606         };
 607         p_region->p_next = p_region_list;
 608     }
 609 #if 0
 610     p_region->p_next = create_text_region( p_filter, p_spu,
 611         p_filter->p_sys->p_menu->p_state->i_width, p_filter->p_sys->p_menu->p_state->i_height,
 612         p_filter->p_sys->p_menu->p_state->p_visible->psz_action );
 613 #endif
 614     p_spu->p_region = p_region;
 615     return p_spu;
 616 }
 617
 618 static int OSDMenuCallback( vlc_object_t *p_this, char const *psz_var,
 619                             vlc_value_t oldval, vlc_value_t newval,
 620                             void *p_data )
 621 {
 622     VLC_UNUSED(p_this); VLC_UNUSED(oldval);
 623     filter_sys_t *p_sys = (filter_sys_t *) p_data;
 624
 625     if( !p_sys )
 626         return VLC_SUCCESS;
 627
 628     if( !strncmp( psz_var, OSD_CFG"position", 16) )
 629     {
 630 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
 631         unsigned int i;
 632         for( i=0; i < ARRAY_SIZE(pi_pos_values); i++ )
 633         {
 634             if( newval.i_int == pi_pos_values[i] )
 635             {
 636                 p_sys->i_position = newval.i_int % 11;
 637                 break;
 638             }
 639         }
 640 #undef ARRAY_SIZE
 641     }
 642     else if( !strncmp( psz_var, OSD_CFG"x", 9) ||
 643              !strncmp( psz_var, OSD_CFG"y", 9))
 644     {
 645         p_sys->b_absolute = true;
 646         if( (p_sys->i_x < 0) || (p_sys->i_y < 0) )
 647         {
 648             p_sys->b_absolute = false;
 649             p_sys->p_menu->i_x = 0;
 650             p_sys->p_menu->i_y = 0;
 651         }
 652         else if( (p_sys->i_x >= 0) || (p_sys->i_y >= 0) )
 653         {
 654             p_sys->p_menu->i_x = p_sys->i_x;
 655             p_sys->p_menu->i_y = p_sys->i_y;
 656         }
 657     }
 658     else if( !strncmp( psz_var, OSD_CFG"update", 14) )
 659         p_sys->i_update =  (mtime_t)(newval.i_int * 1000);
 660     else if( !strncmp( psz_var, OSD_CFG"timeout", 15) )
 661         p_sys->i_update = newval.i_int % 1000;
 662     else if( !strncmp( psz_var, OSD_CFG"alpha", 13) )
 663         p_sys->i_alpha = newval.i_int % 256;
 664
 665     p_sys->b_update = p_sys->b_visible ? true : false;
 666     return VLC_SUCCESS;
 667 }
 668
 669 /*****************************************************************************
 670  * MouseEvent: callback for mouse events
 671  *****************************************************************************/
 672 static int MouseEvent( vlc_object_t *p_this, char const *psz_var,
 673                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
 674 {
 675     VLC_UNUSED(oldval); VLC_UNUSED(newval);
 676     filter_sys_t *p_sys = (filter_sys_t *)p_data;
 677     vout_thread_t *p_vout = (vout_thread_t*)p_sys->p_vout;
 678     int i_x, i_y;
 679     int i_v;
 680
 681 #define MOUSE_DOWN    1
 682 #define MOUSE_CLICKED 2
 683 #define MOUSE_MOVE_X  4
 684 #define MOUSE_MOVE_Y  8
 685 #define MOUSE_MOVE    12
 686     uint8_t mouse= 0;
 687
 688     int v_h = p_vout->output.i_height;
 689     int v_w = p_vout->output.i_width;
 690
 691     if( psz_var[6] == 'x' ) mouse |= MOUSE_MOVE_X;
 692     if( psz_var[6] == 'y' ) mouse |= MOUSE_MOVE_Y;
 693     if( psz_var[6] == 'c' ) mouse |= MOUSE_CLICKED;
 694
 695     i_v = var_GetInteger( p_sys->p_vout, "mouse-button-down" );
 696     if( i_v & 0x1 ) mouse |= MOUSE_DOWN;
 697     i_y = var_GetInteger( p_sys->p_vout, "mouse-y" );
 698     i_x = var_GetInteger( p_sys->p_vout, "mouse-x" );
 699
 700     if( i_y < 0 || i_x < 0 || i_y >= v_h || i_x >= v_w )
 701         return VLC_SUCCESS;
 702
 703     if( mouse & MOUSE_CLICKED )
 704     {
 705         int i_scale_width, i_scale_height;
 706         osd_button_t *p_button = NULL;
 707
 708         i_scale_width = p_vout->fmt_out.i_visible_width * 1000 /
 709             p_vout->fmt_in.i_visible_width;
 710         i_scale_height = p_vout->fmt_out.i_visible_height * 1000 /
 711             p_vout->fmt_in.i_visible_height;
 712
 713         p_button = osd_ButtonFind( p_this, i_x, i_y, v_h, v_w,
 714                                    i_scale_width, i_scale_height );
 715         if( p_button )
 716         {
 717             osd_ButtonSelect( p_this, p_button );
 718             p_sys->b_update = p_sys->b_visible ? true : false;
 719             p_sys->b_clicked = true;
 720             msg_Dbg( p_this, "mouse clicked %s (%d,%d)\n", p_button->psz_name, i_x, i_y );
 721         }
 722     }
 723     return VLC_SUCCESS;
 724 }