/*****************************************************************************
* osd.c - The OSD Menu core code.
*****************************************************************************
- * Copyright (C) 2005 M2X
+ * Copyright (C) 2005-2007 M2X
* $Id$
*
* Authors: Jean-Paul Saman <jpsaman #_at_# m2x dot nl>
/*****************************************************************************
* Preamble
*****************************************************************************/
-#include <stdlib.h>
-#include <string.h>
-#include <vlc/vlc.h>
+#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 vlc_bool_t osd_isVisible( osd_menu_t *p_osd );
+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 vlc_bool_t osd_isVisible( osd_menu_t *p_osd )
+static bool osd_isVisible( osd_menu_t *p_osd )
{
vlc_value_t 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
*****************************************************************************/
{
vlc_value_t val;
- msg_Dbg( p_this, "creating OSD menu object" );
- if( ( p_osd = vlc_object_create( p_this, VLC_OBJECT_OSDMENU ) ) == NULL )
- {
- msg_Err( p_this, "out of memory" );
- vlc_mutex_unlock( lockval.p_address );
- return NULL;
- }
-
/* Parse configuration file */
- if( osd_ConfigLoader( p_this, psz_file, &p_osd ) )
+ 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->p_states, OSD_BUTTON_SELECT );
+ 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;
osd_UpdateState( p_osd->p_state, p_osd->i_x, p_osd->i_y,
p_osd->i_width, p_osd->i_height, NULL );
- vlc_object_yield( p_osd );
- vlc_object_attach( p_osd, p_this->p_libvlc );
-
/* 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 = VLC_FALSE;
+ val.b_bool = false;
var_Set( p_osd, "osd-menu-update", val );
var_Set( p_osd, "osd-menu-visible", val );
}
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 );
- vlc_object_destroy( p_osd );
return NULL;
}
vlc_mutex_lock( lockval.p_address );
vlc_object_release( p_osd );
- if( p_osd->i_refcount > 0 )
+ 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_ConfigUnload( p_this, &p_osd );
- vlc_object_detach( p_osd );
- vlc_object_destroy( p_osd );
+ osd_ParserUnload( p_osd );
p_osd = NULL;
-
vlc_mutex_unlock( lockval.p_address );
}
-osd_state_t *__osd_StateChange( osd_state_t *p_states, const int i_state )
-{
- osd_state_t *p_current = 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 )
- return p_current;
- p_temp = p_current->p_next;
- p_current = p_temp;
- }
- return p_states;
-}
-
-/* The volume can be modified in another interface while the OSD Menu
+/* 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.
*/
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->p_states, OSD_BUTTON_UNSELECT );
+ 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->p_states, OSD_BUTTON_SELECT );
+ 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->p_pic->p[Y_PLANE].i_visible_pitch,
- p_osd->p_state->p_visible->p_current_state->p_pic->p[Y_PLANE].i_visible_lines,
+ 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, VLC_TRUE );
+ osd_SetMenuUpdate( p_osd, true );
}
- osd_SetMenuVisible( p_osd, VLC_TRUE );
+ osd_SetMenuVisible( p_osd, true );
vlc_object_release( (vlc_object_t*) p_osd );
vlc_mutex_unlock( lockval.p_address );
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, VLC_TRUE );
+ osd_SetMenuUpdate( p_osd, true );
vlc_object_release( (vlc_object_t*) p_osd );
vlc_mutex_unlock( lockval.p_address );
return;
}
- if( osd_isVisible( p_osd ) == VLC_FALSE )
+ if( osd_isVisible( p_osd ) == false )
{
vlc_object_release( (vlc_object_t*) p_osd );
return;
if( p_button && !p_button->b_range )
{
- p_button->p_current_state = osd_StateChange( p_button->p_states, OSD_BUTTON_PRESSED );
+ 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->p_pic->p[Y_PLANE].i_visible_pitch,
- p_osd->p_state->p_visible->p_current_state->p_pic->p[Y_PLANE].i_visible_lines,
+ 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, VLC_TRUE );
- osd_SetMenuVisible( p_osd, VLC_TRUE );
+ 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 );
return;
}
- if( osd_isVisible( p_osd ) == VLC_FALSE )
+ if( osd_isVisible( p_osd ) == false )
{
vlc_object_release( (vlc_object_t*) p_osd );
return;
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->p_states, OSD_BUTTON_UNSELECT );
+ 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
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->p_states, OSD_BUTTON_SELECT );
+ 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->p_pic->p[Y_PLANE].i_visible_pitch,
- p_osd->p_state->p_visible->p_current_state->p_pic->p[Y_PLANE].i_visible_lines,
+ 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, VLC_TRUE );
+ 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 );
return;
}
- if( osd_isVisible( p_osd ) == VLC_FALSE )
+ if( osd_isVisible( p_osd ) == false )
{
vlc_object_release( (vlc_object_t*) p_osd );
return;
if( p_button )
{
if( !p_button->b_range )
- p_button->p_current_state = osd_StateChange( p_button->p_states, OSD_BUTTON_UNSELECT );
+ 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
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->p_states, OSD_BUTTON_SELECT );
+ 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->p_pic->p[Y_PLANE].i_visible_pitch,
- p_osd->p_state->p_visible->p_current_state->p_pic->p[Y_PLANE].i_visible_lines,
+ 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, VLC_TRUE );
+ 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 );
return;
}
- if( osd_isVisible( p_osd ) == VLC_FALSE )
+ if( osd_isVisible( p_osd ) == false )
{
vlc_object_release( (vlc_object_t*) p_osd );
return;
{
if( !p_button->b_range )
{
- p_button->p_current_state = osd_StateChange( p_button->p_states, OSD_BUTTON_SELECT );
+ 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;
}
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->p_states, OSD_BUTTON_SELECT );
+ 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->p_pic->p[Y_PLANE].i_visible_pitch,
- p_osd->p_state->p_visible->p_current_state->p_pic->p[Y_PLANE].i_visible_lines,
+ 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, VLC_TRUE );
- /* If this is a range style action with associated images of only one state,
+ 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 )
return;
}
- if( osd_isVisible( p_osd ) == VLC_FALSE )
+ if( osd_isVisible( p_osd ) == false )
{
vlc_object_release( (vlc_object_t*) p_osd );
return;
{
if( !p_button->b_range )
{
- p_button->p_current_state = osd_StateChange( p_button->p_states, OSD_BUTTON_SELECT );
+ 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;
}
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->p_states, OSD_BUTTON_SELECT );
+ 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->p_pic->p[Y_PLANE].i_visible_pitch,
- p_osd->p_state->p_visible->p_current_state->p_pic->p[Y_PLANE].i_visible_lines,
+ 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, VLC_TRUE );
+ 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 defined(OSD_MENU_DEBUG)
- msg_Dbg( p_osd, "direction down [button %s]", p_osd->p_state->p_visible->psz_action );
+ 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 );
osd_UpdateState( p_osd->p_state,
p_button->i_x, p_button->i_y,
- p_button->p_current_state->p_pic->p[Y_PLANE].i_visible_pitch,
- p_button->p_current_state->p_pic->p[Y_PLANE].i_visible_lines,
+ 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, VLC_TRUE );
- osd_SetMenuVisible( p_osd, VLC_TRUE );
+ osd_SetMenuUpdate( p_osd, true );
+ osd_SetMenuVisible( p_osd, true );
}
- vlc_object_release( (vlc_object_t*) p_osd );
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 );
}