git.sesse.net Git - vlc/blob - modules/control/gestures.c

   1 /*****************************************************************************
   2  * gestures.c: control vlc with mouse gestures
   3  *****************************************************************************
   4  * Copyright (C) 2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #include <stdlib.h>                                      /* malloc(), free() */
  28 #include <string.h>
  29
  30 #include <vlc/vlc.h>
  31 #include <vlc_interface.h>
  32 #include <vlc_vout.h>
  33 #include <vlc_playlist.h>
  34
  35 #ifdef HAVE_UNISTD_H
  36 #    include <unistd.h>
  37 #endif
  38
  39 /*****************************************************************************
  40  * intf_sys_t: description and status of interface
  41  *****************************************************************************/
  42 struct intf_sys_t
  43 {
  44     vlc_object_t *      p_vout;
  45     input_thread_t *    p_input;
  46     vlc_bool_t          b_got_gesture;
  47     vlc_bool_t          b_button_pressed;
  48     int                 i_mouse_x, i_mouse_y;
  49     int                 i_last_x, i_last_y;
  50     unsigned int        i_pattern;
  51     int                 i_num_gestures;
  52     int                 i_threshold;
  53     int                 i_button_mask;
  54 };
  55
  56 /*****************************************************************************
  57  * Local prototypes.
  58  *****************************************************************************/
  59 #define UP 1
  60 #define DOWN 2
  61 #define LEFT 3
  62 #define RIGHT 4
  63 #define NONE 0
  64 #define GESTURE( a, b, c, d ) (a | ( b << 4 ) | ( c << 8 ) | ( d << 12 ))
  65
  66 int  E_(Open)   ( vlc_object_t * );
  67 void E_(Close)  ( vlc_object_t * );
  68 static int  InitThread     ( intf_thread_t *p_intf );
  69 static void EndThread      ( intf_thread_t *p_intf );
  70 static int  MouseEvent     ( vlc_object_t *, char const *,
  71                              vlc_value_t, vlc_value_t, void * );
  72
  73 /* Exported functions */
  74 static void RunIntf        ( intf_thread_t *p_intf );
  75
  76 /*****************************************************************************
  77  * Module descriptor
  78  *****************************************************************************/
  79 #define THRESHOLD_TEXT N_( "Motion threshold (10-100)" )
  80 #define THRESHOLD_LONGTEXT N_( \
  81     "Amount of movement required for a mouse gesture to be recorded." )
  82
  83 #define BUTTON_TEXT N_( "Trigger button" )
  84 #define BUTTON_LONGTEXT N_( \
  85     "Trigger button for mouse gestures." )
  86
  87 static const char *button_list[] = { "left", "middle", "right" };
  88 static const char *button_list_text[] =
  89                                    { N_("Left"), N_("Middle"), N_("Right") };
  90
  91 vlc_module_begin();
  92     set_shortname( _("Gestures"));
  93     set_category( CAT_INTERFACE );
  94     set_subcategory( SUBCAT_INTERFACE_CONTROL );
  95     add_integer( "gestures-threshold", 30, NULL,
  96                  THRESHOLD_TEXT, THRESHOLD_LONGTEXT, VLC_TRUE );
  97     add_string( "gestures-button", "right", NULL,
  98                 BUTTON_TEXT, BUTTON_LONGTEXT, VLC_FALSE );
  99         change_string_list( button_list, button_list_text, 0 );
 100     set_description( _("Mouse gestures control interface") );
 101
 102     set_capability( "interface", 0 );
 103     set_callbacks( E_(Open), E_(Close) );
 104 vlc_module_end();
 105
 106 /*****************************************************************************
 107  * OpenIntf: initialize interface
 108  *****************************************************************************/
 109 int E_(Open) ( vlc_object_t *p_this )
 110 {
 111     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 112
 113     /* Allocate instance and initialize some members */
 114     p_intf->p_sys = malloc( sizeof( intf_sys_t ) );
 115     if( p_intf->p_sys == NULL )
 116     {
 117         return( 1 );
 118     };
 119
 120     p_intf->pf_run = RunIntf;
 121
 122     return( 0 );
 123 }
 124
 125 /*****************************************************************************
 126  * gesture: return a subpattern within a pattern
 127  *****************************************************************************/
 128 static int gesture( int i_pattern, int i_num )
 129 {
 130     return ( i_pattern >> ( i_num * 4 ) ) & 0xF;
 131 }
 132
 133 /*****************************************************************************
 134  * CloseIntf: destroy dummy interface
 135  *****************************************************************************/
 136 void E_(Close) ( vlc_object_t *p_this )
 137 {
 138     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 139
 140     /* Destroy structure */
 141     free( p_intf->p_sys );
 142 }
 143
 144
 145 /*****************************************************************************
 146  * RunIntf: main loop
 147  *****************************************************************************/
 148 static void RunIntf( intf_thread_t *p_intf )
 149 {
 150     playlist_t * p_playlist = NULL;
 151     p_intf->p_sys->p_vout = NULL;
 152
 153     if( InitThread( p_intf ) < 0 )
 154     {
 155         msg_Err( p_intf, "can't initialize interface thread" );
 156         return;
 157     }
 158     msg_Dbg( p_intf, "interface thread initialized" );
 159
 160     /* Main loop */
 161     while( !intf_ShouldDie( p_intf ) )
 162     {
 163         vlc_mutex_lock( &p_intf->change_lock );
 164
 165         /*
 166          * mouse cursor
 167          */
 168         if( p_intf->p_sys->b_got_gesture )
 169         {
 170             /* Do something */
 171             switch( p_intf->p_sys->i_pattern )
 172             {
 173             case LEFT:
 174                 p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 175                                               FIND_ANYWHERE );
 176                 if( p_playlist == NULL )
 177                 {
 178                     break;
 179                 }
 180
 181                 playlist_Prev( p_playlist );
 182                 vlc_object_release( p_playlist );
 183                 break;
 184             case RIGHT:
 185                 p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 186                                               FIND_ANYWHERE );
 187                 if( p_playlist == NULL )
 188                 {
 189                     break;
 190                 }
 191
 192                 playlist_Next( p_playlist );
 193                 vlc_object_release( p_playlist );
 194                 break;
 195             case GESTURE(UP,RIGHT,NONE,NONE):
 196                 if (p_intf->p_sys->p_vout )
 197                 {
 198                     ((vout_thread_t *)p_intf->p_sys->p_vout)->i_changes |=
 199                         VOUT_FULLSCREEN_CHANGE;
 200                 }
 201                 break;
 202             case GESTURE(DOWN,RIGHT,NONE,NONE):
 203                 /* FIXME: Should close the vout!"*/
 204                 p_intf->p_libvlc->b_die = VLC_TRUE;
 205                 break;
 206             case GESTURE(DOWN,LEFT,UP,RIGHT):
 207                 msg_Dbg(p_intf, "a square was drawn!" );
 208                 break;
 209             default:
 210                 break;
 211             }
 212             p_intf->p_sys->i_num_gestures = 0;
 213             p_intf->p_sys->i_pattern = 0;
 214             p_intf->p_sys->b_got_gesture = VLC_FALSE;
 215         }
 216
 217         /*
 218          * video output
 219          */
 220         if( p_intf->p_sys->p_vout && p_intf->p_sys->p_vout->b_die )
 221         {
 222             var_DelCallback( p_intf->p_sys->p_vout, "mouse-moved",
 223                              MouseEvent, p_intf );
 224             var_DelCallback( p_intf->p_sys->p_vout, "mouse-button-down",
 225                              MouseEvent, p_intf );
 226             vlc_object_release( p_intf->p_sys->p_vout );
 227             p_intf->p_sys->p_vout = NULL;
 228         }
 229
 230         if( p_intf->p_sys->p_vout == NULL )
 231         {
 232             p_intf->p_sys->p_vout = vlc_object_find( p_intf,
 233                                       VLC_OBJECT_VOUT, FIND_ANYWHERE );
 234             if( p_intf->p_sys->p_vout )
 235             {
 236                 var_AddCallback( p_intf->p_sys->p_vout, "mouse-moved",
 237                                  MouseEvent, p_intf );
 238                 var_AddCallback( p_intf->p_sys->p_vout, "mouse-button-down",
 239                                  MouseEvent, p_intf );
 240             }
 241         }
 242
 243         vlc_mutex_unlock( &p_intf->change_lock );
 244
 245         /* Wait a bit */
 246         msleep( INTF_IDLE_SLEEP );
 247     }
 248
 249     EndThread( p_intf );
 250 }
 251
 252 /*****************************************************************************
 253  * InitThread:
 254  *****************************************************************************/
 255 static int InitThread( intf_thread_t * p_intf )
 256 {
 257     char *psz_button;
 258     /* we might need some locking here */
 259     if( !intf_ShouldDie( p_intf ) )
 260     {
 261         /* p_intf->change_lock locking strategy:
 262          * - Every access to p_intf->p_sys are locked threw p_intf->change_lock
 263          * - make sure there won't be  cross increment/decrement ref count
 264          *   of p_intf->p_sys members p_intf->change_lock should be locked
 265          *   during those operations */
 266         vlc_mutex_lock( &p_intf->change_lock );
 267
 268         /* p_intf->p_sys->p_input references counting strategy:
 269          * - InitThread is responsible for only one ref count retaining
 270          * - EndThread is responsible for the corresponding release */
 271         p_intf->p_sys->p_input = vlc_object_find( p_intf, VLC_OBJECT_INPUT,
 272                                                   FIND_PARENT );
 273
 274         p_intf->p_sys->b_got_gesture = VLC_FALSE;
 275         p_intf->p_sys->b_button_pressed = VLC_FALSE;
 276         p_intf->p_sys->i_threshold =
 277                      config_GetInt( p_intf, "gestures-threshold" );
 278         psz_button = config_GetPsz( p_intf, "gestures-button" );
 279         if ( !strcmp( psz_button, "left" ) )
 280         {
 281             p_intf->p_sys->i_button_mask = 1;
 282         }
 283         else if ( !strcmp( psz_button, "middle" ) )
 284         {
 285             p_intf->p_sys->i_button_mask = 2;
 286         }
 287         else if ( !strcmp( psz_button, "right" ) )
 288         {
 289             p_intf->p_sys->i_button_mask = 4;
 290         }
 291
 292         p_intf->p_sys->i_pattern = 0;
 293         p_intf->p_sys->i_num_gestures = 0;
 294         vlc_mutex_unlock( &p_intf->change_lock );
 295
 296         return 0;
 297     }
 298     else
 299     {
 300         return -1;
 301     }
 302 }
 303
 304 /*****************************************************************************
 305  * EndThread:
 306  *****************************************************************************/
 307 static void EndThread( intf_thread_t * p_intf )
 308 {
 309     vlc_mutex_lock( &p_intf->change_lock );
 310
 311     if( p_intf->p_sys->p_vout )
 312     {
 313         var_DelCallback( p_intf->p_sys->p_vout, "mouse-moved",
 314                          MouseEvent, p_intf );
 315         var_DelCallback( p_intf->p_sys->p_vout, "mouse-button-down",
 316                          MouseEvent, p_intf );
 317         vlc_object_release( p_intf->p_sys->p_vout );
 318     }
 319
 320     if( p_intf->p_sys->p_input )
 321     {
 322         vlc_object_release(p_intf->p_sys->p_input);
 323     }
 324
 325     vlc_mutex_unlock( &p_intf->change_lock );
 326 }
 327
 328 /*****************************************************************************
 329  * MouseEvent: callback for mouse events
 330  *****************************************************************************/
 331 static int MouseEvent( vlc_object_t *p_this, char const *psz_var,
 332                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
 333 {
 334     vlc_value_t val;
 335     int pattern = 0;
 336
 337     signed int i_horizontal, i_vertical;
 338     intf_thread_t *p_intf = (intf_thread_t *)p_data;
 339
 340     vlc_mutex_lock( &p_intf->change_lock );
 341
 342     /* don't process new gestures before the last events are processed */
 343     if( p_intf->p_sys->b_got_gesture )
 344     {
 345         vlc_mutex_unlock( &p_intf->change_lock );
 346         return VLC_SUCCESS;
 347     }
 348
 349     if( !strcmp(psz_var, "mouse-moved" ) && p_intf->p_sys->b_button_pressed )
 350     {
 351         var_Get( p_intf->p_sys->p_vout, "mouse-x", &val );
 352         p_intf->p_sys->i_mouse_x = val.i_int;
 353         var_Get( p_intf->p_sys->p_vout, "mouse-y", &val );
 354         p_intf->p_sys->i_mouse_y = val.i_int;
 355         i_horizontal = p_intf->p_sys->i_mouse_x -
 356             p_intf->p_sys->i_last_x;
 357         i_horizontal = i_horizontal / p_intf->p_sys->i_threshold;
 358         i_vertical = p_intf->p_sys->i_mouse_y
 359             - p_intf->p_sys->i_last_y;
 360         i_vertical = i_vertical / p_intf->p_sys->i_threshold;
 361
 362         if( i_horizontal < 0 )
 363         {
 364             msg_Dbg( p_intf, "left gesture (%d)", i_horizontal );
 365             pattern = LEFT;
 366         }
 367         else if( i_horizontal > 0 )
 368         {
 369             msg_Dbg( p_intf, "right gesture (%d)", i_horizontal );
 370             pattern = RIGHT;
 371         }
 372         if( i_vertical < 0 )
 373         {
 374             msg_Dbg( p_intf, "up gesture (%d)", i_vertical );
 375             pattern = UP;
 376         }
 377         else if( i_vertical > 0 )
 378         {
 379             msg_Dbg( p_intf, "down gesture (%d)", i_vertical );
 380             pattern = DOWN;
 381         }
 382         if( pattern )
 383         {
 384             p_intf->p_sys->i_last_y = p_intf->p_sys->i_mouse_y;
 385             p_intf->p_sys->i_last_x = p_intf->p_sys->i_mouse_x;
 386             if( gesture( p_intf->p_sys->i_pattern,
 387                          p_intf->p_sys->i_num_gestures - 1 ) != pattern )
 388             {
 389                 p_intf->p_sys->i_pattern |=
 390                     pattern << ( p_intf->p_sys->i_num_gestures * 4 );
 391                 p_intf->p_sys->i_num_gestures++;
 392             }
 393         }
 394
 395     }
 396     if( !strcmp( psz_var, "mouse-button-down" )
 397         && newval.i_int & p_intf->p_sys->i_button_mask
 398         && !p_intf->p_sys->b_button_pressed )
 399     {
 400         p_intf->p_sys->b_button_pressed = VLC_TRUE;
 401         var_Get( p_intf->p_sys->p_vout, "mouse-x", &val );
 402         p_intf->p_sys->i_last_x = val.i_int;
 403         var_Get( p_intf->p_sys->p_vout, "mouse-y", &val );
 404         p_intf->p_sys->i_last_y = val.i_int;
 405     }
 406     if( !strcmp( psz_var, "mouse-button-down" )
 407         && !( newval.i_int & p_intf->p_sys->i_button_mask )
 408         && p_intf->p_sys->b_button_pressed )
 409     {
 410         p_intf->p_sys->b_button_pressed = VLC_FALSE;
 411         p_intf->p_sys->b_got_gesture = VLC_TRUE;
 412     }
 413
 414     vlc_mutex_unlock( &p_intf->change_lock );
 415
 416     return VLC_SUCCESS;
 417 }