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_aout.h>
  34 #include <vlc_playlist.h>
  35
  36 #ifdef HAVE_UNISTD_H
  37 #    include <unistd.h>
  38 #endif
  39
  40 /*****************************************************************************
  41  * intf_sys_t: description and status of interface
  42  *****************************************************************************/
  43 struct intf_sys_t
  44 {
  45     vlc_object_t *      p_vout;
  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  * input_from_playlist: don't forget to release the return value
 135  *  Also this function should really be available from core.
 136  *****************************************************************************/
 137 static input_thread_t * input_from_playlist ( playlist_t *p_playlist )
 138 {
 139     input_thread_t * p_input;
 140
 141     PL_LOCK;
 142     p_input = p_playlist->p_input;
 143     if( p_input )
 144         vlc_object_yield( p_input );
 145     PL_UNLOCK;
 146
 147     return p_input;
 148 }
 149
 150 /*****************************************************************************
 151  * CloseIntf: destroy dummy interface
 152  *****************************************************************************/
 153 void E_(Close) ( vlc_object_t *p_this )
 154 {
 155     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 156
 157     /* Destroy structure */
 158     free( p_intf->p_sys );
 159 }
 160
 161
 162 /*****************************************************************************
 163  * RunIntf: main loop
 164  *****************************************************************************/
 165 static void RunIntf( intf_thread_t *p_intf )
 166 {
 167     playlist_t * p_playlist = NULL;
 168
 169     if( InitThread( p_intf ) < 0 )
 170     {
 171         msg_Err( p_intf, "can't initialize interface thread" );
 172         return;
 173     }
 174     msg_Dbg( p_intf, "interface thread initialized" );
 175
 176     /* Main loop */
 177     while( !intf_ShouldDie( p_intf ) )
 178     {
 179         vlc_mutex_lock( &p_intf->change_lock );
 180
 181         /*
 182          * mouse cursor
 183          */
 184         if( p_intf->p_sys->b_got_gesture )
 185         {
 186             vlc_value_t val;
 187             int i_interval = 0;
 188             /* Do something */
 189             /* If you modify this, please try to follow this convention:
 190                Start with LEFT, RIGHT for playback related commands
 191                and UP, DOWN, for other commands */
 192             switch( p_intf->p_sys->i_pattern )
 193             {
 194             case LEFT:
 195                 i_interval = config_GetInt( p_intf , "short-jump-size" );
 196                 if ( i_interval > 0 ) {
 197                     val.i_time = ( (mtime_t)( -i_interval ) * 1000000L);
 198                     var_Set( p_intf, "time-offset", val );
 199                 }
 200                 msg_Dbg(p_intf, "Go backward in the movie!");
 201                 break;
 202             case RIGHT:
 203                 i_interval = config_GetInt( p_intf , "short-jump-size" );
 204                 if ( i_interval > 0 ) {
 205                     val.i_time = ( (mtime_t)( i_interval ) * 1000000L);
 206                     var_Set( p_intf, "time-offset", val );
 207                 }
 208                 msg_Dbg(p_intf, "Go forward in the movie!");
 209                 break;
 210             case GESTURE(LEFT,UP,NONE,NONE):
 211                 /*FIXME BF*/
 212                 msg_Dbg(p_intf, "Going slower.");
 213                 break;
 214             case GESTURE(RIGHT,UP,NONE,NONE):
 215                 /*FIXME FF*/
 216                 msg_Dbg(p_intf, "Going faster.");
 217                 break;
 218             case GESTURE(LEFT,RIGHT,NONE,NONE):
 219             case GESTURE(RIGHT,LEFT,NONE,NONE):
 220                 {
 221                     input_thread_t * p_input;
 222                     p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 223                                               FIND_ANYWHERE );
 224
 225                    if( !p_playlist )
 226                         break;
 227
 228                     p_input = input_from_playlist( p_playlist );
 229
 230                     if( !p_input )
 231                     {
 232                         vlc_object_release( p_playlist );
 233                         break;
 234                     }
 235
 236                     val.i_int = PLAYING_S;
 237                     if( p_input )
 238                     {
 239                         var_Get( p_input, "state", &val);
 240                         if( val.i_int == PAUSE_S )
 241                         {
 242                             val.i_int = PLAYING_S;
 243                         }
 244                         else
 245                         {
 246                             val.i_int = PAUSE_S;
 247                         }
 248                         var_Set( p_input, "state", val);
 249                     }
 250                     msg_Dbg(p_intf, "Play/Pause");
 251                     vlc_object_release( p_input );
 252                     vlc_object_release( p_playlist );
 253                 }
 254                 break;
 255             case GESTURE(LEFT,DOWN,NONE,NONE):
 256                 p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 257                                               FIND_ANYWHERE );
 258                 if( p_playlist == NULL )
 259                 {
 260                     break;
 261                 }
 262
 263                 playlist_Prev( p_playlist );
 264                 vlc_object_release( p_playlist );
 265                 break;
 266             case GESTURE(RIGHT,DOWN,NONE,NONE):
 267                 p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 268                                               FIND_ANYWHERE );
 269                 if( p_playlist == NULL )
 270                 {
 271                     break;
 272                 }
 273
 274                 playlist_Next( p_playlist );
 275                 vlc_object_release( p_playlist );
 276                 break;
 277             case UP:
 278                 {
 279                     audio_volume_t i_newvol;
 280                     aout_VolumeUp( p_intf, 1, &i_newvol );
 281                     msg_Dbg(p_intf, "Louder");
 282                 }
 283                 break;
 284             case DOWN:
 285                 {
 286                     audio_volume_t i_newvol;
 287                     aout_VolumeDown( p_intf, 1, &i_newvol );
 288                     msg_Dbg(p_intf, "Quieter");
 289                 }
 290                 break;
 291             case GESTURE(UP,DOWN,NONE,NONE):
 292             case GESTURE(DOWN,UP,NONE,NONE):
 293                 {
 294                     audio_volume_t i_newvol = -1;
 295                     aout_VolumeMute( p_intf, &i_newvol );
 296                     msg_Dbg(p_intf, "Mute sound");
 297                 }
 298                 break;
 299             case GESTURE(UP,RIGHT,NONE,NONE):
 300                 {
 301                    input_thread_t * p_input;
 302                    vlc_value_t val, list, list2;
 303                    int i_count, i;
 304
 305                     p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 306                                               FIND_ANYWHERE );
 307
 308                    if( !p_playlist )
 309                         break;
 310
 311                     p_input = input_from_playlist( p_playlist );
 312
 313                     if( !p_input )
 314                     {
 315                         vlc_object_release( p_playlist );
 316                         break;
 317                     }
 318
 319                    var_Get( p_input, "audio-es", &val );
 320                    var_Change( p_input, "audio-es", VLC_VAR_GETCHOICES,
 321                                &list, &list2 );
 322                    i_count = list.p_list->i_count;
 323                    if( i_count <= 1 )
 324                    {
 325                        vlc_object_release( p_input );
 326                        vlc_object_release( p_playlist );
 327                        continue;
 328                    }
 329                    for( i = 0; i < i_count; i++ )
 330                    {
 331                        if( val.i_int == list.p_list->p_values[i].i_int )
 332                        {
 333                            vlc_object_release( p_input );
 334                            vlc_object_release( p_playlist );
 335                            break;
 336                        }
 337                    }
 338                    /* value of audio-es was not in choices list */
 339                    if( i == i_count )
 340                    {
 341                        msg_Warn( p_input,
 342                                "invalid current audio track, selecting 0" );
 343                        var_Set( p_input, "audio-es",
 344                                list.p_list->p_values[0] );
 345                        i = 0;
 346                    }
 347                    else if( i == i_count - 1 )
 348                    {
 349                        var_Set( p_input, "audio-es",
 350                                list.p_list->p_values[1] );
 351                        i = 1;
 352                    }
 353                    else
 354                    {
 355                        var_Set( p_input, "audio-es",
 356                                list.p_list->p_values[i+1] );
 357                        i++;
 358                    }
 359                    vlc_object_release( p_input );
 360                    vlc_object_release( p_playlist );
 361                 }
 362                 break;
 363             case GESTURE(DOWN,RIGHT,NONE,NONE):
 364                 {
 365                     input_thread_t * p_input;
 366                     vlc_value_t val, list, list2;
 367                     int i_count, i;
 368
 369                     p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 370                                               FIND_ANYWHERE );
 371
 372                     if( !p_playlist )
 373                         break;
 374
 375                     p_input = input_from_playlist( p_playlist );
 376
 377                     if( !p_input )
 378                     {
 379                         vlc_object_release( p_playlist );
 380                         break;
 381                     }
 382                     var_Get( p_input, "spu-es", &val );
 383
 384                     var_Change( p_input, "spu-es", VLC_VAR_GETCHOICES,
 385                             &list, &list2 );
 386                     i_count = list.p_list->i_count;
 387                     if( i_count <= 1 )
 388                     {
 389                         vlc_object_release( p_input );
 390                         vlc_object_release( p_playlist );
 391                         continue;
 392                     }
 393                     for( i = 0; i < i_count; i++ )
 394                     {
 395                         if( val.i_int == list.p_list->p_values[i].i_int )
 396                         {
 397                             vlc_object_release( p_input );
 398                             vlc_object_release( p_playlist );
 399                             break;
 400                         }
 401                     }
 402                     /* value of spu-es was not in choices list */
 403                     if( i == i_count )
 404                     {
 405                         msg_Warn( p_input,
 406                                 "invalid current subtitle track, selecting 0" );
 407                         var_Set( p_input, "spu-es", list.p_list->p_values[0] );
 408                         i = 0;
 409                     }
 410                     else if( i == i_count - 1 )
 411                     {
 412                         var_Set( p_input, "spu-es", list.p_list->p_values[0] );
 413                         i = 0;
 414                     }
 415                     else
 416                     {
 417                         var_Set( p_input, "spu-es",
 418                                 list.p_list->p_values[i+1] );
 419                         i = i + 1;
 420                     }
 421                     vlc_object_release( p_input );
 422                     vlc_object_release( p_playlist );
 423                 }
 424                 break;
 425             case GESTURE(UP,LEFT,NONE,NONE):
 426                 if (p_intf->p_sys->p_vout )
 427                 {
 428                     ((vout_thread_t *)p_intf->p_sys->p_vout)->i_changes |=
 429                         VOUT_FULLSCREEN_CHANGE;
 430                 }
 431                 break;
 432             case GESTURE(DOWN,LEFT,NONE,NONE):
 433                 /* FIXME: Should close the vout!"*/
 434                 p_intf->p_libvlc->b_die = VLC_TRUE;
 435                 break;
 436             case GESTURE(DOWN,LEFT,UP,RIGHT):
 437             case GESTURE(UP,RIGHT,DOWN,LEFT):
 438                 msg_Dbg(p_intf, "a square was drawn!" );
 439                 break;
 440             default:
 441                 break;
 442             }
 443             p_intf->p_sys->i_num_gestures = 0;
 444             p_intf->p_sys->i_pattern = 0;
 445             p_intf->p_sys->b_got_gesture = VLC_FALSE;
 446         }
 447
 448         /*
 449          * video output
 450          */
 451         if( p_intf->p_sys->p_vout && p_intf->p_sys->p_vout->b_die )
 452         {
 453             var_DelCallback( p_intf->p_sys->p_vout, "mouse-moved",
 454                              MouseEvent, p_intf );
 455             var_DelCallback( p_intf->p_sys->p_vout, "mouse-button-down",
 456                              MouseEvent, p_intf );
 457             vlc_object_release( p_intf->p_sys->p_vout );
 458             p_intf->p_sys->p_vout = NULL;
 459         }
 460
 461         if( p_intf->p_sys->p_vout == NULL )
 462         {
 463             p_intf->p_sys->p_vout = vlc_object_find( p_intf,
 464                                       VLC_OBJECT_VOUT, FIND_ANYWHERE );
 465             if( p_intf->p_sys->p_vout )
 466             {
 467                 var_AddCallback( p_intf->p_sys->p_vout, "mouse-moved",
 468                                  MouseEvent, p_intf );
 469                 var_AddCallback( p_intf->p_sys->p_vout, "mouse-button-down",
 470                                  MouseEvent, p_intf );
 471             }
 472         }
 473
 474         vlc_mutex_unlock( &p_intf->change_lock );
 475
 476         /* Wait a bit */
 477         msleep( INTF_IDLE_SLEEP );
 478     }
 479
 480     EndThread( p_intf );
 481 }
 482
 483 /*****************************************************************************
 484  * InitThread:
 485  *****************************************************************************/
 486 static int InitThread( intf_thread_t * p_intf )
 487 {
 488     char *psz_button;
 489     /* we might need some locking here */
 490     if( !intf_ShouldDie( p_intf ) )
 491     {
 492         /* p_intf->change_lock locking strategy:
 493          * - Every access to p_intf->p_sys are locked threw p_intf->change_lock
 494          * - make sure there won't be  cross increment/decrement ref count
 495          *   of p_intf->p_sys members p_intf->change_lock should be locked
 496          *   during those operations */
 497         vlc_mutex_lock( &p_intf->change_lock );
 498
 499         p_intf->p_sys->b_got_gesture = VLC_FALSE;
 500         p_intf->p_sys->b_button_pressed = VLC_FALSE;
 501         p_intf->p_sys->i_threshold =
 502                      config_GetInt( p_intf, "gestures-threshold" );
 503         psz_button = config_GetPsz( p_intf, "gestures-button" );
 504         if ( !strcmp( psz_button, "left" ) )
 505         {
 506             p_intf->p_sys->i_button_mask = 1;
 507         }
 508         else if ( !strcmp( psz_button, "middle" ) )
 509         {
 510             p_intf->p_sys->i_button_mask = 2;
 511         }
 512         else if ( !strcmp( psz_button, "right" ) )
 513         {
 514             p_intf->p_sys->i_button_mask = 4;
 515         }
 516
 517         p_intf->p_sys->i_pattern = 0;
 518         p_intf->p_sys->i_num_gestures = 0;
 519         vlc_mutex_unlock( &p_intf->change_lock );
 520
 521         return 0;
 522     }
 523     else
 524     {
 525         return -1;
 526     }
 527 }
 528
 529 /*****************************************************************************
 530  * EndThread:
 531  *****************************************************************************/
 532 static void EndThread( intf_thread_t * p_intf )
 533 {
 534     vlc_mutex_lock( &p_intf->change_lock );
 535
 536     if( p_intf->p_sys->p_vout )
 537     {
 538         var_DelCallback( p_intf->p_sys->p_vout, "mouse-moved",
 539                          MouseEvent, p_intf );
 540         var_DelCallback( p_intf->p_sys->p_vout, "mouse-button-down",
 541                          MouseEvent, p_intf );
 542         vlc_object_release( p_intf->p_sys->p_vout );
 543     }
 544
 545     vlc_mutex_unlock( &p_intf->change_lock );
 546 }
 547
 548 /*****************************************************************************
 549  * MouseEvent: callback for mouse events
 550  *****************************************************************************/
 551 static int MouseEvent( vlc_object_t *p_this, char const *psz_var,
 552                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
 553 {
 554     vlc_value_t val;
 555     int pattern = 0;
 556
 557     signed int i_horizontal, i_vertical;
 558     intf_thread_t *p_intf = (intf_thread_t *)p_data;
 559
 560     vlc_mutex_lock( &p_intf->change_lock );
 561
 562     /* don't process new gestures before the last events are processed */
 563     if( p_intf->p_sys->b_got_gesture )
 564     {
 565         vlc_mutex_unlock( &p_intf->change_lock );
 566         return VLC_SUCCESS;
 567     }
 568
 569     if( !strcmp(psz_var, "mouse-moved" ) && p_intf->p_sys->b_button_pressed )
 570     {
 571         var_Get( p_intf->p_sys->p_vout, "mouse-x", &val );
 572         p_intf->p_sys->i_mouse_x = val.i_int;
 573         var_Get( p_intf->p_sys->p_vout, "mouse-y", &val );
 574         p_intf->p_sys->i_mouse_y = val.i_int;
 575         i_horizontal = p_intf->p_sys->i_mouse_x -
 576             p_intf->p_sys->i_last_x;
 577         i_horizontal = i_horizontal / p_intf->p_sys->i_threshold;
 578         i_vertical = p_intf->p_sys->i_mouse_y
 579             - p_intf->p_sys->i_last_y;
 580         i_vertical = i_vertical / p_intf->p_sys->i_threshold;
 581
 582         if( i_horizontal < 0 )
 583         {
 584             msg_Dbg( p_intf, "left gesture (%d)", i_horizontal );
 585             pattern = LEFT;
 586         }
 587         else if( i_horizontal > 0 )
 588         {
 589             msg_Dbg( p_intf, "right gesture (%d)", i_horizontal );
 590             pattern = RIGHT;
 591         }
 592         if( i_vertical < 0 )
 593         {
 594             msg_Dbg( p_intf, "up gesture (%d)", i_vertical );
 595             pattern = UP;
 596         }
 597         else if( i_vertical > 0 )
 598         {
 599             msg_Dbg( p_intf, "down gesture (%d)", i_vertical );
 600             pattern = DOWN;
 601         }
 602         if( pattern )
 603         {
 604             p_intf->p_sys->i_last_y = p_intf->p_sys->i_mouse_y;
 605             p_intf->p_sys->i_last_x = p_intf->p_sys->i_mouse_x;
 606             if( gesture( p_intf->p_sys->i_pattern,
 607                          p_intf->p_sys->i_num_gestures - 1 ) != pattern )
 608             {
 609                 p_intf->p_sys->i_pattern |=
 610                     pattern << ( p_intf->p_sys->i_num_gestures * 4 );
 611                 p_intf->p_sys->i_num_gestures++;
 612             }
 613         }
 614
 615     }
 616     if( !strcmp( psz_var, "mouse-button-down" )
 617         && newval.i_int & p_intf->p_sys->i_button_mask
 618         && !p_intf->p_sys->b_button_pressed )
 619     {
 620         p_intf->p_sys->b_button_pressed = VLC_TRUE;
 621         var_Get( p_intf->p_sys->p_vout, "mouse-x", &val );
 622         p_intf->p_sys->i_last_x = val.i_int;
 623         var_Get( p_intf->p_sys->p_vout, "mouse-y", &val );
 624         p_intf->p_sys->i_last_y = val.i_int;
 625     }
 626     if( !strcmp( psz_var, "mouse-button-down" )
 627         && !( newval.i_int & p_intf->p_sys->i_button_mask )
 628         && p_intf->p_sys->b_button_pressed )
 629     {
 630         p_intf->p_sys->b_button_pressed = VLC_FALSE;
 631         p_intf->p_sys->b_got_gesture = VLC_TRUE;
 632     }
 633
 634     vlc_mutex_unlock( &p_intf->change_lock );
 635
 636     return VLC_SUCCESS;
 637 }