]> git.sesse.net Git - vlc/blobdiff - modules/control/gestures.c
Gestures: Make sure p_intf->p_sys->p_input gets released.
[vlc] / modules / control / gestures.c
index bbe1029b6abec66c41ef8e1cf1dd060e294704f0..9bfa5a3b9cf43ebef5380534883edd17d20ba858 100644 (file)
@@ -1,16 +1,16 @@
 /*****************************************************************************
  * gestures.c: control vlc with mouse gestures
  *****************************************************************************
- * Copyright (C) 2004 VideoLAN
- * $Id: gestures.c,v 1.7 2004/01/25 16:17:03 anil Exp $
+ * Copyright (C) 2004 the VideoLAN team
+ * $Id$
  *
- * Authors: Sigmund Augdal <sigmunau@idi.ntnu.no>
+ * Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
  *
  * 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
@@ -18,7 +18,7 @@
  *
  * 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.
  *****************************************************************************/
 
 /*****************************************************************************
  *****************************************************************************/
 #include <stdlib.h>                                      /* malloc(), free() */
 #include <string.h>
-#include <unistd.h>
 
 #include <vlc/vlc.h>
-#include <vlc/intf.h>
-#include <vlc/vout.h>
+#include <vlc_interface.h>
+#include <vlc_vout.h>
+#include <vlc_playlist.h>
 
-#include "stream_control.h"
-#include "input_ext-intf.h"
+#ifdef HAVE_UNISTD_H
+#    include <unistd.h>
+#endif
 
 /*****************************************************************************
  * intf_sys_t: description and status of interface
@@ -65,6 +66,7 @@ struct intf_sys_t
 int  E_(Open)   ( vlc_object_t * );
 void E_(Close)  ( vlc_object_t * );
 static int  InitThread     ( intf_thread_t *p_intf );
+static void EndThread      ( intf_thread_t *p_intf );
 static int  MouseEvent     ( vlc_object_t *, char const *,
                              vlc_value_t, vlc_value_t, void * );
 
@@ -76,18 +78,22 @@ static void RunIntf        ( intf_thread_t *p_intf );
  *****************************************************************************/
 #define THRESHOLD_TEXT N_( "Motion threshold (10-100)" )
 #define THRESHOLD_LONGTEXT N_( \
-    "Amount of movement required for a mouse" \
-    " gesture to be recorded." )
+    "Amount of movement required for a mouse gesture to be recorded." )
 
 #define BUTTON_TEXT N_( "Trigger button" )
 #define BUTTON_LONGTEXT N_( \
-    "You can set the trigger button for mouse gestures here." )
+    "Trigger button for mouse gestures." )
 
-static char *button_list[] = { "left", "middle", "right" };
-static char *button_list_text[] = { N_("Left"), N_("Middle"), N_("Right") };
+static const char *button_list[] = { "left", "middle", "right" };
+static const char *button_list_text[] =
+                                   { N_("Left"), N_("Middle"), N_("Right") };
 
 vlc_module_begin();
-    add_integer( "gestures-threshold", 30, NULL, THRESHOLD_TEXT, THRESHOLD_LONGTEXT, VLC_TRUE );
+    set_shortname( _("Gestures"));
+    set_category( CAT_INTERFACE );
+    set_subcategory( SUBCAT_INTERFACE_CONTROL );
+    add_integer( "gestures-threshold", 30, NULL,
+                 THRESHOLD_TEXT, THRESHOLD_LONGTEXT, VLC_TRUE );
     add_string( "gestures-button", "right", NULL,
                 BUTTON_TEXT, BUTTON_LONGTEXT, VLC_FALSE );
         change_string_list( button_list, button_list_text, 0 );
@@ -123,7 +129,7 @@ static int gesture( int i_pattern, int i_num )
 {
     return ( i_pattern >> ( i_num * 4 ) ) & 0xF;
 }
-        
+
 /*****************************************************************************
  * CloseIntf: destroy dummy interface
  *****************************************************************************/
@@ -146,17 +152,17 @@ static void RunIntf( intf_thread_t *p_intf )
 
     if( InitThread( p_intf ) < 0 )
     {
-        msg_Err( p_intf, "can't initialize intf" );
+        msg_Err( p_intf, "can't initialize interface thread" );
         return;
     }
-    msg_Dbg( p_intf, "intf initialized" );
+    msg_Dbg( p_intf, "interface thread initialized" );
 
     /* Main loop */
