]> git.sesse.net Git - vlc/blobdiff - modules/video_filter/osdmenu.c
Fix memleak.
[vlc] / modules / video_filter / osdmenu.c
index 52d6266d0b5a5bbe0ff117a30bcc4349ef899c7b..8a492046d74685a09d2da76824d0b3f7f421c81d 100644 (file)
@@ -1,8 +1,8 @@
 /*****************************************************************************
  * osdmenu.c: osd filter module
  *****************************************************************************
- * Copyright (C) 2004-2005 M2X
- * $Id: osdmenu.c 11131 2005-05-23 11:04:07Z hartman $
+ * Copyright (C) 2004-2007 M2X
+ * $Id$
  *
  * Authors: Jean-Paul Saman <jpsaman #_at_# m2x dot nl>
  *
  *
  * 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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
 /*****************************************************************************
  * Preamble
  *****************************************************************************/
-#include <stdlib.h>
-#include <string.h>
-#include <vlc/vlc.h>
-#include <vlc/input.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>
-#include <vlc_video.h>
 
-#include <osd.h>
 #include <vlc_osd.h>
 
 /*****************************************************************************
  *****************************************************************************/
 
 /* FIXME: Future extension make the definition file in XML format. */
-#define OSD_FILE_TEXT N_("OSD menu configuration file")
+#define OSD_FILE_TEXT N_("Configuration file")
 #define OSD_FILE_LONGTEXT N_( \
-    "An OSD menu configuration file that menu actions with button images" )
-
+    "Configuration file for the OSD Menu." )
 #define OSD_PATH_TEXT N_("Path to OSD menu images")
 #define OSD_PATH_LONGTEXT N_( \
-    "Specify another path to the OSD menu images. This will override the path as defined in the " \
+    "Path to the OSD menu images. This will override the path defined in the " \
     "OSD configuration file." )
 
-#define POSX_TEXT N_("X coordinate of the OSD menu")
+#define POSX_TEXT N_("X coordinate")
 #define POSX_LONGTEXT N_("You can move the OSD menu by left-clicking on it." )
 
-#define POSY_TEXT N_("Y coordinate of the OSD menu")
+#define POSY_TEXT N_("Y coordinate")
 #define POSY_LONGTEXT N_("You can move the OSD menu by left-clicking on it." )
 
-#define POS_TEXT N_("OSD menu position")
+#define POS_TEXT N_("Menu position")
 #define POS_LONGTEXT N_( \
   "You can enforce the OSD menu position on the video " \
   "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
-  "also use combinations of these values).")
+  "also use combinations of these values, eg. 6 = top-right).")
 
-#define TIMEOUT_TEXT N_("Timeout of OSD menu")
+#define TIMEOUT_TEXT N_("Menu timeout")
 #define TIMEOUT_LONGTEXT N_( \
-    "OSD menu pictures get a default timeout of 15 seconds added to their remaining time." \
-    "This will ensure that they are at least the specified time visible.")
-
-static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
-static char *ppsz_pos_descriptions[] =
+    "OSD menu pictures get a default timeout of 15 seconds added to their " \
+    "remaining time. This will ensure that they are at least the specified " \
+    "time visible.")
+
+#define OSD_UPDATE_TEXT N_("Menu update interval" )
+#define OSD_UPDATE_LONGTEXT N_( \
+    "The default is to update the OSD menu picture every 200 ms. Shorten the" \
+    " update time for environments that experience transmissions errors. " \
+    "Be careful with this option as encoding OSD menu pictures is very " \
+    "computing intensive. The range is 0 - 1000 ms." )
+
+#define OSD_ALPHA_TEXT N_("Alpha transparency value (default 255)")
+#define OSD_ALPHA_LONGTEXT N_( \
+    "The transparency of the OSD menu can be changed by giving a value " \
+    "between 0 and 255. A lower value specifies more transparency a higher " \
+    "means less transparency. The default is being not transparent " \
+    "(value 255) the minimum is fully transparent (value 0)." )
+
+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") };
 
@@ -75,10 +89,16 @@ static char *ppsz_pos_descriptions[] =
 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 * );                    
+                    vlc_value_t, vlc_value_t, void * );
 static int OSDMenuVisibleEvent( vlc_object_t *, char const *,
                     vlc_value_t, vlc_value_t, void * );
+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-"
 
