1 /*****************************************************************************
2 * gestures.c: control vlc with mouse gestures
3 *****************************************************************************
4 * Copyright (C) 2004 the VideoLAN team
7 * Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
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.
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.
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 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
34 #include <vlc_interface.h>
37 #include <vlc_playlist.h>
43 /*****************************************************************************
44 * intf_sys_t: description and status of interface
45 *****************************************************************************/
48 vlc_object_t * p_vout;
50 bool b_button_pressed;
51 int i_mouse_x, i_mouse_y;
52 int i_last_x, i_last_y;
53 unsigned int i_pattern;
59 /*****************************************************************************
61 *****************************************************************************/
67 #define GESTURE( a, b, c, d ) (a | ( b << 4 ) | ( c << 8 ) | ( d << 12 ))
69 int Open ( vlc_object_t * );
70 void Close ( vlc_object_t * );
71 static int InitThread ( intf_thread_t *p_intf );
72 static void EndThread ( intf_thread_t *p_intf );
73 static int MouseEvent ( vlc_object_t *, char const *,
74 vlc_value_t, vlc_value_t, void * );
76 /* Exported functions */
77 static void RunIntf ( intf_thread_t *p_intf );
79 /*****************************************************************************
81 *****************************************************************************/
82 #define THRESHOLD_TEXT N_( "Motion threshold (10-100)" )
83 #define THRESHOLD_LONGTEXT N_( \
84 "Amount of movement required for a mouse gesture to be recorded." )
86 #define BUTTON_TEXT N_( "Trigger button" )
87 #define BUTTON_LONGTEXT N_( \
88 "Trigger button for mouse gestures." )
90 static const char *const button_list[] = { "left", "middle", "right" };
91 static const char *const button_list_text[] =
92 { N_("Left"), N_("Middle"), N_("Right") };
95 set_shortname( N_("Gestures"));
96 set_category( CAT_INTERFACE );
97 set_subcategory( SUBCAT_INTERFACE_CONTROL );
98 add_integer( "gestures-threshold", 30, NULL,
99 THRESHOLD_TEXT, THRESHOLD_LONGTEXT, true );
100 add_string( "gestures-button", "right", NULL,
101 BUTTON_TEXT, BUTTON_LONGTEXT, false );
102 change_string_list( button_list, button_list_text, 0 );
103 set_description( N_("Mouse gestures control interface") );
105 set_capability( "interface", 0 );
106 set_callbacks( Open, Close );
109 /*****************************************************************************
110 * OpenIntf: initialize interface
111 *****************************************************************************/
112 int Open ( vlc_object_t *p_this )
114 intf_thread_t *p_intf = (intf_thread_t *)p_this;
116 /* Allocate instance and initialize some members */
117 p_intf->p_sys = malloc( sizeof( intf_sys_t ) );
118 if( p_intf->p_sys == NULL )
123 p_intf->pf_run = RunIntf;
128 /*****************************************************************************
129 * gesture: return a subpattern within a pattern
130 *****************************************************************************/
131 static int gesture( int i_pattern, int i_num )
133 return ( i_pattern >> ( i_num * 4 ) ) & 0xF;
136 /*****************************************************************************
137 * input_from_playlist: don't forget to release the return value
138 * Also this function should really be available from core.
139 *****************************************************************************/
140 static input_thread_t * input_from_playlist ( playlist_t *p_playlist )
142 input_thread_t * p_input;
145 p_input = p_playlist->p_input;
147 vlc_object_yield( p_input );
153 /*****************************************************************************
154 * CloseIntf: destroy dummy interface
155 *****************************************************************************/
156 void Close ( vlc_object_t *p_this )
158 intf_thread_t *p_intf = (intf_thread_t *)p_this;
160 /* Destroy structure */
161 free( p_intf->p_sys );
165 /*****************************************************************************
167 *****************************************************************************/
168 static void RunIntf( intf_thread_t *p_intf )
170 playlist_t * p_playlist = NULL;
171 int canc = vlc_savecancel();
173 vlc_mutex_lock( &p_intf->change_lock );
174 p_intf->p_sys->p_vout = NULL;
175 vlc_mutex_unlock( &p_intf->change_lock );
177 if( InitThread( p_intf ) < 0 )
179 msg_Err( p_intf, "can't initialize interface thread" );
182 msg_Dbg( p_intf, "interface thread initialized" );
185 while( !intf_ShouldDie( p_intf ) )
187 vlc_mutex_lock( &p_intf->change_lock );
192 if( p_intf->p_sys->b_got_gesture )
197 /* If you modify this, please try to follow this convention:
198 Start with LEFT, RIGHT for playback related commands
199 and UP, DOWN, for other commands */
200 switch( p_intf->p_sys->i_pattern )
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 );
208 msg_Dbg(p_intf, "Go backward in the movie!");
211 i_interval = config_GetInt( p_intf , "short-jump-size" );
212 if ( i_interval > 0 ) {
213 val.i_time = ( (mtime_t)( i_interval ) * 1000000L);
214 var_Set( p_intf, "time-offset", val );
216 msg_Dbg(p_intf, "Go forward in the movie!");
218 case GESTURE(LEFT,UP,NONE,NONE):
220 msg_Dbg(p_intf, "Going slower.");
222 case GESTURE(RIGHT,UP,NONE,NONE):
224 msg_Dbg(p_intf, "Going faster.");
226 case GESTURE(LEFT,RIGHT,NONE,NONE):
227 case GESTURE(RIGHT,LEFT,NONE,NONE):
229 input_thread_t * p_input;
230 p_playlist = pl_Yield( p_intf );
232 p_input = input_from_playlist( p_playlist );
233 vlc_object_release( p_playlist );
238 val.i_int = PLAYING_S;
241 var_Get( p_input, "state", &val);
242 if( val.i_int == PAUSE_S )
244 val.i_int = PLAYING_S;
250 var_Set( p_input, "state", val);
252 msg_Dbg(p_intf, "Play/Pause");
253 vlc_object_release( p_input );
256 case GESTURE(LEFT,DOWN,NONE,NONE):
257 p_playlist = pl_Yield( p_intf );
259 playlist_Prev( p_playlist );
260 vlc_object_release( p_playlist );
262 case GESTURE(RIGHT,DOWN,NONE,NONE):
263 p_playlist = pl_Yield( p_intf );
265 playlist_Next( p_playlist );
266 vlc_object_release( p_playlist );
270 audio_volume_t i_newvol;
271 aout_VolumeUp( p_intf, 1, &i_newvol );
272 msg_Dbg(p_intf, "Louder");
277 audio_volume_t i_newvol;
278 aout_VolumeDown( p_intf, 1, &i_newvol );
279 msg_Dbg(p_intf, "Quieter");
282 case GESTURE(UP,DOWN,NONE,NONE):
283 case GESTURE(DOWN,UP,NONE,NONE):
285 audio_volume_t i_newvol = -1;
286 aout_VolumeMute( p_intf, &i_newvol );
287 msg_Dbg(p_intf, "Mute sound");
290 case GESTURE(UP,RIGHT,NONE,NONE):
292 input_thread_t * p_input;
293 vlc_value_t val, list, list2;
296 p_playlist = pl_Yield( p_intf );
298 p_input = input_from_playlist( p_playlist );
300 vlc_object_release( p_playlist );
305 var_Get( p_input, "audio-es", &val );
306 var_Change( p_input, "audio-es", VLC_VAR_GETCHOICES,
308 i_count = list.p_list->i_count;
311 vlc_object_release( p_input );
314 for( i = 0; i < i_count; i++ )
316 if( val.i_int == list.p_list->p_values[i].i_int )
321 /* value of audio-es was not in choices list */
325 "invalid current audio track, selecting 0" );
326 var_Set( p_input, "audio-es",
327 list.p_list->p_values[0] );
330 else if( i == i_count - 1 )
332 var_Set( p_input, "audio-es",
333 list.p_list->p_values[1] );
338 var_Set( p_input, "audio-es",
339 list.p_list->p_values[i+1] );
342 vlc_object_release( p_input );
345 case GESTURE(DOWN,RIGHT,NONE,NONE):
347 input_thread_t * p_input;
348 vlc_value_t val, list, list2;
351 p_playlist = pl_Yield( p_intf );
353 p_input = input_from_playlist( p_playlist );
354 vlc_object_release( p_playlist );
359 var_Get( p_input, "spu-es", &val );
361 var_Change( p_input, "spu-es", VLC_VAR_GETCHOICES,
363 i_count = list.p_list->i_count;
366 vlc_object_release( p_input );
369 for( i = 0; i < i_count; i++ )
371 if( val.i_int == list.p_list->p_values[i].i_int )
376 /* value of spu-es was not in choices list */
380 "invalid current subtitle track, selecting 0" );
381 var_Set( p_input, "spu-es", list.p_list->p_values[0] );
384 else if( i == i_count - 1 )
386 var_Set( p_input, "spu-es", list.p_list->p_values[0] );
391 var_Set( p_input, "spu-es",
392 list.p_list->p_values[i+1] );
395 vlc_object_release( p_input );
398 case GESTURE(UP,LEFT,NONE,NONE):
399 if (p_intf->p_sys->p_vout )
401 ((vout_thread_t *)p_intf->p_sys->p_vout)->i_changes |=
402 VOUT_FULLSCREEN_CHANGE;
405 case GESTURE(DOWN,LEFT,NONE,NONE):
406 /* FIXME: Should close the vout!"*/
407 vlc_object_kill( p_intf->p_libvlc );
409 case GESTURE(DOWN,LEFT,UP,RIGHT):
410 case GESTURE(UP,RIGHT,DOWN,LEFT):
411 msg_Dbg(p_intf, "a square was drawn!" );
416 p_intf->p_sys->i_num_gestures = 0;
417 p_intf->p_sys->i_pattern = 0;
418 p_intf->p_sys->b_got_gesture = false;
424 if( p_intf->p_sys->p_vout && !vlc_object_alive (p_intf->p_sys->p_vout) )
426 var_DelCallback( p_intf->p_sys->p_vout, "mouse-moved",
427 MouseEvent, p_intf );
428 var_DelCallback( p_intf->p_sys->p_vout, "mouse-button-down",
429 MouseEvent, p_intf );
430 vlc_object_release( p_intf->p_sys->p_vout );
431 p_intf->p_sys->p_vout = NULL;
434 if( p_intf->p_sys->p_vout == NULL )
436 p_intf->p_sys->p_vout = vlc_object_find( p_intf,
437 VLC_OBJECT_VOUT, FIND_ANYWHERE );
438 if( p_intf->p_sys->p_vout )
440 var_AddCallback( p_intf->p_sys->p_vout, "mouse-moved",
441 MouseEvent, p_intf );
442 var_AddCallback( p_intf->p_sys->p_vout, "mouse-button-down",
443 MouseEvent, p_intf );
447 vlc_mutex_unlock( &p_intf->change_lock );
450 msleep( INTF_IDLE_SLEEP );
454 vlc_restorecancel( canc );
457 /*****************************************************************************
459 *****************************************************************************/
460 static int InitThread( intf_thread_t * p_intf )
463 /* we might need some locking here */
464 if( !intf_ShouldDie( p_intf ) )
466 /* p_intf->change_lock locking strategy:
467 * - Every access to p_intf->p_sys are locked threw p_intf->change_lock
468 * - make sure there won't be cross increment/decrement ref count
469 * of p_intf->p_sys members p_intf->change_lock should be locked
470 * during those operations */
471 vlc_mutex_lock( &p_intf->change_lock );
473 p_intf->p_sys->b_got_gesture = false;
474 p_intf->p_sys->b_button_pressed = false;
475 p_intf->p_sys->i_threshold =
476 config_GetInt( p_intf, "gestures-threshold" );
477 psz_button = config_GetPsz( p_intf, "gestures-button" );
478 if ( !strcmp( psz_button, "left" ) )
480 p_intf->p_sys->i_button_mask = 1;
482 else if ( !strcmp( psz_button, "middle" ) )
484 p_intf->p_sys->i_button_mask = 2;
486 else if ( !strcmp( psz_button, "right" ) )
488 p_intf->p_sys->i_button_mask = 4;
492 p_intf->p_sys->i_pattern = 0;
493 p_intf->p_sys->i_num_gestures = 0;
494 vlc_mutex_unlock( &p_intf->change_lock );
504 /*****************************************************************************
506 *****************************************************************************/
507 static void EndThread( intf_thread_t * p_intf )
509 vlc_mutex_lock( &p_intf->change_lock );
511 if( p_intf->p_sys->p_vout )
513 var_DelCallback( p_intf->p_sys->p_vout, "mouse-moved",
514 MouseEvent, p_intf );
515 var_DelCallback( p_intf->p_sys->p_vout, "mouse-button-down",
516 MouseEvent, p_intf );
517 vlc_object_release( p_intf->p_sys->p_vout );
520 vlc_mutex_unlock( &p_intf->change_lock );
523 /*****************************************************************************
524 * MouseEvent: callback for mouse events
525 *****************************************************************************/
526 static int MouseEvent( vlc_object_t *p_this, char const *psz_var,
527 vlc_value_t oldval, vlc_value_t newval, void *p_data )
529 VLC_UNUSED(p_this); VLC_UNUSED(oldval);
533 signed int i_horizontal, i_vertical;
534 intf_thread_t *p_intf = (intf_thread_t *)p_data;
536 vlc_mutex_lock( &p_intf->change_lock );
538 /* don't process new gestures before the last events are processed */
539 if( p_intf->p_sys->b_got_gesture )
541 vlc_mutex_unlock( &p_intf->change_lock );
545 if( !strcmp(psz_var, "mouse-moved" ) && p_intf->p_sys->b_button_pressed )
547 var_Get( p_intf->p_sys->p_vout, "mouse-x", &val );
548 p_intf->p_sys->i_mouse_x = val.i_int;
549 var_Get( p_intf->p_sys->p_vout, "mouse-y", &val );
550 p_intf->p_sys->i_mouse_y = val.i_int;
551 i_horizontal = p_intf->p_sys->i_mouse_x -
552 p_intf->p_sys->i_last_x;
553 i_horizontal = i_horizontal / p_intf->p_sys->i_threshold;
554 i_vertical = p_intf->p_sys->i_mouse_y
555 - p_intf->p_sys->i_last_y;
556 i_vertical = i_vertical / p_intf->p_sys->i_threshold;
558 if( i_horizontal < 0 )
560 msg_Dbg( p_intf, "left gesture (%d)", i_horizontal );
563 else if( i_horizontal > 0 )
565 msg_Dbg( p_intf, "right gesture (%d)", i_horizontal );
570 msg_Dbg( p_intf, "up gesture (%d)", i_vertical );
573 else if( i_vertical > 0 )
575 msg_Dbg( p_intf, "down gesture (%d)", i_vertical );
580 p_intf->p_sys->i_last_y = p_intf->p_sys->i_mouse_y;
581 p_intf->p_sys->i_last_x = p_intf->p_sys->i_mouse_x;
582 if( gesture( p_intf->p_sys->i_pattern,
583 p_intf->p_sys->i_num_gestures - 1 ) != pattern )
585 p_intf->p_sys->i_pattern |=
586 pattern << ( p_intf->p_sys->i_num_gestures * 4 );
587 p_intf->p_sys->i_num_gestures++;
592 if( !strcmp( psz_var, "mouse-button-down" )
593 && newval.i_int & p_intf->p_sys->i_button_mask
594 && !p_intf->p_sys->b_button_pressed )
596 p_intf->p_sys->b_button_pressed = true;
597 var_Get( p_intf->p_sys->p_vout, "mouse-x", &val );
598 p_intf->p_sys->i_last_x = val.i_int;
599 var_Get( p_intf->p_sys->p_vout, "mouse-y", &val );
600 p_intf->p_sys->i_last_y = val.i_int;
602 if( !strcmp( psz_var, "mouse-button-down" )
603 && !( newval.i_int & p_intf->p_sys->i_button_mask )
604 && p_intf->p_sys->b_button_pressed )
606 p_intf->p_sys->b_button_pressed = false;
607 p_intf->p_sys->b_got_gesture = true;
610 vlc_mutex_unlock( &p_intf->change_lock );