]> git.sesse.net Git - vlc/blobdiff - src/osd/osd.c
osd: Make sure we release properly in __osd_Volume.
[vlc] / src / osd / osd.c
index 4dacb004a7cf74aae6f16102edc52069fb213afc..87be707d6aabb3be2ce1f28575d52101b1c5950a 100644 (file)
-/*****************************************************************************\r
- * osd.c - The OSD Menu core code.\r
- *****************************************************************************\r
- * Copyright (C) 2005 M2X\r
- * $Id$\r
- *\r
- * Authors: Jean-Paul Saman <jpsaman #_at_# m2x dot nl>\r
- *\r
- * This program is free software; you can redistribute it and/or modify\r
- * it under the terms of the GNU General Public License as published by\r
- * the Free Software Foundation; either version 2 of the License, or\r
- * (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License\r
- * along with this program; if not, write to the Free Software\r
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.\r
- *****************************************************************************/\r
-\r
-/*****************************************************************************\r
- * Preamble\r
- *****************************************************************************/\r
-#include <stdlib.h>\r
-#include <string.h>\r
-\r
-#include <vlc/vlc.h>\r
-#include <vlc_keys.h>\r
-#include <vlc_osd.h>\r
-\r
-#undef OSD_MENU_DEBUG\r
-\r
-/*****************************************************************************\r
- * Local prototypes\r
- *****************************************************************************/\r
-\r
-static void osd_UpdateState( osd_menu_state_t *, int, int, int, int, picture_t * );\r
-static inline osd_state_t *osd_VolumeStateChange( osd_state_t *, int );\r
-static int osd_VolumeStep( vlc_object_t *, int, int );\r
-static vlc_bool_t osd_isVisible( osd_menu_t *p_osd );\r
-\r
-static vlc_bool_t osd_isVisible( osd_menu_t *p_osd )\r
-{\r
-    vlc_value_t val;\r
-\r
-    var_Get( p_osd, "osd-menu-visible", &val );\r
-    return val.b_bool;\r
-}\r
-\r
-/*****************************************************************************\r
- * OSD menu Funtions\r
- *****************************************************************************/\r
-osd_menu_t *__osd_MenuCreate( vlc_object_t *p_this, const char *psz_file )\r
-{\r
-    osd_menu_t  *p_osd = NULL;\r
-    vlc_value_t lockval;\r
-    int         i_volume = 0;\r
-    int         i_steps = 0;\r
-\r
-    /* to be sure to avoid multiple creation */\r
-    var_Create( p_this->p_libvlc, "osd_mutex", VLC_VAR_MUTEX );\r
-    var_Get( p_this->p_libvlc, "osd_mutex", &lockval );\r
-    vlc_mutex_lock( lockval.p_address );\r
-\r
-    if( ( p_osd = vlc_object_find( p_this, VLC_OBJECT_OSDMENU, FIND_ANYWHERE ) ) == NULL )\r
-    {\r
-        vlc_value_t val;\r
-\r
-        msg_Dbg( p_this, "creating osd menu object" );\r
-        if( ( p_osd = vlc_object_create( p_this, VLC_OBJECT_OSDMENU ) ) == NULL )\r
-        {\r
-            msg_Err( p_this, "out of memory" );\r
-            vlc_mutex_unlock( lockval.p_address );\r
-            return NULL;\r
-        }\r
-\r
-        /* Parse configuration file */\r
-        if( osd_ConfigLoader( p_this, psz_file, &p_osd ) )\r
-            goto error;\r
-\r
-        /* Setup default button (first button) */\r
-        p_osd->p_state->p_visible = p_osd->p_button;\r
-        p_osd->p_state->p_visible->p_current_state =\r
-            osd_StateChange( p_osd->p_state->p_visible->p_states, OSD_BUTTON_SELECT );\r
-        p_osd->i_width  = p_osd->p_state->p_visible->p_current_state->p_pic->p[Y_PLANE].i_visible_pitch;\r
-        p_osd->i_height = p_osd->p_state->p_visible->p_current_state->p_pic->p[Y_PLANE].i_visible_lines;\r
-\r
-        /* Update the volume state images to match the current volume */\r
-        i_volume = config_GetInt( p_this, "volume" );\r
-        i_steps = osd_VolumeStep( p_this, i_volume, p_osd->p_state->p_volume->i_ranges );\r
-        p_osd->p_state->p_volume->p_current_state = osd_VolumeStateChange( p_osd->p_state->p_volume->p_states, i_steps );\r
-\r
-        /* Initialize OSD state */\r
-        osd_UpdateState( p_osd->p_state, p_osd->i_x, p_osd->i_y,\r
-                         p_osd->i_width, p_osd->i_height, NULL );\r
-\r
-        vlc_object_yield( p_osd );\r
-        vlc_object_attach( p_osd, p_this->p_vlc );\r
-\r
-        /* Signal when an update of OSD menu is needed */\r
-        var_Create( p_osd, "osd-menu-update", VLC_VAR_BOOL );\r
-        var_Create( p_osd, "osd-menu-visible", VLC_VAR_BOOL );\r
-\r
-        val.b_bool = VLC_FALSE;\r
-        var_Set( p_osd, "osd-menu-update", val );\r
-        var_Set( p_osd, "osd-menu-visible", val );\r
-    }\r
-    vlc_mutex_unlock( lockval.p_address );\r
-    return p_osd;\r
-\r
-error:\r
-    msg_Err( p_this, "creating osd menu object failed" );\r
-    vlc_mutex_unlock( lockval.p_address );\r
-    vlc_object_destroy( p_osd );\r
-    return NULL;\r
-}\r
-\r
-void __osd_MenuDelete( vlc_object_t *p_this, osd_menu_t *p_osd )\r
-{\r
-    vlc_value_t lockval;\r
-\r
-    if( !p_osd || !p_this ) return;\r
-\r
-    var_Get( p_this->p_libvlc, "osd_mutex", &lockval );\r
-    vlc_mutex_lock( lockval.p_address );\r
-\r
-    vlc_object_release( p_osd );\r
-    if( p_osd->i_refcount > 0 )\r
-    {\r
-        vlc_mutex_unlock( lockval.p_address );\r
-        return;\r
-    }\r
-\r
-    var_Destroy( p_osd, "osd-menu-visible" );\r
-    var_Destroy( p_osd, "osd-menu-update" );\r
-\r
-    osd_ConfigUnload( p_this, &p_osd );\r
-    vlc_object_detach( p_osd );\r
-    vlc_object_destroy( p_osd );\r
-    p_osd = NULL;\r
-\r
-    vlc_mutex_unlock( lockval.p_address );\r
-}\r
-\r
-osd_state_t *__osd_StateChange( osd_state_t *p_states, const int i_state )\r
-{\r
-    osd_state_t *p_current = p_states;\r
-    osd_state_t *p_temp = NULL;\r
-    int i = 0;\r
-\r
-    for( i=0; p_current != NULL; i++ )\r
-    {\r
-        if( p_current->i_state == i_state )\r
-            return p_current;\r
-        p_temp = p_current->p_next;\r
-        p_current = p_temp;\r
-    }\r
-    return p_states;\r
-}\r
-\r
-/* The volume can be modified in another interface while the OSD Menu \r
- * has not been instantiated yet. This routines updates the "volume OSD menu item"\r
- * to reflect the current state of the GUI.\r
- */\r
-static inline osd_state_t *osd_VolumeStateChange( osd_state_t *p_current, int i_steps )\r
-{\r
-    osd_state_t *p_temp = NULL;\r
-    int i;\r
-\r
-    if( i_steps < 0 ) i_steps = 0;\r
-\r
-    for( i=0; (i < i_steps) && (p_current != NULL); i++ )\r
-    {\r
-        p_temp = p_current->p_next;\r
-        if( !p_temp ) return p_current;\r
-        p_current = p_temp;\r
-    }\r
-    return (!p_temp) ? p_current : p_temp;\r
-}\r
-\r
-/* Update the state of the OSD Menu */\r
-static void osd_UpdateState( osd_menu_state_t *p_state, int i_x, int i_y,\r
-        int i_width, int i_height, picture_t *p_pic )\r
-{\r
-    p_state->i_x = i_x;\r
-    p_state->i_y = i_y;\r
-    p_state->i_width = i_width;\r
-    p_state->i_height = i_height;\r
-    p_state->p_pic = p_pic;\r
-}\r
-\r
-void __osd_MenuShow( vlc_object_t *p_this )\r
-{\r
-    osd_menu_t *p_osd = NULL;\r
-    osd_button_t *p_button = NULL;\r
-    vlc_value_t lockval;\r
-\r
-    if( ( p_osd = vlc_object_find( p_this, VLC_OBJECT_OSDMENU, FIND_ANYWHERE ) ) == NULL )\r
-    {\r
-        msg_Err( p_this, "osd_MenuNext failed" );\r
-        return;\r
-    }\r
-\r
-    var_Get( p_this->p_libvlc, "osd_mutex", &lockval );\r
-    vlc_mutex_lock( lockval.p_address );\r
-\r
-#if defined(OSD_MENU_DEBUG)\r
-    msg_Dbg( p_osd, "menu on" );\r
-#endif\r
-    p_button = p_osd->p_state->p_visible;\r
-    if( p_button )\r
-    {\r
-        if( !p_button->b_range ) \r
-            p_button->p_current_state = osd_StateChange( p_button->p_states, OSD_BUTTON_UNSELECT );\r
-        p_osd->p_state->p_visible = p_osd->p_button;\r
-\r
-        if( !p_osd->p_state->p_visible->b_range ) \r
-            p_osd->p_state->p_visible->p_current_state =\r
-                osd_StateChange( p_osd->p_state->p_visible->p_states, OSD_BUTTON_SELECT );\r
-\r
-        osd_UpdateState( p_osd->p_state,\r
-                p_osd->p_state->p_visible->i_x, p_osd->p_state->p_visible->i_y,\r
-                p_osd->p_state->p_visible->p_current_state->p_pic->p[Y_PLANE].i_visible_pitch,\r
-                p_osd->p_state->p_visible->p_current_state->p_pic->p[Y_PLANE].i_visible_lines,\r
-                p_osd->p_state->p_visible->p_current_state->p_pic );\r
-        osd_SetMenuUpdate( p_osd, VLC_TRUE );\r
-    }\r
-    osd_SetMenuVisible( p_osd, VLC_TRUE );\r
-\r
-    vlc_object_release( (vlc_object_t*) p_osd );\r
-    vlc_mutex_unlock( lockval.p_address );\r
-}\r
-\r
-void __osd_MenuHide( vlc_object_t *p_this )\r
-{\r
-    osd_menu_t *p_osd = NULL;\r
-    vlc_value_t lockval;\r
-\r
-    if( ( p_osd = vlc_object_find( p_this, VLC_OBJECT_OSDMENU, FIND_ANYWHERE ) ) == NULL )\r
-    {\r
-        msg_Err( p_this, "osd_MenuNext failed" );\r
-        return;\r
-    }\r
-\r
-    var_Get( p_this->p_libvlc, "osd_mutex", &lockval );\r
-    vlc_mutex_lock( lockval.p_address );\r
-\r
-#if defined(OSD_MENU_DEBUG)\r
-    msg_Dbg( p_osd, "menu off" );\r
-#endif\r
-    osd_UpdateState( p_osd->p_state,\r
-                p_osd->p_state->i_x, p_osd->p_state->i_y,\r
-                0, 0, NULL );\r
-    osd_SetMenuUpdate( p_osd, VLC_TRUE );\r
-\r
-    vlc_object_release( (vlc_object_t*) p_osd );\r
-    vlc_mutex_unlock( lockval.p_address );\r
-}\r
-\r
-void __osd_MenuActivate( vlc_object_t *p_this )\r
-{\r
-    osd_menu_t *p_osd = NULL;\r
-    osd_button_t *p_button = NULL;\r
-    vlc_value_t lockval;\r
-\r
-    if( ( p_osd = vlc_object_find( p_this, VLC_OBJECT_OSDMENU, FIND_ANYWHERE ) ) == NULL )\r
-    {\r
-        msg_Err( p_this, "osd_MenuNext failed" );\r
-        return;\r
-    }\r
-\r
-    if( osd_isVisible( p_osd ) == VLC_FALSE )\r
-    {\r
-        vlc_object_release( (vlc_object_t*) p_osd );\r
-        return;\r
-    }\r
-\r
-    var_Get( p_this->p_libvlc, "osd_mutex", &lockval );\r
-    vlc_mutex_lock( lockval.p_address );\r
-\r
-#if defined(OSD_MENU_DEBUG)\r
-    msg_Dbg( p_osd, "select" );\r
-#endif\r
-    p_button = p_osd->p_state->p_visible;\r
-    /*\r
-     * Is there a menu item above or below? If so, then select it.\r
-     */\r
-    if( p_button && p_button->p_up)\r
-    {\r
-        vlc_object_release( (vlc_object_t*) p_osd );\r
-        vlc_mutex_unlock( lockval.p_address );\r
-        __osd_MenuUp( p_this );   /* "menu select" means go to menu item above. */\r
-        return;\r
-    }\r
-    if( p_button && p_button->p_down)\r
-    {\r
-        vlc_object_release( (vlc_object_t*) p_osd );\r
-        vlc_mutex_unlock( lockval.p_address );\r
-        __osd_MenuDown( p_this ); /* "menu select" means go to menu item below. */\r
-        return;\r
-    }\r
-\r
-    if( p_button && !p_button->b_range )\r
-    {\r
-        p_button->p_current_state = osd_StateChange( p_button->p_states, OSD_BUTTON_PRESSED );\r
-        osd_UpdateState( p_osd->p_state,\r
-                p_button->i_x, p_button->i_y,\r
-                p_osd->p_state->p_visible->p_current_state->p_pic->p[Y_PLANE].i_visible_pitch,\r
-                p_osd->p_state->p_visible->p_current_state->p_pic->p[Y_PLANE].i_visible_lines,\r
-                p_button->p_current_state->p_pic );\r
-        osd_SetMenuUpdate( p_osd, VLC_TRUE );\r
-        osd_SetMenuVisible( p_osd, VLC_TRUE );\r
-        osd_SetKeyPressed( VLC_OBJECT(p_osd->p_vlc), config_GetInt( p_osd, p_button->psz_action ) );\r
-#if defined(OSD_MENU_DEBUG)\r
-        msg_Dbg( p_osd, "select (%d, %s)", config_GetInt( p_osd, p_button->psz_action ), p_button->psz_action );\r
-#endif\r
-    }\r
-    vlc_object_release( (vlc_object_t*) p_osd );\r
-    vlc_mutex_unlock( lockval.p_address );\r
-}\r
-\r
-void __osd_MenuNext( vlc_object_t *p_this )\r
-{\r
-    osd_menu_t *p_osd = NULL;\r
-    osd_button_t *p_button = NULL;\r
-    vlc_value_t lockval;\r
-\r
-    if( ( p_osd = vlc_object_find( p_this, VLC_OBJECT_OSDMENU, FIND_ANYWHERE ) ) == NULL )\r
-    {\r
-        msg_Err( p_this, "osd_MenuNext failed" );\r
-        return;\r
-    }\r
-\r
-    if( osd_isVisible( p_osd ) == VLC_FALSE )\r
-    {\r
-        vlc_object_release( (vlc_object_t*) p_osd );\r
-        return;\r
-    }\r
-\r
-    var_Get( p_this->p_libvlc, "osd_mutex", &lockval );\r
-    vlc_mutex_lock( lockval.p_address );\r
-\r
-    p_button = p_osd->p_state->p_visible;\r
-    if( p_button )\r
-    {\r
-        if( !p_button->b_range ) \r
-            p_button->p_current_state = osd_StateChange( p_button->p_states, OSD_BUTTON_UNSELECT );\r
-        if( p_button->p_next )\r
-            p_osd->p_state->p_visible = p_button->p_next;\r
-        else\r
-            p_osd->p_state->p_visible = p_osd->p_button;\r
-\r
-        if( !p_osd->p_state->p_visible->b_range ) \r
-            p_osd->p_state->p_visible->p_current_state =\r
-                osd_StateChange( p_osd->p_state->p_visible->p_states, OSD_BUTTON_SELECT );\r
-\r
-        osd_UpdateState( p_osd->p_state, \r
-                p_osd->p_state->p_visible->i_x, p_osd->p_state->p_visible->i_y,\r
-                p_osd->p_state->p_visible->p_current_state->p_pic->p[Y_PLANE].i_visible_pitch,\r
-                p_osd->p_state->p_visible->p_current_state->p_pic->p[Y_PLANE].i_visible_lines,\r
-                p_osd->p_state->p_visible->p_current_state->p_pic );\r
-        osd_SetMenuUpdate( p_osd, VLC_TRUE );\r
-    }\r
-#if defined(OSD_MENU_DEBUG)\r
-    msg_Dbg( p_osd, "direction right [button %s]", p_osd->p_state->p_visible->psz_action );\r
-#endif\r
-\r
-    vlc_object_release( (vlc_object_t*) p_osd );\r
-    vlc_mutex_unlock( lockval.p_address );\r
-}\r
-\r
-void __osd_MenuPrev( vlc_object_t *p_this )\r
-{\r
-    osd_menu_t *p_osd = NULL;\r
-    osd_button_t *p_button = NULL;\r
-    vlc_value_t lockval;\r
-\r
-    if( ( p_osd = vlc_object_find( p_this, VLC_OBJECT_OSDMENU, FIND_ANYWHERE ) ) == NULL )\r
-    {\r
-        msg_Err( p_this, "osd_MenuPrev failed" );\r
-        return;\r
-    }\r
-\r
-    if( osd_isVisible( p_osd ) == VLC_FALSE )\r
-    {\r
-        vlc_object_release( (vlc_object_t*) p_osd );\r
-        return;\r
-    }\r
-\r
-    var_Get( p_this->p_libvlc, "osd_mutex", &lockval );\r
-    vlc_mutex_lock( lockval.p_address );\r
-\r
-    p_button = p_osd->p_state->p_visible;\r
-    if( p_button )\r
-    {\r
-        if( !p_button->b_range ) \r
-            p_button->p_current_state = osd_StateChange( p_button->p_states, OSD_BUTTON_UNSELECT );\r
-        if( p_button->p_prev )\r
-            p_osd->p_state->p_visible = p_button->p_prev;\r
-        else\r
-            p_osd->p_state->p_visible = p_osd->p_last_button;\r
-\r
-        if( !p_osd->p_state->p_visible->b_range ) \r
-            p_osd->p_state->p_visible->p_current_state =\r
-                osd_StateChange( p_osd->p_state->p_visible->p_states, OSD_BUTTON_SELECT );\r
-\r
-        osd_UpdateState( p_osd->p_state, \r
-                p_osd->p_state->p_visible->i_x, p_osd->p_state->p_visible->i_y,\r
-                p_osd->p_state->p_visible->p_current_state->p_pic->p[Y_PLANE].i_visible_pitch,\r
-                p_osd->p_state->p_visible->p_current_state->p_pic->p[Y_PLANE].i_visible_lines,\r
-                p_osd->p_state->p_visible->p_current_state->p_pic );\r
-        osd_SetMenuUpdate( p_osd, VLC_TRUE );\r
-    }\r
-#if defined(OSD_MENU_DEBUG)\r
-    msg_Dbg( p_osd, "direction left [button %s]", p_osd->p_state->p_visible->psz_action );\r
-#endif\r
-\r
-    vlc_object_release( (vlc_object_t*) p_osd );\r
-    vlc_mutex_unlock( lockval.p_address );\r
-}\r
-\r
-void __osd_MenuUp( vlc_object_t *p_this )\r
-{\r
-    osd_menu_t *p_osd = NULL;\r
-    osd_button_t *p_button = NULL;\r
-    vlc_value_t lockval;\r
-#if defined(OSD_MENU_DEBUG)\r
-    vlc_value_t val;\r
-#endif\r
-\r
-    if( ( p_osd = vlc_object_find( p_this, VLC_OBJECT_OSDMENU, FIND_ANYWHERE ) ) == NULL )\r
-    {\r
-        msg_Err( p_this, "osd_MenuDown failed" );\r
-        return;\r
-    }\r
-\r
-    if( osd_isVisible( p_osd ) == VLC_FALSE )\r
-    {\r
-        vlc_object_release( (vlc_object_t*) p_osd );\r
-        return;\r
-    }\r
-\r
-    var_Get( p_this->p_libvlc, "osd_mutex", &lockval );\r
-    vlc_mutex_lock( lockval.p_address );\r
-\r
-    p_button = p_osd->p_state->p_visible;\r
-    if( p_button )\r
-    {\r
-        if( !p_button->b_range ) \r
-        {\r
-            p_button->p_current_state = osd_StateChange( p_button->p_states, OSD_BUTTON_SELECT );\r
-            if( p_button->p_up )\r
-                p_osd->p_state->p_visible = p_button->p_up;\r
-        }\r
-\r
-        if( p_button->b_range && p_osd->p_state->p_visible->b_range ) \r
-        {\r
-            osd_state_t *p_temp = p_osd->p_state->p_visible->p_current_state;\r
-            if( p_temp && p_temp->p_next )\r
-                p_osd->p_state->p_visible->p_current_state = p_temp->p_next;\r
-        }\r
-        else if( !p_osd->p_state->p_visible->b_range )\r
-        {\r
-            p_osd->p_state->p_visible->p_current_state =\r
-                osd_StateChange( p_osd->p_state->p_visible->p_states, OSD_BUTTON_SELECT );\r
-        }\r
-\r
-        osd_UpdateState( p_osd->p_state, \r
-                p_osd->p_state->p_visible->i_x, p_osd->p_state->p_visible->i_y,\r
-                p_osd->p_state->p_visible->p_current_state->p_pic->p[Y_PLANE].i_visible_pitch,\r
-                p_osd->p_state->p_visible->p_current_state->p_pic->p[Y_PLANE].i_visible_lines,\r
-                p_osd->p_state->p_visible->p_current_state->p_pic );\r
-        osd_SetMenuUpdate( p_osd, VLC_TRUE );\r
-        /* If this is a range style action with associated images of only one state, \r
-            * then perform "menu select" on every menu navigation\r
-            */\r
-        if( p_button->b_range ) \r
-        {\r
-            osd_SetKeyPressed( VLC_OBJECT(p_osd->p_vlc), config_GetInt(p_osd, p_button->psz_action) );\r
-#if defined(OSD_MENU_DEBUG)\r
-            msg_Dbg( p_osd, "select (%d, %s)", val.i_int, p_button->psz_action );\r
-#endif\r
-        }\r
-    }\r
-#if defined(OSD_MENU_DEBUG)\r
-    msg_Dbg( p_osd, "direction up [button %s]", p_osd->p_state->p_visible->psz_action );\r
-#endif\r
-\r
-    vlc_object_release( (vlc_object_t*) p_osd );\r
-    vlc_mutex_unlock( lockval.p_address );\r
-}\r
-\r
-void __osd_MenuDown( vlc_object_t *p_this )\r
-{\r
-    osd_menu_t *p_osd = NULL;\r
-    osd_button_t *p_button = NULL;\r
-    vlc_value_t lockval;\r
-#if defined(OSD_MENU_DEBUG)\r
-    vlc_value_t val;\r
-#endif\r
-\r
-    if( ( p_osd = vlc_object_find( p_this, VLC_OBJECT_OSDMENU, FIND_ANYWHERE ) ) == NULL )\r
-    {\r
-        msg_Err( p_this, "osd_MenuDown failed" );\r
-        return;\r
-    }\r
-\r
-    if( osd_isVisible( p_osd ) == VLC_FALSE )\r
-    {\r
-        vlc_object_release( (vlc_object_t*) p_osd );\r
-        return;\r
-    }\r
-\r
-    var_Get( p_this->p_libvlc, "osd_mutex", &lockval );\r
-    vlc_mutex_lock( lockval.p_address );\r
-\r
-    p_button = p_osd->p_state->p_visible;\r
-    if( p_button )\r
-    {\r
-        if( !p_button->b_range ) \r
-        {\r
-            p_button->p_current_state = osd_StateChange( p_button->p_states, OSD_BUTTON_SELECT );\r
-            if( p_button->p_down )\r
-                p_osd->p_state->p_visible = p_button->p_down;\r
-        }\r
-\r
-        if( p_button->b_range && p_osd->p_state->p_visible->b_range ) \r
-        {\r
-            osd_state_t *p_temp = p_osd->p_state->p_visible->p_current_state;\r
-            if( p_temp && p_temp->p_prev )\r
-                p_osd->p_state->p_visible->p_current_state = p_temp->p_prev;\r
-        }\r
-        else if( !p_osd->p_state->p_visible->b_range )\r
-        {\r
-            p_osd->p_state->p_visible->p_current_state =\r
-                osd_StateChange( p_osd->p_state->p_visible->p_states, OSD_BUTTON_SELECT );\r
-        }\r
-\r
-        osd_UpdateState( p_osd->p_state, \r
-                p_osd->p_state->p_visible->i_x, p_osd->p_state->p_visible->i_y,\r
-                p_osd->p_state->p_visible->p_current_state->p_pic->p[Y_PLANE].i_visible_pitch,\r
-                p_osd->p_state->p_visible->p_current_state->p_pic->p[Y_PLANE].i_visible_lines,\r
-                p_osd->p_state->p_visible->p_current_state->p_pic );\r
-        osd_SetMenuUpdate( p_osd, VLC_TRUE );\r
-        /* If this is a range style action with associated images of only one state,\r
-         * then perform "menu select" on every menu navigation\r
-         */\r
-        if( p_button->b_range ) \r
-        {\r
-            osd_SetKeyPressed( VLC_OBJECT(p_osd->p_vlc), config_GetInt(p_osd, p_button->psz_action_down) );\r
-#if defined(OSD_MENU_DEBUG)\r
-            msg_Dbg( p_osd, "select (%d, %s)", val.i_int, p_button->psz_action_down );\r
-#endif\r
-        }\r
-    }\r
-#if defined(OSD_MENU_DEBUG)\r
-    msg_Dbg( p_osd, "direction down [button %s]", p_osd->p_state->p_visible->psz_action ); \r
-#endif\r
-\r
-    vlc_object_release( (vlc_object_t*) p_osd );\r
-    vlc_mutex_unlock( lockval.p_address );\r
-}\r
-\r
-static int osd_VolumeStep( vlc_object_t *p_this, int i_volume, int i_steps )\r
-{\r
-    int i_volume_step = 0;\r
-\r
-    i_volume_step = config_GetInt( p_this->p_vlc, "volume-step" );\r
-    return (i_volume/i_volume_step);\r
-}\r
-\r
-/**\r
- * Display current audio volume bitmap\r
- *\r
- * The OSD Menu audio volume bar is updated to reflect the new audio volume. Call this function\r
- * when the audio volume is updated outside the OSD menu command "menu up", "menu down" or "menu select".\r
- */\r
-void __osd_Volume( vlc_object_t *p_this )\r
-{\r
-    osd_menu_t *p_osd = NULL;\r
-    osd_button_t *p_button = NULL;\r
-    vlc_value_t lockval;\r
-    int i_volume = 0;\r
-    int i_steps = 0;\r
-\r
-    if( ( p_osd = vlc_object_find( p_this, VLC_OBJECT_OSDMENU, FIND_ANYWHERE ) ) == NULL )\r
-    {\r
-        msg_Err( p_this, "OSD menu volume update failed" );\r
-        return;\r
-    }\r
-\r
-    var_Get( p_this->p_libvlc, "osd_mutex", &lockval );\r
-    vlc_mutex_lock( lockval.p_address );\r
-\r
-    p_button = p_osd->p_state->p_volume;\r
-    if( p_osd->p_state->p_volume ) \r
-        p_osd->p_state->p_visible = p_osd->p_state->p_volume;\r
-    if( p_button && p_button->b_range )\r
-    {\r
-        /* Update the volume state images to match the current volume */\r
-        i_volume = config_GetInt( p_this, "volume" );\r
-        i_steps = osd_VolumeStep( p_this, i_volume, p_button->i_ranges );\r
-        p_button->p_current_state = osd_VolumeStateChange( p_button->p_states, i_steps );\r
-\r
-        osd_UpdateState( p_osd->p_state,\r
-                p_button->i_x, p_button->i_y,\r
-                p_button->p_current_state->p_pic->p[Y_PLANE].i_visible_pitch,\r
-                p_button->p_current_state->p_pic->p[Y_PLANE].i_visible_lines,\r
-                p_button->p_current_state->p_pic );\r
-        osd_SetMenuUpdate( p_osd, VLC_TRUE );\r
-        osd_SetMenuVisible( p_osd, VLC_TRUE );\r
-    }\r
-    vlc_object_release( (vlc_object_t*) p_osd );\r
-    vlc_mutex_unlock( lockval.p_address );\r
-}\r
+/*****************************************************************************
+ * osd.c - The OSD Menu core code.
+ *****************************************************************************
+ * Copyright (C) 2005-2007 M2X
+ * $Id$
+ *
+ * Authors: Jean-Paul Saman <jpsaman #_at_# m2x dot nl>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ *****************************************************************************/
+
+/*****************************************************************************
+ * Preamble
+ *****************************************************************************/
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <vlc_common.h>
+#include <vlc_keys.h>
+#include <vlc_osd.h>
+#include <vlc_image.h>
+
+#include "libvlc.h"
+
+#undef OSD_MENU_DEBUG
+
+#if 0
+static const char *ppsz_button_states[] = { "unselect", "select", "pressed" };
+#endif
+
+/*****************************************************************************
+ * Local prototypes
+ *****************************************************************************/
+
+static void osd_UpdateState( osd_menu_state_t *, int, int, int, int, picture_t * );
+static inline osd_state_t *osd_VolumeStateChange( osd_state_t *, int );
+static int osd_VolumeStep( vlc_object_t *, int, int );
+static bool osd_isVisible( osd_menu_t *p_osd );
+static osd_menu_t *osd_ParserLoad( vlc_object_t *, const char * );
+static void osd_ParserUnload( osd_menu_t * );
+
+static bool osd_isVisible( osd_menu_t *p_osd )
+{
+    vlc_value_t val;
+
+    var_Get( p_osd, "osd-menu-visible", &val );
+    return val.b_bool;
+}
+
+/*****************************************************************************
+ * Wrappers for loading and unloading osd parser modules.
+ *****************************************************************************/
+static osd_menu_t *osd_ParserLoad( vlc_object_t *p_this, const char *psz_file )
+{
+    osd_menu_t *p_menu;
+    static const char osdmenu_name[] = "osd menu";
+
+    p_menu = vlc_custom_create( p_this, sizeof( *p_menu ), VLC_OBJECT_OSDMENU,
+                                osdmenu_name );
+    if( !p_menu )
+        return NULL;
+
+    vlc_object_attach( p_menu, p_this->p_libvlc );
+
+    /* Stuff needed for Parser */
+    p_menu->psz_file = strdup( psz_file );
+    p_menu->p_image = image_HandlerCreate( p_this );
+    if( !p_menu->p_image || !p_menu->psz_file )
+    {
+        msg_Err( p_this, "unable to load images, aborting .." );
+        osd_ParserUnload( p_menu );
+        return NULL;
+    }
+    else
+    {
+        char *psz_type;
+        char *psz_ext = strrchr( p_menu->psz_file, '.' );
+
+        if( psz_ext && !strcmp( psz_ext, ".cfg") )
+            psz_type = (char*)"import-osd";
+        else
+            psz_type = (char*)"import-osd-xml";
+
+        p_menu->p_parser = module_Need( p_menu, "osd parser",
+                                        psz_type, true );
+        if( !p_menu->p_parser )
+        {
+            osd_ParserUnload( p_menu );
+            return NULL;
+        }
+    }
+    return p_menu;
+}
+
+static void osd_ParserUnload( osd_menu_t *p_menu )
+{
+    if( p_menu->p_image )
+        image_HandlerDelete( p_menu->p_image );
+    if( p_menu->psz_file )
+        free( p_menu->psz_file );
+
+    if( p_menu->p_parser )
+        module_Unneed( p_menu, p_menu->p_parser );
+
+    vlc_object_detach( p_menu );
+    vlc_object_release( p_menu );
+}
+
+/**
+ * Change state on an osd_button_t.
+ *
+ * This function selects the specified state and returns a pointer to it. The
+ * following states are currently supported:
+ * \see OSD_BUTTON_UNSELECT
+ * \see OSD_BUTTON_SELECT
+ * \see OSD_BUTTON_PRESSED
+ */
+static osd_state_t *osd_StateChange( osd_button_t *p_button, const int i_state )
+{
+    osd_state_t *p_current = p_button->p_states;
+    osd_state_t *p_temp = NULL;
+    int i = 0;
+
+    for( i=0; p_current != NULL; i++ )
+    {
+        if( p_current->i_state == i_state )
+        {
+            p_button->i_x = p_current->i_x;
+            p_button->i_y = p_current->i_y;
+            p_button->i_width = p_current->i_width;
+            p_button->i_height = p_current->i_height;
+            return p_current;
+        }
+        p_temp = p_current->p_next;
+        p_current = p_temp;
+    }
+    return p_button->p_states;
+}
+
+/*****************************************************************************
+ * OSD menu Funtions
+ *****************************************************************************/
+osd_menu_t *__osd_MenuCreate( vlc_object_t *p_this, const char *psz_file )
+{
+    osd_menu_t  *p_osd = NULL;
+    vlc_value_t lockval;
+    int         i_volume = 0;
+    int         i_steps = 0;
+
+    /* to be sure to avoid multiple creation */
+    var_Create( p_this->p_libvlc, "osd_mutex", VLC_VAR_MUTEX );
+    var_Get( p_this->p_libvlc, "osd_mutex", &lockval );
+    vlc_mutex_lock( lockval.p_address );
+
+    p_osd = vlc_object_find( p_this, VLC_OBJECT_OSDMENU, FIND_ANYWHERE );
+    if( p_osd == NULL )
+    {
+        vlc_value_t val;
+
+        /* Parse configuration file */
+        p_osd = osd_ParserLoad( p_this, psz_file );
+        if( !p_osd )
+            goto error;
+
+        /* Setup default button (first button) */
+        p_osd->p_state->p_visible = p_osd->p_button;
+        p_osd->p_state->p_visible->p_current_state =
+            osd_StateChange( p_osd->p_state->p_visible, OSD_BUTTON_SELECT );
+        p_osd->i_width  = p_osd->p_state->p_visible->p_current_state->p_pic->p[Y_PLANE].i_visible_pitch;
+        p_osd->i_height = p_osd->p_state->p_visible->p_current_state->p_pic->p[Y_PLANE].i_visible_lines;
+
+        if( p_osd->p_state->p_volume )
+        {
+            /* Update the volume state images to match the current volume */
+            i_volume = config_GetInt( p_this, "volume" );
+            i_steps = osd_VolumeStep( p_this, i_volume, p_osd->p_state->p_volume->i_ranges );
+            p_osd->p_state->p_volume->p_current_state = osd_VolumeStateChange(
+                                    p_osd->p_state->p_volume->p_states, i_steps );
+        }
+        /* Initialize OSD state */
+        osd_UpdateState( p_osd->p_state, p_osd->i_x, p_osd->i_y,
+                         p_osd->i_width, p_osd->i_height, NULL );
+
+        /* Signal when an update of OSD menu is needed */
+        var_Create( p_osd, "osd-menu-update", VLC_VAR_BOOL );
+        var_Create( p_osd, "osd-menu-visible", VLC_VAR_BOOL );
+
+        val.b_bool = false;
+        var_Set( p_osd, "osd-menu-update", val );
+        var_Set( p_osd, "osd-menu-visible", val );
+    }
+    vlc_mutex_unlock( lockval.p_address );
+    return p_osd;
+
+error:
+    msg_Err( p_this, "creating OSD menu object failed" );
+
+    if( p_osd->p_image )
+        image_HandlerDelete( p_osd->p_image );
+    if( p_osd->psz_file )
+        free( p_osd->psz_file );
+
+    vlc_object_detach( p_osd );
+    vlc_object_release( p_osd );
+    vlc_mutex_unlock( lockval.p_address );
+    return NULL;
+}
+
+void __osd_MenuDelete( vlc_object_t *p_this, osd_menu_t *p_osd )
+{
+    vlc_value_t lockval;
+
+    if( !p_osd || !p_this ) return;
+
+    var_Get( p_this->p_libvlc, "osd_mutex", &lockval );
+    vlc_mutex_lock( lockval.p_address );
+
+    vlc_object_release( p_osd );
+    if( vlc_internals( VLC_OBJECT(p_osd) )->i_refcount > 0 )
+    {
+        vlc_mutex_unlock( lockval.p_address );
+        return;
+    }
+
+    var_Destroy( p_osd, "osd-menu-visible" );
+    var_Destroy( p_osd, "osd-menu-update" );
+
+    osd_ParserUnload( p_osd );
+    p_osd = NULL;
+    vlc_mutex_unlock( lockval.p_address );
+}
+
+/* The volume can be modified in another interface while the OSD Menu
+ * has not been instantiated yet. This routines updates the "volume OSD menu item"
+ * to reflect the current state of the GUI.
+ */
+static inline osd_state_t *osd_VolumeStateChange( osd_state_t *p_current, int i_steps )
+{
+    osd_state_t *p_temp = NULL;
+    int i;
+
+    if( i_steps < 0 ) i_steps = 0;
+
+    for( i=0; (i < i_steps) && (p_current != NULL); i++ )
+    {
+        p_temp = p_current->p_next;
+        if( !p_temp ) return p_current;
+        p_current = p_temp;
+    }
+    return (!p_temp) ? p_current : p_temp;
+}
+
+/* Update the state of the OSD Menu */
+static void osd_UpdateState( osd_menu_state_t *p_state, int i_x, int i_y,
+        int i_width, int i_height, picture_t *p_pic )
+{
+    p_state->i_x = i_x;
+    p_state->i_y = i_y;
+    p_state->i_width = i_width;
+    p_state->i_height = i_height;
+    p_state->p_pic = p_pic;
+}
+
+void __osd_MenuShow( vlc_object_t *p_this )
+{
+    osd_menu_t *p_osd = NULL;
+    osd_button_t *p_button = NULL;
+    vlc_value_t lockval;
+
+    p_osd = vlc_object_find( p_this, VLC_OBJECT_OSDMENU, FIND_ANYWHERE );
+    if( p_osd == NULL )
+    {
+        msg_Err( p_this, "osd_MenuNext failed" );
+        return;
+    }
+
+    var_Get( p_this->p_libvlc, "osd_mutex", &lockval );
+    vlc_mutex_lock( lockval.p_address );
+
+#if defined(OSD_MENU_DEBUG)
+    msg_Dbg( p_osd, "menu on" );
+#endif
+    p_button = p_osd->p_state->p_visible;
+    if( p_button )
+    {
+        if( !p_button->b_range )
+            p_button->p_current_state = osd_StateChange( p_button, OSD_BUTTON_UNSELECT );
+        p_osd->p_state->p_visible = p_osd->p_button;
+
+        if( !p_osd->p_state->p_visible->b_range )
+            p_osd->p_state->p_visible->p_current_state =
+                osd_StateChange( p_osd->p_state->p_visible, OSD_BUTTON_SELECT );
+
+        osd_UpdateState( p_osd->p_state,
+                p_osd->p_state->p_visible->i_x, p_osd->p_state->p_visible->i_y,
+                p_osd->p_state->p_visible->p_current_state->i_width,
+                p_osd->p_state->p_visible->p_current_state->i_height,
+                p_osd->p_state->p_visible->p_current_state->p_pic );
+        osd_SetMenuUpdate( p_osd, true );
+    }
+    osd_SetMenuVisible( p_osd, true );
+
+    vlc_object_release( (vlc_object_t*) p_osd );
+    vlc_mutex_unlock( lockval.p_address );
+}
+
+void __osd_MenuHide( vlc_object_t *p_this )
+{
+    osd_menu_t *p_osd = NULL;
+    vlc_value_t lockval;
+
+    p_osd = vlc_object_find( p_this, VLC_OBJECT_OSDMENU, FIND_ANYWHERE );
+    if( p_osd == NULL )
+    {
+        msg_Err( p_this, "osd_MenuNext failed" );
+        return;
+    }
+
+    var_Get( p_this->p_libvlc, "osd_mutex", &lockval );
+    vlc_mutex_lock( lockval.p_address );
+
+#if defined(OSD_MENU_DEBUG)
+    msg_Dbg( p_osd, "menu off" );
+#endif
+    osd_UpdateState( p_osd->p_state,
+                p_osd->p_state->i_x, p_osd->p_state->i_y,
+                0, 0, NULL );
+    osd_SetMenuUpdate( p_osd, true );
+
+    vlc_object_release( (vlc_object_t*) p_osd );
+    vlc_mutex_unlock( lockval.p_address );
+}
+
+void __osd_MenuActivate( vlc_object_t *p_this )
+{
+    osd_menu_t *p_osd = NULL;
+    osd_button_t *p_button = NULL;
+    vlc_value_t lockval;
+
+    p_osd = vlc_object_find( p_this, VLC_OBJECT_OSDMENU, FIND_ANYWHERE );
+    if( p_osd == NULL )
+    {
+        msg_Err( p_this, "osd_MenuNext failed" );
+        return;
+    }
+
+    if( osd_isVisible( p_osd ) == false )
+    {
+        vlc_object_release( (vlc_object_t*) p_osd );
+        return;
+    }
+
+    var_Get( p_this->p_libvlc, "osd_mutex", &lockval );
+    vlc_mutex_lock( lockval.p_address );
+
+#if defined(OSD_MENU_DEBUG)
+    msg_Dbg( p_osd, "select" );
+#endif
+    p_button = p_osd->p_state->p_visible;
+    /*
+     * Is there a menu item above or below? If so, then select it.
+     */
+    if( p_button && p_button->p_up )
+    {
+        vlc_object_release( (vlc_object_t*) p_osd );
+        vlc_mutex_unlock( lockval.p_address );
+        __osd_MenuUp( p_this );   /* "menu select" means go to menu item above. */
+        return;
+    }
+    if( p_button && p_button->p_down )
+    {
+        vlc_object_release( (vlc_object_t*) p_osd );
+        vlc_mutex_unlock( lockval.p_address );
+        __osd_MenuDown( p_this ); /* "menu select" means go to menu item below. */
+        return;
+    }
+
+    if( p_button && !p_button->b_range )
+    {
+        p_button->p_current_state = osd_StateChange( p_button, OSD_BUTTON_PRESSED );
+        osd_UpdateState( p_osd->p_state,
+                p_button->i_x, p_button->i_y,
+                p_osd->p_state->p_visible->p_current_state->i_width,
+                p_osd->p_state->p_visible->p_current_state->i_height,
+                p_button->p_current_state->p_pic );
+        osd_SetMenuUpdate( p_osd, true );
+        osd_SetMenuVisible( p_osd, true );
+        osd_SetKeyPressed( VLC_OBJECT(p_osd->p_libvlc), config_GetInt( p_osd, p_button->psz_action ) );
+#if defined(OSD_MENU_DEBUG)
+        msg_Dbg( p_osd, "select (%d, %s)", config_GetInt( p_osd, p_button->psz_action ), p_button->psz_action );
+#endif
+    }
+    vlc_object_release( (vlc_object_t*) p_osd );
+    vlc_mutex_unlock( lockval.p_address );
+}
+
+void __osd_MenuNext( vlc_object_t *p_this )
+{
+    osd_menu_t *p_osd = NULL;
+    osd_button_t *p_button = NULL;
+    vlc_value_t lockval;
+
+    p_osd = vlc_object_find( p_this, VLC_OBJECT_OSDMENU, FIND_ANYWHERE );
+    if( p_osd == NULL )
+    {
+        msg_Err( p_this, "osd_MenuNext failed" );
+        return;
+    }
+
+    if( osd_isVisible( p_osd ) == false )
+    {
+        vlc_object_release( (vlc_object_t*) p_osd );
+        return;
+    }
+
+    var_Get( p_this->p_libvlc, "osd_mutex", &lockval );
+    vlc_mutex_lock( lockval.p_address );
+
+    p_button = p_osd->p_state->p_visible;
+    if( p_button )
+    {
+        if( !p_button->b_range )
+            p_button->p_current_state = osd_StateChange( p_button, OSD_BUTTON_UNSELECT );
+        if( p_button->p_next )
+            p_osd->p_state->p_visible = p_button->p_next;
+        else
+            p_osd->p_state->p_visible = p_osd->p_button;
+
+        if( !p_osd->p_state->p_visible->b_range )
+            p_osd->p_state->p_visible->p_current_state =
+                osd_StateChange( p_osd->p_state->p_visible, OSD_BUTTON_SELECT );
+
+        osd_UpdateState( p_osd->p_state,
+                p_osd->p_state->p_visible->i_x, p_osd->p_state->p_visible->i_y,
+                p_osd->p_state->p_visible->p_current_state->i_width,
+                p_osd->p_state->p_visible->p_current_state->i_height,
+                p_osd->p_state->p_visible->p_current_state->p_pic );
+        osd_SetMenuUpdate( p_osd, true );
+    }
+#if defined(OSD_MENU_DEBUG)
+    msg_Dbg( p_osd, "direction right [button %s]", p_osd->p_state->p_visible->psz_action );
+#endif
+
+    vlc_object_release( (vlc_object_t*) p_osd );
+    vlc_mutex_unlock( lockval.p_address );
+}
+
+void __osd_MenuPrev( vlc_object_t *p_this )
+{
+    osd_menu_t *p_osd = NULL;
+    osd_button_t *p_button = NULL;
+    vlc_value_t lockval;
+
+    p_osd = vlc_object_find( p_this, VLC_OBJECT_OSDMENU, FIND_ANYWHERE );
+    if( p_osd == NULL )
+    {
+        msg_Err( p_this, "osd_MenuPrev failed" );
+        return;
+    }
+
+    if( osd_isVisible( p_osd ) == false )
+    {
+        vlc_object_release( (vlc_object_t*) p_osd );
+        return;
+    }
+
+    var_Get( p_this->p_libvlc, "osd_mutex", &lockval );
+    vlc_mutex_lock( lockval.p_address );
+
+    p_button = p_osd->p_state->p_visible;
+    if( p_button )
+    {
+        if( !p_button->b_range )
+            p_button->p_current_state = osd_StateChange( p_button, OSD_BUTTON_UNSELECT );
+        if( p_button->p_prev )
+            p_osd->p_state->p_visible = p_button->p_prev;
+        else
+            p_osd->p_state->p_visible = p_osd->p_last_button;
+
+        if( !p_osd->p_state->p_visible->b_range )
+            p_osd->p_state->p_visible->p_current_state =
+                osd_StateChange( p_osd->p_state->p_visible, OSD_BUTTON_SELECT );
+
+        osd_UpdateState( p_osd->p_state,
+                p_osd->p_state->p_visible->i_x, p_osd->p_state->p_visible->i_y,
+                p_osd->p_state->p_visible->p_current_state->i_width,
+                p_osd->p_state->p_visible->p_current_state->i_height,
+                p_osd->p_state->p_visible->p_current_state->p_pic );
+        osd_SetMenuUpdate( p_osd, true );
+    }
+#if defined(OSD_MENU_DEBUG)
+    msg_Dbg( p_osd, "direction left [button %s]", p_osd->p_state->p_visible->psz_action );
+#endif
+
+    vlc_object_release( (vlc_object_t*) p_osd );
+    vlc_mutex_unlock( lockval.p_address );
+}
+
+void __osd_MenuUp( vlc_object_t *p_this )
+{
+    osd_menu_t *p_osd = NULL;
+    osd_button_t *p_button = NULL;
+    vlc_value_t lockval;
+#if defined(OSD_MENU_DEBUG)
+    vlc_value_t val;
+#endif
+    p_osd = vlc_object_find( p_this, VLC_OBJECT_OSDMENU, FIND_ANYWHERE );
+    if( p_osd == NULL )
+    {
+        msg_Err( p_this, "osd_MenuDown failed" );
+        return;
+    }
+
+    if( osd_isVisible( p_osd ) == false )
+    {
+        vlc_object_release( (vlc_object_t*) p_osd );
+        return;
+    }
+
+    var_Get( p_this->p_libvlc, "osd_mutex", &lockval );
+    vlc_mutex_lock( lockval.p_address );
+
+    p_button = p_osd->p_state->p_visible;
+    if( p_button )
+    {
+        if( !p_button->b_range )
+        {
+            p_button->p_current_state = osd_StateChange( p_button, OSD_BUTTON_SELECT );
+            if( p_button->p_up )
+                p_osd->p_state->p_visible = p_button->p_up;
+        }
+
+        if( p_button->b_range && p_osd->p_state->p_visible->b_range )
+        {
+            osd_state_t *p_temp = p_osd->p_state->p_visible->p_current_state;
+            if( p_temp && p_temp->p_next )
+                p_osd->p_state->p_visible->p_current_state = p_temp->p_next;
+        }
+        else if( !p_osd->p_state->p_visible->b_range )
+        {
+            p_osd->p_state->p_visible->p_current_state =
+                osd_StateChange( p_osd->p_state->p_visible, OSD_BUTTON_SELECT );
+        }
+
+        osd_UpdateState( p_osd->p_state,
+                p_osd->p_state->p_visible->i_x, p_osd->p_state->p_visible->i_y,
+                p_osd->p_state->p_visible->p_current_state->i_width,
+                p_osd->p_state->p_visible->p_current_state->i_height,
+                p_osd->p_state->p_visible->p_current_state->p_pic );
+        osd_SetMenuUpdate( p_osd, true );
+        /* If this is a range style action with associated images of only one state,
+            * then perform "menu select" on every menu navigation
+            */
+        if( p_button->b_range )
+        {
+            osd_SetKeyPressed( VLC_OBJECT(p_osd->p_libvlc), config_GetInt(p_osd, p_button->psz_action) );
+#if defined(OSD_MENU_DEBUG)
+            msg_Dbg( p_osd, "select (%d, %s)", val.i_int, p_button->psz_action );
+#endif
+        }
+    }
+#if defined(OSD_MENU_DEBUG)
+    msg_Dbg( p_osd, "direction up [button %s]", p_osd->p_state->p_visible->psz_action );
+#endif
+
+    vlc_object_release( (vlc_object_t*) p_osd );
+    vlc_mutex_unlock( lockval.p_address );
+}
+
+void __osd_MenuDown( vlc_object_t *p_this )
+{
+    osd_menu_t *p_osd = NULL;
+    osd_button_t *p_button = NULL;
+    vlc_value_t lockval;
+#if defined(OSD_MENU_DEBUG)
+    vlc_value_t val;
+#endif
+
+    p_osd = vlc_object_find( p_this, VLC_OBJECT_OSDMENU, FIND_ANYWHERE );
+    if( p_osd == NULL )
+    {
+        msg_Err( p_this, "osd_MenuDown failed" );
+        return;
+    }
+
+    if( osd_isVisible( p_osd ) == false )
+    {
+        vlc_object_release( (vlc_object_t*) p_osd );
+        return;
+    }
+
+    var_Get( p_this->p_libvlc, "osd_mutex", &lockval );
+    vlc_mutex_lock( lockval.p_address );
+
+    p_button = p_osd->p_state->p_visible;
+    if( p_button )
+    {
+        if( !p_button->b_range )
+        {
+            p_button->p_current_state = osd_StateChange( p_button, OSD_BUTTON_SELECT );
+            if( p_button->p_down )
+                p_osd->p_state->p_visible = p_button->p_down;
+        }
+
+        if( p_button->b_range && p_osd->p_state->p_visible->b_range )
+        {
+            osd_state_t *p_temp = p_osd->p_state->p_visible->p_current_state;
+            if( p_temp && p_temp->p_prev )
+                p_osd->p_state->p_visible->p_current_state = p_temp->p_prev;
+        }
+        else if( !p_osd->p_state->p_visible->b_range )
+        {
+            p_osd->p_state->p_visible->p_current_state =
+                osd_StateChange( p_osd->p_state->p_visible, OSD_BUTTON_SELECT );
+        }
+
+        osd_UpdateState( p_osd->p_state,
+                p_osd->p_state->p_visible->i_x, p_osd->p_state->p_visible->i_y,
+                p_osd->p_state->p_visible->p_current_state->i_width,
+                p_osd->p_state->p_visible->p_current_state->i_height,
+                p_osd->p_state->p_visible->p_current_state->p_pic );
+        osd_SetMenuUpdate( p_osd, true );
+        /* If this is a range style action with associated images of only one state,
+         * then perform "menu select" on every menu navigation
+         */
+        if( p_button->b_range )
+        {
+            osd_SetKeyPressed( VLC_OBJECT(p_osd->p_libvlc), config_GetInt(p_osd, p_button->psz_action_down) );
+#if defined(OSD_MENU_DEBUG)
+            msg_Dbg( p_osd, "select (%d, %s)", val.i_int, p_button->psz_action_down );
+#endif
+        }
+    }
+#if defined(OSD_MENU_DEBUG)
+    msg_Dbg( p_osd, "direction down [button %s]", p_osd->p_state->p_visible->psz_action );
+#endif
+
+    vlc_object_release( (vlc_object_t*) p_osd );
+    vlc_mutex_unlock( lockval.p_address );
+}
+
+static int osd_VolumeStep( vlc_object_t *p_this, int i_volume, int i_steps )
+{
+    int i_volume_step = 0;
+    (void)i_steps;
+
+    i_volume_step = config_GetInt( p_this->p_libvlc, "volume-step" );
+    return (i_volume/i_volume_step);
+}
+
+/**
+ * Display current audio volume bitmap
+ *
+ * The OSD Menu audio volume bar is updated to reflect the new audio volume. Call this function
+ * when the audio volume is updated outside the OSD menu command "menu up", "menu down" or "menu select".
+ */
+void __osd_Volume( vlc_object_t *p_this )
+{
+    osd_menu_t *p_osd = NULL;
+    osd_button_t *p_button = NULL;
+    vlc_value_t lockval;
+    int i_volume = 0;
+    int i_steps = 0;
+
+    p_osd = vlc_object_find( p_this, VLC_OBJECT_OSDMENU, FIND_ANYWHERE );
+    if( p_osd == NULL )
+    {
+        msg_Err( p_this, "OSD menu volume update failed" );
+        return;
+    }
+
+    if( p_osd->p_state && p_osd->p_state->p_volume )
+    {
+        var_Get( p_this->p_libvlc, "osd_mutex", &lockval );
+        vlc_mutex_lock( lockval.p_address );
+
+        p_button = p_osd->p_state->p_volume;
+        if( p_osd->p_state->p_volume )
+            p_osd->p_state->p_visible = p_osd->p_state->p_volume;
+        if( p_button && p_button->b_range )
+        {
+            /* Update the volume state images to match the current volume */
+            i_volume = config_GetInt( p_this, "volume" );
+            i_steps = osd_VolumeStep( p_this, i_volume, p_button->i_ranges );
+            p_button->p_current_state = osd_VolumeStateChange( p_button->p_states, i_steps );
+
+            osd_UpdateState( p_osd->p_state,
+                    p_button->i_x, p_button->i_y,
+                    p_button->p_current_state->i_width,
+                    p_button->p_current_state->i_height,
+                    p_button->p_current_state->p_pic );
+            osd_SetMenuUpdate( p_osd, true );
+            osd_SetMenuVisible( p_osd, true );
+        }
+        vlc_mutex_unlock( lockval.p_address );
+    }
+    vlc_object_release( p_osd );
+}
+
+osd_button_t *__osd_ButtonFind( vlc_object_t *p_this, int i_x, int i_y,
+    int i_window_height, int i_window_width,
+    int i_scale_width, int i_scale_height )
+{
+    osd_menu_t *p_osd;
+    osd_button_t *p_button;
+    vlc_value_t lockval;
+
+    p_osd = vlc_object_find( p_this, VLC_OBJECT_OSDMENU, FIND_ANYWHERE );
+    if( p_osd == NULL )
+    {
+        msg_Err( p_this, "OSD menu button find failed" );
+        return NULL;
+    }
+
+    if( osd_isVisible( p_osd ) == false )
+    {
+        vlc_object_release( (vlc_object_t*) p_osd );
+        return NULL;
+    }
+
+    var_Get( p_this->p_libvlc, "osd_mutex", &lockval );
+    vlc_mutex_lock( lockval.p_address );
+
+    p_button = p_osd->p_button;
+    for( ; p_button != NULL; p_button = p_button->p_next )
+    {
+        int i_source_video_width  = ( i_window_width  * 1000 ) / i_scale_width;
+        int i_source_video_height = ( i_window_height * 1000 ) / i_scale_height;
+        int i_y_offset = p_button->i_y;
+        int i_x_offset = p_button->i_x;
+        int i_width = p_button->i_width;
+        int i_height = p_button->i_height;
+
+        if( p_osd->i_position > 0 )
+        {
+            int i_inv_scale_y = i_source_video_height;
+            int i_inv_scale_x = i_source_video_width;
+            int pi_x = 0;
+
+            if( p_osd->i_position & SUBPICTURE_ALIGN_BOTTOM )
+            {
+                i_y_offset = i_window_height - p_button->i_height -
+                    (p_osd->i_y + p_button->i_y) * i_inv_scale_y / 1000;
+            }
+            else if ( !(p_osd->i_position & SUBPICTURE_ALIGN_TOP) )
+            {
+                i_y_offset = i_window_height / 2 - p_button->i_height / 2;
+            }
+
+            if( p_osd->i_position & SUBPICTURE_ALIGN_RIGHT )
+            {
+                i_x_offset = i_window_width - p_button->i_width -
+                    (pi_x + p_button->i_x)
+                    * i_inv_scale_x / 1000;
+            }
+            else if ( !(p_osd->i_position & SUBPICTURE_ALIGN_LEFT) )
+            {
+                i_x_offset = i_window_width / 2 - p_button->i_width / 2;
+            }
+
+            i_width = i_window_width - p_button->i_width - i_inv_scale_x / 1000;
+            i_height = i_window_height - p_button->i_height - i_inv_scale_y / 1000;
+        }
+
+        // TODO: write for Up / Down case too.
+        // TODO: handle absolute positioning case
+        if( ( i_x >= i_x_offset ) && ( i_x <= i_x_offset + i_width ) &&
+            ( i_y >= i_y_offset ) && ( i_y <= i_y_offset + i_height ) )
+        {
+            vlc_object_release( (vlc_object_t*) p_osd );
+            vlc_mutex_unlock( lockval.p_address );
+            return p_button;
+        }
+    }
+
+    vlc_object_release( (vlc_object_t*) p_osd );
+    vlc_mutex_unlock( lockval.p_address );
+    return NULL;
+}
+
+/**
+ * Select the button provided as the new active button
+ */
+void __osd_ButtonSelect( vlc_object_t *p_this, osd_button_t *p_button )
+{
+    osd_menu_t *p_osd;
+    osd_button_t *p_old;
+    vlc_value_t lockval;
+
+    p_osd = vlc_object_find( p_this, VLC_OBJECT_OSDMENU, FIND_ANYWHERE );
+    if( p_osd == NULL )
+    {
+        msg_Err( p_this, "OSD menu button select failed" );
+        return;
+    }
+
+    if( osd_isVisible( p_osd ) == false )
+    {
+        vlc_object_release( (vlc_object_t*) p_osd );
+        return;
+    }
+
+    var_Get( p_this->p_libvlc, "osd_mutex", &lockval );
+    vlc_mutex_lock( lockval.p_address );
+
+    p_old = p_osd->p_state->p_visible;
+    if( p_old )
+    {
+        if( !p_old->b_range )
+            p_old->p_current_state = osd_StateChange( p_old, OSD_BUTTON_UNSELECT );
+        p_osd->p_state->p_visible = p_button;
+
+        if( !p_osd->p_state->p_visible->b_range )
+            p_osd->p_state->p_visible->p_current_state =
+                osd_StateChange( p_osd->p_state->p_visible, OSD_BUTTON_SELECT );
+
+        osd_UpdateState( p_osd->p_state,
+                p_osd->p_state->p_visible->i_x, p_osd->p_state->p_visible->i_y,
+                p_osd->p_state->p_visible->p_current_state->i_width,
+                p_osd->p_state->p_visible->p_current_state->i_height,
+                p_osd->p_state->p_visible->p_current_state->p_pic );
+        osd_SetMenuUpdate( p_osd, true );
+    }
+#if defined(OSD_MENU_DEBUG)
+    msg_Dbg( p_osd, "button selected is [button %s]", p_osd->p_state->p_visible->psz_action );
+#endif
+
+    vlc_object_release( (vlc_object_t*) p_osd );
+    vlc_mutex_unlock( lockval.p_address );
+}