]> git.sesse.net Git - vlc/blobdiff - modules/video_filter/osdmenu.c
Use var_InheritString for --decklink-video-connection.
[vlc] / modules / video_filter / osdmenu.c
index 8a492046d74685a09d2da76824d0b3f7f421c81d..01560d9b25dbf6e51a55ec6ecee93bbcbf7736d7 100644 (file)
@@ -30,7 +30,6 @@
 
 #include <vlc_common.h>
 #include <vlc_plugin.h>
-#include <vlc_vout.h>
 #include <vlc_filter.h>
 
 #include <vlc_osd.h>
@@ -97,8 +96,10 @@ 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 * );
+static int MouseEvent( filter_t *,
+                       const vlc_mouse_t *,
+                       const vlc_mouse_t *,
+                       const video_format_t * );
 
 #define OSD_CFG "osdmenu-"
 
@@ -112,34 +113,35 @@ static int MouseEvent( vlc_object_t *, char const *,
 #define OSD_UPDATE_DEFAULT 300
 #define OSD_UPDATE_MAX     1000
 
-vlc_module_begin();
-    add_integer( OSD_CFG "x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, false );
-    add_integer( OSD_CFG "y", -1, NULL, POSY_TEXT, POSY_LONGTEXT, false );
+vlc_module_begin ()
+    set_capability( "sub filter", 100 )
+    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 )
+
+    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 );
+                 false )
+        change_integer_list( pi_pos_values, ppsz_pos_descriptions, NULL )
     add_string( OSD_CFG "file", OSD_DEFAULT_CFG, NULL, OSD_FILE_TEXT,
-        OSD_FILE_LONGTEXT, false );
+        OSD_FILE_LONGTEXT, false )
     add_string( OSD_CFG "file-path", NULL, NULL, OSD_PATH_TEXT,
-        OSD_PATH_LONGTEXT, false );
+        OSD_PATH_LONGTEXT, false )
     add_integer( OSD_CFG "timeout", 15, NULL, TIMEOUT_TEXT,
-        TIMEOUT_LONGTEXT, 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, true );
+        OSD_UPDATE_LONGTEXT, true )
     add_integer_with_range( OSD_CFG "alpha", 255, 0, 255, NULL,
-        OSD_ALPHA_TEXT, OSD_ALPHA_LONGTEXT, true );
+        OSD_ALPHA_TEXT, OSD_ALPHA_LONGTEXT, true )
 
-    set_capability( "sub filter", 100 );
-    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();
+vlc_module_end ()
 
 /*****************************************************************************
  * Sub filter code
@@ -168,7 +170,6 @@ struct filter_sys_t
     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;
@@ -218,6 +219,7 @@ static int CreateFilter ( vlc_object_t *p_this )
     if( p_sys->p_menu == NULL )
         goto error;
 
+    /* FIXME: this plugin is not at all thread-safe w.r.t. callbacks */
     p_sys->p_menu->i_position = p_sys->i_position;
 
     /* Check if menu position was overridden */
@@ -250,19 +252,9 @@ static int CreateFilter ( vlc_object_t *p_this )
 
     /* Attach subpicture filter callback */
     p_filter->pf_sub_filter = Filter;
+    p_filter->pf_sub_mouse  = MouseEvent;
 
-    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',' ' ) );
+    es_format_Init( &p_filter->fmt_out, SPU_ES, VLC_CODEC_SPU );
     p_filter->fmt_out.i_priority = 0;
 
     return VLC_SUCCESS;
@@ -270,8 +262,6 @@ static int CreateFilter ( vlc_object_t *p_this )
 error:
     msg_Err( p_filter, "osdmenu filter discarded" );
 
-    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 );
@@ -291,26 +281,10 @@ static void DestroyFilter( vlc_object_t *p_this )
     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_DelCallback( p_sys->p_menu, "osd-menu-update",
+                     OSDMenuUpdateEvent, p_filter );
+    var_DelCallback( p_sys->p_menu, "osd-menu-visible",
+                     OSDMenuVisibleEvent, p_filter );
 
     var_Destroy( p_this, OSD_CFG "file-path" );
     var_Destroy( p_this, OSD_CFG "file" );
@@ -321,14 +295,10 @@ static void DestroyFilter( vlc_object_t *p_this )
     var_Destroy( p_this, OSD_CFG "update" );
     var_Destroy( p_this, OSD_CFG "alpha" );
 
-    if( p_sys )
-    {
-        osd_MenuDelete( p_filter, p_sys->p_menu );
-
-        free( p_sys->psz_path );
-        free( p_sys->psz_file );
-        free( p_sys );
-    }
+    osd_MenuDelete( p_filter, p_sys->p_menu );
+    free( p_sys->psz_path );
+    free( p_sys->psz_file );
+    free( p_sys );
 }
 
 /*****************************************************************************
@@ -371,13 +341,12 @@ static subpicture_region_t *create_text_region( filter_t *p_filter, subpicture_t
 
     /* Create new SPU region */
     memset( &fmt, 0, sizeof(video_format_t) );
-    fmt.i_chroma = VLC_FOURCC( 'T','E','X','T' );
-    fmt.i_aspect = VOUT_ASPECT_FACTOR;
+    fmt.i_chroma = VLC_CODEC_TEXT;
     fmt.i_sar_num = fmt.i_sar_den = 1;
     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 );
