/*****************************************************************************
* 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_plugin.h>
#include <vlc_vout.h>
#include <vlc_filter.h>
"means less transparency. The default is being not transparent " \
"(value 255) the minimum is fully transparent (value 0)." )
-static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
-static const char *ppsz_pos_descriptions[] =
+static const int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
+static const char *const ppsz_pos_descriptions[] =
{ N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
static int CreateFilter ( vlc_object_t * );
static void DestroyFilter( vlc_object_t * );
static subpicture_t *Filter( filter_t *, mtime_t );
+
static int OSDMenuUpdateEvent( vlc_object_t *, char const *,
vlc_value_t, vlc_value_t, void * );
static int OSDMenuVisibleEvent( vlc_object_t *, char const *,
static int OSDMenuCallback( vlc_object_t *, char const *,
vlc_value_t, vlc_value_t, void * );
+static int MouseEvent( vlc_object_t *, char const *,
+ vlc_value_t , vlc_value_t , void * );
+
#define OSD_CFG "osdmenu-"
#if defined( WIN32 ) || defined( UNDER_CE )
#endif
#define OSD_UPDATE_MIN 0
-#define OSD_UPDATE_DEFAULT 0
+#define OSD_UPDATE_DEFAULT 300
#define OSD_UPDATE_MAX 1000
vlc_module_begin();
- add_integer( OSD_CFG "x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_FALSE );
- add_integer( OSD_CFG "y", -1, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_FALSE );
+ add_integer( OSD_CFG "x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, false );
+ add_integer( OSD_CFG "y", -1, NULL, POSY_TEXT, POSY_LONGTEXT, false );
add_integer( OSD_CFG "position", 8, NULL, POS_TEXT, POS_LONGTEXT,
- VLC_FALSE );
+ false );
change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
add_string( OSD_CFG "file", OSD_DEFAULT_CFG, NULL, OSD_FILE_TEXT,
- OSD_FILE_LONGTEXT, VLC_FALSE );
+ OSD_FILE_LONGTEXT, false );
add_string( OSD_CFG "file-path", NULL, NULL, OSD_PATH_TEXT,
- OSD_PATH_LONGTEXT, VLC_FALSE );
+ OSD_PATH_LONGTEXT, false );
add_integer( OSD_CFG "timeout", 15, NULL, TIMEOUT_TEXT,
- TIMEOUT_LONGTEXT, VLC_FALSE );
+ TIMEOUT_LONGTEXT, false );
add_integer_with_range( OSD_CFG "update", OSD_UPDATE_DEFAULT,
OSD_UPDATE_MIN, OSD_UPDATE_MAX, NULL, OSD_UPDATE_TEXT,
- OSD_UPDATE_LONGTEXT, VLC_TRUE );
-
+ OSD_UPDATE_LONGTEXT, true );
add_integer_with_range( OSD_CFG "alpha", 255, 0, 255, NULL,
- OSD_ALPHA_TEXT, OSD_ALPHA_LONGTEXT, VLC_TRUE );
+ OSD_ALPHA_TEXT, OSD_ALPHA_LONGTEXT, true );
set_capability( "sub filter", 100 );
- set_description( _("On Screen Display menu") );
- set_shortname( _("OSD menu") );
+ set_description( N_("On Screen Display menu") );
+ set_shortname( N_("OSD menu") );
add_shortcut( "osdmenu" );
-/*
+
set_category( CAT_VIDEO );
set_subcategory( SUBCAT_VIDEO_SUBPIC );
-*/
+
set_callbacks( CreateFilter, DestroyFilter );
vlc_module_end();
*****************************************************************************/
struct filter_sys_t
{
- int position; /* relative positioning of SPU images */
+ int i_position; /* relative positioning of SPU images */
int i_x; /* absolute positioning of SPU images */
int i_y; /* absolute positioning of SPU images */
mtime_t i_last_date; /* last mdate SPU object has been sent to SPU subsytem */
mtime_t i_timeout; /* duration SPU object is valid on the video output in seconds */
- vlc_bool_t b_absolute; /* do we use absolute positioning or relative? */
- vlc_bool_t b_update; /* Update OSD Menu by sending SPU objects */
- vlc_bool_t b_visible; /* OSD Menu is visible */
+ bool b_absolute; /* do we use absolute positioning or relative? */
+ bool b_update; /* Update OSD Menu by sending SPU objects */
+ bool b_visible; /* OSD Menu is visible */
mtime_t i_update; /* Update the OSD menu every n ms */
mtime_t i_end_date; /* End data of display OSD menu */
int i_alpha; /* alpha transparency value */
char *psz_file; /* OSD Menu configuration file */
+ char *psz_path; /* Path to OSD Menu pictures */
osd_menu_t *p_menu; /* pointer to OSD Menu object */
+
+ /* menu interaction */
+ vout_thread_t *p_vout;
+ bool b_clicked;
+ uint32_t i_mouse_x;
+ uint32_t i_mouse_y;
};
/*****************************************************************************
{
filter_t *p_filter = (filter_t *)p_this;
filter_sys_t *p_sys = NULL;
- vlc_value_t val;
p_filter->p_sys = p_sys = (filter_sys_t *) malloc( sizeof(filter_sys_t) );
if( !p_filter->p_sys )
- {
- msg_Err( p_filter, "out of memory" );
return VLC_ENOMEM;
- }
memset( p_sys, 0, sizeof(filter_sys_t) );
/* Populating struct */
- p_filter->p_sys->p_menu = NULL;
- p_filter->p_sys->psz_file = NULL;
-
- p_filter->p_sys->psz_file = config_GetPsz( p_filter, OSD_CFG "file" );
- if( (p_filter->p_sys->psz_file == NULL) ||
- (*p_filter->p_sys->psz_file == '\0') )
+ p_sys->psz_path = var_CreateGetString( p_this, OSD_CFG "file-path" );
+ p_sys->psz_file = var_CreateGetString( p_this, OSD_CFG "file" );
+ if( (p_sys->psz_file == NULL) ||
+ (*p_sys->psz_file == '\0') )
{
msg_Err( p_filter, "unable to get filename" );
goto error;
p_sys->i_x = var_CreateGetIntegerCommand( p_this, OSD_CFG "x" );
p_sys->i_y = var_CreateGetIntegerCommand( p_this, OSD_CFG "y" );
- p_sys->position = var_CreateGetIntegerCommand( p_this, OSD_CFG "position" );
+ p_sys->i_position = var_CreateGetIntegerCommand( p_this, OSD_CFG "position" );
p_sys->i_alpha = var_CreateGetIntegerCommand( p_this, OSD_CFG "alpha" );
/* in micro seconds - divide by 2 to match user expectations */
- var_Create( p_this, OSD_CFG "timeout",
- VLC_VAR_INTEGER | VLC_VAR_DOINHERIT | VLC_VAR_ISCOMMAND );
- var_Get( p_this, OSD_CFG "timeout", &val );
- p_sys->i_timeout = (mtime_t)(val.i_int * 1000000) >> 2;
- var_Create( p_this, OSD_CFG "update",
- VLC_VAR_INTEGER | VLC_VAR_DOINHERIT | VLC_VAR_ISCOMMAND );
- var_Get( p_this, OSD_CFG "update", &val );
- p_sys->i_update = (mtime_t)(val.i_int * 1000); /* in micro seconds */
+ p_sys->i_timeout = var_CreateGetIntegerCommand( p_this, OSD_CFG "timeout" );
+ p_sys->i_timeout = (mtime_t)(p_sys->i_timeout * 1000000) >> 2;
+ p_sys->i_update = var_CreateGetIntegerCommand( p_this, OSD_CFG "update" );
+ p_sys->i_update = (mtime_t)(p_sys->i_update * 1000); /* in micro seconds */
var_AddCallback( p_filter, OSD_CFG "position", OSDMenuCallback, p_sys );
var_AddCallback( p_filter, OSD_CFG "timeout", OSDMenuCallback, p_sys );
if( p_sys->p_menu == NULL )
goto error;
+ p_sys->p_menu->i_position = p_sys->i_position;
+
/* Check if menu position was overridden */
- p_sys->b_absolute = VLC_TRUE;
+ p_sys->b_absolute = true;
if( (p_sys->i_x < 0) || (p_sys->i_y < 0) )
{
- p_sys->b_absolute = VLC_FALSE;
+ p_sys->b_absolute = false;
p_sys->p_menu->i_x = 0;
p_sys->p_menu->i_y = 0;
}
- else if( (p_sys->i_x >= 0) || (p_sys->i_y >= 0) )
+ else
{
p_sys->p_menu->i_x = p_sys->i_x;
p_sys->p_menu->i_y = p_sys->i_y;
}
- else if( (p_sys->p_menu->i_x < 0) ||
- (p_sys->p_menu->i_y < 0) )
- {
- p_sys->b_absolute = VLC_FALSE;
- p_sys->p_menu->i_x = 0;
- p_sys->p_menu->i_y = 0;
- }
/* Set up p_filter */
p_sys->i_last_date = mdate();
/* Keep track of OSD Events */
- p_sys->b_update = VLC_FALSE;
- p_sys->b_visible = VLC_FALSE;
+ p_sys->b_update = false;
+ p_sys->b_visible = false;
+ p_sys->b_clicked = false;
/* Listen to osd menu core updates/visible settings. */
var_AddCallback( p_sys->p_menu, "osd-menu-update",
/* Attach subpicture filter callback */
p_filter->pf_sub_filter = Filter;
+ p_sys->p_vout = vlc_object_find( p_this, VLC_OBJECT_VOUT, FIND_ANYWHERE );
+ if( p_sys->p_vout )
+ {
+ var_AddCallback( p_sys->p_vout, "mouse-x",
+ MouseEvent, p_sys );
+ var_AddCallback( p_sys->p_vout, "mouse-y",
+ MouseEvent, p_sys );
+ var_AddCallback( p_sys->p_vout, "mouse-clicked",
+ MouseEvent, p_sys );
+ }
+
es_format_Init( &p_filter->fmt_out, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
p_filter->fmt_out.i_priority = 0;
- msg_Dbg( p_filter, "successfully loaded osdmenu filter" );
return VLC_SUCCESS;
error:
msg_Err( p_filter, "osdmenu filter discarded" );
- if( p_filter->p_sys->p_menu )
- {
- osd_MenuDelete( p_this, p_filter->p_sys->p_menu );
- p_filter->p_sys->p_menu = NULL;
- }
- if( p_filter->p_sys->psz_file ) free( p_filter->p_sys->psz_file );
- if( p_filter->p_sys ) free( p_filter->p_sys );
+
+ osd_MenuDelete( p_this, p_sys->p_menu );
+ p_sys->p_menu = NULL;
+ free( p_sys->psz_path );
+ free( p_sys->psz_file );
+ free( p_sys );
return VLC_EGENERIC;
}
var_DelCallback( p_filter, OSD_CFG "update", OSDMenuCallback, p_sys );
var_DelCallback( p_filter, OSD_CFG "alpha", OSDMenuCallback, p_sys );
- var_DelCallback( p_sys->p_menu, "osd-menu-update",
- OSDMenuUpdateEvent, p_filter );
- var_DelCallback( p_sys->p_menu, "osd-menu-visible",
- OSDMenuVisibleEvent, p_filter );
+ if( p_sys )
+ {
+ var_DelCallback( p_sys->p_menu, "osd-menu-update",
+ OSDMenuUpdateEvent, p_filter );
+ var_DelCallback( p_sys->p_menu, "osd-menu-visible",
+ OSDMenuVisibleEvent, p_filter );
+ }
+ if( p_sys && p_sys->p_vout )
+ {
+ var_DelCallback( p_sys->p_vout, "mouse-x",
+ MouseEvent, p_sys );
+ var_DelCallback( p_sys->p_vout, "mouse-y",
+ MouseEvent, p_sys );
+ var_DelCallback( p_sys->p_vout, "mouse-clicked",
+ MouseEvent, p_sys );
+
+ vlc_object_release( p_sys->p_vout );
+ p_sys->p_vout = NULL;
+ }
+
+ var_Destroy( p_this, OSD_CFG "file-path" );
var_Destroy( p_this, OSD_CFG "file" );
var_Destroy( p_this, OSD_CFG "x" );
var_Destroy( p_this, OSD_CFG "y" );
var_Destroy( p_this, OSD_CFG "update" );
var_Destroy( p_this, OSD_CFG "alpha" );
- osd_MenuDelete( p_filter, p_sys->p_menu );
-
- if( p_sys->psz_file) free( p_sys->psz_file );
- if( p_sys ) free( p_sys );
+ if( p_sys )
+ {
+ osd_MenuDelete( p_filter, p_sys->p_menu );
- msg_Dbg( p_filter, "osdmenu filter destroyed" );
+ free( p_sys->psz_path );
+ free( p_sys->psz_file );
+ free( p_sys );
+ }
}
/*****************************************************************************
static int OSDMenuVisibleEvent( vlc_object_t *p_this, char const *psz_var,
vlc_value_t oldval, vlc_value_t newval, void *p_data )
{
+ VLC_UNUSED(p_this); VLC_UNUSED(psz_var); VLC_UNUSED(oldval);
+ VLC_UNUSED(newval);
filter_t *p_filter = (filter_t *) p_data;
- p_filter->p_sys->b_visible = VLC_TRUE;
+ p_filter->p_sys->b_visible = true;
+ p_filter->p_sys->b_update = true;
return VLC_SUCCESS;
}
static int OSDMenuUpdateEvent( vlc_object_t *p_this, char const *psz_var,
vlc_value_t oldval, vlc_value_t newval, void *p_data )
{
+ VLC_UNUSED(p_this); VLC_UNUSED(psz_var); VLC_UNUSED(oldval);
+ VLC_UNUSED(newval);
filter_t *p_filter = (filter_t *) p_data;
+ filter_sys_t *p_sys = p_filter->p_sys;
- p_filter->p_sys->b_update = VLC_TRUE;
- p_filter->p_sys->i_end_date = (mtime_t) 0;
+ p_sys->b_update = p_sys->b_visible ? true : false;
+ p_sys->i_end_date = (mtime_t) 0;
return VLC_SUCCESS;
}
/*****************************************************************************
* create_text_region : compose a text region SPU
*****************************************************************************/
-static subpicture_region_t *create_text_region( filter_t *p_filter, subpicture_t *p_spu,
+static subpicture_region_t *create_text_region( filter_t *p_filter, subpicture_t *p_spu,
int i_width, int i_height, const char *psz_text )
{
subpicture_region_t *p_region;
return NULL;
}
p_region->psz_text = strdup( psz_text );
- p_region->i_x = 0;
+ p_region->i_x = 0;
p_region->i_y = 40;
-#if 1
- msg_Dbg( p_filter, "SPU text region position (%d,%d) (%d,%d) [%s]",
+#if 0
+ msg_Dbg( p_filter, "SPU text region position (%d,%d) (%d,%d) [%s]",
p_region->i_x, p_region->i_y,
p_region->fmt.i_width, p_region->fmt.i_height, p_region->psz_text );
#endif
p_region->i_x = 0;
p_region->i_y = 0;
- p_region->i_align = SUBPICTURE_ALIGN_LEFT;
+ p_region->i_align = p_filter->p_sys->i_position;
+ p_region->i_alpha = p_filter->p_sys->i_alpha;
#if 0
msg_Dbg( p_filter, "SPU picture region position (%d,%d) (%d,%d) [%p]",
p_region->i_x, p_region->i_y,
return NULL; /* we are too early, so wait */
/* Allocate the subpicture internal data. */
- p_spu = p_filter->pf_sub_buffer_new( p_filter );
- if( !p_spu ) return NULL;
+ p_spu = filter_NewSubpicture( p_filter );
+ if( !p_spu )
+ return NULL;
- p_spu->b_ephemer = VLC_TRUE;
- p_spu->b_fade = VLC_TRUE;
+ p_spu->b_ephemer = true;
+ p_spu->b_fade = true;
if( p_filter->p_sys->p_menu->i_style == OSD_MENU_STYLE_CONCAT )
- p_spu->b_absolute = VLC_TRUE;
+ p_spu->b_absolute = true;
else
p_spu->b_absolute = p_sys->b_absolute;
- p_spu->i_flags = p_sys->position;
+ p_spu->i_flags = p_sys->i_position;
/* Determine the duration of the subpicture */
if( p_sys->i_end_date > 0 )
/* Display the subpicture again. */
p_spu->i_stop = p_sys->i_end_date - i_date;
if( ( i_date + p_sys->i_update ) >= p_sys->i_end_date )
- p_sys->b_update = VLC_FALSE;
+ p_sys->b_update = false;
}
else
{
* when OSD menu should be hidden and menu picture is not allocated.
*/
if( !p_filter->p_sys->p_menu->p_state->p_pic ||
- ( p_filter->p_sys->b_visible == VLC_FALSE ) )
+ ( p_filter->p_sys->b_visible == false ) )
{
/* Create new spu regions and allocate an empty picture in it. */
p_region = create_picture_region( p_filter, p_spu,
return p_spu;
}
+ if( p_sys->p_vout && p_sys->b_clicked )
+ {
+ p_sys->b_clicked = false;
+ osd_MenuActivate( p_filter );
+ }
/* Create new spu regions
*/
p_region = create_picture_region( p_filter, p_spu,
vlc_value_t oldval, vlc_value_t newval,
void *p_data )
{
+ VLC_UNUSED(p_this); VLC_UNUSED(oldval);
filter_sys_t *p_sys = (filter_sys_t *) p_data;
if( !p_sys )
{
if( newval.i_int == pi_pos_values[i] )
{
- p_sys->position = newval.i_int % 11;
+ p_sys->i_position = newval.i_int % 11;
break;
}
}
else if( !strncmp( psz_var, OSD_CFG"x", 9) ||
!strncmp( psz_var, OSD_CFG"y", 9))
{
- p_sys->b_absolute = VLC_TRUE;
+ p_sys->b_absolute = true;
if( (p_sys->i_x < 0) || (p_sys->i_y < 0) )
{
- p_sys->b_absolute = VLC_FALSE;
+ p_sys->b_absolute = false;
p_sys->p_menu->i_x = 0;
p_sys->p_menu->i_y = 0;
}
else if( !strncmp( psz_var, OSD_CFG"alpha", 13) )
p_sys->i_alpha = newval.i_int % 256;
- p_sys->b_update = VLC_TRUE;
+ p_sys->b_update = p_sys->b_visible ? true : false;
+ return VLC_SUCCESS;
+}
+
+/*****************************************************************************
+ * MouseEvent: callback for mouse events
+ *****************************************************************************/
+static int MouseEvent( vlc_object_t *p_this, char const *psz_var,
+ vlc_value_t oldval, vlc_value_t newval, void *p_data )
+{
+ VLC_UNUSED(oldval); VLC_UNUSED(newval);
+ filter_sys_t *p_sys = (filter_sys_t *)p_data;
+ vout_thread_t *p_vout = (vout_thread_t*)p_sys->p_vout;
+ int i_x, i_y;
+ int i_v;
+
+#define MOUSE_DOWN 1
+#define MOUSE_CLICKED 2
+#define MOUSE_MOVE_X 4
+#define MOUSE_MOVE_Y 8
+#define MOUSE_MOVE 12
+ uint8_t mouse= 0;
+
+ int v_h = p_vout->output.i_height;
+ int v_w = p_vout->output.i_width;
+
+ if( psz_var[6] == 'x' ) mouse |= MOUSE_MOVE_X;
+ if( psz_var[6] == 'y' ) mouse |= MOUSE_MOVE_Y;
+ if( psz_var[6] == 'c' ) mouse |= MOUSE_CLICKED;
+
+ i_v = var_GetInteger( p_sys->p_vout, "mouse-button-down" );
+ if( i_v & 0x1 ) mouse |= MOUSE_DOWN;
+ i_y = var_GetInteger( p_sys->p_vout, "mouse-y" );
+ i_x = var_GetInteger( p_sys->p_vout, "mouse-x" );
+
+ if( i_y < 0 || i_x < 0 || i_y >= v_h || i_x >= v_w )
+ return VLC_SUCCESS;
+
+ if( mouse & MOUSE_CLICKED )
+ {
+ int i_scale_width, i_scale_height;
+ osd_button_t *p_button = NULL;
+
+ i_scale_width = p_vout->fmt_out.i_visible_width * 1000 /
+ p_vout->fmt_in.i_visible_width;
+ i_scale_height = p_vout->fmt_out.i_visible_height * 1000 /
+ p_vout->fmt_in.i_visible_height;
+
+ p_button = osd_ButtonFind( p_this, i_x, i_y, v_h, v_w,
+ i_scale_width, i_scale_height );
+ if( p_button )
+ {
+ osd_ButtonSelect( p_this, p_button );
+ p_sys->b_update = p_sys->b_visible ? true : false;
+ p_sys->b_clicked = true;
+ msg_Dbg( p_this, "mouse clicked %s (%d,%d)\n", p_button->psz_name, i_x, i_y );
+ }
+ }
return VLC_SUCCESS;
}