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