@@ -88,21 +108,36 @@ static int OSDMenuVisibleEvent( vlc_object_t *, char const *,
 #define OSD_DEFAULT_CFG "share/osdmenu/default.cfg"
 #endif
 
+#define OSD_UPDATE_MIN     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 "position", 8, NULL, POS_TEXT, POS_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,
+                 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 );
-    add_string( OSD_CFG "file-path", NULL, NULL, OSD_PATH_TEXT, OSD_PATH_LONGTEXT, VLC_FALSE );
-    add_integer( OSD_CFG "timeout", 0, NULL, TIMEOUT_TEXT, TIMEOUT_LONGTEXT, VLC_FALSE );
+    add_string( OSD_CFG "file", OSD_DEFAULT_CFG, NULL, OSD_FILE_TEXT,
+        OSD_FILE_LONGTEXT, false );
+    add_string( OSD_CFG "file-path", NULL, NULL, OSD_PATH_TEXT,
+        OSD_PATH_LONGTEXT, false );
+    add_integer( OSD_CFG "timeout", 15, NULL, TIMEOUT_TEXT,
+        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, true );
+    add_integer_with_range( OSD_CFG "alpha", 255, 0, 255, NULL,
+        OSD_ALPHA_TEXT, OSD_ALPHA_LONGTEXT, true );
 
     set_capability( "sub filter", 100 );
-    set_description( N_("On Screen Display menu subfilter") );
+    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();
 
@@ -115,18 +150,28 @@ vlc_module_end();
  *****************************************************************************/
 struct filter_sys_t
 {
-    vlc_mutex_t  lock;
-
-    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 */
-    int          i_timeout;     /* duration SPU object is valid on the video output in seconds */
+    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;
 };
 
 /*****************************************************************************
@@ -135,98 +180,102 @@ struct filter_sys_t
 static int CreateFilter ( vlc_object_t *p_this )
 {
     filter_t *p_filter = (filter_t *)p_this;
-    vlc_value_t val;
-    int posx, posy;
+    filter_sys_t *p_sys = NULL;
 
-    p_filter->p_sys = (filter_sys_t *) malloc( sizeof( filter_sys_t ) );
+    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;
-
-    vlc_mutex_init( p_filter, &p_filter->p_sys->lock );
-
-    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;
     }
 
-    var_Create( p_this, OSD_CFG "position", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
-    var_Get( p_this, OSD_CFG "position", &val );
-    p_filter->p_sys->position = val.i_int;
-    var_Create( p_this, OSD_CFG "x", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
-    var_Get( p_this, OSD_CFG "x", &val );
-    posx = val.i_int;
-    var_Create( p_this, OSD_CFG "y", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
-    var_Get( p_this, OSD_CFG "y", &val );
-    posy = val.i_int;
-    var_Create( p_this, OSD_CFG "timeout", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
-    var_Get( p_this, OSD_CFG "timeout", &val );
-    p_filter->p_sys->i_timeout = val.i_int; /* in seconds */
+    p_sys->i_x = var_CreateGetIntegerCommand( p_this, OSD_CFG "x" );
+    p_sys->i_y = var_CreateGetIntegerCommand( p_this, OSD_CFG "y" );
+    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 */
+    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 );
+    var_AddCallback( p_filter, OSD_CFG "update", OSDMenuCallback, p_sys );
+    var_AddCallback( p_filter, OSD_CFG "alpha", OSDMenuCallback, p_sys );
 
     /* Load the osd menu subsystem */
-    p_filter->p_sys->p_menu = osd_MenuCreate( p_this, p_filter->p_sys->psz_file );
-    if( p_filter->p_sys->p_menu == NULL )
+    p_sys->p_menu = osd_MenuCreate( p_this, p_sys->psz_file );
+    if( p_sys->p_menu == NULL )
         goto error;
 
-    /* Check if menu position was overridden */
-    p_filter->p_sys->b_absolute = VLC_TRUE;
+    p_sys->p_menu->i_position = p_sys->i_position;
 
-    if( posx < 0 || posy < 0)
-    {
-        p_filter->p_sys->b_absolute = VLC_FALSE;
-        p_filter->p_sys->p_menu->i_x = 0;
-        p_filter->p_sys->p_menu->i_y = 0;
-    }
-    else if( posx >= 0 || posy >= 0 )
+    /* Check if menu position was overridden */
+    p_sys->b_absolute = true;
+    if( (p_sys->i_x < 0) || (p_sys->i_y < 0) )
     {
-        p_filter->p_sys->p_menu->i_x = posx;
-        p_filter->p_sys->p_menu->i_y = posy;
+        p_sys->b_absolute = false;
+        p_sys->p_menu->i_x = 0;
+        p_sys->p_menu->i_y = 0;
     }
