1 /*****************************************************************************
2 * gestures.c: control vlc with mouse gestures
3 *****************************************************************************
4 * Copyright (C) 2004-2009 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 MouseEvent ( vlc_object_t *, char const *,
72 vlc_value_t, vlc_value_t, void * );
74 /* Exported functions */
75 static void RunIntf ( intf_thread_t *p_intf );
77 /*****************************************************************************
79 *****************************************************************************/
80 #define THRESHOLD_TEXT N_( "Motion threshold (10-100)" )
81 #define THRESHOLD_LONGTEXT N_( \
82 "Amount of movement required for a mouse gesture to be recorded." )
84 #define BUTTON_TEXT N_( "Trigger button" )
85 #define BUTTON_LONGTEXT N_( \
86 "Trigger button for mouse gestures." )
88 static const char *const button_list[] = { "left", "middle", "right" };
89 static const char *const button_list_text[] =
90 { N_("Left"), N_("Middle"), N_("Right") };
93 set_shortname( N_("Gestures"))
94 set_category( CAT_INTERFACE )
95 set_subcategory( SUBCAT_INTERFACE_CONTROL )
96 add_integer( "gestures-threshold", 30, NULL,
97 THRESHOLD_TEXT, THRESHOLD_LONGTEXT, true )
98 add_string( "gestures-button", "right", NULL,
99 BUTTON_TEXT, BUTTON_LONGTEXT, false )
100 change_string_list( button_list, button_list_text, 0 )
101 set_description( N_("Mouse gestures control interface") )
103 set_capability( "interface", 0 )
104 set_callbacks( Open, Close )
107 /*****************************************************************************
108 * OpenIntf: initialize interface
109 *****************************************************************************/
110 int Open ( vlc_object_t *p_this )
112 intf_thread_t *p_intf = (intf_thread_t *)p_this;
114 /* Allocate instance and initialize some members */
115 intf_sys_t *p_sys = p_intf->p_sys = malloc( sizeof( intf_sys_t ) );
116 if( p_intf->p_sys == NULL )
119 // Configure the module
120 p_intf->pf_run = RunIntf;
122 p_sys->p_vout = NULL;
123 p_sys->b_got_gesture = false;
124 p_sys->b_button_pressed = false;
125 p_sys->i_threshold = config_GetInt( p_intf, "gestures-threshold" );
127 // Choose the tight button to use
128 char *psz_button = config_GetPsz( p_intf, "gestures-button" );
129 if( !strcmp( psz_button, "left" ) )
130 p_sys->i_button_mask = 1;
131 else if( !strcmp( psz_button, "middle" ) )
132 p_sys->i_button_mask = 2;
133 else // psz_button == "right"
134 p_sys->i_button_mask = 4;
137 p_sys->i_pattern = 0;
138 p_sys->i_num_gestures = 0;
143 /*****************************************************************************
144 * gesture: return a subpattern within a pattern
145 *****************************************************************************/
146 static int gesture( int i_pattern, int i_num )
148 return ( i_pattern >> ( i_num * 4 ) ) & 0xF;
151 /*****************************************************************************
152 * CloseIntf: destroy dummy interface
153 *****************************************************************************/
154 void Close ( vlc_object_t *p_this )
156 intf_thread_t *p_intf = (intf_thread_t *)p_this;
158 // Destroy the callbacks
159 if( p_intf->p_sys->p_vout )
161 var_DelCallback( p_intf->p_sys->p_vout, "mouse-moved",
162 MouseEvent, p_intf );
163 var_DelCallback( p_intf->p_sys->p_vout, "mouse-button-down",
164 MouseEvent, p_intf );
165 vlc_object_release( p_intf->p_sys->p_vout );
168 /* Destroy structure */
169 free( p_intf->p_sys );
173 /*****************************************************************************
175 *****************************************************************************/
176 static void RunIntf( intf_thread_t *p_intf )
178 playlist_t * p_playlist = NULL;
179 int canc = vlc_savecancel();
180 input_thread_t *p_input;
183 while( vlc_object_alive( p_intf ) )
185 vlc_mutex_lock( &p_intf->change_lock );
190 if( p_intf->p_sys->b_got_gesture )
195 /* If you modify this, please try to follow this convention:
196 Start with LEFT, RIGHT for playback related commands
197 and UP, DOWN, for other commands */
198 switch( p_intf->p_sys->i_pattern )
201 msg_Dbg( p_intf, "Go backward in the movie!" );
202 p_playlist = pl_Hold( p_intf );
203 p_input = playlist_CurrentInput( p_playlist );
204 pl_Release( p_intf );
207 i_interval = config_GetInt( p_intf , "short-jump-size" );
208 if ( i_interval > 0 )
210 val.i_time = ( (mtime_t)( -i_interval ) * 1000000L);
211 var_Set( p_input, "time-offset", val );
213 vlc_object_release( p_input );
218 msg_Dbg( p_intf, "Go forward in the movie!" );
219 p_playlist = pl_Hold( p_intf );
220 p_input = playlist_CurrentInput( p_playlist );
221 pl_Release( p_intf );
225 i_interval = config_GetInt( p_intf , "short-jump-size" );
226 if ( i_interval > 0 )
228 val.i_time = ( (mtime_t)( i_interval ) * 1000000L);
229 var_Set( p_input, "time-offset", val );
231 vlc_object_release( p_input );
235 case GESTURE(LEFT,UP,NONE,NONE):
236 msg_Dbg( p_intf, "Going slower." );
237 p_playlist = pl_Hold( p_intf );
238 p_input = playlist_CurrentInput( p_playlist );
239 pl_Release( p_intf );
242 var_SetVoid( p_input, "rate-slower" );
243 vlc_object_release( p_input );
247 case GESTURE(RIGHT,UP,NONE,NONE):
248 msg_Dbg( p_intf, "Going faster." );
249 p_playlist = pl_Hold( p_intf );
250 p_input = playlist_CurrentInput( p_playlist );
251 pl_Release( p_intf );
254 var_SetVoid( p_input, "rate-faster" );
255 vlc_object_release( p_input );
259 case GESTURE(LEFT,RIGHT,NONE,NONE):
260 case GESTURE(RIGHT,LEFT,NONE,NONE):
261 msg_Dbg( p_intf, "Play/Pause" );
262 p_playlist = pl_Hold( p_intf );
263 p_input = playlist_CurrentInput( p_playlist );
264 pl_Release( p_intf );
268 var_Get( p_input, "state", &val);
269 val.i_int = ( val.i_int != PLAYING_S ) ? PLAYING_S : PAUSE_S;
270 var_Set( p_input, "state", val);
271 vlc_object_release( p_input );
275 case GESTURE(LEFT,DOWN,NONE,NONE):
276 p_playlist = pl_Hold( p_intf );
277 playlist_Prev( p_playlist );
278 pl_Release( p_intf );
281 case GESTURE(RIGHT,DOWN,NONE,NONE):
282 p_playlist = pl_Hold( p_intf );
283 playlist_Next( p_playlist );
284 pl_Release( p_intf );
288 msg_Dbg(p_intf, "Louder");
289 aout_VolumeUp( p_intf, 1, NULL );
293 msg_Dbg(p_intf, "Quieter");
294 aout_VolumeDown( p_intf, 1, NULL );
297 case GESTURE(UP,DOWN,NONE,NONE):
298 case GESTURE(DOWN,UP,NONE,NONE):
299 msg_Dbg(p_intf, "Mute sound");
300 aout_VolumeMute( p_intf, NULL );
303 case GESTURE(UP,RIGHT,NONE,NONE):
305 vlc_value_t val, list, list2;
308 p_playlist = pl_Hold( p_intf );
309 p_input = playlist_CurrentInput( p_playlist );
310 pl_Release( p_intf );
315 var_Get( p_input, "audio-es", &val );
316 var_Change( p_input, "audio-es", VLC_VAR_GETCHOICES,
318 i_count = list.p_list->i_count;
321 vlc_object_release( p_input );
324 for( i = 0; i < i_count; i++ )
326 if( val.i_int == list.p_list->p_values[i].i_int )
329 /* value of audio-es was not in choices list */
333 "invalid current audio track, selecting 0" );
336 else if( i == i_count - 1 )
340 var_Set( p_input, "audio-es", list.p_list->p_values[i] );
341 vlc_object_release( p_input );
344 case GESTURE(DOWN,RIGHT,NONE,NONE):
346 vlc_value_t val, list, list2;
349 p_playlist = pl_Hold( p_intf );
350 p_input = playlist_CurrentInput( p_playlist );
351 pl_Release( p_intf );
356 var_Get( p_input, "spu-es", &val );
358 var_Change( p_input, "spu-es", VLC_VAR_GETCHOICES,
360 i_count = list.p_list->i_count;
363 vlc_object_release( p_input );
366 for( i = 0; i < i_count; i++ )
368 if( val.i_int == list.p_list->p_values[i].i_int )
373 /* value of spu-es was not in choices list */
377 "invalid current subtitle track, selecting 0" );
380 else if( i == i_count - 1 )
384 var_Set( p_input, "spu-es", list.p_list->p_values[i] );
385 vlc_object_release( p_input );
389 case GESTURE(UP,LEFT,NONE,NONE):
390 if (p_intf->p_sys->p_vout )
392 var_Get( p_intf->p_sys->p_vout, "fullscreen", &val );
393 val.b_bool = !val.b_bool;
394 var_Set( p_intf->p_sys->p_vout, "fullscreen", val );
398 case GESTURE(DOWN,LEFT,NONE,NONE):
399 /* FIXME: Should close the vout!"*/
400 libvlc_Quit( p_intf->p_libvlc );
402 case GESTURE(DOWN,LEFT,UP,RIGHT):
403 case GESTURE(UP,RIGHT,DOWN,LEFT):
404 msg_Dbg(p_intf, "a square was drawn!" );
409 p_intf->p_sys->i_num_gestures = 0;
410 p_intf->p_sys->i_pattern = 0;
411 p_intf->p_sys->b_got_gesture = false;
417 if( p_intf->p_sys->p_vout && !vlc_object_alive (p_intf->p_sys->p_vout) )
419 var_DelCallback( p_intf->p_sys->p_vout, "mouse-moved",
420 MouseEvent, p_intf );
421 var_DelCallback( p_intf->p_sys->p_vout, "mouse-button-down",
422 MouseEvent, p_intf );
423 vlc_object_release( p_intf->p_sys->p_vout );
424 p_intf->p_sys->p_vout = NULL;
427 if( p_intf->p_sys->p_vout == NULL )
429 p_playlist = pl_Hold( p_intf );
430 p_input = playlist_CurrentInput( p_playlist );
431 pl_Release( p_intf );
434 p_intf->p_sys->p_vout = input_GetVout( p_input );
435 vlc_object_release( p_input );
437 if( p_intf->p_sys->p_vout )
439 var_AddCallback( p_intf->p_sys->p_vout, "mouse-moved",
440 MouseEvent, p_intf );
441 var_AddCallback( p_intf->p_sys->p_vout, "mouse-button-down",
442 MouseEvent, p_intf );
446 vlc_mutex_unlock( &p_intf->change_lock );
449 msleep( INTF_IDLE_SLEEP );
452 vlc_restorecancel( canc );
455 /*****************************************************************************
456 * MouseEvent: callback for mouse events
457 *****************************************************************************/
458 static int MouseEvent( vlc_object_t *p_this, char const *psz_var,
459 vlc_value_t oldval, vlc_value_t newval, void *p_data )
461 VLC_UNUSED(p_this); VLC_UNUSED(oldval);
465 signed int i_horizontal, i_vertical;
466 intf_thread_t *p_intf = (intf_thread_t *)p_data;
468 vlc_mutex_lock( &p_intf->change_lock );
470 /* don't process new gestures before the last events are processed */
471 if( p_intf->p_sys->b_got_gesture )
473 vlc_mutex_unlock( &p_intf->change_lock );
477 if( !strcmp(psz_var, "mouse-moved" ) && p_intf->p_sys->b_button_pressed )
479 var_Get( p_intf->p_sys->p_vout, "mouse-x", &val );
480 p_intf->p_sys->i_mouse_x = val.i_int;
481 var_Get( p_intf->p_sys->p_vout, "mouse-y", &val );
482 p_intf->p_sys->i_mouse_y = val.i_int;
483 i_horizontal = p_intf->p_sys->i_mouse_x -
484 p_intf->p_sys->i_last_x;
485 i_horizontal = i_horizontal / p_intf->p_sys->i_threshold;
486 i_vertical = p_intf->p_sys->i_mouse_y
487 - p_intf->p_sys->i_last_y;
488 i_vertical = i_vertical / p_intf->p_sys->i_threshold;
490 if( i_horizontal < 0 )
492 msg_Dbg( p_intf, "left gesture (%d)", i_horizontal );
495 else if( i_horizontal > 0 )
497 msg_Dbg( p_intf, "right gesture (%d)", i_horizontal );
502 msg_Dbg( p_intf, "up gesture (%d)", i_vertical );
505 else if( i_vertical > 0 )
507 msg_Dbg( p_intf, "down gesture (%d)", i_vertical );
512 p_intf->p_sys->i_last_y = p_intf->p_sys->i_mouse_y;
513 p_intf->p_sys->i_last_x = p_intf->p_sys->i_mouse_x;
514 if( gesture( p_intf->p_sys->i_pattern,
515 p_intf->p_sys->i_num_gestures - 1 ) != pattern )
517 p_intf->p_sys->i_pattern |=
518 pattern << ( p_intf->p_sys->i_num_gestures * 4 );
519 p_intf->p_sys->i_num_gestures++;
524 if( !strcmp( psz_var, "mouse-button-down" )
525 && newval.i_int & p_intf->p_sys->i_button_mask
526 && !p_intf->p_sys->b_button_pressed )
528 p_intf->p_sys->b_button_pressed = true;
529 var_Get( p_intf->p_sys->p_vout, "mouse-x", &val );
530 p_intf->p_sys->i_last_x = val.i_int;
531 var_Get( p_intf->p_sys->p_vout, "mouse-y", &val );
532 p_intf->p_sys->i_last_y = val.i_int;
534 if( !strcmp( psz_var, "mouse-button-down" )
535 && !( newval.i_int & p_intf->p_sys->i_button_mask )
536 && p_intf->p_sys->b_button_pressed )
538 p_intf->p_sys->b_button_pressed = false;
539 p_intf->p_sys->b_got_gesture = true;
542 vlc_mutex_unlock( &p_intf->change_lock );