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                     vlc_object_release( p_playlist );
 230
 231                     if( !p_input )
 232                         break;
 233
 234                     val.i_int = PLAYING_S;
 235                     if( p_input )
 236                     {
 237                         var_Get( p_input, "state", &val);
 238                         if( val.i_int == PAUSE_S )
 239                         {
 240                             val.i_int = PLAYING_S;
 241                         }
 242                         else
 243                         {
 244                             val.i_int = PAUSE_S;
 245                         }
 246                         var_Set( p_input, "state", val);
 247                     }
 248                     msg_Dbg(p_intf, "Play/Pause");
 249                     vlc_object_release( p_input );
 250                 }
 251                 break;
 252             case GESTURE(LEFT,DOWN,NONE,NONE):
 253                 p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 254                                               FIND_ANYWHERE );
 255                 if( p_playlist == NULL )
 256                 {
 257                     break;
 258                 }
 259
 260                 playlist_Prev( p_playlist );
 261                 vlc_object_release( p_playlist );
 262                 break;
 263             case GESTURE(RIGHT,DOWN,NONE,NONE):
 264                 p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 265                                               FIND_ANYWHERE );
 266                 if( p_playlist == NULL )
 267                 {
 268                     break;
 269                 }
 270
 271                 playlist_Next( p_playlist );
 272                 vlc_object_release( p_playlist );
 273                 break;
 274             case UP:
 275                 {
 276                     audio_volume_t i_newvol;
 277                     aout_VolumeUp( p_intf, 1, &i_newvol );
 278                     msg_Dbg(p_intf, "Louder");
 279                 }
 280                 break;
 281             case DOWN:
 282                 {
 283                     audio_volume_t i_newvol;
 284                     aout_VolumeDown( p_intf, 1, &i_newvol );
 285                     msg_Dbg(p_intf, "Quieter");
 286                 }
 287                 break;
 288             case GESTURE(UP,DOWN,NONE,NONE):
 289             case GESTURE(DOWN,UP,NONE,NONE):
 290                 {
 291                     audio_volume_t i_newvol = -1;
 292                     aout_VolumeMute( p_intf, &i_newvol );
 293                     msg_Dbg(p_intf, "Mute sound");
 294                 }
 295                 break;
 296             case GESTURE(UP,RIGHT,NONE,NONE):
 297                 {
 298                    input_thread_t * p_input;
 299                    vlc_value_t val, list, list2;
 300                    int i_count, i;
 301
 302                     p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 303                                               FIND_ANYWHERE );
 304
 305                    if( !p_playlist )
 306                         break;
 307
 308                     p_input = input_from_playlist( p_playlist );
 309
 310                     vlc_object_release( p_playlist );
 311
 312                     if( !p_input )
 313                         break;
 314
 315                    var_Get( p_input, "audio-es", &val );
 316                    var_Change( p_input, "audio-es", VLC_VAR_GETCHOICES,
 317                                &list, &list2 );
 318                    i_count = list.p_list->i_count;
 319                    if( i_count <= 1 )
 320                    {
 321                        vlc_object_release( p_input );
 322                        continue;
 323                    }
 324                    for( i = 0; i < i_count; i++ )
 325                    {
 326                        if( val.i_int == list.p_list->p_values[i].i_int )
 327                        {
 328                            vlc_object_release( p_input );
 329                            break;
 330                        }
 331                    }
 332                    /* value of audio-es was not in choices list */
 333                    if( i == i_count )
 334                    {
 335                        msg_Warn( p_input,
 336                                "invalid current audio track, selecting 0" );
 337                        var_Set( p_input, "audio-es",
 338                                list.p_list->p_values[0] );
 339                        i = 0;
 340                    }
 341                    else if( i == i_count - 1 )
 342                    {
 343                        var_Set( p_input, "audio-es",
 344                                list.p_list->p_values[1] );
 345                        i = 1;
 346                    }
 347                    else
 348                    {
 349                        var_Set( p_input, "audio-es",
 350                                list.p_list->p_values[i+1] );
 351                        i++;
 352                    }
 353                    vlc_object_release( p_input );
 354                 }
 355                 break;
 356             case GESTURE(DOWN,RIGHT,NONE,NONE):
 357                 {
 358                     input_thread_t * p_input;
 359                     vlc_value_t val, list, list2;
 360                     int i_count, i;
 361
 362                     p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 363                                               FIND_ANYWHERE );
 364
 365                     if( !p_playlist )
 366                         break;
 367
 368                     p_input = input_from_playlist( p_playlist );
 369                     vlc_object_release( p_playlist );
 370
 371                     if( !p_input )
 372                         break;
 373
 374                     var_Get( p_input, "spu-es", &val );
 375
 376                     var_Change( p_input, "spu-es", VLC_VAR_GETCHOICES,
 377                             &list, &list2 );
 378                     i_count = list.p_list->i_count;
 379                     if( i_count <= 1 )
 380                     {
 381                         vlc_object_release( p_input );
 382                         continue;
 383                     }
 384                     for( i = 0; i < i_count; i++ )
 385                     {
 386                         if( val.i_int == list.p_list->p_values[i].i_int )
 387                         {
 388                             vlc_object_release( p_input );
 389                             break;
 390                         }
 391                     }
 392                     /* value of spu-es was not in choices list */
 393                     if( i == i_count )
 394                     {
 395                         msg_Warn( p_input,
 396                                 "invalid current subtitle track, selecting 0" );
 397                         var_Set( p_input, "spu-es", list.p_list->p_values[0] );
 398                         i = 0;
 399                     }
 400                     else if( i == i_count - 1 )
 401                     {
 402                         var_Set( p_input, "spu-es", list.p_list->p_values[0] );
 403                         i = 0;
 404                     }
 405                     else
 406                     {
 407                         var_Set( p_input, "spu-es",
 408                                 list.p_list->p_values[i+1] );
 409                         i = i + 1;
 410                     }
 411                     vlc_object_release( p_input );
 412                 }
 413                 break;
 414             case GESTURE(UP,LEFT,NONE,NONE):
 415                 if (p_intf->p_sys->p_vout )
 416                 {
 417                     ((vout_thread_t *)p_intf->p_sys->p_vout)->i_changes |=
 418                         VOUT_FULLSCREEN_CHANGE;
 419                 }
 420                 break;
 421             case GESTURE(DOWN,LEFT,NONE,NONE):
 422                 /* FIXME: Should close the vout!"*/
 423                 p_intf->p_libvlc->b_die = VLC_TRUE;
 424                 break;
 425             case GESTURE(DOWN,LEFT,UP,RIGHT):
 426             case GESTURE(UP,RIGHT,DOWN,LEFT):
 427                 msg_Dbg(p_intf, "a square was drawn!" );
 428                 break;
 429             default:
 430                 break;
 431             }
 432             p_intf->p_sys->i_num_gestures = 0;
 433             p_intf->p_sys->i_pattern = 0;
 434             p_intf->p_sys->b_got_gesture = VLC_FALSE;
 435         }
 436
 437         /*
 438          * video output
 439          */
 440         if( p_intf->p_sys->p_vout && p_intf->p_sys->p_vout->b_die )
 441         {
 442             var_DelCallback( p_intf->p_sys->p_vout, "mouse-moved",
 443                              MouseEvent, p_intf );
 444             var_DelCallback( p_intf->p_sys->p_vout, "mouse-button-down",
 445                              MouseEvent, p_intf );
 446             vlc_object_release( p_intf->p_sys->p_vout );
 447             p_intf->p_sys->p_vout = NULL;
 448         }
 449
 450         if( p_intf->p_sys->p_vout == NULL )
 451         {
 452             p_intf->p_sys->p_vout = vlc_object_find( p_intf,
 453                                       VLC_OBJECT_VOUT, FIND_ANYWHERE );
 454             if( p_intf->p_sys->p_vout )
 455             {
 456                 var_AddCallback( p_intf->p_sys->p_vout, "mouse-moved",
 457                                  MouseEvent, p_intf );
 458                 var_AddCallback( p_intf->p_sys->p_vout, "mouse-button-down",
 459                                  MouseEvent, p_intf );
 460             }
 461         }
 462
 463         vlc_mutex_unlock( &p_intf->change_lock );
 464
 465         /* Wait a bit */
 466         msleep( INTF_IDLE_SLEEP );
 467     }
 468
 469     EndThread( p_intf );
 470 }
 471
 472 /*****************************************************************************
 473  * InitThread:
 474  *****************************************************************************/
 475 static int InitThread( intf_thread_t * p_intf )
 476 {
 477     char *psz_button;
 478     /* we might need some locking here */
 479     if( !intf_ShouldDie( p_intf ) )
 480     {
 481         /* p_intf->change_lock locking strategy:
 482          * - Every access to p_intf->p_sys are locked threw p_intf->change_lock
 483          * - make sure there won't be  cross increment/decrement ref count
 484          *   of p_intf->p_sys members p_intf->change_lock should be locked
 485          *   during those operations */
 486         vlc_mutex_lock( &p_intf->change_lock );
 487
 488         p_intf->p_sys->b_got_gesture = VLC_FALSE;
 489         p_intf->p_sys->b_button_pressed = VLC_FALSE;
 490         p_intf->p_sys->i_threshold =
 491                      config_GetInt( p_intf, "gestures-threshold" );
 492         psz_button = config_GetPsz( p_intf, "gestures-button" );
 493         if ( !strcmp( psz_button, "left" ) )
 494         {
 495             p_intf->p_sys->i_button_mask = 1;
 496         }
 497         else if ( !strcmp( psz_button, "middle" ) )
 498         {
 499             p_intf->p_sys->i_button_mask = 2;
 500         }
 501         else if ( !strcmp( psz_button, "right" ) )
 502         {
 503             p_intf->p_sys->i_button_mask = 4;
 504         }
 505
 506         p_intf->p_sys->i_pattern = 0;
 507         p_intf->p_sys->i_num_gestures = 0;
 508         vlc_mutex_unlock( &p_intf->change_lock );
 509
 510         return 0;
 511     }
 512     else
 513     {
 514         return -1;
 515     }
 516 }
 517
 518 /*****************************************************************************
 519  * EndThread:
 520  *****************************************************************************/
 521 static void EndThread( intf_thread_t * p_intf )
 522 {
 523     vlc_mutex_lock( &p_intf->change_lock );
 524
 525     if( p_intf->p_sys->p_vout )
 526     {
 527         var_DelCallback( p_intf->p_sys->p_vout, "mouse-moved",
 528                          MouseEvent, p_intf );
 529         var_DelCallback( p_intf->p_sys->p_vout, "mouse-button-down",
 530                          MouseEvent, p_intf );
 531         vlc_object_release( p_intf->p_sys->p_vout );
 532     }
 533
 534     vlc_mutex_unlock( &p_intf->change_lock );
 535 }
 536
 537 /*****************************************************************************
 538  * MouseEvent: callback for mouse events
 539  *****************************************************************************/
 540 static int MouseEvent( vlc_object_t *p_this, char const *psz_var,
 541                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
 542 {
 543     vlc_value_t val;
 544     int pattern = 0;
 545
 546     signed int i_horizontal, i_vertical;
 547     intf_thread_t *p_intf = (intf_thread_t *)p_data;
 548
 549     vlc_mutex_lock( &p_intf->change_lock );
 550
 551     /* don't process new gestures before the last events are processed */
 552     if( p_intf->p_sys->b_got_gesture )
 553     {
 554         vlc_mutex_unlock( &p_intf->change_lock );
 555         return VLC_SUCCESS;
 556     }
 557
 558     if( !strcmp(psz_var, "mouse-moved" ) && p_intf->p_sys->b_button_pressed )
 559     {
 560         var_Get( p_intf->p_sys->p_vout, "mouse-x", &val );
 561         p_intf->p_sys->i_mouse_x = val.i_int;
 562         var_Get( p_intf->p_sys->p_vout, "mouse-y", &val );
 563         p_intf->p_sys->i_mouse_y = val.i_int;
 564         i_horizontal = p_intf->p_sys->i_mouse_x -
 565             p_intf->p_sys->i_last_x;
 566         i_horizontal = i_horizontal / p_intf->p_sys->i_threshold;
 567         i_vertical = p_intf->p_sys->i_mouse_y
 568             - p_intf->p_sys->i_last_y;
 569         i_vertical = i_vertical / p_intf->p_sys->i_threshold;
 570
 571         if( i_horizontal < 0 )
 572         {
 573             msg_Dbg( p_intf, "left gesture (%d)", i_horizontal );
 574             pattern = LEFT;
 575         }
 576         else if( i_horizontal > 0 )
 577         {
 578             msg_Dbg( p_intf, "right gesture (%d)", i_horizontal );
 579             pattern = RIGHT;
 580         }
 581         if( i_vertical < 0 )
 582         {
 583             msg_Dbg( p_intf, "up gesture (%d)", i_vertical );
 584             pattern = UP;
 585         }
 586         else if( i_vertical > 0 )
 587         {
 588             msg_Dbg( p_intf, "down gesture (%d)", i_vertical );
 589             pattern = DOWN;
 590         }
 591         if( pattern )
 592         {
 593             p_intf->p_sys->i_last_y = p_intf->p_sys->i_mouse_y;
 594             p_intf->p_sys->i_last_x = p_intf->p_sys->i_mouse_x;
 595             if( gesture( p_intf->p_sys->i_pattern,
 596                          p_intf->p_sys->i_num_gestures - 1 ) != pattern )
 597             {
 598                 p_intf->p_sys->i_pattern |=
 599                     pattern << ( p_intf->p_sys->i_num_gestures * 4 );
 600                 p_intf->p_sys->i_num_gestures++;
 601             }
 602         }
 603
 604     }
 605     if( !strcmp( psz_var, "mouse-button-down" )
 606         && newval.i_int & p_intf->p_sys->i_button_mask
 607         && !p_intf->p_sys->b_button_pressed )
 608     {
 609         p_intf->p_sys->b_button_pressed = VLC_TRUE;
 610         var_Get( p_intf->p_sys->p_vout, "mouse-x", &val );
 611         p_intf->p_sys->i_last_x = val.i_int;
 612         var_Get( p_intf->p_sys->p_vout, "mouse-y", &val );
 613         p_intf->p_sys->i_last_y = val.i_int;
 614     }
 615     if( !strcmp( psz_var, "mouse-button-down" )
 616         && !( newval.i_int & p_intf->p_sys->i_button_mask )
 617         && p_intf->p_sys->b_button_pressed )
 618     {
 619         p_intf->p_sys->b_button_pressed = VLC_FALSE;
 620         p_intf->p_sys->b_got_gesture = VLC_TRUE;
 621     }
 622
 623     vlc_mutex_unlock( &p_intf->change_lock );
 624
 625     return VLC_SUCCESS;
 626 }