src/osd/osd.c

   1 /*****************************************************************************
   2  * osd.c - The OSD Menu core code.
   3  *****************************************************************************
   4  * Copyright (C) 2005-2008 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 implied 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
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <vlc_common.h>
  33 #include <vlc_keys.h>
  34 #include <vlc_osd.h>
  35 #include <vlc_image.h>
  36 #include <vlc_modules.h>
  37
  38 #include "libvlc.h"
  39
  40 #undef OSD_MENU_DEBUG
  41
  42 /*****************************************************************************
  43  * Local prototypes
  44  *****************************************************************************/
  45
  46 static void osd_UpdateState( osd_menu_state_t *, int, int, int, int, picture_t * );
  47 static inline osd_state_t *osd_VolumeStateChange( osd_state_t *, int );
  48 static int osd_VolumeStep( vlc_object_t *, int, int );
  49 static bool osd_ParserLoad( osd_menu_t *, const char * );
  50 static void osd_ParserUnload( osd_menu_t * );
  51
  52 static inline bool osd_isVisible( osd_menu_t *p_osd )
  53 {
  54     return var_GetBool( p_osd, "osd-menu-visible" );
  55 }
  56
  57 static vlc_mutex_t *osd_GetMutex( vlc_object_t *p_this )
  58 {
  59     vlc_value_t lockval;
  60
  61     var_Create( p_this->p_libvlc, "osd_mutex", VLC_VAR_MUTEX );
  62     var_Get( p_this->p_libvlc, "osd_mutex", &lockval );
  63     return lockval.p_address;
  64 }
  65
  66 /*****************************************************************************
  67  * Wrappers for loading and unloading osd parser modules.
  68  *****************************************************************************/
  69 static bool osd_ParserLoad( osd_menu_t *p_menu, const char *psz_file )
  70 {
  71     /* Stuff needed for Parser */
  72     p_menu->psz_file = strdup( psz_file );
  73     p_menu->p_image = image_HandlerCreate( p_menu );
  74     if( !p_menu->p_image || !p_menu->psz_file )
  75     {
  76         msg_Err( p_menu, "unable to load images, aborting .." );
  77         return false;
  78     }
  79     else
  80     {
  81         const char *psz_type;
  82         const char *psz_ext = strrchr( p_menu->psz_file, '.' );
  83
  84         if( psz_ext && !strcmp( psz_ext, ".cfg") )
  85             psz_type = "import-osd";
  86         else
  87             psz_type = "import-osd-xml";
  88
  89         p_menu->p_parser = module_need( p_menu, "osd parser",
  90                                         psz_type, true );
  91         if( !p_menu->p_parser )
  92         {
  93             return false;
  94         }
  95     }
  96     return true;
  97 }
  98
  99 static void osd_ParserUnload( osd_menu_t *p_menu )
 100 {
 101     if( p_menu->p_image )
 102         image_HandlerDelete( p_menu->p_image );
 103
 104     if( p_menu->p_parser )
 105         module_unneed( p_menu, p_menu->p_parser );
 106
 107     free( p_menu->psz_file );
 108 }
 109
 110 /**
 111  * Change state on an osd_button_t.
 112  *
 113  * This function selects the specified state and returns a pointer
 114  * vlc_custom_create to it. The following states are currently supported:
 115  * \see OSD_BUTTON_UNSELECT
 116  * \see OSD_BUTTON_SELECT
 117  * \see OSD_BUTTON_PRESSED
 118  */
 119 static osd_state_t *osd_StateChange( osd_button_t *p_button, const int i_state )
 120 {
 121     osd_state_t *p_current = p_button->p_states;
 122     osd_state_t *p_temp = NULL;
 123     int i = 0;
 124
 125     for( i= 0; p_current != NULL; i++ )
 126     {
 127         if( p_current->i_state == i_state )
 128         {
 129             p_button->i_x = p_current->i_x;
 130             p_button->i_y = p_current->i_y;
 131             p_button->i_width = p_current->i_width;
 132             p_button->i_height = p_current->i_height;
 133             return p_current;
 134         }
 135         p_temp = p_current->p_next;
 136         p_current = p_temp;
 137     }
 138     return p_button->p_states;
 139 }
 140
 141 #undef osd_MenuCreate
 142 /*****************************************************************************
 143  * OSD menu Funtions
 144  *****************************************************************************/
 145 osd_menu_t *osd_MenuCreate( vlc_object_t *p_this, const char *psz_file )
 146 {
 147     osd_menu_t  *p_osd = NULL;
 148     vlc_value_t val;
 149     vlc_mutex_t *p_lock;
 150     int         i_volume = 0;
 151     int         i_steps = 0;
 152
 153     /* to be sure to avoid multiple creation */
 154     p_lock = osd_GetMutex( p_this );
 155     vlc_mutex_lock( p_lock );
 156
 157     var_Create( p_this->p_libvlc, "osd-object", VLC_VAR_ADDRESS );
 158     var_Get( p_this->p_libvlc, "osd-object", &val );
 159     if( val.p_address == NULL )
 160     {
 161         static const char osdmenu_name[] = "osd menu";
 162
 163         p_osd = vlc_custom_create( p_this, sizeof( *p_osd ),
 164                                    VLC_OBJECT_GENERIC, osdmenu_name );
 165         if( !p_osd )
 166             return NULL;
 167
 168         p_osd->p_parser = NULL;
 169         vlc_object_attach( p_osd, p_this->p_libvlc );
 170
 171         /* Parse configuration file */
 172         if ( !osd_ParserLoad( p_osd, psz_file ) )
 173             goto error;
 174         if( !p_osd->p_state )
 175             goto error;
 176
 177         /* Setup default button (first button) */
 178         p_osd->p_state->p_visible = p_osd->p_button;
 179         p_osd->p_state->p_visible->p_current_state =
 180             osd_StateChange( p_osd->p_state->p_visible, OSD_BUTTON_SELECT );
 181         p_osd->i_width  = p_osd->p_state->p_visible->p_current_state->p_pic->p[Y_PLANE].i_visible_pitch;
 182         p_osd->i_height = p_osd->p_state->p_visible->p_current_state->p_pic->p[Y_PLANE].i_visible_lines;
 183
 184         if( p_osd->p_state->p_volume )
 185         {
 186             /* Update the volume state images to match the current volume */
 187             i_volume = config_GetInt( p_this, "volume" );
 188             i_steps = osd_VolumeStep( p_this, i_volume, p_osd->p_state->p_volume->i_ranges );
 189             p_osd->p_state->p_volume->p_current_state = osd_VolumeStateChange(
 190                                     p_osd->p_state->p_volume->p_states, i_steps );
 191         }
 192         /* Initialize OSD state */
 193         osd_UpdateState( p_osd->p_state, p_osd->i_x, p_osd->i_y,
 194                          p_osd->i_width, p_osd->i_height, NULL );
 195
 196         /* Signal when an update of OSD menu is needed */
 197         var_Create( p_osd, "osd-menu-update", VLC_VAR_BOOL );
 198         var_Create( p_osd, "osd-menu-visible", VLC_VAR_BOOL );
 199
 200         var_SetBool( p_osd, "osd-menu-update", false );
 201         var_SetBool( p_osd, "osd-menu-visible", false );
 202
 203         var_SetAddress( p_this->p_libvlc, "osd-object", p_osd );
 204     }
 205     else
 206         p_osd = val.p_address;
 207     vlc_object_hold( p_osd );
 208     vlc_mutex_unlock( p_lock );
 209     return p_osd;
 210
 211 error:
 212     vlc_mutex_unlock( p_lock );
 213     osd_MenuDelete( p_this, p_osd );
 214     return NULL;
 215 }
 216
 217 #undef osd_MenuDelete
 218 void osd_MenuDelete( vlc_object_t *p_this, osd_menu_t *p_osd )
 219 {
 220     vlc_mutex_t *p_lock;
 221
 222     if( !p_osd || !p_this ) return;
 223
 224     p_lock = osd_GetMutex( p_this );
 225     vlc_mutex_lock( p_lock );
 226
 227     if( vlc_internals( VLC_OBJECT(p_osd) )->i_refcount == 1 )
 228     {
 229         var_Destroy( p_osd, "osd-menu-visible" );
 230         var_Destroy( p_osd, "osd-menu-update" );
 231         osd_ParserUnload( p_osd );
 232         var_SetAddress( p_this->p_libvlc, "osd-object", NULL );
 233     }
 234
 235     vlc_object_release( p_osd );
 236     vlc_mutex_unlock( p_lock );
 237 }
 238
 239 static osd_menu_t *osd_Find( vlc_object_t *p_this )
 240 {
 241     vlc_value_t val;
 242
 243     if( var_Get( p_this->p_libvlc, "osd-object", &val ) )
 244         return NULL;
 245     return val.p_address;
 246 }
 247
 248 /* The volume can be modified in another interface while the OSD Menu
 249  * has not been instantiated yet. This routines updates the "volume OSD menu item"
 250  * to reflect the current state of the GUI.
 251  */
 252 static inline osd_state_t *osd_VolumeStateChange( osd_state_t *p_current, int i_steps )
 253 {
 254     osd_state_t *p_temp = NULL;
 255     int i;
 256
 257     if( i_steps < 0 ) i_steps = 0;
 258
 259     for( i=0; (i < i_steps) && (p_current != NULL); i++ )
 260     {
 261         p_temp = p_current->p_next;
 262         if( !p_temp ) return p_current;
 263         p_current = p_temp;
 264     }
 265     return (!p_temp) ? p_current : p_temp;
 266 }
 267
 268 /* Update the state of the OSD Menu */
 269 static void osd_UpdateState( osd_menu_state_t *p_state, int i_x, int i_y,
 270         int i_width, int i_height, picture_t *p_pic )
 271 {
 272     p_state->i_x = i_x;
 273     p_state->i_y = i_y;
 274     p_state->i_width = i_width;
 275     p_state->i_height = i_height;
 276     p_state->p_pic = p_pic;
 277 }
 278
 279 #undef osd_MenuShow
 280 void osd_MenuShow( vlc_object_t *p_this )
 281 {
 282     osd_menu_t *p_osd;
 283     osd_button_t *p_button = NULL;
 284     vlc_mutex_t *p_lock = osd_GetMutex( p_this );
 285
 286     vlc_mutex_lock( p_lock );
 287     p_osd = osd_Find( p_this );
 288     if( p_osd == NULL )
 289     {
 290         vlc_mutex_unlock( p_lock );
 291         msg_Err( p_this, "osd_MenuShow failed" );
 292         return;
 293     }
 294
 295 #if defined(OSD_MENU_DEBUG)
 296     msg_Dbg( p_osd, "menu on" );
 297 #endif
 298     p_button = p_osd->p_state->p_visible;
 299     if( p_button )
 300     {
 301         if( !p_button->b_range )
 302             p_button->p_current_state = osd_StateChange( p_button, OSD_BUTTON_UNSELECT );
 303         p_osd->p_state->p_visible = p_osd->p_button;
 304
 305         if( !p_osd->p_state->p_visible->b_range )
 306             p_osd->p_state->p_visible->p_current_state =
 307                 osd_StateChange( p_osd->p_state->p_visible, OSD_BUTTON_SELECT );
 308
 309         osd_UpdateState( p_osd->p_state,
 310                 p_osd->p_state->p_visible->i_x, p_osd->p_state->p_visible->i_y,
 311                 p_osd->p_state->p_visible->p_current_state->i_width,
 312                 p_osd->p_state->p_visible->p_current_state->i_height,
 313                 p_osd->p_state->p_visible->p_current_state->p_pic );
 314         osd_SetMenuUpdate( p_osd, true );
 315     }
 316     osd_SetMenuVisible( p_osd, true );
 317
 318     vlc_mutex_unlock( p_lock );
 319 }
 320
 321 #undef osd_MenuHide
 322 void osd_MenuHide( vlc_object_t *p_this )
 323 {
 324     osd_menu_t *p_osd;
 325     vlc_mutex_t *p_lock = osd_GetMutex( p_this );
 326
 327     vlc_mutex_lock( p_lock );
 328
 329     p_osd = osd_Find( p_this );
 330     if( p_osd == NULL )
 331     {
 332         vlc_mutex_unlock( p_lock );
 333         msg_Err( p_this, "osd_MenuHide failed" );
 334         return;
 335     }
 336
 337 #if defined(OSD_MENU_DEBUG)
 338     msg_Dbg( p_osd, "menu off" );
 339 #endif
 340     osd_UpdateState( p_osd->p_state,
 341                 p_osd->p_state->i_x, p_osd->p_state->i_y,
 342                 0, 0, NULL );
 343     osd_SetMenuUpdate( p_osd, true );
 344
 345     vlc_mutex_unlock( p_lock );
 346 }
 347
 348 #undef osd_MenuActivate
 349 void osd_MenuActivate( vlc_object_t *p_this )
 350 {
 351     osd_menu_t *p_osd;
 352     osd_button_t *p_button = NULL;
 353     vlc_mutex_t *p_lock = osd_GetMutex( p_this );
 354
 355     vlc_mutex_lock( p_lock );
 356
 357     p_osd = osd_Find( p_this );
 358     if( p_osd == NULL || !osd_isVisible( p_osd ) )
 359     {
 360         vlc_mutex_unlock( p_lock );
 361         msg_Err( p_this, "osd_MenuActivate failed" );
 362         return;
 363     }
 364
 365 #if defined(OSD_MENU_DEBUG)
 366     msg_Dbg( p_osd, "select" );
 367 #endif
 368     p_button = p_osd->p_state->p_visible;
 369     /*
 370      * Is there a menu item above or below? If so, then select it.
 371      */
 372     if( p_button && p_button->p_up )
 373     {
 374         vlc_mutex_unlock( p_lock );
 375         osd_MenuUp( p_this );   /* "menu select" means go to menu item above. */
 376         return;
 377     }
 378     if( p_button && p_button->p_down )
 379     {
 380         vlc_mutex_unlock( p_lock );
 381         osd_MenuDown( p_this ); /* "menu select" means go to menu item below. */
 382         return;
 383     }
 384
 385     if( p_button && !p_button->b_range )
 386     {
 387         p_button->p_current_state = osd_StateChange( p_button, OSD_BUTTON_PRESSED );
 388         osd_UpdateState( p_osd->p_state,
 389                 p_button->i_x, p_button->i_y,
 390                 p_osd->p_state->p_visible->p_current_state->i_width,
 391                 p_osd->p_state->p_visible->p_current_state->i_height,
 392                 p_button->p_current_state->p_pic );
 393         osd_SetMenuUpdate( p_osd, true );
 394         osd_SetMenuVisible( p_osd, true );
 395         osd_SetKeyPressed( VLC_OBJECT(p_osd->p_libvlc),
 396                            var_InheritInteger( p_osd, p_button->psz_action ) );
 397 #if defined(OSD_MENU_DEBUG)
 398         msg_Dbg( p_osd, "select (%d, %s)",
 399                  (int)var_InheritInteger( p_osd, p_button->psz_action ),
 400                  p_button->psz_action );
 401 #endif
 402     }
 403     vlc_mutex_unlock( p_lock );
 404 }
 405
 406 #undef osd_MenuNext
 407 void osd_MenuNext( vlc_object_t *p_this )
 408 {
 409     osd_menu_t *p_osd;
 410     osd_button_t *p_button = NULL;
 411     vlc_mutex_t *p_lock = osd_GetMutex( p_this );
 412
 413     vlc_mutex_lock( p_lock );
 414
 415     p_osd = osd_Find( p_this );
 416     if( p_osd == NULL || !osd_isVisible( p_osd ) )
 417     {
 418         vlc_mutex_unlock( p_lock );
 419         msg_Err( p_this, "osd_MenuNext failed" );
 420         return;
 421     }
 422
 423     p_button = p_osd->p_state->p_visible;
 424     if( p_button )
 425     {
 426         if( !p_button->b_range )
 427             p_button->p_current_state = osd_StateChange( p_button, OSD_BUTTON_UNSELECT );
 428         if( p_button->p_next )
 429             p_osd->p_state->p_visible = p_button->p_next;
 430         else
 431             p_osd->p_state->p_visible = p_osd->p_button;
 432
 433         if( !p_osd->p_state->p_visible->b_range )
 434             p_osd->p_state->p_visible->p_current_state =
 435                 osd_StateChange( p_osd->p_state->p_visible, OSD_BUTTON_SELECT );
 436
 437         osd_UpdateState( p_osd->p_state,
 438                 p_osd->p_state->p_visible->i_x, p_osd->p_state->p_visible->i_y,
 439                 p_osd->p_state->p_visible->p_current_state->i_width,
 440                 p_osd->p_state->p_visible->p_current_state->i_height,
 441                 p_osd->p_state->p_visible->p_current_state->p_pic );
 442         osd_SetMenuUpdate( p_osd, true );
 443     }
 444 #if defined(OSD_MENU_DEBUG)
 445     msg_Dbg( p_osd, "direction right [button %s]", p_osd->p_state->p_visible->psz_action );
 446 #endif
 447
 448     vlc_mutex_unlock( p_lock );
 449 }
 450
 451 #undef osd_MenuPrev
 452 void osd_MenuPrev( vlc_object_t *p_this )
 453 {
 454     osd_menu_t *p_osd;
 455     osd_button_t *p_button = NULL;
 456     vlc_mutex_t *p_lock = osd_GetMutex( p_this );
 457
 458     vlc_mutex_lock( p_lock );
 459     p_osd = osd_Find( p_this );
 460     if( p_osd == NULL || !osd_isVisible( p_osd ) )
 461     {
 462         vlc_mutex_unlock( p_lock );
 463         msg_Err( p_this, "osd_MenuPrev failed" );
 464         return;
 465     }
 466
 467     p_button = p_osd->p_state->p_visible;
 468     if( p_button )
 469     {
 470         if( !p_button->b_range )
 471             p_button->p_current_state = osd_StateChange( p_button, OSD_BUTTON_UNSELECT );
 472         if( p_button->p_prev )
 473             p_osd->p_state->p_visible = p_button->p_prev;
 474         else
 475             p_osd->p_state->p_visible = p_osd->p_last_button;
 476
 477         if( !p_osd->p_state->p_visible->b_range )
 478             p_osd->p_state->p_visible->p_current_state =
 479                 osd_StateChange( p_osd->p_state->p_visible, OSD_BUTTON_SELECT );
 480
 481         osd_UpdateState( p_osd->p_state,
 482                 p_osd->p_state->p_visible->i_x, p_osd->p_state->p_visible->i_y,
 483                 p_osd->p_state->p_visible->p_current_state->i_width,
 484                 p_osd->p_state->p_visible->p_current_state->i_height,
 485                 p_osd->p_state->p_visible->p_current_state->p_pic );
 486         osd_SetMenuUpdate( p_osd, true );
 487     }
 488 #if defined(OSD_MENU_DEBUG)
 489     msg_Dbg( p_osd, "direction left [button %s]", p_osd->p_state->p_visible->psz_action );
 490 #endif
 491
 492     vlc_mutex_unlock( p_lock );
 493 }
 494
 495 #undef osd_MenuUp
 496 void osd_MenuUp( vlc_object_t *p_this )
 497 {
 498     osd_menu_t *p_osd;
 499     osd_button_t *p_button = NULL;
 500 #if defined(OSD_MENU_DEBUG)
 501     vlc_value_t val;
 502 #endif
 503     vlc_mutex_t *p_lock = osd_GetMutex( p_this );
 504
 505     vlc_mutex_lock( p_lock );
 506     p_osd = osd_Find( p_this );
 507     if( p_osd == NULL || !osd_isVisible( p_osd ) )
 508     {
 509         vlc_mutex_unlock( p_lock );
 510         msg_Err( p_this, "osd_MenuActivate failed" );
 511         return;
 512     }
 513
 514     p_button = p_osd->p_state->p_visible;
 515     if( p_button )
 516     {
 517         if( !p_button->b_range )
 518         {
 519             p_button->p_current_state = osd_StateChange( p_button, OSD_BUTTON_SELECT );
 520             if( p_button->p_up )
 521                 p_osd->p_state->p_visible = p_button->p_up;
 522         }
 523
 524         if( p_button->b_range && p_osd->p_state->p_visible->b_range )
 525         {
 526             osd_state_t *p_temp = p_osd->p_state->p_visible->p_current_state;
 527             if( p_temp && p_temp->p_next )
 528                 p_osd->p_state->p_visible->p_current_state = p_temp->p_next;
 529         }
 530         else if( !p_osd->p_state->p_visible->b_range )
 531         {
 532             p_osd->p_state->p_visible->p_current_state =
 533                 osd_StateChange( p_osd->p_state->p_visible, OSD_BUTTON_SELECT );
 534         }
 535
 536         osd_UpdateState( p_osd->p_state,
 537                 p_osd->p_state->p_visible->i_x, p_osd->p_state->p_visible->i_y,
 538                 p_osd->p_state->p_visible->p_current_state->i_width,
 539                 p_osd->p_state->p_visible->p_current_state->i_height,
 540                 p_osd->p_state->p_visible->p_current_state->p_pic );
 541         osd_SetMenuUpdate( p_osd, true );
 542         /* If this is a range style action with associated images of only one state,
 543             * then perform "menu select" on every menu navigation
 544             */
 545         if( p_button->b_range )
 546         {
 547             osd_SetKeyPressed( VLC_OBJECT(p_osd->p_libvlc),
 548                                var_InheritInteger(p_osd, p_button->psz_action) );
 549 #if defined(OSD_MENU_DEBUG)
 550             msg_Dbg( p_osd, "select (%"PRId64", %s)", val.i_int, p_button->psz_action );
 551 #endif
 552         }
 553     }
 554 #if defined(OSD_MENU_DEBUG)
 555     msg_Dbg( p_osd, "direction up [button %s]", p_osd->p_state->p_visible->psz_action );
 556 #endif
 557
 558     vlc_mutex_unlock( p_lock );
 559 }
 560
 561 #undef osd_MenuDown
 562 void osd_MenuDown( vlc_object_t *p_this )
 563 {
 564     osd_menu_t *p_osd;
 565     osd_button_t *p_button = NULL;
 566 #if defined(OSD_MENU_DEBUG)
 567     vlc_value_t val;
 568 #endif
 569     vlc_mutex_t *p_lock = osd_GetMutex( p_this );
 570
 571     vlc_mutex_lock( p_lock );
 572
 573     p_osd = osd_Find( p_this );
 574     if( p_osd == NULL || !osd_isVisible( p_osd ) )
 575     {
 576         vlc_mutex_unlock( p_lock );
 577         msg_Err( p_this, "osd_MenuActivate failed" );
 578         return;
 579     }
 580
 581     p_button = p_osd->p_state->p_visible;
 582     if( p_button )
 583     {
 584         if( !p_button->b_range )
 585         {
 586             p_button->p_current_state = osd_StateChange( p_button, OSD_BUTTON_SELECT );
 587             if( p_button->p_down )
 588                 p_osd->p_state->p_visible = p_button->p_down;
 589         }
 590
 591         if( p_button->b_range && p_osd->p_state->p_visible->b_range )
 592         {
 593             osd_state_t *p_temp = p_osd->p_state->p_visible->p_current_state;
 594             if( p_temp && p_temp->p_prev )
 595                 p_osd->p_state->p_visible->p_current_state = p_temp->p_prev;
 596         }
 597         else if( !p_osd->p_state->p_visible->b_range )
 598         {
 599             p_osd->p_state->p_visible->p_current_state =
 600                 osd_StateChange( p_osd->p_state->p_visible, OSD_BUTTON_SELECT );
 601         }
 602
 603         osd_UpdateState( p_osd->p_state,
 604                 p_osd->p_state->p_visible->i_x, p_osd->p_state->p_visible->i_y,
 605                 p_osd->p_state->p_visible->p_current_state->i_width,
 606                 p_osd->p_state->p_visible->p_current_state->i_height,
 607                 p_osd->p_state->p_visible->p_current_state->p_pic );
 608         osd_SetMenuUpdate( p_osd, true );
 609         /* If this is a range style action with associated images of only one state,
 610          * then perform "menu select" on every menu navigation
 611          */
 612         if( p_button->b_range )
 613         {
 614             osd_SetKeyPressed( VLC_OBJECT(p_osd->p_libvlc),
 615                                var_InheritInteger(p_osd, p_button->psz_action_down) );
 616 #if defined(OSD_MENU_DEBUG)
 617             msg_Dbg( p_osd, "select (%"PRId64", %s)", val.i_int, p_button->psz_action_down );
 618 #endif
 619         }
 620     }
 621 #if defined(OSD_MENU_DEBUG)
 622     msg_Dbg( p_osd, "direction down [button %s]", p_osd->p_state->p_visible->psz_action );
 623 #endif
 624
 625     vlc_mutex_unlock( p_lock );
 626 }
 627
 628 static int osd_VolumeStep( vlc_object_t *p_this, int i_volume, int i_steps )
 629 {
 630     int i_volume_step = 0;
 631     (void)i_steps;
 632
 633     i_volume_step = config_GetInt( p_this->p_libvlc, "volume-step" );
 634     return (i_volume/i_volume_step);
 635 }
 636
 637 #undef osd_Volume
 638 /**
 639  * Display current audio volume bitmap
 640  *
 641  * The OSD Menu audio volume bar is updated to reflect the new audio volume. Call this function
 642  * when the audio volume is updated outside the OSD menu command "menu up", "menu down" or "menu select".
 643  */
 644 void osd_Volume( vlc_object_t *p_this )
 645 {
 646     osd_menu_t *p_osd;
 647     osd_button_t *p_button = NULL;
 648     vlc_mutex_t *p_lock = osd_GetMutex( p_this );
 649     int i_volume = 0;
 650     int i_steps = 0;
 651
 652     vlc_mutex_lock( p_lock );
 653
 654     p_osd = osd_Find( p_this );
 655     if( p_osd == NULL )
 656     {
 657         vlc_mutex_unlock( p_lock );
 658         msg_Err( p_this, "OSD menu volume update failed" );
 659         return;
 660     }
 661
 662     if( p_osd->p_state && p_osd->p_state->p_volume )
 663     {
 664
 665         p_button = p_osd->p_state->p_volume;
 666         if( p_osd->p_state->p_volume )
 667             p_osd->p_state->p_visible = p_osd->p_state->p_volume;
 668         if( p_button && p_button->b_range )
 669         {
 670             /* Update the volume state images to match the current volume */
 671             i_volume = config_GetInt( p_this, "volume" );
 672             i_steps = osd_VolumeStep( p_this, i_volume, p_button->i_ranges );
 673             p_button->p_current_state = osd_VolumeStateChange( p_button->p_states, i_steps );
 674
 675             osd_UpdateState( p_osd->p_state,
 676                     p_button->i_x, p_button->i_y,
 677                     p_button->p_current_state->i_width,
 678                     p_button->p_current_state->i_height,
 679                     p_button->p_current_state->p_pic );
 680             osd_SetMenuUpdate( p_osd, true );
 681             osd_SetMenuVisible( p_osd, true );
 682         }
 683     }
 684     vlc_mutex_unlock( p_lock );
 685 }
 686
 687 #undef osd_ButtonFind
 688 osd_button_t *osd_ButtonFind( vlc_object_t *p_this, int i_x, int i_y,
 689     int i_window_height, int i_window_width,
 690     int i_scale_width, int i_scale_height )
 691 {
 692     osd_menu_t *p_osd;
 693     osd_button_t *p_button;
 694     vlc_mutex_t *p_lock = osd_GetMutex( p_this );
 695
 696     vlc_mutex_lock( p_lock );
 697
 698     p_osd = osd_Find( p_this );
 699     if( p_osd == NULL || !osd_isVisible( p_osd ) )
 700     {
 701         vlc_mutex_unlock( p_lock );
 702         msg_Err( p_this, "osd_ButtonFind failed" );
 703         return NULL;
 704     }
 705
 706     p_button = p_osd->p_button;
 707     for( ; p_button != NULL; p_button = p_button->p_next )
 708     {
 709         int i_source_video_width  = ( i_window_width  * 1000 ) / i_scale_width;
 710         int i_source_video_height = ( i_window_height * 1000 ) / i_scale_height;
 711         int i_y_offset = p_button->i_y;
 712         int i_x_offset = p_button->i_x;
 713         int i_width = p_button->i_width;
 714         int i_height = p_button->i_height;
 715
 716         if( p_osd->i_position > 0 )
 717         {
 718             int i_inv_scale_y = i_source_video_height;
 719             int i_inv_scale_x = i_source_video_width;
 720             int pi_x = 0;
 721
 722             if( p_osd->i_position & SUBPICTURE_ALIGN_BOTTOM )
 723             {
 724                 i_y_offset = i_window_height - p_button->i_height -
 725                     (p_osd->i_y + p_button->i_y) * i_inv_scale_y / 1000;
 726             }
 727             else if ( !(p_osd->i_position & SUBPICTURE_ALIGN_TOP) )
 728             {
 729                 i_y_offset = i_window_height / 2 - p_button->i_height / 2;
 730             }
 731
 732             if( p_osd->i_position & SUBPICTURE_ALIGN_RIGHT )
 733             {
 734                 i_x_offset = i_window_width - p_button->i_width -
 735                     (pi_x + p_button->i_x)
 736                     * i_inv_scale_x / 1000;
 737             }
 738             else if ( !(p_osd->i_position & SUBPICTURE_ALIGN_LEFT) )
 739             {
 740                 i_x_offset = i_window_width / 2 - p_button->i_width / 2;
 741             }
 742
 743             i_width = i_window_width - p_button->i_width - i_inv_scale_x / 1000;
 744             i_height = i_window_height - p_button->i_height - i_inv_scale_y / 1000;
 745         }
 746
 747         // TODO: write for Up / Down case too.
 748         // TODO: handle absolute positioning case
 749         if( ( i_x >= i_x_offset ) && ( i_x <= i_x_offset + i_width ) &&
 750             ( i_y >= i_y_offset ) && ( i_y <= i_y_offset + i_height ) )
 751         {
 752             vlc_mutex_unlock( p_lock );
 753             return p_button;
 754         }
 755     }
 756
 757     vlc_mutex_unlock( p_lock );
 758     return NULL;
 759 }
 760
 761 #undef osd_ButtonSelect
 762 /**
 763  * Select the button provided as the new active button
 764  */
 765 void osd_ButtonSelect( vlc_object_t *p_this, osd_button_t *p_button )
 766 {
 767     osd_menu_t *p_osd;
 768     osd_button_t *p_old;
 769     vlc_mutex_t *p_lock = osd_GetMutex( p_this );
 770
 771     vlc_mutex_lock( p_lock );
 772
 773     p_osd = osd_Find( p_this );
 774     if( p_osd == NULL || !osd_isVisible( p_osd ) )
 775     {
 776         vlc_mutex_unlock( p_lock );
 777         msg_Err( p_this, "osd_ButtonSelect failed" );
 778         return;
 779     }
 780
 781     p_old = p_osd->p_state->p_visible;
 782     if( p_old )
 783     {
 784         if( !p_old->b_range )
 785             p_old->p_current_state = osd_StateChange( p_old, OSD_BUTTON_UNSELECT );
 786         p_osd->p_state->p_visible = p_button;
 787
 788         if( !p_osd->p_state->p_visible->b_range )
 789             p_osd->p_state->p_visible->p_current_state =
 790                 osd_StateChange( p_osd->p_state->p_visible, OSD_BUTTON_SELECT );
 791
 792         osd_UpdateState( p_osd->p_state,
 793                 p_osd->p_state->p_visible->i_x, p_osd->p_state->p_visible->i_y,
 794                 p_osd->p_state->p_visible->p_current_state->i_width,
 795                 p_osd->p_state->p_visible->p_current_state->i_height,
 796                 p_osd->p_state->p_visible->p_current_state->p_pic );
 797         osd_SetMenuUpdate( p_osd, true );
 798     }
 799 #if defined(OSD_MENU_DEBUG)
 800     msg_Dbg( p_osd, "button selected is [button %s]", p_osd->p_state->p_visible->psz_action );
 801 #endif
 802
 803     vlc_mutex_unlock( p_lock );
 804 }