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