-    else if( p_filter->p_sys->p_menu->i_x < 0 || p_filter->p_sys->p_menu->i_y < 0 )
+    else
     {
-        p_filter->p_sys->b_absolute = VLC_FALSE;
-        p_filter->p_sys->p_menu->i_x = 0;
-        p_filter->p_sys->p_menu->i_y = 0;
+        p_sys->p_menu->i_x = p_sys->i_x;
+        p_sys->p_menu->i_y = p_sys->i_y;
     }
 
     /* Set up p_filter */
-    p_filter->p_sys->i_last_date = mdate();
+    p_sys->i_last_date = mdate();
 
     /* Keep track of OSD Events */
-    p_filter->p_sys->b_update = VLC_FALSE;
-    p_filter->p_sys->b_visible = VLC_FALSE;
+    p_sys->b_update  = false;
+    p_sys->b_visible = false;
+    p_sys->b_clicked = false;
 
-    var_AddCallback( p_filter->p_sys->p_menu, "osd-menu-update", OSDMenuUpdateEvent, p_filter );        
-    var_AddCallback( p_filter->p_sys->p_menu, "osd-menu-visible", OSDMenuVisibleEvent, p_filter );        
+    /* Listen to osd menu core updates/visible settings. */
+    var_AddCallback( p_sys->p_menu, "osd-menu-update",
+                     OSDMenuUpdateEvent, p_filter );
+    var_AddCallback( p_sys->p_menu, "osd-menu-visible",
+                     OSDMenuVisibleEvent, p_filter );
 
     /* 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" );
-    vlc_mutex_destroy( &p_filter->p_sys->lock );
-    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 );
-    return VLC_EGENERIC;    
+
+    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;
 }
 
 /*****************************************************************************
@@ -237,22 +286,49 @@ static void DestroyFilter( vlc_object_t *p_this )
     filter_t     *p_filter = (filter_t*)p_this;
     filter_sys_t *p_sys = p_filter->p_sys;
 
+    var_DelCallback( p_filter, OSD_CFG "position", OSDMenuCallback, p_sys );
+    var_DelCallback( p_filter, OSD_CFG "timeout", OSDMenuCallback, p_sys );
+    var_DelCallback( p_filter, OSD_CFG "update", OSDMenuCallback, p_sys );
+    var_DelCallback( p_filter, OSD_CFG "alpha", OSDMenuCallback, p_sys );
+
+    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 "position" );
     var_Destroy( p_this, OSD_CFG "timeout" );
+    var_Destroy( p_this, OSD_CFG "update" );
+    var_Destroy( p_this, OSD_CFG "alpha" );
 
-    var_DelCallback( p_sys->p_menu, "osd-menu-update", OSDMenuUpdateEvent, p_filter );
-    var_DelCallback( p_sys->p_menu, "osd-menu-visible", OSDMenuVisibleEvent, p_filter );
-
-    osd_MenuDelete( p_filter, p_sys->p_menu );
-
-    vlc_mutex_destroy( &p_filter->p_sys->lock );
-    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 );
+    }
 }
 
 /*****************************************************************************
@@ -261,18 +337,25 @@ static void DestroyFilter( vlc_object_t *p_this )
 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_sys->b_update = p_sys->b_visible ? true : false;
+    p_sys->i_end_date = (mtime_t) 0;
     return VLC_SUCCESS;
 }
 
@@ -280,7 +363,7 @@ static int OSDMenuUpdateEvent( vlc_object_t *p_this, char const *psz_var,
 /*****************************************************************************
  * 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;
@@ -301,11 +384,11 @@ static subpicture_region_t *create_text_region( filter_t *p_filter, subpicture_t
         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]", 
-        p_region->i_x, p_region->i_y, 
+#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
     return p_region;
@@ -318,7 +401,7 @@ static subpicture_region_t *create_text_region( filter_t *p_filter, subpicture_t
 static subpicture_region_t *create_picture_region( filter_t *p_filter, subpicture_t *p_spu,
     int i_width, int i_height, picture_t *p_pic )
 {
-    subpicture_region_t *p_region;
+    subpicture_region_t *p_region = NULL;
     video_format_t       fmt;
 
     if( !p_spu ) return NULL;
@@ -331,6 +414,7 @@ static subpicture_region_t *create_picture_region( filter_t *p_filter, subpictur
     fmt.i_width = fmt.i_visible_width = i_width;
     fmt.i_height = fmt.i_visible_height = i_height;
     fmt.i_x_offset = fmt.i_y_offset = 0;
+
     p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
     if( !p_region )
     {
@@ -344,11 +428,13 @@ static subpicture_region_t *create_picture_region( filter_t *p_filter, subpictur
         p_region->fmt.i_width = p_region->fmt.i_visible_width = 0;
         p_region->fmt.i_height = p_region->fmt.i_visible_height = 0;
     }
-    if( p_pic != NULL )
+    if( p_pic )
         vout_CopyPicture( p_filter, &p_region->picture, p_pic );
 
     p_region->i_x = 0;
     p_region->i_y = 0;
+    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,
@@ -365,31 +451,54 @@ static subpicture_region_t *create_picture_region( filter_t *p_filter, subpictur
 static subpicture_t *Filter( filter_t *p_filter, mtime_t i_date )
 {
     filter_sys_t *p_sys = p_filter->p_sys;
-    subpicture_t *p_spu;
-    subpicture_region_t *p_region;
+    subpicture_t *p_spu = NULL;
+    subpicture_region_t *p_region = NULL;
 
-    if( !p_filter->p_sys->b_update ) return NULL;
+    if( !p_sys->b_update || (p_sys->i_update <= 0) )
+            return NULL;
 
-    p_filter->p_sys->i_last_date = i_date;
-    p_filter->p_sys->b_update = VLC_FALSE; 
+    /* Am I too early?
+    */
+    if( ( ( p_sys->i_last_date + p_sys->i_update ) > i_date ) &&
+        ( p_sys->i_end_date > 0 ) )
+        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_absolute = p_sys->b_absolute;
-    p_spu->i_start = p_sys->i_last_date = i_date; 
-    p_spu->i_stop = (p_sys->i_timeout == 0) ? 0 : i_date + (mtime_t)(p_sys->i_timeout * 1000000);
-    p_spu->b_ephemer = VLC_TRUE;
-    p_spu->b_fade = VLC_TRUE;
-    p_spu->i_flags = p_sys->position;
-    p_filter->p_sys->b_update = VLC_FALSE; 
+    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 = true;
+    else
+        p_spu->b_absolute = p_sys->b_absolute;
+    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 = false;
+    }
+    else
+    {
+        /* There is a new OSD picture to display */
+        p_spu->i_stop = i_date + p_sys->i_timeout;
+        p_sys->i_end_date = p_spu->i_stop;
+    }
+
+    p_sys->i_last_date = i_date;
+    p_spu->i_start = p_sys->i_last_date = i_date;
 
     /* Send an empty subpicture to clear the display
      * 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,
@@ -401,24 +510,208 @@ static subpicture_t *Filter( filter_t *p_filter, mtime_t i_date )
         p_spu->i_x = p_filter->p_sys->p_menu->p_state->i_x;
         p_spu->i_y = p_filter->p_sys->p_menu->p_state->i_y;
         p_spu->p_region = p_region;
-        p_spu->i_alpha = 0xFF; /* Picture is completely transparent. */
+        p_spu->i_alpha = 0xFF; /* Picture is completely non transparent. */
         return p_spu;
     }
 
