]> git.sesse.net Git - vlc/blob - modules/video_output/xcb/x11.c
XCB: no need to create a color map for default visual
[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.0
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
27 #include <stdlib.h>
28 #include <assert.h>
29
30 #include <sys/types.h>
31 #include <sys/shm.h>
32
33 #include <xcb/xcb.h>
34 #include <xcb/shm.h>
35
36 #include <xcb/xcb_aux.h>
37 #include <xcb/xcb_image.h>
38
39 #include <vlc_common.h>
40 #include <vlc_plugin.h>
41 #include <vlc_vout.h>
42 #include <vlc_window.h>
43
44 #include "xcb_vlc.h"
45
46 #define DISPLAY_TEXT N_("X11 display")
47 #define DISPLAY_LONGTEXT N_( \
48     "X11 hardware display to use. By default VLC will " \
49     "use the value of the DISPLAY environment variable.")
50
51 #define SHM_TEXT N_("Use shared memory")
52 #define SHM_LONGTEXT N_( \
53     "Use shared memory to communicate between VLC and the X server.")
54
55 static int  Open (vlc_object_t *);
56 static void Close (vlc_object_t *);
57
58 /*
59  * Module descriptor
60  */
61 vlc_module_begin ()
62     set_shortname (N_("XCB"))
63     set_description (N_("(Experimental) XCB video output"))
64     set_category (CAT_VIDEO)
65     set_subcategory (SUBCAT_VIDEO_VOUT)
66     set_capability ("video output", 0)
67     set_callbacks (Open, Close)
68
69     add_string ("x11-display", NULL, NULL,
70                 DISPLAY_TEXT, DISPLAY_LONGTEXT, true)
71     add_bool ("x11-shm", true, NULL, SHM_TEXT, SHM_LONGTEXT, true)
72 vlc_module_end ()
73
74 struct vout_sys_t
75 {
76     xcb_connection_t *conn;
77     xcb_screen_t *screen;
78     vout_window_t *embed; /* VLC window (when windowed) */
79
80     xcb_visualid_t vid; /* selected visual */
81     xcb_window_t parent; /* parent X window */
82     xcb_colormap_t cmap; /* colormap for selected visual */
83     xcb_window_t window; /* drawable X window */
84     xcb_gcontext_t gc; /* context to put images */
85     bool shm; /* whether to use MIT-SHM */
86     uint8_t bpp; /* bits per pixel */
87     uint8_t pad; /* scanline pad */
88 };
89
90 static int Init (vout_thread_t *);
91 static void Deinit (vout_thread_t *);
92 static void Render (vout_thread_t *, picture_t *);
93 static void Display (vout_thread_t *, picture_t *);
94 static int Manage (vout_thread_t *);
95
96 int CheckError (vout_thread_t *vout, const char *str, xcb_void_cookie_t ck)
97 {
98     xcb_generic_error_t *err;
99
100     err = xcb_request_check (vout->p_sys->conn, ck);
101     if (err)
102     {
103         msg_Err (vout, "%s: X11 error %d", str, err->error_code);
104         return VLC_EGENERIC;
105     }
106     return VLC_SUCCESS;
107 }
108
109 #define p_vout vout
110
111 /**
112  * Probe the X server.
113  */
114 static int Open (vlc_object_t *obj)
115 {
116     vout_thread_t *vout = (vout_thread_t *)obj;
117     vout_sys_t *p_sys = malloc (sizeof (*p_sys));
118     if (p_sys == NULL)
119         return VLC_ENOMEM;
120
121     vout->p_sys = p_sys;
122     p_sys->conn = NULL;
123     p_sys->embed = NULL;
124
125     /* Connect to X */
126     char *display = var_CreateGetNonEmptyString (vout, "x11-display");
127     int snum;
128     p_sys->conn = xcb_connect (display, &snum);
129     if (xcb_connection_has_error (p_sys->conn) /*== NULL*/)
130     {
131         msg_Err (vout, "cannot connect to X server %s",
132                  display ? display : "");
133         free (display);
134         goto error;
135     }
136     free (display);
137
138     const xcb_setup_t *setup = xcb_get_setup (p_sys->conn);
139
140     /* Get the preferred screen */
141     xcb_screen_t *scr = xcb_aux_get_screen (p_sys->conn, snum);
142     p_sys->screen = scr;
143     assert (p_sys->screen);
144     msg_Dbg (vout, "using screen %d", snum);
145
146     /* Determine our video format. Normally, this is done in pf_init(), but
147      * this plugin always uses the same format for a given X11 screen. */
148     uint8_t depth = 0;
149     bool gray = true;
150     for (const xcb_format_t *fmt = xcb_setup_pixmap_formats (setup),
151              *end = fmt + xcb_setup_pixmap_formats_length (setup);
152          fmt < end; fmt++)
153     {
154         vlc_fourcc_t chroma = 0;
155
156         if (fmt->depth < depth)
157             continue; /* We already found a better format! */
158
159         /* Check that the pixmap format is supported by VLC. */
160         switch (fmt->depth)
161         {
162           case 24:
163             if (fmt->bits_per_pixel == 32)
164                 chroma = VLC_FOURCC ('R', 'V', '3', '2');
165             else if (fmt->bits_per_pixel == 24)
166                 chroma = VLC_FOURCC ('R', 'V', '2', '4');
167             else
168                 continue;
169             break;
170           case 16:
171             if (fmt->bits_per_pixel != 16)
172                 continue;
173             chroma = VLC_FOURCC ('R', 'V', '1', '6');
174             break;
175           case 15:
176             if (fmt->bits_per_pixel != 16)
177                 continue;
178             chroma = VLC_FOURCC ('R', 'V', '1', '5');
179             break;
180           case 8:
181             if (fmt->bits_per_pixel != 8)
182                 continue;
183             chroma = VLC_FOURCC ('R', 'G', 'B', '2');
184             break;
185           default:
186             continue;
187         }
188         if ((fmt->bits_per_pixel << 4) % fmt->scanline_pad)
189             continue; /* VLC pads lines to 16 pixels internally */
190
191         /* Byte sex is a non-issue for 8-bits. It can be worked around with
192          * RGB masks for 24-bits. Too bad for 15-bits and 16-bits. */
193 #ifdef WORDS_BIGENDIAN
194 # define ORDER XCB_IMAGE_ORDER_MSB_FIRST
195 #else
196 # define ORDER XCB_IMAGE_ORDER_LSB_FIRST
197 #endif
198         if (fmt->bits_per_pixel == 16 && setup->image_byte_order != ORDER)
199             continue;
200
201         /* Check that the selected screen supports this depth */
202         xcb_depth_iterator_t it = xcb_screen_allowed_depths_iterator (scr);
203         while (it.rem > 0 && it.data->depth != fmt->depth)
204              xcb_depth_next (&it);
205         if (!it.rem)
206             continue; /* Depth not supported on this screen */
207
208         /* Find a visual type for the selected depth */
209         const xcb_visualtype_t *vt = xcb_depth_visuals (it.data);
210         xcb_visualid_t vid = 0;
211         for (int i = xcb_depth_visuals_length (it.data); (i > 0) && !vid; i--)
212         {
213             if (vt->_class == XCB_VISUAL_CLASS_TRUE_COLOR)
214             {
215                 msg_Dbg (vout,
216                          "using TrueColor %"PRIu8"-bits visual ID 0x%0"PRIx32,
217                          fmt->depth, vt->visual_id);
218                 vid = vt->visual_id;
219                 gray = false;
220                 break;
221             }
222             if (fmt->depth == 8 && vt->_class == XCB_VISUAL_CLASS_STATIC_GRAY)
223             {
224                 if (!gray)
225                     continue; /* Prefer color over gray scale */
226                 vid = vt->visual_id;
227                 chroma = VLC_FOURCC ('G', 'R', 'E', 'Y');
228                 msg_Dbg (vout,
229                          "using static gray 8-bits visual ID 0x%x"PRIx32,
230                          vt->visual_id);
231                 break;
232             }
233         }
234
235         if (!vid)
236             continue; /* The screen does not *really* support this depth */
237
238         vout->fmt_out.i_chroma = vout->output.i_chroma = chroma;
239         if (!gray)
240         {
241             vout->output.i_rmask = vt->red_mask;
242             vout->output.i_gmask = vt->green_mask;
243             vout->output.i_bmask = vt->blue_mask;
244         }
245         p_sys->vid = vid;
246         p_sys->bpp = fmt->bits_per_pixel;
247         p_sys->pad = fmt->scanline_pad;
248
249         depth = fmt->depth;
250     }
251
252     if (depth == 0)
253     {
254         msg_Err (vout, "no supported pixmap formats");
255         goto error;
256     }
257
258     msg_Dbg (vout, "using %"PRIu8" bits per pixels (line pad: %"PRIu8")",
259              p_sys->bpp, p_sys->pad);
260
261     /* Create colormap (needed to select non-default visual) */
262     if (p_sys->vid != scr->root_visual)
263     {
264         p_sys->cmap = xcb_generate_id (p_sys->conn);
265         xcb_create_colormap (p_sys->conn, XCB_COLORMAP_ALLOC_NONE,
266                              p_sys->cmap, scr->root, p_sys->vid);
267     }
268     else
269         p_sys->cmap = scr->default_colormap;
270
271     /* Check shared memory support */
272     p_sys->shm = var_CreateGetBool (vout, "x11-shm") > 0;
273     if (p_sys->shm)
274     {
275         xcb_shm_query_version_cookie_t ck;
276         xcb_shm_query_version_reply_t *r;
277         xcb_generic_error_t *err;
278
279         ck = xcb_shm_query_version (p_sys->conn);
280         r = xcb_shm_query_version_reply (p_sys->conn, ck, &err);
281         if (!r)
282         {
283             msg_Err (vout, "shared memory (MIT-SHM) not available");
284             msg_Warn (vout, "display will be slow");
285             p_sys->shm = false;
286         }
287     }
288
289     /* Get window */
290     /* FIXME: WTH to put as initial width/height values??? */
291     p_sys->embed = vout_RequestXWindow (vout, &(int){ 0 }, &(int){ 0 },
292                                         &(unsigned){ 0 }, &(unsigned){ 0 });
293     if (p_sys->embed == NULL)
294     {
295         msg_Err (vout, "parent window not available");
296         goto error;
297     }
298
299     vout->pf_init = Init;
300     vout->pf_end = Deinit;
301     vout->pf_render = Render;
302     vout->pf_display = Display;
303     vout->pf_manage = Manage;
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_thread_t *vout = (vout_thread_t *)obj;
318     vout_sys_t *p_sys = vout->p_sys;
319
320     if (p_sys->embed)
321         vout_ReleaseWindow (p_sys->embed);
322     /* colormap is garbage-ollected by X (?) */
323     if (p_sys->conn)
324         xcb_disconnect (p_sys->conn);
325     free (p_sys);
326 }
327
328 struct picture_sys_t
329 {
330     xcb_connection_t *conn; /* Shared connection to X server */
331     xcb_image_t *image;  /* Picture buffer */
332     xcb_image_t *native; /* Rendered picture buffer (in X server format) */
333     xcb_shm_seg_t segment; /* Shared memory segment X ID */
334 };
335
336 #define SHM_ERR ((void *)(intptr_t)(-1))
337
338 static int PictureInit (vout_thread_t *vout, picture_t *pic)
339 {
340     vout_sys_t *p_sys = vout->p_sys;
341     picture_sys_t *priv = malloc (sizeof (*p_sys));
342
343     if (priv == NULL)
344         return VLC_ENOMEM;
345
346     assert (pic->i_status == FREE_PICTURE);
347     vout_InitPicture (vout, pic, vout->output.i_chroma,
348                       vout->output.i_width, vout->output.i_height,
349                       vout->output.i_aspect);
350
351     void *shm = SHM_ERR;
352     const size_t size = pic->p->i_pitch * pic->p->i_lines;
353
354     if (p_sys->shm)
355     {   /* Allocate shared memory segment */
356         int id = shmget (IPC_PRIVATE, size, IPC_CREAT | 0700);
357
358         if (id == -1)
359         {
360             msg_Err (vout, "shared memory allocation error: %m");
361             goto error;
362         }
363
364         /* Attach the segment to VLC */
365         shm = shmat (id, NULL, 0 /* read/write */);
366         if (shm == SHM_ERR)
367         {
368             msg_Err (vout, "shared memory attachment error: %m");
369             shmctl (id, IPC_RMID, 0);
370             goto error;
371         }
372
373         /* Attach the segment to X */
374         xcb_void_cookie_t ck;
375
376         priv->segment = xcb_generate_id (p_sys->conn);
377         ck = xcb_shm_attach_checked (p_sys->conn, priv->segment, id, 1);
378         shmctl (id, IPC_RMID, 0);
379
380         if (CheckError (vout, "shared memory server-side error", ck))
381         {
382             msg_Info (vout, "using buggy X (remote) server? SSH?");
383             shmdt (shm);
384             shm = SHM_ERR;
385         }
386     }
387     else
388         priv->segment = 0;
389
390     const unsigned real_width = pic->p->i_pitch / (p_sys->bpp >> 3);
391     /* FIXME: anyway to getthing more intuitive than that?? */
392
393     xcb_image_t *img;
394     img = xcb_image_create (real_width, pic->p->i_lines,
395                             XCB_IMAGE_FORMAT_Z_PIXMAP, p_sys->pad,
396                             p_sys->screen->root_depth, p_sys->bpp, p_sys->bpp,
397 #ifdef WORDS_BIGENDIAN
398                             XCB_IMAGE_ORDER_MSB_FIRST,
399 #else
400                             XCB_IMAGE_ORDER_LSB_FIRST,
401 #endif
402                             XCB_IMAGE_ORDER_MSB_FIRST,
403                             NULL,
404                             (shm != SHM_ERR) ? size : 0,
405                             (shm != SHM_ERR) ? shm : NULL);
406
407     if (img == NULL)
408     {
409         if (shm != SHM_ERR)
410             xcb_shm_detach (p_sys->conn, priv->segment);
411         goto error;
412     }
413     if (shm != SHM_ERR && xcb_image_native (p_sys->conn, img, 0) == NULL)
414         msg_Warn (vout, "incompatible X server image format");
415
416     priv->conn = p_sys->conn;
417     priv->image = img;
418     priv->native = NULL;
419     pic->p_sys = priv;
420     pic->p->p_pixels = img->data;
421     pic->i_status = DESTROYED_PICTURE;
422     pic->i_type = DIRECT_PICTURE;
423     return VLC_SUCCESS;
424
425 error:
426     if (shm != SHM_ERR)
427         shmdt (shm);
428     free (priv);
429     return VLC_EGENERIC;
430 }
431
432
433 /**
434  * Release picture private data
435  */
436 static void PictureDeinit (picture_t *pic)
437 {
438     struct picture_sys_t *p_sys = pic->p_sys;
439
440     if (p_sys->segment != 0)
441     {
442         xcb_shm_detach (p_sys->conn, p_sys->segment);
443         shmdt (p_sys->image->data);
444     }
445     if ((p_sys->native != NULL) && (p_sys->native != p_sys->image))
446         xcb_image_destroy (p_sys->native);
447     xcb_image_destroy (p_sys->image);
448     free (p_sys);
449 }
450
451 /**
452  * Allocate drawable window and picture buffers.
453  */
454 static int Init (vout_thread_t *vout)
455 {
456     vout_sys_t *p_sys = vout->p_sys;
457     const xcb_screen_t *screen = p_sys->screen;
458     unsigned x, y, width, height;
459
460     I_OUTPUTPICTURES = 0;
461
462     /* Determine parent window and size */
463     if (vout->b_fullscreen)
464     {
465         p_sys->parent = screen->root;
466         width = screen->width_in_pixels;
467         height = screen->height_in_pixels;
468     }
469     else
470     {
471         p_sys->parent = p_sys->embed->handle.xid;
472
473         /* Subscribe to parent window resize events */
474         const uint32_t value = XCB_EVENT_MASK_STRUCTURE_NOTIFY;
475         xcb_change_window_attributes (p_sys->conn, p_sys->parent,
476                                       XCB_CW_EVENT_MASK, &value);
477
478         xcb_get_geometry_cookie_t ck;
479         ck = xcb_get_geometry (p_sys->conn, p_sys->parent);
480
481         xcb_get_geometry_reply_t *geo;
482         xcb_generic_error_t *err;
483         geo = xcb_get_geometry_reply (p_sys->conn, ck, &err);
484         width = geo->width;
485         height = geo->height;
486         free (geo);
487     }
488
489     vout_PlacePicture (vout, width, height, &x, &y, &width, &height);
490
491     /* FIXME: I don't get the subtlety between output and fmt_out here */
492     vout->fmt_out.i_visible_width = width;
493     vout->fmt_out.i_visible_height = height;
494     vout->fmt_out.i_sar_num = vout->fmt_out.i_sar_den = 1;
495
496     vout->output.i_width = vout->fmt_out.i_width =
497         width * vout->fmt_in.i_width / vout->fmt_in.i_visible_width;
498     vout->output.i_height = vout->fmt_out.i_height =
499         height * vout->fmt_in.i_height / vout->fmt_in.i_visible_height;
500     vout->fmt_out.i_x_offset =
501         width * vout->fmt_in.i_x_offset / vout->fmt_in.i_visible_width;
502     p_vout->fmt_out.i_y_offset =
503         height * vout->fmt_in.i_y_offset / vout->fmt_in.i_visible_height;
504
505     assert (height > 0);
506     vout->output.i_aspect = vout->fmt_out.i_aspect =
507         width * VOUT_ASPECT_FACTOR / height;
508
509     /* Create window */
510     const uint32_t mask = XCB_CW_BACK_PIXEL | XCB_CW_EVENT_MASK
511                         | XCB_CW_COLORMAP;
512     const uint32_t values[] = {
513         /* XCB_CW_BACK_PIXEL */
514         screen->black_pixel,
515         /* XCB_CW_EVENT_MASK */
516         XCB_EVENT_MASK_BUTTON_PRESS | XCB_EVENT_MASK_BUTTON_RELEASE |
517         XCB_EVENT_MASK_POINTER_MOTION,
518         /* XCB_CW_COLORMAP */
519         p_sys->cmap,
520     };
521     xcb_void_cookie_t c;
522     xcb_window_t window = xcb_generate_id (p_sys->conn);
523
524     c = xcb_create_window_checked (p_sys->conn, screen->root_depth, window,
525                                    p_sys->parent, x, y, width, height, 0,
526                                    XCB_WINDOW_CLASS_INPUT_OUTPUT,
527                                    p_sys->vid, mask, values);
528     if (CheckError (vout, "cannot create X11 window", c))
529         goto error;
530     p_sys->window = window;
531     msg_Dbg (vout, "using X11 window %08"PRIx32, p_sys->window);
532     xcb_map_window (p_sys->conn, window);
533
534     /* Create graphic context (I wonder why the heck do we need this) */
535     p_sys->gc = xcb_generate_id (p_sys->conn);
536     xcb_create_gc (p_sys->conn, p_sys->gc, p_sys->window, 0, NULL);
537     msg_Dbg (vout, "using X11 graphic context %08"PRIx32, p_sys->gc);
538     xcb_flush (p_sys->conn);
539
540     /* Allocate picture buffers */
541     I_OUTPUTPICTURES = 0;
542     for (size_t index = 0; I_OUTPUTPICTURES < 2; index++)
543     {
544         picture_t *pic = vout->p_picture + index;
545
546         if (index > sizeof (vout->p_picture) / sizeof (pic))
547             break;
548         if (pic->i_status != FREE_PICTURE)
549             continue;
550         if (PictureInit (vout, pic))
551             break;
552         PP_OUTPUTPICTURE[I_OUTPUTPICTURES++] = pic;
553     }
554
555     return VLC_SUCCESS;
556
557 error:
558     Deinit (vout);
559     return VLC_EGENERIC;
560 }
561
562 /**
563  * Free picture buffers.
564  */
565 static void Deinit (vout_thread_t *vout)
566 {
567     vout_sys_t *p_sys = vout->p_sys;
568
569     for (int i = 0; i < I_OUTPUTPICTURES; i++)
570         PictureDeinit (PP_OUTPUTPICTURE[i]);
571
572     xcb_unmap_window (p_sys->conn, p_sys->window);
573     xcb_destroy_window (p_sys->conn, p_sys->window);
574 }
575
576 /**
577  * Prepares an image ahead of display.
578  */
579 static void Render (vout_thread_t *vout, picture_t *pic)
580 {
581     vout_sys_t *p_sys = vout->p_sys;
582     picture_sys_t *priv = pic->p_sys;
583
584     if ((priv->native != NULL) && (priv->native != priv->image))
585         xcb_image_destroy (priv->native);
586     priv->native = xcb_image_native (p_sys->conn, priv->image, 1);
587 }
588
589
590 /**
591  * Sends an image to the X server.
592  */
593 static void Display (vout_thread_t *vout, picture_t *pic)
594 {
595     vout_sys_t *p_sys = vout->p_sys;
596     picture_sys_t *priv = pic->p_sys;
597     xcb_image_t *img = priv->image, *native = priv->native;
598
599     if ((native == img) && (img->base == NULL))
600     {
601         xcb_shm_segment_info_t info = {
602             .shmseg = priv->segment,
603             .shmid = -1, /* lost track of it, unimportant */
604             .shmaddr = img->data,
605         };
606
607         xcb_image_shm_put (p_sys->conn, p_sys->window, p_sys->gc, img, info,
608                         0, 0, 0, 0, img->width, img->height, 0);
609     }
610     else
611     if (native != NULL)
612         xcb_image_put (p_sys->conn, p_sys->window, p_sys->gc, native, 0, 0, 0);
613     xcb_flush (p_sys->conn);
614 }
615
616 /**
617  * Process incoming X events.
618  */
619 static int Manage (vout_thread_t *vout)
620 {
621     vout_sys_t *p_sys = vout->p_sys;
622     xcb_generic_event_t *ev;
623
624     while ((ev = xcb_poll_for_event (p_sys->conn)) != NULL)
625         ProcessEvent (vout, p_sys->conn, p_sys->window, ev);
626
627     if (xcb_connection_has_error (p_sys->conn))
628     {
629         msg_Err (vout, "X server failure");
630         return VLC_EGENERIC;
631     }
632     return VLC_SUCCESS;
633 }