git.sesse.net Git - vlc/blob - 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
  32 #include <xcb/xcb.h>
  33 #include <xcb/xcb_keysyms.h>
  34 #include <X11/keysym.h>
  35 #include <X11/XF86keysym.h>
  36
  37 #include <poll.h>
  38
  39 /*****************************************************************************
  40  * Local prototypes
  41  *****************************************************************************/
  42 static int Open( vlc_object_t *p_this );
  43 static void Close( vlc_object_t *p_this );
  44
  45 /*****************************************************************************
  46  * Module descriptor
  47  *****************************************************************************/
  48 vlc_module_begin()
  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 )
  55 vlc_module_end()
  56
  57 typedef struct
  58 {
  59     xcb_keycode_t i_x11;
  60     unsigned      i_modifier;
  61     int           i_action;
  62 } hotkey_mapping_t;
  63
  64 struct intf_sys_t
  65 {
  66     vlc_thread_t thread;
  67
  68     xcb_connection_t  *p_connection;
  69     xcb_window_t      root;
  70     xcb_key_symbols_t *p_symbols;
  71
  72     int              i_map;
  73     hotkey_mapping_t *p_map;
  74 };
  75
  76 static void Mapping( intf_thread_t *p_intf );
  77 static void Register( intf_thread_t *p_intf );
  78 static void Unregister( intf_thread_t *p_intf );
  79 static void *Thread( void *p_data );
  80
  81 /*****************************************************************************
  82  * Open:
  83  *****************************************************************************/
  84 static int Open( vlc_object_t *p_this )
  85 {
  86     intf_thread_t *p_intf = (intf_thread_t *)p_this;
  87     intf_sys_t *p_sys;
  88
  89     p_intf->p_sys = p_sys = calloc( 1, sizeof(*p_sys) );
  90     if( !p_sys )
  91         return VLC_ENOMEM;
  92
  93     char *psz_display = var_CreateGetNonEmptyString( p_intf, "x11-display" );
  94
  95     int i_screen_default;
  96     p_sys->p_connection = xcb_connect( psz_display, &i_screen_default );
  97     free( psz_display );
  98
  99     if( !p_sys->p_connection )
 100         goto error;
 101
 102     /* Get the root windows of the default screen */
 103     memset( &p_sys->root, 0, sizeof( p_sys->root ) );
 104     xcb_screen_iterator_t iter = xcb_setup_roots_iterator( xcb_get_setup( p_sys->p_connection ) );
 105     for( int i = 0; i < i_screen_default; i++ )
 106     {
 107         if( !iter.rem )
 108             break;
 109         xcb_screen_next( &iter );
 110     }
 111     if( !iter.rem )
 112         goto error;
 113     p_sys->root = iter.data->root;
 114
 115     /* */
 116     p_sys->p_symbols = xcb_key_symbols_alloc( p_sys->p_connection ); // FIXME
 117     if( !p_sys->p_symbols )
 118         goto error;
 119
 120     Mapping( p_intf );
 121     Register( p_intf );
 122
 123     if( vlc_clone( &p_sys->thread, Thread, p_intf, VLC_THREAD_PRIORITY_LOW ) )
 124     {
 125         Unregister( p_intf );
 126         free( p_sys->p_map );
 127         goto error;
 128     }
 129     return VLC_SUCCESS;
 130
 131 error:
 132     if( p_sys->p_symbols )
 133         xcb_key_symbols_free( p_sys->p_symbols );
 134     if( p_sys->p_connection )
 135         xcb_disconnect( p_sys->p_connection );
 136     free( p_sys );
 137     return VLC_EGENERIC;
 138 }
 139
 140 /*****************************************************************************
 141  * Close:
 142  *****************************************************************************/
 143 static void Close( vlc_object_t *p_this )
 144 {
 145     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 146     intf_sys_t *p_sys = p_intf->p_sys;
 147
 148     vlc_cancel( p_sys->thread );
 149     vlc_join( p_sys->thread, NULL );
 150
 151     Unregister( p_intf );
 152     free( p_sys->p_map );
 153
 154     xcb_key_symbols_free( p_sys->p_symbols );
 155     xcb_disconnect( p_sys->p_connection );
 156     free( p_sys );
 157 }
 158
 159 /*****************************************************************************
 160  *
 161  *****************************************************************************/
 162 static unsigned GetModifier( xcb_connection_t *p_connection, xcb_key_symbols_t *p_symbols, xcb_keysym_t sym )
 163 {
 164     static const unsigned pi_mask[8] = {
 165         XCB_MOD_MASK_SHIFT, XCB_MOD_MASK_LOCK, XCB_MOD_MASK_CONTROL, XCB_MOD_MASK_1,
 166         XCB_MOD_MASK_2, XCB_MOD_MASK_3, XCB_MOD_MASK_4, XCB_MOD_MASK_5
 167     };
 168
 169     const xcb_keycode_t key = xcb_key_symbols_get_keycode( p_symbols, sym );
 170     if( key == 0 )
 171         return 0;
 172
 173     xcb_get_modifier_mapping_cookie_t r = xcb_get_modifier_mapping( p_connection );
 174     xcb_get_modifier_mapping_reply_t *p_map = xcb_get_modifier_mapping_reply( p_connection, r, NULL );
 175     if( !p_map )
 176         return 0;
 177
 178     xcb_keycode_t *p_keycode = xcb_get_modifier_mapping_keycodes( p_map );
 179     if( !p_keycode )
 180         return 0;
 181
 182     unsigned i_mask = 0;
 183     for( int i = 0; i < 8; i++ )
 184     {
 185         for( int j = 0; j < p_map->keycodes_per_modifier; j++ )
 186         {
 187             if( p_keycode[i * p_map->keycodes_per_modifier + j] == key )
 188                 i_mask = pi_mask[i];
 189         }
 190     }
 191
 192     free( p_map ); // FIXME to check
 193     return i_mask;
 194 }
 195 static unsigned GetX11Modifier( xcb_connection_t *p_connection, xcb_key_symbols_t *p_symbols, unsigned i_vlc )
 196 {
 197     unsigned i_mask = 0;
 198
 199     if( i_vlc & KEY_MODIFIER_ALT )
 200         i_mask |= GetModifier( p_connection, p_symbols, XK_Alt_L ) |
 201                   GetModifier( p_connection, p_symbols, XK_Alt_R );
 202     if( i_vlc & KEY_MODIFIER_CTRL )
 203         i_mask |= GetModifier( p_connection, p_symbols, XK_Control_L ) |
 204                   GetModifier( p_connection, p_symbols, XK_Control_R );
 205     if( i_vlc & KEY_MODIFIER_SHIFT )
 206         i_mask |= GetModifier( p_connection, p_symbols, XK_Shift_L ) |
 207                   GetModifier( p_connection, p_symbols, XK_Shift_R );
 208     return i_mask;
 209 }
 210
 211 /* FIXME this table is also used by the vout */
 212 static const struct
 213 {
 214     xcb_keysym_t i_x11;
 215     unsigned     i_vlc;
 216
 217 } x11keys_to_vlckeys[] =
 218 {
 219     { XK_F1, KEY_F1 }, { XK_F2, KEY_F2 }, { XK_F3, KEY_F3 }, { XK_F4, KEY_F4 },
 220     { XK_F5, KEY_F5 }, { XK_F6, KEY_F6 }, { XK_F7, KEY_F7 }, { XK_F8, KEY_F8 },
 221     { XK_F9, KEY_F9 }, { XK_F10, KEY_F10 }, { XK_F11, KEY_F11 },
 222     { XK_F12, KEY_F12 },
 223
 224     { XK_Return, KEY_ENTER },
 225     { XK_KP_Enter, KEY_ENTER },
 226     { XK_space, KEY_SPACE },
 227     { XK_Escape, KEY_ESC },
 228
 229     { XK_Menu, KEY_MENU },
 230     { XK_Left, KEY_LEFT },
 231     { XK_Right, KEY_RIGHT },
 232     { XK_Up, KEY_UP },
 233     { XK_Down, KEY_DOWN },
 234
 235     { XK_Home, KEY_HOME },
 236     { XK_End, KEY_END },
 237     { XK_Page_Up, KEY_PAGEUP },
 238     { XK_Page_Down, KEY_PAGEDOWN },
 239
 240     { XK_Insert, KEY_INSERT },
 241     { XK_Delete, KEY_DELETE },
 242     { XF86XK_AudioNext, KEY_MEDIA_NEXT_TRACK},
 243     { XF86XK_AudioPrev, KEY_MEDIA_PREV_TRACK},
 244     { XF86XK_AudioMute, KEY_VOLUME_MUTE },
 245     { XF86XK_AudioLowerVolume, KEY_VOLUME_DOWN },
 246     { XF86XK_AudioRaiseVolume, KEY_VOLUME_UP },
 247     { XF86XK_AudioPlay, KEY_MEDIA_PLAY_PAUSE },
 248     { XF86XK_AudioPause, KEY_MEDIA_PLAY_PAUSE },
 249
 250     { 0, 0 }
 251 };
 252 static xcb_keysym_t GetX11Key( unsigned i_vlc )
 253 {
 254     for( int i = 0; x11keys_to_vlckeys[i].i_vlc != 0; i++ )
 255     {
 256         if( x11keys_to_vlckeys[i].i_vlc == i_vlc )
 257             return x11keys_to_vlckeys[i].i_x11;
 258     }
 259
 260     /* Copied from xcb, it seems that xcb use ascii code for ascii characters */
 261     if( isascii( i_vlc ) )
 262         return i_vlc;
 263
 264     return XK_VoidSymbol;
 265 }
 266
 267 static void Mapping( intf_thread_t *p_intf )
 268 {
 269     static const xcb_keysym_t p_x11_modifier_ignored[] = {
 270         0,
 271         XK_Num_Lock,
 272         XK_Scroll_Lock,
 273         XK_Caps_Lock,
 274     };
 275
 276     intf_sys_t *p_sys = p_intf->p_sys;
 277
 278     p_sys->i_map = 0;
 279     p_sys->p_map = NULL;
 280
 281     /* Registering of Hotkeys */
 282     for( struct hotkey *p_hotkey = p_intf->p_libvlc->p_hotkeys;
 283             p_hotkey->psz_action != NULL;
 284             p_hotkey++ )
 285     {
 286         char *psz_hotkey;
 287         if( asprintf( &psz_hotkey, "global-%s", p_hotkey->psz_action ) < 0 )
 288             break;
 289
 290         const int i_vlc_action = p_hotkey->i_action;
 291         const int i_vlc_key = config_GetInt( p_intf, psz_hotkey );
 292
 293         free( psz_hotkey );
 294
 295         if( !i_vlc_key )
 296             continue;
 297
 298         const xcb_keycode_t key = xcb_key_symbols_get_keycode( p_sys->p_symbols, GetX11Key( i_vlc_key & ~KEY_MODIFIER ) );
 299         const unsigned i_modifier = GetX11Modifier( p_sys->p_connection, p_sys->p_symbols, i_vlc_key & KEY_MODIFIER );
 300
 301         for( int j = 0; j < sizeof(p_x11_modifier_ignored)/sizeof(*p_x11_modifier_ignored); j++ )
 302         {
 303             const unsigned i_ignored = GetModifier( p_sys->p_connection, p_sys->p_symbols, p_x11_modifier_ignored[j] );
 304             if( j != 0 && i_ignored == 0x00)
 305                 continue;
 306
 307             hotkey_mapping_t *p_map_old = p_sys->p_map;
 308             p_sys->p_map = realloc( p_sys->p_map, sizeof(*p_sys->p_map) * (p_sys->i_map+1) );
 309             if( !p_sys->p_map )
 310             {
 311                 p_sys->p_map = p_map_old;
 312                 break;
 313             }
 314             hotkey_mapping_t *p_map = &p_sys->p_map[p_sys->i_map++];
 315
 316             p_map->i_x11 = key;
 317             p_map->i_modifier = i_modifier|i_ignored;
 318             p_map->i_action = i_vlc_action;
 319         }
 320     }
 321 }
 322
 323 static void Register( intf_thread_t *p_intf )
 324 {
 325     intf_sys_t *p_sys = p_intf->p_sys;
 326
 327     for( int i = 0; i < p_sys->i_map; i++ )
 328     {
 329         const hotkey_mapping_t *p_map = &p_sys->p_map[i];
 330         xcb_grab_key( p_sys->p_connection, true, p_sys->root,
 331                       p_map->i_modifier, p_map->i_x11,
 332                       XCB_GRAB_MODE_ASYNC, XCB_GRAB_MODE_ASYNC );
 333     }
 334 }
 335 static void Unregister( intf_thread_t *p_intf )
 336 {
 337     intf_sys_t *p_sys = p_intf->p_sys;
 338
 339     for( int i = 0; i < p_sys->i_map; i++ )
 340     {
 341         const hotkey_mapping_t *p_map = &p_sys->p_map[i];
 342         xcb_ungrab_key( p_sys->p_connection, p_map->i_x11, p_sys->root, p_map->i_modifier );
 343     }
 344 }
 345
 346 static void *Thread( void *p_data )
 347 {
 348     intf_thread_t *p_intf = p_data;
 349     intf_sys_t *p_sys = p_intf->p_sys;
 350     xcb_connection_t *p_connection = p_sys->p_connection;
 351
 352     int canc = vlc_savecancel();
 353
 354     /* */
 355     xcb_flush( p_connection );
 356
 357     /* */
 358     int fd = xcb_get_file_descriptor( p_connection );
 359     for( ;; )
 360     {
 361         /* Wait for x11 event */
 362         vlc_restorecancel( canc );
 363         struct pollfd fds = { .fd = fd, .events = POLLIN, };
 364         if( poll( &fds, 1, -1 ) < 0 )
 365         {
 366             if( errno != EINTR )
 367                 break;
 368             canc = vlc_savecancel();
 369             continue;
 370         }
 371         canc = vlc_savecancel();
 372
 373         xcb_generic_event_t *p_event;
 374         while( ( p_event = xcb_poll_for_event( p_connection ) ) )
 375         {
 376             if( ( p_event->response_type & 0x7f ) != XCB_KEY_PRESS )
 377             {
 378                 free( p_event );
 379                 continue;
 380             }
 381
 382             xcb_key_press_event_t *e = (xcb_key_press_event_t *)p_event;
 383
 384             for( int i = 0; i < p_sys->i_map; i++ )
 385             {
 386                 hotkey_mapping_t *p_map = &p_sys->p_map[i];
 387
 388                 if( p_map->i_x11 == e->detail &&
 389                     p_map->i_modifier == e->state )
 390                 {
 391                     var_SetInteger( p_intf->p_libvlc, "key-action", p_map->i_action );
 392                     break;
 393                 }
 394             }
 395             free( p_event );
 396         }
 397     }
 398
 399     return NULL;
 400 }
 401