remove debug left over in [b3a591d0]
[vlc.git] / modules / control / globalhotkeys / xcb.c
1 /*****************************************************************************
2  * xcb.c: Global-Hotkey X11 using xcb handling for vlc
3  *****************************************************************************
4  * Copyright (C) 2009 the VideoLAN team
5  *
6  * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
7  *
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.
12  *
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.
17  *
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  *****************************************************************************/
22
23 #ifdef HAVE_CONFIG_H
24 # include "config.h"
25 #endif
26 #include <vlc_common.h>
27 #include <vlc_plugin.h>
28 #include <vlc_interface.h>
29 #include <vlc_keys.h>
30 #include <ctype.h>
31 #include <errno.h>
32
33 #include <xcb/xcb.h>
34 #include <xcb/xcb_keysyms.h>
35 #include <X11/keysym.h>
36 #include <X11/XF86keysym.h>
37
38 #include <poll.h>
39
40 /*****************************************************************************
41  * Local prototypes
42  *****************************************************************************/
43 static int Open( vlc_object_t *p_this );
44 static void Close( vlc_object_t *p_this );
45
46 /*****************************************************************************
47  * Module descriptor
48  *****************************************************************************/
49 vlc_module_begin()
50     set_shortname( N_("Global Hotkeys") )
51     set_category( CAT_INTERFACE )
52     set_subcategory( SUBCAT_INTERFACE_HOTKEYS )
53     set_description( N_("Global Hotkeys interface") )
54     set_capability( "interface", 0 )
55     set_callbacks( Open, Close )
56 vlc_module_end()
57
58 typedef struct
59 {
60 #ifdef XCB_KEYSYM_OLD_API /* as seen in Debian Lenny */
61     xcb_keycode_t i_x11;
62 #else
63     xcb_keycode_t *p_keys;
64 #endif
65     unsigned      i_modifier;
66     int           i_action;
67 } hotkey_mapping_t;
68
69 struct intf_sys_t
70 {
71     vlc_thread_t thread;
72
73     xcb_connection_t  *p_connection;
74     xcb_window_t      root;
75     xcb_key_symbols_t *p_symbols;
76
77     int              i_map;
78     hotkey_mapping_t *p_map;
79 };
80
81 static void Mapping( intf_thread_t *p_intf );
82 static void Register( intf_thread_t *p_intf );
83 static void Unregister( intf_thread_t *p_intf );
84 static void *Thread( void *p_data );
85
86 /*****************************************************************************
87  * Open:
88  *****************************************************************************/
89 static int Open( vlc_object_t *p_this )
90 {
91     intf_thread_t *p_intf = (intf_thread_t *)p_this;
92     intf_sys_t *p_sys;
93
94     p_intf->p_sys = p_sys = calloc( 1, sizeof(*p_sys) );
95     if( !p_sys )
96         return VLC_ENOMEM;
97
98     char *psz_display = var_CreateGetNonEmptyString( p_intf, "x11-display" );
99
100     int i_screen_default;
101     p_sys->p_connection = xcb_connect( psz_display, &i_screen_default );
102     free( psz_display );
103
104     if( !p_sys->p_connection )
105         goto error;
106
107     /* Get the root windows of the default screen */
108     const xcb_setup_t* xcbsetup = xcb_get_setup( p_sys->p_connection );
109     if( !xcbsetup )
110         goto error;
111     xcb_screen_iterator_t iter = xcb_setup_roots_iterator( xcbsetup );
112     for( int i = 0; i < i_screen_default; i++ )
113     {
114         if( !iter.rem )
115             break;
116         xcb_screen_next( &iter );
117     }
118     if( !iter.rem )
119         goto error;
120     p_sys->root = iter.data->root;
121
122     /* */
123     p_sys->p_symbols = xcb_key_symbols_alloc( p_sys->p_connection ); // FIXME
124     if( !p_sys->p_symbols )
125         goto error;
126
127     Mapping( p_intf );
128     Register( p_intf );
129
130     if( vlc_clone( &p_sys->thread, Thread, p_intf, VLC_THREAD_PRIORITY_LOW ) )
131     {
132         Unregister( p_intf );
133 #ifndef XCB_KEYSYM_OLD_API /* as seen in Debian Lenny */
134         if( p_sys->p_map )
135             free( p_sys->p_map->p_keys );
136 #endif
137         free( p_sys->p_map );
138         goto error;
139     }
140     return VLC_SUCCESS;
141
142 error:
143     if( p_sys->p_symbols )
144         xcb_key_symbols_free( p_sys->p_symbols );
145     if( p_sys->p_connection )
146         xcb_disconnect( p_sys->p_connection );
147     free( p_sys );
148     return VLC_EGENERIC;
149 }
150
151 /*****************************************************************************
152  * Close:
153  *****************************************************************************/
154 static void Close( vlc_object_t *p_this )
155 {
156     intf_thread_t *p_intf = (intf_thread_t *)p_this;
157     intf_sys_t *p_sys = p_intf->p_sys;
158
159     vlc_cancel( p_sys->thread );
160     vlc_join( p_sys->thread, NULL );
161
162     Unregister( p_intf );
163 #ifndef XCB_KEYSYM_OLD_API /* as seen in Debian Lenny */
164     if( p_sys->p_map )
165         free( p_sys->p_map->p_keys );
166 #endif
167     free( p_sys->p_map );
168
169     xcb_key_symbols_free( p_sys->p_symbols );
170     xcb_disconnect( p_sys->p_connection );
171     free( p_sys );
172 }
173
174 /*****************************************************************************
175  *
176  *****************************************************************************/
177 static unsigned GetModifier( xcb_connection_t *p_connection, xcb_key_symbols_t *p_symbols, xcb_keysym_t sym )
178 {
179     static const unsigned pi_mask[8] = {
180         XCB_MOD_MASK_SHIFT, XCB_MOD_MASK_LOCK, XCB_MOD_MASK_CONTROL,
181         XCB_MOD_MASK_1, XCB_MOD_MASK_2, XCB_MOD_MASK_3,
182         XCB_MOD_MASK_4, XCB_MOD_MASK_5
183     };
184
185 #ifdef XCB_KEYSYM_OLD_API /* as seen in Debian Lenny */
186     const xcb_keycode_t key = xcb_key_symbols_get_keycode( p_symbols, sym );
187     if( key == 0 )
188         return 0;
189 #else
190     const xcb_keycode_t *p_keys = xcb_key_symbols_get_keycode( p_symbols, sym );
191     if( !p_keys )
192         return 0;
193 #endif
194
195     xcb_get_modifier_mapping_cookie_t r =
196             xcb_get_modifier_mapping( p_connection );
197     xcb_get_modifier_mapping_reply_t *p_map =
198             xcb_get_modifier_mapping_reply( p_connection, r, NULL );
199     if( !p_map )
200         return 0;
201
202     xcb_keycode_t *p_keycode = xcb_get_modifier_mapping_keycodes( p_map );
203     if( !p_keycode )
204         return 0;
205
206     for( int i = 0; i < 8; i++ )
207         for( int j = 0; j < p_map->keycodes_per_modifier; j++ )
208 #ifdef XCB_KEYSYM_OLD_API /* as seen in Debian Lenny */
209             if( p_keycode[i * p_map->keycodes_per_modifier + j] == key )
210             {
211                 free( p_map );
212                 return pi_mask[i];
213             }
214 #else
215             for( int k = 0; p_keys[k] != XCB_NO_SYMBOL; k++ )
216                 if( p_keycode[i*p_map->keycodes_per_modifier + j] == p_keys[k])
217                 {
218                     free( p_map );
219                     return pi_mask[i];
220                 }
221 #endif
222
223     free( p_map ); // FIXME to check
224     return 0;
225 }
226
227
228 static unsigned GetX11Modifier( xcb_connection_t *p_connection,
229         xcb_key_symbols_t *p_symbols, unsigned i_vlc )
230 {
231     unsigned i_mask = 0;
232
233     if( i_vlc & KEY_MODIFIER_ALT )
234         i_mask |= GetModifier( p_connection, p_symbols, XK_Alt_L ) |
235                   GetModifier( p_connection, p_symbols, XK_Alt_R );
236     if( i_vlc & KEY_MODIFIER_CTRL )
237         i_mask |= GetModifier( p_connection, p_symbols, XK_Control_L ) |
238                   GetModifier( p_connection, p_symbols, XK_Control_R );
239     if( i_vlc & KEY_MODIFIER_SHIFT )
240         i_mask |= GetModifier( p_connection, p_symbols, XK_Shift_L ) |
241                   GetModifier( p_connection, p_symbols, XK_Shift_R );
242     return i_mask;
243 }
244
245 /* FIXME this table is also used by the vout */
246 static const struct
247 {
248     xcb_keysym_t i_x11;
249     unsigned     i_vlc;
250
251 } x11keys_to_vlckeys[] =
252 {
253     { XK_F1, KEY_F1 }, { XK_F2, KEY_F2 }, { XK_F3, KEY_F3 }, { XK_F4, KEY_F4 },
254     { XK_F5, KEY_F5 }, { XK_F6, KEY_F6 }, { XK_F7, KEY_F7 }, { XK_F8, KEY_F8 },
255     { XK_F9, KEY_F9 }, { XK_F10, KEY_F10 }, { XK_F11, KEY_F11 },
256     { XK_F12, KEY_F12 },
257
258     { XK_Return, KEY_ENTER },
259     { XK_KP_Enter, KEY_ENTER },
260     { XK_Escape, KEY_ESC },
261
262     { XK_Menu, KEY_MENU },
263     { XK_Left, KEY_LEFT },
264     { XK_Right, KEY_RIGHT },
265     { XK_Up, KEY_UP },
266     { XK_Down, KEY_DOWN },
267
268     { XK_Home, KEY_HOME },
269     { XK_End, KEY_END },
270     { XK_Page_Up, KEY_PAGEUP },
271     { XK_Page_Down, KEY_PAGEDOWN },
272
273     { XK_Insert, KEY_INSERT },
274     { XK_Delete, KEY_DELETE },
275     { XF86XK_AudioNext, KEY_MEDIA_NEXT_TRACK},
276     { XF86XK_AudioPrev, KEY_MEDIA_PREV_TRACK},
277     { XF86XK_AudioMute, KEY_VOLUME_MUTE },
278     { XF86XK_AudioLowerVolume, KEY_VOLUME_DOWN },
279     { XF86XK_AudioRaiseVolume, KEY_VOLUME_UP },
280     { XF86XK_AudioPlay, KEY_MEDIA_PLAY_PAUSE },
281     { XF86XK_AudioPause, KEY_MEDIA_PLAY_PAUSE },
282
283     { 0, 0 }
284 };
285 static xcb_keysym_t GetX11Key( unsigned i_vlc )
286 {
287     /* X11 and VLC use ASCII for printable ASCII characters */
288     if( i_vlc >= 32 && i_vlc <= 127 )
289         return i_vlc;
290
291     for( int i = 0; x11keys_to_vlckeys[i].i_vlc != 0; i++ )
292     {
293         if( x11keys_to_vlckeys[i].i_vlc == i_vlc )
294             return x11keys_to_vlckeys[i].i_x11;
295     }
296
297     return XK_VoidSymbol;
298 }
299
300 static void Mapping( intf_thread_t *p_intf )
301 {
302     static const xcb_keysym_t p_x11_modifier_ignored[] = {
303         0,
304         XK_Num_Lock,
305         XK_Scroll_Lock,
306         XK_Caps_Lock,
307     };
308
309     intf_sys_t *p_sys = p_intf->p_sys;
310
311     p_sys->i_map = 0;
312     p_sys->p_map = NULL;
313
314     /* Registering of Hotkeys */
315     for( const struct hotkey *p_hotkey = p_intf->p_libvlc->p_hotkeys;
316             p_hotkey->psz_action != NULL;
317             p_hotkey++ )
318     {
319         char *psz_hotkey;
320         if( asprintf( &psz_hotkey, "global-%s", p_hotkey->psz_action ) < 0 )
321             break;
322
323         const int i_vlc_action = p_hotkey->i_action;
324         const int i_vlc_key = config_GetInt( p_intf, psz_hotkey );
325         free( psz_hotkey );
326
327         if( !i_vlc_key )
328             continue;
329 #ifdef XCB_KEYSYM_OLD_API /* as seen in Debian Lenny */
330         const xcb_keycode_t key = xcb_key_symbols_get_keycode(
331                 p_sys->p_symbols, GetX11Key( i_vlc_key & ~KEY_MODIFIER ) );
332 #else
333         xcb_keycode_t *p_keys = xcb_key_symbols_get_keycode(
334                 p_sys->p_symbols, GetX11Key( i_vlc_key & ~KEY_MODIFIER ) );
335         if( !p_keys )
336             continue;
337 #endif
338         const unsigned i_modifier = GetX11Modifier( p_sys->p_connection,
339                 p_sys->p_symbols, i_vlc_key & KEY_MODIFIER );
340
341         const size_t max = sizeof(p_x11_modifier_ignored) /
342                 sizeof(*p_x11_modifier_ignored);
343         for( unsigned int i = 0; i < max; i++ )
344         {
345             const unsigned i_ignored = GetModifier( p_sys->p_connection,
346                     p_sys->p_symbols, p_x11_modifier_ignored[i] );
347             if( i != 0 && i_ignored == 0x00)
348                 continue;
349
350             hotkey_mapping_t *p_map_old = p_sys->p_map;
351             p_sys->p_map = realloc( p_sys->p_map,
352                     sizeof(*p_sys->p_map) * (p_sys->i_map+1) );
353             if( !p_sys->p_map )
354             {
355                 p_sys->p_map = p_map_old;
356                 break;
357             }
358             hotkey_mapping_t *p_map = &p_sys->p_map[p_sys->i_map++];
359
360 #ifdef XCB_KEYSYM_OLD_API /* as seen in Debian Lenny */
361             p_map->i_x11 = key;
362 #else
363             p_map->p_keys = p_keys;
364 #endif
365             p_map->i_modifier = i_modifier|i_ignored;
366             p_map->i_action = i_vlc_action;
367         }
368     }
369 }
370
371 static void Register( intf_thread_t *p_intf )
372 {
373     intf_sys_t *p_sys = p_intf->p_sys;
374
375     for( int i = 0; i < p_sys->i_map; i++ )
376     {
377         const hotkey_mapping_t *p_map = &p_sys->p_map[i];
378 #ifdef XCB_KEYSYM_OLD_API /* as seen in Debian Lenny */
379         xcb_grab_key( p_sys->p_connection, true, p_sys->root,
380                       p_map->i_modifier, p_map->i_x11,
381                       XCB_GRAB_MODE_ASYNC, XCB_GRAB_MODE_ASYNC );
382 #else
383         for( int j = 0; p_map->p_keys[j] != XCB_NO_SYMBOL; j++ )
384         {
385             xcb_grab_key( p_sys->p_connection, true, p_sys->root,
386                           p_map->i_modifier, p_map->p_keys[j],
387                           XCB_GRAB_MODE_ASYNC, XCB_GRAB_MODE_ASYNC );
388         }
389 #endif
390     }
391 }
392 static void Unregister( intf_thread_t *p_intf )
393 {
394     intf_sys_t *p_sys = p_intf->p_sys;
395
396     for( int i = 0; i < p_sys->i_map; i++ )
397     {
398         const hotkey_mapping_t *p_map = &p_sys->p_map[i];
399 #ifdef XCB_KEYSYM_OLD_API /* as seen in Debian Lenny */
400         xcb_ungrab_key( p_sys->p_connection, p_map->i_x11, p_sys->root,
401                 p_map->i_modifier );
402 #else
403         for( int j = 0; p_map->p_keys[j] != XCB_NO_SYMBOL; j++ )
404             xcb_ungrab_key( p_sys->p_connection, p_map->p_keys[j], p_sys->root,
405                     p_map->i_modifier );
406 #endif
407     }
408 }
409
410 static void *Thread( void *p_data )
411 {
412     intf_thread_t *p_intf = p_data;
413     intf_sys_t *p_sys = p_intf->p_sys;
414     xcb_connection_t *p_connection = p_sys->p_connection;
415
416     int canc = vlc_savecancel();
417
418     /* */
419     xcb_flush( p_connection );
420
421     /* */
422     int fd = xcb_get_file_descriptor( p_connection );
423     for( ;; )
424     {
425         /* Wait for x11 event */
426         vlc_restorecancel( canc );
427         struct pollfd fds = { .fd = fd, .events = POLLIN, };
428         if( poll( &fds, 1, -1 ) < 0 )
429         {
430             if( errno != EINTR )
431                 break;
432             canc = vlc_savecancel();
433             continue;
434         }
435         canc = vlc_savecancel();
436
437         xcb_generic_event_t *p_event;
438         while( ( p_event = xcb_poll_for_event( p_connection ) ) )
439         {
440             if( ( p_event->response_type & 0x7f ) != XCB_KEY_PRESS )
441             {
442                 free( p_event );
443                 continue;
444             }
445
446             xcb_key_press_event_t *e = (xcb_key_press_event_t *)p_event;
447
448             for( int i = 0; i < p_sys->i_map; i++ )
449             {
450                 hotkey_mapping_t *p_map = &p_sys->p_map[i];
451
452 #ifdef XCB_KEYSYM_OLD_API /* as seen in Debian Lenny */
453                 if( p_map->i_x11 == e->detail &&
454                     p_map->i_modifier == e->state )
455                 {
456                     var_SetInteger( p_intf->p_libvlc, "key-action",
457                             p_map->i_action );
458                     break;
459                 }
460 #else
461             bool loop_break = false;
462             for( int j = 0; p_map->p_keys[j] != XCB_NO_SYMBOL; j++ )
463                 if( p_map->p_keys[j] == e->detail &&
464                     p_map->i_modifier == e->state )
465                 {
466                     var_SetInteger( p_intf->p_libvlc, "key-action",
467                             p_map->i_action );
468                     loop_break = true;
469                     break;
470                 }
471             if( loop_break )
472                 break;
473 #endif
474             }
475             free( p_event );
476         }
477     }
478
479     return NULL;
480 }
481