-    while( !p_intf->b_die )
+    while( !intf_ShouldDie( p_intf ) )
     {
         vlc_mutex_lock( &p_intf->change_lock );
 
-        /* 
+        /*
          * mouse cursor
          */
         if( p_intf->p_sys->b_got_gesture )
@@ -171,7 +177,7 @@ static void RunIntf( intf_thread_t *p_intf )
                 {
                     break;
                 }
-                
+
                 playlist_Prev( p_playlist );
                 vlc_object_release( p_playlist );
                 break;
@@ -182,7 +188,7 @@ static void RunIntf( intf_thread_t *p_intf )
                 {
                     break;
                 }
-                
+
                 playlist_Next( p_playlist );
                 vlc_object_release( p_playlist );
                 break;
@@ -195,10 +201,10 @@ static void RunIntf( intf_thread_t *p_intf )
                 break;
             case GESTURE(DOWN,RIGHT,NONE,NONE):
                 /* FIXME: Should close the vout!"*/
-                p_intf->p_vlc->b_die = VLC_TRUE;
+                p_intf->p_libvlc->b_die = VLC_TRUE;
                 break;
             case GESTURE(DOWN,LEFT,UP,RIGHT):
-                msg_Dbg(p_intf, "a square!" );
+                msg_Dbg(p_intf, "a square was drawn!" );
                 break;
             default:
                 break;
@@ -207,11 +213,11 @@ static void RunIntf( intf_thread_t *p_intf )
             p_intf->p_sys->i_pattern = 0;
             p_intf->p_sys->b_got_gesture = VLC_FALSE;
         }
-                
+
 
         vlc_mutex_unlock( &p_intf->change_lock );
 
-        /* 
+        /*
          * video output
          */
         if( p_intf->p_sys->p_vout && p_intf->p_sys->p_vout->b_die )
@@ -241,14 +247,7 @@ static void RunIntf( intf_thread_t *p_intf )
         msleep( INTF_IDLE_SLEEP );
     }
 
-    if( p_intf->p_sys->p_vout )
-    {
-        var_DelCallback( p_intf->p_sys->p_vout, "mouse-moved",
-                         MouseEvent, p_intf );
-        var_DelCallback( p_intf->p_sys->p_vout, "mouse-button-down",
-                         MouseEvent, p_intf );
-        vlc_object_release( p_intf->p_sys->p_vout );
-    }
+    EndThread( p_intf );
 }
 
 /*****************************************************************************
@@ -258,10 +257,13 @@ static int InitThread( intf_thread_t * p_intf )
 {
     char *psz_button;
     /* we might need some locking here */
-    if( !p_intf->b_die )
+    if( !intf_ShouldDie( p_intf ) )
     {
         input_thread_t * p_input;
 
+        /* p_intf->p_sys->p_input references counting strategy:
+         * - InitThread is responsible for only one ref count retaining
+         * - EndThread is responsible for the correspondinf release */
         p_input = vlc_object_find( p_intf, VLC_OBJECT_INPUT, FIND_PARENT );
 
         vlc_mutex_lock( &p_intf->change_lock );
@@ -269,7 +271,8 @@ static int InitThread( intf_thread_t * p_intf )
         p_intf->p_sys->p_input = p_input;
         p_intf->p_sys->b_got_gesture = VLC_FALSE;
         p_intf->p_sys->b_button_pressed = VLC_FALSE;
-        p_intf->p_sys->i_threshold = config_GetInt( p_intf, "gestures-threshold" );
+        p_intf->p_sys->i_threshold =
+                     config_GetInt( p_intf, "gestures-threshold" );
         psz_button = config_GetPsz( p_intf, "gestures-button" );
         if ( !strcmp( psz_button, "left" ) )
         {
@@ -296,6 +299,26 @@ static int InitThread( intf_thread_t * p_intf )
     }
 }
 
+/*****************************************************************************
+ * EndThread:
+ *****************************************************************************/
+static void EndThread( intf_thread_t * p_intf )
+{
+    if( p_intf->p_sys->p_vout )
+    {
+        var_DelCallback( p_intf->p_sys->p_vout, "mouse-moved",
+                         MouseEvent, p_intf );
+        var_DelCallback( p_intf->p_sys->p_vout, "mouse-button-down",
+                         MouseEvent, p_intf );
+        vlc_object_release( p_intf->p_sys->p_vout );
+    }
+
+    if( p_intf->p_sys->p_input )
+    {
+        vlc_object_release(p_intf->p_sys->p_input);
+    }
+}
+
 /*****************************************************************************
  * MouseEvent: callback for mouse events
  *****************************************************************************/
