1 /*****************************************************************************
2 * xcb.c: Global-Hotkey X11 using xcb handling for vlc
3 *****************************************************************************
4 * Copyright (C) 2009 the VideoLAN team
6 * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21 *****************************************************************************/
26 #include <vlc_common.h>
27 #include <vlc_plugin.h>
28 #include <vlc_interface.h>
33 #include <xcb/xcb_keysyms.h>
34 #include <X11/keysym.h>
35 #include <X11/XF86keysym.h>
39 /*****************************************************************************
41 *****************************************************************************/
42 static int Open( vlc_object_t *p_this );
43 static void Close( vlc_object_t *p_this );
45 /*****************************************************************************
47 *****************************************************************************/
49 set_shortname( N_("Global Hotkeys") )
50 set_category( CAT_INTERFACE )
51 set_subcategory( SUBCAT_INTERFACE_HOTKEYS )
52 set_description( N_("Global Hotkeys interface") )
53 set_capability( "interface", 0 )
54 set_callbacks( Open, Close )
59 #ifdef XCB_KEYSYM_OLD_API /* as seen in Debian Lenny */
62 xcb_keycode_t *p_keys;
72 xcb_connection_t *p_connection;
74 xcb_key_symbols_t *p_symbols;
77 hotkey_mapping_t *p_map;
80 static bool Mapping( intf_thread_t *p_intf );
81 static void Register( intf_thread_t *p_intf );
82 static void *Thread( void *p_data );
84 /*****************************************************************************
86 *****************************************************************************/
87 static int Open( vlc_object_t *p_this )
89 intf_thread_t *p_intf = (intf_thread_t *)p_this;
91 int ret = VLC_EGENERIC;
93 p_intf->p_sys = p_sys = calloc( 1, sizeof(*p_sys) );
97 char *psz_display = var_CreateGetNonEmptyString( p_intf, "x11-display" );
100 p_sys->p_connection = xcb_connect( psz_display, &i_screen_default );
103 if( xcb_connection_has_error( p_sys->p_connection ) )
106 /* Get the root windows of the default screen */
107 const xcb_setup_t* xcbsetup = xcb_get_setup( p_sys->p_connection );
110 xcb_screen_iterator_t iter = xcb_setup_roots_iterator( xcbsetup );
111 for( int i = 0; i < i_screen_default; i++ )
115 xcb_screen_next( &iter );
119 p_sys->root = iter.data->root;
122 p_sys->p_symbols = xcb_key_symbols_alloc( p_sys->p_connection ); // FIXME
123 if( !p_sys->p_symbols )
126 if( !Mapping( p_intf ) )
129 p_intf->p_sys = NULL; /* for Close() */
134 if( vlc_clone( &p_sys->thread, Thread, p_intf, VLC_THREAD_PRIORITY_LOW ) )
136 #ifndef XCB_KEYSYM_OLD_API /* as seen in Debian Lenny */
138 free( p_sys->p_map->p_keys );
140 free( p_sys->p_map );
146 if( p_sys->p_symbols )
147 xcb_key_symbols_free( p_sys->p_symbols );
148 xcb_disconnect( p_sys->p_connection );
153 /*****************************************************************************
155 *****************************************************************************/
156 static void Close( vlc_object_t *p_this )
158 intf_thread_t *p_intf = (intf_thread_t *)p_this;
159 intf_sys_t *p_sys = p_intf->p_sys;
162 return; /* if we were running disabled */
164 vlc_cancel( p_sys->thread );
165 vlc_join( p_sys->thread, NULL );
167 #ifndef XCB_KEYSYM_OLD_API /* as seen in Debian Lenny */
169 free( p_sys->p_map->p_keys );
171 free( p_sys->p_map );
173 xcb_key_symbols_free( p_sys->p_symbols );
174 xcb_disconnect( p_sys->p_connection );
178 /*****************************************************************************
180 *****************************************************************************/
181 static unsigned GetModifier( xcb_connection_t *p_connection, xcb_key_symbols_t *p_symbols, xcb_keysym_t sym )
183 static const unsigned pi_mask[8] = {
184 XCB_MOD_MASK_SHIFT, XCB_MOD_MASK_LOCK, XCB_MOD_MASK_CONTROL,
185 XCB_MOD_MASK_1, XCB_MOD_MASK_2, XCB_MOD_MASK_3,
186 XCB_MOD_MASK_4, XCB_MOD_MASK_5
190 return 0; /* no modifier */
192 #ifdef XCB_KEYSYM_OLD_API /* as seen in Debian Lenny */
193 const xcb_keycode_t key = xcb_key_symbols_get_keycode( p_symbols, sym );
197 const xcb_keycode_t *p_keys = xcb_key_symbols_get_keycode( p_symbols, sym );
202 bool no_modifier = true;
203 while( p_keys[i] != XCB_NO_SYMBOL )
217 xcb_get_modifier_mapping_cookie_t r =
218 xcb_get_modifier_mapping( p_connection );
219 xcb_get_modifier_mapping_reply_t *p_map =
220 xcb_get_modifier_mapping_reply( p_connection, r, NULL );
224 xcb_keycode_t *p_keycode = xcb_get_modifier_mapping_keycodes( p_map );
228 for( int i = 0; i < 8; i++ )
229 for( int j = 0; j < p_map->keycodes_per_modifier; j++ )
230 #ifdef XCB_KEYSYM_OLD_API /* as seen in Debian Lenny */
231 if( p_keycode[i * p_map->keycodes_per_modifier + j] == key )
237 for( int k = 0; p_keys[k] != XCB_NO_SYMBOL; k++ )
238 if( p_keycode[i*p_map->keycodes_per_modifier + j] == p_keys[k])
245 free( p_map ); // FIXME to check
250 static unsigned GetX11Modifier( xcb_connection_t *p_connection,
251 xcb_key_symbols_t *p_symbols, unsigned i_vlc )
255 if( i_vlc & KEY_MODIFIER_ALT )
256 i_mask |= GetModifier( p_connection, p_symbols, XK_Alt_L ) |
257 GetModifier( p_connection, p_symbols, XK_Alt_R );
258 if( i_vlc & KEY_MODIFIER_CTRL )
259 i_mask |= GetModifier( p_connection, p_symbols, XK_Control_L ) |
260 GetModifier( p_connection, p_symbols, XK_Control_R );
261 if( i_vlc & KEY_MODIFIER_SHIFT )
262 i_mask |= GetModifier( p_connection, p_symbols, XK_Shift_L ) |
263 GetModifier( p_connection, p_symbols, XK_Shift_R );
267 /* FIXME this table is also used by the vout */
273 } x11keys_to_vlckeys[] =
275 #include "../../video_output/xcb/xcb_keysym.h"
278 static xcb_keysym_t GetX11Key( unsigned i_vlc )
280 /* X11 and VLC use ASCII for printable ASCII characters */
281 if( i_vlc >= 32 && i_vlc <= 127 )
284 for( int i = 0; x11keys_to_vlckeys[i].i_vlc != 0; i++ )
286 if( x11keys_to_vlckeys[i].i_vlc == i_vlc )
287 return x11keys_to_vlckeys[i].i_x11;
290 return XK_VoidSymbol;
293 static bool Mapping( intf_thread_t *p_intf )
295 static const xcb_keysym_t p_x11_modifier_ignored[] = {
302 intf_sys_t *p_sys = p_intf->p_sys;
308 /* Registering of Hotkeys */
309 for( const struct hotkey *p_hotkey = p_intf->p_libvlc->p_hotkeys;
310 p_hotkey->psz_action != NULL;
314 if( asprintf( &psz_hotkey, "global-%s", p_hotkey->psz_action ) < 0 )
317 const int i_vlc_action = p_hotkey->i_action;
318 const int i_vlc_key = var_InheritInteger( p_intf, psz_hotkey );
323 #ifdef XCB_KEYSYM_OLD_API /* as seen in Debian Lenny */
324 const xcb_keycode_t key = xcb_key_symbols_get_keycode(
325 p_sys->p_symbols, GetX11Key( i_vlc_key & ~KEY_MODIFIER ) );
327 xcb_keycode_t *p_keys = xcb_key_symbols_get_keycode(
328 p_sys->p_symbols, GetX11Key( i_vlc_key & ~KEY_MODIFIER ) );
332 const unsigned i_modifier = GetX11Modifier( p_sys->p_connection,
333 p_sys->p_symbols, i_vlc_key & KEY_MODIFIER );
335 const size_t max = sizeof(p_x11_modifier_ignored) /
336 sizeof(*p_x11_modifier_ignored);
337 for( unsigned int i = 0; i < max; i++ )
339 const unsigned i_ignored = GetModifier( p_sys->p_connection,
340 p_sys->p_symbols, p_x11_modifier_ignored[i] );
341 if( i != 0 && i_ignored == 0)
344 hotkey_mapping_t *p_map_old = p_sys->p_map;
345 p_sys->p_map = realloc( p_sys->p_map,
346 sizeof(*p_sys->p_map) * (p_sys->i_map+1) );
349 p_sys->p_map = p_map_old;
352 hotkey_mapping_t *p_map = &p_sys->p_map[p_sys->i_map++];
354 #ifdef XCB_KEYSYM_OLD_API /* as seen in Debian Lenny */
357 p_map->p_keys = p_keys;
359 p_map->i_modifier = i_modifier|i_ignored;
360 p_map->i_action = i_vlc_action;
367 static void Register( intf_thread_t *p_intf )
369 intf_sys_t *p_sys = p_intf->p_sys;
371 for( int i = 0; i < p_sys->i_map; i++ )
373 const hotkey_mapping_t *p_map = &p_sys->p_map[i];
374 #ifdef XCB_KEYSYM_OLD_API /* as seen in Debian Lenny */
375 xcb_grab_key( p_sys->p_connection, true, p_sys->root,
376 p_map->i_modifier, p_map->i_x11,
377 XCB_GRAB_MODE_ASYNC, XCB_GRAB_MODE_ASYNC );
379 for( int j = 0; p_map->p_keys[j] != XCB_NO_SYMBOL; j++ )
381 xcb_grab_key( p_sys->p_connection, true, p_sys->root,
382 p_map->i_modifier, p_map->p_keys[j],
383 XCB_GRAB_MODE_ASYNC, XCB_GRAB_MODE_ASYNC );
389 static void *Thread( void *p_data )
391 intf_thread_t *p_intf = p_data;
392 intf_sys_t *p_sys = p_intf->p_sys;
393 xcb_connection_t *p_connection = p_sys->p_connection;
395 int canc = vlc_savecancel();
398 xcb_flush( p_connection );
401 int fd = xcb_get_file_descriptor( p_connection );
404 /* Wait for x11 event */
405 vlc_restorecancel( canc );
406 struct pollfd fds = { .fd = fd, .events = POLLIN, };
407 if( poll( &fds, 1, -1 ) < 0 )
411 canc = vlc_savecancel();
414 canc = vlc_savecancel();
416 xcb_generic_event_t *p_event;
417 while( ( p_event = xcb_poll_for_event( p_connection ) ) )
419 if( ( p_event->response_type & 0x7f ) != XCB_KEY_PRESS )
425 xcb_key_press_event_t *e = (xcb_key_press_event_t *)p_event;
427 for( int i = 0; i < p_sys->i_map; i++ )
429 hotkey_mapping_t *p_map = &p_sys->p_map[i];
431 #ifdef XCB_KEYSYM_OLD_API /* as seen in Debian Lenny */
432 if( p_map->i_x11 == e->detail &&
433 p_map->i_modifier == e->state )
435 var_SetInteger( p_intf->p_libvlc, "key-action",
440 bool loop_break = false;
441 for( int j = 0; p_map->p_keys[j] != XCB_NO_SYMBOL; j++ )
442 if( p_map->p_keys[j] == e->detail &&
443 p_map->i_modifier == e->state )
445 var_SetInteger( p_intf->p_libvlc, "key-action",