3523602c4be469b621e0f5932d5504b2797c93a9
[vlc.git] / modules / video_output / xcb / xcb.c
1 /**
2  * @file xcb.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 (_("XCB"))
63     set_description (_("(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;
81     xcb_window_t parent; /* parent X window */
82     xcb_window_t window; /* drawable X window */
83     xcb_gcontext_t gc; /* context to put images */
84     bool shm; /* whether to use MIT-SHM */
85     uint8_t bpp; /* bits per pixel */
86 };
87
88 static int Init (vout_thread_t *);
89 static void Deinit (vout_thread_t *);
90 static void Display (vout_thread_t *, picture_t *);
91 static int Manage (vout_thread_t *);
92
93 int CheckError (vout_thread_t *vout, const char *str, xcb_void_cookie_t ck)
94 {
95     xcb_generic_error_t *err;
96
97     err = xcb_request_check (vout->p_sys->conn, ck);
98     if (err)
99     {
100         msg_Err (vout, "%s: X11 error %d", str, err->error_code);
101         return VLC_EGENERIC;
102     }
103     return VLC_SUCCESS;
104 }
105
106 #define p_vout vout
107
108 /**
109  * Probe the X server.
110  */
111 static int Open (vlc_object_t *obj)
112 {
113     vout_thread_t *vout = (vout_thread_t *)obj;
114     vout_sys_t *p_sys = malloc (sizeof (*p_sys));
115     if (p_sys == NULL)
116         return VLC_ENOMEM;
117
118     vout->p_sys = p_sys;
119     p_sys->conn = NULL;
120 #ifndef NDEBUG
121     p_sys->embed = NULL;
122 #endif
123
124     /* Connect to X */
125     char *display = var_CreateGetNonEmptyString (vout, "x11-display");
126     int snum;
127     p_sys->conn = xcb_connect (display, &snum);
128     if (xcb_connection_has_error (p_sys->conn) /*== NULL*/)
129     {
130         msg_Err (vout, "cannot connect to X server %s",
131                  display ? display : "");
132         goto error;
133     }
134
135     /* Get the preferred screen */
136     xcb_screen_t *scr = xcb_aux_get_screen (p_sys->conn, snum);
137     p_sys->screen = scr;
138     assert (p_sys->screen);
139     msg_Dbg (vout, "using screen %d (depth %"PRIu8")", snum, scr->root_depth);
140
141     if (strchr ("\x08\x0f\x10\x18\x20", scr->root_depth) == NULL)
142     {
143         msg_Err (vout, "unsupported %"PRIu8"-bits color depth",
144                  scr->root_depth);
145         goto error;
146     }
147
148     /* Determine the visual (color depth and palette) */
149     xcb_visualtype_t *vt = NULL;
150     if ((vt = xcb_aux_find_visual_by_attrs (scr, XCB_VISUAL_CLASS_TRUE_COLOR,
151                                             scr->root_depth)) != NULL)
152         msg_Dbg (vout, "using TrueColor visual ID %d", (int)vt->visual_id);
153     else
154     if ((vt = xcb_aux_find_visual_by_attrs (scr,XCB_VISUAL_CLASS_STATIC_COLOR,
155                                             scr->root_depth)) != NULL)
156         msg_Dbg (vout, "using static color visual ID %d", (int)vt->visual_id);
157     else
158     {
159         vt = xcb_aux_get_visualtype (p_sys->conn, snum, scr->root_visual);
160         assert (vt);
161         msg_Err (vout, "unsupported visual class %"PRIu8, vt->_class);
162         goto error;
163     }
164     p_sys->vid = vt->visual_id;
165
166     p_sys->shm = var_CreateGetBool (vout, "x11-shm") > 0;
167     if (p_sys->shm)
168     {
169         xcb_shm_query_version_cookie_t ck;
170         xcb_shm_query_version_reply_t *r;
171         xcb_generic_error_t *err;
172
173         ck = xcb_shm_query_version (p_sys->conn);
174         r = xcb_shm_query_version_reply (p_sys->conn, ck, &err);
175         if (!r)
176         {
177             msg_Err (vout, "shared memory (MIT-SHM) not available");
178             msg_Warn (vout, "display will be slow");
179             p_sys->shm = false;
180         }
181     }
182
183     vout->pf_init = Init;
184     vout->pf_end = Deinit;
185     vout->pf_display = Display;
186     vout->pf_manage = Manage;
187     return VLC_SUCCESS;
188
189 error:
190     Close (obj);
191     return VLC_EGENERIC;
192 }
193
194
195 /**
196  * Disconnect from the X server.
197  */
198 static void Close (vlc_object_t *obj)
199 {
200     vout_thread_t *vout = (vout_thread_t *)obj;
201     vout_sys_t *p_sys = vout->p_sys;
202
203     assert (p_sys->embed == NULL);
204     if (p_sys->conn)
205         xcb_disconnect (p_sys->conn);
206     free (p_sys);
207 }
208
209 struct picture_sys_t
210 {
211     xcb_connection_t *conn;
212     xcb_image_t *image;
213     xcb_shm_seg_t segment;
214 };
215
216 static void PictureRelease (picture_t *pic);
217 static void PictureShmRelease (picture_t *pic);
218 #define SHM_ERR ((void *)(intptr_t)(-1))
219
220 static int PictureInit (vout_thread_t *vout, picture_t *pic)
221 {
222     vout_sys_t *p_sys = vout->p_sys;
223     picture_sys_t *priv = malloc (sizeof (*p_sys));
224
225     if (priv == NULL)
226         return VLC_ENOMEM;
227
228     assert (pic->i_status == FREE_PICTURE);
229     vout_InitPicture (vout, pic, vout->output.i_chroma,
230                       vout->output.i_width, vout->output.i_height,
231                       vout->output.i_aspect);
232
233     void *shm = SHM_ERR;
234     const size_t size = pic->p->i_pitch * pic->p->i_lines;
235
236     if (p_sys->shm)
237     {   /* Allocate shared memory segment */
238         int id = shmget (IPC_PRIVATE, size, IPC_CREAT | 0700);
239
240         if (id == -1)
241         {
242             msg_Err (vout, "shared memory allocation error: %m");
243             goto error;
244         }
245
246         /* Attach the segment to VLC */
247         shm = shmat (id, NULL, 0 /* read/write */);
248         if (shm == SHM_ERR)
249         {
250             msg_Err (vout, "shared memory attachment error: %m");
251             shmctl (id, IPC_RMID, 0);
252             goto error;
253         }
254
255         /* Attach the segment to X */
256         xcb_void_cookie_t ck;
257
258         priv->segment = xcb_generate_id (p_sys->conn);
259         ck = xcb_shm_attach_checked (p_sys->conn, priv->segment, id, 1);
260         shmctl (id, IPC_RMID, 0);
261
262         if (CheckError (vout, "shared memory server-side error", ck))
263         {
264             msg_Info (vout, "using buggy X (remote) server? SSH?");
265             shmdt (shm);
266             shm = SHM_ERR;
267         }
268     }
269
270     const unsigned real_width = pic->p->i_pitch / (p_sys->bpp >> 3);
271     /* FIXME: anyway to getthing more intuitive than that?? */
272
273     /* NOTE: 32-bits scanline_pad assumed, FIXME? (see xdpyinfo) */
274     xcb_image_t *img;
275     img = xcb_image_create (real_width, pic->p->i_lines,
276                             XCB_IMAGE_FORMAT_Z_PIXMAP, 32,
277                             p_sys->screen->root_depth, p_sys->bpp, p_sys->bpp,
278 #ifdef WORDS_BIGENDIAN
279                             XCB_IMAGE_ORDER_MSB_FIRST,
280 #else
281                             XCB_IMAGE_ORDER_LSB_FIRST,
282 #endif
283                             XCB_IMAGE_ORDER_MSB_FIRST,
284                             NULL,
285                             (shm != SHM_ERR) ? size : 0,
286                             (shm != SHM_ERR) ? shm : NULL);
287
288     if (img == NULL)
289     {
290         if (shm != SHM_ERR)
291             xcb_shm_detach (p_sys->conn, priv->segment);
292         goto error;
293     }
294     if (shm != SHM_ERR && xcb_image_native (p_sys->conn, img, 0) == NULL)
295     {
296         msg_Err (vout, "incompatible X server image format");
297         xcb_image_destroy (img);
298         goto error;
299     }
300
301     priv->conn = p_sys->conn;
302     priv->image = img;
303     pic->p_sys = priv;
304     pic->p->p_pixels = img->data;
305     pic->pf_release = (shm != SHM_ERR) ? PictureShmRelease
306                                        : PictureRelease;
307     pic->i_status = DESTROYED_PICTURE;
308     pic->i_type = DIRECT_PICTURE;
309     return VLC_SUCCESS;
310
311 error:
312     if (shm != SHM_ERR)
313         shmdt (shm);
314     free (p_sys);
315     return VLC_EGENERIC;
316 }
317
318
319 /**
320  * Release picture private data
321  */
322 static void PictureRelease (picture_t *pic)
323 {
324     struct picture_sys_t *p_sys = pic->p_sys;
325
326     xcb_image_destroy (p_sys->image);
327     free (p_sys);
328 }
329
330 /**
331  * Release shared memory picture private data
332  */
333 static void PictureShmRelease (picture_t *pic)
334 {
335     struct picture_sys_t *p_sys = pic->p_sys;
336
337     xcb_shm_detach (p_sys->conn, p_sys->segment);
338     shmdt (p_sys->image->data);
339     PictureRelease (pic);
340 }
341
342 /**
343  * Allocate drawable window and picture buffers.
344  */
345 static int Init (vout_thread_t *vout)
346 {
347     vout_sys_t *p_sys = vout->p_sys;
348     const xcb_screen_t *screen = p_sys->screen;
349     unsigned x, y, width, height;
350
351     /* Determine parent window */
352     if (vout->b_fullscreen)
353     {
354         p_sys->embed = NULL;
355         p_sys->parent = screen->root;
356         width = screen->width_in_pixels;
357         height = screen->height_in_pixels;
358     }
359     else
360     {
361         p_sys->embed = vout_RequestWindow (vout, &(int){ 0 }, &(int){ 0 },
362                                             &width, &height);
363         if (p_sys->embed == NULL)
364         {
365             msg_Err (vout, "cannot get window");
366             return VLC_EGENERIC;
367         }
368         p_sys->parent = (intptr_t)p_sys->embed->handle;
369     }
370
371     /* Determine our input format */
372     p_sys->bpp = screen->root_depth;
373     switch (screen->root_depth)
374     {
375         case 24:
376             p_sys->bpp = 32;
377         case 32: /* FIXME: untested */
378             vout->output.i_chroma = VLC_FOURCC ('R', 'V', '3', '2');
379             break;
380
381         case 16:
382             vout->output.i_chroma = VLC_FOURCC ('R', 'V', '1', '6');
383             break;
384
385         case 15:
386             p_sys->bpp = 16;
387             vout->output.i_chroma = VLC_FOURCC ('R', 'V', '1', '5');
388             break;
389
390         case 8: /* FIXME: VLC cannot convert */
391             vout->output.i_chroma = VLC_FOURCC ('R', 'G', 'B', '2');
392             break;
393
394         default:
395             assert (0);
396     }
397
398     vout_PlacePicture (vout, width, height, &x, &y, &width, &height);
399     vout->output.i_width = width;
400     vout->output.i_height = height;
401     assert (height > 0);
402     vout->output.i_aspect = width * VOUT_ASPECT_FACTOR / height;
403     /* FIXME: I don't get the subtlety between output and fmt_out here */
404
405     /* Create window */
406     const uint32_t mask = XCB_CW_BACK_PIXEL | XCB_CW_EVENT_MASK;
407     uint32_t values[2] = {
408         /* XCB_CW_BACK_PIXEL */
409         screen->black_pixel,
410         /* XCB_CW_EVENT_MASK */
411         XCB_EVENT_MASK_BUTTON_PRESS | XCB_EVENT_MASK_BUTTON_RELEASE |
412         XCB_EVENT_MASK_POINTER_MOTION,
413     };
414     xcb_void_cookie_t c;
415     xcb_window_t window = xcb_generate_id (p_sys->conn);
416
417     c = xcb_create_window_checked (p_sys->conn, screen->root_depth, window,
418                                    p_sys->parent, x, y, width, height, 0,
419                                    XCB_WINDOW_CLASS_INPUT_OUTPUT,
420                                    screen->root_visual, mask, values);
421     if (CheckError (vout, "cannot create X11 window", c))
422         goto error;
423     p_sys->window = window;
424     msg_Dbg (vout, "using X11 window %08"PRIx32, p_sys->window);
425     xcb_map_window (p_sys->conn, window);
426
427     /* Create graphic context (I wonder why the heck do we need this) */
428     p_sys->gc = xcb_generate_id (p_sys->conn);
429     xcb_create_gc (p_sys->conn, p_sys->gc, p_sys->window, 0, NULL);
430     msg_Dbg (vout, "using X11 graphic context %08"PRIx32, p_sys->gc);
431     xcb_flush (p_sys->conn);
432
433     /* Allocate picture buffers */
434     do
435     {
436         picture_t *pic = vout->p_picture + I_OUTPUTPICTURES;
437
438         if (PictureInit (vout, pic))
439             break;
440         PP_OUTPUTPICTURE[I_OUTPUTPICTURES++] = pic;
441     }
442     while (I_OUTPUTPICTURES < 2);
443
444     return VLC_SUCCESS;
445
446 error:
447     Deinit (vout);
448     return VLC_EGENERIC;
449 }
450
451 /**
452  * Free picture buffers.
453  */
454 static void Deinit (vout_thread_t *vout)
455 {
456     vout_sys_t *p_sys = vout->p_sys;
457
458     while (I_OUTPUTPICTURES > 0)
459         picture_Release (PP_OUTPUTPICTURE[--I_OUTPUTPICTURES]);
460
461     xcb_unmap_window (p_sys->conn, p_sys->window);
462     xcb_destroy_window (p_sys->conn, p_sys->window);
463     vout_ReleaseWindow (p_sys->embed);
464     p_sys->embed = NULL;
465 }
466
467 /**
468  * Sends an image to the X server.
469  */
470 static void Display (vout_thread_t *vout, picture_t *pic)
471 {
472     vout_sys_t *p_sys = vout->p_sys;
473     picture_sys_t *priv = pic->p_sys;
474     xcb_image_t *img = priv->image;
475
476     if (img->base == NULL)
477     {
478         xcb_shm_segment_info_t info = {
479             .shmseg = priv->segment,
480             .shmid = -1, /* lost track of it, unimportant */
481             .shmaddr = img->data,
482         };
483
484         xcb_image_shm_put (p_sys->conn, p_sys->window, p_sys->gc, img, info,
485                         0, 0, 0, 0, img->width, img->height, 0);
486     }
487     else
488     {
489         xcb_image_t *native = xcb_image_native (p_sys->conn, img, 1);
490
491         if (native == NULL)
492             return;
493
494         xcb_image_put (p_sys->conn, p_sys->window, p_sys->gc, native, 0, 0, 0);
495         if (native != img)
496             xcb_image_destroy (native);
497     }
498     xcb_flush (p_sys->conn);
499 }
500
501 /**
502  * Process incoming X events.
503  */
504 static int Manage (vout_thread_t *vout)
505 {
506     vout_sys_t *p_sys = vout->p_sys;
507     xcb_generic_event_t *ev;
508
509     while ((ev = xcb_poll_for_event (p_sys->conn)) != NULL)
510         ProcessEvent (vout, ev);
511
512     if (xcb_connection_has_error (p_sys->conn))
513     {
514         msg_Err (vout, "X server failure");
515         return VLC_EGENERIC;
516     }
517     return VLC_SUCCESS;
518 }