+    p_region = subpicture_region_New( &fmt );
     if( !p_region )
     {
         msg_Err( p_filter, "cannot allocate another SPU region" );
@@ -403,33 +372,35 @@ static subpicture_region_t *create_picture_region( filter_t *p_filter, subpictur
 {
     subpicture_region_t *p_region = NULL;
     video_format_t       fmt;
+    video_palette_t      palette;
 
     if( !p_spu ) return NULL;
 
     /* Create new SPU region */
     memset( &fmt, 0, sizeof(video_format_t) );
-    fmt.i_chroma = (p_pic == NULL) ? VLC_FOURCC('Y','U','V','P') : VLC_FOURCC('Y','U','V','A');
-    fmt.i_aspect = VOUT_ASPECT_FACTOR;
+    fmt.i_chroma = (p_pic == NULL) ? VLC_CODEC_YUVP : VLC_CODEC_YUVA;
     fmt.i_sar_num = fmt.i_sar_den = 1;
     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;
+    if( fmt.i_chroma == VLC_CODEC_YUVP )
+    {
+        fmt.p_palette = &palette;
+        fmt.p_palette->i_entries = 0;
+        fmt.i_visible_width = 0;
+        fmt.i_visible_height = 0;
+    }
 
-    p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
+    p_region = subpicture_region_New( &fmt );
     if( !p_region )
     {
         msg_Err( p_filter, "cannot allocate SPU region" );
         p_filter->pf_sub_buffer_del( p_filter, p_spu );
         return NULL;
     }
-    if( !p_pic && ( fmt.i_chroma == VLC_FOURCC('Y','U','V','P') ) )
-    {
-        p_region->fmt.p_palette->i_entries = 0;
-        p_region->fmt.i_width = p_region->fmt.i_visible_width = 0;
-        p_region->fmt.i_height = p_region->fmt.i_visible_height = 0;
-    }
+    /* FIXME the copy is probably not needed anymore */
     if( p_pic )
-        vout_CopyPicture( p_filter, &p_region->picture, p_pic );
+        picture_Copy( p_region->p_picture, p_pic );
 
     p_region->i_x = 0;
     p_region->i_y = 0;
@@ -453,6 +424,7 @@ 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 = NULL;
     subpicture_region_t *p_region = NULL;
+    int i_x, i_y;
 
     if( !p_sys->b_update || (p_sys->i_update <= 0) )
             return NULL;
@@ -474,7 +446,6 @@ static subpicture_t *Filter( filter_t *p_filter, mtime_t i_date )
         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 )
@@ -498,23 +469,13 @@ static subpicture_t *Filter( filter_t *p_filter, mtime_t i_date )
      * 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 == false ) )
+        !p_filter->p_sys->b_visible )
     {
-        /* Create new spu regions and allocate an empty picture in it. */
-        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,
-            NULL );
-
-        /* 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;
         p_spu->i_alpha = 0xFF; /* Picture is completely non transparent. */
         return p_spu;
     }
 
-    if( p_sys->p_vout && p_sys->b_clicked )
+    if( p_sys->b_clicked )
     {
         p_sys->b_clicked = false;
         osd_MenuActivate( p_filter );
@@ -532,21 +493,21 @@ static subpicture_t *Filter( filter_t *p_filter, mtime_t i_date )
         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;
+        i_x = p_filter->p_sys->p_menu->p_button->i_x;
+        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;
+        i_x = p_filter->p_sys->p_menu->p_state->i_x;
+        i_y = p_filter->p_sys->p_menu->p_state->i_y;
     }
+    p_region->i_x = i_x;
+    p_region->i_y = i_y;
 
     if( p_filter->p_sys->p_menu->i_style == OSD_MENU_STYLE_CONCAT )
     {
@@ -568,20 +529,13 @@ static subpicture_t *Filter( filter_t *p_filter, mtime_t i_date )
             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 );
+                subpicture_region_ChainDelete( p_region_list );
+                subpicture_region_Delete( 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;
@@ -589,8 +543,8 @@ static subpicture_t *Filter( filter_t *p_filter, mtime_t i_date )
             }
             else
             {
-                p_new->i_x = p_region_tail->fmt.i_visible_width;
-                p_new->i_y = p_button->i_y;
+                p_new->i_x = i_x+p_region_tail->fmt.i_visible_width;
+                p_new->i_y = i_y+p_button->i_y;
                 p_region_tail->p_next = p_new;
                 p_region_tail = p_new;
             }
@@ -649,7 +603,7 @@ static int OSDMenuCallback( vlc_object_t *p_this, char const *psz_var,
         }
     }
     else if( !strncmp( psz_var, OSD_CFG"update", 14) )
-        p_sys->i_update =  (mtime_t)(newval.i_int * 1000);
+        p_sys->i_update =  newval.i_int * INT64_C(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) )
@@ -659,59 +613,28 @@ static int OSDMenuCallback( vlc_object_t *p_this, char const *psz_var,
     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 )
+static int MouseEvent( filter_t *p_filter,
+                       const vlc_mouse_t *p_old,
+                       const vlc_mouse_t *p_new,
+                       const video_format_t *p_fmt )
 {
-    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" );
+    filter_sys_t *p_sys = p_filter->p_sys;
 
-    if( i_y < 0 || i_x < 0 || i_y >= v_h || i_x >= v_w )
+    if( !vlc_mouse_HasPressed( p_old, p_new, MOUSE_BUTTON_LEFT ) )
         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;
+    osd_button_t *p_button = osd_ButtonFind( VLC_OBJECT(p_filter),
+                                             p_new->i_x,
+                                             p_new->i_y,
+                                             p_fmt->i_width,
+                                             p_fmt->i_height,
+                                             1000, 1000 );
+    if( !p_button )
+        return VLC_SUCCESS;
 
-        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 );
-        }
-    }
+    osd_ButtonSelect( VLC_OBJECT(p_filter), p_button );
+    p_sys->b_update = p_sys->b_visible ? true : false;
+    p_sys->b_clicked = true;
+    msg_Dbg( p_filter, "mouse clicked %s (%d,%d)", p_button->psz_name, p_new->i_x, p_new->i_y );
     return VLC_SUCCESS;
 }