@@ -304,17 +327,19 @@ static int MouseEvent( vlc_object_t *p_this, char const *psz_var,
 {
     vlc_value_t val;
     int pattern = 0;
-    
+
     signed int i_horizontal, i_vertical;
     intf_thread_t *p_intf = (intf_thread_t *)p_data;
 
     /* don't process new gestures before the last events are processed */
-    if( p_intf->p_sys->b_got_gesture ) {
+    if( p_intf->p_sys->b_got_gesture )
+    {
         return VLC_SUCCESS;
     }
 
     vlc_mutex_lock( &p_intf->change_lock );
-    if( !strcmp(psz_var, "mouse-moved" ) && p_intf->p_sys->b_button_pressed ) {
+    if( !strcmp(psz_var, "mouse-moved" ) && p_intf->p_sys->b_button_pressed )
+    {
         var_Get( p_intf->p_sys->p_vout, "mouse-x", &val );
         p_intf->p_sys->i_mouse_x = val.i_int;
         var_Get( p_intf->p_sys->p_vout, "mouse-y", &val );
@@ -325,40 +350,43 @@ static int MouseEvent( vlc_object_t *p_this, char const *psz_var,
         i_vertical = p_intf->p_sys->i_mouse_y
             - p_intf->p_sys->i_last_y;
         i_vertical = i_vertical / p_intf->p_sys->i_threshold;
-        
-        if ( i_horizontal < 0 )
+
+        if( i_horizontal < 0 )
         {
-            msg_Dbg( p_intf, "left gesture(%d)", i_horizontal );
+            msg_Dbg( p_intf, "left gesture (%d)", i_horizontal );
             pattern = LEFT;
         }
-        else if ( i_horizontal > 0 )
+        else if( i_horizontal > 0 )
         {
-            msg_Dbg( p_intf, "right gesture(%d)", i_horizontal );
+            msg_Dbg( p_intf, "right gesture (%d)", i_horizontal );
             pattern = RIGHT;
         }
-        if ( i_vertical < 0 )
+        if( i_vertical < 0 )
         {
-            msg_Dbg( p_intf, "up gesture(%d)", i_vertical );
+            msg_Dbg( p_intf, "up gesture (%d)", i_vertical );
             pattern = UP;
         }
-        else if ( i_vertical > 0 )
+        else if( i_vertical > 0 )
         {
-            msg_Dbg( p_intf, "down gesture(%d)", i_vertical );
+            msg_Dbg( p_intf, "down gesture (%d)", i_vertical );
             pattern = DOWN;
         }
-        if (pattern )
+        ifpattern )
         {
             p_intf->p_sys->i_last_y = p_intf->p_sys->i_mouse_y;
             p_intf->p_sys->i_last_x = p_intf->p_sys->i_mouse_x;
-            if( gesture(p_intf->p_sys->i_pattern, p_intf->p_sys->i_num_gestures - 1 ) != pattern )
+            if( gesture( p_intf->p_sys->i_pattern,
+                         p_intf->p_sys->i_num_gestures - 1 ) != pattern )
             {
-                p_intf->p_sys->i_pattern |= pattern << ( p_intf->p_sys->i_num_gestures * 4 );
+                p_intf->p_sys->i_pattern |=
+                    pattern << ( p_intf->p_sys->i_num_gestures * 4 );
                 p_intf->p_sys->i_num_gestures++;
             }
         }
 
     }
-    if( !strcmp( psz_var, "mouse-button-down" ) && newval.i_int & p_intf->p_sys->i_button_mask
+    if( !strcmp( psz_var, "mouse-button-down" )
+        && newval.i_int & p_intf->p_sys->i_button_mask
         && !p_intf->p_sys->b_button_pressed )
     {
         p_intf->p_sys->b_button_pressed = VLC_TRUE;
@@ -367,7 +395,8 @@ static int MouseEvent( vlc_object_t *p_this, char const *psz_var,
         var_Get( p_intf->p_sys->p_vout, "mouse-y", &val );
         p_intf->p_sys->i_last_y = val.i_int;
     }
-    if( !strcmp( psz_var, "mouse-button-down" ) && !( newval.i_int & p_intf->p_sys->i_button_mask )
+    if( !strcmp( psz_var, "mouse-button-down" )
+        && !( newval.i_int & p_intf->p_sys->i_button_mask )
         && p_intf->p_sys->b_button_pressed )
     {
         p_intf->p_sys->b_button_pressed = VLC_FALSE;