LGPL
[vlc.git] / modules / access / screen / xcb.c
1 /**
2  * @file xcb.c
3  * @brief X11 C Bindings screen capture demux module for VLC media player
4  */
5 /*****************************************************************************
6  * Copyright © 2009 Rémi Denis-Courmont
7  *
8  * This program is free software; you can redistribute it and/or modify it
9  * under the terms of the GNU Lesser General Public License as published by
10  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * 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 <stdarg.h>
27 #include <assert.h>
28 #include <xcb/xcb.h>
29 #include <xcb/composite.h>
30 #include <vlc_common.h>
31 #include <vlc_demux.h>
32 #include <vlc_plugin.h>
33
34 #define FPS_TEXT N_("Frame rate")
35 #define FPS_LONGTEXT N_( \
36     "How many times the screen content should be refreshed per second.")
37
38 #define LEFT_TEXT N_("Region left column")
39 #define LEFT_LONGTEXT N_( \
40     "Abscissa of the capture region in pixels.")
41
42 #define TOP_TEXT N_("Region top row")
43 #define TOP_LONGTEXT N_( \
44     "Ordinate of the capture region in pixels.")
45
46 #define WIDTH_TEXT N_("Capture region width")
47 #define WIDTH_LONGTEXT N_( \
48     "Pixel width of the capture region, or 0 for full width")
49
50 #define HEIGHT_TEXT N_("Capture region height")
51 #define HEIGHT_LONGTEXT N_( \
52     "Pixel height of the capture region, or 0 for full height")
53
54 #define FOLLOW_MOUSE_TEXT N_( "Follow the mouse" )
55 #define FOLLOW_MOUSE_LONGTEXT N_( \
56     "Follow the mouse when capturing a subscreen." )
57
58 static int  Open (vlc_object_t *);
59 static void Close (vlc_object_t *);
60
61 /*
62  * Module descriptor
63  */
64 vlc_module_begin ()
65     set_shortname (N_("Screen"))
66     set_description (N_("Screen capture (with X11/XCB)"))
67     set_category (CAT_INPUT)
68     set_subcategory (SUBCAT_INPUT_ACCESS)
69     set_capability ("access_demux", 0)
70     set_callbacks (Open, Close)
71
72     add_float ("screen-fps", 2.0, FPS_TEXT, FPS_LONGTEXT, true)
73     add_integer ("screen-left", 0, LEFT_TEXT, LEFT_LONGTEXT, true)
74         change_integer_range (-32768, 32767)
75         change_safe ()
76     add_integer ("screen-top", 0, TOP_TEXT, TOP_LONGTEXT, true)
77         change_integer_range (-32768, 32767)
78         change_safe ()
79     add_integer ("screen-width", 0, WIDTH_TEXT, WIDTH_LONGTEXT, true)
80         change_integer_range (0, 65535)
81         change_safe ()
82     add_integer ("screen-height", 0, HEIGHT_TEXT, HEIGHT_LONGTEXT, true)
83         change_integer_range (0, 65535)
84         change_safe ()
85     add_bool ("screen-follow-mouse", false, FOLLOW_MOUSE_TEXT,
86               FOLLOW_MOUSE_LONGTEXT, true)
87
88     add_shortcut ("screen", "window")
89 vlc_module_end ()
90
91 /*
92  * Local prototypes
93  */
94 static void Demux (void *);
95 static int Control (demux_t *, int, va_list);
96 static es_out_id_t *InitES (demux_t *, uint_fast16_t, uint_fast16_t,
97                             uint_fast8_t);
98
99 struct demux_sys_t
100 {
101     /* All owned by timer thread while timer is armed: */
102     xcb_connection_t *conn;
103     es_out_id_t      *es;
104     float             rate;
105     xcb_window_t      window;
106     xcb_pixmap_t      pixmap;
107     int16_t           x, y;
108     uint16_t          w, h;
109     uint16_t          cur_w, cur_h;
110     bool              follow_mouse;
111     /* Timer does not use this, only input thread: */
112     vlc_timer_t       timer;
113 };
114
115 /**
116  * Probes and initializes.
117  */
118 static int Open (vlc_object_t *obj)
119 {
120     demux_t *demux = (demux_t *)obj;
121     demux_sys_t *p_sys = malloc (sizeof (*p_sys));
122
123     if (p_sys == NULL)
124         return VLC_ENOMEM;
125     demux->p_sys = p_sys;
126
127     /* Connect to X server */
128     char *display = var_InheritString (obj, "x11-display");
129     int snum;
130     xcb_connection_t *conn = xcb_connect (display, &snum);
131     free (display);
132     if (xcb_connection_has_error (conn))
133     {
134         free (p_sys);
135         return VLC_EGENERIC;
136     }
137     p_sys->conn = conn;
138
139    /* Find configured screen */
140     if (!strcmp (demux->psz_access, "screen"))
141     {
142         const xcb_setup_t *setup = xcb_get_setup (conn);
143         const xcb_screen_t *scr = NULL;
144         for (xcb_screen_iterator_t i = xcb_setup_roots_iterator (setup);
145              i.rem > 0; xcb_screen_next (&i))
146         {
147             if (snum == 0)
148             {
149                scr = i.data;
150                 break;
151             }
152             snum--;
153         }
154         if (scr == NULL)
155         {
156             msg_Err (obj, "bad X11 screen number");
157             goto error;
158         }
159         p_sys->window = scr->root;
160     }
161     else
162     /* Determine capture window */
163     if (!strcmp (demux->psz_access, "window"))
164     {
165         char *end;
166         unsigned long ul = strtoul (demux->psz_location, &end, 0);
167         if (*end || ul > 0xffffffff)
168         {
169             msg_Err (obj, "bad X11 drawable %s", demux->psz_location);
170             goto error;
171         }
172         p_sys->window = ul;
173
174         xcb_composite_query_version_reply_t *r =
175             xcb_composite_query_version_reply (conn,
176                 xcb_composite_query_version (conn, 0, 4), NULL);
177         if (r == NULL || r->minor_version < 2)
178         {
179             msg_Err (obj, "X Composite extension not available");
180             free (r);
181             goto error;
182         }
183         msg_Dbg (obj, "using Composite extension v%"PRIu32".%"PRIu32,
184                  r->major_version, r->minor_version);
185         free (r);
186
187         xcb_composite_redirect_window (conn, p_sys->window,
188                                        XCB_COMPOSITE_REDIRECT_AUTOMATIC);
189     }
190     else
191         goto error;
192
193     /* Window properties */
194     p_sys->pixmap = xcb_generate_id (conn);
195     p_sys->w = var_InheritInteger (obj, "screen-width");
196     p_sys->h = var_InheritInteger (obj, "screen-height");
197     if (p_sys->w != 0 || p_sys->h != 0)
198         p_sys->follow_mouse = var_InheritBool (obj, "screen-follow-mouse");
199     else /* Following mouse is meaningless if width&height are dynamic. */
200         p_sys->follow_mouse = false;
201     if (!p_sys->follow_mouse) /* X and Y are meaningless if following mouse */
202     {
203         p_sys->x = var_InheritInteger (obj, "screen-left");
204         p_sys->y = var_InheritInteger (obj, "screen-top");
205     }
206
207     /* Initializes format */
208     p_sys->rate = var_InheritFloat (obj, "screen-fps");
209     if (!p_sys->rate)
210         goto error;
211
212     mtime_t interval = (float)CLOCK_FREQ / p_sys->rate;
213     if (!interval)
214         goto error;
215
216     p_sys->cur_w = 0;
217     p_sys->cur_h = 0;
218     p_sys->es = NULL;
219     if (vlc_timer_create (&p_sys->timer, Demux, demux))
220         goto error;
221     vlc_timer_schedule (p_sys->timer, false, 1, interval);
222
223     /* Initializes demux */
224     demux->pf_demux   = NULL;
225     demux->pf_control = Control;
226     return VLC_SUCCESS;
227
228 error:
229     xcb_disconnect (p_sys->conn);
230     free (p_sys);
231     return VLC_EGENERIC;
232 }
233
234
235 /**
236  * Releases resources
237  */
238 static void Close (vlc_object_t *obj)
239 {
240     demux_t *demux = (demux_t *)obj;
241     demux_sys_t *p_sys = demux->p_sys;
242
243     vlc_timer_destroy (p_sys->timer);
244     xcb_disconnect (p_sys->conn);
245     free (p_sys);
246 }
247
248
249 /**
250  * Control callback
251  */
252 static int Control (demux_t *demux, int query, va_list args)
253 {
254     switch (query)
255     {
256         case DEMUX_GET_POSITION:
257         {
258             float *v = va_arg (args, float *);
259             *v = 0.;
260             return VLC_SUCCESS;
261         }
262
263         case DEMUX_GET_LENGTH:
264         case DEMUX_GET_TIME:
265         {
266             int64_t *v = va_arg (args, int64_t *);
267             *v = 0;
268             return VLC_SUCCESS;
269         }
270
271         /* TODO: get title info -> crawl visible windows */
272
273         case DEMUX_GET_PTS_DELAY:
274         {
275             int64_t *v = va_arg (args, int64_t *);
276             *v = INT64_C(1000) * var_InheritInteger (demux, "live-caching");
277             return VLC_SUCCESS;
278         }
279
280         case DEMUX_CAN_PAUSE:
281         case DEMUX_CAN_CONTROL_PACE:
282         case DEMUX_CAN_CONTROL_RATE:
283         case DEMUX_CAN_SEEK:
284         {
285             bool *v = (bool*)va_arg( args, bool * );
286             *v = false;
287             return VLC_SUCCESS;
288         }
289
290         case DEMUX_SET_PAUSE_STATE:
291             return VLC_SUCCESS; /* should not happen */
292     }
293
294     return VLC_EGENERIC;
295 }
296
297
298 /**
299  * Processing callback
300  */
301 static void Demux (void *opaque)
302 {
303     demux_t *demux = opaque;
304     demux_sys_t *sys = demux->p_sys;
305     xcb_connection_t *conn = sys->conn;
306
307     /* Determine capture region */
308     xcb_get_geometry_cookie_t gc;
309     xcb_query_pointer_cookie_t qc;
310
311     gc = xcb_get_geometry (conn, sys->window);
312     if (sys->follow_mouse)
313         qc = xcb_query_pointer (conn, sys->window);
314
315     xcb_get_geometry_reply_t *geo = xcb_get_geometry_reply (conn, gc, NULL);
316     if (geo == NULL)
317     {
318         msg_Err (demux, "bad X11 drawable 0x%08"PRIx32, sys->window);
319 discard:
320         if (sys->follow_mouse)
321             xcb_discard_reply (conn, gc.sequence);
322         return;
323     }
324
325     int w = sys->w;
326     int h = sys->h;
327     int x, y;
328
329     if (sys->follow_mouse)
330     {
331         xcb_query_pointer_reply_t *ptr =
332             xcb_query_pointer_reply (conn, qc, NULL);
333         if (ptr == NULL)
334         {
335             free (geo);
336             return;
337         }
338
339         if (w == 0 || w > geo->width)
340             w = geo->width;
341         x = ptr->win_x;
342         if (x < w / 2)
343             x = 0;
344         else if (x >= (int)geo->width - (w / 2))
345             x = geo->width - w;
346         else
347             x -= w / 2;
348
349         if (h == 0 || h > geo->height)
350             h = geo->height;
351         y = ptr->win_y;
352         if (y < h / 2)
353             y = 0;
354         else if (y >= (int)geo->height - (h / 2))
355             y = geo->height - h;
356         else
357             y -= h / 2;
358     }
359     else
360     {
361         int max;
362
363         x = sys->x;
364         max = (int)geo->width - x;
365         if (max <= 0)
366             goto discard;
367         if (w == 0 || w > max)
368             w = max;
369
370         y = sys->y;
371         max = (int)geo->height - y;
372         if (max <= 0)
373             goto discard;
374         if (h == 0 || h > max)
375             h = max;
376     }
377
378     /* Update elementary stream format (if needed) */
379     if (w != sys->cur_w || h != sys->cur_h)
380     {
381         if (sys->es != NULL)
382             es_out_Del (demux->out, sys->es);
383
384         /* Update composite pixmap */
385         if (sys->window != geo->root)
386         {
387             xcb_free_pixmap (conn, sys->pixmap); /* no-op first time */
388             xcb_composite_name_window_pixmap (conn, sys->window, sys->pixmap);
389             xcb_create_pixmap (conn, geo->depth, sys->pixmap,
390                                geo->root, geo->width, geo->height);
391         }
392
393         sys->es = InitES (demux, w, h, geo->depth);
394         if (sys->es != NULL)
395         {
396             sys->cur_w = w;
397             sys->cur_h = h;
398         }
399     }
400
401     /* Capture screen */
402     xcb_drawable_t drawable =
403         (sys->window != geo->root) ? sys->pixmap : sys->window;
404     free (geo);
405
406     xcb_get_image_reply_t *img;
407     img = xcb_get_image_reply (conn,
408         xcb_get_image (conn, XCB_IMAGE_FORMAT_Z_PIXMAP, drawable,
409                        x, y, w, h, ~0), NULL);
410     if (img == NULL)
411         return;
412
413     uint8_t *data = xcb_get_image_data (img);
414     size_t datalen = xcb_get_image_data_length (img);
415     block_t *block = block_heap_Alloc (img, data + datalen - (uint8_t *)img);
416     if (block == NULL)
417         return;
418     block->p_buffer = data;
419     block->i_buffer = datalen;
420
421     /* Send block - zero copy */
422     if (sys->es != NULL)
423     {
424         block->i_pts = block->i_dts = mdate ();
425
426         es_out_Control (demux->out, ES_OUT_SET_PCR, block->i_pts);
427         es_out_Send (demux->out, sys->es, block);
428     }
429 }
430
431 static es_out_id_t *InitES (demux_t *demux, uint_fast16_t width,
432                             uint_fast16_t height, uint_fast8_t depth)
433 {
434     demux_sys_t *p_sys = demux->p_sys;
435     const xcb_setup_t *setup = xcb_get_setup (p_sys->conn);
436     uint32_t chroma = 0;
437     uint8_t bpp;
438
439     for (const xcb_format_t *fmt = xcb_setup_pixmap_formats (setup),
440              *end = fmt + xcb_setup_pixmap_formats_length (setup);
441          fmt < end; fmt++)
442     {
443         if (fmt->depth != depth)
444             continue;
445         bpp = fmt->depth;
446         switch (fmt->depth)
447         {
448             case 32:
449                 if (fmt->bits_per_pixel == 32)
450                     chroma = VLC_CODEC_RGBA;
451                 break;
452             case 24:
453                 if (fmt->bits_per_pixel == 32)
454                 {
455                     chroma = VLC_CODEC_RGB32;
456                     bpp = 32;
457                 }
458                 else if (fmt->bits_per_pixel == 24)
459                     chroma = VLC_CODEC_RGB24;
460                 break;
461             case 16:
462                 if (fmt->bits_per_pixel == 16)
463                     chroma = VLC_CODEC_RGB16;
464                 break;
465             case 15:
466                 if (fmt->bits_per_pixel == 16)
467                     chroma = VLC_CODEC_RGB15;
468                 break;
469             case 8: /* XXX: screw grey scale! */
470                 if (fmt->bits_per_pixel == 8)
471                     chroma = VLC_CODEC_RGB8;
472                 break;
473         }
474         if (chroma != 0)
475             break;
476     }
477
478     if (!chroma)
479     {
480         msg_Err (demux, "unsupported pixmap formats");
481         return NULL;
482     }
483
484     es_format_t fmt;
485
486     es_format_Init (&fmt, VIDEO_ES, chroma);
487     fmt.video.i_chroma = chroma;
488     fmt.video.i_bits_per_pixel = bpp;
489     fmt.video.i_sar_num = fmt.video.i_sar_den = 1;
490     fmt.video.i_frame_rate = 1000 * p_sys->rate;
491     fmt.video.i_frame_rate_base = 1000;
492     fmt.video.i_visible_width = fmt.video.i_width = width;
493     fmt.video.i_visible_height = fmt.video.i_height = height;
494
495     return es_out_Add (demux->out, &fmt);
496 }