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         return VLC_ENOMEM;
 188     memset( p_sys, 0, sizeof(filter_sys_t) );
 189
 190     /* Populating struct */
 191     p_sys->psz_path = var_CreateGetString( p_this, OSD_CFG "file-path" );
 192     p_sys->psz_file = var_CreateGetString( p_this, OSD_CFG "file" );
 193     if( (p_sys->psz_file == NULL) ||
 194         (*p_sys->psz_file == '\0') )
 195     {
 196         msg_Err( p_filter, "unable to get filename" );
 197         goto error;
 198     }
 199
 200     p_sys->i_x = var_CreateGetIntegerCommand( p_this, OSD_CFG "x" );
 201     p_sys->i_y = var_CreateGetIntegerCommand( p_this, OSD_CFG "y" );
 202     p_sys->i_position = var_CreateGetIntegerCommand( p_this, OSD_CFG "position" );
 203     p_sys->i_alpha = var_CreateGetIntegerCommand( p_this, OSD_CFG "alpha" );
 204
 205     /* in micro seconds - divide by 2 to match user expectations */
 206     p_sys->i_timeout = var_CreateGetIntegerCommand( p_this, OSD_CFG "timeout" );
 207     p_sys->i_timeout = (mtime_t)(p_sys->i_timeout * 1000000) >> 2;
 208     p_sys->i_update  = var_CreateGetIntegerCommand( p_this, OSD_CFG "update" );
 209     p_sys->i_update = (mtime_t)(p_sys->i_update * 1000); /* in micro seconds */
 210
 211     var_AddCallback( p_filter, OSD_CFG "position", OSDMenuCallback, p_sys );
 212     var_AddCallback( p_filter, OSD_CFG "timeout", OSDMenuCallback, p_sys );
 213     var_AddCallback( p_filter, OSD_CFG "update", OSDMenuCallback, p_sys );
 214     var_AddCallback( p_filter, OSD_CFG "alpha", OSDMenuCallback, p_sys );
 215
 216     /* Load the osd menu subsystem */
 217     p_sys->p_menu = osd_MenuCreate( p_this, p_sys->psz_file );
 218     if( p_sys->p_menu == NULL )
 219         goto error;
 220
 221     p_sys->p_menu->i_position = p_sys->i_position;
 222
 223     /* Check if menu position was overridden */
 224     p_sys->b_absolute = true;
 225     if( (p_sys->i_x < 0) || (p_sys->i_y < 0) )
 226     {
 227         p_sys->b_absolute = false;
 228         p_sys->p_menu->i_x = 0;
 229         p_sys->p_menu->i_y = 0;
 230     }
 231     else if( (p_sys->i_x >= 0) || (p_sys->i_y >= 0) )
 232     {
 233         p_sys->p_menu->i_x = p_sys->i_x;
 234         p_sys->p_menu->i_y = p_sys->i_y;
 235     }
 236     else if( (p_sys->p_menu->i_x < 0) ||
 237              (p_sys->p_menu->i_y < 0) )
 238     {
 239         p_sys->b_absolute = false;
 240         p_sys->p_menu->i_x = 0;
 241         p_sys->p_menu->i_y = 0;
 242     }
 243
 244     /* Set up p_filter */
 245     p_sys->i_last_date = mdate();
 246
 247     /* Keep track of OSD Events */
 248     p_sys->b_update  = false;
 249     p_sys->b_visible = false;
 250     p_sys->b_clicked = false;
 251
 252     /* Listen to osd menu core updates/visible settings. */
 253     var_AddCallback( p_sys->p_menu, "osd-menu-update",
 254                      OSDMenuUpdateEvent, p_filter );
 255     var_AddCallback( p_sys->p_menu, "osd-menu-visible",
 256                      OSDMenuVisibleEvent, p_filter );
 257
 258     /* Attach subpicture filter callback */
 259     p_filter->pf_sub_filter = Filter;
 260
 261     p_sys->p_vout = vlc_object_find( p_this, VLC_OBJECT_VOUT, FIND_ANYWHERE );
 262     if( p_sys->p_vout )
 263     {
 264         var_AddCallback( p_sys->p_vout, "mouse-x",
 265                         MouseEvent, p_sys );
 266         var_AddCallback( p_sys->p_vout, "mouse-y",
 267                         MouseEvent, p_sys );
 268         var_AddCallback( p_sys->p_vout, "mouse-clicked",
 269                         MouseEvent, p_sys );
 270     }
 271
 272     es_format_Init( &p_filter->fmt_out, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
 273     p_filter->fmt_out.i_priority = 0;
 274
 275     return VLC_SUCCESS;
 276
 277 error:
 278     msg_Err( p_filter, "osdmenu filter discarded" );
 279
 280     osd_MenuDelete( p_this, p_sys->p_menu );
 281     p_sys->p_menu = NULL;
 282     free( p_sys->psz_file );
 283     free( p_sys );
 284     return VLC_EGENERIC;
 285 }
 286
 287 /*****************************************************************************
 288  * DestroyFilter: Make a clean exit of this plugin
 289  *****************************************************************************/
 290 static void DestroyFilter( vlc_object_t *p_this )
 291 {
 292     filter_t     *p_filter = (filter_t*)p_this;
 293     filter_sys_t *p_sys = p_filter->p_sys;
 294
 295     var_DelCallback( p_filter, OSD_CFG "position", OSDMenuCallback, p_sys );
 296     var_DelCallback( p_filter, OSD_CFG "timeout", OSDMenuCallback, p_sys );
 297     var_DelCallback( p_filter, OSD_CFG "update", OSDMenuCallback, p_sys );
 298     var_DelCallback( p_filter, OSD_CFG "alpha", OSDMenuCallback, p_sys );
 299
 300     if( p_sys )
 301     {
 302         var_DelCallback( p_sys->p_menu, "osd-menu-update",
 303                          OSDMenuUpdateEvent, p_filter );
 304         var_DelCallback( p_sys->p_menu, "osd-menu-visible",
 305                          OSDMenuVisibleEvent, p_filter );
 306     }
 307
 308     if( p_sys && 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     if( p_sys )
 331     {
 332         osd_MenuDelete( p_filter, p_sys->p_menu );
 333
 334         free( p_sys->psz_file );
 335         free( p_sys );
 336     }
 337 }
 338
 339 /*****************************************************************************
 340  * OSDMenuEvent: callback for OSD Menu events
 341  *****************************************************************************/
 342 static int OSDMenuVisibleEvent( vlc_object_t *p_this, char const *psz_var,
 343                     vlc_value_t oldval, vlc_value_t newval, void *p_data )
 344 {
 345     VLC_UNUSED(p_this); VLC_UNUSED(psz_var); VLC_UNUSED(oldval);
 346     VLC_UNUSED(newval);
 347     filter_t *p_filter = (filter_t *) p_data;
 348
 349     p_filter->p_sys->b_visible = true;
 350     p_filter->p_sys->b_update = true;
 351     return VLC_SUCCESS;
 352 }
 353
 354 static int OSDMenuUpdateEvent( vlc_object_t *p_this, char const *psz_var,
 355                     vlc_value_t oldval, vlc_value_t newval, void *p_data )
 356 {
 357     VLC_UNUSED(p_this); VLC_UNUSED(psz_var); VLC_UNUSED(oldval);
 358     VLC_UNUSED(newval);
 359     filter_t *p_filter = (filter_t *) p_data;
 360     filter_sys_t *p_sys = p_filter->p_sys;
 361
 362     p_sys->b_update = p_sys->b_visible ? true : false;
 363     p_sys->i_end_date = (mtime_t) 0;
 364     return VLC_SUCCESS;
 365 }
 366
 367 #if 0
 368 /*****************************************************************************
 369  * create_text_region : compose a text region SPU
 370  *****************************************************************************/
 371 static subpicture_region_t *create_text_region( filter_t *p_filter, subpicture_t *p_spu,
 372     int i_width, int i_height, const char *psz_text )
 373 {
 374     subpicture_region_t *p_region;
 375     video_format_t       fmt;
 376
 377     /* Create new SPU region */
 378     memset( &fmt, 0, sizeof(video_format_t) );
 379     fmt.i_chroma = VLC_FOURCC( 'T','E','X','T' );
 380     fmt.i_aspect = VOUT_ASPECT_FACTOR;
 381     fmt.i_sar_num = fmt.i_sar_den = 1;
 382     fmt.i_width = fmt.i_visible_width = i_width;
 383     fmt.i_height = fmt.i_visible_height = i_height;
 384     fmt.i_x_offset = fmt.i_y_offset = 0;
 385     p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
 386     if( !p_region )
 387     {
 388         msg_Err( p_filter, "cannot allocate another SPU region" );
 389         return NULL;
 390     }
 391     p_region->psz_text = strdup( psz_text );
 392     p_region->i_x = 0;
 393     p_region->i_y = 40;
 394 #if 0
 395     msg_Dbg( p_filter, "SPU text region position (%d,%d) (%d,%d) [%s]",
 396         p_region->i_x, p_region->i_y,
 397         p_region->fmt.i_width, p_region->fmt.i_height, p_region->psz_text );
 398 #endif
 399     return p_region;
 400 }
 401 #endif
 402
 403 /*****************************************************************************
 404  * create_picture_region : compose a picture region SPU
 405  *****************************************************************************/
 406 static subpicture_region_t *create_picture_region( filter_t *p_filter, subpicture_t *p_spu,
 407     int i_width, int i_height, picture_t *p_pic )
 408 {
 409     subpicture_region_t *p_region = NULL;
 410     video_format_t       fmt;
 411
 412     if( !p_spu ) return NULL;
 413
 414     /* Create new SPU region */
 415     memset( &fmt, 0, sizeof(video_format_t) );
 416     fmt.i_chroma = (p_pic == NULL) ? VLC_FOURCC('Y','U','V','P') : VLC_FOURCC('Y','U','V','A');
 417     fmt.i_aspect = VOUT_ASPECT_FACTOR;
 418     fmt.i_sar_num = fmt.i_sar_den = 1;
 419     fmt.i_width = fmt.i_visible_width = i_width;
 420     fmt.i_height = fmt.i_visible_height = i_height;
 421     fmt.i_x_offset = fmt.i_y_offset = 0;
 422
 423     p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
 424     if( !p_region )
 425     {
 426         msg_Err( p_filter, "cannot allocate SPU region" );
 427         p_filter->pf_sub_buffer_del( p_filter, p_spu );
 428         return NULL;
 429     }
 430     if( !p_pic && ( fmt.i_chroma == VLC_FOURCC('Y','U','V','P') ) )
 431     {
 432         p_region->fmt.p_palette->i_entries = 0;
 433         p_region->fmt.i_width = p_region->fmt.i_visible_width = 0;
 434         p_region->fmt.i_height = p_region->fmt.i_visible_height = 0;
 435     }
 436     if( p_pic )
 437         vout_CopyPicture( p_filter, &p_region->picture, p_pic );
 438
 439     p_region->i_x = 0;
 440     p_region->i_y = 0;
 441     p_region->i_align = p_filter->p_sys->i_position;
 442     p_region->i_alpha = p_filter->p_sys->i_alpha;
 443 #if 0
 444     msg_Dbg( p_filter, "SPU picture region position (%d,%d) (%d,%d) [%p]",
 445         p_region->i_x, p_region->i_y,
 446         p_region->fmt.i_width, p_region->fmt.i_height, p_pic );
 447 #endif
 448     return p_region;
 449 }
 450
 451 /****************************************************************************
 452  * Filter: the whole thing
 453  ****************************************************************************
 454  * This function outputs subpictures at regular time intervals.
 455  ****************************************************************************/
 456 static subpicture_t *Filter( filter_t *p_filter, mtime_t i_date )
 457 {
 458     filter_sys_t *p_sys = p_filter->p_sys;
 459     subpicture_t *p_spu = NULL;
 460     subpicture_region_t *p_region = NULL;
 461
 462     if( !p_sys->b_update || (p_sys->i_update <= 0) )
 463             return NULL;
 464
 465     /* Am I too early?
 466     */
 467     if( ( ( p_sys->i_last_date + p_sys->i_update ) > i_date ) &&
 468         ( p_sys->i_end_date > 0 ) )
 469         return NULL; /* we are too early, so wait */
 470
 471     /* Allocate the subpicture internal data. */
 472     p_spu = p_filter->pf_sub_buffer_new( p_filter );
 473     if( !p_spu ) return NULL;
 474
 475     p_spu->b_ephemer = true;
 476     p_spu->b_fade = true;
 477     if( p_filter->p_sys->p_menu->i_style == OSD_MENU_STYLE_CONCAT )
 478         p_spu->b_absolute = true;
 479     else
 480         p_spu->b_absolute = p_sys->b_absolute;
 481     p_spu->i_flags = p_sys->i_position;
 482
 483     /* Determine the duration of the subpicture */
 484     if( p_sys->i_end_date > 0 )
 485     {
 486         /* Display the subpicture again. */
 487         p_spu->i_stop = p_sys->i_end_date - i_date;
 488         if( ( i_date + p_sys->i_update ) >= p_sys->i_end_date )
 489             p_sys->b_update = false;
 490     }
 491     else
 492     {
 493         /* There is a new OSD picture to display */
 494         p_spu->i_stop = i_date + p_sys->i_timeout;
 495         p_sys->i_end_date = p_spu->i_stop;
 496     }
 497
 498     p_sys->i_last_date = i_date;
 499     p_spu->i_start = p_sys->i_last_date = i_date;
 500
 501     /* Send an empty subpicture to clear the display
 502      * when OSD menu should be hidden and menu picture is not allocated.
 503      */
 504     if( !p_filter->p_sys->p_menu->p_state->p_pic ||
 505         ( p_filter->p_sys->b_visible == false ) )
 506     {
 507         /* Create new spu regions and allocate an empty picture in it. */
 508         p_region = create_picture_region( p_filter, p_spu,
 509             p_filter->p_sys->p_menu->p_state->i_width,
 510             p_filter->p_sys->p_menu->p_state->i_height,
 511             NULL );
 512
 513         /* proper positioning of OSD menu image */
 514         p_spu->i_x = p_filter->p_sys->p_menu->p_state->i_x;
 515         p_spu->i_y = p_filter->p_sys->p_menu->p_state->i_y;
 516         p_spu->p_region = p_region;
 517         p_spu->i_alpha = 0xFF; /* Picture is completely non transparent. */
 518         return p_spu;
 519     }
 520
 521     if( p_sys->p_vout && p_sys->b_clicked )
 522     {
 523         p_sys->b_clicked = false;
 524         osd_MenuActivate( p_filter );
 525     }
 526     /* Create new spu regions
 527     */
 528     p_region = create_picture_region( p_filter, p_spu,
 529         p_filter->p_sys->p_menu->p_state->i_width,
 530         p_filter->p_sys->p_menu->p_state->i_height,
 531         p_filter->p_sys->p_menu->p_state->p_pic );
 532
 533     if( !p_region )
 534     {
 535         p_filter->pf_sub_buffer_del( p_filter, p_spu );
 536         return NULL;
 537     }
 538
 539     p_spu->i_width = p_region->fmt.i_visible_width;
 540     p_spu->i_height = p_region->fmt.i_visible_height;
 541     p_spu->i_alpha = p_filter->p_sys->i_alpha;
 542
 543     /* proper positioning of OSD menu image */
 544     if( p_filter->p_sys->p_menu->i_style == OSD_MENU_STYLE_CONCAT )
 545     {
 546         p_spu->i_x = p_filter->p_sys->p_menu->p_button->i_x;
 547         p_spu->i_y = p_filter->p_sys->p_menu->p_button->i_y;
 548     }
 549     else
 550     {
 551         p_spu->i_x = p_filter->p_sys->p_menu->p_state->i_x;
 552         p_spu->i_y = p_filter->p_sys->p_menu->p_state->i_y;
 553     }
 554
 555     if( p_filter->p_sys->p_menu->i_style == OSD_MENU_STYLE_CONCAT )
 556     {
 557         subpicture_region_t *p_region_list = NULL;
 558         subpicture_region_t *p_region_tail = NULL;
 559         osd_menu_t *p_osd = p_filter->p_sys->p_menu;
 560         osd_button_t *p_button = p_osd->p_button;
 561
 562         /* Construct the entire OSD from individual images */
 563         while( p_button != NULL )
 564         {
 565             osd_button_t *p_tmp = NULL;
 566             subpicture_region_t *p_new = NULL;
 567
 568             p_new = create_picture_region( p_filter, p_spu,
 569                     p_button->p_current_state->p_pic->p[Y_PLANE].i_visible_pitch,
 570                     p_button->p_current_state->p_pic->p[Y_PLANE].i_visible_lines,
 571                     p_button->p_current_state->p_pic );
 572             if( !p_new )
 573             {
 574                 /* Cleanup when bailing out */
 575                 subpicture_region_t *p_tmp = NULL;
 576                 while( p_region_list )
 577                 {
 578                     p_tmp = p_region_list->p_next;
 579                     p_spu->pf_destroy_region( VLC_OBJECT(p_filter), p_region_list );
 580                 };
 581                 p_spu->pf_destroy_region( VLC_OBJECT(p_filter), p_region );
 582                 p_filter->pf_sub_buffer_del( p_filter, p_spu );
 583                 return NULL;
 584             }
 585
 586             p_spu->i_width += p_new->fmt.i_visible_width;
 587             p_spu->i_height += p_new->fmt.i_visible_height;
 588
 589             if( !p_region_list )
 590             {
 591                 p_region_list = p_new;
 592                 p_region_tail = p_new;
 593             }
 594             else
 595             {
 596                 p_new->i_x = p_region_tail->fmt.i_visible_width;
 597                 p_new->i_y = p_button->i_y;
 598                 p_region_tail->p_next = p_new;
 599                 p_region_tail = p_new;
 600             }
 601             p_tmp = p_button->p_next;
 602             p_button = p_tmp;
 603         };
 604         p_region->p_next = p_region_list;
 605     }
 606 #if 0
 607     p_region->p_next = create_text_region( p_filter, p_spu,
 608         p_filter->p_sys->p_menu->p_state->i_width, p_filter->p_sys->p_menu->p_state->i_height,
 609         p_filter->p_sys->p_menu->p_state->p_visible->psz_action );
 610 #endif
 611     p_spu->p_region = p_region;
 612     return p_spu;
 613 }
 614
 615 static int OSDMenuCallback( vlc_object_t *p_this, char const *psz_var,
 616                             vlc_value_t oldval, vlc_value_t newval,
 617                             void *p_data )
 618 {
 619     VLC_UNUSED(p_this); VLC_UNUSED(oldval);
 620     filter_sys_t *p_sys = (filter_sys_t *) p_data;
 621
 622     if( !p_sys )
 623         return VLC_SUCCESS;
 624
 625     if( !strncmp( psz_var, OSD_CFG"position", 16) )
 626     {
 627 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
 628         unsigned int i;
 629         for( i=0; i < ARRAY_SIZE(pi_pos_values); i++ )
 630         {
 631             if( newval.i_int == pi_pos_values[i] )
 632             {
 633                 p_sys->i_position = newval.i_int % 11;
 634                 break;
 635             }
 636         }
 637 #undef ARRAY_SIZE
 638     }
 639     else if( !strncmp( psz_var, OSD_CFG"x", 9) ||
 640              !strncmp( psz_var, OSD_CFG"y", 9))
 641     {
 642         p_sys->b_absolute = true;
 643         if( (p_sys->i_x < 0) || (p_sys->i_y < 0) )
 644         {
 645             p_sys->b_absolute = false;
 646             p_sys->p_menu->i_x = 0;
 647             p_sys->p_menu->i_y = 0;
 648         }
 649         else if( (p_sys->i_x >= 0) || (p_sys->i_y >= 0) )
 650         {
 651             p_sys->p_menu->i_x = p_sys->i_x;
 652             p_sys->p_menu->i_y = p_sys->i_y;
 653         }
 654     }
 655     else if( !strncmp( psz_var, OSD_CFG"update", 14) )
 656         p_sys->i_update =  (mtime_t)(newval.i_int * 1000);
 657     else if( !strncmp( psz_var, OSD_CFG"timeout", 15) )
 658         p_sys->i_update = newval.i_int % 1000;
 659     else if( !strncmp( psz_var, OSD_CFG"alpha", 13) )
 660         p_sys->i_alpha = newval.i_int % 256;
 661
 662     p_sys->b_update = p_sys->b_visible ? true : false;
 663     return VLC_SUCCESS;
 664 }
 665
 666 /*****************************************************************************
 667  * MouseEvent: callback for mouse events
 668  *****************************************************************************/
 669 static int MouseEvent( vlc_object_t *p_this, char const *psz_var,
 670                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
 671 {
 672     VLC_UNUSED(oldval); VLC_UNUSED(newval);
 673     filter_sys_t *p_sys = (filter_sys_t *)p_data;
 674     vout_thread_t *p_vout = (vout_thread_t*)p_sys->p_vout;
 675     int i_x, i_y;
 676     int i_v;
 677
 678 #define MOUSE_DOWN    1
 679 #define MOUSE_CLICKED 2
 680 #define MOUSE_MOVE_X  4
 681 #define MOUSE_MOVE_Y  8
 682 #define MOUSE_MOVE    12
 683     uint8_t mouse= 0;
 684
 685     int v_h = p_vout->output.i_height;
 686     int v_w = p_vout->output.i_width;
 687
 688     if( psz_var[6] == 'x' ) mouse |= MOUSE_MOVE_X;
 689     if( psz_var[6] == 'y' ) mouse |= MOUSE_MOVE_Y;
 690     if( psz_var[6] == 'c' ) mouse |= MOUSE_CLICKED;
 691
 692     i_v = var_GetInteger( p_sys->p_vout, "mouse-button-down" );
 693     if( i_v & 0x1 ) mouse |= MOUSE_DOWN;
 694     i_y = var_GetInteger( p_sys->p_vout, "mouse-y" );
 695     i_x = var_GetInteger( p_sys->p_vout, "mouse-x" );
 696
 697     if( i_y < 0 || i_x < 0 || i_y >= v_h || i_x >= v_w )
 698         return VLC_SUCCESS;
 699
 700     if( mouse & MOUSE_CLICKED )
 701     {
 702         int i_scale_width, i_scale_height;
 703         osd_button_t *p_button = NULL;
 704
 705         i_scale_width = p_vout->fmt_out.i_visible_width * 1000 /
 706             p_vout->fmt_in.i_visible_width;
 707         i_scale_height = p_vout->fmt_out.i_visible_height * 1000 /
 708             p_vout->fmt_in.i_visible_height;
 709
 710         p_button = osd_ButtonFind( p_this, i_x, i_y, v_h, v_w,
 711                                    i_scale_width, i_scale_height );
 712         if( p_button )
 713         {
 714             osd_ButtonSelect( p_this, p_button );
 715             p_sys->b_update = p_sys->b_visible ? true : false;
 716             p_sys->b_clicked = true;
 717             msg_Dbg( p_this, "mouse clicked %s (%d,%d)\n", p_button->psz_name, i_x, i_y );
 718         }
 719     }
 720     return VLC_SUCCESS;
 721 }