-    /* Create new spu regions */
+    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,
         p_filter->p_sys->p_menu->p_state->i_width,
         p_filter->p_sys->p_menu->p_state->i_height,
         p_filter->p_sys->p_menu->p_state->p_pic );
+
+    if( !p_region )
+    {
+        p_filter->pf_sub_buffer_del( p_filter, p_spu );
+        return NULL;
+    }
+
+    p_spu->i_width = p_region->fmt.i_visible_width;
+    p_spu->i_height = p_region->fmt.i_visible_height;
+    p_spu->i_alpha = p_filter->p_sys->i_alpha;
+
+    /* proper positioning of OSD menu image */
+    if( p_filter->p_sys->p_menu->i_style == OSD_MENU_STYLE_CONCAT )
+    {
+        p_spu->i_x = p_filter->p_sys->p_menu->p_button->i_x;
+        p_spu->i_y = p_filter->p_sys->p_menu->p_button->i_y;
+    }
+    else
+    {
+        p_spu->i_x = p_filter->p_sys->p_menu->p_state->i_x;
+        p_spu->i_y = p_filter->p_sys->p_menu->p_state->i_y;
+    }
+
+    if( p_filter->p_sys->p_menu->i_style == OSD_MENU_STYLE_CONCAT )
+    {
+        subpicture_region_t *p_region_list = NULL;
+        subpicture_region_t *p_region_tail = NULL;
+        osd_menu_t *p_osd = p_filter->p_sys->p_menu;
+        osd_button_t *p_button = p_osd->p_button;
+
+        /* Construct the entire OSD from individual images */
+        while( p_button != NULL )
+        {
+            osd_button_t *p_tmp = NULL;
+            subpicture_region_t *p_new = NULL;
+
+            p_new = create_picture_region( p_filter, p_spu,
+                    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->p_pic );
+            if( !p_new )
+            {
+                /* Cleanup when bailing out */
+                subpicture_region_t *p_tmp = NULL;
+                while( p_region_list )
+                {
+                    p_tmp = p_region_list->p_next;
+                    p_spu->pf_destroy_region( VLC_OBJECT(p_filter), p_region_list );
+                };
+                p_spu->pf_destroy_region( VLC_OBJECT(p_filter), p_region );
+                p_filter->pf_sub_buffer_del( p_filter, p_spu );
+                return NULL;
+            }
+
+            p_spu->i_width += p_new->fmt.i_visible_width;
+            p_spu->i_height += p_new->fmt.i_visible_height;
+
+            if( !p_region_list )
+            {
+                p_region_list = p_new;
+                p_region_tail = p_new;
+            }
+            else
+            {
+                p_new->i_x = p_region_tail->fmt.i_visible_width;
+                p_new->i_y = p_button->i_y;
+                p_region_tail->p_next = p_new;
+                p_region_tail = p_new;
+            }
+            p_tmp = p_button->p_next;
+            p_button = p_tmp;
+        };
+        p_region->p_next = p_region_list;
+    }
 #if 0
     p_region->p_next = create_text_region( p_filter, p_spu,
         p_filter->p_sys->p_menu->p_state->i_width, p_filter->p_sys->p_menu->p_state->i_height,
         p_filter->p_sys->p_menu->p_state->p_visible->psz_action );
 #endif
