2210875343f3c907b405f43090daab43c6a86645
[vlc.git] / modules / video_output / xcb / x11.c
1 /**
2  * @file x11.c
3  * @brief X C Bindings video output 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
27 #include <stdlib.h>
28 #include <assert.h>
29
30 #include <xcb/xcb.h>
31 #include <xcb/shm.h>
32
33 #include <vlc_common.h>
34 #include <vlc_plugin.h>
35 #include <vlc_vout_display.h>
36 #include <vlc_picture_pool.h>
37
38 #include "xcb_vlc.h"
39
40 static int  Open (vlc_object_t *);
41 static void Close (vlc_object_t *);
42
43 /*
44  * Module descriptor
45  */
46 vlc_module_begin ()
47     set_shortname (N_("X11"))
48     set_description (N_("X11 video output (XCB)"))
49     set_category (CAT_VIDEO)
50     set_subcategory (SUBCAT_VIDEO_VOUT)
51     set_capability ("vout display", 100)
52     set_callbacks (Open, Close)
53     add_shortcut ("xcb-x11", "x11", "xid")
54
55     add_obsolete_bool ("x11-shm") /* obsoleted since 2.0.0 */
56 vlc_module_end ()
57
58 /* This must be large enough to absorb the server display jitter.
59  * But excessively large value is useless as direct rendering cannot be used
60  * with XCB X11. */
61 #define MAX_PICTURES (3)
62
63 struct vout_display_sys_t
64 {
65     xcb_connection_t *conn;
66     vout_window_t *embed; /* VLC window */
67
68     xcb_cursor_t cursor; /* blank cursor */
69     xcb_window_t window; /* drawable X window */
70     xcb_gcontext_t gc; /* context to put images */
71     bool shm; /* whether to use MIT-SHM */
72     bool visible; /* whether to draw */
73     uint8_t depth; /* useful bits per pixel */
74
75     picture_pool_t *pool; /* picture pool */
76     picture_resource_t resource[MAX_PICTURES];
77 };
78
79 static picture_pool_t *Pool (vout_display_t *, unsigned);
80 static void Display (vout_display_t *, picture_t *, subpicture_t *subpicture);
81 static int Control (vout_display_t *, int, va_list);
82 static void Manage (vout_display_t *);
83
84 static void ResetPictures (vout_display_t *);
85
86 static const xcb_depth_t *FindDepth (const xcb_screen_t *scr,
87                                      uint_fast8_t depth)
88 {
89     xcb_depth_t *d = NULL;
90     for (xcb_depth_iterator_t it = xcb_screen_allowed_depths_iterator (scr);
91          it.rem > 0 && d == NULL;
92          xcb_depth_next (&it))
93     {
94         if (it.data->depth == depth)
95             d = it.data;
96     }
97
98     return d;
99 }
100
101
102 /**
103  * Probe the X server.
104  */
105 static int Open (vlc_object_t *obj)
106 {
107     vout_display_t *vd = (vout_display_t *)obj;
108     vout_display_sys_t *sys = malloc (sizeof (*sys));
109     if (unlikely(sys == NULL))
110         return VLC_ENOMEM;
111
112     vd->sys = sys;
113     sys->pool = NULL;
114
115     /* Get window, connect to X server */
116     xcb_connection_t *conn;
117     const xcb_screen_t *scr;
118     uint16_t width, height;
119     sys->embed = XCB_parent_Create (vd, &conn, &scr, &width, &height);
120     if (sys->embed == NULL)
121     {
122         free (sys);
123         return VLC_EGENERIC;
124     }
125     sys->conn = conn;
126
127     const xcb_setup_t *setup = xcb_get_setup (conn);
128
129     /* Determine our pixel format */
130     video_format_t fmt_pic;
131     xcb_visualid_t vid;
132     sys->depth = 0;
133
134     for (const xcb_format_t *fmt = xcb_setup_pixmap_formats (setup),
135              *end = fmt + xcb_setup_pixmap_formats_length (setup);
136          fmt < end;
137          fmt++)
138     {
139         if (fmt->depth <= sys->depth)
140             continue; /* no better than earlier format */
141
142         fmt_pic = vd->fmt;
143
144         /* Check that the pixmap format is supported by VLC. */
145         switch (fmt->depth)
146         {
147           case 32:
148             if (fmt->bits_per_pixel != 32)
149                 continue;
150 #ifdef FIXED_VLC_RGBA_MASK
151             fmt_pic.i_chroma = VLC_CODEC_RGBA;
152             break;
153 #else
154             msg_Dbg (vd, "X11 visual with alpha-channel not supported");
155             continue;
156 #endif
157           case 24:
158             if (fmt->bits_per_pixel == 32)
159                 fmt_pic.i_chroma = VLC_CODEC_RGB32;
160             else if (fmt->bits_per_pixel == 24)
161                 fmt_pic.i_chroma = VLC_CODEC_RGB24;
162             else
163                 continue;
164             break;
165           case 16:
166             if (fmt->bits_per_pixel != 16)
167                 continue;
168             fmt_pic.i_chroma = VLC_CODEC_RGB16;
169             break;
170           case 15:
171             if (fmt->bits_per_pixel != 16)
172                 continue;
173             fmt_pic.i_chroma = VLC_CODEC_RGB15;
174             break;
175           case 8:
176             if (fmt->bits_per_pixel != 8)
177                 continue;
178             fmt_pic.i_chroma = VLC_CODEC_RGB8;
179             break;
180           default:
181             continue;
182         }
183
184         /* Byte sex is a non-issue for 8-bits. It can be worked around with
185          * RGB masks for 24-bits. Too bad for 15-bits and 16-bits. */
186         if (fmt->bits_per_pixel == 16 && setup->image_byte_order != ORDER)
187             continue;
188
189         /* Make sure the X server is sane */
190         assert (fmt->bits_per_pixel > 0);
191         if (unlikely(fmt->scanline_pad % fmt->bits_per_pixel))
192             continue;
193
194         /* Check that the selected screen supports this depth */
195         const xcb_depth_t *d = FindDepth (scr, fmt->depth);
196         if (d == NULL)
197             continue;
198
199         /* Find a visual type for the selected depth */
200         const xcb_visualtype_t *vt = xcb_depth_visuals (d);
201
202         /* First try True Color class */
203         for (int i = xcb_depth_visuals_length (d); i > 0; i--)
204         {
205             if (vt->_class == XCB_VISUAL_CLASS_TRUE_COLOR)
206             {
207                 fmt_pic.i_rmask = vt->red_mask;
208                 fmt_pic.i_gmask = vt->green_mask;
209                 fmt_pic.i_bmask = vt->blue_mask;
210             found_visual:
211                 vid = vt->visual_id;
212                 msg_Dbg (vd, "using X11 visual ID 0x%"PRIx32, vid);
213                 sys->depth = fmt->depth;
214                 msg_Dbg (vd, " %"PRIu8" bits depth", sys->depth);
215                 msg_Dbg (vd, " %"PRIu8" bits per pixel", fmt->bits_per_pixel);
216                 msg_Dbg (vd, " %"PRIu8" bits line pad", fmt->scanline_pad);
217                 goto found_format;
218             }
219             vt++;
220         }
221
222         /* Then try Static Gray class */
223         if (fmt->depth != 8)
224             continue;
225         vt = xcb_depth_visuals (d);
226         for (int i = xcb_depth_visuals_length (d); i > 0 && !vid; i--)
227         {
228             if (vt->_class == XCB_VISUAL_CLASS_STATIC_GRAY)
229             {
230                 fmt_pic.i_chroma = VLC_CODEC_GREY;
231                 goto found_visual;
232             }
233             vt++;
234         }
235     }
236
237     msg_Err (obj, "no supported pixel format & visual");
238     goto error;
239
240 found_format:;
241     /* Create colormap (needed to select non-default visual) */
242     xcb_colormap_t cmap;
243     if (vid != scr->root_visual)
244     {
245         cmap = xcb_generate_id (conn);
246         xcb_create_colormap (conn, XCB_COLORMAP_ALLOC_NONE,
247                              cmap, scr->root, vid);
248     }
249     else
250         cmap = scr->default_colormap;
251
252     /* Create window */
253     sys->window = xcb_generate_id (conn);
254     sys->gc = xcb_generate_id (conn);
255     xcb_pixmap_t pixmap = xcb_generate_id (conn);
256     {
257         const uint32_t mask =
258             XCB_CW_BACK_PIXMAP |
259             XCB_CW_BACK_PIXEL |
260             XCB_CW_BORDER_PIXMAP |
261             XCB_CW_BORDER_PIXEL |
262             XCB_CW_EVENT_MASK |
263             XCB_CW_COLORMAP;
264         const uint32_t values[] = {
265             /* XCB_CW_BACK_PIXMAP */
266             pixmap,
267             /* XCB_CW_BACK_PIXEL */
268             scr->black_pixel,
269             /* XCB_CW_BORDER_PIXMAP */
270             pixmap,
271             /* XCB_CW_BORDER_PIXEL */
272             scr->black_pixel,
273             /* XCB_CW_EVENT_MASK */
274             XCB_EVENT_MASK_VISIBILITY_CHANGE,
275             /* XCB_CW_COLORMAP */
276             cmap,
277         };
278         xcb_void_cookie_t c;
279
280         xcb_create_pixmap (conn, sys->depth, pixmap, scr->root, 1, 1);
281         c = xcb_create_window_checked (conn, sys->depth, sys->window,
282                                        sys->embed->handle.xid, 0, 0,
283                                        width, height, 0,
284                                        XCB_WINDOW_CLASS_INPUT_OUTPUT,
285                                        vid, mask, values);
286         xcb_map_window (conn, sys->window);
287         /* Create graphic context (I wonder why the heck do we need this) */
288         xcb_create_gc (conn, sys->gc, sys->window, 0, NULL);
289
290         if (XCB_error_Check (vd, conn, "cannot create X11 window", c))
291             goto error;
292     }
293     msg_Dbg (vd, "using X11 window %08"PRIx32, sys->window);
294     msg_Dbg (vd, "using X11 graphic context %08"PRIx32, sys->gc);
295
296     sys->cursor = XCB_cursor_Create (conn, scr);
297     sys->visible = false;
298     sys->shm = XCB_shm_Check (obj, conn);
299
300
301     /* Setup vout_display_t once everything is fine */
302     vd->info.has_pictures_invalid = true;
303     vd->info.has_event_thread = true;
304
305     vd->fmt = fmt_pic;
306     vd->pool = Pool;
307     vd->prepare = NULL;
308     vd->display = Display;
309     vd->control = Control;
310     vd->manage = Manage;
311
312     /* */
313     bool is_fullscreen = vd->cfg->is_fullscreen;
314     if (is_fullscreen && vout_window_SetFullScreen (sys->embed, true))
315         is_fullscreen = false;
316     vout_display_SendEventFullscreen (vd, is_fullscreen);
317     vout_display_SendEventDisplaySize (vd, width, height, is_fullscreen);
318
319     return VLC_SUCCESS;
320
321 error:
322     Close (obj);
323     return VLC_EGENERIC;
324 }
325
326
327 /**
328  * Disconnect from the X server.
329  */
330 static void Close (vlc_object_t *obj)
331 {
332     vout_display_t *vd = (vout_display_t *)obj;
333     vout_display_sys_t *sys = vd->sys;
334
335     ResetPictures (vd);
336
337     /* show the default cursor */
338     xcb_change_window_attributes (sys->conn, sys->embed->handle.xid, XCB_CW_CURSOR,
339                                   &(uint32_t) { XCB_CURSOR_NONE });
340     xcb_flush (sys->conn);
341
342     /* colormap, window and context are garbage-collected by X */
343     xcb_disconnect (sys->conn);
344     vout_display_DeleteWindow (vd, sys->embed);
345     free (sys);
346 }
347
348 /**
349  * Return a direct buffer
350  */
351 static picture_pool_t *Pool (vout_display_t *vd, unsigned requested_count)
352 {
353     vout_display_sys_t *sys = vd->sys;
354     (void)requested_count;
355
356     if (sys->pool)
357         return sys->pool;
358
359     vout_display_place_t place;
360
361     vout_display_PlacePicture (&place, &vd->source, vd->cfg, false);
362
363     /* */
364     const uint32_t values[] = { place.x, place.y, place.width, place.height };
365     xcb_configure_window (sys->conn, sys->window,
366                           XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y |
367                           XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT,
368                           values);
369
370     picture_t *pic = picture_NewFromFormat (&vd->fmt);
371     if (!pic)
372         return NULL;
373
374     assert (pic->i_planes == 1);
375     memset (sys->resource, 0, sizeof(sys->resource));
376
377     unsigned count;
378     picture_t *pic_array[MAX_PICTURES];
379     for (count = 0; count < MAX_PICTURES; count++)
380     {
381         picture_resource_t *res = &sys->resource[count];
382
383         res->p->i_lines = pic->p->i_lines;
384         res->p->i_pitch = pic->p->i_pitch;
385         if (XCB_pictures_Alloc (vd, res, res->p->i_pitch * res->p->i_lines,
386                                 sys->conn, sys->shm))
387             break;
388         pic_array[count] = picture_NewFromResource (&vd->fmt, res);
389         if (!pic_array[count])
390         {
391             XCB_pictures_Free (res, sys->conn);
392             memset (res, 0, sizeof(*res));
393             break;
394         }
395     }
396     picture_Release (pic);
397
398     if (count == 0)
399         return NULL;
400
401     sys->pool = picture_pool_New (count, pic_array);
402     /* TODO release picture resources if NULL */
403     xcb_flush (sys->conn);
404     return sys->pool;
405 }
406
407 /**
408  * Sends an image to the X server.
409  */
410 static void Display (vout_display_t *vd, picture_t *pic, subpicture_t *subpicture)
411 {
412     vout_display_sys_t *sys = vd->sys;
413     xcb_shm_seg_t segment = pic->p_sys->segment;
414     xcb_void_cookie_t ck;
415
416     if (!sys->visible)
417         goto out;
418     if (segment != 0)
419         ck = xcb_shm_put_image_checked (sys->conn, sys->window, sys->gc,
420           /* real width */ pic->p->i_pitch / pic->p->i_pixel_pitch,
421          /* real height */ pic->p->i_lines,
422                    /* x */ vd->fmt.i_x_offset,
423                    /* y */ vd->fmt.i_y_offset,
424                /* width */ vd->fmt.i_visible_width,
425               /* height */ vd->fmt.i_visible_height,
426                            0, 0, sys->depth, XCB_IMAGE_FORMAT_Z_PIXMAP,
427                            0, segment, 0);
428     else
429     {
430         const size_t offset = vd->fmt.i_y_offset * pic->p->i_pitch;
431         const unsigned lines = pic->p->i_lines - vd->fmt.i_y_offset;
432
433         ck = xcb_put_image_checked (sys->conn, XCB_IMAGE_FORMAT_Z_PIXMAP,
434                        sys->window, sys->gc,
435                        pic->p->i_pitch / pic->p->i_pixel_pitch,
436                        lines, -vd->fmt.i_x_offset, 0, 0, sys->depth,
437                        pic->p->i_pitch * lines, pic->p->p_pixels + offset);
438     }
439
440     /* Wait for reply. This makes sure that the X server gets CPU time to
441      * display the picture. xcb_flush() is *not* sufficient: especially with
442      * shared memory the PUT requests are so short that many of them can fit in
443      * X11 socket output buffer before the kernel preempts VLC. */
444     xcb_generic_error_t *e = xcb_request_check (sys->conn, ck);
445     if (e != NULL)
446     {
447         msg_Dbg (vd, "%s: X11 error %d", "cannot put image", e->error_code);
448         free (e);
449     }
450
451     /* FIXME might be WAY better to wait in some case (be carefull with
452      * VOUT_DISPLAY_RESET_PICTURES if done) + does not work with
453      * vout_display wrapper. */
454 out:
455     picture_Release (pic);
456     (void)subpicture;
457 }
458
459 static int Control (vout_display_t *vd, int query, va_list ap)
460 {
461     vout_display_sys_t *sys = vd->sys;
462
463     switch (query)
464     {
465     case VOUT_DISPLAY_CHANGE_FULLSCREEN:
466     {
467         const vout_display_cfg_t *c = va_arg (ap, const vout_display_cfg_t *);
468         return vout_window_SetFullScreen (sys->embed, c->is_fullscreen);
469     }
470
471     case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE:
472     {
473         const vout_display_cfg_t *p_cfg =
474             (const vout_display_cfg_t*)va_arg (ap, const vout_display_cfg_t *);
475         const bool is_forced = (bool)va_arg (ap, int);
476
477         if (is_forced
478          && vout_window_SetSize (sys->embed,
479                                  p_cfg->display.width,
480                                  p_cfg->display.height))
481             return VLC_EGENERIC;
482
483         vout_display_place_t place;
484         vout_display_PlacePicture (&place, &vd->source, p_cfg, false);
485
486         if (place.width  != vd->fmt.i_visible_width ||
487             place.height != vd->fmt.i_visible_height)
488         {
489             vout_display_SendEventPicturesInvalid (vd);
490             return VLC_SUCCESS;
491         }
492
493         /* Move the picture within the window */
494         const uint32_t values[] = { place.x, place.y };
495         xcb_configure_window (sys->conn, sys->window,
496                               XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y,
497                               values);
498         return VLC_SUCCESS;
499     }
500     case VOUT_DISPLAY_CHANGE_WINDOW_STATE:
501     {
502         unsigned state = va_arg (ap, unsigned);
503         return vout_window_SetState (sys->embed, state);
504     }
505
506     case VOUT_DISPLAY_CHANGE_ZOOM:
507     case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
508     case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT:
509     case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
510         /* I am not sure it is always necessary, but it is way simpler ... */
511         vout_display_SendEventPicturesInvalid (vd);
512         return VLC_SUCCESS;
513
514     case VOUT_DISPLAY_RESET_PICTURES:
515     {
516         ResetPictures (vd);
517
518         vout_display_place_t place;
519         vout_display_PlacePicture (&place, &vd->source, vd->cfg, false);
520
521         vd->fmt.i_width  = vd->source.i_width  * place.width  / vd->source.i_visible_width;
522         vd->fmt.i_height = vd->source.i_height * place.height / vd->source.i_visible_height;
523
524         vd->fmt.i_visible_width  = place.width;
525         vd->fmt.i_visible_height = place.height;
526         vd->fmt.i_x_offset = vd->source.i_x_offset * place.width  / vd->source.i_visible_width;
527         vd->fmt.i_y_offset = vd->source.i_y_offset * place.height / vd->source.i_visible_height;
528         return VLC_SUCCESS;
529     }
530
531     /* Hide the mouse. It will be send when
532      * vout_display_t::info.b_hide_mouse is false */
533     case VOUT_DISPLAY_HIDE_MOUSE:
534         xcb_change_window_attributes (sys->conn, sys->embed->handle.xid,
535                                   XCB_CW_CURSOR, &(uint32_t){ sys->cursor });
536         xcb_flush (sys->conn);
537         return VLC_SUCCESS;
538
539     default:
540         msg_Err (vd, "Unknown request in XCB vout display");
541         return VLC_EGENERIC;
542     }
543 }
544
545 static void Manage (vout_display_t *vd)
546 {
547     vout_display_sys_t *sys = vd->sys;
548
549     XCB_Manage (vd, sys->conn, &sys->visible);
550 }
551
552 static void ResetPictures (vout_display_t *vd)
553 {
554     vout_display_sys_t *sys = vd->sys;
555
556     if (!sys->pool)
557         return;
558
559     for (unsigned i = 0; i < MAX_PICTURES; i++)
560     {
561         picture_resource_t *res = &sys->resource[i];
562
563         if (!res->p->p_pixels)
564             break;
565         XCB_pictures_Free (res, sys->conn);
566     }
567     picture_pool_Delete (sys->pool);
568     sys->pool = NULL;
569 }