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