git.sesse.net Git - vlc/blob - modules/services_discovery/xcb_apps.c

   1 /**
   2  * @file xcb_apps.c
   3  * @brief List of application windows XCB module for VLC media player
   4  */
   5 /*****************************************************************************
   6  * Copyright © 2009 Rémi Denis-Courmont
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public License
  10  * as published by the Free Software Foundation; either version 2.1
  11  * of the License, or (at your option) any later version.
  12  *
  13  * This library 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 Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  21  ****************************************************************************/
  22
  23 #ifdef HAVE_CONFIG_H
  24 # include <config.h>
  25 #endif
  26 #include <stdarg.h>
  27 #include <xcb/xcb.h>
  28 typedef xcb_atom_t Atom;
  29 #include <X11/Xatom.h> /* XA_WINDOW */
  30 #include <vlc_common.h>
  31 #include <vlc_services_discovery.h>
  32 #include <vlc_dialog.h>
  33 #include <vlc_charset.h>
  34 #include <vlc_plugin.h>
  35 #include <poll.h>
  36 #include <search.h>
  37
  38 static int  Open (vlc_object_t *);
  39 static void Close (vlc_object_t *);
  40 static int vlc_sd_probe_Open (vlc_object_t *);
  41
  42 /*
  43  * Module descriptor
  44  */
  45 vlc_module_begin ()
  46     set_shortname (N_("Screen capture"))
  47     set_description (N_("Screen capture"))
  48     set_category (CAT_PLAYLIST)
  49     set_subcategory (SUBCAT_PLAYLIST_SD)
  50     set_capability ("services_discovery", 0)
  51     set_callbacks (Open, Close)
  52
  53     add_shortcut ("apps")
  54
  55     VLC_SD_PROBE_SUBMODULE
  56 vlc_module_end ()
  57
  58 struct services_discovery_sys_t
  59 {
  60     xcb_connection_t *conn;
  61     vlc_thread_t      thread;
  62     xcb_atom_t        net_client_list;
  63     xcb_atom_t        net_wm_name;
  64     xcb_window_t      root_window;
  65     void             *nodes;
  66 };
  67
  68 static void *Run (void *);
  69 static void Update (services_discovery_t *);
  70 static void DelItem (void *);
  71
  72 static int vlc_sd_probe_Open (vlc_object_t *obj)
  73 {
  74     vlc_probe_t *probe = (vlc_probe_t *)obj;
  75
  76     char *display = var_CreateGetNonEmptyString (obj, "x11-display");
  77     xcb_connection_t *conn = xcb_connect (display, NULL);
  78     free (display);
  79     if (xcb_connection_has_error (conn))
  80         return VLC_PROBE_CONTINUE;
  81     xcb_disconnect (conn);
  82     return vlc_sd_probe_Add (probe, "xcb_apps{longname=\"Screen capture\"}",
  83                              N_("Screen capture"), SD_CAT_MYCOMPUTER);
  84 }
  85
  86 /**
  87  * Probes and initializes.
  88  */
  89 static int Open (vlc_object_t *obj)
  90 {
  91     services_discovery_t *sd = (services_discovery_t *)obj;
  92     services_discovery_sys_t *p_sys = malloc (sizeof (*p_sys));
  93
  94     if (p_sys == NULL)
  95         return VLC_ENOMEM;
  96     sd->p_sys = p_sys;
  97
  98     /* Connect to X server */
  99     char *display = var_CreateGetNonEmptyString (obj, "x11-display");
 100     int snum;
 101     xcb_connection_t *conn = xcb_connect (display, &snum);
 102     free (display);
 103     if (xcb_connection_has_error (conn))
 104     {
 105         free (p_sys);
 106         return VLC_EGENERIC;
 107     }
 108     p_sys->conn = conn;
 109
 110     /* Find configured screen */
 111     const xcb_setup_t *setup = xcb_get_setup (conn);
 112     const xcb_screen_t *scr = NULL;
 113     for (xcb_screen_iterator_t i = xcb_setup_roots_iterator (setup);
 114          i.rem > 0; xcb_screen_next (&i))
 115     {
 116         if (snum == 0)
 117         {
 118             scr = i.data;
 119             break;
 120         }
 121         snum--;
 122     }
 123     if (scr == NULL)
 124     {
 125         msg_Err (obj, "bad X11 screen number");
 126         goto error;
 127     }
 128
 129     p_sys->root_window = scr->root;
 130     xcb_change_window_attributes (conn, scr->root, XCB_CW_EVENT_MASK,
 131                                &(uint32_t) { XCB_EVENT_MASK_PROPERTY_CHANGE });
 132
 133     /* TODO: check that _NET_CLIENT_LIST is in _NET_SUPPORTED
 134      * (and _NET_SUPPORTING_WM_CHECK) */
 135     xcb_intern_atom_reply_t *r;
 136     xcb_intern_atom_cookie_t ncl, nwn;
 137
 138     ncl = xcb_intern_atom (conn, 1, strlen ("_NET_CLIENT_LIST"),
 139                           "_NET_CLIENT_LIST");
 140     nwn = xcb_intern_atom (conn, 0, strlen ("_NET_WM_NAME"), "_NET_WM_NAME");
 141
 142     r = xcb_intern_atom_reply (conn, ncl, NULL);
 143     if (r == NULL || r->atom == 0)
 144     {
 145         dialog_Fatal (sd, _("Application list failure"),
 146                   _("Your window manager does not support application list."));
 147         msg_Err (sd, "application list not support (_NET_CLIENT_LIST absent)");
 148         free (r);
 149         goto error;
 150     }
 151     p_sys->net_client_list = r->atom;
 152     free (r);
 153     r = xcb_intern_atom_reply (conn, nwn, NULL);
 154     if (r != NULL)
 155     {
 156         p_sys->net_wm_name = r->atom;
 157         free (r);
 158     }
 159
 160     p_sys->nodes = NULL;
 161     Update (sd);
 162
 163     if (vlc_clone (&p_sys->thread, Run, sd, VLC_THREAD_PRIORITY_LOW))
 164         goto error;
 165     return VLC_SUCCESS;
 166
 167 error:
 168     xcb_disconnect (p_sys->conn);
 169     free (p_sys);
 170     return VLC_EGENERIC;
 171 }
 172
 173
 174 /**
 175  * Releases resources
 176  */
 177 static void Close (vlc_object_t *obj)
 178 {
 179     services_discovery_t *sd = (services_discovery_t *)obj;
 180     services_discovery_sys_t *p_sys = sd->p_sys;
 181
 182     vlc_cancel (p_sys->thread);
 183     vlc_join (p_sys->thread, NULL);
 184     xcb_disconnect (p_sys->conn);
 185     tdestroy (p_sys->nodes, DelItem);
 186     free (p_sys);
 187 }
 188
 189 static void *Run (void *data)
 190 {
 191     services_discovery_t *sd = data;
 192     services_discovery_sys_t *p_sys = sd->p_sys;
 193     xcb_connection_t *conn = p_sys->conn;
 194     int fd = xcb_get_file_descriptor (conn);
 195     if (fd == -1)
 196         return NULL;
 197
 198     while (!xcb_connection_has_error (conn))
 199     {
 200         xcb_generic_event_t *ev;
 201         struct pollfd ufd = { .fd = fd, .events = POLLIN, };
 202
 203         poll (&ufd, 1, -1);
 204
 205         int canc = vlc_savecancel ();
 206         while ((ev = xcb_poll_for_event (conn)) != NULL)
 207         {
 208             if ((ev->response_type & 0x7F) == XCB_PROPERTY_NOTIFY)
 209             {
 210                  const xcb_property_notify_event_t *pn =
 211                      (xcb_property_notify_event_t *)ev;
 212                  if (pn->atom == p_sys->net_client_list)
 213                      Update (sd);
 214             }
 215             free (ev);
 216         }
 217         vlc_restorecancel (canc);
 218     }
 219     return NULL;
 220 }
 221
 222 struct app
 223 {
 224     xcb_window_t          xid; /* must be first for cmpapp */
 225     input_item_t         *item;
 226     services_discovery_t *owner;
 227 };
 228
 229 static struct app *AddItem (services_discovery_t *sd, xcb_window_t xid)
 230 {
 231     services_discovery_sys_t *p_sys = sd->p_sys;
 232     char *mrl, *name;
 233
 234     if (asprintf (&mrl, "window://0x%"PRIx8, xid) == -1)
 235         return NULL;
 236
 237     xcb_get_property_reply_t *r =
 238         xcb_get_property_reply (p_sys->conn,
 239             xcb_get_property (p_sys->conn, 0, xid, p_sys->net_wm_name, 0,
 240                               0, 1023 /* max size */), NULL);
 241     if (r != NULL)
 242     {
 243         name = strndup (xcb_get_property_value (r),
 244                         xcb_get_property_value_length (r));
 245         if (name != NULL)
 246             EnsureUTF8 (name); /* don't trust third party apps too much ;-) */
 247         free (r);
 248     }
 249     /* TODO: use WM_NAME (Latin-1) for very old apps */
 250     else
 251         name = NULL;
 252
 253     input_item_t *item = input_item_NewWithType (VLC_OBJECT (sd), mrl,
 254                                                  name ? name : mrl,
 255                                                  0, NULL, 0, -1,
 256                                                  ITEM_TYPE_CARD /* FIXME */);
 257     free (mrl);
 258     free (name);
 259     if (item == NULL)
 260         return NULL;
 261
 262     struct app *app = malloc (sizeof (*app));
 263     if (app == NULL)
 264     {
 265         vlc_gc_decref (item);
 266         return NULL;
 267     }
 268     app->xid = xid;
 269     app->item = item;
 270     app->owner = sd;
 271     services_discovery_AddItem (sd, item, _("Applications"));
 272     return app;
 273 }
 274
 275 static void DelItem (void *data)
 276 {
 277     struct app *app = data;
 278
 279     services_discovery_RemoveItem (app->owner, app->item);
 280     vlc_gc_decref (app->item);
 281     free (app);
 282 }
 283
 284 static int cmpapp (const void *a, const void *b)
 285 {
 286     xcb_window_t wa = *(xcb_window_t *)a;
 287     xcb_window_t wb = *(xcb_window_t *)b;
 288
 289     if (wa > wb)
 290         return 1;
 291     if (wa < wb)
 292         return -1;
 293     return 0;
 294 }
 295
 296 static void Update (services_discovery_t *sd)
 297 {
 298     services_discovery_sys_t *p_sys = sd->p_sys;
 299     xcb_connection_t *conn = p_sys->conn;
 300
 301     xcb_get_property_reply_t *r =
 302         xcb_get_property_reply (conn,
 303             xcb_get_property (conn, false, p_sys->root_window,
 304                               p_sys->net_client_list, XA_WINDOW, 0, 1024),
 305             NULL);
 306     if (r == NULL)
 307         return; /* FIXME: remove all entries */
 308
 309     xcb_window_t *ent = xcb_get_property_value (r);
 310     int n = xcb_get_property_value_length (r) / 4;
 311     void *newnodes = NULL, *oldnodes = p_sys->nodes;
 312
 313     for (int i = 0; i < n; i++)
 314     {
 315         xcb_window_t id = *(ent++);
 316         struct app *app;
 317
 318         struct app **pa = tfind (&id, &oldnodes, cmpapp);
 319         if (pa != NULL) /* existing entry */
 320         {
 321             app = *pa;
 322             tdelete (app, &oldnodes, cmpapp);
 323         }
 324         else /* new entry */
 325         {
 326             app = AddItem (sd, id);
 327             if (app == NULL)
 328                 continue;
 329         }
 330
 331         pa = tsearch (app, &newnodes, cmpapp);
 332         if (pa == NULL /* OOM */ || *pa != app /* buggy window manager */)
 333             DelItem (app);
 334     }
 335     free (r);
 336
 337     /* Remove old nodes */
 338     tdestroy (oldnodes, DelItem);
 339     p_sys->nodes = newnodes;
 340 }