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     set_capability( "sub filter", 100 )
 117     set_description( N_("On Screen Display menu") )
 118     set_shortname( N_("OSD menu") )
 119     add_shortcut( "osdmenu" )
 120
 121     set_category( CAT_VIDEO )
 122     set_subcategory( SUBCAT_VIDEO_SUBPIC )
 123
 124     set_callbacks( CreateFilter, DestroyFilter )
 125
 126     add_integer( OSD_CFG "x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, false )
 127     add_integer( OSD_CFG "y", -1, NULL, POSY_TEXT, POSY_LONGTEXT, false )
 128     add_integer( OSD_CFG "position", 8, NULL, POS_TEXT, POS_LONGTEXT,
 129                  false )
 130         change_integer_list( pi_pos_values, ppsz_pos_descriptions, NULL )
 131     add_string( OSD_CFG "file", OSD_DEFAULT_CFG, NULL, OSD_FILE_TEXT,
 132         OSD_FILE_LONGTEXT, false )
 133     add_string( OSD_CFG "file-path", NULL, NULL, OSD_PATH_TEXT,
 134         OSD_PATH_LONGTEXT, false )
 135     add_integer( OSD_CFG "timeout", 15, NULL, TIMEOUT_TEXT,
 136         TIMEOUT_LONGTEXT, false )
 137     add_integer_with_range( OSD_CFG "update", OSD_UPDATE_DEFAULT,
 138         OSD_UPDATE_MIN, OSD_UPDATE_MAX, NULL, OSD_UPDATE_TEXT,
 139         OSD_UPDATE_LONGTEXT, true )
 140     add_integer_with_range( OSD_CFG "alpha", 255, 0, 255, NULL,
 141         OSD_ALPHA_TEXT, OSD_ALPHA_LONGTEXT, true )
 142
 143 vlc_module_end ()
 144
 145 /*****************************************************************************
 146  * Sub filter code
 147  *****************************************************************************/
 148
 149 /*****************************************************************************
 150  * Local prototypes
 151  *****************************************************************************/
 152 struct filter_sys_t
 153 {
 154     int          i_position;    /* relative positioning of SPU images */
 155     int          i_x;           /* absolute positioning of SPU images */
 156     int          i_y;           /* absolute positioning of SPU images */
 157     mtime_t      i_last_date;   /* last mdate SPU object has been sent to SPU subsytem */
 158     mtime_t      i_timeout;     /* duration SPU object is valid on the video output in seconds */
 159
 160     bool   b_absolute;    /* do we use absolute positioning or relative? */
 161     bool   b_update;      /* Update OSD Menu by sending SPU objects */
 162     bool   b_visible;     /* OSD Menu is visible */
 163     mtime_t      i_update;      /* Update the OSD menu every n ms */
 164     mtime_t      i_end_date;    /* End data of display OSD menu */
 165     int          i_alpha;       /* alpha transparency value */
 166
 167     char        *psz_file;      /* OSD Menu configuration file */
 168     char        *psz_path;      /* Path to OSD Menu pictures */
 169     osd_menu_t  *p_menu;        /* pointer to OSD Menu object */
 170
 171     /* menu interaction */
 172     vout_thread_t *p_vout;
 173     bool  b_clicked;
 174     uint32_t    i_mouse_x;
 175     uint32_t    i_mouse_y;
 176 };
 177
 178 /*****************************************************************************
 179  * CreateFilter: Create the filter and open the definition file
 180  *****************************************************************************/
 181 static int CreateFilter ( vlc_object_t *p_this )
 182 {
 183     filter_t *p_filter = (filter_t *)p_this;
 184     filter_sys_t *p_sys = NULL;
 185
 186     p_filter->p_sys = p_sys = (filter_sys_t *) malloc( sizeof(filter_sys_t) );
 187     if( !p_filter->p_sys )
 188         return VLC_ENOMEM;
 189     memset( p_sys, 0, sizeof(filter_sys_t) );
 190
 191     /* Populating struct */
 192     p_sys->psz_path = var_CreateGetString( p_this, OSD_CFG "file-path" );
 193     p_sys->psz_file = var_CreateGetString( p_this, OSD_CFG "file" );
 194     if( (p_sys->psz_file == NULL) ||
 195         (*p_sys->psz_file == '\0') )
 196     {
 197         msg_Err( p_filter, "unable to get filename" );
 198         goto error;
 199     }
 200
 201     p_sys->i_x = var_CreateGetIntegerCommand( p_this, OSD_CFG "x" );
 202     p_sys->i_y = var_CreateGetIntegerCommand( p_this, OSD_CFG "y" );
 203     p_sys->i_position = var_CreateGetIntegerCommand( p_this, OSD_CFG "position" );
 204     p_sys->i_alpha = var_CreateGetIntegerCommand( p_this, OSD_CFG "alpha" );
 205
 206     /* in micro seconds - divide by 2 to match user expectations */
 207     p_sys->i_timeout = var_CreateGetIntegerCommand( p_this, OSD_CFG "timeout" );
 208     p_sys->i_timeout = (mtime_t)(p_sys->i_timeout * 1000000) >> 2;
 209     p_sys->i_update  = var_CreateGetIntegerCommand( p_this, OSD_CFG "update" );
 210     p_sys->i_update = (mtime_t)(p_sys->i_update * 1000); /* in micro seconds */
 211
 212     var_AddCallback( p_filter, OSD_CFG "position", OSDMenuCallback, p_sys );
 213     var_AddCallback( p_filter, OSD_CFG "timeout", OSDMenuCallback, p_sys );
 214     var_AddCallback( p_filter, OSD_CFG "update", OSDMenuCallback, p_sys );
 215     var_AddCallback( p_filter, OSD_CFG "alpha", OSDMenuCallback, p_sys );
 216
 217     /* Load the osd menu subsystem */
 218     p_sys->p_menu = osd_MenuCreate( p_this, p_sys->psz_file );
 219     if( p_sys->p_menu == NULL )
 220         goto error;
 221
 222     /* FIXME: this plugin is not at all thread-safe w.r.t. callbacks */
 223     p_sys->p_menu->i_position = p_sys->i_position;
 224
 225     /* Check if menu position was overridden */
 226     p_sys->b_absolute = true;
 227     if( (p_sys->i_x < 0) || (p_sys->i_y < 0) )
 228     {
 229         p_sys->b_absolute = false;
 230         p_sys->p_menu->i_x = 0;
 231         p_sys->p_menu->i_y = 0;
 232     }
 233     else
 234     {
 235         p_sys->p_menu->i_x = p_sys->i_x;
 236         p_sys->p_menu->i_y = p_sys->i_y;
 237     }
 238
 239     /* Set up p_filter */
 240     p_sys->i_last_date = mdate();
 241
 242     /* Keep track of OSD Events */
 243     p_sys->b_update  = false;
 244     p_sys->b_visible = false;
 245     p_sys->b_clicked = false;
 246
 247     /* Listen to osd menu core updates/visible settings. */
 248     var_AddCallback( p_sys->p_menu, "osd-menu-update",
 249                      OSDMenuUpdateEvent, p_filter );
 250     var_AddCallback( p_sys->p_menu, "osd-menu-visible",
 251                      OSDMenuVisibleEvent, p_filter );
 252
 253     /* Attach subpicture filter callback */
 254     p_filter->pf_sub_filter = Filter;
 255
 256     p_sys->p_vout = vlc_object_find( p_this, VLC_OBJECT_VOUT, FIND_PARENT );
 257     if( p_sys->p_vout )
 258         var_AddCallback( p_sys->p_vout, "mouse-clicked",
 259                         MouseEvent, p_sys );
 260
 261     es_format_Init( &p_filter->fmt_out, SPU_ES, VLC_CODEC_SPU );
 262     p_filter->fmt_out.i_priority = 0;
 263
 264     return VLC_SUCCESS;
 265
 266 error:
 267     msg_Err( p_filter, "osdmenu filter discarded" );
 268
 269     free( p_sys->psz_path );
 270     free( p_sys->psz_file );
 271     free( p_sys );
 272     return VLC_EGENERIC;
 273 }
 274
 275 /*****************************************************************************
 276  * DestroyFilter: Make a clean exit of this plugin
 277  *****************************************************************************/
 278 static void DestroyFilter( vlc_object_t *p_this )
 279 {
 280     filter_t     *p_filter = (filter_t*)p_this;
 281     filter_sys_t *p_sys = p_filter->p_sys;
 282
 283     var_DelCallback( p_filter, OSD_CFG "position", OSDMenuCallback, p_sys );
 284     var_DelCallback( p_filter, OSD_CFG "timeout", OSDMenuCallback, p_sys );
 285     var_DelCallback( p_filter, OSD_CFG "update", OSDMenuCallback, p_sys );
 286     var_DelCallback( p_filter, OSD_CFG "alpha", OSDMenuCallback, p_sys );
 287
 288     var_DelCallback( p_sys->p_menu, "osd-menu-update",
 289                      OSDMenuUpdateEvent, p_filter );
 290     var_DelCallback( p_sys->p_menu, "osd-menu-visible",
 291                      OSDMenuVisibleEvent, p_filter );
 292
 293     if( p_sys->p_vout )
 294     {
 295         var_DelCallback( p_sys->p_vout, "mouse-clicked",
 296                         MouseEvent, p_sys );
 297         vlc_object_release( p_sys->p_vout );
 298     }
 299
 300     var_Destroy( p_this, OSD_CFG "file-path" );
 301     var_Destroy( p_this, OSD_CFG "file" );
 302     var_Destroy( p_this, OSD_CFG "x" );
 303     var_Destroy( p_this, OSD_CFG "y" );
 304     var_Destroy( p_this, OSD_CFG "position" );
 305     var_Destroy( p_this, OSD_CFG "timeout" );
 306     var_Destroy( p_this, OSD_CFG "update" );
 307     var_Destroy( p_this, OSD_CFG "alpha" );
 308
 309     osd_MenuDelete( p_filter, p_sys->p_menu );
 310     free( p_sys->psz_path );
 311     free( p_sys->psz_file );
 312     free( p_sys );
 313 }
 314
 315 /*****************************************************************************
 316  * OSDMenuEvent: callback for OSD Menu events
 317  *****************************************************************************/
 318 static int OSDMenuVisibleEvent( vlc_object_t *p_this, char const *psz_var,
 319                     vlc_value_t oldval, vlc_value_t newval, void *p_data )
 320 {
 321     VLC_UNUSED(p_this); VLC_UNUSED(psz_var); VLC_UNUSED(oldval);
 322     VLC_UNUSED(newval);
 323     filter_t *p_filter = (filter_t *) p_data;
 324
 325     p_filter->p_sys->b_visible = true;
 326     p_filter->p_sys->b_update = true;
 327     return VLC_SUCCESS;
 328 }
 329
 330 static int OSDMenuUpdateEvent( vlc_object_t *p_this, char const *psz_var,
 331                     vlc_value_t oldval, vlc_value_t newval, void *p_data )
 332 {
 333     VLC_UNUSED(p_this); VLC_UNUSED(psz_var); VLC_UNUSED(oldval);
 334     VLC_UNUSED(newval);
 335     filter_t *p_filter = (filter_t *) p_data;
 336     filter_sys_t *p_sys = p_filter->p_sys;
 337
 338     p_sys->b_update = p_sys->b_visible ? true : false;
 339     p_sys->i_end_date = (mtime_t) 0;
 340     return VLC_SUCCESS;
 341 }
 342
 343 #if 0
 344 /*****************************************************************************
 345  * create_text_region : compose a text region SPU
 346  *****************************************************************************/
 347 static subpicture_region_t *create_text_region( filter_t *p_filter, subpicture_t *p_spu,
 348     int i_width, int i_height, const char *psz_text )
 349 {
 350     subpicture_region_t *p_region;
 351     video_format_t       fmt;
 352
 353     /* Create new SPU region */
 354     memset( &fmt, 0, sizeof(video_format_t) );
 355     fmt.i_chroma = VLC_CODEC_TEXT;
 356     fmt.i_sar_num = fmt.i_sar_den = 1;
 357     fmt.i_width = fmt.i_visible_width = i_width;
 358     fmt.i_height = fmt.i_visible_height = i_height;
 359     fmt.i_x_offset = fmt.i_y_offset = 0;
 360     p_region = subpicture_region_New( &fmt );
 361     if( !p_region )
 362     {
 363         msg_Err( p_filter, "cannot allocate another SPU region" );
 364         return NULL;
 365     }
 366     p_region->psz_text = strdup( psz_text );
 367     p_region->i_x = 0;
 368     p_region->i_y = 40;
 369 #if 0
 370     msg_Dbg( p_filter, "SPU text region position (%d,%d) (%d,%d) [%s]",
 371         p_region->i_x, p_region->i_y,
 372         p_region->fmt.i_width, p_region->fmt.i_height, p_region->psz_text );
 373 #endif
 374     return p_region;
 375 }
 376 #endif
 377
 378 /*****************************************************************************
 379  * create_picture_region : compose a picture region SPU
 380  *****************************************************************************/
 381 static subpicture_region_t *create_picture_region( filter_t *p_filter, subpicture_t *p_spu,
 382     int i_width, int i_height, picture_t *p_pic )
 383 {
 384     subpicture_region_t *p_region = NULL;
 385     video_format_t       fmt;
 386     video_palette_t      palette;
 387
 388     if( !p_spu ) return NULL;
 389
 390     /* Create new SPU region */
 391     memset( &fmt, 0, sizeof(video_format_t) );
 392     fmt.i_chroma = (p_pic == NULL) ? VLC_CODEC_YUVP : VLC_CODEC_YUVA;
 393     fmt.i_sar_num = fmt.i_sar_den = 1;
 394     fmt.i_width = fmt.i_visible_width = i_width;
 395     fmt.i_height = fmt.i_visible_height = i_height;
 396     fmt.i_x_offset = fmt.i_y_offset = 0;
 397     if( fmt.i_chroma == VLC_CODEC_YUVP )
 398     {
 399         fmt.p_palette = &palette;
 400         fmt.p_palette->i_entries = 0;
 401         fmt.i_visible_width = 0;
 402         fmt.i_visible_height = 0;
 403     }
 404
 405     p_region = subpicture_region_New( &fmt );
 406     if( !p_region )
 407     {
 408         msg_Err( p_filter, "cannot allocate SPU region" );
 409         p_filter->pf_sub_buffer_del( p_filter, p_spu );
 410         return NULL;
 411     }
 412     /* FIXME the copy is probably not needed anymore */
 413     if( p_pic )
 414         picture_Copy( p_region->p_picture, p_pic );
 415
 416     p_region->i_x = 0;
 417     p_region->i_y = 0;
 418     p_region->i_align = p_filter->p_sys->i_position;
 419     p_region->i_alpha = p_filter->p_sys->i_alpha;
 420 #if 0
 421     msg_Dbg( p_filter, "SPU picture region position (%d,%d) (%d,%d) [%p]",
 422         p_region->i_x, p_region->i_y,
 423         p_region->fmt.i_width, p_region->fmt.i_height, p_pic );
 424 #endif
 425     return p_region;
 426 }
 427
 428 /****************************************************************************
 429  * Filter: the whole thing
 430  ****************************************************************************
 431  * This function outputs subpictures at regular time intervals.
 432  ****************************************************************************/
 433 static subpicture_t *Filter( filter_t *p_filter, mtime_t i_date )
 434 {
 435     filter_sys_t *p_sys = p_filter->p_sys;
 436     subpicture_t *p_spu = NULL;
 437     subpicture_region_t *p_region = NULL;
 438     int i_x, i_y;
 439
 440     if( !p_sys->b_update || (p_sys->i_update <= 0) )
 441             return NULL;
 442
 443     /* Am I too early?
 444     */
 445     if( ( ( p_sys->i_last_date + p_sys->i_update ) > i_date ) &&
 446         ( p_sys->i_end_date > 0 ) )
 447         return NULL; /* we are too early, so wait */
 448
 449     /* Allocate the subpicture internal data. */
 450     p_spu = filter_NewSubpicture( p_filter );
 451     if( !p_spu )
 452         return NULL;
 453
 454     p_spu->b_ephemer = true;
 455     p_spu->b_fade = true;
 456     if( p_filter->p_sys->p_menu->i_style == OSD_MENU_STYLE_CONCAT )
 457         p_spu->b_absolute = true;
 458     else
 459         p_spu->b_absolute = p_sys->b_absolute;
 460
 461     /* Determine the duration of the subpicture */
 462     if( p_sys->i_end_date > 0 )
 463     {
 464         /* Display the subpicture again. */
 465         p_spu->i_stop = p_sys->i_end_date - i_date;
 466         if( ( i_date + p_sys->i_update ) >= p_sys->i_end_date )
 467             p_sys->b_update = false;
 468     }
 469     else
 470     {
 471         /* There is a new OSD picture to display */
 472         p_spu->i_stop = i_date + p_sys->i_timeout;
 473         p_sys->i_end_date = p_spu->i_stop;
 474     }
 475
 476     p_sys->i_last_date = i_date;
 477     p_spu->i_start = p_sys->i_last_date = i_date;
 478
 479     /* Send an empty subpicture to clear the display
 480      * when OSD menu should be hidden and menu picture is not allocated.
 481      */
 482     if( !p_filter->p_sys->p_menu->p_state->p_pic ||
 483         ( p_filter->p_sys->b_visible == false ) )
 484     {
 485         /* Create new spu regions and allocate an empty picture in it. */
 486         p_region = create_picture_region( p_filter, p_spu,
 487             p_filter->p_sys->p_menu->p_state->i_width,
 488             p_filter->p_sys->p_menu->p_state->i_height,
 489             NULL );
 490
 491         /* proper positioning of OSD menu image */
 492         p_region->i_x = p_filter->p_sys->p_menu->p_state->i_x;
 493         p_region->i_y = p_filter->p_sys->p_menu->p_state->i_y;
 494         /* FIXME is it needed ?
 495         p_region->i_align = p_sys->i_position;
 496         */
 497         p_spu->p_region = p_region;
 498         p_spu->i_alpha = 0xFF; /* Picture is completely non transparent. */
 499         return p_spu;
 500     }
 501
 502     if( p_sys->p_vout && p_sys->b_clicked )
 503     {
 504         p_sys->b_clicked = false;
 505         osd_MenuActivate( p_filter );
 506     }
 507     /* Create new spu regions
 508     */
 509     p_region = create_picture_region( p_filter, p_spu,
 510         p_filter->p_sys->p_menu->p_state->i_width,
 511         p_filter->p_sys->p_menu->p_state->i_height,
 512         p_filter->p_sys->p_menu->p_state->p_pic );
 513
 514     if( !p_region )
 515     {
 516         p_filter->pf_sub_buffer_del( p_filter, p_spu );
 517         return NULL;
 518     }
 519
 520     p_spu->i_alpha = p_filter->p_sys->i_alpha;
 521
 522     /* proper positioning of OSD menu image */
 523     if( p_filter->p_sys->p_menu->i_style == OSD_MENU_STYLE_CONCAT )
 524     {
 525         i_x = p_filter->p_sys->p_menu->p_button->i_x;
 526         i_y = p_filter->p_sys->p_menu->p_button->i_y;
 527     }
 528     else
 529     {
 530         i_x = p_filter->p_sys->p_menu->p_state->i_x;
 531         i_y = p_filter->p_sys->p_menu->p_state->i_y;
 532     }
 533     p_region->i_x = i_x;
 534     p_region->i_y = i_y;
 535
 536     if( p_filter->p_sys->p_menu->i_style == OSD_MENU_STYLE_CONCAT )
 537     {
 538         subpicture_region_t *p_region_list = NULL;
 539         subpicture_region_t *p_region_tail = NULL;
 540         osd_menu_t *p_osd = p_filter->p_sys->p_menu;
 541         osd_button_t *p_button = p_osd->p_button;
 542
 543         /* Construct the entire OSD from individual images */
 544         while( p_button != NULL )
 545         {
 546             osd_button_t *p_tmp = NULL;
 547             subpicture_region_t *p_new = NULL;
 548
 549             p_new = create_picture_region( p_filter, p_spu,
 550                     p_button->p_current_state->p_pic->p[Y_PLANE].i_visible_pitch,
 551                     p_button->p_current_state->p_pic->p[Y_PLANE].i_visible_lines,
 552                     p_button->p_current_state->p_pic );
 553             if( !p_new )
 554             {
 555                 /* Cleanup when bailing out */
 556                 subpicture_region_ChainDelete( p_region_list );
 557                 subpicture_region_Delete( p_region );
 558
 559                 p_filter->pf_sub_buffer_del( p_filter, p_spu );
 560                 return NULL;
 561             }
 562
 563             if( !p_region_list )
 564             {
 565                 p_region_list = p_new;
 566                 p_region_tail = p_new;
 567             }
 568             else
 569             {
 570                 p_new->i_x = i_x+p_region_tail->fmt.i_visible_width;
 571                 p_new->i_y = i_y+p_button->i_y;
 572                 p_region_tail->p_next = p_new;
 573                 p_region_tail = p_new;
 574             }
 575             p_tmp = p_button->p_next;
 576             p_button = p_tmp;
 577         };
 578         p_region->p_next = p_region_list;
 579     }
 580 #if 0
 581     p_region->p_next = create_text_region( p_filter, p_spu,
 582         p_filter->p_sys->p_menu->p_state->i_width, p_filter->p_sys->p_menu->p_state->i_height,
 583         p_filter->p_sys->p_menu->p_state->p_visible->psz_action );
 584 #endif
 585     p_spu->p_region = p_region;
 586     return p_spu;
 587 }
 588
 589 static int OSDMenuCallback( vlc_object_t *p_this, char const *psz_var,
 590                             vlc_value_t oldval, vlc_value_t newval,
 591                             void *p_data )
 592 {
 593     VLC_UNUSED(p_this); VLC_UNUSED(oldval);
 594     filter_sys_t *p_sys = (filter_sys_t *) p_data;
 595
 596     if( !p_sys )
 597         return VLC_SUCCESS;
 598
 599     if( !strncmp( psz_var, OSD_CFG"position", 16) )
 600     {
 601 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
 602         unsigned int i;
 603         for( i=0; i < ARRAY_SIZE(pi_pos_values); i++ )
 604         {
 605             if( newval.i_int == pi_pos_values[i] )
 606             {
 607                 p_sys->i_position = newval.i_int % 11;
 608                 break;
 609             }
 610         }
 611 #undef ARRAY_SIZE
 612     }
 613     else if( !strncmp( psz_var, OSD_CFG"x", 9) ||
 614              !strncmp( psz_var, OSD_CFG"y", 9))
 615     {
 616         p_sys->b_absolute = true;
 617         if( (p_sys->i_x < 0) || (p_sys->i_y < 0) )
 618         {
 619             p_sys->b_absolute = false;
 620             p_sys->p_menu->i_x = 0;
 621             p_sys->p_menu->i_y = 0;
 622         }
 623         else if( (p_sys->i_x >= 0) || (p_sys->i_y >= 0) )
 624         {
 625             p_sys->p_menu->i_x = p_sys->i_x;
 626             p_sys->p_menu->i_y = p_sys->i_y;
 627         }
 628     }
 629     else if( !strncmp( psz_var, OSD_CFG"update", 14) )
 630         p_sys->i_update =  (mtime_t)(newval.i_int * 1000);
 631     else if( !strncmp( psz_var, OSD_CFG"timeout", 15) )
 632         p_sys->i_update = newval.i_int % 1000;
 633     else if( !strncmp( psz_var, OSD_CFG"alpha", 13) )
 634         p_sys->i_alpha = newval.i_int % 256;
 635
 636     p_sys->b_update = p_sys->b_visible ? true : false;
 637     return VLC_SUCCESS;
 638 }
 639
 640 /*****************************************************************************
 641  * MouseEvent: callback for mouse events
 642  *****************************************************************************/
 643 static int MouseEvent( vlc_object_t *p_this, char const *psz_var,
 644                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
 645 {
 646     VLC_UNUSED(oldval);
 647     filter_sys_t *p_sys = (filter_sys_t *)p_data;
 648     vout_thread_t *p_vout = (vout_thread_t*)p_sys->p_vout;
 649     int i_x = newval.coords.x;
 650     int i_y = newval.coords.y;
 651     int v_h = p_vout->output.i_height;
 652     int v_w = p_vout->output.i_width;
 653
 654     if( i_y < 0 || i_x < 0 || i_y >= v_h || i_x >= v_w )
 655         return VLC_SUCCESS;
 656
 657     do
 658     {
 659         int i_scale_width, i_scale_height;
 660         osd_button_t *p_button = NULL;
 661
 662         i_scale_width = p_vout->fmt_out.i_visible_width * 1000 /
 663             p_vout->fmt_in.i_visible_width;
 664         i_scale_height = p_vout->fmt_out.i_visible_height * 1000 /
 665             p_vout->fmt_in.i_visible_height;
 666
 667         p_button = osd_ButtonFind( p_this, i_x, i_y, v_h, v_w,
 668                                    i_scale_width, i_scale_height );
 669         if( p_button )
 670         {
 671             osd_ButtonSelect( p_this, p_button );
 672             p_sys->b_update = p_sys->b_visible ? true : false;
 673             p_sys->b_clicked = true;
 674             msg_Dbg( p_this, "mouse clicked %s (%d,%d)", p_button->psz_name, i_x, i_y );
 675         }
 676     }
 677     while(0);
 678     return VLC_SUCCESS;
 679 }