1 /*****************************************************************************
2 * hotkeys.c: Hotkey handling for vlc
3 *****************************************************************************
4 * Copyright (C) 2004 VideoLAN
7 * Authors: Sigmund Augdal <sigmunau@idi.ntnu.no>
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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
27 #include <stdlib.h> /* malloc(), free() */
31 #include <vlc/input.h>
38 #define BUFFER_SIZE 10
40 #define CHANNELS_NUMBER 4
41 #define VOLUME_TEXT_CHAN p_intf->p_sys->p_channels[ 0 ]
42 #define VOLUME_WIDGET_CHAN p_intf->p_sys->p_channels[ 1 ]
43 #define POSITION_TEXT_CHAN p_intf->p_sys->p_channels[ 2 ]
44 #define POSITION_WIDGET_CHAN p_intf->p_sys->p_channels[ 3 ]
45 /*****************************************************************************
46 * intf_sys_t: description and status of FB interface
47 *****************************************************************************/
50 vlc_mutex_t change_lock; /* mutex to keep the callback
51 * and the main loop from
52 * stepping on each others
54 int p_keys[ BUFFER_SIZE ]; /* buffer that contains
56 int i_size; /* number of events in buffer */
57 int p_channels[ CHANNELS_NUMBER ]; /* contains registered
59 input_thread_t * p_input; /* pointer to input */
60 vout_thread_t * p_vout; /* pointer to vout object */
63 /*****************************************************************************
65 *****************************************************************************/
66 static int Open ( vlc_object_t * );
67 static void Close ( vlc_object_t * );
68 static void Run ( intf_thread_t * );
69 static int GetKey ( intf_thread_t *);
70 static int KeyEvent( vlc_object_t *, char const *,
71 vlc_value_t, vlc_value_t, void * );
72 static int ActionKeyCB( vlc_object_t *, char const *,
73 vlc_value_t, vlc_value_t, void * );
74 static void PlayBookmark( intf_thread_t *, int );
75 static void SetBookmark ( intf_thread_t *, int );
76 static void DisplayPosition( intf_thread_t *, vout_thread_t *, input_thread_t * );
77 static void DisplayVolume ( intf_thread_t *, vout_thread_t *, audio_volume_t );
78 static void ClearChannels ( intf_thread_t *, vout_thread_t * );
80 /*****************************************************************************
82 *****************************************************************************/
83 #define BOOKMARK1_TEXT N_("Playlist bookmark 1")
84 #define BOOKMARK2_TEXT N_("Playlist bookmark 2")
85 #define BOOKMARK3_TEXT N_("Playlist bookmark 3")
86 #define BOOKMARK4_TEXT N_("Playlist bookmark 4")
87 #define BOOKMARK5_TEXT N_("Playlist bookmark 5")
88 #define BOOKMARK6_TEXT N_("Playlist bookmark 6")
89 #define BOOKMARK7_TEXT N_("Playlist bookmark 7")
90 #define BOOKMARK8_TEXT N_("Playlist bookmark 8")
91 #define BOOKMARK9_TEXT N_("Playlist bookmark 9")
92 #define BOOKMARK10_TEXT N_("Playlist bookmark 10")
93 #define BOOKMARK_LONGTEXT N_( \
94 "This option allows you to define playlist bookmarks.")
97 set_description( _("Hotkeys management interface") );
98 add_string( "bookmark1", NULL, NULL,
99 BOOKMARK1_TEXT, BOOKMARK_LONGTEXT, VLC_FALSE );
100 add_string( "bookmark2", NULL, NULL,
101 BOOKMARK2_TEXT, BOOKMARK_LONGTEXT, VLC_FALSE );
102 add_string( "bookmark3", NULL, NULL,
103 BOOKMARK3_TEXT, BOOKMARK_LONGTEXT, VLC_FALSE );
104 add_string( "bookmark4", NULL, NULL,
105 BOOKMARK4_TEXT, BOOKMARK_LONGTEXT, VLC_FALSE );
106 add_string( "bookmark5", NULL, NULL,
107 BOOKMARK5_TEXT, BOOKMARK_LONGTEXT, VLC_FALSE );
108 add_string( "bookmark6", NULL, NULL,
109 BOOKMARK6_TEXT, BOOKMARK_LONGTEXT, VLC_FALSE );
110 add_string( "bookmark7", NULL, NULL,
111 BOOKMARK7_TEXT, BOOKMARK_LONGTEXT, VLC_FALSE );
112 add_string( "bookmark8", NULL, NULL,
113 BOOKMARK8_TEXT, BOOKMARK_LONGTEXT, VLC_FALSE );
114 add_string( "bookmark9", NULL, NULL,
115 BOOKMARK9_TEXT, BOOKMARK_LONGTEXT, VLC_FALSE );
116 add_string( "bookmark10", NULL, NULL,
117 BOOKMARK10_TEXT, BOOKMARK_LONGTEXT, VLC_FALSE );
119 set_capability( "interface", 0 );
120 set_callbacks( Open, Close );
123 /*****************************************************************************
124 * Open: initialize interface
125 *****************************************************************************/
126 static int Open( vlc_object_t *p_this )
128 intf_thread_t *p_intf = (intf_thread_t *)p_this;
130 /* Allocate instance and initialize some members */
131 p_intf->p_sys = malloc( sizeof( intf_sys_t ) );
132 if( p_intf->p_sys == NULL )
134 msg_Err( p_intf, "out of memory" );
137 vlc_mutex_init( p_intf, &p_intf->p_sys->change_lock );
138 p_intf->p_sys->i_size = 0;
139 p_intf->pf_run = Run;
141 p_intf->p_sys->p_input = NULL;
142 p_intf->p_sys->p_vout = NULL;
144 var_AddCallback( p_intf->p_vlc, "key-pressed", KeyEvent, p_intf );
148 /*****************************************************************************
149 * Close: destroy interface
150 *****************************************************************************/
151 static void Close( vlc_object_t *p_this )
153 intf_thread_t *p_intf = (intf_thread_t *)p_this;
155 if( p_intf->p_sys->p_input )
157 vlc_object_release( p_intf->p_sys->p_input );
159 if( p_intf->p_sys->p_vout )
161 vlc_object_release( p_intf->p_sys->p_vout );
163 /* Destroy structure */
164 free( p_intf->p_sys );
167 /*****************************************************************************
169 *****************************************************************************/
170 static void Run( intf_thread_t *p_intf )
172 playlist_t *p_playlist;
173 input_thread_t *p_input;
174 vout_thread_t *p_vout = NULL;
175 vout_thread_t *p_last_vout;
176 struct hotkey *p_hotkeys = p_intf->p_vlc->p_hotkeys;
180 /* Initialize hotkey structure */
181 for( i = 0; p_hotkeys[i].psz_action != NULL; i++ )
183 var_Create( p_intf->p_vlc, p_hotkeys[i].psz_action,
184 VLC_VAR_HOTKEY | VLC_VAR_DOINHERIT );
186 var_AddCallback( p_intf->p_vlc, p_hotkeys[i].psz_action,
188 var_Get( p_intf->p_vlc, p_hotkeys[i].psz_action, &val );
189 var_Set( p_intf->p_vlc, p_hotkeys[i].psz_action, val );
192 while( !p_intf->b_die )
197 msleep( INTF_IDLE_SLEEP );
199 /* Update the input */
200 if( p_intf->p_sys->p_input == NULL )
202 p_intf->p_sys->p_input = vlc_object_find( p_intf, VLC_OBJECT_INPUT,
205 else if( p_intf->p_sys->p_input->b_dead )
207 vlc_object_release( p_intf->p_sys->p_input );
208 p_intf->p_sys->p_input = NULL;
210 p_input = p_intf->p_sys->p_input;
212 /* Update the vout */
213 p_last_vout = p_intf->p_sys->p_vout;
216 p_vout = vlc_object_find( p_intf, VLC_OBJECT_VOUT, FIND_ANYWHERE );
217 p_intf->p_sys->p_vout = p_vout;
219 else if( p_vout->b_die )
221 vlc_object_release( p_vout );
223 p_intf->p_sys->p_vout = NULL;
226 /* Register OSD channels */
227 if( p_vout && p_vout != p_last_vout )
229 for( i = 0; i < CHANNELS_NUMBER; i++ )
231 p_intf->p_sys->p_channels[ i ] =
232 vout_RegisterOSDChannel( p_vout );
236 /* Find action triggered by hotkey */
238 i_key = GetKey( p_intf );
239 for( i = 0; p_hotkeys[i].psz_action != NULL; i++ )
241 if( p_hotkeys[i].i_key == i_key )
243 i_action = p_hotkeys[i].i_action;
249 /* No key pressed, sleep a bit more */
250 msleep( INTF_IDLE_SLEEP );
254 if( i_action == ACTIONID_QUIT )
256 p_intf->p_vlc->b_die = VLC_TRUE;
257 ClearChannels( p_intf, p_vout );
258 vout_OSDMessage( p_intf, DEFAULT_CHAN, _( "Quit" ) );
261 else if( i_action == ACTIONID_VOL_UP )
263 audio_volume_t i_newvol;
264 aout_VolumeUp( p_intf, 1, &i_newvol );
265 DisplayVolume( p_intf, p_vout, i_newvol );
267 else if( i_action == ACTIONID_VOL_DOWN )
269 audio_volume_t i_newvol;
270 aout_VolumeDown( p_intf, 1, &i_newvol );
271 DisplayVolume( p_intf, p_vout, i_newvol );
273 else if( i_action == ACTIONID_VOL_MUTE )
275 audio_volume_t i_newvol = -1;
276 aout_VolumeMute( p_intf, &i_newvol );
281 ClearChannels( p_intf, p_vout );
282 vout_OSDIcon( VLC_OBJECT( p_intf ), DEFAULT_CHAN,
287 DisplayVolume( p_intf, p_vout, i_newvol );
292 else if( i_action == ACTIONID_SUBDELAY_DOWN )
294 int64_t i_delay = var_GetTime( p_input, "spu-delay" );
296 i_delay -= 10000; /* 10 ms */
298 var_SetTime( p_input, "spu-delay", i_delay );
299 ClearChannels( p_intf, p_vout );
300 vout_OSDMessage( p_intf, DEFAULT_CHAN, "Subtitle delay %i ms",
301 (int)(i_delay/1000) );
303 else if( i_action == ACTIONID_SUBDELAY_UP )
305 int64_t i_delay = var_GetTime( p_input, "spu-delay" );
307 i_delay += 10000; /* 10 ms */
309 var_SetTime( p_input, "spu-delay", i_delay );
310 ClearChannels( p_intf, p_vout );
311 vout_OSDMessage( p_intf, DEFAULT_CHAN, "Subtitle delay %i ms",
312 (int)(i_delay/1000) );
314 else if( i_action == ACTIONID_FULLSCREEN && p_vout )
316 var_Get( p_vout, "fullscreen", &val );
317 var_Set( p_vout, "fullscreen", (vlc_value_t)!val.b_bool );
319 else if( i_action == ACTIONID_PLAY )
321 p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
325 playlist_Play( p_playlist );
326 vlc_object_release( p_playlist );
329 else if( i_action == ACTIONID_PLAY_PAUSE )
331 val.i_int = PLAYING_S;
334 var_Get( p_input, "state", &val );
336 if( p_input && val.i_int != PAUSE_S )
338 ClearChannels( p_intf, p_vout );
339 vout_OSDIcon( VLC_OBJECT( p_intf ), DEFAULT_CHAN,
342 var_Set( p_input, "state", val );
346 p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
350 ClearChannels( p_intf, p_vout );
351 vout_OSDIcon( VLC_OBJECT( p_intf ), DEFAULT_CHAN,
353 playlist_Play( p_playlist );
354 vlc_object_release( p_playlist );
361 * How to get a valid value ?
362 * That's not that easy with some special stream
364 vlc_bool_t b_seekable = VLC_TRUE;
366 if( i_action == ACTIONID_PAUSE )
368 ClearChannels( p_intf, p_vout );
369 vout_OSDIcon( VLC_OBJECT( p_intf ), DEFAULT_CHAN,
372 var_Set( p_input, "state", val );
374 else if( i_action == ACTIONID_JUMP_BACKWARD_10SEC && b_seekable )
376 val.i_time = -10000000;
377 var_Set( p_input, "time-offset", val );
378 DisplayPosition( p_intf, p_vout, p_input );
380 else if( i_action == ACTIONID_JUMP_FORWARD_10SEC && b_seekable )
382 val.i_time = 10000000;
383 var_Set( p_input, "time-offset", val );
384 DisplayPosition( p_intf, p_vout, p_input );
386 else if( i_action == ACTIONID_JUMP_BACKWARD_1MIN && b_seekable )
388 val.i_time = -60000000;
389 var_Set( p_input, "time-offset", val );
390 DisplayPosition( p_intf, p_vout, p_input );
392 else if( i_action == ACTIONID_JUMP_FORWARD_1MIN && b_seekable )
394 val.i_time = 60000000;
395 var_Set( p_input, "time-offset", val );
396 DisplayPosition( p_intf, p_vout, p_input );
398 else if( i_action == ACTIONID_JUMP_BACKWARD_5MIN && b_seekable )
400 val.i_time = -300000000;
401 var_Set( p_input, "time-offset", val );
402 DisplayPosition( p_intf, p_vout, p_input );
404 else if( i_action == ACTIONID_JUMP_FORWARD_5MIN && b_seekable )
406 val.i_time = 300000000;
407 var_Set( p_input, "time-offset", val );
408 DisplayPosition( p_intf, p_vout, p_input );
410 else if( i_action == ACTIONID_AUDIO_TRACK )
412 vlc_value_t val, list, list2;
414 var_Get( p_input, "audio-es", &val );
415 var_Change( p_input, "audio-es", VLC_VAR_GETCHOICES,
417 i_count = list.p_list->i_count;
422 for( i = 0; i < i_count; i++ )
424 if( val.i_int == list.p_list->p_values[i].i_int )
429 /* value of audio-es was not in choices list */
433 "invalid current audio track, selecting 0" );
434 var_Set( p_input, "audio-es",
435 list.p_list->p_values[0] );
438 else if( i == i_count - 1 )
440 var_Set( p_input, "audio-es",
441 list.p_list->p_values[1] );
446 var_Set( p_input, "audio-es",
447 list.p_list->p_values[i+1] );
450 vout_OSDMessage( VLC_OBJECT(p_input), DEFAULT_CHAN,
451 _("Audio track: %s"),
452 list2.p_list->p_values[i].psz_string );
454 else if( i_action == ACTIONID_SUBTITLE_TRACK )
456 vlc_value_t val, list, list2;
458 var_Get( p_input, "spu-es", &val );
459 var_Change( p_input, "spu-es", VLC_VAR_GETCHOICES,
461 i_count = list.p_list->i_count;
462 for( i = 0; i < i_count; i++ )
464 if( val.i_int == list.p_list->p_values[i].i_int )
469 /* value of audio-es was not in choices list */
472 msg_Warn( p_input, "invalid current subtitle track, selecting 0" );
473 var_Set( p_input, "spu-es", list.p_list->p_values[0] );
476 else if( i == i_count - 1 )
478 var_Set( p_input, "spu-es", list.p_list->p_values[0] );
483 var_Set( p_input, "spu-es", list.p_list->p_values[i+1] );
486 vout_OSDMessage( VLC_OBJECT(p_input), DEFAULT_CHAN,
487 _("Subtitle track: %s"),
488 list2.p_list->p_values[i].psz_string );
490 else if( i_action == ACTIONID_NEXT )
492 p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
496 playlist_Next( p_playlist );
497 vlc_object_release( p_playlist );
500 else if( i_action == ACTIONID_PREV )
502 p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
506 playlist_Prev( p_playlist );
507 vlc_object_release( p_playlist );
510 else if( i_action == ACTIONID_STOP )
512 p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
516 playlist_Stop( p_playlist );
517 vlc_object_release( p_playlist );
520 else if( i_action == ACTIONID_FASTER )
522 vlc_value_t val; val.b_bool = VLC_TRUE;
523 var_Set( p_input, "rate-faster", val );
525 else if( i_action == ACTIONID_SLOWER )
527 vlc_value_t val; val.b_bool = VLC_TRUE;
528 var_Set( p_input, "rate-slower", val );
530 else if( i_action == ACTIONID_POSITION && b_seekable )
532 DisplayPosition( p_intf, p_vout, p_input );
534 else if( i_action >= ACTIONID_PLAY_BOOKMARK1 &&
535 i_action <= ACTIONID_PLAY_BOOKMARK10 )
537 PlayBookmark( p_intf, i_action - ACTIONID_PLAY_BOOKMARK1 + 1 );
539 else if( i_action >= ACTIONID_SET_BOOKMARK1 &&
540 i_action <= ACTIONID_SET_BOOKMARK10 )
542 SetBookmark( p_intf, i_action - ACTIONID_SET_BOOKMARK1 + 1 );
548 static int GetKey( intf_thread_t *p_intf)
550 vlc_mutex_lock( &p_intf->p_sys->change_lock );
551 if ( p_intf->p_sys->i_size == 0 )
553 vlc_mutex_unlock( &p_intf->p_sys->change_lock );
558 int i_return = p_intf->p_sys->p_keys[ 0 ];
560 p_intf->p_sys->i_size--;
561 for ( i = 0; i < BUFFER_SIZE - 1; i++)
563 p_intf->p_sys->p_keys[ i ] = p_intf->p_sys->p_keys[ i + 1 ];
565 vlc_mutex_unlock( &p_intf->p_sys->change_lock );
570 /*****************************************************************************
571 * KeyEvent: callback for keyboard events
572 *****************************************************************************/
573 static int KeyEvent( vlc_object_t *p_this, char const *psz_var,
574 vlc_value_t oldval, vlc_value_t newval, void *p_data )
576 intf_thread_t *p_intf = (intf_thread_t *)p_data;
577 vlc_mutex_lock( &p_intf->p_sys->change_lock );
578 if ( p_intf->p_sys->i_size == BUFFER_SIZE )
580 msg_Warn( p_intf, "event buffer full, dropping keypress" );
581 vlc_mutex_unlock( &p_intf->p_sys->change_lock );
586 p_intf->p_sys->p_keys[ p_intf->p_sys->i_size ] = newval.i_int;
587 p_intf->p_sys->i_size++;
589 vlc_mutex_unlock( &p_intf->p_sys->change_lock );
594 static int ActionKeyCB( vlc_object_t *p_this, char const *psz_var,
595 vlc_value_t oldval, vlc_value_t newval, void *p_data )
597 vlc_t *p_vlc = (vlc_t *)p_this;
598 struct hotkey *p_hotkeys = p_vlc->p_hotkeys;
601 for( i = 0; p_hotkeys[i].psz_action != NULL; i++ )
603 if( !strcmp( p_hotkeys[i].psz_action, psz_var ) )
605 p_hotkeys[i].i_key = newval.i_int;
612 static void PlayBookmark( intf_thread_t *p_intf, int i_num )
616 char psz_bookmark_name[11];
617 playlist_t *p_playlist =
618 vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
620 sprintf( psz_bookmark_name, "bookmark%i", i_num );
621 var_Create( p_intf, psz_bookmark_name, VLC_VAR_STRING|VLC_VAR_DOINHERIT );
622 var_Get( p_intf, psz_bookmark_name, &val );
626 char *psz_bookmark = strdup( val.psz_string );
627 for( i_position = 0; i_position < p_playlist->i_size; i_position++)
629 if( !strcmp( psz_bookmark,
630 p_playlist->pp_items[i_position]->input.psz_uri ) )
632 playlist_Goto( p_playlist, i_position );
636 vlc_object_release( p_playlist );
640 static void SetBookmark( intf_thread_t *p_intf, int i_num )
643 playlist_t *p_playlist =
644 vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
647 char psz_bookmark_name[11];
648 sprintf( psz_bookmark_name, "bookmark%i", i_num );
649 var_Create( p_intf, psz_bookmark_name,
650 VLC_VAR_STRING|VLC_VAR_DOINHERIT );
651 val.psz_string = strdup( p_playlist->pp_items[p_playlist->i_index]->input.psz_uri );
652 var_Set( p_intf, psz_bookmark_name, val );
653 msg_Info( p_intf, "setting playlist bookmark %i to %s", i_num,
655 vlc_object_release( p_playlist );
659 static void DisplayPosition( intf_thread_t *p_intf, vout_thread_t *p_vout,
660 input_thread_t *p_input )
662 char psz_duration[MSTRTIME_MAX_SIZE];
663 char psz_time[MSTRTIME_MAX_SIZE];
664 vlc_value_t time, pos;
671 ClearChannels( p_intf, p_vout );
673 var_Get( p_input, "time", &time );
674 i_seconds = time.i_time / 1000000;
675 secstotimestr ( psz_time, i_seconds );
677 var_Get( p_input, "length", &time );
678 if( time.i_time > 0 )
680 secstotimestr( psz_duration, time.i_time / 1000000 );
681 vout_OSDMessage( p_input, POSITION_TEXT_CHAN, "%s / %s",
682 psz_time, psz_duration );
684 else if( i_seconds > 0 )
686 vout_OSDMessage( p_input, POSITION_TEXT_CHAN, psz_time );
689 if( !p_vout->p_parent_intf || p_vout->b_fullscreen )
691 var_Get( p_input, "position", &pos );
692 vout_OSDSlider( VLC_OBJECT( p_input ), POSITION_WIDGET_CHAN,
693 pos.f_float * 100, OSD_HOR_SLIDER );
697 static void DisplayVolume( intf_thread_t *p_intf, vout_thread_t *p_vout,
698 audio_volume_t i_vol )
704 ClearChannels( p_intf, p_vout );
706 if( !p_vout->p_parent_intf || p_vout->b_fullscreen )
708 vout_OSDSlider( VLC_OBJECT( p_vout ), VOLUME_WIDGET_CHAN,
709 i_vol*100/AOUT_VOLUME_MAX, OSD_VERT_SLIDER );
713 vout_OSDMessage( p_vout, VOLUME_TEXT_CHAN, "Vol %d%%",
714 2*i_vol*100/AOUT_VOLUME_MAX );
718 static void ClearChannels( intf_thread_t *p_intf, vout_thread_t *p_vout )
724 vout_ClearOSDChannel( p_vout, DEFAULT_CHAN );
725 for( i = 0; i < CHANNELS_NUMBER; i++ )
727 vout_ClearOSDChannel( p_vout, p_intf->p_sys->p_channels[ i ] );