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/vlc.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 int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
  84 static const char *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( _("On Screen Display menu") );
 135     set_shortname( _("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     var_DelCallback( p_sys->p_menu, "osd-menu-update",
 304                      OSDMenuUpdateEvent, p_filter );
 305     var_DelCallback( p_sys->p_menu, "osd-menu-visible",
 306                      OSDMenuVisibleEvent, p_filter );
 307
 308     if( p_sys->p_vout )
 309     {
 310         var_DelCallback( p_sys->p_vout, "mouse-x",
 311                         MouseEvent, p_sys );
 312         var_DelCallback( p_sys->p_vout, "mouse-y",
 313                         MouseEvent, p_sys );
 314         var_DelCallback( p_sys->p_vout, "mouse-clicked",
 315                         MouseEvent, p_sys );
 316
 317         vlc_object_release( p_sys->p_vout );
 318         p_sys->p_vout = NULL;
 319     }
 320
 321     var_Destroy( p_this, OSD_CFG "file-path" );
 322     var_Destroy( p_this, OSD_CFG "file" );
 323     var_Destroy( p_this, OSD_CFG "x" );
 324     var_Destroy( p_this, OSD_CFG "y" );
 325     var_Destroy( p_this, OSD_CFG "position" );
 326     var_Destroy( p_this, OSD_CFG "timeout" );
 327     var_Destroy( p_this, OSD_CFG "update" );
 328     var_Destroy( p_this, OSD_CFG "alpha" );
 329
 330     osd_MenuDelete( p_filter, p_sys->p_menu );
 331
 332     free( p_sys->psz_file );
 333     free( p_sys );
 334 }
 335
 336 /*****************************************************************************
 337  * OSDMenuEvent: callback for OSD Menu events
 338  *****************************************************************************/
 339 static int OSDMenuVisibleEvent( vlc_object_t *p_this, char const *psz_var,
 340                     vlc_value_t oldval, vlc_value_t newval, void *p_data )
 341 {
 342     VLC_UNUSED(p_this); VLC_UNUSED(psz_var); VLC_UNUSED(oldval);
 343     VLC_UNUSED(newval);
 344     filter_t *p_filter = (filter_t *) p_data;
 345
 346     p_filter->p_sys->b_visible = true;
 347     p_filter->p_sys->b_update = true;
 348     return VLC_SUCCESS;
 349 }
 350
 351 static int OSDMenuUpdateEvent( vlc_object_t *p_this, char const *psz_var,
 352                     vlc_value_t oldval, vlc_value_t newval, void *p_data )
 353 {
 354     VLC_UNUSED(p_this); VLC_UNUSED(psz_var); VLC_UNUSED(oldval);
 355     VLC_UNUSED(newval);
 356     filter_t *p_filter = (filter_t *) p_data;
 357     filter_sys_t *p_sys = p_filter->p_sys;
 358
 359     p_sys->b_update = p_sys->b_visible ? true : false;
 360     p_sys->i_end_date = (mtime_t) 0;
 361     return VLC_SUCCESS;
 362 }
 363
 364 #if 0
 365 /*****************************************************************************
 366  * create_text_region : compose a text region SPU
 367  *****************************************************************************/
 368 static subpicture_region_t *create_text_region( filter_t *p_filter, subpicture_t *p_spu,
 369     int i_width, int i_height, const char *psz_text )
 370 {
 371     subpicture_region_t *p_region;
 372     video_format_t       fmt;
 373
 374     /* Create new SPU region */
 375     memset( &fmt, 0, sizeof(video_format_t) );
 376     fmt.i_chroma = VLC_FOURCC( 'T','E','X','T' );
 377     fmt.i_aspect = VOUT_ASPECT_FACTOR;
 378     fmt.i_sar_num = fmt.i_sar_den = 1;
 379     fmt.i_width = fmt.i_visible_width = i_width;
 380     fmt.i_height = fmt.i_visible_height = i_height;
 381     fmt.i_x_offset = fmt.i_y_offset = 0;
 382     p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
 383     if( !p_region )
 384     {
 385         msg_Err( p_filter, "cannot allocate another SPU region" );
 386         return NULL;
 387     }
 388     p_region->psz_text = strdup( psz_text );
 389     p_region->i_x = 0;
 390     p_region->i_y = 40;
 391 #if 0
 392     msg_Dbg( p_filter, "SPU text region position (%d,%d) (%d,%d) [%s]",
 393         p_region->i_x, p_region->i_y,
 394         p_region->fmt.i_width, p_region->fmt.i_height, p_region->psz_text );
 395 #endif
 396     return p_region;
 397 }
 398 #endif
 399
 400 /*****************************************************************************
 401  * create_picture_region : compose a picture region SPU
 402  *****************************************************************************/
 403 static subpicture_region_t *create_picture_region( filter_t *p_filter, subpicture_t *p_spu,
 404     int i_width, int i_height, picture_t *p_pic )
 405 {
 406     subpicture_region_t *p_region = NULL;
 407     video_format_t       fmt;
 408
 409     if( !p_spu ) return NULL;
 410
 411     /* Create new SPU region */
 412     memset( &fmt, 0, sizeof(video_format_t) );
 413     fmt.i_chroma = (p_pic == NULL) ? VLC_FOURCC('Y','U','V','P') : VLC_FOURCC('Y','U','V','A');
 414     fmt.i_aspect = VOUT_ASPECT_FACTOR;
 415     fmt.i_sar_num = fmt.i_sar_den = 1;
 416     fmt.i_width = fmt.i_visible_width = i_width;
 417     fmt.i_height = fmt.i_visible_height = i_height;
 418     fmt.i_x_offset = fmt.i_y_offset = 0;
 419
 420     p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
 421     if( !p_region )
 422     {
 423         msg_Err( p_filter, "cannot allocate SPU region" );
 424         p_filter->pf_sub_buffer_del( p_filter, p_spu );
 425         return NULL;
 426     }
 427     if( !p_pic && ( fmt.i_chroma == VLC_FOURCC('Y','U','V','P') ) )
 428     {
 429         p_region->fmt.p_palette->i_entries = 0;
 430         p_region->fmt.i_width = p_region->fmt.i_visible_width = 0;
 431         p_region->fmt.i_height = p_region->fmt.i_visible_height = 0;
 432     }
 433     if( p_pic )
 434         vout_CopyPicture( p_filter, &p_region->picture, p_pic );
 435
 436     p_region->i_x = 0;
 437     p_region->i_y = 0;
 438     p_region->i_align = p_filter->p_sys->i_position;
 439     p_region->i_alpha = p_filter->p_sys->i_alpha;
 440 #if 0
 441     msg_Dbg( p_filter, "SPU picture region position (%d,%d) (%d,%d) [%p]",
 442         p_region->i_x, p_region->i_y,
 443         p_region->fmt.i_width, p_region->fmt.i_height, p_pic );
 444 #endif
 445     return p_region;
 446 }
 447
 448 /****************************************************************************
 449  * Filter: the whole thing
 450  ****************************************************************************
 451  * This function outputs subpictures at regular time intervals.
 452  ****************************************************************************/
 453 static subpicture_t *Filter( filter_t *p_filter, mtime_t i_date )
 454 {
 455     filter_sys_t *p_sys = p_filter->p_sys;
 456     subpicture_t *p_spu = NULL;
 457     subpicture_region_t *p_region = NULL;
 458
 459     if( !p_sys->b_update || (p_sys->i_update <= 0) )
 460             return NULL;
 461
 462     /* Am I too early?
 463     */
 464     if( ( ( p_sys->i_last_date + p_sys->i_update ) > i_date ) &&
 465         ( p_sys->i_end_date > 0 ) )
 466         return NULL; /* we are too early, so wait */
 467
 468     /* Allocate the subpicture internal data. */
 469     p_spu = p_filter->pf_sub_buffer_new( p_filter );
 470     if( !p_spu ) return NULL;
 471
 472     p_spu->b_ephemer = true;
 473     p_spu->b_fade = true;
 474     if( p_filter->p_sys->p_menu->i_style == OSD_MENU_STYLE_CONCAT )
 475         p_spu->b_absolute = true;
 476     else
 477         p_spu->b_absolute = p_sys->b_absolute;
 478     p_spu->i_flags = p_sys->i_position;
 479
 480     /* Determine the duration of the subpicture */
 481     if( p_sys->i_end_date > 0 )
 482     {
 483         /* Display the subpicture again. */
 484         p_spu->i_stop = p_sys->i_end_date - i_date;
 485         if( ( i_date + p_sys->i_update ) >= p_sys->i_end_date )
 486             p_sys->b_update = false;
 487     }
 488     else
 489     {
 490         /* There is a new OSD picture to display */
 491         p_spu->i_stop = i_date + p_sys->i_timeout;
 492         p_sys->i_end_date = p_spu->i_stop;
 493     }
 494
 495     p_sys->i_last_date = i_date;
 496     p_spu->i_start = p_sys->i_last_date = i_date;
 497
 498     /* Send an empty subpicture to clear the display
 499      * when OSD menu should be hidden and menu picture is not allocated.
 500      */
 501     if( !p_filter->p_sys->p_menu->p_state->p_pic ||
 502         ( p_filter->p_sys->b_visible == false ) )
 503     {
 504         /* Create new spu regions and allocate an empty picture in it. */
 505         p_region = create_picture_region( p_filter, p_spu,
 506             p_filter->p_sys->p_menu->p_state->i_width,
 507             p_filter->p_sys->p_menu->p_state->i_height,
 508             NULL );
 509
 510         /* proper positioning of OSD menu image */
 511         p_spu->i_x = p_filter->p_sys->p_menu->p_state->i_x;
 512         p_spu->i_y = p_filter->p_sys->p_menu->p_state->i_y;
 513         p_spu->p_region = p_region;
 514         p_spu->i_alpha = 0xFF; /* Picture is completely non transparent. */
 515         return p_spu;
 516     }
 517
 518     if( p_sys->p_vout && p_sys->b_clicked )
 519     {
 520         p_sys->b_clicked = false;
 521         osd_MenuActivate( p_filter );
 522     }
 523     /* Create new spu regions
 524     */
 525     p_region = create_picture_region( p_filter, p_spu,
 526         p_filter->p_sys->p_menu->p_state->i_width,
 527         p_filter->p_sys->p_menu->p_state->i_height,
 528         p_filter->p_sys->p_menu->p_state->p_pic );
 529
 530     if( !p_region )
 531     {
 532         p_filter->pf_sub_buffer_del( p_filter, p_spu );
 533         return NULL;
 534     }
 535
 536     p_spu->i_width = p_region->fmt.i_visible_width;
 537     p_spu->i_height = p_region->fmt.i_visible_height;
 538     p_spu->i_alpha = p_filter->p_sys->i_alpha;
 539
 540     /* proper positioning of OSD menu image */
 541     if( p_filter->p_sys->p_menu->i_style == OSD_MENU_STYLE_CONCAT )
 542     {
 543         p_spu->i_x = p_filter->p_sys->p_menu->p_button->i_x;
 544         p_spu->i_y = p_filter->p_sys->p_menu->p_button->i_y;
 545     }
 546     else
 547     {
 548         p_spu->i_x = p_filter->p_sys->p_menu->p_state->i_x;
 549         p_spu->i_y = p_filter->p_sys->p_menu->p_state->i_y;
 550     }
 551
 552     if( p_filter->p_sys->p_menu->i_style == OSD_MENU_STYLE_CONCAT )
 553     {
 554         subpicture_region_t *p_region_list = NULL;
 555         subpicture_region_t *p_region_tail = NULL;
 556         osd_menu_t *p_osd = p_filter->p_sys->p_menu;
 557         osd_button_t *p_button = p_osd->p_button;
 558
 559         /* Construct the entire OSD from individual images */
 560         while( p_button != NULL )
 561         {
 562             osd_button_t *p_tmp = NULL;
 563             subpicture_region_t *p_new = NULL;
 564
 565             p_new = create_picture_region( p_filter, p_spu,
 566                     p_button->p_current_state->p_pic->p[Y_PLANE].i_visible_pitch,
 567                     p_button->p_current_state->p_pic->p[Y_PLANE].i_visible_lines,
 568                     p_button->p_current_state->p_pic );
 569             if( !p_new )
 570             {
 571                 /* Cleanup when bailing out */
 572                 subpicture_region_t *p_tmp = NULL;
 573                 while( p_region_list )
 574                 {
 575                     p_tmp = p_region_list->p_next;
 576                     p_spu->pf_destroy_region( VLC_OBJECT(p_filter), p_region_list );
 577                 };
 578                 p_spu->pf_destroy_region( VLC_OBJECT(p_filter), p_region );
 579                 p_filter->pf_sub_buffer_del( p_filter, p_spu );
 580                 return NULL;
 581             }
 582
 583             p_spu->i_width += p_new->fmt.i_visible_width;
 584             p_spu->i_height += p_new->fmt.i_visible_height;
 585
 586             if( !p_region_list )
 587             {
 588                 p_region_list = p_new;
 589                 p_region_tail = p_new;
 590             }
 591             else
 592             {
 593                 p_new->i_x = p_region_tail->fmt.i_visible_width;
 594                 p_new->i_y = p_button->i_y;
 595                 p_region_tail->p_next = p_new;
 596                 p_region_tail = p_new;
 597             }
 598             p_tmp = p_button->p_next;
 599             p_button = p_tmp;
 600         };
 601         p_region->p_next = p_region_list;
 602     }
 603 #if 0
 604     p_region->p_next = create_text_region( p_filter, p_spu,
 605         p_filter->p_sys->p_menu->p_state->i_width, p_filter->p_sys->p_menu->p_state->i_height,
 606         p_filter->p_sys->p_menu->p_state->p_visible->psz_action );
 607 #endif
 608     p_spu->p_region = p_region;
 609     return p_spu;
 610 }
 611
 612 static int OSDMenuCallback( vlc_object_t *p_this, char const *psz_var,
 613                             vlc_value_t oldval, vlc_value_t newval,
 614                             void *p_data )
 615 {
 616     VLC_UNUSED(p_this); VLC_UNUSED(oldval);
 617     filter_sys_t *p_sys = (filter_sys_t *) p_data;
 618
 619     if( !p_sys )
 620         return VLC_SUCCESS;
 621
 622     if( !strncmp( psz_var, OSD_CFG"position", 16) )
 623     {
 624 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
 625         unsigned int i;
 626         for( i=0; i < ARRAY_SIZE(pi_pos_values); i++ )
 627         {
 628             if( newval.i_int == pi_pos_values[i] )
 629             {
 630                 p_sys->i_position = newval.i_int % 11;
 631                 break;
 632             }
 633         }
 634 #undef ARRAY_SIZE
 635     }
 636     else if( !strncmp( psz_var, OSD_CFG"x", 9) ||
 637              !strncmp( psz_var, OSD_CFG"y", 9))
 638     {
 639         p_sys->b_absolute = true;
 640         if( (p_sys->i_x < 0) || (p_sys->i_y < 0) )
 641         {
 642             p_sys->b_absolute = false;
 643             p_sys->p_menu->i_x = 0;
 644             p_sys->p_menu->i_y = 0;
 645         }
 646         else if( (p_sys->i_x >= 0) || (p_sys->i_y >= 0) )
 647         {
 648             p_sys->p_menu->i_x = p_sys->i_x;
 649             p_sys->p_menu->i_y = p_sys->i_y;
 650         }
 651     }
 652     else if( !strncmp( psz_var, OSD_CFG"update", 14) )
 653         p_sys->i_update =  (mtime_t)(newval.i_int * 1000);
 654     else if( !strncmp( psz_var, OSD_CFG"timeout", 15) )
 655         p_sys->i_update = newval.i_int % 1000;
 656     else if( !strncmp( psz_var, OSD_CFG"alpha", 13) )
 657         p_sys->i_alpha = newval.i_int % 256;
 658
 659     p_sys->b_update = p_sys->b_visible ? true : false;
 660     return VLC_SUCCESS;
 661 }
 662
 663 /*****************************************************************************
 664  * MouseEvent: callback for mouse events
 665  *****************************************************************************/
 666 static int MouseEvent( vlc_object_t *p_this, char const *psz_var,
 667                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
 668 {
 669     VLC_UNUSED(oldval); VLC_UNUSED(newval);
 670     filter_sys_t *p_sys = (filter_sys_t *)p_data;
 671     vout_thread_t *p_vout = (vout_thread_t*)p_sys->p_vout;
 672     int i_x, i_y;
 673     int i_v;
 674
 675 #define MOUSE_DOWN    1
 676 #define MOUSE_CLICKED 2
 677 #define MOUSE_MOVE_X  4
 678 #define MOUSE_MOVE_Y  8
 679 #define MOUSE_MOVE    12
 680     uint8_t mouse= 0;
 681
 682     int v_h = p_vout->output.i_height;
 683     int v_w = p_vout->output.i_width;
 684
 685     if( psz_var[6] == 'x' ) mouse |= MOUSE_MOVE_X;
 686     if( psz_var[6] == 'y' ) mouse |= MOUSE_MOVE_Y;
 687     if( psz_var[6] == 'c' ) mouse |= MOUSE_CLICKED;
 688
 689     i_v = var_GetInteger( p_sys->p_vout, "mouse-button-down" );
 690     if( i_v & 0x1 ) mouse |= MOUSE_DOWN;
 691     i_y = var_GetInteger( p_sys->p_vout, "mouse-y" );
 692     i_x = var_GetInteger( p_sys->p_vout, "mouse-x" );
 693
 694     if( i_y < 0 || i_x < 0 || i_y >= v_h || i_x >= v_w )
 695         return VLC_SUCCESS;
 696
 697     if( mouse & MOUSE_CLICKED )
 698     {
 699         int i_scale_width, i_scale_height;
 700         osd_button_t *p_button = NULL;
 701
 702         i_scale_width = p_vout->fmt_out.i_visible_width * 1000 /
 703             p_vout->fmt_in.i_visible_width;
 704         i_scale_height = p_vout->fmt_out.i_visible_height * 1000 /
 705             p_vout->fmt_in.i_visible_height;
 706
 707         p_button = osd_ButtonFind( p_this, i_x, i_y, v_h, v_w,
 708                                    i_scale_width, i_scale_height );
 709         if( p_button )
 710         {
 711             osd_ButtonSelect( p_this, p_button );
 712             p_sys->b_update = p_sys->b_visible ? true : false;
 713             p_sys->b_clicked = true;
 714             msg_Dbg( p_this, "mouse clicked %s (%d,%d)\n", p_button->psz_name, i_x, i_y );
 715         }
 716     }
 717     return VLC_SUCCESS;
 718 }