-
-    /* proper positioning of OSD menu image */
-    p_spu->i_x = p_filter->p_sys->p_menu->p_state->i_x;
-    p_spu->i_y = p_filter->p_sys->p_menu->p_state->i_y;
     p_spu->p_region = p_region;
     return p_spu;
 }
+
+static int OSDMenuCallback( 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(oldval);
+    filter_sys_t *p_sys = (filter_sys_t *) p_data;
+
+    if( !p_sys )
+        return VLC_SUCCESS;
+
+    if( !strncmp( psz_var, OSD_CFG"position", 16) )
+    {
+#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
+        unsigned int i;
+        for( i=0; i < ARRAY_SIZE(pi_pos_values); i++ )
+        {
+            if( newval.i_int == pi_pos_values[i] )
+            {
+                p_sys->i_position = newval.i_int % 11;
+                break;
+            }
+        }
+#undef ARRAY_SIZE
+    }
+    else if( !strncmp( psz_var, OSD_CFG"x", 9) ||
+             !strncmp( psz_var, OSD_CFG"y", 9))
+    {
+        p_sys->b_absolute = true;
+        if( (p_sys->i_x < 0) || (p_sys->i_y < 0) )
+        {
+            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) )
+        {
+            p_sys->p_menu->i_x = p_sys->i_x;
+            p_sys->p_menu->i_y = p_sys->i_y;
+        }
+    }
+    else if( !strncmp( psz_var, OSD_CFG"update", 14) )
+        p_sys->i_update =  (mtime_t)(newval.i_int * 1000);
+    else if( !strncmp( psz_var, OSD_CFG"timeout", 15) )
+        p_sys->i_update = newval.i_int % 1000;
+    else if( !strncmp( psz_var, OSD_CFG"alpha", 13) )
+        p_sys->i_alpha = newval.i_int % 256;
+
+    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;
+}