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